1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4 * Copyright (c) 2007-2008, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
10 * \brief Master header file for Tor-specific functionality.
15 #define OR_H_ID "$Id$"
19 #define WIN32_WINNT 0x400
20 #define _WIN32_WINNT 0x400
21 #define WIN32_LEAN_AND_MEAN
33 #ifdef HAVE_SYS_PARAM_H
34 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
37 #ifdef HAVE_SYS_WAIT_H
40 #ifdef HAVE_SYS_FCNTL_H
41 #include <sys/fcntl.h>
46 #ifdef HAVE_SYS_IOCTL_H
47 #include <sys/ioctl.h>
52 #ifdef HAVE_SYS_STAT_H
55 #ifdef HAVE_ARPA_INET_H
56 #include <arpa/inet.h>
73 #define snprintf _snprintf
80 #include "container.h"
87 /* These signals are defined to help control_signal_act work.
104 /* Controller signals start at a high number so we don't
105 * conflict with system-defined signals. */
106 #define SIGNEWNYM 129
107 #define SIGCLEARDNSCACHE 130
109 #if (SIZEOF_CELL_T != 0)
110 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
111 * that our stuff always calls cell_t something different. */
112 #define cell_t tor_cell_t
115 /** Length of longest allowable configured nickname. */
116 #define MAX_NICKNAME_LEN 19
117 /** Length of a router identity encoded as a hexadecimal digest, plus
118 * possible dollar sign. */
119 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
120 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
121 * equal sign or tilde, nickname. */
122 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
124 /** Maximum size, in bytes, for resized buffers. */
125 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
126 /** Maximum size, in bytes, for any directory object that we've downloaded. */
127 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
129 /** For http parsing: Maximum number of bytes we'll accept in the headers
130 * of an HTTP request or response. */
131 #define MAX_HEADERS_SIZE 50000
132 /** Maximum size, in bytes, for any directory object that we're accepting
134 #define MAX_DIR_UL_SIZE 500000
136 /** Maximum size, in bytes, of a single router descriptor uploaded to us
137 * as a directory authority. Caches and clients fetch whatever descriptors
138 * the authorities tell them to fetch, and don't care about size. */
139 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
141 /** Maximum size of a single extrainfo document, as above. */
142 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
144 /** How long do we keep DNS cache entries before purging them (regardless of
146 #define MAX_DNS_ENTRY_AGE (30*60)
147 /** How long do we cache/tell clients to cache DNS records when no TTL is
149 #define DEFAULT_DNS_TTL (30*60)
150 /** How long can a TTL be before we stop believing it? */
151 #define MAX_DNS_TTL (3*60*60)
152 /** How small can a TTL be before we stop believing it? Provides rudimentary
154 #define MIN_DNS_TTL (60)
156 /** How often do we rotate onion keys? */
157 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
158 /** How often do we rotate TLS contexts? */
159 #define MAX_SSL_KEY_LIFETIME (2*60*60)
161 /** How old do we allow a router to get before removing it
162 * from the router list? In seconds. */
163 #define ROUTER_MAX_AGE (60*60*48)
164 /** How old can a router get before we (as a server) will no longer
165 * consider it live? In seconds. */
166 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
167 /** How old do we let a saved descriptor get before force-removing it? */
168 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
170 /** Possible rules for generating circuit IDs on an OR connection. */
172 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
173 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
174 /** The other side of a connection is an OP: never create circuits to it,
175 * and let it use any circuit ID it wants. */
176 CIRC_ID_TYPE_NEITHER
=2
179 #define _CONN_TYPE_MIN 3
180 /** Type for sockets listening for OR connections. */
181 #define CONN_TYPE_OR_LISTENER 3
182 /** A bidirectional TLS connection transmitting a sequence of cells.
183 * May be from an OR to an OR, or from an OP to an OR. */
184 #define CONN_TYPE_OR 4
185 /** A TCP connection from an onion router to a stream's destination. */
186 #define CONN_TYPE_EXIT 5
187 /** Type for sockets listening for SOCKS connections. */
188 #define CONN_TYPE_AP_LISTENER 6
189 /** A SOCKS proxy connection from the user application to the onion
191 #define CONN_TYPE_AP 7
192 /** Type for sockets listening for HTTP connections to the directory server. */
193 #define CONN_TYPE_DIR_LISTENER 8
194 /** Type for HTTP connections to the directory server. */
195 #define CONN_TYPE_DIR 9
196 /** Connection from the main process to a CPU worker process. */
197 #define CONN_TYPE_CPUWORKER 10
198 /** Type for listening for connections from user interface process. */
199 #define CONN_TYPE_CONTROL_LISTENER 11
200 /** Type for connections from user interface process. */
201 #define CONN_TYPE_CONTROL 12
202 /** Type for sockets listening for transparent connections redirected by pf or
204 #define CONN_TYPE_AP_TRANS_LISTENER 13
205 /** Type for sockets listening for transparent connections redirected by
207 #define CONN_TYPE_AP_NATD_LISTENER 14
208 /** Type for sockets listening for DNS requests. */
209 #define CONN_TYPE_AP_DNS_LISTENER 15
210 #define _CONN_TYPE_MAX 15
211 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
214 #define CONN_IS_EDGE(x) \
215 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
217 /** State for any listener connection. */
218 #define LISTENER_STATE_READY 0
220 #define _CPUWORKER_STATE_MIN 1
221 /** State for a connection to a cpuworker process that's idle. */
222 #define CPUWORKER_STATE_IDLE 1
223 /** State for a connection to a cpuworker process that's processing a
225 #define CPUWORKER_STATE_BUSY_ONION 2
226 #define _CPUWORKER_STATE_MAX 2
228 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
230 #define _OR_CONN_STATE_MIN 1
231 /** State for a connection to an OR: waiting for connect() to finish. */
232 #define OR_CONN_STATE_CONNECTING 1
233 /** State for a connection to an OR: waiting for proxy command to flush. */
234 #define OR_CONN_STATE_PROXY_FLUSHING 2
235 /** State for a connection to an OR: waiting for proxy response. */
236 #define OR_CONN_STATE_PROXY_READING 3
237 /** State for a connection to an OR or client: SSL is handshaking, not done
239 #define OR_CONN_STATE_TLS_HANDSHAKING 4
240 /** State for a connection to an OR: We're doing a second SSL handshake for
241 * renegotiation purposes. */
242 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 5
243 /** State for a connection at an OR: We're waiting for the client to
245 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 6
246 /** State for a connection to an OR: We're done with our SSL handshake, but we
247 * haven't yet negotiated link protocol versions and sent a netinfo cell.
249 #define OR_CONN_STATE_OR_HANDSHAKING 7
250 /** State for a connection to an OR: Ready to send/receive cells. */
251 #define OR_CONN_STATE_OPEN 8
252 #define _OR_CONN_STATE_MAX 8
254 #define _EXIT_CONN_STATE_MIN 1
255 /** State for an exit connection: waiting for response from dns farm. */
256 #define EXIT_CONN_STATE_RESOLVING 1
257 /** State for an exit connection: waiting for connect() to finish. */
258 #define EXIT_CONN_STATE_CONNECTING 2
259 /** State for an exit connection: open and ready to transmit data. */
260 #define EXIT_CONN_STATE_OPEN 3
261 /** State for an exit connection: waiting to be removed. */
262 #define EXIT_CONN_STATE_RESOLVEFAILED 4
263 #define _EXIT_CONN_STATE_MAX 4
265 /* The AP state values must be disjoint from the EXIT state values. */
266 #define _AP_CONN_STATE_MIN 5
267 /** State for a SOCKS connection: waiting for SOCKS request. */
268 #define AP_CONN_STATE_SOCKS_WAIT 5
269 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
270 * rendezvous descriptor. */
271 #define AP_CONN_STATE_RENDDESC_WAIT 6
272 /** The controller will attach this connection to a circuit; it isn't our
274 #define AP_CONN_STATE_CONTROLLER_WAIT 7
275 /** State for a SOCKS connection: waiting for a completed circuit. */
276 #define AP_CONN_STATE_CIRCUIT_WAIT 8
277 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
278 #define AP_CONN_STATE_CONNECT_WAIT 9
279 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
280 #define AP_CONN_STATE_RESOLVE_WAIT 10
281 /** State for a SOCKS connection: ready to send and receive. */
282 #define AP_CONN_STATE_OPEN 11
283 /** State for a transparent natd connection: waiting for original
285 #define AP_CONN_STATE_NATD_WAIT 12
286 #define _AP_CONN_STATE_MAX 12
288 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
289 * edge connection is not attached to any circuit. */
290 #define AP_CONN_STATE_IS_UNATTACHED(s) \
291 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
293 #define _DIR_CONN_STATE_MIN 1
294 /** State for connection to directory server: waiting for connect(). */
295 #define DIR_CONN_STATE_CONNECTING 1
296 /** State for connection to directory server: sending HTTP request. */
297 #define DIR_CONN_STATE_CLIENT_SENDING 2
298 /** State for connection to directory server: reading HTTP response. */
299 #define DIR_CONN_STATE_CLIENT_READING 3
300 /** State for connection to directory server: happy and finished. */
301 #define DIR_CONN_STATE_CLIENT_FINISHED 4
302 /** State for connection at directory server: waiting for HTTP request. */
303 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
304 /** State for connection at directory server: sending HTTP response. */
305 #define DIR_CONN_STATE_SERVER_WRITING 6
306 #define _DIR_CONN_STATE_MAX 6
308 /** True iff the purpose of <b>conn</b> means that it's a server-side
309 * directory connection. */
310 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
312 #define _CONTROL_CONN_STATE_MIN 1
313 /** State for a control connection: Authenticated and accepting v1 commands. */
314 #define CONTROL_CONN_STATE_OPEN 1
315 /** State for a control connection: Waiting for authentication; speaking
317 #define CONTROL_CONN_STATE_NEEDAUTH 2
318 #define _CONTROL_CONN_STATE_MAX 2
320 #define _DIR_PURPOSE_MIN 3
321 /** A connection to a directory server: download a rendezvous
323 #define DIR_PURPOSE_FETCH_RENDDESC 3
324 /** A connection to a directory server: set after a rendezvous
325 * descriptor is downloaded. */
326 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
327 /** A connection to a directory server: download one or more v2
328 * network-status objects */
329 #define DIR_PURPOSE_FETCH_NETWORKSTATUS 5
330 /** A connection to a directory server: download one or more server
332 #define DIR_PURPOSE_FETCH_SERVERDESC 6
333 /** A connection to a directory server: download one or more extra-info
335 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
336 /** A connection to a directory server: upload a server descriptor. */
337 #define DIR_PURPOSE_UPLOAD_DIR 8
338 /** A connection to a directory server: upload a rendezvous
340 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
341 /** A connection to a directory server: upload a v3 networkstatus vote. */
342 #define DIR_PURPOSE_UPLOAD_VOTE 10
343 /** A connection to a directory server: upload a v3 consensus signature */
344 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
345 /** A connection to a directory server: download one or more network-status
346 * objects [XXX wtf, these are all the same comment] */
347 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
348 /** A connection to a directory server: download one or more network-status
350 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
351 /** A connection to a directory server: download one or more network-status
353 #define DIR_PURPOSE_FETCH_CONSENSUS 14
354 /** A connection to a directory server: download one or more network-status
356 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
358 /** Purpose for connection at a directory server. */
359 #define DIR_PURPOSE_SERVER 16
360 /** A connection to a hidden service directory server: upload a v2 rendezvous
362 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
363 /** A connection to a hidden service directory server: download a v2 rendezvous
365 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
366 #define _DIR_PURPOSE_MAX 18
368 #define DIR_PURPOSE_IS_UPLOAD(p) \
369 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
370 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
371 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
372 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
374 #define _EXIT_PURPOSE_MIN 1
375 /** This exit stream wants to do an ordinary connect. */
376 #define EXIT_PURPOSE_CONNECT 1
377 /** This exit stream wants to do a resolve (either normal or reverse). */
378 #define EXIT_PURPOSE_RESOLVE 2
379 #define _EXIT_PURPOSE_MAX 2
381 /* !!!! If any connection purpose is ever over over 31, we must grow the type
382 * field in connection_t. */
384 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
385 #define CIRCUIT_STATE_BUILDING 0
386 /** Circuit state: Waiting to process the onionskin. */
387 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
388 /** Circuit state: I'd like to deliver a create, but my n_conn is still
390 #define CIRCUIT_STATE_OR_WAIT 2
391 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
392 #define CIRCUIT_STATE_OPEN 3
394 #define _CIRCUIT_PURPOSE_MIN 1
396 /* these circuits were initiated elsewhere */
397 #define _CIRCUIT_PURPOSE_OR_MIN 1
398 /** OR-side circuit purpose: normal circuit, at OR. */
399 #define CIRCUIT_PURPOSE_OR 1
400 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
401 #define CIRCUIT_PURPOSE_INTRO_POINT 2
402 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
403 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
404 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
405 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
406 #define _CIRCUIT_PURPOSE_OR_MAX 4
408 /* these circuits originate at this node */
410 /* here's how circ client-side purposes work:
411 * normal circuits are C_GENERAL.
412 * circuits that are c_introducing are either on their way to
413 * becoming open, or they are open and waiting for a
414 * suitable rendcirc before they send the intro.
415 * circuits that are c_introduce_ack_wait have sent the intro,
416 * but haven't gotten a response yet.
417 * circuits that are c_establish_rend are either on their way
418 * to becoming open, or they are open and have sent the
419 * establish_rendezvous cell but haven't received an ack.
420 * circuits that are c_rend_ready are open and have received a
421 * rend ack, but haven't heard from bob yet. if they have a
422 * buildstate->pending_final_cpath then they're expecting a
423 * cell from bob, else they're not.
424 * circuits that are c_rend_ready_intro_acked are open, and
425 * some intro circ has sent its intro and received an ack.
426 * circuits that are c_rend_joined are open, have heard from
427 * bob, and are talking to him.
429 /** Client-side circuit purpose: Normal circuit, with cpath. */
430 #define CIRCUIT_PURPOSE_C_GENERAL 5
431 /** Client-side circuit purpose: at Alice, connecting to intro point. */
432 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
433 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
434 * waiting for ACK/NAK. */
435 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
436 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
437 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
438 /** Client-side circuit purpose: at Alice, waiting for ack. */
439 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
440 /** Client-side circuit purpose: at Alice, waiting for Bob. */
441 #define CIRCUIT_PURPOSE_C_REND_READY 10
442 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
443 * has been acknowledged. */
444 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
445 /** Client-side circuit purpose: at Alice, rendezvous established. */
446 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
448 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
449 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
450 /** Hidden-service-side circuit purpose: at Bob, successfully established
452 #define CIRCUIT_PURPOSE_S_INTRO 14
453 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
454 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
455 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
456 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
457 /** A testing circuit; not meant to be used for actual traffic. */
458 #define CIRCUIT_PURPOSE_TESTING 17
459 /** A controller made this circuit and Tor should not use it. */
460 #define CIRCUIT_PURPOSE_CONTROLLER 18
461 #define _CIRCUIT_PURPOSE_MAX 18
462 /** A catch-all for unrecognized purposes. Currently we don't expect
463 * to make or see any circuits with this purpose. */
464 #define CIRCUIT_PURPOSE_UNKNOWN 255
466 /** True iff the circuit purpose <b>p</b> is for a circuit that
467 * originated at this node. */
468 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
469 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
471 /** How many circuits do we want simultaneously in-progress to handle
473 #define MIN_CIRCUITS_HANDLING_STREAM 2
475 #define RELAY_COMMAND_BEGIN 1
476 #define RELAY_COMMAND_DATA 2
477 #define RELAY_COMMAND_END 3
478 #define RELAY_COMMAND_CONNECTED 4
479 #define RELAY_COMMAND_SENDME 5
480 #define RELAY_COMMAND_EXTEND 6
481 #define RELAY_COMMAND_EXTENDED 7
482 #define RELAY_COMMAND_TRUNCATE 8
483 #define RELAY_COMMAND_TRUNCATED 9
484 #define RELAY_COMMAND_DROP 10
485 #define RELAY_COMMAND_RESOLVE 11
486 #define RELAY_COMMAND_RESOLVED 12
487 #define RELAY_COMMAND_BEGIN_DIR 13
489 #define RELAY_COMMAND_ESTABLISH_INTRO 32
490 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
491 #define RELAY_COMMAND_INTRODUCE1 34
492 #define RELAY_COMMAND_INTRODUCE2 35
493 #define RELAY_COMMAND_RENDEZVOUS1 36
494 #define RELAY_COMMAND_RENDEZVOUS2 37
495 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
496 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
497 #define RELAY_COMMAND_INTRODUCE_ACK 40
499 /* Reasons why an OR connection is closed */
500 #define END_OR_CONN_REASON_DONE 1
501 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
502 #define END_OR_CONN_REASON_OR_IDENTITY 3
503 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
504 #define END_OR_CONN_REASON_TIMEOUT 5
505 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
506 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
507 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
508 #define END_OR_CONN_REASON_MISC 9
510 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
511 * documentation of these. */
512 #define END_STREAM_REASON_MISC 1
513 #define END_STREAM_REASON_RESOLVEFAILED 2
514 #define END_STREAM_REASON_CONNECTREFUSED 3
515 #define END_STREAM_REASON_EXITPOLICY 4
516 #define END_STREAM_REASON_DESTROY 5
517 #define END_STREAM_REASON_DONE 6
518 #define END_STREAM_REASON_TIMEOUT 7
519 /* 8 is unallocated for historical reasons. */
520 #define END_STREAM_REASON_HIBERNATING 9
521 #define END_STREAM_REASON_INTERNAL 10
522 #define END_STREAM_REASON_RESOURCELIMIT 11
523 #define END_STREAM_REASON_CONNRESET 12
524 #define END_STREAM_REASON_TORPROTOCOL 13
525 #define END_STREAM_REASON_NOTDIRECTORY 14
526 #define END_STREAM_REASON_ENTRYPOLICY 15
528 /* These high-numbered end reasons are not part of the official spec,
529 * and are not intended to be put in relay end cells. They are here
530 * to be more informative when sending back socks replies to the
532 /* XXXX 256 is no longer used; feel free to reuse it. */
533 /** We were unable to attach the connection to any circuit at all. */
534 /* XXXX the ways we use this one don't make a lot of sense. */
535 #define END_STREAM_REASON_CANT_ATTACH 257
536 /** We can't connect to any directories at all, so we killed our streams
537 * before they can time out. */
538 #define END_STREAM_REASON_NET_UNREACHABLE 258
539 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
540 * protocol in a way we couldn't handle. */
541 #define END_STREAM_REASON_SOCKSPROTOCOL 259
542 /** This is a transparent proxy connection, but we can't extract the original
543 * target address:port. */
544 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
545 /** This is a connection on the NATD port, and the destination IP:Port was
546 * either ill-formed or out-of-range. */
547 #define END_STREAM_REASON_INVALID_NATD_DEST 261
549 /** Bitwise-and this value with endreason to mask out all flags. */
550 #define END_STREAM_REASON_MASK 511
552 /** Bitwise-or this with the argument to control_event_stream_status
553 * to indicate that the reason came from an END cell. */
554 #define END_STREAM_REASON_FLAG_REMOTE 512
555 /** Bitwise-or this with the argument to control_event_stream_status
556 * to indicate that we already sent a CLOSED stream event. */
557 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
558 /** Bitwise-or this with endreason to indicate that we already sent
559 * a socks reply, and no further reply needs to be sent from
560 * connection_mark_unattached_ap(). */
561 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
563 /** Reason for remapping an AP connection's address: we have a cached
565 #define REMAP_STREAM_SOURCE_CACHE 1
566 /** Reason for remapping an AP connection's address: the exit node told us an
568 #define REMAP_STREAM_SOURCE_EXIT 2
570 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
571 #define RESOLVED_TYPE_HOSTNAME 0
572 #define RESOLVED_TYPE_IPV4 4
573 #define RESOLVED_TYPE_IPV6 6
574 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
575 #define RESOLVED_TYPE_ERROR 0xF1
577 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
578 * call; they only go to the controller for tracking */
579 /** We couldn't build a path for this circuit. */
580 #define END_CIRC_REASON_NOPATH -2
581 /** Catch-all "other" reason for closing origin circuits. */
582 #define END_CIRC_AT_ORIGIN -1
584 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
585 * documentation of these. */
586 #define _END_CIRC_REASON_MIN 0
587 #define END_CIRC_REASON_NONE 0
588 #define END_CIRC_REASON_TORPROTOCOL 1
589 #define END_CIRC_REASON_INTERNAL 2
590 #define END_CIRC_REASON_REQUESTED 3
591 #define END_CIRC_REASON_HIBERNATING 4
592 #define END_CIRC_REASON_RESOURCELIMIT 5
593 #define END_CIRC_REASON_CONNECTFAILED 6
594 #define END_CIRC_REASON_OR_IDENTITY 7
595 #define END_CIRC_REASON_OR_CONN_CLOSED 8
596 #define END_CIRC_REASON_FINISHED 9
597 #define END_CIRC_REASON_TIMEOUT 10
598 #define END_CIRC_REASON_DESTROYED 11
599 #define END_CIRC_REASON_NOSUCHSERVICE 12
600 #define _END_CIRC_REASON_MAX 12
602 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
603 * control_event_circuit_status() to indicate that the reason was
604 * passed through from a destroy or truncate cell. */
605 #define END_CIRC_REASON_FLAG_REMOTE 512
607 /** Length of 'y' portion of 'y.onion' URL. */
608 #define REND_SERVICE_ID_LEN_BASE32 16
610 /** Length of 'y.onion' including '.onion' URL. */
611 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
613 /** Length of a binary-encoded rendezvous service ID. */
614 #define REND_SERVICE_ID_LEN 10
616 /** Time period for which a v2 descriptor will be valid. */
617 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
619 /** Time period within which two sets of v2 descriptors will be uploaded in
621 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
623 /** Number of non-consecutive replicas (i.e. distributed somewhere
624 * in the ring) for a descriptor. */
625 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
627 /** Number of consecutive replicas for a descriptor. */
628 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
630 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
631 #define REND_DESC_ID_V2_LEN_BASE32 32
633 /** Length of the base32-encoded secret ID part of versioned hidden service
635 #define REND_SECRET_ID_PART_LEN_BASE32 32
637 /** Length of the base32-encoded hash of an introduction point's
639 #define REND_INTRO_POINT_ID_LEN_BASE32 32
641 /** Length of the descriptor cookie that is used for client authorization
642 * to hidden services. */
643 #define REND_DESC_COOKIE_LEN 16
645 /** Length of the base64-encoded descriptor cookie that is used for
646 * exchanging client authorization between hidden service and client. */
647 #define REND_DESC_COOKIE_LEN_BASE64 22
649 /** Length of client identifier in encrypted introduction points for hidden
650 * service authorization type 'basic'. */
651 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
653 /** Multiple of the number of clients to which the real number of clients
654 * is padded with fake clients for hidden service authorization type
656 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
658 /** Length of client entry consisting of client identifier and encrypted
659 * session key for hidden service authorization type 'basic'. */
660 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
663 /** Maximum size of v2 hidden service descriptors. */
664 #define REND_DESC_MAX_SIZE (20 * 1024)
666 /** Legal characters for use in authorized client names for a hidden
668 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
669 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
671 /** Maximum length of authorized client names for a hidden service. */
672 #define REND_CLIENTNAME_MAX_LEN 16
674 /** Length of the rendezvous cookie that is used to connect circuits at the
675 * rendezvous point. */
676 #define REND_COOKIE_LEN DIGEST_LEN
678 /** Client authorization type that a hidden service performs. */
679 typedef enum rend_auth_type_t
{
682 REND_STEALTH_AUTH
= 2,
685 /** Client-side configuration of authorization for a hidden service. */
686 typedef struct rend_service_authorization_t
{
687 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
688 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
689 rend_auth_type_t auth_type
;
690 } rend_service_authorization_t
;
692 /** Client- and server-side data that is used for hidden service connection
693 * establishment. Not all fields contain data depending on where this struct
695 typedef struct rend_data_t
{
696 /** Onion address (without the .onion part) that a client requests. */
697 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
699 /** (Optional) descriptor cookie that is used by a client. */
700 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
702 /** Authorization type for accessing a service used by a client. */
703 rend_auth_type_t auth_type
;
705 /** Hash of the hidden service's PK used by a service. */
706 char rend_pk_digest
[DIGEST_LEN
];
708 /** Rendezvous cookie used by both, client and service. */
709 char rend_cookie
[REND_COOKIE_LEN
];
711 /** Rendezvous descriptor version that is used by a service. Used to
712 * distinguish introduction and rendezvous points belonging to the same
713 * rendezvous service ID, but different descriptor versions.
715 uint8_t rend_desc_version
;
718 /** Time interval for tracking possible replays of INTRODUCE2 cells.
719 * Incoming cells with timestamps half of this interval in the past or
720 * future are dropped immediately. */
721 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
723 #define CELL_DIRECTION_IN 1
724 #define CELL_DIRECTION_OUT 2
726 /** Initial value for both sides of a circuit transmission window when the
727 * circuit is initialized. Measured in cells. */
728 #define CIRCWINDOW_START 1000
729 /** Amount to increment a circuit window when we get a circuit SENDME. */
730 #define CIRCWINDOW_INCREMENT 100
731 /** Initial value on both sides of a stream transmission window when the
732 * stream is initialized. Measured in cells. */
733 #define STREAMWINDOW_START 500
734 /** Amount to increment a stream window when we get a stream SENDME. */
735 #define STREAMWINDOW_INCREMENT 50
738 #define CELL_PADDING 0
739 #define CELL_CREATE 1
740 #define CELL_CREATED 2
742 #define CELL_DESTROY 4
743 #define CELL_CREATE_FAST 5
744 #define CELL_CREATED_FAST 6
745 #define CELL_VERSIONS 7
746 #define CELL_NETINFO 8
747 #define CELL_RELAY_EARLY 9
749 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
751 /** How long to test reachability before complaining to the user. */
752 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
754 /** Legal characters in a nickname. */
755 #define LEGAL_NICKNAME_CHARACTERS \
756 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
758 /** Name to use in client TLS certificates if no nickname is given. Once
759 * Tor 0.1.2.x is obsolete, we can remove this. */
760 #define DEFAULT_CLIENT_NICKNAME "client"
762 /** Number of bytes in a SOCKS4 header. */
763 #define SOCKS4_NETWORK_LEN 8
767 * Relay command [1 byte]
768 * Recognized [2 bytes]
769 * Stream ID [2 bytes]
770 * Partial SHA-1 [4 bytes]
772 * Relay payload [498 bytes]
775 /** Number of bytes in a cell, minus cell header. */
776 #define CELL_PAYLOAD_SIZE 509
777 /** Number of bytes in a cell transmitted over the network. */
778 #define CELL_NETWORK_SIZE 512
780 #define VAR_CELL_HEADER_SIZE 5
782 /** Number of bytes in a relay cell's header (not including general cell
784 #define RELAY_HEADER_SIZE (1+2+2+4+2)
785 /** Largest number of bytes that can fit in a relay cell payload. */
786 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
788 /** Identifies a circuit on an or_connection */
789 typedef uint16_t circid_t
;
790 /** Identifies a stream on a circuit */
791 typedef uint16_t streamid_t
;
793 /** Parsed onion routing cell. All communication between nodes
795 typedef struct cell_t
{
796 circid_t circ_id
; /**< Circuit which received the cell. */
797 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
798 * CELL_DESTROY, etc */
799 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
802 /** Parsed variable-length onion routing cell. */
803 typedef struct var_cell_t
{
806 uint16_t payload_len
;
810 /** A cell as packed for writing to the network. */
811 typedef struct packed_cell_t
{
812 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
813 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
816 /** A queue of cells on a circuit, waiting to be added to the
817 * or_connection_t's outbuf. */
818 typedef struct cell_queue_t
{
819 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
820 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
821 int n
; /**< The number of cells in the queue. */
824 /** Beginning of a RELAY cell payload. */
826 uint8_t command
; /**< The end-to-end relay command. */
827 uint16_t recognized
; /**< Used to tell whether cell is for us. */
828 streamid_t stream_id
; /**< Which stream is this cell associated with? */
829 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
830 uint16_t length
; /**< How long is the payload body? */
833 typedef struct buf_t buf_t
;
834 typedef struct socks_request_t socks_request_t
;
836 /* Values for connection_t.magic: used to make sure that downcasts (casts from
837 * connection_t to foo_connection_t) are safe. */
838 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
839 #define OR_CONNECTION_MAGIC 0x7D31FF03u
840 #define EDGE_CONNECTION_MAGIC 0xF0374013u
841 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
842 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
844 /** Description of a connection to another host or process, and associated
847 * A connection is named based on what it's connected to -- an "OR
848 * connection" has a Tor node on the other end, an "exit
849 * connection" has a website or other server on the other end, and an
850 * "AP connection" has an application proxy (and thus a user) on the
853 * Every connection has a type and a state. Connections never change
854 * their type, but can go through many state changes in their lifetime.
856 * Every connection has two associated input and output buffers.
857 * Listeners don't use them. For non-listener connections, incoming
858 * data is appended to conn->inbuf, and outgoing data is taken from
859 * conn->outbuf. Connections differ primarily in the functions called
860 * to fill and drain these buffers.
862 typedef struct connection_t
{
863 uint32_t magic
; /**< For memory debugging: must equal one of
864 * *_CONNECTION_MAGIC. */
866 uint8_t state
; /**< Current state of this connection. */
867 unsigned int type
:4; /**< What kind of connection is this? */
868 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
870 /* The next fields are all one-bit booleans. Some are only applicable to
871 * connection subtypes, but we hold them here anyway, to save space.
873 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
874 * again once the bandwidth throttler allows it? */
875 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
876 * again once the bandwidth throttler allows
878 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
879 * marked for close, do we flush it
880 * before closing it? */
881 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
883 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
884 * connections. Set once we've set the stream end,
885 * and check in connection_about_to_close_connection().
887 /** Edge connections only: true if we've blocked reading until the
888 * circuit has fewer queued cells. */
889 unsigned int edge_blocked_on_circ
:1;
890 /** Used for OR conns that shouldn't get any new circs attached to them,
891 * because the connection is too old. */
892 /* XXXX "obsolete" isn't really a good name here. */
893 unsigned int or_is_obsolete
:1;
894 /** For AP connections only. If 1, and we fail to reach the chosen exit,
895 * stop requiring it. */
896 unsigned int chosen_exit_optional
:1;
897 /** For AP connections only. If non-zero, this exit node was picked as
898 * a result of the TrackHostExit, and the value decrements every time
899 * we fail to complete a circuit to our chosen exit -- if it reaches
900 * zero, abandon the associated mapaddress. */
901 unsigned int chosen_exit_retries
:3;
902 /** Set to 1 when we're inside connection_flushed_some to keep us from
903 * calling connection_handle_write() recursively. */
904 unsigned int in_flushed_some
:1;
906 /* For linked connections:
908 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
909 /** True iff we'd like to be notified about read events from the
911 unsigned int reading_from_linked_conn
:1;
912 /** True iff we're willing to write to the linked conn. */
913 unsigned int writing_to_linked_conn
:1;
914 /** True iff we're currently able to read on the linked conn, and our
915 * read_event should be made active with libevent. */
916 unsigned int active_on_link
:1;
917 /** True iff we've called connection_close_immediate() on this linked
919 unsigned int linked_conn_is_closed
:1;
921 int s
; /**< Our socket; -1 if this connection is closed, or has no
923 int conn_array_index
; /**< Index into the global connection array. */
924 struct event
*read_event
; /**< Libevent event structure. */
925 struct event
*write_event
; /**< Libevent event structure. */
926 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
927 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
928 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
930 time_t timestamp_lastread
; /**< When was the last time libevent said we could
932 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
934 time_t timestamp_created
; /**< When was this connection_t created? */
936 /* XXXX_IP6 make this ipv6-capable */
937 int socket_family
; /**< Address family of this connection's socket. Usually
938 * AF_INET, but it can also be AF_UNIX, or in the future
940 tor_addr_t addr
; /**< IP of the other side of the connection; used to
941 * identify routers, along with port. */
942 uint16_t port
; /**< If non-zero, port on the other end
943 * of the connection. */
944 uint16_t marked_for_close
; /**< Should we close this conn on the next
945 * iteration of the main loop? (If true, holds
946 * the line number where this connection was
948 const char *marked_for_close_file
; /**< For debugging: in which file were
949 * we marked for close? */
950 char *address
; /**< FQDN (or IP) of the guy on the other end.
951 * strdup into this, because free_connection() frees it. */
952 /** Another connection that's connected to this one in lieu of a socket. */
953 struct connection_t
*linked_conn
;
955 /** Unique identifier for this connection. */
956 uint64_t global_identifier
;
958 /* XXXX021 move this into a subtype. */
959 struct evdns_server_port
*dns_server_port
;
963 /** Stores flags and information related to the portion of a v2 Tor OR
964 * connection handshake that happens after the TLS handshake is finished.
966 typedef struct or_handshake_state_t
{
967 /** When was the VERSIONS cell sent on this connection? Used to get
968 * an estimate of the skew in the returning NETINFO reply. */
969 time_t sent_versions_at
;
970 /** True iff we originated this connection */
971 unsigned int started_here
: 1;
972 /** True iff we have received and processed a VERSIONS cell. */
973 unsigned int received_versions
: 1;
974 } or_handshake_state_t
;
976 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
978 typedef struct or_connection_t
{
981 /** Hash of the public RSA key for the other side's identity key, or zeroes
982 * if the other side hasn't shown us a valid identity key. */
983 char identity_digest
[DIGEST_LEN
];
984 char *nickname
; /**< Nickname of OR on other side (if any). */
986 tor_tls_t
*tls
; /**< TLS connection state. */
987 int tls_error
; /**< Last tor_tls error code. */
988 /** When we last used this conn for any client traffic. If not
989 * recent, we can rate limit it further. */
992 tor_addr_t real_addr
; /**< The actual address that this connection came from
993 * or went to. The <b>addr</b> field is prone to
994 * getting overridden by the address from the router
995 * descriptor matching <b>identity_digest</b>. */
997 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
998 * connection, which half of the space should
1000 /** Should this connection be used for extending circuits to the server
1001 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1002 * sure we aren't getting MITMed, either because we're connected to an
1003 * address listed in a server descriptor, or because an authenticated
1004 * NETINFO cell listed the address we're connected to as recognized. */
1005 unsigned int is_canonical
:1;
1006 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1007 * "none negotiated yet." */
1008 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1009 * this connection? This is always in the
1010 * range 0..1<<15-1. */
1012 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1013 * up, state information to do so. */
1014 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1015 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1016 * non-padding cell to the outbuf? */
1018 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
1019 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1020 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1021 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1022 * add 'bandwidthrate' to this, capping it at
1023 * bandwidthburst. (OPEN ORs only) */
1024 int n_circuits
; /**< How many circuits use this connection as p_conn or
1027 /** Double-linked ring of circuits with queued cells waiting for room to
1028 * free up on this connection's outbuf. Every time we pull cells from a
1029 * circuit, we advance this pointer to the next circuit in the ring. */
1030 struct circuit_t
*active_circuits
;
1031 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1032 * identity digest as this one. */
1035 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1036 * connection, or an exit. */
1037 typedef struct edge_connection_t
{
1040 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1042 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1043 * this conn exits at. */
1044 int package_window
; /**< How many more relay cells can I send into the
1046 int deliver_window
; /**< How many more relay cells can end at me? */
1048 /** Nickname of planned exit node -- used with .exit support. */
1049 char *chosen_exit_name
;
1051 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1053 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1054 * connection is using. */
1056 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1057 * connection. Exit connections only. */
1059 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1062 /** The reason why this connection is closing; passed to the controller. */
1063 uint16_t end_reason
;
1065 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1068 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1071 /** What rendezvous service are we querying for? (AP only) */
1072 rend_data_t
*rend_data
;
1074 /** Number of times we've reassigned this application connection to
1075 * a new circuit. We keep track because the timeout is longer if we've
1076 * already retried several times. */
1077 uint8_t num_socks_retries
;
1079 /** True iff this connection is for a dns request only. */
1080 unsigned int is_dns_request
:1;
1082 /** True iff this stream must attach to a one-hop circuit (e.g. for
1084 unsigned int want_onehop
:1;
1085 /** True iff this stream should use a BEGIN_DIR relay command to establish
1086 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1087 unsigned int use_begindir
:1;
1089 /** If this is a DNSPort connection, this field holds the pending DNS
1090 * request that we're going to try to answer. */
1091 struct evdns_server_request
*dns_server_request
;
1093 } edge_connection_t
;
1095 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1096 * connection to retrieve or serve directory material. */
1097 typedef struct dir_connection_t
{
1100 char *requested_resource
; /**< Which 'resource' did we ask the directory
1102 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1104 /* Used only for server sides of some dir connections, to implement
1105 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1106 * to append everything to the outbuf in one enormous chunk. */
1107 /** What exactly are we spooling right now? */
1109 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1110 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1111 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
1112 } dir_spool_src
: 3;
1113 /** If we're fetching descriptors, what router purpose shall we assign
1115 uint8_t router_purpose
;
1116 /** List of fingerprints for networkstatuses or desriptors to be spooled. */
1117 smartlist_t
*fingerprint_stack
;
1118 /** A cached_dir_t object that we're currently spooling out */
1119 struct cached_dir_t
*cached_dir
;
1120 /** The current offset into cached_dir. */
1121 off_t cached_dir_offset
;
1122 /** The zlib object doing on-the-fly compression for spooled data. */
1123 tor_zlib_state_t
*zlib_state
;
1125 /** What rendezvous service are we querying for? */
1126 rend_data_t
*rend_data
;
1128 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1129 * the directory server's signing key. */
1133 /** Subtype of connection_t for an connection to a controller. */
1134 typedef struct control_connection_t
{
1137 uint32_t event_mask
; /**< Bitfield: which events does this controller
1139 unsigned int use_long_names
:1; /**< True if we should use long nicknames
1140 * on this (v1) connection. Only settable
1141 * via v1 controllers. */
1142 /** For control connections only. If set, we send extended info with control
1143 * events as appropriate. */
1144 unsigned int use_extended_events
:1;
1146 /** True if we have sent a protocolinfo reply on this connection. */
1147 unsigned int have_sent_protocolinfo
:1;
1149 uint32_t incoming_cmd_len
;
1150 uint32_t incoming_cmd_cur_len
;
1152 /* Used only by control v0 connections */
1153 uint16_t incoming_cmd_type
;
1154 } control_connection_t
;
1156 /** Cast a connection_t subtype pointer to a connection_t **/
1157 #define TO_CONN(c) (&(((c)->_base)))
1158 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1159 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1161 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1163 static or_connection_t
*TO_OR_CONN(connection_t
*);
1164 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1166 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1167 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1169 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1170 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1172 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1174 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1176 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1177 return DOWNCAST(or_connection_t
, c
);
1179 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1181 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1182 return DOWNCAST(dir_connection_t
, c
);
1184 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1186 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1187 return DOWNCAST(edge_connection_t
, c
);
1189 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1191 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1192 return DOWNCAST(control_connection_t
, c
);
1196 ADDR_POLICY_ACCEPT
=1,
1197 ADDR_POLICY_REJECT
=2,
1198 } addr_policy_action_t
;
1200 /** A reference-counted address policy rule. */
1201 typedef struct addr_policy_t
{
1202 int refcnt
; /**< Reference count */
1203 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1204 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1206 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1207 * copy (stored in a hash table to avoid
1208 * duplication of common policies) */
1209 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1210 * first <b>maskbits</b> bits of <b>a</b> match
1212 tor_addr_t addr
; /**< Base address to accept or reject. */
1213 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1214 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1217 /** A cached_dir_t represents a cacheable directory object, along with its
1218 * compressed form. */
1219 typedef struct cached_dir_t
{
1220 char *dir
; /**< Contents of this object, nul-terminated. */
1221 char *dir_z
; /**< Compressed contents of this object. */
1222 size_t dir_len
; /**< Length of <b>dir</b> (not counting its nul). */
1223 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1224 time_t published
; /**< When was this object published. */
1225 int refcnt
; /**< Reference count for this cached_dir_t. */
1228 /** Enum used to remember where a signed_descriptor_t is stored and how to
1229 * manage the memory for signed_descriptor_body. */
1231 /** The descriptor isn't stored on disk at all: the copy in memory is
1232 * canonical; the saved_offset field is meaningless. */
1234 /** The descriptor is stored in the cached_routers file: the
1235 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1236 * saved_offset are used to index into the mmaped cache file. */
1238 /** The descriptor is stored in the cached_routers.new file: the
1239 * signed_descriptor_body and saved_offset fields are both set. */
1240 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1241 * lazy-load the descriptor text by using seek and read. We don't, for
1247 /** Enumeration: what kind of downlaod schedule are we using for a given
1250 DL_SCHED_GENERIC
= 0,
1251 DL_SCHED_CONSENSUS
= 1,
1252 } download_schedule_t
;
1254 /** Information about our plans for retrying downloads for a downloadable
1256 typedef struct download_status_t
{
1257 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1259 uint8_t n_download_failures
; /**< Number of failures trying to download the
1260 * most recent descriptor. */
1261 download_schedule_t schedule
: 8;
1262 } download_status_t
;
1264 /** The max size we expect router descriptor annotations we create to
1265 * be. We'll accept larger ones if we see them on disk, but we won't
1266 * create any that are larger than this. */
1267 #define ROUTER_ANNOTATION_BUF_LEN 256
1269 /** Information need to cache an onion router's descriptor. */
1270 typedef struct signed_descriptor_t
{
1271 /** Pointer to the raw server descriptor, preceded by annotations. Not
1272 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1273 * pointer is null. */
1274 char *signed_descriptor_body
;
1275 /** Length of the annotations preceeding the server descriptor. */
1276 size_t annotations_len
;
1277 /** Length of the server descriptor. */
1278 size_t signed_descriptor_len
;
1279 /** Digest of the server descriptor, computed as specified in
1281 char signed_descriptor_digest
[DIGEST_LEN
];
1282 /** Identity digest of the router. */
1283 char identity_digest
[DIGEST_LEN
];
1284 /** Declared publication time of the descriptor. */
1285 time_t published_on
;
1286 /** For routerdescs only: digest of the corresponding extrainfo. */
1287 char extra_info_digest
[DIGEST_LEN
];
1288 /** For routerdescs only: Status of downloading the corresponding
1290 download_status_t ei_dl_status
;
1291 /** Where is the descriptor saved? */
1292 saved_location_t saved_location
;
1293 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1294 * this descriptor in the corresponding file. */
1296 /** What position is this descriptor within routerlist->routers or
1297 * routerlist->old_routers? -1 for none. */
1298 int routerlist_index
;
1299 /** The valid-until time of the most recent consensus that listed this
1300 * descriptor, or a bit after the publication time of the most recent v2
1301 * networkstatus that listed it. 0 for "never listed in a consensus or
1302 * status, so far as we know." */
1303 time_t last_listed_as_valid_until
;
1304 #ifdef TRACK_SERVED_TIME
1306 time_t last_served_at
; /*XXXX021 remove if not useful. */
1308 /* If true, we do not ever try to save this object in the cache. */
1309 unsigned int do_not_cache
: 1;
1310 /* If true, this item is meant to represent an extrainfo. */
1311 unsigned int is_extrainfo
: 1;
1312 /* If true, we got an extrainfo for this item, and the digest was right,
1313 * but it was incompatible. */
1314 unsigned int extrainfo_is_bogus
: 1;
1315 /* If true, we are willing to transmit this item unencrypted. */
1316 unsigned int send_unencrypted
: 1;
1317 } signed_descriptor_t
;
1319 /** A signed integer representing a country code. */
1320 typedef int16_t country_t
;
1322 /** Information about another onion router in the network. */
1324 signed_descriptor_t cache_info
;
1325 char *address
; /**< Location of OR: either a hostname or an IP address. */
1326 char *nickname
; /**< Human-readable OR name. */
1328 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1329 uint16_t or_port
; /**< Port for TLS connections. */
1330 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1332 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1333 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1335 char *platform
; /**< What software/operating system is this OR using? */
1338 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1339 * bucket per second? */
1340 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1341 /** How many bytes/s is this router known to handle? */
1342 uint32_t bandwidthcapacity
;
1343 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1344 * to exit? NULL for 'reject *:*'. */
1345 long uptime
; /**< How many seconds the router claims to have been up */
1346 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1347 * claims are its family. */
1348 char *contact_info
; /**< Declared contact info for this router. */
1349 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1351 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1352 * dnsworker code. */
1353 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1354 * extrainfo documents. */
1355 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1356 * single hop exits. */
1359 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1361 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1362 * (For Authdir: Have we validated this OR?)
1364 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1366 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1367 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1368 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1369 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1370 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1371 * or otherwise nasty? */
1372 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1373 * underpowered, or otherwise useless? */
1374 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1375 * a hidden service directory. */
1376 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1377 * directory according to the authorities. */
1379 /** Tor can use this router for general positions in circuits. */
1380 #define ROUTER_PURPOSE_GENERAL 0
1381 /** Tor should avoid using this router for circuit-building. */
1382 #define ROUTER_PURPOSE_CONTROLLER 1
1383 /** Tor should use this router only for bridge positions in circuits. */
1384 #define ROUTER_PURPOSE_BRIDGE 2
1385 /** Tor should not use this router; it was marked in cached-descriptors with
1386 * a purpose we didn't recognize. */
1387 #define ROUTER_PURPOSE_UNKNOWN 255
1389 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1391 /* The below items are used only by authdirservers for
1392 * reachability testing. */
1393 /** When was the last time we could reach this OR? */
1394 time_t last_reachable
;
1395 /** When did we start testing reachability for this OR? */
1396 time_t testing_since
;
1397 /** According to the geoip db what country is this router in? */
1401 /** Information needed to keep and cache a signed extra-info document. */
1402 typedef struct extrainfo_t
{
1403 signed_descriptor_t cache_info
;
1404 /** The router's nickname. */
1405 char nickname
[MAX_NICKNAME_LEN
+1];
1406 /** True iff we found the right key for this extra-info, verified the
1407 * signature, and found it to be bad. */
1408 unsigned int bad_sig
: 1;
1409 /** If present, we didn't have the right key to verify this extra-info,
1410 * so this is a copy of the signature in the document. */
1412 /** Length of pending_sig. */
1413 size_t pending_sig_len
;
1416 /** Contents of a single router entry in a network status object.
1418 typedef struct routerstatus_t
{
1419 time_t published_on
; /**< When was this router published? */
1420 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1422 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1424 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1426 uint32_t addr
; /**< IPv4 address for this router. */
1427 uint16_t or_port
; /**< OR port for this router. */
1428 uint16_t dir_port
; /**< Directory port for this router. */
1429 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1430 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1431 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1432 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1433 unsigned int is_running
:1; /**< True iff this router is up. */
1434 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1435 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1437 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1438 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1439 * information with v2 of the directory
1440 * protocol. (All directory caches cache v1
1442 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1443 * choice as an entry guard. */
1444 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1446 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1447 * underpowered, or otherwise useless? */
1448 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1449 * service directory. */
1450 /** True iff we know version info for this router. (i.e., a "v" entry was
1451 * included.) We'll replace all these with a big tor_version_t or a char[]
1452 * if the number of traits we care about ever becomes incredibly big. */
1453 unsigned int version_known
:1;
1454 /** True iff this router is a version that supports BEGIN_DIR cells. */
1455 unsigned int version_supports_begindir
:1;
1456 /** True iff this router is a version that supports conditional consensus
1457 * downloads (signed by list of authorities). */
1458 unsigned int version_supports_conditional_consensus
:1;
1459 /** True iff this router is a version that we can post extrainfo docs to. */
1460 unsigned int version_supports_extrainfo_upload
:1;
1461 /** True iff this router is a version that, if it caches directory info,
1462 * we can get v3 downloads from. */
1463 unsigned int version_supports_v3_dir
:1;
1465 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1466 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1468 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1469 * the vote/consensus, in kilobytes/sec. */
1470 char *exitsummary
; /**< exit policy summary -
1471 * XXX weasel: this probably should not stay a string. */
1473 /* ---- The fields below aren't derived from the networkstatus; they
1474 * hold local information only. */
1476 /** True if we, as a directory mirror, want to download the corresponding
1477 * routerinfo from the authority who gave us this routerstatus. (That is,
1478 * if we don't have the routerinfo, and if we haven't already tried to get it
1479 * from this authority.) Applies in v2 networkstatus document only.
1481 unsigned int need_to_mirror
:1;
1482 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1483 * to this (unnamed) router by nickname?
1485 time_t last_dir_503_at
; /**< When did this router last tell us that it
1486 * was too busy to serve directory info? */
1487 download_status_t dl_status
;
1491 /** How many times will we try to download a router's descriptor before giving
1493 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1495 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1496 typedef struct networkstatus_v2_t
{
1497 /** When did we receive the network-status document? */
1500 /** What was the digest of the document? */
1501 char networkstatus_digest
[DIGEST_LEN
];
1503 unsigned int is_recent
; /**< Is this recent enough to influence running
1506 /* These fields come from the actual network-status document.*/
1507 time_t published_on
; /**< Declared publication date. */
1509 char *source_address
; /**< Canonical directory server hostname. */
1510 uint32_t source_addr
; /**< Canonical directory server IP. */
1511 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1513 unsigned int binds_names
:1; /**< True iff this directory server binds
1515 unsigned int recommends_versions
:1; /**< True iff this directory server
1516 * recommends client and server software
1518 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1519 * malfunctioning exits as bad. */
1520 /** True iff this directory server marks malfunctioning directories as
1522 unsigned int lists_bad_directories
:1;
1524 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1525 char *contact
; /**< How to contact directory admin? (may be NULL). */
1526 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1527 char *client_versions
; /**< comma-separated list of recommended client
1529 char *server_versions
; /**< comma-separated list of recommended server
1532 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1533 * sorted by identity_digest. */
1534 } networkstatus_v2_t
;
1536 /** The claim about a single router, make in a vote. */
1537 typedef struct vote_routerstatus_t
{
1538 routerstatus_t status
; /**< Underlying 'status' object for this router.
1539 * Flags are redundant. */
1540 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1541 * networkstatus_t.known_flags. */
1542 char *version
; /**< The version that the authority says this router is
1544 } vote_routerstatus_t
;
1546 /** Information about a single voter in a vote or a consensus. */
1547 typedef struct networkstatus_voter_info_t
{
1548 char *nickname
; /**< Nickname of this voter */
1549 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1550 char *address
; /**< Address of this voter, in string format. */
1551 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1552 uint16_t dir_port
; /**< Directory port of this voter */
1553 uint16_t or_port
; /**< OR port of this voter */
1554 char *contact
; /**< Contact information for this voter. */
1555 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1556 char legacy_id_digest
[DIGEST_LEN
]; /**< From vote only. DOCDOC */
1558 /* Nothing from here on is signed. */
1559 char signing_key_digest
[DIGEST_LEN
]; /**< Declared digest of signing key
1560 * used by this voter. */
1561 char *signature
; /**< Signature from this voter. */
1562 int signature_len
; /**< Length of <b>signature</b> */
1563 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1564 * the sig, and we know it's bad. */
1565 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1567 } networkstatus_voter_info_t
;
1569 /** Enumerates the possible seriousness values of a networkstatus document. */
1574 } networkstatus_type_t
;
1576 /** A common structure to hold a v3 network status vote, or a v3 network
1577 * status consensus. */
1578 typedef struct networkstatus_t
{
1579 networkstatus_type_t type
; /**< Vote, consensus, or opinion? */
1580 time_t published
; /**< Vote only: Tiem when vote was written. */
1581 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1582 time_t fresh_until
; /**< Time before which this is the most recent vote or
1584 time_t valid_until
; /**< Time after which this vote or consensus should not
1587 /** Consensus only: what method was used to produce this consensus? */
1588 int consensus_method
;
1589 /** Vote only: what methods is this voter willing to use? */
1590 smartlist_t
*supported_methods
;
1592 /** How long does this vote/consensus claim that authorities take to
1593 * distribute their votes to one another? */
1595 /** How long does this vote/consensus claim that authorites take to
1596 * distribute their consensus signatures to one another? */
1599 /** Comma-separated list of recommended client software, or NULL if this
1600 * voter has no opinion. */
1601 char *client_versions
;
1602 char *server_versions
;
1603 /** List of flags that this vote/consensus applies to routers. If a flag is
1604 * not listed here, the voter has no opinion on what its value should be. */
1605 smartlist_t
*known_flags
;
1607 /** List of networkstatus_voter_info_t. For a vote, only one element
1608 * is included. For a consensus, one element is included for every voter
1609 * whose vote contributed to the consensus. */
1610 smartlist_t
*voters
;
1612 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1614 /** Digest of this document, as signed. */
1615 char networkstatus_digest
[DIGEST_LEN
];
1617 /** List of router statuses, sorted by identity digest. For a vote,
1618 * the elements are vote_routerstatus_t; for a consensus, the elements
1619 * are routerstatus_t. */
1620 smartlist_t
*routerstatus_list
;
1622 /** If present, a map from descriptor digest to elements of
1623 * routerstatus_list. */
1624 digestmap_t
*desc_digest_map
;
1627 /** A set of signatures for a networkstatus consensus. All fields are as for
1628 * networkstatus_t. */
1629 typedef struct ns_detached_signatures_t
{
1633 char networkstatus_digest
[DIGEST_LEN
];
1634 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1635 } ns_detached_signatures_t
;
1637 /** Allowable types of desc_store_t. */
1638 typedef enum store_type_t
{
1643 /** A 'store' is a set of descriptors saved on disk, with accompanying
1644 * journal, mmaped as needed, rebuilt as needed. */
1645 typedef struct desc_store_t
{
1646 /** Filename (within DataDir) for the store. We append .tmp to this
1647 * filename for a temporary file when rebuilding the store, and .new to this
1648 * filename for the journal. */
1649 const char *fname_base
;
1650 /** Alternative (obsolete) value for fname_base: if the file named by
1651 * fname_base isn't present, we read from here instead, but we never write
1653 const char *fname_alt_base
;
1654 /** Human-readable description of what this store contains. */
1655 const char *description
;
1657 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1659 store_type_t type
; /**< What's stored in this store? */
1661 /** The size of the router log, in bytes. */
1663 /** The size of the router store, in bytes. */
1665 /** Total bytes dropped since last rebuild: this is space currently
1666 * used in the cache and the journal that could be freed by a rebuild. */
1667 size_t bytes_dropped
;
1670 /** Contents of a directory of onion routers. */
1672 /** Map from server identity digest to a member of routers. */
1673 struct digest_ri_map_t
*identity_map
;
1674 /** Map from server descriptor digest to a signed_descriptor_t from
1675 * routers or old_routers. */
1676 struct digest_sd_map_t
*desc_digest_map
;
1677 /** Map from extra-info digest to an extrainfo_t. Only exists for
1678 * routers in routers or old_routers. */
1679 struct digest_ei_map_t
*extra_info_map
;
1680 /** Map from extra-info digests to a signed_descriptor_t for a router
1681 * descriptor having that extra-info digest. Only exists for
1682 * routers in routers or old_routers. */
1683 struct digest_sd_map_t
*desc_by_eid_map
;
1684 /** List of routerinfo_t for all currently live routers we know. */
1685 smartlist_t
*routers
;
1686 /** List of signed_descriptor_t for older router descriptors we're
1688 smartlist_t
*old_routers
;
1689 /** Store holding server descriptors. If present, any router whose
1690 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1691 * starting at cache_info.saved_offset */
1692 desc_store_t desc_store
;
1693 /** Store holding extra-info documents. */
1694 desc_store_t extrainfo_store
;
1697 /** Information on router used when extending a circuit. We don't need a
1698 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1699 * connection, and onion_key to create the onionskin. Note that for onehop
1700 * general-purpose tunnels, the onion_key is NULL. */
1701 typedef struct extend_info_t
{
1702 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1704 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1705 uint16_t port
; /**< OR port. */
1706 tor_addr_t addr
; /**< IP address. */
1707 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1710 /** Certificate for v3 directory protocol: binds long-term authority identity
1711 * keys to medium-term authority signing keys. */
1712 typedef struct authority_cert_t
{
1713 signed_descriptor_t cache_info
;
1714 crypto_pk_env_t
*identity_key
;
1715 crypto_pk_env_t
*signing_key
;
1716 char signing_key_digest
[DIGEST_LEN
];
1722 /** Bitfield enum type listing types of directory authority/directory
1726 V1_AUTHORITY
= 1 << 0,
1727 V2_AUTHORITY
= 1 << 1,
1728 V3_AUTHORITY
= 1 << 2,
1729 HIDSERV_AUTHORITY
= 1 << 3,
1730 BRIDGE_AUTHORITY
= 1 << 4,
1731 EXTRAINFO_CACHE
= 1 << 5, /* not precisely an authority type. */
1734 #define CRYPT_PATH_MAGIC 0x70127012u
1736 /** Holds accounting information for a single step in the layered encryption
1737 * performed by a circuit. Used only at the client edge of a circuit. */
1738 typedef struct crypt_path_t
{
1741 /* crypto environments */
1742 /** Encryption key and counter for cells heading towards the OR at this
1744 crypto_cipher_env_t
*f_crypto
;
1745 /** Encryption key and counter for cells heading back from the OR at this
1747 crypto_cipher_env_t
*b_crypto
;
1749 /** Digest state for cells heading towards the OR at this step. */
1750 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1751 /** Digest state for cells heading away from the OR at this step. */
1752 crypto_digest_env_t
*b_digest
;
1754 /** Current state of Diffie-Hellman key negotiation with the OR at this
1756 crypto_dh_env_t
*dh_handshake_state
;
1757 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1758 * step. Used to save CPU when TLS is already providing all the
1759 * authentication, secrecy, and integrity we need, and we're already
1760 * distinguishable from an OR.
1762 char fast_handshake_state
[DIGEST_LEN
];
1763 /** Negotiated key material shared with the OR at this step. */
1764 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1766 /** Information to extend to the OR at this step. */
1767 extend_info_t
*extend_info
;
1769 /** Is the circuit built to this step? Must be one of:
1770 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1771 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1772 * and not received an EXTENDED/CREATED)
1773 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1775 #define CPATH_STATE_CLOSED 0
1776 #define CPATH_STATE_AWAITING_KEYS 1
1777 #define CPATH_STATE_OPEN 2
1778 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1779 * (The list is circular, so the last node
1780 * links to the first.) */
1781 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1784 int package_window
; /**< How many bytes are we allowed to originate ending
1786 int deliver_window
; /**< How many bytes are we willing to deliver originating
1790 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1792 #define DH_KEY_LEN DH_BYTES
1793 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1796 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1798 /** Information used to build a circuit. */
1800 /** Intended length of the final circuit. */
1801 int desired_path_len
;
1802 /** How to extend to the planned exit node. */
1803 extend_info_t
*chosen_exit
;
1804 /** Whether every node in the circ must have adequate uptime. */
1806 /** Whether every node in the circ must have adequate capacity. */
1808 /** Whether the last hop was picked with exiting in mind. */
1810 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1811 * These are for encrypted connections that exit to this router, not
1812 * for arbitrary exits from the circuit. */
1814 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1815 crypt_path_t
*pending_final_cpath
;
1816 /** How many times has building a circuit for this task failed? */
1818 /** At what time should we give up on this task? */
1820 } cpath_build_state_t
;
1822 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1823 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1826 * A circuit is a path over the onion routing
1827 * network. Applications can connect to one end of the circuit, and can
1828 * create exit connections at the other end of the circuit. AP and exit
1829 * connections have only one circuit associated with them (and thus these
1830 * connection types are closed when the circuit is closed), whereas
1831 * OR connections multiplex many circuits at once, and stay standing even
1832 * when there are no circuits running over them.
1834 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1835 * links two connections together: either an edge connection and an OR
1836 * connection, or two OR connections. (When joined to an OR connection, a
1837 * circuit_t affects only cells sent to a particular circID on that
1838 * connection. When joined to an edge connection, a circuit_t affects all
1841 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1842 * along a given circuit. At the OP, it has a sequence of ciphers, each
1843 * of which is shared with a single OR along the circuit. Separate
1844 * ciphers are used for data going "forward" (away from the OP) and
1845 * "backward" (towards the OP). At the OR, a circuit has only two stream
1846 * ciphers: one for data going forward, and one for data going backward.
1848 typedef struct circuit_t
{
1849 uint32_t magic
; /**< For memory and type debugging: must equal
1850 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1852 /** Queue of cells waiting to be transmitted on n_conn. */
1853 cell_queue_t n_conn_cells
;
1854 /** The OR connection that is next in this circuit. */
1855 or_connection_t
*n_conn
;
1856 /** The circuit_id used in the next (forward) hop of this circuit. */
1859 /** The hop to which we want to extend this ciruit. Should be NULL if
1860 * the circuit has attached to a connection. */
1861 extend_info_t
*n_hop
;
1863 /** True iff we are waiting for n_conn_cells to become less full before
1864 * allowing p_streams to add any more cells. (Origin circuit only.) */
1865 unsigned int streams_blocked_on_n_conn
: 1;
1866 /** True iff we are waiting for p_conn_cells to become less full before
1867 * allowing n_streams to add any more cells. (OR circuit only.) */
1868 unsigned int streams_blocked_on_p_conn
: 1;
1870 uint8_t state
; /**< Current status of this circuit. */
1871 uint8_t purpose
; /**< Why are we creating this circuit? */
1873 /** How many relay data cells can we package (read from edge streams)
1874 * on this circuit before we receive a circuit-level sendme cell asking
1877 /** How many relay data cells will we deliver (write to edge streams)
1878 * on this circuit? When deliver_window gets low, we send some
1879 * circuit-level sendme cells to indicate that we're willing to accept
1883 /** For storage while n_conn is pending
1884 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1885 * length ONIONSKIN_CHALLENGE_LEN. */
1886 char *n_conn_onionskin
;
1888 time_t timestamp_created
; /**< When was this circuit created? */
1889 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1890 * circuit is clean. */
1892 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1893 * the main loop? (If true, holds the line number
1894 * where this circuit was marked.) */
1895 const char *marked_for_close_file
; /**< For debugging: in which file was this
1896 * circuit marked for close? */
1898 /** Next circuit in the doubly-linked ring of circuits waiting to add
1899 * cells to n_conn. NULL if we have no cells pending, or if we're not
1900 * linked to an OR connection. */
1901 struct circuit_t
*next_active_on_n_conn
;
1902 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1903 * cells to n_conn. NULL if we have no cells pending, or if we're not
1904 * linked to an OR connection. */
1905 struct circuit_t
*prev_active_on_n_conn
;
1906 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1909 /** Largest number of relay_early cells that we can send on a given
1911 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
1913 /** An origin_circuit_t holds data necessary to build and use a circuit.
1915 typedef struct origin_circuit_t
{
1918 /** Linked list of AP streams (or EXIT streams if hidden service)
1919 * associated with this circuit. */
1920 edge_connection_t
*p_streams
;
1921 /** Build state for this circuit. It includes the intended path
1922 * length, the chosen exit router, rendezvous information, etc.
1924 cpath_build_state_t
*build_state
;
1925 /** The doubly-linked list of crypt_path_t entries, one per hop,
1926 * for this circuit. This includes ciphers for each hop,
1927 * integrity-checking digests for each hop, and package/delivery
1928 * windows for each hop.
1930 crypt_path_t
*cpath
;
1932 /** Holds all rendezvous data on either client or service side. */
1933 rend_data_t
*rend_data
;
1935 /** How many more relay_early cells can we send on this circuit, according
1936 * to the specification? */
1937 unsigned int remaining_relay_early_cells
: 4;
1939 /** The next stream_id that will be tried when we're attempting to
1940 * construct a new AP stream originating at this circuit. */
1941 streamid_t next_stream_id
;
1943 /* The intro key replaces the hidden service's public key if purpose is
1944 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
1945 * descriptor is used. */
1946 crypto_pk_env_t
*intro_key
;
1948 /** Quasi-global identifier for this circuit; used for control.c */
1949 /* XXXX NM This can get re-used after 2**32 circuits. */
1950 uint32_t global_identifier
;
1954 /** An or_circuit_t holds information needed to implement a circuit at an
1956 typedef struct or_circuit_t
{
1959 /** Next circuit in the doubly-linked ring of circuits waiting to add
1960 * cells to p_conn. NULL if we have no cells pending, or if we're not
1961 * linked to an OR connection. */
1962 struct circuit_t
*next_active_on_p_conn
;
1963 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1964 * cells to p_conn. NULL if we have no cells pending, or if we're not
1965 * linked to an OR connection. */
1966 struct circuit_t
*prev_active_on_p_conn
;
1968 /** The circuit_id used in the previous (backward) hop of this circuit. */
1970 /** Queue of cells waiting to be transmitted on p_conn. */
1971 cell_queue_t p_conn_cells
;
1972 /** The OR connection that is previous in this circuit. */
1973 or_connection_t
*p_conn
;
1974 /** Linked list of Exit streams associated with this circuit. */
1975 edge_connection_t
*n_streams
;
1976 /** Linked list of Exit streams associated with this circuit that are
1977 * still being resolved. */
1978 edge_connection_t
*resolving_streams
;
1979 /** The cipher used by intermediate hops for cells heading toward the
1981 crypto_cipher_env_t
*p_crypto
;
1982 /** The cipher used by intermediate hops for cells heading away from
1984 crypto_cipher_env_t
*n_crypto
;
1986 /** The integrity-checking digest used by intermediate hops, for
1987 * cells packaged here and heading towards the OP.
1989 crypto_digest_env_t
*p_digest
;
1990 /** The integrity-checking digest used by intermediate hops, for
1991 * cells packaged at the OP and arriving here.
1993 crypto_digest_env_t
*n_digest
;
1995 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
1996 * is not marked for close. */
1997 struct or_circuit_t
*rend_splice
;
1999 #if REND_COOKIE_LEN >= DIGEST_LEN
2000 #define REND_TOKEN_LEN REND_COOKIE_LEN
2002 #define REND_TOKEN_LEN DIGEST_LEN
2005 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2006 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2008 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2010 char rend_token
[REND_TOKEN_LEN
];
2012 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2013 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2015 /** How many more relay_early cells can we send on this circuit, according
2016 * to the specification? */
2017 unsigned int remaining_relay_early_cells
: 4;
2019 /** True iff this circuit was made with a CREATE_FAST cell. */
2020 unsigned int is_first_hop
: 1;
2023 /** Convert a circuit subtype to a circuit_t.*/
2024 #define TO_CIRCUIT(x) (&((x)->_base))
2026 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2027 * if the cast is impossible. */
2028 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2029 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2030 * Asserts if the cast is impossible. */
2031 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2033 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2035 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2036 return DOWNCAST(or_circuit_t
, x
);
2038 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2040 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2041 return DOWNCAST(origin_circuit_t
, x
);
2044 #define ALLOW_INVALID_ENTRY 1
2045 #define ALLOW_INVALID_EXIT 2
2046 #define ALLOW_INVALID_MIDDLE 4
2047 #define ALLOW_INVALID_RENDEZVOUS 8
2048 #define ALLOW_INVALID_INTRODUCTION 16
2050 /** An entry specifying a set of addresses and ports that should be remapped
2051 * to another address and port before exiting this exit node. */
2052 typedef struct exit_redirect_t
{
2056 maskbits_t maskbits
;
2058 tor_addr_t addr_dest
;
2060 unsigned int is_redirect
:1;
2063 /* limits for TCP send and recv buffer size used for constrained sockets */
2064 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2065 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2067 /** A linked list of lines in a config file. */
2068 typedef struct config_line_t
{
2071 struct config_line_t
*next
;
2074 typedef struct routerset_t routerset_t
;
2076 /** Configuration options for a Tor process. */
2080 /** What should the tor process actually do? */
2082 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2083 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2085 const char *command_arg
; /**< Argument for command-line option. */
2087 config_line_t
*Logs
; /**< New-style list of configuration lines
2090 char *DebugLogFile
; /**< Where to send verbose log messages. */
2091 char *DataDirectory
; /**< OR only: where to store long-term data. */
2092 char *Nickname
; /**< OR only: nickname of this onion router. */
2093 char *Address
; /**< OR only: configured address for this onion router. */
2094 char *PidFile
; /**< Where to store PID of Tor process. */
2096 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2097 * country codes and IP address patterns of ORs to
2098 * consider as exits. */
2099 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2100 * country codes and IP address patterns of ORs to
2101 * consider as entry points. */
2102 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2103 * stop building circuits? */
2104 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2105 * stop building circuits? */
2106 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2107 * country codes and IP address patterns of ORs
2108 * not to use in circuits. */
2109 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2110 * country codes and IP address patterns of
2111 * ORs not to consider as exits. */
2113 /** Union of ExcludeNodes and ExcludeExitNodes */
2114 struct routerset_t
*_ExcludeExitNodesUnion
;
2116 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2117 smartlist_t
*AllowInvalidNodes
;
2118 int _AllowInvalid
; /**< Bitmask; derived from AllowInvalidNodes. */
2119 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2120 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2121 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2122 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2123 /** Addresses to bind for listening for SOCKS connections. */
2124 config_line_t
*SocksListenAddress
;
2125 /** Addresses to bind for listening for transparent pf/nefilter
2127 config_line_t
*TransListenAddress
;
2128 /** Addresses to bind for listening for transparent natd connections */
2129 config_line_t
*NatdListenAddress
;
2130 /** Addresses to bind for listening for SOCKS connections. */
2131 config_line_t
*DNSListenAddress
;
2132 /** Addresses to bind for listening for OR connections. */
2133 config_line_t
*ORListenAddress
;
2134 /** Addresses to bind for listening for directory connections. */
2135 config_line_t
*DirListenAddress
;
2136 /** Addresses to bind for listening for control connections. */
2137 config_line_t
*ControlListenAddress
;
2138 /** Local address to bind outbound sockets */
2139 char *OutboundBindAddress
;
2140 /** Directory server only: which versions of
2141 * Tor should we tell users to run? */
2142 config_line_t
*RecommendedVersions
;
2143 config_line_t
*RecommendedClientVersions
;
2144 config_line_t
*RecommendedServerVersions
;
2145 /** Whether dirservers refuse router descriptors with private IPs. */
2146 int DirAllowPrivateAddresses
;
2147 char *User
; /**< Name of user to run Tor as. */
2148 char *Group
; /**< Name of group to run Tor as. */
2149 int ORPort
; /**< Port to listen on for OR connections. */
2150 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2151 /** Port to listen on for transparent pf/netfilter connections. */
2153 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2154 int ControlPort
; /**< Port to listen on for control connections. */
2155 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2156 * for control connections. */
2157 int DirPort
; /**< Port to listen on for directory connections. */
2158 int DNSPort
; /**< Port to listen on for DNS requests. */
2159 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2160 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2161 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2162 * for version 1 directories? */
2163 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2164 * for version 2 directories? */
2165 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2166 * for version 3 directories? */
2167 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2168 * handle hidden service requests? */
2169 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
2170 * directory record statistics? */
2171 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2172 * that's willing to bind names? */
2173 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2174 * directory that's willing to recommend
2176 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2177 * that aggregates bridge descriptors? */
2179 /** If set on a bridge authority, it will answer requests on its dirport
2180 * for bridge statuses -- but only if the requests use this password.
2181 * If set on a bridge user, request bridge statuses, and use this password
2183 char *BridgePassword
;
2185 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2186 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2188 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2189 * this explicit so we can change how we behave in the
2192 /** Boolean: if we know the bridge's digest, should we get new
2193 * descriptors from the bridge authorities or from the bridge itself? */
2194 int UpdateBridgesFromAuthority
;
2196 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2198 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2199 /** Boolean: should we never publish a descriptor? Deprecated. */
2201 /** To what authority types do we publish our descriptor? Choices are
2202 * "v1", "v2", "v3", "bridge", or "". */
2203 smartlist_t
*PublishServerDescriptor
;
2204 /** An authority type, derived from PublishServerDescriptor. */
2205 authority_type_t _PublishServerDescriptor
;
2206 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2207 int PublishHidServDescriptors
;
2208 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2209 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2210 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2212 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2213 * service directories after what time? */
2214 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2215 int AllDirActionsPrivate
; /**< Should every directory action be sent
2216 * through a Tor circuit? */
2218 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2219 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2220 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2221 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2222 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2224 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2225 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2226 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2228 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2229 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2231 /** Application ports that require all nodes in circ to have sufficient
2233 smartlist_t
*LongLivedPorts
;
2234 /** Application ports that are likely to be unencrypted and
2235 * unauthenticated; we reject requests for them to prevent the
2236 * user from screwing up and leaking plaintext secrets to an
2237 * observer somewhere on the Internet. */
2238 smartlist_t
*RejectPlaintextPorts
;
2239 /** Related to RejectPlaintextPorts above, except this config option
2240 * controls whether we warn (in the log and via a controller status
2241 * event) every time a risky connection is attempted. */
2242 smartlist_t
*WarnPlaintextPorts
;
2243 /** Should we try to reuse the same exit node for a given host */
2244 smartlist_t
*TrackHostExits
;
2245 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2247 config_line_t
*AddressMap
; /**< List of address map directives. */
2248 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2249 * hostname ending with one of the suffixes in
2250 * <b>AutomapHostsSuffixes</b>, map it to a
2251 * virtual address. */
2252 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2253 * <b>AutomapHostsOnResolve</b>. */
2254 int RendPostPeriod
; /**< How often do we post each rendezvous service
2255 * descriptor? Remember to publish them independently. */
2256 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2257 * connections alive? */
2258 int SocksTimeout
; /**< How long do we let a socks connection wait
2259 * unattached before we fail it? */
2260 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2261 * at least this many seconds ago. */
2262 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2263 * at least this many seconds ago. */
2264 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2265 * to wait simultaneously before we start dropping
2267 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2269 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2270 this interval ago. */
2271 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2272 * to use in a second? */
2273 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2274 * to use in a second? */
2275 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2276 * tell people we have? */
2277 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2278 * willing to use for all relayed conns? */
2279 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2280 * use in a second for all relayed conns? */
2281 int NumCpus
; /**< How many CPUs should we try to use? */
2282 int RunTesting
; /**< If true, create testing circuits to measure how well the
2283 * other ORs are running. */
2284 config_line_t
*RendConfigLines
; /**< List of configuration lines
2285 * for rendezvous services. */
2286 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2287 * authorizations for hidden services */
2288 char *ContactInfo
; /**< Contact info to be published in the directory. */
2290 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2291 uint32_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2292 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2293 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2295 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2296 uint32_t HttpsProxyAddr
; /**< Parsed IPv4 addr for https proxy, if any. */
2297 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2298 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2300 /** List of configuration lines for replacement directory authorities.
2301 * If you just want to replace one class of authority at a time,
2302 * use the "Alternate*Authority" options below instead. */
2303 config_line_t
*DirServers
;
2305 /** If set, use these main (currently v3) directory authorities and
2306 * not the default ones. */
2307 config_line_t
*AlternateDirAuthority
;
2309 /** If set, use these bridge authorities and not the default one. */
2310 config_line_t
*AlternateBridgeAuthority
;
2312 /** If set, use these HS authorities and not the default ones. */
2313 config_line_t
*AlternateHSAuthority
;
2315 char *MyFamily
; /**< Declared family for this OR. */
2316 config_line_t
*NodeFamilies
; /**< List of config lines for
2318 config_line_t
*RedirectExit
; /**< List of config lines for simple
2319 * addr/port redirection */
2320 smartlist_t
*RedirectExitList
; /**< List of exit_redirect_t */
2321 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2322 * mark as bad dir mirrors. */
2323 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2324 * mark as bad exits. */
2325 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2327 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2328 * never mark as valid. */
2329 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2330 * and vote for all other dir mirrors as good. */
2331 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2332 * and vote for all other exits as good. */
2333 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2334 * aren't named in our fingerprint file? */
2335 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2336 * number of servers per IP address. */
2337 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2338 * number of servers per IP address shared
2339 * with an authority. */
2341 char *AccountingStart
; /**< How long is the accounting interval, and when
2343 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2344 * interval before hibernation? 0 for "never
2347 /** Base64-encoded hash of accepted passwords for the control system. */
2348 config_line_t
*HashedControlPassword
;
2349 /** As HashedControlPassword, but not saved. */
2350 config_line_t
*HashedControlSessionPassword
;
2352 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2353 * the control system? */
2354 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2355 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2356 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2357 * circuits itself (0), or does it expect a controller
2359 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2360 * make circuits in the background (0),
2362 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2363 * long do we wait before exiting? */
2364 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2365 * such as addresses (0), or do we scrub them first (1)? */
2366 int SafeSocks
; /**< Boolean: should we outright refuse application
2367 * connections that use socks4 or socks5-with-local-dns? */
2368 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2369 LOG_WARN : LOG_INFO)
2370 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2371 * protocol, is it a warn or an info in our logs? */
2372 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2373 * log whether it was DNS-leaking or not? */
2374 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2375 * acceleration where available? */
2376 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2377 * of fixed nodes? */
2378 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2379 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2380 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2381 * of our PK time by sending CREATE_FAST cells? */
2382 /** Should we always fetch our dir info on the mirror schedule (which
2383 * means directly from the authorities) no matter our other config? */
2384 int FetchDirInfoEarly
;
2386 smartlist_t
*reachable_addr_policy
; /**< Parsed from ReachableAddresses */
2388 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2389 * MAPADDRESS requests. */
2390 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2391 * addresses to be FQDNs, but rather search for them in
2392 * the local domains. */
2393 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2395 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2396 * DNS poisoning attacks. */
2397 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2398 * resolver from the file here rather than from
2399 * /etc/resolv.conf (Unix) or the registry (Windows). */
2400 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2401 disclaimer. This allows a server administrator to show
2402 that they're running Tor and anyone visiting their server
2403 will know this without any specialized knowledge. */
2404 /** Boolean: if set, we start even if our resolv.conf file is missing
2406 int ServerDNSAllowBrokenResolvConf
;
2408 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2409 * should be resolveable. Used for
2410 * testing our DNS server. */
2411 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2412 * same network zone in the same circuit. */
2413 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2415 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2416 * support BEGIN_DIR, when possible. */
2417 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2418 * with weird characters. */
2419 /** If true, we try resolving hostnames with weird characters. */
2420 int ServerDNSAllowNonRFC953Hostnames
;
2422 /** If true, we try to download extra-info documents (and we serve them,
2423 * if we are a cache). For authorities, this is always true. */
2424 int DownloadExtraInfo
;
2426 /** If true, and we are acting as a relay, allow exit circuits even when
2427 * we are the first hop of a circuit. */
2428 int AllowSingleHopExits
;
2429 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2430 * circuits that we build. */
2431 int ExcludeSingleHopRelays
;
2432 /** If true, and the controller tells us to use a one-hop circuit, and the
2433 * exit allows it, we use it. */
2434 int AllowSingleHopCircuits
;
2436 /** If true, do not believe anybody who tells us that a domain resolves
2437 * to an internal address, or that an internal address has a PTR mapping.
2438 * Helps avoid some cross-site attacks. */
2439 int ClientDNSRejectInternalAddresses
;
2441 /** The length of time that we think a consensus should be fresh. */
2442 int V3AuthVotingInterval
;
2443 /** The length of time we think it will take to distribute votes. */
2444 int V3AuthVoteDelay
;
2445 /** The length of time we think it will take to distribute signatures. */
2446 int V3AuthDistDelay
;
2447 /** The number of intervals we think a consensus should be valid. */
2448 int V3AuthNIntervalsValid
;
2450 /** Should advertise and sign consensuses with a legacy key, for key
2451 * migration purposes? */
2452 int V3AuthUseLegacyKey
;
2454 /** The length of time that we think an initial consensus should be fresh.
2455 * Only altered on testing networks. */
2456 int TestingV3AuthInitialVotingInterval
;
2458 /** The length of time we think it will take to distribute initial votes.
2459 * Only altered on testing networks. */
2460 int TestingV3AuthInitialVoteDelay
;
2462 /** The length of time we think it will take to distribute initial
2463 * signatures. Only altered on testing networks.*/
2464 int TestingV3AuthInitialDistDelay
;
2466 /** If an authority has been around for less than this amount of time, it
2467 * does not believe its reachability information is accurate. Only
2468 * altered on testing networks. */
2469 int TestingAuthDirTimeToLearnReachability
;
2471 /** Clients don't download any descriptor this recent, since it will
2472 * probably not have propagated to enough caches. Only altered on testing
2474 int TestingEstimatedDescriptorPropagationTime
;
2476 /** If true, we take part in a testing network. Change the defaults of a
2477 * couple of other configuration options and allow to change the values
2478 * of certain configuration options. */
2479 int TestingTorNetwork
;
2481 /** File to check for a consensus networkstatus, if we don't have one
2483 char *FallbackNetworkstatusFile
;
2485 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2486 * count of how many client addresses have contacted us so that we can help
2487 * the bridge authority guess which countries have blocked access to us. */
2488 int BridgeRecordUsageByCountry
;
2489 #ifdef ENABLE_GEOIP_STATS
2490 int DirRecordUsageByCountry
;
2491 int DirRecordUsageGranularity
;
2492 int DirRecordUsageRetainIPs
;
2493 int DirRecordUsageSaveInterval
;
2496 /** Optionally, a file with GeoIP data. */
2499 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2500 * to make this false. */
2501 int ReloadTorrcOnSIGHUP
;
2505 /** Persistent state for an onion router, as saved to disk. */
2508 /** The time at which we next plan to write the state to the disk. Equal to
2509 * TIME_MAX if there are no saveable changes, 0 if there are changes that
2510 * should be saved right away. */
2513 /** When was the state last written to disk? */
2516 /** Fields for accounting bandwidth use. */
2517 time_t AccountingIntervalStart
;
2518 uint64_t AccountingBytesReadInInterval
;
2519 uint64_t AccountingBytesWrittenInInterval
;
2520 int AccountingSecondsActive
;
2521 uint64_t AccountingExpectedUsage
;
2523 /** A list of Entry Guard-related configuration lines. */
2524 config_line_t
*EntryGuards
;
2526 /** These fields hold information on the history of bandwidth usage for
2527 * servers. The "Ends" fields hold the time when we last updated the
2528 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2529 * of the entries of Values. The "Values" lists hold decimal string
2530 * representations of the number of bytes read or written in each
2532 time_t BWHistoryReadEnds
;
2533 int BWHistoryReadInterval
;
2534 smartlist_t
*BWHistoryReadValues
;
2535 time_t BWHistoryWriteEnds
;
2536 int BWHistoryWriteInterval
;
2537 smartlist_t
*BWHistoryWriteValues
;
2539 /** What version of Tor wrote this state file? */
2542 /** Holds any unrecognized values we found in the state file, in the order
2543 * in which we found them. */
2544 config_line_t
*ExtraLines
;
2546 /** When did we last rotate our onion key? "0" for 'no idea'. */
2547 time_t LastRotatedOnionKey
;
2550 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2551 * state is already scheduled to be written to disk earlier than <b>when</b>.
2553 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2555 if (state
->next_write
> when
)
2556 state
->next_write
= when
;
2559 #define MAX_SOCKS_REPLY_LEN 1024
2560 #define MAX_SOCKS_ADDR_LEN 256
2562 /** Please open a TCP connection to this addr:port. */
2563 #define SOCKS_COMMAND_CONNECT 0x01
2564 /** Please turn this FQDN into an IP address, privately. */
2565 #define SOCKS_COMMAND_RESOLVE 0xF0
2566 /** Please turn this IP address into an FQDN, privately. */
2567 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2569 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2570 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2571 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2573 /** State of a SOCKS request from a user to an OP. Also used to encode other
2574 * information for non-socks user request (such as those on TransPort and
2576 struct socks_request_t
{
2577 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2578 * 0 means that no socks handshake ever took place, and this is just a
2579 * stub connection (e.g. see connection_ap_make_link()). */
2581 int command
; /**< What is this stream's goal? One from the above list. */
2582 size_t replylen
; /**< Length of <b>reply</b>. */
2583 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2584 * we want to specify our own socks reply,
2585 * rather than using the default socks4 or
2586 * socks5 socks reply. We use this for the
2587 * two-stage socks5 handshake.
2589 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2590 connect to/resolve? */
2591 uint16_t port
; /**< What port did the client ask to connect to? */
2592 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2593 * make sure we send back a socks reply for
2594 * every connection. */
2597 /* all the function prototypes go here */
2599 /********************************* buffers.c ***************************/
2601 buf_t
*buf_new(void);
2602 buf_t
*buf_new_with_capacity(size_t size
);
2603 void buf_free(buf_t
*buf
);
2604 void buf_clear(buf_t
*buf
);
2605 void buf_shrink(buf_t
*buf
);
2606 void buf_shrink_freelists(int free_all
);
2607 void buf_dump_freelist_sizes(int severity
);
2609 size_t buf_datalen(const buf_t
*buf
);
2610 size_t buf_allocation(const buf_t
*buf
);
2611 size_t buf_slack(const buf_t
*buf
);
2612 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2614 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2616 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2618 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2619 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2621 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2622 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2623 const char *data
, size_t data_len
, int done
);
2624 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2625 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2626 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2627 int fetch_from_buf_http(buf_t
*buf
,
2628 char **headers_out
, size_t max_headerlen
,
2629 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2630 int force_complete
);
2631 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2632 int log_sockstype
, int safe_socks
);
2633 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2635 int peek_buf_has_control0_command(buf_t
*buf
);
2637 void assert_buf_ok(buf_t
*buf
);
2639 #ifdef BUFFERS_PRIVATE
2640 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2643 /********************************* circuitbuild.c **********************/
2645 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2646 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2647 void circuit_log_path(int severity
, unsigned int domain
,
2648 origin_circuit_t
*circ
);
2649 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2650 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2651 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2652 extend_info_t
*exit
,
2654 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2655 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2656 int inform_testing_reachability(void);
2657 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2658 void circuit_note_clock_jumped(int seconds_elapsed
);
2659 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2660 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2662 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2664 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2665 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2666 const char *payload
, const char *keys
);
2667 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2668 int *need_capacity
);
2670 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2671 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2672 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2673 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2674 crypto_pk_env_t
*onion_key
,
2675 const tor_addr_t
*addr
, uint16_t port
);
2676 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2677 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2678 void extend_info_free(extend_info_t
*info
);
2679 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2680 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2682 void entry_guards_compute_status(void);
2683 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2685 void entry_nodes_should_be_added(void);
2686 int entry_list_can_grow(or_options_t
*options
);
2687 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2688 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2689 void entry_guards_update_state(or_state_t
*state
);
2690 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2691 const char *question
, char **answer
);
2693 void clear_bridge_list(void);
2694 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2695 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
2697 void retry_bridge_descriptor_fetch_directly(const char *digest
);
2698 void fetch_bridge_descriptors(time_t now
);
2699 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2700 int any_bridge_descriptors_known(void);
2701 int any_pending_bridge_descriptor_fetches(void);
2702 int bridges_known_but_down(void);
2703 void bridges_retry_all(void);
2705 void entry_guards_free_all(void);
2707 /********************************* circuitlist.c ***********************/
2709 circuit_t
* _circuit_get_global_list(void);
2710 const char *circuit_state_to_string(int state
);
2711 const char *circuit_purpose_to_controller_string(uint8_t purpose
);
2712 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
2713 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
2714 or_connection_t
*conn
);
2715 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
2716 or_connection_t
*conn
);
2717 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
2718 void circuit_close_all_marked(void);
2719 origin_circuit_t
*origin_circuit_new(void);
2720 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
2721 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
2722 or_connection_t
*conn
);
2723 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
2724 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
2725 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
2726 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
2727 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
2729 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
2730 const char *digest
, uint8_t purpose
);
2731 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
2732 or_circuit_t
*circuit_get_intro_point(const char *digest
);
2733 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
2734 extend_info_t
*info
, int flags
);
2735 void circuit_mark_all_unused_circs(void);
2736 void circuit_expire_all_dirty_circs(void);
2737 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
2738 int line
, const char *file
);
2739 int circuit_get_cpath_len(origin_circuit_t
*circ
);
2740 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
2741 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
2742 or_connection_t
*or_conn
);
2743 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
2745 #define circuit_mark_for_close(c, reason) \
2746 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
2748 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
2749 void assert_circuit_ok(const circuit_t
*c
);
2750 void circuit_free_all(void);
2752 /********************************* circuituse.c ************************/
2754 void circuit_expire_building(time_t now
);
2755 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
2756 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
2758 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
2759 const or_options_t
*options
);
2760 void circuit_build_needed_circs(time_t now
);
2761 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
2763 void reset_bandwidth_test(void);
2764 int circuit_enough_testing_circs(void);
2766 void circuit_has_opened(origin_circuit_t
*circ
);
2767 void circuit_build_failed(origin_circuit_t
*circ
);
2769 /** Flag to set when a circuit should have only a single hop. */
2770 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
2771 /** Flag to set when a circuit needs to be built of high-uptime nodes */
2772 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
2773 /** Flag to set when a circuit needs to be build of high-capcity nodes */
2774 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
2775 /** Flag to set when the last hop of a circuit doesn't need to be an
2777 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
2778 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
2779 extend_info_t
*info
,
2781 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
2782 routerinfo_t
*exit
, int flags
);
2783 void circuit_reset_failure_count(int timeout
);
2784 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
2785 origin_circuit_t
*circ
,
2786 crypt_path_t
*cpath
);
2787 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
2789 /********************************* command.c ***************************/
2791 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
2792 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
2794 extern uint64_t stats_n_padding_cells_processed
;
2795 extern uint64_t stats_n_create_cells_processed
;
2796 extern uint64_t stats_n_created_cells_processed
;
2797 extern uint64_t stats_n_relay_cells_processed
;
2798 extern uint64_t stats_n_destroy_cells_processed
;
2800 /********************************* config.c ***************************/
2802 /** An error from options_trial_assign() or options_init_from_string(). */
2803 typedef enum setopt_err_t
{
2805 SETOPT_ERR_MISC
= -1,
2806 SETOPT_ERR_PARSE
= -2,
2807 SETOPT_ERR_TRANSITION
= -3,
2808 SETOPT_ERR_SETTING
= -4,
2811 const char *get_dirportfrontpage(void);
2812 or_options_t
*get_options(void);
2813 int set_options(or_options_t
*new_val
, char **msg
);
2814 void config_free_all(void);
2815 const char *safe_str(const char *address
);
2816 const char *escaped_safe_str(const char *address
);
2817 const char *get_version(void);
2819 int config_get_lines(const char *string
, config_line_t
**result
);
2820 void config_free_lines(config_line_t
*front
);
2821 int options_trial_assign(config_line_t
*list
, int use_defaults
,
2822 int clear_first
, char **msg
);
2823 int resolve_my_address(int warn_severity
, or_options_t
*options
,
2824 uint32_t *addr
, char **hostname_out
);
2825 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
2826 void options_init(or_options_t
*options
);
2827 int options_init_from_torrc(int argc
, char **argv
);
2828 setopt_err_t
options_init_from_string(const char *cf
,
2829 int command
, const char *command_arg
, char **msg
);
2830 int option_is_recognized(const char *key
);
2831 const char *option_get_canonical_name(const char *key
);
2832 config_line_t
*option_get_assignment(or_options_t
*options
,
2834 int options_save_current(void);
2835 const char *get_torrc_fname(void);
2836 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
2837 const char *sub1
, const char *sub2
,
2838 const char *suffix
);
2839 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
2840 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
2841 /** Return a newly allocated string containing datadir/sub1. See
2842 * get_datadir_fname2_suffix. */
2843 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
2844 /** Return a newly allocated string containing datadir/sub1/sub2. See
2845 * get_datadir_fname2_suffix. */
2846 #define get_datadir_fname2(sub1,sub2) \
2847 get_datadir_fname2_suffix((sub1), (sub2), NULL)
2848 /** Return a newly allocated string containing datadir/sub1suffix. See
2849 * get_datadir_fname2_suffix. */
2850 #define get_datadir_fname_suffix(sub1, suffix) \
2851 get_datadir_fname2_suffix((sub1), NULL, (suffix))
2853 or_state_t
*get_or_state(void);
2854 int or_state_save(time_t now
);
2856 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
2857 int getinfo_helper_config(control_connection_t
*conn
,
2858 const char *question
, char **answer
);
2860 #ifdef CONFIG_PRIVATE
2861 /* Used only by config.c and test.c */
2862 or_options_t
*options_new(void);
2865 /********************************* connection.c ***************************/
2867 const char *conn_type_to_string(int type
);
2868 const char *conn_state_to_string(int type
, int state
);
2870 dir_connection_t
*dir_connection_new(int socket_family
);
2871 or_connection_t
*or_connection_new(int socket_family
);
2872 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
2873 control_connection_t
*control_connection_new(int socket_family
);
2874 connection_t
*connection_new(int type
, int socket_family
);
2876 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
2877 void connection_unregister_events(connection_t
*conn
);
2878 void connection_free(connection_t
*conn
);
2879 void connection_free_all(void);
2880 void connection_about_to_close_connection(connection_t
*conn
);
2881 void connection_close_immediate(connection_t
*conn
);
2882 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
2884 #define connection_mark_for_close(c) \
2885 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
2887 void connection_expire_held_open(void);
2889 int connection_connect(connection_t
*conn
, const char *address
,
2890 const tor_addr_t
*addr
,
2891 uint16_t port
, int *socket_error
);
2892 int retry_all_listeners(smartlist_t
*replaced_conns
,
2893 smartlist_t
*new_conns
);
2895 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
2896 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
2897 void connection_bucket_init(void);
2898 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
2900 int connection_handle_read(connection_t
*conn
);
2902 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
2904 int connection_wants_to_flush(connection_t
*conn
);
2905 int connection_outbuf_too_full(connection_t
*conn
);
2906 int connection_handle_write(connection_t
*conn
, int force
);
2907 void _connection_write_to_buf_impl(const char *string
, size_t len
,
2908 connection_t
*conn
, int zlib
);
2909 static void connection_write_to_buf(const char *string
, size_t len
,
2910 connection_t
*conn
);
2911 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
2912 dir_connection_t
*conn
, int done
);
2914 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
2916 _connection_write_to_buf_impl(string
, len
, conn
, 0);
2919 connection_write_to_buf_zlib(const char *string
, size_t len
,
2920 dir_connection_t
*conn
, int done
)
2922 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
2925 connection_t
*connection_get_by_global_id(uint64_t id
);
2927 connection_t
*connection_get_by_type(int type
);
2928 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
2929 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
2930 const tor_addr_t
*addr
,
2931 uint16_t port
, int purpose
);
2932 connection_t
*connection_get_by_type_state(int type
, int state
);
2933 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
2934 const char *rendquery
,
2937 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
2938 int connection_is_listener(connection_t
*conn
);
2939 int connection_state_is_open(connection_t
*conn
);
2940 int connection_state_is_connecting(connection_t
*conn
);
2942 char *alloc_http_authenticator(const char *authenticator
);
2944 void assert_connection_ok(connection_t
*conn
, time_t now
);
2945 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
2946 void connection_dump_buffer_mem_stats(int severity
);
2947 void remove_file_if_very_old(const char *fname
, time_t now
);
2949 /********************************* connection_edge.c *************************/
2951 #define connection_mark_unattached_ap(conn, endreason) \
2952 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
2954 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
2955 int line
, const char *file
);
2956 int connection_edge_reached_eof(edge_connection_t
*conn
);
2957 int connection_edge_process_inbuf(edge_connection_t
*conn
,
2958 int package_partial
);
2959 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
2960 int connection_edge_end(edge_connection_t
*conn
, char reason
);
2961 int connection_edge_end_errno(edge_connection_t
*conn
);
2962 int connection_edge_finished_flushing(edge_connection_t
*conn
);
2963 int connection_edge_finished_connecting(edge_connection_t
*conn
);
2965 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
2966 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
2968 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
2970 int use_begindir
, int want_onehop
);
2971 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
2974 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
2981 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
2982 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
2983 void connection_exit_connect(edge_connection_t
*conn
);
2984 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
2985 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
2986 void connection_ap_expire_beginning(void);
2987 void connection_ap_attach_pending(void);
2988 void connection_ap_fail_onehop(const char *failed_digest
,
2989 cpath_build_state_t
*build_state
);
2990 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
2991 int connection_ap_detach_retriable(edge_connection_t
*conn
,
2992 origin_circuit_t
*circ
,
2994 int connection_ap_process_transparent(edge_connection_t
*conn
);
2996 int address_is_invalid_destination(const char *address
, int client
);
2998 void addressmap_init(void);
2999 void addressmap_clean(time_t now
);
3000 void addressmap_clear_configured(void);
3001 void addressmap_clear_transient(void);
3002 void addressmap_free_all(void);
3003 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
3004 int addressmap_have_mapping(const char *address
, int update_timeout
);
3006 ADDRMAPSRC_CONTROLLER
, ADDRMAPSRC_TORRC
, ADDRMAPSRC_TRACKEXIT
,
3008 } addressmap_entry_source_t
;
3009 void addressmap_register(const char *address
, char *new_address
,
3010 time_t expires
, addressmap_entry_source_t source
);
3011 int parse_virtual_addr_network(const char *val
, int validate_only
,
3013 int client_dns_incr_failures(const char *address
);
3014 void client_dns_clear_failures(const char *address
);
3015 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3016 const char *exitname
, int ttl
);
3017 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3018 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3019 time_t max_expires
, int want_expiry
);
3020 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3021 origin_circuit_t
*circ
,
3022 crypt_path_t
*cpath
);
3023 int hostname_is_noconnect_address(const char *address
);
3025 void set_exit_redirects(smartlist_t
*lst
);
3026 typedef enum hostname_type_t
{
3027 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3029 hostname_type_t
parse_extended_hostname(char *address
);
3031 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3032 int get_pf_socket(void);
3035 /********************************* connection_or.c ***************************/
3037 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3038 void connection_or_clear_identity_map(void);
3039 or_connection_t
*connection_or_get_by_identity_digest(const char *digest
);
3041 int connection_or_reached_eof(or_connection_t
*conn
);
3042 int connection_or_process_inbuf(or_connection_t
*conn
);
3043 int connection_or_flushed_some(or_connection_t
*conn
);
3044 int connection_or_finished_flushing(or_connection_t
*conn
);
3045 int connection_or_finished_connecting(or_connection_t
*conn
);
3047 void connection_or_connect_failed(or_connection_t
*conn
,
3048 int reason
, const char *msg
);
3049 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3050 const char *id_digest
);
3052 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3053 int connection_tls_continue_handshake(or_connection_t
*conn
);
3055 void or_handshake_state_free(or_handshake_state_t
*state
);
3056 int connection_or_set_state_open(or_connection_t
*conn
);
3057 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3058 or_connection_t
*conn
);
3059 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3060 or_connection_t
*conn
);
3061 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3063 int connection_or_send_netinfo(or_connection_t
*conn
);
3064 int connection_or_send_cert(or_connection_t
*conn
);
3065 int connection_or_send_link_auth(or_connection_t
*conn
);
3066 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3068 int is_or_protocol_version_known(uint16_t version
);
3070 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3071 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3072 var_cell_t
*var_cell_new(uint16_t payload_len
);
3073 void var_cell_free(var_cell_t
*cell
);
3075 /********************************* control.c ***************************/
3077 typedef enum circuit_status_event_t
{
3078 CIRC_EVENT_LAUNCHED
= 0,
3079 CIRC_EVENT_BUILT
= 1,
3080 CIRC_EVENT_EXTENDED
= 2,
3081 CIRC_EVENT_FAILED
= 3,
3082 CIRC_EVENT_CLOSED
= 4,
3083 } circuit_status_event_t
;
3085 typedef enum stream_status_event_t
{
3086 STREAM_EVENT_SENT_CONNECT
= 0,
3087 STREAM_EVENT_SENT_RESOLVE
= 1,
3088 STREAM_EVENT_SUCCEEDED
= 2,
3089 STREAM_EVENT_FAILED
= 3,
3090 STREAM_EVENT_CLOSED
= 4,
3091 STREAM_EVENT_NEW
= 5,
3092 STREAM_EVENT_NEW_RESOLVE
= 6,
3093 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3094 STREAM_EVENT_REMAP
= 8
3095 } stream_status_event_t
;
3097 typedef enum or_conn_status_event_t
{
3098 OR_CONN_EVENT_LAUNCHED
= 0,
3099 OR_CONN_EVENT_CONNECTED
= 1,
3100 OR_CONN_EVENT_FAILED
= 2,
3101 OR_CONN_EVENT_CLOSED
= 3,
3102 OR_CONN_EVENT_NEW
= 4,
3103 } or_conn_status_event_t
;
3105 void control_update_global_event_mask(void);
3106 void control_adjust_event_log_severity(void);
3108 /** Execute the statement <b>stmt</b>, which may log events concerning the
3109 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3110 * being sent to controllers if <b>conn</b> is a control connection.
3112 * Stmt must not contain any return or goto statements.
3114 #define CONN_LOG_PROTECT(conn, stmt) \
3116 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3117 if (_log_conn_is_control) \
3118 disable_control_logging(); \
3119 STMT_BEGIN stmt; STMT_END; \
3120 if (_log_conn_is_control) \
3121 enable_control_logging(); \
3124 /** Log information about the connection <b>conn</b>, protecting it as with
3125 * CONN_LOG_PROTECT. Example:
3127 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3129 #define LOG_FN_CONN(conn, args) \
3130 CONN_LOG_PROTECT(conn, log_fn args)
3132 int connection_control_finished_flushing(control_connection_t
*conn
);
3133 int connection_control_reached_eof(control_connection_t
*conn
);
3134 int connection_control_process_inbuf(control_connection_t
*conn
);
3136 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3137 #define EVENT_NS 0x000F
3138 int control_event_is_interesting(int event
);
3140 int control_event_circuit_status(origin_circuit_t
*circ
,
3141 circuit_status_event_t e
, int reason
);
3142 int control_event_stream_status(edge_connection_t
*conn
,
3143 stream_status_event_t e
,
3145 int control_event_or_conn_status(or_connection_t
*conn
,
3146 or_conn_status_event_t e
, int reason
);
3147 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3148 int control_event_stream_bandwidth_used(void);
3149 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3150 int control_event_descriptors_changed(smartlist_t
*routers
);
3151 int control_event_address_mapped(const char *from
, const char *to
,
3152 time_t expires
, const char *error
);
3153 int control_event_or_authdir_new_descriptor(const char *action
,
3157 int control_event_my_descriptor_changed(void);
3158 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3159 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3160 int control_event_general_status(int severity
, const char *format
, ...)
3162 int control_event_client_status(int severity
, const char *format
, ...)
3164 int control_event_server_status(int severity
, const char *format
, ...)
3166 int control_event_guard(const char *nickname
, const char *digest
,
3167 const char *status
);
3169 int init_cookie_authentication(int enabled
);
3170 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3171 void disable_control_logging(void);
3172 void enable_control_logging(void);
3174 /** Enum describing various stages of bootstrapping, for use with controller
3175 * bootstrap status events. The values range from 0 to 100. */
3177 BOOTSTRAP_STATUS_UNDEF
=-1,
3178 BOOTSTRAP_STATUS_STARTING
=0,
3179 BOOTSTRAP_STATUS_CONN_DIR
=5,
3180 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3181 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3182 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3183 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3184 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3185 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3186 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3187 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3188 BOOTSTRAP_STATUS_CONN_OR
=80,
3189 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3190 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3191 BOOTSTRAP_STATUS_DONE
=100
3192 } bootstrap_status_t
;
3194 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3195 void control_event_bootstrap_problem(const char *warn
, int reason
);
3197 #ifdef CONTROL_PRIVATE
3198 /* Used only by control.c and test.c */
3199 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3200 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3203 /********************************* cpuworker.c *****************************/
3205 void cpu_init(void);
3206 void cpuworkers_rotate(void);
3207 int connection_cpu_finished_flushing(connection_t
*conn
);
3208 int connection_cpu_reached_eof(connection_t
*conn
);
3209 int connection_cpu_process_inbuf(connection_t
*conn
);
3210 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3214 /********************************* directory.c ***************************/
3216 int directories_have_accepted_server_descriptor(void);
3217 char *authority_type_to_string(authority_type_t auth
);
3218 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3219 authority_type_t type
, const char *payload
,
3220 size_t payload_len
, size_t extrainfo_len
);
3221 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3222 const char *resource
,
3224 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3225 uint8_t router_purpose
,
3226 const char *resource
);
3227 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3228 uint8_t dir_purpose
,
3229 uint8_t router_purpose
,
3230 int anonymized_connection
,
3231 const char *resource
,
3232 const char *payload
,
3234 time_t if_modified_since
);
3235 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3236 uint8_t dir_purpose
,
3237 uint8_t router_purpose
,
3238 int anonymized_connection
,
3239 const char *resource
,
3240 const char *payload
,
3242 time_t if_modified_since
,
3243 const rend_data_t
*rend_query
);
3245 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3246 compress_method_t
*compression
, char **response
);
3248 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3249 int connection_dir_reached_eof(dir_connection_t
*conn
);
3250 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3251 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3252 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3253 void connection_dir_request_failed(dir_connection_t
*conn
);
3254 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3255 uint16_t or_port
, uint16_t dir_port
,
3256 int supports_conditional_consensus
,
3257 int supports_begindir
, const char *digest
,
3258 uint8_t dir_purpose
, uint8_t router_purpose
,
3259 int anonymized_connection
,
3260 const char *resource
,
3261 const char *payload
, size_t payload_len
,
3262 time_t if_modified_since
);
3264 int dir_split_resource_into_fingerprints(const char *resource
,
3265 smartlist_t
*fp_out
, int *compresseed_out
,
3266 int decode_hex
, int sort_uniq
);
3267 char *directory_dump_request_log(void);
3268 void note_request(const char *key
, size_t bytes
);
3269 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3271 time_t download_status_increment_failure(download_status_t
*dls
,
3272 int status_code
, const char *item
,
3273 int server
, time_t now
);
3274 #define download_status_failed(dls, sc) \
3275 download_status_increment_failure((dls), (sc), NULL, \
3276 get_options()->DirPort, time(NULL))
3278 void download_status_reset(download_status_t
*dls
);
3279 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3281 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3282 * ready to get its download reattempted. */
3284 download_status_is_ready(download_status_t
*dls
, time_t now
,
3287 return (dls
->n_download_failures
<= max_failures
3288 && dls
->next_attempt_at
<= now
);
3291 /********************************* dirserv.c ***************************/
3292 /** Maximum length of an exit policy summary. */
3293 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3295 /** Maximum allowable length of a version line in a networkstatus. */
3296 #define MAX_V_LINE_LEN 128
3297 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3298 * Running Stable Unnamed V2Dir Valid\n". */
3299 #define MAX_FLAG_LINE_LEN 96
3300 /** Length of "w" line for weighting. Currently at most
3301 * "w Bandwidth=<uint32t>\n" */
3302 #define MAX_WEIGHT_LINE_LEN (13+10)
3303 /** Maximum length of an exit policy summary line. */
3304 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3305 /** Amount of space to allocate for each entry: r, s, and v lines. */
3306 #define RS_ENTRY_LEN \
3307 ( /* first line */ \
3308 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3309 5*2 /* ports */ + 10 /* punctuation */ + \
3311 MAX_FLAG_LINE_LEN + \
3313 MAX_WEIGHT_LINE_LEN + \
3315 MAX_POLICY_LINE_LEN + \
3319 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3321 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3323 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3324 int dirserv_load_fingerprint_file(void);
3325 void dirserv_free_fingerprint_list(void);
3326 const char *dirserv_get_nickname_by_digest(const char *digest
);
3327 int dirserv_add_multiple_descriptors(const char *desc
, uint8_t purpose
,
3330 int dirserv_add_descriptor(routerinfo_t
*ri
, const char **msg
);
3331 int getinfo_helper_dirserv_unregistered(control_connection_t
*conn
,
3332 const char *question
, char **answer
);
3333 void dirserv_free_descriptors(void);
3334 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3335 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3336 int for_controller
);
3337 int dirserv_dump_directory_to_string(char **dir_out
,
3338 crypto_pk_env_t
*private_key
);
3340 int directory_fetches_from_authorities(or_options_t
*options
);
3341 int directory_fetches_dir_info_early(or_options_t
*options
);
3342 int directory_fetches_dir_info_later(or_options_t
*options
);
3343 int directory_caches_v2_dir_info(or_options_t
*options
);
3344 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3345 int directory_caches_dir_info(or_options_t
*options
);
3346 int directory_permits_begindir_requests(or_options_t
*options
);
3347 int directory_permits_controller_requests(or_options_t
*options
);
3348 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3350 void directory_set_dirty(void);
3351 cached_dir_t
*dirserv_get_directory(void);
3352 cached_dir_t
*dirserv_get_runningrouters(void);
3353 cached_dir_t
*dirserv_get_consensus(void);
3354 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3355 int is_running_routers
);
3356 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3357 const char *identity
,
3359 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
3361 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3362 void dirserv_clear_old_v1_info(time_t now
);
3363 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3364 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3366 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3368 int for_unencrypted_conn
);
3369 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3371 void dirserv_orconn_tls_done(const char *address
,
3373 const char *digest_rcvd
,
3375 void dirserv_test_reachability(time_t now
, int try_all
);
3376 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3378 int dirserv_would_reject_router(routerstatus_t
*rs
);
3379 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3380 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3381 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3383 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3384 routerstatus_t
*rs
, const char *platform
,
3385 int first_line_only
, int v2_format
);
3386 void dirserv_free_all(void);
3387 void cached_dir_decref(cached_dir_t
*d
);
3388 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3390 /********************************* dirvote.c ************************/
3392 /** Lowest allowable value for VoteSeconds. */
3393 #define MIN_VOTE_SECONDS 20
3394 /** Lowest allowable value for DistSeconds. */
3395 #define MIN_DIST_SECONDS 20
3396 /** Smallest allowable voting interval. */
3397 #define MIN_VOTE_INTERVAL 300
3399 void dirvote_free_all(void);
3401 /* vote manipulation */
3402 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3403 int total_authorities
,
3404 crypto_pk_env_t
*identity_key
,
3405 crypto_pk_env_t
*signing_key
,
3406 const char *legacy_identity_key_digest
,
3407 crypto_pk_env_t
*legacy_signing_key
);
3408 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3409 ns_detached_signatures_t
*sigs
,
3410 const char **msg_out
);
3411 char *networkstatus_get_detached_signatures(networkstatus_t
*consensus
);
3412 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3414 /* cert manipulation */
3415 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3417 /** Describes the schedule by which votes should be generated. */
3418 typedef struct vote_timing_t
{
3420 int n_intervals_valid
;
3424 /* vote scheduling */
3425 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3426 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3427 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3428 void dirvote_act(or_options_t
*options
, time_t now
);
3430 /* invoked on timers and by outside triggers. */
3431 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3432 const char **msg_out
,
3434 int dirvote_add_signatures(const char *detached_signatures_body
,
3436 const char **msg_out
);
3439 const char *dirvote_get_pending_consensus(void);
3440 const char *dirvote_get_pending_detached_signatures(void);
3442 #define DGV_INCLUDE_PENDING 2
3443 #define DGV_INCLUDE_PREVIOUS 4
3444 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3445 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3446 routerinfo_t
*ri
, time_t now
,
3447 int naming
, int exits_can_be_guards
,
3448 int listbadexits
, int listbaddirs
);
3449 void router_clear_status_flags(routerinfo_t
*ri
);
3451 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3452 authority_cert_t
*cert
);
3454 #ifdef DIRVOTE_PRIVATE
3456 format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3457 networkstatus_t
*v3_ns
);
3460 /********************************* dns.c ***************************/
3463 int has_dns_init_failed(void);
3464 void dns_free_all(void);
3465 uint32_t dns_clip_ttl(uint32_t ttl
);
3466 int dns_reset(void);
3467 void connection_dns_remove(edge_connection_t
*conn
);
3468 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3469 void assert_all_pending_dns_resolves_ok(void);
3470 void dns_cancel_pending_resolve(const char *question
);
3471 int dns_resolve(edge_connection_t
*exitconn
);
3472 void dns_launch_correctness_checks(void);
3473 int dns_seems_to_be_broken(void);
3474 void dns_reset_correctness_checks(void);
3475 int parse_inaddr_arpa_address(const char *address
, struct in_addr
*in
);
3477 /********************************* dnsserv.c ************************/
3479 void dnsserv_configure_listener(connection_t
*conn
);
3480 void dnsserv_close_listener(connection_t
*conn
);
3481 void dnsserv_resolved(edge_connection_t
*conn
,
3486 void dnsserv_reject_request(edge_connection_t
*conn
);
3487 int dnsserv_launch_request(const char *name
, int is_reverse
);
3489 /********************************* geoip.c **************************/
3491 #ifdef GEOIP_PRIVATE
3492 int geoip_parse_entry(const char *line
);
3494 int should_record_bridge_info(or_options_t
*options
);
3495 int geoip_load_file(const char *filename
, or_options_t
*options
);
3496 int geoip_get_country_by_ip(uint32_t ipaddr
);
3497 int geoip_get_n_countries(void);
3498 const char *geoip_get_country_name(country_t num
);
3499 int geoip_is_loaded(void);
3500 country_t
geoip_get_country(const char *countrycode
);
3501 /** Indicates an action that we might be noting geoip statistics on.
3502 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3503 * the others, we're not.
3506 /** We've noticed a connection as a bridge relay. */
3507 GEOIP_CLIENT_CONNECT
= 0,
3508 /** We've served a networkstatus consensus as a directory server. */
3509 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3510 /** We've served a v2 networkstatus consensus as a directory server. */
3511 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3512 } geoip_client_action_t
;
3513 void geoip_note_client_seen(geoip_client_action_t action
,
3514 uint32_t addr
, time_t now
);
3515 void geoip_remove_old_clients(time_t cutoff
);
3516 time_t geoip_get_history_start(void);
3517 char *geoip_get_client_history(time_t now
, geoip_client_action_t action
);
3518 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
3519 int getinfo_helper_geoip(control_connection_t
*control_conn
,
3520 const char *question
, char **answer
);
3521 void geoip_free_all(void);
3522 void dump_geoip_stats(void);
3524 /********************************* hibernate.c **********************/
3526 int accounting_parse_options(or_options_t
*options
, int validate_only
);
3527 int accounting_is_enabled(or_options_t
*options
);
3528 void configure_accounting(time_t now
);
3529 void accounting_run_housekeeping(time_t now
);
3530 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
3531 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
3532 void hibernate_begin_shutdown(void);
3533 int we_are_hibernating(void);
3534 void consider_hibernation(time_t now
);
3535 int getinfo_helper_accounting(control_connection_t
*conn
,
3536 const char *question
, char **answer
);
3537 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
3539 /********************************* main.c ***************************/
3541 extern int has_completed_circuit
;
3543 int connection_add(connection_t
*conn
);
3544 int connection_remove(connection_t
*conn
);
3545 int connection_in_array(connection_t
*conn
);
3546 void add_connection_to_closeable_list(connection_t
*conn
);
3547 int connection_is_on_closeable_list(connection_t
*conn
);
3549 smartlist_t
*get_connection_array(void);
3551 void connection_watch_events(connection_t
*conn
, short events
);
3552 int connection_is_reading(connection_t
*conn
);
3553 void connection_stop_reading(connection_t
*conn
);
3554 void connection_start_reading(connection_t
*conn
);
3556 int connection_is_writing(connection_t
*conn
);
3557 void connection_stop_writing(connection_t
*conn
);
3558 void connection_start_writing(connection_t
*conn
);
3560 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
3562 void directory_all_unreachable(time_t now
);
3563 void directory_info_has_arrived(time_t now
, int from_cache
);
3565 void ip_address_changed(int at_interface
);
3566 void dns_servers_relaunch_checks(void);
3568 void control_signal_act(int the_signal
);
3569 void handle_signals(int is_parent
);
3571 int try_locking(or_options_t
*options
, int err_if_locked
);
3572 int have_lockfile(void);
3573 void release_lockfile(void);
3575 void tor_cleanup(void);
3576 void tor_free_all(int postfork
);
3578 int tor_main(int argc
, char *argv
[]);
3581 int do_main_loop(void);
3582 int do_list_fingerprint(void);
3583 void do_hash_password(void);
3584 int tor_init(int argc
, char **argv
);
3587 /********************************* networkstatus.c *********************/
3589 /** How old do we allow a v2 network-status to get before removing it
3591 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
3594 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3595 } networkstatus_source_t
;
3597 typedef enum version_status_t
{
3598 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3599 VS_OLD
=1, /**< This version is older than any recommended version. */
3600 VS_NEW
=2, /**< This version is newer than any recommended version. */
3601 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3602 * in its series, but later recommended versions exist.
3604 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
3605 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
3606 VS_UNKNOWN
, /**< We have no idea. */
3609 void networkstatus_reset_warnings(void);
3610 void networkstatus_reset_download_failures(void);
3611 int router_reload_v2_networkstatus(void);
3612 int router_reload_consensus_networkstatus(void);
3613 void routerstatus_free(routerstatus_t
*rs
);
3614 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
3615 void networkstatus_vote_free(networkstatus_t
*ns
);
3616 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
3617 networkstatus_t
*vote
,
3618 const char *identity
);
3619 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
3621 int networkstatus_check_voter_signature(networkstatus_t
*consensus
,
3622 networkstatus_voter_info_t
*voter
,
3623 authority_cert_t
*cert
);
3624 char *networkstatus_get_cache_filename(const char *identity_digest
);
3625 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
3626 networkstatus_source_t source
,
3627 smartlist_t
*requested_fingerprints
);
3628 void networkstatus_v2_list_clean(time_t now
);
3629 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
3630 const char *digest
);
3631 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
3632 const char *digest
);
3633 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
3634 const char *digest
, int *found_out
);
3635 const smartlist_t
*networkstatus_get_v2_list(void);
3636 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
3637 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
3638 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
3639 const char *digest
);
3640 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
3641 int warn_if_unnamed
);
3642 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
3643 int networkstatus_nickname_is_unnamed(const char *nickname
);
3644 void networkstatus_consensus_download_failed(int status_code
);
3645 void update_consensus_networkstatus_fetch_time(time_t now
);
3646 int should_delay_dir_fetches(or_options_t
*options
);
3647 void update_networkstatus_downloads(time_t now
);
3648 void update_certificate_downloads(time_t now
);
3649 int consensus_is_waiting_for_certs(void);
3650 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
3651 networkstatus_t
*networkstatus_get_latest_consensus(void);
3652 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
3653 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
3654 #define NSSET_FROM_CACHE 1
3655 #define NSSET_WAS_WAITING_FOR_CERTS 2
3656 #define NSSET_DONT_DOWNLOAD_CERTS 4
3657 int networkstatus_set_current_consensus(const char *consensus
, unsigned flags
);
3658 void networkstatus_note_certs_arrived(void);
3659 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
3660 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
3661 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
3662 int reset_failures
);
3663 void signed_descs_update_status_from_consensus_networkstatus(
3664 smartlist_t
*descs
);
3666 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
3667 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
3668 void networkstatus_dump_bridge_status_to_file(time_t now
);
3669 int getinfo_helper_networkstatus(control_connection_t
*conn
,
3670 const char *question
, char **answer
);
3671 void networkstatus_free_all(void);
3673 /********************************* ntmain.c ***************************/
3679 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
3680 int nt_service_is_stopping(void);
3681 void nt_service_set_state(DWORD state
);
3683 #define nt_service_is_stopping() (0)
3686 /********************************* onion.c ***************************/
3688 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
3689 or_circuit_t
*onion_next_task(char **onionskin_out
);
3690 void onion_pending_remove(or_circuit_t
*circ
);
3692 int onion_skin_create(crypto_pk_env_t
*router_key
,
3693 crypto_dh_env_t
**handshake_state_out
,
3694 char *onion_skin_out
);
3696 int onion_skin_server_handshake(const char *onion_skin
,
3697 crypto_pk_env_t
*private_key
,
3698 crypto_pk_env_t
*prev_private_key
,
3699 char *handshake_reply_out
,
3701 size_t key_out_len
);
3703 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
3704 const char *handshake_reply
,
3706 size_t key_out_len
);
3708 int fast_server_handshake(const char *key_in
,
3709 char *handshake_reply_out
,
3711 size_t key_out_len
);
3713 int fast_client_handshake(const char *handshake_state
,
3714 const char *handshake_reply_out
,
3716 size_t key_out_len
);
3718 void clear_pending_onions(void);
3720 /********************************* policies.c ************************/
3722 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
3725 #define POLICY_BUF_LEN 52
3728 ADDR_POLICY_ACCEPTED
=0,
3729 ADDR_POLICY_REJECTED
=-1,
3730 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3731 ADDR_POLICY_PROBABLY_REJECTED
=2
3732 } addr_policy_result_t
;
3734 int firewall_is_fascist_or(void);
3735 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
3736 int fascist_firewall_allows_or(routerinfo_t
*ri
);
3737 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
3738 int dir_policy_permits_address(const tor_addr_t
*addr
);
3739 int socks_policy_permits_address(const tor_addr_t
*addr
);
3740 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
3741 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
3742 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
3743 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
3745 int validate_addr_policies(or_options_t
*options
, char **msg
);
3746 void policy_expand_private(smartlist_t
**policy
);
3747 int policies_parse_from_options(or_options_t
*options
);
3749 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
3750 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
3751 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
3752 uint16_t port
, smartlist_t
*policy
);
3753 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
3754 uint16_t port
, smartlist_t
*policy
);
3755 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
3756 int rejectprivate
, const char *local_address
);
3757 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
3758 int exit_policy_is_general_exit(smartlist_t
*policy
);
3759 int policy_is_reject_star(smartlist_t
*policy
);
3760 int getinfo_helper_policies(control_connection_t
*conn
,
3761 const char *question
, char **answer
);
3762 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
3763 int format_for_desc
);
3765 void addr_policy_list_free(smartlist_t
*p
);
3766 void addr_policy_free(addr_policy_t
*p
);
3767 void policies_free_all(void);
3769 char *policy_summarize(smartlist_t
*policy
);
3771 /********************************* reasons.c ***************************/
3773 const char *stream_end_reason_to_control_string(int reason
);
3774 const char *stream_end_reason_to_string(int reason
);
3775 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
3776 uint8_t errno_to_stream_end_reason(int e
);
3778 const char *orconn_end_reason_to_control_string(int r
);
3779 int tls_error_to_orconn_end_reason(int e
);
3780 int errno_to_orconn_end_reason(int e
);
3782 const char *circuit_end_reason_to_control_string(int reason
);
3784 /********************************* relay.c ***************************/
3786 extern uint64_t stats_n_relay_cells_relayed
;
3787 extern uint64_t stats_n_relay_cells_delivered
;
3789 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
3790 int cell_direction
);
3792 void relay_header_pack(char *dest
, const relay_header_t
*src
);
3793 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
3794 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
3795 uint8_t relay_command
, const char *payload
,
3796 size_t payload_len
, crypt_path_t
*cpath_layer
);
3797 int connection_edge_send_command(edge_connection_t
*fromconn
,
3798 uint8_t relay_command
, const char *payload
,
3799 size_t payload_len
);
3800 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
3801 int package_partial
);
3802 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
3804 extern uint64_t stats_n_data_cells_packaged
;
3805 extern uint64_t stats_n_data_bytes_packaged
;
3806 extern uint64_t stats_n_data_cells_received
;
3807 extern uint64_t stats_n_data_bytes_received
;
3809 void init_cell_pool(void);
3810 void free_cell_pool(void);
3811 void clean_cell_pool(void);
3812 void dump_cell_pool_usage(int severity
);
3814 void cell_queue_clear(cell_queue_t
*queue
);
3815 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
3816 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
3818 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
3819 cell_t
*cell
, int direction
);
3820 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
3821 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
3822 int max
, time_t now
);
3823 void assert_active_circuits_ok(or_connection_t
*orconn
);
3824 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3825 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3827 int append_address_to_payload(char *payload_out
, const tor_addr_t
*addr
);
3828 const char *decode_address_from_payload(tor_addr_t
*addr_out
,
3829 const char *payload
,
3832 /********************************* rephist.c ***************************/
3834 void rep_hist_init(void);
3835 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
3836 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
3837 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
3838 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
3839 void rep_hist_note_extend_succeeded(const char *from_name
,
3840 const char *to_name
);
3841 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
3842 void rep_hist_dump_stats(time_t now
, int severity
);
3843 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
3844 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
3845 int rep_hist_bandwidth_assess(void);
3846 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
3847 void rep_hist_update_state(or_state_t
*state
);
3848 int rep_hist_load_state(or_state_t
*state
, char **err
);
3849 void rep_history_clean(time_t before
);
3851 void rep_hist_note_router_reachable(const char *id
, time_t when
);
3852 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
3853 int rep_hist_record_mtbf_data(void);
3854 int rep_hist_load_mtbf_data(time_t now
);
3856 time_t rep_hist_downrate_old_runs(time_t now
);
3857 double rep_hist_get_stability(const char *id
, time_t when
);
3858 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
3859 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
3860 int rep_hist_have_measured_enough_stability(void);
3861 const char *rep_hist_get_router_stability_doc(time_t now
);
3863 void rep_hist_note_used_port(time_t now
, uint16_t port
);
3864 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
3865 void rep_hist_note_used_resolve(time_t now
);
3866 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
3868 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
3869 int *need_capacity
);
3871 int any_predicted_circuits(time_t now
);
3872 int rep_hist_circbuilding_dormant(time_t now
);
3874 /** Possible public/private key operations in Tor: used to keep track of where
3875 * we're spending our time. */
3878 VERIFY_DIR
, VERIFY_RTR
,
3879 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
3880 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
3881 REND_CLIENT
, REND_MID
, REND_SERVER
,
3883 void note_crypto_pk_op(pk_op_t operation
);
3884 void dump_pk_ops(int severity
);
3886 void rep_hist_free_all(void);
3888 /* for hidden service usage statistics */
3889 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
3890 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
3891 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
3892 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
3893 void hs_usage_write_statistics_to_file(time_t now
);
3894 void hs_usage_free_all(void);
3896 /********************************* rendclient.c ***************************/
3898 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
3899 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
3900 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
3901 size_t request_len
);
3902 void rend_client_refetch_renddesc(const char *query
);
3903 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
3904 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
3905 const rend_data_t
*rend_query
);
3906 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
3907 size_t request_len
);
3908 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
3909 size_t request_len
);
3910 void rend_client_desc_trynow(const char *query
, int rend_version
);
3912 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
3914 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
3915 origin_circuit_t
*rendcirc
);
3916 int rend_parse_service_authorization(or_options_t
*options
,
3918 rend_service_authorization_t
*rend_client_lookup_service_authorization(
3919 const char *onion_address
);
3920 void rend_service_authorization_free_all(void);
3921 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
3923 /********************************* rendcommon.c ***************************/
3925 /** Hidden-service side configuration of client authorization. */
3926 typedef struct rend_authorized_client_t
{
3928 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
3929 crypto_pk_env_t
*client_key
;
3930 } rend_authorized_client_t
;
3932 /** ASCII-encoded v2 hidden service descriptor. */
3933 typedef struct rend_encoded_v2_service_descriptor_t
{
3934 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
3935 char *desc_str
; /**< Descriptor string. */
3936 } rend_encoded_v2_service_descriptor_t
;
3938 /** Introduction point information. */
3939 typedef struct rend_intro_point_t
{
3940 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
3941 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
3942 * key, if this descriptor is V2. */
3943 } rend_intro_point_t
;
3945 /** Information used to connect to a hidden service. */
3946 typedef struct rend_service_descriptor_t
{
3947 crypto_pk_env_t
*pk
; /**< This service's public key. */
3948 int version
; /**< Version of the descriptor format: 0 or 2. */
3949 time_t timestamp
; /**< Time when the descriptor was generated. */
3950 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
3951 * (We allow bits '0', '1', and '2' to be set.) */
3952 /** List of the service's introduction points. Elements are removed if
3953 * introduction attempts fail. */
3954 smartlist_t
*intro_nodes
;
3955 /** Has descriptor been uploaded to all hidden service directories? */
3956 int all_uploads_performed
;
3957 /** List of hidden service directories to which an upload request for
3958 * this descriptor could be sent. Smartlist exists only when at least one
3959 * of the previous upload requests failed (otherwise it's not important
3960 * to know which uploads succeeded and which not). */
3961 smartlist_t
*successful_uploads
;
3962 } rend_service_descriptor_t
;
3964 /** Free all storage associated with <b>data</b> */
3966 rend_data_free(rend_data_t
*data
)
3971 int rend_cmp_service_ids(const char *one
, const char *two
);
3973 void rend_process_relay_cell(circuit_t
*circ
, const crypt_path_t
*layer_hint
,
3974 int command
, size_t length
, const char *payload
);
3976 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
3977 int rend_encode_service_descriptor(rend_service_descriptor_t
*desc
,
3978 crypto_pk_env_t
*key
,
3981 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
3983 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
3984 void rend_encoded_v2_service_descriptor_free(
3985 rend_encoded_v2_service_descriptor_t
*desc
);
3986 void rend_intro_point_free(rend_intro_point_t
*intro
);
3988 /** A cached rendezvous descriptor. */
3989 typedef struct rend_cache_entry_t
{
3990 size_t len
; /**< Length of <b>desc</b> */
3991 time_t received
; /**< When was the descriptor received? */
3992 char *desc
; /**< Service descriptor */
3993 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
3994 } rend_cache_entry_t
;
3996 void rend_cache_init(void);
3997 void rend_cache_clean(void);
3998 void rend_cache_clean_v2_descs_as_dir(void);
3999 void rend_cache_free_all(void);
4000 int rend_valid_service_id(const char *query
);
4001 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
4003 int rend_cache_lookup_entry(const char *query
, int version
,
4004 rend_cache_entry_t
**entry_out
);
4005 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
4006 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
4007 int rend_cache_store_v2_desc_as_client(const char *desc
,
4008 const rend_data_t
*rend_query
);
4009 int rend_cache_store_v2_desc_as_dir(const char *desc
);
4010 int rend_cache_size(void);
4011 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
4012 rend_service_descriptor_t
*desc
, time_t now
,
4013 uint8_t period
, rend_auth_type_t auth_type
,
4014 crypto_pk_env_t
*client_key
,
4015 smartlist_t
*client_cookies
);
4016 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
4017 const char *descriptor_cookie
,
4018 time_t now
, uint8_t replica
);
4019 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4020 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4021 const char *service_id
,
4022 const char *secret_id_part
);
4024 /********************************* rendservice.c ***************************/
4026 int num_rend_services(void);
4027 int rend_config_services(or_options_t
*options
, int validate_only
);
4028 int rend_service_load_keys(void);
4029 void rend_services_init(void);
4030 void rend_services_introduce(void);
4031 void rend_consider_services_upload(time_t now
);
4032 void rend_hsdir_routers_changed(void);
4033 void rend_consider_descriptor_republication(void);
4035 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4036 int rend_service_intro_established(origin_circuit_t
*circuit
,
4037 const char *request
,
4038 size_t request_len
);
4039 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4040 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
4041 size_t request_len
);
4042 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4043 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4044 origin_circuit_t
*circ
);
4045 void rend_service_dump_stats(int severity
);
4046 void rend_service_free_all(void);
4048 /********************************* rendmid.c *******************************/
4049 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
4050 size_t request_len
);
4051 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
4052 size_t request_len
);
4053 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
4054 size_t request_len
);
4055 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
4056 size_t request_len
);
4058 /********************************* router.c ***************************/
4060 crypto_pk_env_t
*get_onion_key(void);
4061 time_t get_onion_key_set_at(void);
4062 void set_identity_key(crypto_pk_env_t
*k
);
4063 crypto_pk_env_t
*get_identity_key(void);
4064 int identity_key_is_set(void);
4065 authority_cert_t
*get_my_v3_authority_cert(void);
4066 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4067 authority_cert_t
*get_my_v3_legacy_cert(void);
4068 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4069 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4070 void rotate_onion_key(void);
4071 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4073 void v3_authority_check_key_expiry(void);
4075 int init_keys(void);
4077 int check_whether_orport_reachable(void);
4078 int check_whether_dirport_reachable(void);
4079 void consider_testing_reachability(int test_or
, int test_dir
);
4080 void router_orport_found_reachable(void);
4081 void router_dirport_found_reachable(void);
4082 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4084 int authdir_mode(or_options_t
*options
);
4085 int authdir_mode_v1(or_options_t
*options
);
4086 int authdir_mode_v2(or_options_t
*options
);
4087 int authdir_mode_v3(or_options_t
*options
);
4088 int authdir_mode_any_main(or_options_t
*options
);
4089 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4090 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4091 int authdir_mode_publishes_statuses(or_options_t
*options
);
4092 int authdir_mode_tests_reachability(or_options_t
*options
);
4093 int authdir_mode_bridge(or_options_t
*options
);
4095 int clique_mode(or_options_t
*options
);
4096 int server_mode(or_options_t
*options
);
4097 int advertised_server_mode(void);
4098 int proxy_mode(or_options_t
*options
);
4099 void consider_publishable_server(int force
);
4101 int router_is_clique_mode(routerinfo_t
*router
);
4102 void router_upload_dir_desc_to_dirservers(int force
);
4103 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4104 void mark_my_descriptor_dirty(void);
4105 void check_descriptor_bandwidth_changed(time_t now
);
4106 void check_descriptor_ipaddress_changed(time_t now
);
4107 void router_new_address_suggestion(const char *suggestion
,
4108 const dir_connection_t
*d_conn
);
4109 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4110 routerinfo_t
*router_get_my_routerinfo(void);
4111 extrainfo_t
*router_get_my_extrainfo(void);
4112 const char *router_get_my_descriptor(void);
4113 int router_digest_is_me(const char *digest
);
4114 int router_extrainfo_digest_is_me(const char *digest
);
4115 int router_is_me(routerinfo_t
*router
);
4116 int router_fingerprint_is_me(const char *fp
);
4117 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4118 int router_rebuild_descriptor(int force
);
4119 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4120 crypto_pk_env_t
*ident_key
);
4121 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4122 crypto_pk_env_t
*ident_key
);
4123 int is_legal_nickname(const char *s
);
4124 int is_legal_nickname_or_hexdigest(const char *s
);
4125 int is_legal_hexdigest(const char *s
);
4126 void router_get_verbose_nickname(char *buf
, routerinfo_t
*router
);
4127 void router_reset_warnings(void);
4128 void router_reset_reachability(void);
4129 void router_free_all(void);
4131 const char *router_purpose_to_string(uint8_t p
);
4132 uint8_t router_purpose_from_string(const char *s
);
4134 #ifdef ROUTER_PRIVATE
4135 /* Used only by router.c and test.c */
4136 void get_platform_str(char *platform
, size_t len
);
4139 /********************************* routerlist.c ***************************/
4141 /** Represents information about a single trusted directory server. */
4142 typedef struct trusted_dir_server_t
{
4145 char *address
; /**< Hostname. */
4146 uint32_t addr
; /**< IPv4 address. */
4147 uint16_t dir_port
; /**< Directory port. */
4148 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4149 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4150 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4151 * high-security) identity key. */
4153 unsigned int is_running
:1; /**< True iff we think this server is running. */
4155 /** True iff this server has accepted the most recent server descriptor
4156 * we tried to upload to it. */
4157 unsigned int has_accepted_serverdesc
:1;
4159 /** What kind of authority is this? (Bitfield.) */
4160 authority_type_t type
;
4162 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4163 * v2 network status. */
4164 time_t addr_current_at
; /**< When was the document that we derived the
4165 * address information from published? */
4167 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4168 * dir_server_t to directory_initiate_command_*
4169 * as a routerstatus_t. Not updated by the
4170 * router-status management code!
4172 } trusted_dir_server_t
;
4174 #define ROUTER_REQUIRED_MIN_BANDWIDTH 10000
4176 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4178 int get_n_authorities(authority_type_t type
);
4179 int trusted_dirs_reload_certs(void);
4180 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4182 void trusted_dirs_flush_certs_to_disk(void);
4183 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4184 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4185 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4186 const char *sk_digest
);
4187 void authority_cert_get_all(smartlist_t
*certs_out
);
4188 void authority_cert_dl_failed(const char *id_digest
, int status
);
4189 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4190 int router_reload_router_list(void);
4191 smartlist_t
*router_get_trusted_dir_servers(void);
4193 /* Flags for pick_directory_server and pick_trusteddirserver. */
4194 /** Flag to indicate that we should not automatically be willing to use
4195 * ourself to answer a directory request.
4196 * Passed to router_pick_directory_server (et al).*/
4197 #define PDS_ALLOW_SELF (1<<0)
4198 /** Flag to indicate that if no servers seem to be up, we should mark all
4199 * directory servers as up and try again.
4200 * Passed to router_pick_directory_server (et al).*/
4201 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4202 /** Flag to indicate that we should not exclude directory servers that
4203 * our ReachableAddress settings would exclude. This usually means that
4204 * we're going to connect to the server over Tor, and so we don't need to
4205 * worry about our firewall telling us we can't.
4206 * Passed to router_pick_directory_server (et al).*/
4207 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4208 /** Flag to indicate that we should not use any directory authority to which
4209 * we have an existing directory connection for downloading server descriptors
4210 * or extrainfo documents.
4212 * Passed to router_pick_directory_server (et al)
4214 * [XXXX021 NOTE: This option is only implemented for pick_trusteddirserver,
4215 * not pick_directory_server. If we make it work on pick_directory_server
4216 * too, we could conservatively make it only prevent multiple fetches to
4217 * the same authority, or we could aggressively make it prevent multiple
4218 * fetches to _any_ directory server.]
4220 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4221 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4222 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4223 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4224 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4225 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4226 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4227 double *v3_share_out
);
4228 void router_reset_status_download_failures(void);
4229 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4230 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4231 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4232 int must_be_running
);
4233 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4234 routerinfo_t
*routerlist_find_my_routerinfo(void);
4235 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4237 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4238 int need_capacity
, int need_guard
);
4239 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4240 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4243 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4244 } bandwidth_weight_rule_t
;
4245 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4246 bandwidth_weight_rule_t rule
);
4247 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4249 /** Flags to be control router_choose_random_node */
4251 CRN_NEED_UPTIME
= 1<<0,
4252 CRN_NEED_CAPACITY
= 1<<1,
4253 CRN_NEED_GUARD
= 1<<2,
4254 CRN_ALLOW_INVALID
= 1<<3,
4255 /* XXXX021 not used, apparently. */
4256 CRN_STRICT_PREFERRED
= 1<<4,
4257 /* XXXX021 not used, apparently. */
4258 CRN_WEIGHT_AS_EXIT
= 1<<5
4259 } router_crn_flags_t
;
4261 routerinfo_t
*router_choose_random_node(const char *preferred
,
4262 smartlist_t
*excludedsmartlist
,
4263 struct routerset_t
*excludedset
,
4264 router_crn_flags_t flags
);
4266 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4267 int warn_if_unnamed
);
4268 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4269 int router_digest_is_trusted_dir_type(const char *digest
,
4270 authority_type_t type
);
4271 #define router_digest_is_trusted_dir(d) \
4272 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4274 int router_addr_is_trusted_dir(uint32_t addr
);
4275 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4276 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4277 routerinfo_t
*router_get_by_digest(const char *digest
);
4278 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4279 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4280 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4281 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4282 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4283 routerlist_t
*router_get_routerlist(void);
4284 void routerinfo_free(routerinfo_t
*router
);
4285 void extrainfo_free(extrainfo_t
*extrainfo
);
4286 void routerlist_free(routerlist_t
*rl
);
4287 void dump_routerlist_mem_usage(int severity
);
4288 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
);
4289 void routerlist_free_all(void);
4290 void routerlist_reset_warnings(void);
4291 void router_set_status(const char *digest
, int up
);
4292 int router_add_to_routerlist(routerinfo_t
*router
, const char **msg
,
4293 int from_cache
, int from_fetch
);
4294 int router_add_extrainfo_to_routerlist(extrainfo_t
*ei
, const char **msg
,
4295 int from_cache
, int from_fetch
);
4296 void routerlist_remove_old_routers(void);
4297 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4299 void router_load_routers_from_string(const char *s
, const char *eos
,
4300 saved_location_t saved_location
,
4301 smartlist_t
*requested_fingerprints
,
4302 int descriptor_digests
,
4303 const char *prepend_annotations
);
4304 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4305 saved_location_t saved_location
,
4306 smartlist_t
*requested_fingerprints
,
4307 int descriptor_digests
);
4308 void routerlist_retry_directory_downloads(time_t now
);
4309 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4311 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4312 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4313 const char *address
,
4314 uint16_t dir_port
, uint16_t or_port
,
4315 const char *digest
, const char *v3_auth_digest
,
4316 authority_type_t type
);
4317 void authority_cert_free(authority_cert_t
*cert
);
4318 void clear_trusted_dir_servers(void);
4319 int any_trusted_dir_is_v1_authority(void);
4320 void update_router_descriptor_downloads(time_t now
);
4321 void update_extrainfo_downloads(time_t now
);
4322 int router_have_minimum_dir_info(void);
4323 void router_dir_info_changed(void);
4324 const char *get_dir_info_status_string(void);
4325 int count_loading_descriptors_progress(void);
4326 void router_reset_descriptor_download_failures(void);
4327 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
4328 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
4329 signed_descriptor_t
*sd
,
4331 void routerlist_assert_ok(routerlist_t
*rl
);
4332 const char *esc_router_info(routerinfo_t
*router
);
4333 void routers_sort_by_identity(smartlist_t
*routers
);
4335 routerset_t
*routerset_new(void);
4336 int routerset_parse(routerset_t
*target
, const char *s
,
4337 const char *description
);
4338 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
4339 int routerset_is_list(const routerset_t
*set
);
4340 int routerset_needs_geoip(const routerset_t
*set
);
4341 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
4342 int routerset_contains_routerstatus(const routerset_t
*set
,
4343 routerstatus_t
*rs
);
4344 int routerset_contains_extendinfo(const routerset_t
*set
, extend_info_t
*ei
);
4345 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
4347 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
4348 const routerset_t
*include
,
4349 const routerset_t
*exclude
, int running_only
);
4350 void routerset_subtract_routers(smartlist_t
*out
,
4351 const routerset_t
*routerset
);
4352 char *routerset_to_string(const routerset_t
*routerset
);
4353 void routerset_refresh_countries(routerset_t
*target
);
4354 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
4355 void routerset_free(routerset_t
*routerset
);
4356 void routerinfo_set_country(routerinfo_t
*ri
);
4357 void routerlist_refresh_countries(void);
4359 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
4361 int hid_serv_acting_as_directory(void);
4362 int hid_serv_responsible_for_desc_id(const char *id
);
4364 /********************************* routerparse.c ************************/
4366 #define MAX_STATUS_TAG_LEN 32
4367 /** Structure to hold parsed Tor versions. This is a little messier
4368 * than we would like it to be, because we changed version schemes with 0.1.0.
4370 * See version-spec.txt for the whole business.
4372 typedef struct tor_version_t
{
4376 /** Release status. For version in the post-0.1 format, this is always
4378 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4380 char status_tag
[MAX_STATUS_TAG_LEN
];
4384 int router_get_router_hash(const char *s
, char *digest
);
4385 int router_get_dir_hash(const char *s
, char *digest
);
4386 int router_get_runningrouters_hash(const char *s
, char *digest
);
4387 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
4388 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
4389 int router_get_extrainfo_hash(const char *s
, char *digest
);
4390 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
4392 crypto_pk_env_t
*private_key
);
4393 int router_parse_list_from_string(const char **s
, const char *eos
,
4395 saved_location_t saved_location
,
4397 int allow_annotations
,
4398 const char *prepend_annotations
);
4399 int router_parse_routerlist_from_directory(const char *s
,
4400 routerlist_t
**dest
,
4401 crypto_pk_env_t
*pkey
,
4403 int write_to_cache
);
4404 int router_parse_runningrouters(const char *str
);
4405 int router_parse_directory(const char *str
);
4406 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
4408 int allow_annotations
,
4409 const char *prepend_annotations
);
4410 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
4411 int cache_copy
, struct digest_ri_map_t
*routermap
);
4412 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
4414 version_status_t
tor_version_is_obsolete(const char *myversion
,
4415 const char *versionlist
);
4416 int tor_version_parse(const char *s
, tor_version_t
*out
);
4417 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
4418 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
4419 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
4420 void assert_addr_policy_ok(smartlist_t
*t
);
4421 void dump_distinct_digest_count(int severity
);
4423 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
4424 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
4425 const char **eos_out
,
4426 networkstatus_type_t ns_type
);
4427 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
4428 const char *s
, const char *eos
);
4430 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
4431 const char **end_of_string
);
4432 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
4434 char **intro_points_encrypted_out
,
4435 size_t *intro_points_encrypted_size_out
,
4436 size_t *encoded_size_out
,
4437 const char **next_out
, const char *desc
);
4438 int rend_decrypt_introduction_points(char **ipos_decrypted
,
4439 size_t *ipos_decrypted_size
,
4440 const char *descriptor_cookie
,
4441 const char *ipos_encrypted
,
4442 size_t ipos_encrypted_size
);
4443 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
4444 const char *intro_points_encoded
,
4445 size_t intro_points_encoded_size
);
4446 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);