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-2011, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Master header file for Tor-specific functionality.
18 /* If we're building for a static analysis, turn on all the off-by-default
20 #ifndef INSTRUMENT_DOWNLOADS
21 #define INSTRUMENT_DOWNLOADS 1
23 #ifndef ENABLE_GEOIP_STATS
24 #define ENABLE_GEOIP_STATS 1
29 #define WIN32_WINNT 0x400
30 #define _WIN32_WINNT 0x400
31 #define WIN32_LEAN_AND_MEAN
43 #ifdef HAVE_SYS_PARAM_H
44 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
47 #ifdef HAVE_SYS_WAIT_H
50 #ifdef HAVE_SYS_FCNTL_H
51 #include <sys/fcntl.h>
56 #ifdef HAVE_SYS_IOCTL_H
57 #include <sys/ioctl.h>
62 #ifdef HAVE_SYS_STAT_H
65 #ifdef HAVE_ARPA_INET_H
66 #include <arpa/inet.h>
83 #define snprintf _snprintf
90 #include "container.h"
97 /* These signals are defined to help control_signal_act work.
114 /* Controller signals start at a high number so we don't
115 * conflict with system-defined signals. */
116 #define SIGNEWNYM 129
117 #define SIGCLEARDNSCACHE 130
119 #if (SIZEOF_CELL_T != 0)
120 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
121 * that our stuff always calls cell_t something different. */
122 #define cell_t tor_cell_t
125 /** Length of longest allowable configured nickname. */
126 #define MAX_NICKNAME_LEN 19
127 /** Length of a router identity encoded as a hexadecimal digest, plus
128 * possible dollar sign. */
129 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
130 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
131 * equal sign or tilde, nickname. */
132 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
134 /** Maximum size, in bytes, for resized buffers. */
135 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
136 /** Maximum size, in bytes, for any directory object that we've downloaded. */
137 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
139 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
140 * of an HTTP request or response. */
141 #define MAX_HEADERS_SIZE 50000
142 /** Maximum size, in bytes, for any directory object that we're accepting
144 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
146 /** Maximum size, in bytes, of a single router descriptor uploaded to us
147 * as a directory authority. Caches and clients fetch whatever descriptors
148 * the authorities tell them to fetch, and don't care about size. */
149 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
151 /** Maximum size of a single extrainfo document, as above. */
152 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
154 /** How long do we keep DNS cache entries before purging them (regardless of
156 #define MAX_DNS_ENTRY_AGE (30*60)
157 /** How long do we cache/tell clients to cache DNS records when no TTL is
159 #define DEFAULT_DNS_TTL (30*60)
160 /** How long can a TTL be before we stop believing it? */
161 #define MAX_DNS_TTL (3*60*60)
162 /** How small can a TTL be before we stop believing it? Provides rudimentary
164 #define MIN_DNS_TTL (60)
166 /** How often do we rotate onion keys? */
167 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
168 /** How often do we rotate TLS contexts? */
169 #define MAX_SSL_KEY_LIFETIME_INTERNAL (2*60*60)
170 /** What expiry time shall we place on our SSL certs? */
171 #define MAX_SSL_KEY_LIFETIME_ADVERTISED (365*24*60*60)
173 /** How old do we allow a router to get before removing it
174 * from the router list? In seconds. */
175 #define ROUTER_MAX_AGE (60*60*48)
176 /** How old can a router get before we (as a server) will no longer
177 * consider it live? In seconds. */
178 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
179 /** How old do we let a saved descriptor get before force-removing it? */
180 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
182 /** Possible rules for generating circuit IDs on an OR connection. */
184 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
185 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
186 /** The other side of a connection is an OP: never create circuits to it,
187 * and let it use any circuit ID it wants. */
188 CIRC_ID_TYPE_NEITHER
=2
191 #define _CONN_TYPE_MIN 3
192 /** Type for sockets listening for OR connections. */
193 #define CONN_TYPE_OR_LISTENER 3
194 /** A bidirectional TLS connection transmitting a sequence of cells.
195 * May be from an OR to an OR, or from an OP to an OR. */
196 #define CONN_TYPE_OR 4
197 /** A TCP connection from an onion router to a stream's destination. */
198 #define CONN_TYPE_EXIT 5
199 /** Type for sockets listening for SOCKS connections. */
200 #define CONN_TYPE_AP_LISTENER 6
201 /** A SOCKS proxy connection from the user application to the onion
203 #define CONN_TYPE_AP 7
204 /** Type for sockets listening for HTTP connections to the directory server. */
205 #define CONN_TYPE_DIR_LISTENER 8
206 /** Type for HTTP connections to the directory server. */
207 #define CONN_TYPE_DIR 9
208 /** Connection from the main process to a CPU worker process. */
209 #define CONN_TYPE_CPUWORKER 10
210 /** Type for listening for connections from user interface process. */
211 #define CONN_TYPE_CONTROL_LISTENER 11
212 /** Type for connections from user interface process. */
213 #define CONN_TYPE_CONTROL 12
214 /** Type for sockets listening for transparent connections redirected by pf or
216 #define CONN_TYPE_AP_TRANS_LISTENER 13
217 /** Type for sockets listening for transparent connections redirected by
219 #define CONN_TYPE_AP_NATD_LISTENER 14
220 /** Type for sockets listening for DNS requests. */
221 #define CONN_TYPE_AP_DNS_LISTENER 15
222 #define _CONN_TYPE_MAX 15
223 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
226 /** True iff <b>x</b> is an edge connection. */
227 #define CONN_IS_EDGE(x) \
228 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
230 /** State for any listener connection. */
231 #define LISTENER_STATE_READY 0
233 #define _CPUWORKER_STATE_MIN 1
234 /** State for a connection to a cpuworker process that's idle. */
235 #define CPUWORKER_STATE_IDLE 1
236 /** State for a connection to a cpuworker process that's processing a
238 #define CPUWORKER_STATE_BUSY_ONION 2
239 #define _CPUWORKER_STATE_MAX 2
241 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
243 #define _OR_CONN_STATE_MIN 1
244 /** State for a connection to an OR: waiting for connect() to finish. */
245 #define OR_CONN_STATE_CONNECTING 1
246 /** State for a connection to an OR: waiting for proxy command to flush. */
247 #define OR_CONN_STATE_PROXY_FLUSHING 2
248 /** State for a connection to an OR: waiting for proxy response. */
249 #define OR_CONN_STATE_PROXY_READING 3
250 /** State for a connection to an OR or client: SSL is handshaking, not done
252 #define OR_CONN_STATE_TLS_HANDSHAKING 4
253 /** State for a connection to an OR: We're doing a second SSL handshake for
254 * renegotiation purposes. */
255 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 5
256 /** State for a connection at an OR: We're waiting for the client to
258 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 6
259 /** State for a connection to an OR: We're done with our SSL handshake, but we
260 * haven't yet negotiated link protocol versions and sent a netinfo cell.
262 #define OR_CONN_STATE_OR_HANDSHAKING 7
263 /** State for a connection to an OR: Ready to send/receive cells. */
264 #define OR_CONN_STATE_OPEN 8
265 #define _OR_CONN_STATE_MAX 8
267 #define _EXIT_CONN_STATE_MIN 1
268 /** State for an exit connection: waiting for response from DNS farm. */
269 #define EXIT_CONN_STATE_RESOLVING 1
270 /** State for an exit connection: waiting for connect() to finish. */
271 #define EXIT_CONN_STATE_CONNECTING 2
272 /** State for an exit connection: open and ready to transmit data. */
273 #define EXIT_CONN_STATE_OPEN 3
274 /** State for an exit connection: waiting to be removed. */
275 #define EXIT_CONN_STATE_RESOLVEFAILED 4
276 #define _EXIT_CONN_STATE_MAX 4
278 /* The AP state values must be disjoint from the EXIT state values. */
279 #define _AP_CONN_STATE_MIN 5
280 /** State for a SOCKS connection: waiting for SOCKS request. */
281 #define AP_CONN_STATE_SOCKS_WAIT 5
282 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
283 * rendezvous descriptor. */
284 #define AP_CONN_STATE_RENDDESC_WAIT 6
285 /** The controller will attach this connection to a circuit; it isn't our
287 #define AP_CONN_STATE_CONTROLLER_WAIT 7
288 /** State for a SOCKS connection: waiting for a completed circuit. */
289 #define AP_CONN_STATE_CIRCUIT_WAIT 8
290 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
291 #define AP_CONN_STATE_CONNECT_WAIT 9
292 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
293 #define AP_CONN_STATE_RESOLVE_WAIT 10
294 /** State for a SOCKS connection: ready to send and receive. */
295 #define AP_CONN_STATE_OPEN 11
296 /** State for a transparent natd connection: waiting for original
298 #define AP_CONN_STATE_NATD_WAIT 12
299 #define _AP_CONN_STATE_MAX 12
301 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
302 * edge connection is not attached to any circuit. */
303 #define AP_CONN_STATE_IS_UNATTACHED(s) \
304 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
306 #define _DIR_CONN_STATE_MIN 1
307 /** State for connection to directory server: waiting for connect(). */
308 #define DIR_CONN_STATE_CONNECTING 1
309 /** State for connection to directory server: sending HTTP request. */
310 #define DIR_CONN_STATE_CLIENT_SENDING 2
311 /** State for connection to directory server: reading HTTP response. */
312 #define DIR_CONN_STATE_CLIENT_READING 3
313 /** State for connection to directory server: happy and finished. */
314 #define DIR_CONN_STATE_CLIENT_FINISHED 4
315 /** State for connection at directory server: waiting for HTTP request. */
316 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
317 /** State for connection at directory server: sending HTTP response. */
318 #define DIR_CONN_STATE_SERVER_WRITING 6
319 #define _DIR_CONN_STATE_MAX 6
321 /** True iff the purpose of <b>conn</b> means that it's a server-side
322 * directory connection. */
323 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
325 #define _CONTROL_CONN_STATE_MIN 1
326 /** State for a control connection: Authenticated and accepting v1 commands. */
327 #define CONTROL_CONN_STATE_OPEN 1
328 /** State for a control connection: Waiting for authentication; speaking
330 #define CONTROL_CONN_STATE_NEEDAUTH 2
331 #define _CONTROL_CONN_STATE_MAX 2
333 #define _DIR_PURPOSE_MIN 3
334 /** A connection to a directory server: download a rendezvous
336 #define DIR_PURPOSE_FETCH_RENDDESC 3
337 /** A connection to a directory server: set after a rendezvous
338 * descriptor is downloaded. */
339 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
340 /** A connection to a directory server: download one or more v2
341 * network-status objects */
342 #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
343 /** A connection to a directory server: download one or more server
345 #define DIR_PURPOSE_FETCH_SERVERDESC 6
346 /** A connection to a directory server: download one or more extra-info
348 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
349 /** A connection to a directory server: upload a server descriptor. */
350 #define DIR_PURPOSE_UPLOAD_DIR 8
351 /** A connection to a directory server: upload a rendezvous
353 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
354 /** A connection to a directory server: upload a v3 networkstatus vote. */
355 #define DIR_PURPOSE_UPLOAD_VOTE 10
356 /** A connection to a directory server: upload a v3 consensus signature */
357 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
358 /** A connection to a directory server: download one or more v3 networkstatus
360 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
361 /** A connection to a directory server: download a v3 detached signatures
362 * object for a consensus. */
363 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
364 /** A connection to a directory server: download a v3 networkstatus
366 #define DIR_PURPOSE_FETCH_CONSENSUS 14
367 /** A connection to a directory server: download one or more directory
368 * authority certificates. */
369 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
371 /** Purpose for connection at a directory server. */
372 #define DIR_PURPOSE_SERVER 16
373 /** A connection to a hidden service directory server: upload a v2 rendezvous
375 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
376 /** A connection to a hidden service directory server: download a v2 rendezvous
378 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
379 #define _DIR_PURPOSE_MAX 18
381 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
382 * directory server. */
383 #define DIR_PURPOSE_IS_UPLOAD(p) \
384 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
385 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
386 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
387 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
389 #define _EXIT_PURPOSE_MIN 1
390 /** This exit stream wants to do an ordinary connect. */
391 #define EXIT_PURPOSE_CONNECT 1
392 /** This exit stream wants to do a resolve (either normal or reverse). */
393 #define EXIT_PURPOSE_RESOLVE 2
394 #define _EXIT_PURPOSE_MAX 2
396 /* !!!! If any connection purpose is ever over 31, we must grow the type
397 * field in connection_t. */
399 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
400 #define CIRCUIT_STATE_BUILDING 0
401 /** Circuit state: Waiting to process the onionskin. */
402 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
403 /** Circuit state: I'd like to deliver a create, but my n_conn is still
405 #define CIRCUIT_STATE_OR_WAIT 2
406 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
407 #define CIRCUIT_STATE_OPEN 3
409 #define _CIRCUIT_PURPOSE_MIN 1
411 /* these circuits were initiated elsewhere */
412 #define _CIRCUIT_PURPOSE_OR_MIN 1
413 /** OR-side circuit purpose: normal circuit, at OR. */
414 #define CIRCUIT_PURPOSE_OR 1
415 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
416 #define CIRCUIT_PURPOSE_INTRO_POINT 2
417 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
418 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
419 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
420 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
421 #define _CIRCUIT_PURPOSE_OR_MAX 4
423 /* these circuits originate at this node */
425 /* here's how circ client-side purposes work:
426 * normal circuits are C_GENERAL.
427 * circuits that are c_introducing are either on their way to
428 * becoming open, or they are open and waiting for a
429 * suitable rendcirc before they send the intro.
430 * circuits that are c_introduce_ack_wait have sent the intro,
431 * but haven't gotten a response yet.
432 * circuits that are c_establish_rend are either on their way
433 * to becoming open, or they are open and have sent the
434 * establish_rendezvous cell but haven't received an ack.
435 * circuits that are c_rend_ready are open and have received a
436 * rend ack, but haven't heard from bob yet. if they have a
437 * buildstate->pending_final_cpath then they're expecting a
438 * cell from bob, else they're not.
439 * circuits that are c_rend_ready_intro_acked are open, and
440 * some intro circ has sent its intro and received an ack.
441 * circuits that are c_rend_joined are open, have heard from
442 * bob, and are talking to him.
444 /** Client-side circuit purpose: Normal circuit, with cpath. */
445 #define CIRCUIT_PURPOSE_C_GENERAL 5
446 /** Client-side circuit purpose: at Alice, connecting to intro point. */
447 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
448 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
449 * waiting for ACK/NAK. */
450 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
451 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
452 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
453 /** Client-side circuit purpose: at Alice, waiting for ack. */
454 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
455 /** Client-side circuit purpose: at Alice, waiting for Bob. */
456 #define CIRCUIT_PURPOSE_C_REND_READY 10
457 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
458 * has been acknowledged. */
459 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
460 /** Client-side circuit purpose: at Alice, rendezvous established. */
461 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
463 #define _CIRCUIT_PURPOSE_C_MAX 12
465 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
466 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
467 /** Hidden-service-side circuit purpose: at Bob, successfully established
469 #define CIRCUIT_PURPOSE_S_INTRO 14
470 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
471 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
472 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
473 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
474 /** A testing circuit; not meant to be used for actual traffic. */
475 #define CIRCUIT_PURPOSE_TESTING 17
476 /** A controller made this circuit and Tor should not use it. */
477 #define CIRCUIT_PURPOSE_CONTROLLER 18
478 #define _CIRCUIT_PURPOSE_MAX 18
479 /** A catch-all for unrecognized purposes. Currently we don't expect
480 * to make or see any circuits with this purpose. */
481 #define CIRCUIT_PURPOSE_UNKNOWN 255
483 /** True iff the circuit purpose <b>p</b> is for a circuit that
484 * originated at this node. */
485 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
486 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
487 * here to serve as a client. (Hidden services don't count here.) */
488 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
489 ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
490 (p)<=_CIRCUIT_PURPOSE_C_MAX)
491 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
492 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
493 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
495 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
496 ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
497 (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
499 /** How many circuits do we want simultaneously in-progress to handle
501 #define MIN_CIRCUITS_HANDLING_STREAM 2
503 /* These RELAY_COMMAND constants define values for relay cell commands, and
504 * must match those defined in tor-spec.txt. */
505 #define RELAY_COMMAND_BEGIN 1
506 #define RELAY_COMMAND_DATA 2
507 #define RELAY_COMMAND_END 3
508 #define RELAY_COMMAND_CONNECTED 4
509 #define RELAY_COMMAND_SENDME 5
510 #define RELAY_COMMAND_EXTEND 6
511 #define RELAY_COMMAND_EXTENDED 7
512 #define RELAY_COMMAND_TRUNCATE 8
513 #define RELAY_COMMAND_TRUNCATED 9
514 #define RELAY_COMMAND_DROP 10
515 #define RELAY_COMMAND_RESOLVE 11
516 #define RELAY_COMMAND_RESOLVED 12
517 #define RELAY_COMMAND_BEGIN_DIR 13
519 #define RELAY_COMMAND_ESTABLISH_INTRO 32
520 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
521 #define RELAY_COMMAND_INTRODUCE1 34
522 #define RELAY_COMMAND_INTRODUCE2 35
523 #define RELAY_COMMAND_RENDEZVOUS1 36
524 #define RELAY_COMMAND_RENDEZVOUS2 37
525 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
526 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
527 #define RELAY_COMMAND_INTRODUCE_ACK 40
529 /* Reasons why an OR connection is closed. */
530 #define END_OR_CONN_REASON_DONE 1
531 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
532 #define END_OR_CONN_REASON_OR_IDENTITY 3
533 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
534 #define END_OR_CONN_REASON_TIMEOUT 5
535 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
536 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
537 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
538 #define END_OR_CONN_REASON_MISC 9
540 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
541 * documentation of these. The values must match. */
542 #define END_STREAM_REASON_MISC 1
543 #define END_STREAM_REASON_RESOLVEFAILED 2
544 #define END_STREAM_REASON_CONNECTREFUSED 3
545 #define END_STREAM_REASON_EXITPOLICY 4
546 #define END_STREAM_REASON_DESTROY 5
547 #define END_STREAM_REASON_DONE 6
548 #define END_STREAM_REASON_TIMEOUT 7
549 #define END_STREAM_REASON_NOROUTE 8
550 #define END_STREAM_REASON_HIBERNATING 9
551 #define END_STREAM_REASON_INTERNAL 10
552 #define END_STREAM_REASON_RESOURCELIMIT 11
553 #define END_STREAM_REASON_CONNRESET 12
554 #define END_STREAM_REASON_TORPROTOCOL 13
555 #define END_STREAM_REASON_NOTDIRECTORY 14
556 #define END_STREAM_REASON_ENTRYPOLICY 15
558 /* These high-numbered end reasons are not part of the official spec,
559 * and are not intended to be put in relay end cells. They are here
560 * to be more informative when sending back socks replies to the
562 /* XXXX 256 is no longer used; feel free to reuse it. */
563 /** We were unable to attach the connection to any circuit at all. */
564 /* XXXX the ways we use this one don't make a lot of sense. */
565 #define END_STREAM_REASON_CANT_ATTACH 257
566 /** We can't connect to any directories at all, so we killed our streams
567 * before they can time out. */
568 #define END_STREAM_REASON_NET_UNREACHABLE 258
569 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
570 * protocol in a way we couldn't handle. */
571 #define END_STREAM_REASON_SOCKSPROTOCOL 259
572 /** This is a transparent proxy connection, but we can't extract the original
573 * target address:port. */
574 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
575 /** This is a connection on the NATD port, and the destination IP:Port was
576 * either ill-formed or out-of-range. */
577 #define END_STREAM_REASON_INVALID_NATD_DEST 261
579 /** Bitwise-and this value with endreason to mask out all flags. */
580 #define END_STREAM_REASON_MASK 511
582 /** Bitwise-or this with the argument to control_event_stream_status
583 * to indicate that the reason came from an END cell. */
584 #define END_STREAM_REASON_FLAG_REMOTE 512
585 /** Bitwise-or this with the argument to control_event_stream_status
586 * to indicate that we already sent a CLOSED stream event. */
587 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
588 /** Bitwise-or this with endreason to indicate that we already sent
589 * a socks reply, and no further reply needs to be sent from
590 * connection_mark_unattached_ap(). */
591 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
593 /** Reason for remapping an AP connection's address: we have a cached
595 #define REMAP_STREAM_SOURCE_CACHE 1
596 /** Reason for remapping an AP connection's address: the exit node told us an
598 #define REMAP_STREAM_SOURCE_EXIT 2
600 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
601 #define RESOLVED_TYPE_HOSTNAME 0
602 #define RESOLVED_TYPE_IPV4 4
603 #define RESOLVED_TYPE_IPV6 6
604 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
605 #define RESOLVED_TYPE_ERROR 0xF1
607 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
608 * call; they only go to the controller for tracking */
609 /** We couldn't build a path for this circuit. */
610 #define END_CIRC_REASON_NOPATH -2
611 /** Catch-all "other" reason for closing origin circuits. */
612 #define END_CIRC_AT_ORIGIN -1
614 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
615 * documentation of these. */
616 #define _END_CIRC_REASON_MIN 0
617 #define END_CIRC_REASON_NONE 0
618 #define END_CIRC_REASON_TORPROTOCOL 1
619 #define END_CIRC_REASON_INTERNAL 2
620 #define END_CIRC_REASON_REQUESTED 3
621 #define END_CIRC_REASON_HIBERNATING 4
622 #define END_CIRC_REASON_RESOURCELIMIT 5
623 #define END_CIRC_REASON_CONNECTFAILED 6
624 #define END_CIRC_REASON_OR_IDENTITY 7
625 #define END_CIRC_REASON_OR_CONN_CLOSED 8
626 #define END_CIRC_REASON_FINISHED 9
627 #define END_CIRC_REASON_TIMEOUT 10
628 #define END_CIRC_REASON_DESTROYED 11
629 #define END_CIRC_REASON_NOSUCHSERVICE 12
630 #define _END_CIRC_REASON_MAX 12
632 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
633 * control_event_circuit_status() to indicate that the reason was
634 * passed through from a destroy or truncate cell. */
635 #define END_CIRC_REASON_FLAG_REMOTE 512
637 /** Length of 'y' portion of 'y.onion' URL. */
638 #define REND_SERVICE_ID_LEN_BASE32 16
640 /** Length of 'y.onion' including '.onion' URL. */
641 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
643 /** Length of a binary-encoded rendezvous service ID. */
644 #define REND_SERVICE_ID_LEN 10
646 /** How long after we receive a hidden service descriptor do we consider
648 #define NUM_SECONDS_BEFORE_HS_REFETCH (60*15)
650 /** Time period for which a v2 descriptor will be valid. */
651 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
653 /** Time period within which two sets of v2 descriptors will be uploaded in
655 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
657 /** Number of non-consecutive replicas (i.e. distributed somewhere
658 * in the ring) for a descriptor. */
659 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
661 /** Number of consecutive replicas for a descriptor. */
662 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
664 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
665 #define REND_DESC_ID_V2_LEN_BASE32 32
667 /** Length of the base32-encoded secret ID part of versioned hidden service
669 #define REND_SECRET_ID_PART_LEN_BASE32 32
671 /** Length of the base32-encoded hash of an introduction point's
673 #define REND_INTRO_POINT_ID_LEN_BASE32 32
675 /** Length of the descriptor cookie that is used for client authorization
676 * to hidden services. */
677 #define REND_DESC_COOKIE_LEN 16
679 /** Length of the base64-encoded descriptor cookie that is used for
680 * exchanging client authorization between hidden service and client. */
681 #define REND_DESC_COOKIE_LEN_BASE64 22
683 /** Length of client identifier in encrypted introduction points for hidden
684 * service authorization type 'basic'. */
685 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
687 /** Multiple of the number of clients to which the real number of clients
688 * is padded with fake clients for hidden service authorization type
690 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
692 /** Length of client entry consisting of client identifier and encrypted
693 * session key for hidden service authorization type 'basic'. */
694 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
697 /** Maximum size of v2 hidden service descriptors. */
698 #define REND_DESC_MAX_SIZE (20 * 1024)
700 /** Legal characters for use in authorized client names for a hidden
702 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
703 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
705 /** Maximum length of authorized client names for a hidden service. */
706 #define REND_CLIENTNAME_MAX_LEN 16
708 /** Length of the rendezvous cookie that is used to connect circuits at the
709 * rendezvous point. */
710 #define REND_COOKIE_LEN DIGEST_LEN
712 /** Client authorization type that a hidden service performs. */
713 typedef enum rend_auth_type_t
{
716 REND_STEALTH_AUTH
= 2,
719 /** Client-side configuration of authorization for a hidden service. */
720 typedef struct rend_service_authorization_t
{
721 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
722 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
723 rend_auth_type_t auth_type
;
724 } rend_service_authorization_t
;
726 /** Client- and server-side data that is used for hidden service connection
727 * establishment. Not all fields contain data depending on where this struct
729 typedef struct rend_data_t
{
730 /** Onion address (without the .onion part) that a client requests. */
731 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
733 /** (Optional) descriptor cookie that is used by a client. */
734 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
736 /** Authorization type for accessing a service used by a client. */
737 rend_auth_type_t auth_type
;
739 /** Hash of the hidden service's PK used by a service. */
740 char rend_pk_digest
[DIGEST_LEN
];
742 /** Rendezvous cookie used by both, client and service. */
743 char rend_cookie
[REND_COOKIE_LEN
];
745 /** Rendezvous descriptor version that is used by a service. Used to
746 * distinguish introduction and rendezvous points belonging to the same
747 * rendezvous service ID, but different descriptor versions.
749 uint8_t rend_desc_version
;
752 /** Time interval for tracking possible replays of INTRODUCE2 cells.
753 * Incoming cells with timestamps half of this interval in the past or
754 * future are dropped immediately. */
755 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
757 /** Used to indicate which way a cell is going on a circuit. */
759 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
760 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
763 /** Initial value for both sides of a circuit transmission window when the
764 * circuit is initialized. Measured in cells. */
765 #define CIRCWINDOW_START 1000
766 /** Amount to increment a circuit window when we get a circuit SENDME. */
767 #define CIRCWINDOW_INCREMENT 100
768 /** Initial value on both sides of a stream transmission window when the
769 * stream is initialized. Measured in cells. */
770 #define STREAMWINDOW_START 500
771 /** Amount to increment a stream window when we get a stream SENDME. */
772 #define STREAMWINDOW_INCREMENT 50
774 /* Cell commands. These values are defined in tor-spec.txt. */
775 #define CELL_PADDING 0
776 #define CELL_CREATE 1
777 #define CELL_CREATED 2
779 #define CELL_DESTROY 4
780 #define CELL_CREATE_FAST 5
781 #define CELL_CREATED_FAST 6
782 #define CELL_VERSIONS 7
783 #define CELL_NETINFO 8
784 #define CELL_RELAY_EARLY 9
786 /** True iff the cell command <b>x</b> is one that implies a variable-length
788 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
790 /** How long to test reachability before complaining to the user. */
791 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
793 /** Legal characters in a nickname. */
794 #define LEGAL_NICKNAME_CHARACTERS \
795 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
797 /** Name to use in client TLS certificates if no nickname is given. Once
798 * Tor 0.1.2.x is obsolete, we can remove this. */
799 #define DEFAULT_CLIENT_NICKNAME "client"
801 /** Number of bytes in a SOCKS4 header. */
802 #define SOCKS4_NETWORK_LEN 8
806 * Relay command [1 byte]
807 * Recognized [2 bytes]
808 * Stream ID [2 bytes]
809 * Partial SHA-1 [4 bytes]
811 * Relay payload [498 bytes]
814 /** Number of bytes in a cell, minus cell header. */
815 #define CELL_PAYLOAD_SIZE 509
816 /** Number of bytes in a cell transmitted over the network. */
817 #define CELL_NETWORK_SIZE 512
819 /** Length of a header on a variable-length cell. */
820 #define VAR_CELL_HEADER_SIZE 5
822 /** Number of bytes in a relay cell's header (not including general cell
824 #define RELAY_HEADER_SIZE (1+2+2+4+2)
825 /** Largest number of bytes that can fit in a relay cell payload. */
826 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
828 /** Identifies a circuit on an or_connection */
829 typedef uint16_t circid_t
;
830 /** Identifies a stream on a circuit */
831 typedef uint16_t streamid_t
;
833 /** Parsed onion routing cell. All communication between nodes
835 typedef struct cell_t
{
836 circid_t circ_id
; /**< Circuit which received the cell. */
837 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
838 * CELL_DESTROY, etc */
839 uint8_t payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
842 /** Parsed variable-length onion routing cell. */
843 typedef struct var_cell_t
{
846 uint16_t payload_len
;
850 /** A cell as packed for writing to the network. */
851 typedef struct packed_cell_t
{
852 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
853 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
856 /** A queue of cells on a circuit, waiting to be added to the
857 * or_connection_t's outbuf. */
858 typedef struct cell_queue_t
{
859 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
860 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
861 int n
; /**< The number of cells in the queue. */
864 /** Beginning of a RELAY cell payload. */
866 uint8_t command
; /**< The end-to-end relay command. */
867 uint16_t recognized
; /**< Used to tell whether cell is for us. */
868 streamid_t stream_id
; /**< Which stream is this cell associated with? */
869 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
870 uint16_t length
; /**< How long is the payload body? */
873 typedef struct buf_t buf_t
;
874 typedef struct socks_request_t socks_request_t
;
876 /* Values for connection_t.magic: used to make sure that downcasts (casts from
877 * connection_t to foo_connection_t) are safe. */
878 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
879 #define OR_CONNECTION_MAGIC 0x7D31FF03u
880 #define EDGE_CONNECTION_MAGIC 0xF0374013u
881 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
882 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
884 /** Description of a connection to another host or process, and associated
887 * A connection is named based on what it's connected to -- an "OR
888 * connection" has a Tor node on the other end, an "exit
889 * connection" has a website or other server on the other end, and an
890 * "AP connection" has an application proxy (and thus a user) on the
893 * Every connection has a type and a state. Connections never change
894 * their type, but can go through many state changes in their lifetime.
896 * Every connection has two associated input and output buffers.
897 * Listeners don't use them. For non-listener connections, incoming
898 * data is appended to conn->inbuf, and outgoing data is taken from
899 * conn->outbuf. Connections differ primarily in the functions called
900 * to fill and drain these buffers.
902 typedef struct connection_t
{
903 uint32_t magic
; /**< For memory debugging: must equal one of
904 * *_CONNECTION_MAGIC. */
906 uint8_t state
; /**< Current state of this connection. */
907 unsigned int type
:4; /**< What kind of connection is this? */
908 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
910 /* The next fields are all one-bit booleans. Some are only applicable to
911 * connection subtypes, but we hold them here anyway, to save space.
913 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
914 * again once the bandwidth throttler allows it? */
915 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
916 * again once the bandwidth throttler allows
918 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
919 * marked for close, do we flush it
920 * before closing it? */
921 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
923 /** Set to 1 when we're inside connection_flushed_some to keep us from
924 * calling connection_handle_write() recursively. */
925 unsigned int in_flushed_some
:1;
927 /* For linked connections:
929 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
930 /** True iff we'd like to be notified about read events from the
932 unsigned int reading_from_linked_conn
:1;
933 /** True iff we're willing to write to the linked conn. */
934 unsigned int writing_to_linked_conn
:1;
935 /** True iff we're currently able to read on the linked conn, and our
936 * read_event should be made active with libevent. */
937 unsigned int active_on_link
:1;
938 /** True iff we've called connection_close_immediate() on this linked
940 unsigned int linked_conn_is_closed
:1;
942 int s
; /**< Our socket; -1 if this connection is closed, or has no
944 int conn_array_index
; /**< Index into the global connection array. */
945 struct event
*read_event
; /**< Libevent event structure. */
946 struct event
*write_event
; /**< Libevent event structure. */
947 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
948 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
949 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
951 time_t timestamp_lastread
; /**< When was the last time libevent said we could
953 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
955 time_t timestamp_created
; /**< When was this connection_t created? */
957 /* XXXX_IP6 make this IPv6-capable */
958 int socket_family
; /**< Address family of this connection's socket. Usually
959 * AF_INET, but it can also be AF_UNIX, or in the future
961 tor_addr_t addr
; /**< IP of the other side of the connection; used to
962 * identify routers, along with port. */
963 uint16_t port
; /**< If non-zero, port on the other end
964 * of the connection. */
965 uint16_t marked_for_close
; /**< Should we close this conn on the next
966 * iteration of the main loop? (If true, holds
967 * the line number where this connection was
969 const char *marked_for_close_file
; /**< For debugging: in which file were
970 * we marked for close? */
971 char *address
; /**< FQDN (or IP) of the guy on the other end.
972 * strdup into this, because free_connection() frees it. */
973 /** Another connection that's connected to this one in lieu of a socket. */
974 struct connection_t
*linked_conn
;
976 /** Unique identifier for this connection on this Tor instance. */
977 uint64_t global_identifier
;
979 /* XXXX022 move this field, and all the listener-only fields (just
980 socket_family, I think), into a new listener_connection_t subtype. */
981 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
982 * to the evdns_server_port is uses to listen to and answer connections. */
983 struct evdns_server_port
*dns_server_port
;
987 /** Stores flags and information related to the portion of a v2 Tor OR
988 * connection handshake that happens after the TLS handshake is finished.
990 typedef struct or_handshake_state_t
{
991 /** When was the VERSIONS cell sent on this connection? Used to get
992 * an estimate of the skew in the returning NETINFO reply. */
993 time_t sent_versions_at
;
994 /** True iff we originated this connection */
995 unsigned int started_here
: 1;
996 /** True iff we have received and processed a VERSIONS cell. */
997 unsigned int received_versions
: 1;
998 } or_handshake_state_t
;
1000 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
1001 * cells over TLS. */
1002 typedef struct or_connection_t
{
1005 /** Hash of the public RSA key for the other side's identity key, or zeroes
1006 * if the other side hasn't shown us a valid identity key. */
1007 char identity_digest
[DIGEST_LEN
];
1008 char *nickname
; /**< Nickname of OR on other side (if any). */
1010 tor_tls_t
*tls
; /**< TLS connection state. */
1011 int tls_error
; /**< Last tor_tls error code. */
1012 /** When we last used this conn for any client traffic. If not
1013 * recent, we can rate limit it further. */
1016 tor_addr_t real_addr
; /**< The actual address that this connection came from
1017 * or went to. The <b>addr</b> field is prone to
1018 * getting overridden by the address from the router
1019 * descriptor matching <b>identity_digest</b>. */
1021 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1022 * connection, which half of the space should
1024 /** Should this connection be used for extending circuits to the server
1025 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1026 * sure we aren't getting MITMed, either because we're connected to an
1027 * address listed in a server descriptor, or because an authenticated
1028 * NETINFO cell listed the address we're connected to as recognized. */
1029 unsigned int is_canonical
:1;
1030 /** True iff this connection shouldn't get any new circs attached to it,
1031 * because the connection is too old, or because there's a better one, etc.
1033 unsigned int is_bad_for_new_circs
:1;
1034 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1035 * "none negotiated yet." */
1036 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1037 * this connection? This is always in the
1038 * range 0..1<<15-1. */
1040 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1041 * up, state information to do so. */
1042 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1043 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1044 * non-padding cell to the outbuf? */
1046 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
1047 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1048 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1049 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1050 * add 'bandwidthrate' to this, capping it at
1051 * bandwidthburst. (OPEN ORs only) */
1052 int n_circuits
; /**< How many circuits use this connection as p_conn or
1055 /** Double-linked ring of circuits with queued cells waiting for room to
1056 * free up on this connection's outbuf. Every time we pull cells from a
1057 * circuit, we advance this pointer to the next circuit in the ring. */
1058 struct circuit_t
*active_circuits
;
1059 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1060 * identity digest as this one. */
1063 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1064 * connection, or an exit. */
1065 typedef struct edge_connection_t
{
1068 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1070 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1071 * this conn exits at. */
1072 int package_window
; /**< How many more relay cells can I send into the
1074 int deliver_window
; /**< How many more relay cells can end at me? */
1076 /** Nickname of planned exit node -- used with .exit support. */
1077 char *chosen_exit_name
;
1079 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1081 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1082 * connection is using. */
1084 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1085 * connection. Exit connections only. */
1087 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1090 /** The reason why this connection is closing; passed to the controller. */
1091 uint16_t end_reason
;
1093 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1096 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1099 /** What rendezvous service are we querying for? (AP only) */
1100 rend_data_t
*rend_data
;
1102 /** Number of times we've reassigned this application connection to
1103 * a new circuit. We keep track because the timeout is longer if we've
1104 * already retried several times. */
1105 uint8_t num_socks_retries
;
1107 /** True iff this connection is for a DNS request only. */
1108 unsigned int is_dns_request
:1;
1110 /** True iff this stream must attach to a one-hop circuit (e.g. for
1112 unsigned int want_onehop
:1;
1113 /** True iff this stream should use a BEGIN_DIR relay command to establish
1114 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1115 unsigned int use_begindir
:1;
1117 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1118 * connections. Set once we've set the stream end,
1119 * and check in connection_about_to_close_connection().
1121 /** True iff we've blocked reading until the circuit has fewer queued
1123 unsigned int edge_blocked_on_circ
:1;
1124 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1125 * stop requiring it. */
1126 unsigned int chosen_exit_optional
:1;
1127 /** For AP connections only. If non-zero, this exit node was picked as
1128 * a result of the TrackHostExit, and the value decrements every time
1129 * we fail to complete a circuit to our chosen exit -- if it reaches
1130 * zero, abandon the associated mapaddress. */
1131 unsigned int chosen_exit_retries
:3;
1133 /** If this is a DNSPort connection, this field holds the pending DNS
1134 * request that we're going to try to answer. */
1135 struct evdns_server_request
*dns_server_request
;
1137 } edge_connection_t
;
1139 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1140 * connection to retrieve or serve directory material. */
1141 typedef struct dir_connection_t
{
1144 char *requested_resource
; /**< Which 'resource' did we ask the directory
1146 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1148 /* Used only for server sides of some dir connections, to implement
1149 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1150 * to append everything to the outbuf in one enormous chunk. */
1151 /** What exactly are we spooling right now? */
1153 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1154 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1155 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
1156 } dir_spool_src
: 3;
1157 /** If we're fetching descriptors, what router purpose shall we assign
1159 uint8_t router_purpose
;
1160 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1161 smartlist_t
*fingerprint_stack
;
1162 /** A cached_dir_t object that we're currently spooling out */
1163 struct cached_dir_t
*cached_dir
;
1164 /** The current offset into cached_dir. */
1165 off_t cached_dir_offset
;
1166 /** The zlib object doing on-the-fly compression for spooled data. */
1167 tor_zlib_state_t
*zlib_state
;
1169 /** What rendezvous service are we querying for? */
1170 rend_data_t
*rend_data
;
1172 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1173 * the directory server's signing key. */
1177 /** Subtype of connection_t for an connection to a controller. */
1178 typedef struct control_connection_t
{
1181 uint32_t event_mask
; /**< Bitfield: which events does this controller
1183 unsigned int use_long_names
:1; /**< True if we should use long nicknames
1184 * on this (v1) connection. Only settable
1185 * via v1 controllers. */
1186 /** For control connections only. If set, we send extended info with control
1187 * events as appropriate. */
1188 unsigned int use_extended_events
:1;
1190 /** True if we have sent a protocolinfo reply on this connection. */
1191 unsigned int have_sent_protocolinfo
:1;
1193 /** Amount of space allocated in incoming_cmd. */
1194 uint32_t incoming_cmd_len
;
1195 /** Number of bytes currently stored in incoming_cmd. */
1196 uint32_t incoming_cmd_cur_len
;
1197 /** A control command that we're reading from the inbuf, but which has not
1198 * yet arrived completely. */
1200 } control_connection_t
;
1202 /** Cast a connection_t subtype pointer to a connection_t **/
1203 #define TO_CONN(c) (&(((c)->_base)))
1204 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1205 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1207 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1209 static or_connection_t
*TO_OR_CONN(connection_t
*);
1210 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1212 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1213 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1215 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1216 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1218 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1220 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1222 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1223 return DOWNCAST(or_connection_t
, c
);
1225 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1227 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1228 return DOWNCAST(dir_connection_t
, c
);
1230 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1232 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1233 return DOWNCAST(edge_connection_t
, c
);
1235 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1237 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1238 return DOWNCAST(control_connection_t
, c
);
1241 /** What action type does an address policy indicate: accept or reject? */
1243 ADDR_POLICY_ACCEPT
=1,
1244 ADDR_POLICY_REJECT
=2,
1245 } addr_policy_action_t
;
1247 /** A reference-counted address policy rule. */
1248 typedef struct addr_policy_t
{
1249 int refcnt
; /**< Reference count */
1250 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1251 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1253 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1254 * copy (stored in a hash table to avoid
1255 * duplication of common policies) */
1256 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1257 * first <b>maskbits</b> bits of <b>a</b> match
1259 tor_addr_t addr
; /**< Base address to accept or reject. */
1260 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1261 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1264 /** A cached_dir_t represents a cacheable directory object, along with its
1265 * compressed form. */
1266 typedef struct cached_dir_t
{
1267 char *dir
; /**< Contents of this object, NUL-terminated. */
1268 char *dir_z
; /**< Compressed contents of this object. */
1269 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1270 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1271 time_t published
; /**< When was this object published. */
1272 int refcnt
; /**< Reference count for this cached_dir_t. */
1275 /** Enum used to remember where a signed_descriptor_t is stored and how to
1276 * manage the memory for signed_descriptor_body. */
1278 /** The descriptor isn't stored on disk at all: the copy in memory is
1279 * canonical; the saved_offset field is meaningless. */
1281 /** The descriptor is stored in the cached_routers file: the
1282 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1283 * saved_offset are used to index into the mmaped cache file. */
1285 /** The descriptor is stored in the cached_routers.new file: the
1286 * signed_descriptor_body and saved_offset fields are both set. */
1287 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1288 * lazy-load the descriptor text by using seek and read. We don't, for
1294 /** Enumeration: what kind of download schedule are we using for a given
1297 DL_SCHED_GENERIC
= 0,
1298 DL_SCHED_CONSENSUS
= 1,
1299 DL_SCHED_BRIDGE
= 2,
1300 } download_schedule_t
;
1302 /** Information about our plans for retrying downloads for a downloadable
1304 typedef struct download_status_t
{
1305 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1307 uint8_t n_download_failures
; /**< Number of failures trying to download the
1308 * most recent descriptor. */
1309 download_schedule_t schedule
: 8;
1310 } download_status_t
;
1312 /** If n_download_failures is this high, the download can never happen. */
1313 #define IMPOSSIBLE_TO_DOWNLOAD 255
1315 /** The max size we expect router descriptor annotations we create to
1316 * be. We'll accept larger ones if we see them on disk, but we won't
1317 * create any that are larger than this. */
1318 #define ROUTER_ANNOTATION_BUF_LEN 256
1320 /** Information need to cache an onion router's descriptor. */
1321 typedef struct signed_descriptor_t
{
1322 /** Pointer to the raw server descriptor, preceded by annotations. Not
1323 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1324 * pointer is null. */
1325 char *signed_descriptor_body
;
1326 /** Length of the annotations preceding the server descriptor. */
1327 size_t annotations_len
;
1328 /** Length of the server descriptor. */
1329 size_t signed_descriptor_len
;
1330 /** Digest of the server descriptor, computed as specified in
1332 char signed_descriptor_digest
[DIGEST_LEN
];
1333 /** Identity digest of the router. */
1334 char identity_digest
[DIGEST_LEN
];
1335 /** Declared publication time of the descriptor. */
1336 time_t published_on
;
1337 /** For routerdescs only: digest of the corresponding extrainfo. */
1338 char extra_info_digest
[DIGEST_LEN
];
1339 /** For routerdescs only: Status of downloading the corresponding
1341 download_status_t ei_dl_status
;
1342 /** Where is the descriptor saved? */
1343 saved_location_t saved_location
;
1344 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1345 * this descriptor in the corresponding file. */
1347 /** What position is this descriptor within routerlist->routers or
1348 * routerlist->old_routers? -1 for none. */
1349 int routerlist_index
;
1350 /** The valid-until time of the most recent consensus that listed this
1351 * descriptor, or a bit after the publication time of the most recent v2
1352 * networkstatus that listed it. 0 for "never listed in a consensus or
1353 * status, so far as we know." */
1354 time_t last_listed_as_valid_until
;
1355 #ifdef TRACK_SERVED_TIME
1356 /** The last time we served anybody this descriptor. Used for internal
1357 * testing to see whether we're holding on to descriptors too long. */
1358 time_t last_served_at
; /*XXXX remove if not useful. */
1360 /* If true, we do not ever try to save this object in the cache. */
1361 unsigned int do_not_cache
: 1;
1362 /* If true, this item is meant to represent an extrainfo. */
1363 unsigned int is_extrainfo
: 1;
1364 /* If true, we got an extrainfo for this item, and the digest was right,
1365 * but it was incompatible. */
1366 unsigned int extrainfo_is_bogus
: 1;
1367 /* If true, we are willing to transmit this item unencrypted. */
1368 unsigned int send_unencrypted
: 1;
1369 } signed_descriptor_t
;
1371 /** A signed integer representing a country code. */
1372 typedef int16_t country_t
;
1374 /** Information about another onion router in the network. */
1376 signed_descriptor_t cache_info
;
1377 char *address
; /**< Location of OR: either a hostname or an IP address. */
1378 char *nickname
; /**< Human-readable OR name. */
1380 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1381 uint16_t or_port
; /**< Port for TLS connections. */
1382 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1384 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1385 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1387 char *platform
; /**< What software/operating system is this OR using? */
1390 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1391 * bucket per second? */
1392 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1393 /** How many bytes/s is this router known to handle? */
1394 uint32_t bandwidthcapacity
;
1395 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1396 * to exit? NULL for 'reject *:*'. */
1397 long uptime
; /**< How many seconds the router claims to have been up */
1398 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1399 * claims are its family. */
1400 char *contact_info
; /**< Declared contact info for this router. */
1401 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1403 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1404 * dnsworker code. */
1405 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1406 * extrainfo documents. */
1407 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1408 * single hop exits. */
1411 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1413 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1414 * (For Authdir: Have we validated this OR?)
1416 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1418 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1419 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1420 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1421 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1422 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1423 * or otherwise nasty? */
1424 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1425 * underpowered, or otherwise useless? */
1426 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1427 * a hidden service directory. */
1428 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1429 * directory according to the authorities. */
1430 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1431 * router rejects everything. */
1433 /** Tor can use this router for general positions in circuits. */
1434 #define ROUTER_PURPOSE_GENERAL 0
1435 /** Tor should avoid using this router for circuit-building. */
1436 #define ROUTER_PURPOSE_CONTROLLER 1
1437 /** Tor should use this router only for bridge positions in circuits. */
1438 #define ROUTER_PURPOSE_BRIDGE 2
1439 /** Tor should not use this router; it was marked in cached-descriptors with
1440 * a purpose we didn't recognize. */
1441 #define ROUTER_PURPOSE_UNKNOWN 255
1443 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1445 /* The below items are used only by authdirservers for
1446 * reachability testing. */
1447 /** When was the last time we could reach this OR? */
1448 time_t last_reachable
;
1449 /** When did we start testing reachability for this OR? */
1450 time_t testing_since
;
1451 /** According to the geoip db what country is this router in? */
1455 /** Information needed to keep and cache a signed extra-info document. */
1456 typedef struct extrainfo_t
{
1457 signed_descriptor_t cache_info
;
1458 /** The router's nickname. */
1459 char nickname
[MAX_NICKNAME_LEN
+1];
1460 /** True iff we found the right key for this extra-info, verified the
1461 * signature, and found it to be bad. */
1462 unsigned int bad_sig
: 1;
1463 /** If present, we didn't have the right key to verify this extra-info,
1464 * so this is a copy of the signature in the document. */
1466 /** Length of pending_sig. */
1467 size_t pending_sig_len
;
1470 /** Contents of a single router entry in a network status object.
1472 typedef struct routerstatus_t
{
1473 time_t published_on
; /**< When was this router published? */
1474 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1476 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1478 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1480 uint32_t addr
; /**< IPv4 address for this router. */
1481 uint16_t or_port
; /**< OR port for this router. */
1482 uint16_t dir_port
; /**< Directory port for this router. */
1483 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1484 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1485 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1486 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1487 unsigned int is_running
:1; /**< True iff this router is up. */
1488 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1489 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1491 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1492 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1493 * information with v2 of the directory
1494 * protocol. (All directory caches cache v1
1496 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1497 * choice as an entry guard. */
1498 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1500 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1501 * underpowered, or otherwise useless? */
1502 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1503 * service directory. */
1504 /** True iff we know version info for this router. (i.e., a "v" entry was
1505 * included.) We'll replace all these with a big tor_version_t or a char[]
1506 * if the number of traits we care about ever becomes incredibly big. */
1507 unsigned int version_known
:1;
1508 /** True iff this router is a version that supports BEGIN_DIR cells. */
1509 unsigned int version_supports_begindir
:1;
1510 /** True iff this router is a version that supports conditional consensus
1511 * downloads (signed by list of authorities). */
1512 unsigned int version_supports_conditional_consensus
:1;
1513 /** True iff this router is a version that we can post extrainfo docs to. */
1514 unsigned int version_supports_extrainfo_upload
:1;
1515 /** True iff this router is a version that, if it caches directory info,
1516 * we can get v3 downloads from. */
1517 unsigned int version_supports_v3_dir
:1;
1519 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1520 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1522 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1523 * the vote/consensus, in kilobytes/sec. */
1524 char *exitsummary
; /**< exit policy summary -
1525 * XXX weasel: this probably should not stay a string. */
1527 /* ---- The fields below aren't derived from the networkstatus; they
1528 * hold local information only. */
1530 /** True if we, as a directory mirror, want to download the corresponding
1531 * routerinfo from the authority who gave us this routerstatus. (That is,
1532 * if we don't have the routerinfo, and if we haven't already tried to get it
1533 * from this authority.) Applies in v2 networkstatus document only.
1535 unsigned int need_to_mirror
:1;
1536 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1537 * to this (unnamed) router by nickname?
1539 time_t last_dir_503_at
; /**< When did this router last tell us that it
1540 * was too busy to serve directory info? */
1541 download_status_t dl_status
;
1545 /** How many times will we try to download a router's descriptor before giving
1547 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1549 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1550 typedef struct networkstatus_v2_t
{
1551 /** When did we receive the network-status document? */
1554 /** What was the digest of the document? */
1555 char networkstatus_digest
[DIGEST_LEN
];
1557 /* These fields come from the actual network-status document.*/
1558 time_t published_on
; /**< Declared publication date. */
1560 char *source_address
; /**< Canonical directory server hostname. */
1561 uint32_t source_addr
; /**< Canonical directory server IP. */
1562 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1564 unsigned int binds_names
:1; /**< True iff this directory server binds
1566 unsigned int recommends_versions
:1; /**< True iff this directory server
1567 * recommends client and server software
1569 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1570 * malfunctioning exits as bad. */
1571 /** True iff this directory server marks malfunctioning directories as
1573 unsigned int lists_bad_directories
:1;
1575 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1576 char *contact
; /**< How to contact directory admin? (may be NULL). */
1577 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1578 char *client_versions
; /**< comma-separated list of recommended client
1580 char *server_versions
; /**< comma-separated list of recommended server
1583 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1584 * sorted by identity_digest. */
1585 } networkstatus_v2_t
;
1587 /** The claim about a single router, made in a vote. */
1588 typedef struct vote_routerstatus_t
{
1589 routerstatus_t status
; /**< Underlying 'status' object for this router.
1590 * Flags are redundant. */
1591 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1592 * networkstatus_t.known_flags. */
1593 char *version
; /**< The version that the authority says this router is
1595 } vote_routerstatus_t
;
1597 /** Information about a single voter in a vote or a consensus. */
1598 typedef struct networkstatus_voter_info_t
{
1599 char *nickname
; /**< Nickname of this voter */
1600 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1601 char *address
; /**< Address of this voter, in string format. */
1602 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1603 uint16_t dir_port
; /**< Directory port of this voter */
1604 uint16_t or_port
; /**< OR port of this voter */
1605 char *contact
; /**< Contact information for this voter. */
1606 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1607 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
1608 * consensuses, we treat legacy keys as additional signers. */
1609 char legacy_id_digest
[DIGEST_LEN
];
1611 /* Nothing from here on is signed. */
1612 char signing_key_digest
[DIGEST_LEN
]; /**< Declared digest of signing key
1613 * used by this voter. */
1614 char *signature
; /**< Signature from this voter. */
1615 int signature_len
; /**< Length of <b>signature</b> */
1616 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1617 * the sig, and we know it's bad. */
1618 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1620 } networkstatus_voter_info_t
;
1622 /** Enumerates the possible seriousness values of a networkstatus document. */
1627 } networkstatus_type_t
;
1629 /** A common structure to hold a v3 network status vote, or a v3 network
1630 * status consensus. */
1631 typedef struct networkstatus_t
{
1632 networkstatus_type_t type
; /**< Vote, consensus, or opinion? */
1633 time_t published
; /**< Vote only: Time when vote was written. */
1634 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1635 time_t fresh_until
; /**< Time before which this is the most recent vote or
1637 time_t valid_until
; /**< Time after which this vote or consensus should not
1640 /** Consensus only: what method was used to produce this consensus? */
1641 int consensus_method
;
1642 /** Vote only: what methods is this voter willing to use? */
1643 smartlist_t
*supported_methods
;
1645 /** How long does this vote/consensus claim that authorities take to
1646 * distribute their votes to one another? */
1648 /** How long does this vote/consensus claim that authorities take to
1649 * distribute their consensus signatures to one another? */
1652 /** Comma-separated list of recommended client software, or NULL if this
1653 * voter has no opinion. */
1654 char *client_versions
;
1655 char *server_versions
;
1656 /** List of flags that this vote/consensus applies to routers. If a flag is
1657 * not listed here, the voter has no opinion on what its value should be. */
1658 smartlist_t
*known_flags
;
1660 /** List of key=value strings for the parameters in this vote or
1661 * consensus, sorted by key. */
1662 smartlist_t
*net_params
;
1664 /** List of networkstatus_voter_info_t. For a vote, only one element
1665 * is included. For a consensus, one element is included for every voter
1666 * whose vote contributed to the consensus. */
1667 smartlist_t
*voters
;
1669 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1671 /** Digest of this document, as signed. */
1672 char networkstatus_digest
[DIGEST_LEN
];
1674 /** List of router statuses, sorted by identity digest. For a vote,
1675 * the elements are vote_routerstatus_t; for a consensus, the elements
1676 * are routerstatus_t. */
1677 smartlist_t
*routerstatus_list
;
1679 /** If present, a map from descriptor digest to elements of
1680 * routerstatus_list. */
1681 digestmap_t
*desc_digest_map
;
1684 /** A set of signatures for a networkstatus consensus. All fields are as for
1685 * networkstatus_t. */
1686 typedef struct ns_detached_signatures_t
{
1690 char networkstatus_digest
[DIGEST_LEN
];
1691 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1692 } ns_detached_signatures_t
;
1694 /** Allowable types of desc_store_t. */
1695 typedef enum store_type_t
{
1700 /** A 'store' is a set of descriptors saved on disk, with accompanying
1701 * journal, mmaped as needed, rebuilt as needed. */
1702 typedef struct desc_store_t
{
1703 /** Filename (within DataDir) for the store. We append .tmp to this
1704 * filename for a temporary file when rebuilding the store, and .new to this
1705 * filename for the journal. */
1706 const char *fname_base
;
1707 /** Alternative (obsolete) value for fname_base: if the file named by
1708 * fname_base isn't present, we read from here instead, but we never write
1710 const char *fname_alt_base
;
1711 /** Human-readable description of what this store contains. */
1712 const char *description
;
1714 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1716 store_type_t type
; /**< What's stored in this store? */
1718 /** The size of the router log, in bytes. */
1720 /** The size of the router store, in bytes. */
1722 /** Total bytes dropped since last rebuild: this is space currently
1723 * used in the cache and the journal that could be freed by a rebuild. */
1724 size_t bytes_dropped
;
1727 /** Contents of a directory of onion routers. */
1729 /** Map from server identity digest to a member of routers. */
1730 struct digest_ri_map_t
*identity_map
;
1731 /** Map from server descriptor digest to a signed_descriptor_t from
1732 * routers or old_routers. */
1733 struct digest_sd_map_t
*desc_digest_map
;
1734 /** Map from extra-info digest to an extrainfo_t. Only exists for
1735 * routers in routers or old_routers. */
1736 struct digest_ei_map_t
*extra_info_map
;
1737 /** Map from extra-info digests to a signed_descriptor_t for a router
1738 * descriptor having that extra-info digest. Only exists for
1739 * routers in routers or old_routers. */
1740 struct digest_sd_map_t
*desc_by_eid_map
;
1741 /** List of routerinfo_t for all currently live routers we know. */
1742 smartlist_t
*routers
;
1743 /** List of signed_descriptor_t for older router descriptors we're
1745 smartlist_t
*old_routers
;
1746 /** Store holding server descriptors. If present, any router whose
1747 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1748 * starting at cache_info.saved_offset */
1749 desc_store_t desc_store
;
1750 /** Store holding extra-info documents. */
1751 desc_store_t extrainfo_store
;
1754 /** Information on router used when extending a circuit. We don't need a
1755 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1756 * connection, and onion_key to create the onionskin. Note that for onehop
1757 * general-purpose tunnels, the onion_key is NULL. */
1758 typedef struct extend_info_t
{
1759 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1761 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1762 uint16_t port
; /**< OR port. */
1763 tor_addr_t addr
; /**< IP address. */
1764 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1767 /** Certificate for v3 directory protocol: binds long-term authority identity
1768 * keys to medium-term authority signing keys. */
1769 typedef struct authority_cert_t
{
1770 /** Information relating to caching this cert on disk and looking it up. */
1771 signed_descriptor_t cache_info
;
1772 /** This authority's long-term authority identity key. */
1773 crypto_pk_env_t
*identity_key
;
1774 /** This authority's medium-term signing key. */
1775 crypto_pk_env_t
*signing_key
;
1776 /** The digest of <b>signing_key</b> */
1777 char signing_key_digest
[DIGEST_LEN
];
1778 /** The listed expiration time of this certificate. */
1780 /** This authority's IPv4 address, in host order. */
1782 /** This authority's directory port. */
1784 /** True iff this certificate was cross-certified by signing the identity
1785 * key with the signing key. */
1786 uint8_t is_cross_certified
;
1789 /** Bitfield enum type listing types of directory authority/directory
1793 /** Serves/signs v1 directory information: Big lists of routers, and short
1794 * routerstatus documents. */
1795 V1_AUTHORITY
= 1 << 0,
1796 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
1797 V2_AUTHORITY
= 1 << 1,
1798 /** Serves/signs v3 directory information: votes, consensuses, certs */
1799 V3_AUTHORITY
= 1 << 2,
1800 /** Serves hidden service descriptors. */
1801 HIDSERV_AUTHORITY
= 1 << 3,
1802 /** Serves bridge descriptors. */
1803 BRIDGE_AUTHORITY
= 1 << 4,
1804 /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
1805 EXTRAINFO_CACHE
= 1 << 5,
1808 #define CRYPT_PATH_MAGIC 0x70127012u
1810 /** Holds accounting information for a single step in the layered encryption
1811 * performed by a circuit. Used only at the client edge of a circuit. */
1812 typedef struct crypt_path_t
{
1815 /* crypto environments */
1816 /** Encryption key and counter for cells heading towards the OR at this
1818 crypto_cipher_env_t
*f_crypto
;
1819 /** Encryption key and counter for cells heading back from the OR at this
1821 crypto_cipher_env_t
*b_crypto
;
1823 /** Digest state for cells heading towards the OR at this step. */
1824 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1825 /** Digest state for cells heading away from the OR at this step. */
1826 crypto_digest_env_t
*b_digest
;
1828 /** Current state of Diffie-Hellman key negotiation with the OR at this
1830 crypto_dh_env_t
*dh_handshake_state
;
1831 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1832 * step. Used to save CPU when TLS is already providing all the
1833 * authentication, secrecy, and integrity we need, and we're already
1834 * distinguishable from an OR.
1836 uint8_t fast_handshake_state
[DIGEST_LEN
];
1837 /** Negotiated key material shared with the OR at this step. */
1838 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1840 /** Information to extend to the OR at this step. */
1841 extend_info_t
*extend_info
;
1843 /** Is the circuit built to this step? Must be one of:
1844 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1845 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1846 * and not received an EXTENDED/CREATED)
1847 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1849 #define CPATH_STATE_CLOSED 0
1850 #define CPATH_STATE_AWAITING_KEYS 1
1851 #define CPATH_STATE_OPEN 2
1852 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1853 * (The list is circular, so the last node
1854 * links to the first.) */
1855 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1858 int package_window
; /**< How many cells are we allowed to originate ending
1860 int deliver_window
; /**< How many cells are we willing to deliver originating
1864 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1866 #define DH_KEY_LEN DH_BYTES
1867 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1870 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1872 /** Information used to build a circuit. */
1874 /** Intended length of the final circuit. */
1875 int desired_path_len
;
1876 /** How to extend to the planned exit node. */
1877 extend_info_t
*chosen_exit
;
1878 /** Whether every node in the circ must have adequate uptime. */
1880 /** Whether every node in the circ must have adequate capacity. */
1882 /** Whether the last hop was picked with exiting in mind. */
1884 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1885 * These are for encrypted connections that exit to this router, not
1886 * for arbitrary exits from the circuit. */
1888 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1889 crypt_path_t
*pending_final_cpath
;
1890 /** How many times has building a circuit for this task failed? */
1892 /** At what time should we give up on this task? */
1894 } cpath_build_state_t
;
1896 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1897 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1900 * A circuit is a path over the onion routing
1901 * network. Applications can connect to one end of the circuit, and can
1902 * create exit connections at the other end of the circuit. AP and exit
1903 * connections have only one circuit associated with them (and thus these
1904 * connection types are closed when the circuit is closed), whereas
1905 * OR connections multiplex many circuits at once, and stay standing even
1906 * when there are no circuits running over them.
1908 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1909 * links two connections together: either an edge connection and an OR
1910 * connection, or two OR connections. (When joined to an OR connection, a
1911 * circuit_t affects only cells sent to a particular circID on that
1912 * connection. When joined to an edge connection, a circuit_t affects all
1915 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1916 * along a given circuit. At the OP, it has a sequence of ciphers, each
1917 * of which is shared with a single OR along the circuit. Separate
1918 * ciphers are used for data going "forward" (away from the OP) and
1919 * "backward" (towards the OP). At the OR, a circuit has only two stream
1920 * ciphers: one for data going forward, and one for data going backward.
1922 typedef struct circuit_t
{
1923 uint32_t magic
; /**< For memory and type debugging: must equal
1924 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1926 /** Queue of cells waiting to be transmitted on n_conn. */
1927 cell_queue_t n_conn_cells
;
1928 /** The OR connection that is next in this circuit. */
1929 or_connection_t
*n_conn
;
1930 /** The circuit_id used in the next (forward) hop of this circuit. */
1933 /** The hop to which we want to extend this circuit. Should be NULL if
1934 * the circuit has attached to a connection. */
1935 extend_info_t
*n_hop
;
1937 /** True iff we are waiting for n_conn_cells to become less full before
1938 * allowing p_streams to add any more cells. (Origin circuit only.) */
1939 unsigned int streams_blocked_on_n_conn
: 1;
1940 /** True iff we are waiting for p_conn_cells to become less full before
1941 * allowing n_streams to add any more cells. (OR circuit only.) */
1942 unsigned int streams_blocked_on_p_conn
: 1;
1944 uint8_t state
; /**< Current status of this circuit. */
1945 uint8_t purpose
; /**< Why are we creating this circuit? */
1947 /** How many relay data cells can we package (read from edge streams)
1948 * on this circuit before we receive a circuit-level sendme cell asking
1951 /** How many relay data cells will we deliver (write to edge streams)
1952 * on this circuit? When deliver_window gets low, we send some
1953 * circuit-level sendme cells to indicate that we're willing to accept
1957 /** For storage while n_conn is pending
1958 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1959 * length ONIONSKIN_CHALLENGE_LEN. */
1960 char *n_conn_onionskin
;
1962 time_t timestamp_created
; /**< When was this circuit created? */
1963 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1964 * circuit is clean. */
1966 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1967 * the main loop? (If true, holds the line number
1968 * where this circuit was marked.) */
1969 const char *marked_for_close_file
; /**< For debugging: in which file was this
1970 * circuit marked for close? */
1972 /** Next circuit in the doubly-linked ring of circuits waiting to add
1973 * cells to n_conn. NULL if we have no cells pending, or if we're not
1974 * linked to an OR connection. */
1975 struct circuit_t
*next_active_on_n_conn
;
1976 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1977 * cells to n_conn. NULL if we have no cells pending, or if we're not
1978 * linked to an OR connection. */
1979 struct circuit_t
*prev_active_on_n_conn
;
1980 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1983 /** Largest number of relay_early cells that we can send on a given
1985 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
1987 /** An origin_circuit_t holds data necessary to build and use a circuit.
1989 typedef struct origin_circuit_t
{
1992 /** Linked list of AP streams (or EXIT streams if hidden service)
1993 * associated with this circuit. */
1994 edge_connection_t
*p_streams
;
1995 /** Build state for this circuit. It includes the intended path
1996 * length, the chosen exit router, rendezvous information, etc.
1998 cpath_build_state_t
*build_state
;
1999 /** The doubly-linked list of crypt_path_t entries, one per hop,
2000 * for this circuit. This includes ciphers for each hop,
2001 * integrity-checking digests for each hop, and package/delivery
2002 * windows for each hop.
2004 crypt_path_t
*cpath
;
2006 /** Holds all rendezvous data on either client or service side. */
2007 rend_data_t
*rend_data
;
2009 /** How many more relay_early cells can we send on this circuit, according
2010 * to the specification? */
2011 unsigned int remaining_relay_early_cells
: 4;
2013 /** What commands were sent over this circuit that decremented the
2014 * RELAY_EARLY counter? This is for debugging task 878. */
2015 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
2017 /** How many RELAY_EARLY cells have been sent over this circuit? This is
2018 * for debugging task 878, too. */
2019 int relay_early_cells_sent
;
2021 /** The next stream_id that will be tried when we're attempting to
2022 * construct a new AP stream originating at this circuit. */
2023 streamid_t next_stream_id
;
2025 /* The intro key replaces the hidden service's public key if purpose is
2026 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2027 * descriptor is used. */
2028 crypto_pk_env_t
*intro_key
;
2030 /** Quasi-global identifier for this circuit; used for control.c */
2031 /* XXXX NM This can get re-used after 2**32 circuits. */
2032 uint32_t global_identifier
;
2036 /** An or_circuit_t holds information needed to implement a circuit at an
2038 typedef struct or_circuit_t
{
2041 /** Next circuit in the doubly-linked ring of circuits waiting to add
2042 * cells to p_conn. NULL if we have no cells pending, or if we're not
2043 * linked to an OR connection. */
2044 struct circuit_t
*next_active_on_p_conn
;
2045 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2046 * cells to p_conn. NULL if we have no cells pending, or if we're not
2047 * linked to an OR connection. */
2048 struct circuit_t
*prev_active_on_p_conn
;
2050 /** The circuit_id used in the previous (backward) hop of this circuit. */
2052 /** Queue of cells waiting to be transmitted on p_conn. */
2053 cell_queue_t p_conn_cells
;
2054 /** The OR connection that is previous in this circuit. */
2055 or_connection_t
*p_conn
;
2056 /** Linked list of Exit streams associated with this circuit. */
2057 edge_connection_t
*n_streams
;
2058 /** Linked list of Exit streams associated with this circuit that are
2059 * still being resolved. */
2060 edge_connection_t
*resolving_streams
;
2061 /** The cipher used by intermediate hops for cells heading toward the
2063 crypto_cipher_env_t
*p_crypto
;
2064 /** The cipher used by intermediate hops for cells heading away from
2066 crypto_cipher_env_t
*n_crypto
;
2068 /** The integrity-checking digest used by intermediate hops, for
2069 * cells packaged here and heading towards the OP.
2071 crypto_digest_env_t
*p_digest
;
2072 /** The integrity-checking digest used by intermediate hops, for
2073 * cells packaged at the OP and arriving here.
2075 crypto_digest_env_t
*n_digest
;
2077 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2078 * is not marked for close. */
2079 struct or_circuit_t
*rend_splice
;
2081 #if REND_COOKIE_LEN >= DIGEST_LEN
2082 #define REND_TOKEN_LEN REND_COOKIE_LEN
2084 #define REND_TOKEN_LEN DIGEST_LEN
2087 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2088 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2090 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2092 char rend_token
[REND_TOKEN_LEN
];
2094 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2095 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2097 /** How many more relay_early cells can we send on this circuit, according
2098 * to the specification? */
2099 unsigned int remaining_relay_early_cells
: 4;
2101 /** True iff this circuit was made with a CREATE_FAST cell. */
2102 unsigned int is_first_hop
: 1;
2105 /** Convert a circuit subtype to a circuit_t.*/
2106 #define TO_CIRCUIT(x) (&((x)->_base))
2108 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2109 * if the cast is impossible. */
2110 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2111 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2112 * Asserts if the cast is impossible. */
2113 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2115 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2117 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2118 return DOWNCAST(or_circuit_t
, x
);
2120 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2122 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2123 return DOWNCAST(origin_circuit_t
, x
);
2126 /** Bitfield type: things that we're willing to use invalid routers for. */
2127 typedef enum invalid_router_usage_t
{
2128 ALLOW_INVALID_ENTRY
=1,
2129 ALLOW_INVALID_EXIT
=2,
2130 ALLOW_INVALID_MIDDLE
=4,
2131 ALLOW_INVALID_RENDEZVOUS
=8,
2132 ALLOW_INVALID_INTRODUCTION
=16,
2133 } invalid_router_usage_t
;
2135 /* limits for TCP send and recv buffer size used for constrained sockets */
2136 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2137 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2139 /** A linked list of lines in a config file. */
2140 typedef struct config_line_t
{
2143 struct config_line_t
*next
;
2146 typedef struct routerset_t routerset_t
;
2148 /** Configuration options for a Tor process. */
2152 /** What should the tor process actually do? */
2154 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2155 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2157 const char *command_arg
; /**< Argument for command-line option. */
2159 config_line_t
*Logs
; /**< New-style list of configuration lines
2162 char *DebugLogFile
; /**< Where to send verbose log messages. */
2163 char *DataDirectory
; /**< OR only: where to store long-term data. */
2164 char *Nickname
; /**< OR only: nickname of this onion router. */
2165 char *Address
; /**< OR only: configured address for this onion router. */
2166 char *PidFile
; /**< Where to store PID of Tor process. */
2168 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2169 * country codes and IP address patterns of ORs to
2170 * consider as exits. */
2171 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2172 * country codes and IP address patterns of ORs to
2173 * consider as entry points. */
2174 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2175 * stop building circuits? */
2176 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2177 * stop building circuits? */
2178 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2179 * country codes and IP address patterns of ORs
2180 * not to use in circuits. */
2181 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2182 * country codes and IP address patterns of
2183 * ORs not to consider as exits. */
2185 /** Union of ExcludeNodes and ExcludeExitNodes */
2186 struct routerset_t
*_ExcludeExitNodesUnion
;
2188 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2189 smartlist_t
*AllowInvalidNodes
;
2190 /** Bitmask; derived from AllowInvalidNodes. */
2191 invalid_router_usage_t _AllowInvalid
;
2192 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2193 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2194 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2195 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2196 /** Addresses to bind for listening for SOCKS connections. */
2197 config_line_t
*SocksListenAddress
;
2198 /** Addresses to bind for listening for transparent pf/netfilter
2200 config_line_t
*TransListenAddress
;
2201 /** Addresses to bind for listening for transparent natd connections */
2202 config_line_t
*NatdListenAddress
;
2203 /** Addresses to bind for listening for SOCKS connections. */
2204 config_line_t
*DNSListenAddress
;
2205 /** Addresses to bind for listening for OR connections. */
2206 config_line_t
*ORListenAddress
;
2207 /** Addresses to bind for listening for directory connections. */
2208 config_line_t
*DirListenAddress
;
2209 /** Addresses to bind for listening for control connections. */
2210 config_line_t
*ControlListenAddress
;
2211 /** Local address to bind outbound sockets */
2212 char *OutboundBindAddress
;
2213 /** Directory server only: which versions of
2214 * Tor should we tell users to run? */
2215 config_line_t
*RecommendedVersions
;
2216 config_line_t
*RecommendedClientVersions
;
2217 config_line_t
*RecommendedServerVersions
;
2218 /** Whether dirservers refuse router descriptors with private IPs. */
2219 int DirAllowPrivateAddresses
;
2220 char *User
; /**< Name of user to run Tor as. */
2221 char *Group
; /**< Name of group to run Tor as. */
2222 int ORPort
; /**< Port to listen on for OR connections. */
2223 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2224 /** Port to listen on for transparent pf/netfilter connections. */
2226 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2227 int ControlPort
; /**< Port to listen on for control connections. */
2228 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2229 * for control connections. */
2230 int DirPort
; /**< Port to listen on for directory connections. */
2231 int DNSPort
; /**< Port to listen on for DNS requests. */
2232 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2233 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2234 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2235 * for version 1 directories? */
2236 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2237 * for version 2 directories? */
2238 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2239 * for version 3 directories? */
2240 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2241 * handle hidden service requests? */
2242 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
2243 * directory record statistics? */
2244 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2245 * that's willing to bind names? */
2246 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2247 * directory that's willing to recommend
2249 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2250 * that aggregates bridge descriptors? */
2252 /** If set on a bridge authority, it will answer requests on its dirport
2253 * for bridge statuses -- but only if the requests use this password.
2254 * If set on a bridge user, request bridge statuses, and use this password
2256 char *BridgePassword
;
2258 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2259 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2261 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2262 * this explicit so we can change how we behave in the
2265 /** Boolean: if we know the bridge's digest, should we get new
2266 * descriptors from the bridge authorities or from the bridge itself? */
2267 int UpdateBridgesFromAuthority
;
2269 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2271 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2272 /** Boolean: should we never publish a descriptor? Deprecated. */
2274 /** To what authority types do we publish our descriptor? Choices are
2275 * "v1", "v2", "v3", "bridge", or "". */
2276 smartlist_t
*PublishServerDescriptor
;
2277 /** An authority type, derived from PublishServerDescriptor. */
2278 authority_type_t _PublishServerDescriptor
;
2279 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2280 int PublishHidServDescriptors
;
2281 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2282 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2283 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2285 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2286 * service directories after what time? */
2287 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2288 int AllDirActionsPrivate
; /**< Should every directory action be sent
2289 * through a Tor circuit? */
2291 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2292 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2293 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2294 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2295 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2297 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2298 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2299 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2301 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2302 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2304 /** Application ports that require all nodes in circ to have sufficient
2306 smartlist_t
*LongLivedPorts
;
2307 /** Application ports that are likely to be unencrypted and
2308 * unauthenticated; we reject requests for them to prevent the
2309 * user from screwing up and leaking plaintext secrets to an
2310 * observer somewhere on the Internet. */
2311 smartlist_t
*RejectPlaintextPorts
;
2312 /** Related to RejectPlaintextPorts above, except this config option
2313 * controls whether we warn (in the log and via a controller status
2314 * event) every time a risky connection is attempted. */
2315 smartlist_t
*WarnPlaintextPorts
;
2316 /** Should we try to reuse the same exit node for a given host */
2317 smartlist_t
*TrackHostExits
;
2318 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2320 config_line_t
*AddressMap
; /**< List of address map directives. */
2321 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2322 * hostname ending with one of the suffixes in
2323 * <b>AutomapHostsSuffixes</b>, map it to a
2324 * virtual address. */
2325 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2326 * <b>AutomapHostsOnResolve</b>. */
2327 int RendPostPeriod
; /**< How often do we post each rendezvous service
2328 * descriptor? Remember to publish them independently. */
2329 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2330 * connections alive? */
2331 int SocksTimeout
; /**< How long do we let a socks connection wait
2332 * unattached before we fail it? */
2333 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2334 * at least this many seconds ago. */
2335 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2336 * at least this many seconds ago. */
2337 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2338 * to wait simultaneously before we start dropping
2340 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2342 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2343 this interval ago. */
2344 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2345 * to use in a second? */
2346 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2347 * to use in a second? */
2348 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2349 * tell people we have? */
2350 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2351 * willing to use for all relayed conns? */
2352 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2353 * use in a second for all relayed conns? */
2354 int NumCpus
; /**< How many CPUs should we try to use? */
2355 int RunTesting
; /**< If true, create testing circuits to measure how well the
2356 * other ORs are running. */
2357 config_line_t
*RendConfigLines
; /**< List of configuration lines
2358 * for rendezvous services. */
2359 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2360 * authorizations for hidden services */
2361 char *ContactInfo
; /**< Contact info to be published in the directory. */
2363 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2364 uint32_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2365 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2366 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2368 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2369 uint32_t HttpsProxyAddr
; /**< Parsed IPv4 addr for https proxy, if any. */
2370 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2371 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2373 /** List of configuration lines for replacement directory authorities.
2374 * If you just want to replace one class of authority at a time,
2375 * use the "Alternate*Authority" options below instead. */
2376 config_line_t
*DirServers
;
2378 /** If set, use these main (currently v3) directory authorities and
2379 * not the default ones. */
2380 config_line_t
*AlternateDirAuthority
;
2382 /** If set, use these bridge authorities and not the default one. */
2383 config_line_t
*AlternateBridgeAuthority
;
2385 /** If set, use these HS authorities and not the default ones. */
2386 config_line_t
*AlternateHSAuthority
;
2388 char *MyFamily
; /**< Declared family for this OR. */
2389 config_line_t
*NodeFamilies
; /**< List of config lines for
2391 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2392 * mark as bad dir mirrors. */
2393 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2394 * mark as bad exits. */
2395 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2397 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2398 * never mark as valid. */
2399 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2400 * and vote for all other dir mirrors as good. */
2401 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2402 * and vote for all other exits as good. */
2403 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2404 * aren't named in our fingerprint file? */
2405 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2406 * number of servers per IP address. */
2407 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2408 * number of servers per IP address shared
2409 * with an authority. */
2411 char *AccountingStart
; /**< How long is the accounting interval, and when
2413 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2414 * interval before hibernation? 0 for "never
2417 /** Base64-encoded hash of accepted passwords for the control system. */
2418 config_line_t
*HashedControlPassword
;
2419 /** As HashedControlPassword, but not saved. */
2420 config_line_t
*HashedControlSessionPassword
;
2422 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2423 * the control system? */
2424 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2425 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2426 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2427 * circuits itself (0), or does it expect a controller
2429 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2430 * make circuits in the background (0),
2432 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2433 * long do we wait before exiting? */
2434 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2435 * such as addresses (0), or do we scrub them first (1)? */
2436 int SafeSocks
; /**< Boolean: should we outright refuse application
2437 * connections that use socks4 or socks5-with-local-dns? */
2438 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2439 LOG_WARN : LOG_INFO)
2440 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2441 * protocol, is it a warn or an info in our logs? */
2442 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2443 * log whether it was DNS-leaking or not? */
2444 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2445 * acceleration where available? */
2446 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2447 * of fixed nodes? */
2448 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2449 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2450 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2451 * of our PK time by sending CREATE_FAST cells? */
2452 /** Should we always fetch our dir info on the mirror schedule (which
2453 * means directly from the authorities) no matter our other config? */
2454 int FetchDirInfoEarly
;
2456 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2457 * MAPADDRESS requests. */
2458 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2459 * addresses to be FQDNs, but rather search for them in
2460 * the local domains. */
2461 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2463 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2464 * DNS poisoning attacks. */
2465 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2466 * resolver from the file here rather than from
2467 * /etc/resolv.conf (Unix) or the registry (Windows). */
2468 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2469 disclaimer. This allows a server administrator to show
2470 that they're running Tor and anyone visiting their server
2471 will know this without any specialized knowledge. */
2472 /** Boolean: if set, we start even if our resolv.conf file is missing
2474 int ServerDNSAllowBrokenConfig
;
2476 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2477 * should be resolvable. Used for
2478 * testing our DNS server. */
2479 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2480 * same network zone in the same circuit. */
2481 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2483 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2484 * support BEGIN_DIR, when possible. */
2485 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2486 * with weird characters. */
2487 /** If true, we try resolving hostnames with weird characters. */
2488 int ServerDNSAllowNonRFC953Hostnames
;
2490 /** If true, we try to download extra-info documents (and we serve them,
2491 * if we are a cache). For authorities, this is always true. */
2492 int DownloadExtraInfo
;
2494 /** If true, and we are acting as a relay, allow exit circuits even when
2495 * we are the first hop of a circuit. */
2496 int AllowSingleHopExits
;
2497 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2498 * circuits that we build. */
2499 int ExcludeSingleHopRelays
;
2500 /** If true, and the controller tells us to use a one-hop circuit, and the
2501 * exit allows it, we use it. */
2502 int AllowSingleHopCircuits
;
2504 /** If true, do not believe anybody who tells us that a domain resolves
2505 * to an internal address, or that an internal address has a PTR mapping.
2506 * Helps avoid some cross-site attacks. */
2507 int ClientDNSRejectInternalAddresses
;
2509 /** The length of time that we think a consensus should be fresh. */
2510 int V3AuthVotingInterval
;
2511 /** The length of time we think it will take to distribute votes. */
2512 int V3AuthVoteDelay
;
2513 /** The length of time we think it will take to distribute signatures. */
2514 int V3AuthDistDelay
;
2515 /** The number of intervals we think a consensus should be valid. */
2516 int V3AuthNIntervalsValid
;
2518 /** Should advertise and sign consensuses with a legacy key, for key
2519 * migration purposes? */
2520 int V3AuthUseLegacyKey
;
2522 /** The length of time that we think an initial consensus should be fresh.
2523 * Only altered on testing networks. */
2524 int TestingV3AuthInitialVotingInterval
;
2526 /** The length of time we think it will take to distribute initial votes.
2527 * Only altered on testing networks. */
2528 int TestingV3AuthInitialVoteDelay
;
2530 /** The length of time we think it will take to distribute initial
2531 * signatures. Only altered on testing networks.*/
2532 int TestingV3AuthInitialDistDelay
;
2534 /** If an authority has been around for less than this amount of time, it
2535 * does not believe its reachability information is accurate. Only
2536 * altered on testing networks. */
2537 int TestingAuthDirTimeToLearnReachability
;
2539 /** Clients don't download any descriptor this recent, since it will
2540 * probably not have propagated to enough caches. Only altered on testing
2542 int TestingEstimatedDescriptorPropagationTime
;
2544 /** If true, we take part in a testing network. Change the defaults of a
2545 * couple of other configuration options and allow to change the values
2546 * of certain configuration options. */
2547 int TestingTorNetwork
;
2549 /** File to check for a consensus networkstatus, if we don't have one
2551 char *FallbackNetworkstatusFile
;
2553 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2554 * count of how many client addresses have contacted us so that we can help
2555 * the bridge authority guess which countries have blocked access to us. */
2556 int BridgeRecordUsageByCountry
;
2558 #ifdef ENABLE_GEOIP_STATS
2559 /** If true, and Tor is built with GEOIP_STATS support, and we're a
2560 * directory, record how many directory requests we get from each country. */
2561 int DirRecordUsageByCountry
;
2562 /** Round all GeoIP results to the next multiple of this value, to avoid
2563 * leaking information. */
2564 int DirRecordUsageGranularity
;
2565 /** Time interval: purge geoip stats after this long. */
2566 int DirRecordUsageRetainIPs
;
2567 /** Time interval: Flush geoip data to disk this often. */
2568 int DirRecordUsageSaveInterval
;
2571 /** Optionally, a file with GeoIP data. */
2574 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2575 * to make this false. */
2576 int ReloadTorrcOnSIGHUP
;
2580 /** Persistent state for an onion router, as saved to disk. */
2583 /** The time at which we next plan to write the state to the disk. Equal to
2584 * TIME_MAX if there are no savable changes, 0 if there are changes that
2585 * should be saved right away. */
2588 /** When was the state last written to disk? */
2591 /** Fields for accounting bandwidth use. */
2592 time_t AccountingIntervalStart
;
2593 uint64_t AccountingBytesReadInInterval
;
2594 uint64_t AccountingBytesWrittenInInterval
;
2595 int AccountingSecondsActive
;
2596 uint64_t AccountingExpectedUsage
;
2598 /** A list of Entry Guard-related configuration lines. */
2599 config_line_t
*EntryGuards
;
2601 /** These fields hold information on the history of bandwidth usage for
2602 * servers. The "Ends" fields hold the time when we last updated the
2603 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2604 * of the entries of Values. The "Values" lists hold decimal string
2605 * representations of the number of bytes read or written in each
2607 time_t BWHistoryReadEnds
;
2608 int BWHistoryReadInterval
;
2609 smartlist_t
*BWHistoryReadValues
;
2610 time_t BWHistoryWriteEnds
;
2611 int BWHistoryWriteInterval
;
2612 smartlist_t
*BWHistoryWriteValues
;
2614 /** What version of Tor wrote this state file? */
2617 /** Holds any unrecognized values we found in the state file, in the order
2618 * in which we found them. */
2619 config_line_t
*ExtraLines
;
2621 /** When did we last rotate our onion key? "0" for 'no idea'. */
2622 time_t LastRotatedOnionKey
;
2625 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2626 * state is already scheduled to be written to disk earlier than <b>when</b>.
2628 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2630 if (state
->next_write
> when
)
2631 state
->next_write
= when
;
2634 #define MAX_SOCKS_REPLY_LEN 1024
2635 #define MAX_SOCKS_ADDR_LEN 256
2637 /** Please open a TCP connection to this addr:port. */
2638 #define SOCKS_COMMAND_CONNECT 0x01
2639 /** Please turn this FQDN into an IP address, privately. */
2640 #define SOCKS_COMMAND_RESOLVE 0xF0
2641 /** Please turn this IP address into an FQDN, privately. */
2642 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2644 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2645 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2646 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2648 /** State of a SOCKS request from a user to an OP. Also used to encode other
2649 * information for non-socks user request (such as those on TransPort and
2651 struct socks_request_t
{
2652 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2653 * 0 means that no socks handshake ever took place, and this is just a
2654 * stub connection (e.g. see connection_ap_make_link()). */
2656 int command
; /**< What is this stream's goal? One from the above list. */
2657 size_t replylen
; /**< Length of <b>reply</b>. */
2658 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2659 * we want to specify our own socks reply,
2660 * rather than using the default socks4 or
2661 * socks5 socks reply. We use this for the
2662 * two-stage socks5 handshake.
2664 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2665 connect to/resolve? */
2666 uint16_t port
; /**< What port did the client ask to connect to? */
2667 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2668 * make sure we send back a socks reply for
2669 * every connection. */
2672 /* all the function prototypes go here */
2674 /********************************* buffers.c ***************************/
2676 buf_t
*buf_new(void);
2677 buf_t
*buf_new_with_capacity(size_t size
);
2678 void buf_free(buf_t
*buf
);
2679 void buf_clear(buf_t
*buf
);
2680 void buf_shrink(buf_t
*buf
);
2681 void buf_shrink_freelists(int free_all
);
2682 void buf_dump_freelist_sizes(int severity
);
2684 size_t buf_datalen(const buf_t
*buf
);
2685 size_t buf_allocation(const buf_t
*buf
);
2686 size_t buf_slack(const buf_t
*buf
);
2687 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2689 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2691 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2693 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2694 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2696 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2697 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2698 const char *data
, size_t data_len
, int done
);
2699 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2700 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2701 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2702 int fetch_from_buf_http(buf_t
*buf
,
2703 char **headers_out
, size_t max_headerlen
,
2704 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2705 int force_complete
);
2706 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2707 int log_sockstype
, int safe_socks
);
2708 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2710 int peek_buf_has_control0_command(buf_t
*buf
);
2712 void assert_buf_ok(buf_t
*buf
);
2714 #ifdef BUFFERS_PRIVATE
2715 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2718 /********************************* circuitbuild.c **********************/
2720 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2721 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2722 void circuit_log_path(int severity
, unsigned int domain
,
2723 origin_circuit_t
*circ
);
2724 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2725 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2726 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2727 extend_info_t
*exit
,
2729 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2730 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2731 int inform_testing_reachability(void);
2732 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2733 void circuit_note_clock_jumped(int seconds_elapsed
);
2734 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2735 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2737 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2738 const uint8_t *reply
);
2739 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2740 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2741 const char *payload
, const char *keys
);
2742 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2743 int *need_capacity
);
2745 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2746 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2747 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2748 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2749 crypto_pk_env_t
*onion_key
,
2750 const tor_addr_t
*addr
, uint16_t port
);
2751 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2752 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2753 void extend_info_free(extend_info_t
*info
);
2754 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2755 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2757 void entry_guards_compute_status(void);
2758 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2759 int mark_relay_status
, time_t now
);
2760 void entry_nodes_should_be_added(void);
2761 int entry_list_can_grow(or_options_t
*options
);
2762 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2763 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2764 void entry_guards_update_state(or_state_t
*state
);
2765 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2766 const char *question
, char **answer
);
2768 void clear_bridge_list(void);
2769 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2770 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
2772 void retry_bridge_descriptor_fetch_directly(const char *digest
);
2773 void fetch_bridge_descriptors(time_t now
);
2774 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2775 int any_bridge_descriptors_known(void);
2776 int any_pending_bridge_descriptor_fetches(void);
2777 int bridges_known_but_down(void);
2778 void bridges_retry_all(void);
2780 void entry_guards_free_all(void);
2782 /********************************* circuitlist.c ***********************/
2784 circuit_t
* _circuit_get_global_list(void);
2785 const char *circuit_state_to_string(int state
);
2786 const char *circuit_purpose_to_controller_string(uint8_t purpose
);
2787 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
2788 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
2789 or_connection_t
*conn
);
2790 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
2791 or_connection_t
*conn
);
2792 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
2793 void circuit_close_all_marked(void);
2794 int32_t circuit_initial_package_window(void);
2795 origin_circuit_t
*origin_circuit_new(void);
2796 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
2797 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
2798 or_connection_t
*conn
);
2799 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
2800 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
2801 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
2802 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
2803 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
2805 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
2806 const char *digest
, uint8_t purpose
);
2807 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
2808 or_circuit_t
*circuit_get_intro_point(const char *digest
);
2809 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
2810 extend_info_t
*info
, int flags
);
2811 void circuit_mark_all_unused_circs(void);
2812 void circuit_expire_all_dirty_circs(void);
2813 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
2814 int line
, const char *file
);
2815 int circuit_get_cpath_len(origin_circuit_t
*circ
);
2816 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
2817 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
2818 or_connection_t
*or_conn
);
2819 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
2821 #define circuit_mark_for_close(c, reason) \
2822 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
2824 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
2825 void assert_circuit_ok(const circuit_t
*c
);
2826 void circuit_free_all(void);
2828 /********************************* circuituse.c ************************/
2830 void circuit_expire_building(time_t now
);
2831 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
2832 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
2834 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
2835 const or_options_t
*options
);
2836 void circuit_build_needed_circs(time_t now
);
2837 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
2839 void circuit_expire_old_circuits_serverside(time_t now
);
2841 void reset_bandwidth_test(void);
2842 int circuit_enough_testing_circs(void);
2844 void circuit_has_opened(origin_circuit_t
*circ
);
2845 void circuit_build_failed(origin_circuit_t
*circ
);
2847 /** Flag to set when a circuit should have only a single hop. */
2848 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
2849 /** Flag to set when a circuit needs to be built of high-uptime nodes */
2850 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
2851 /** Flag to set when a circuit needs to be built of high-capacity nodes */
2852 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
2853 /** Flag to set when the last hop of a circuit doesn't need to be an
2855 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
2856 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
2857 extend_info_t
*info
,
2859 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
2860 routerinfo_t
*exit
, int flags
);
2861 void circuit_reset_failure_count(int timeout
);
2862 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
2863 origin_circuit_t
*circ
,
2864 crypt_path_t
*cpath
);
2865 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
2867 /********************************* command.c ***************************/
2869 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
2870 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
2872 extern uint64_t stats_n_padding_cells_processed
;
2873 extern uint64_t stats_n_create_cells_processed
;
2874 extern uint64_t stats_n_created_cells_processed
;
2875 extern uint64_t stats_n_relay_cells_processed
;
2876 extern uint64_t stats_n_destroy_cells_processed
;
2878 /********************************* config.c ***************************/
2880 /** An error from options_trial_assign() or options_init_from_string(). */
2881 typedef enum setopt_err_t
{
2883 SETOPT_ERR_MISC
= -1,
2884 SETOPT_ERR_PARSE
= -2,
2885 SETOPT_ERR_TRANSITION
= -3,
2886 SETOPT_ERR_SETTING
= -4,
2889 const char *get_dirportfrontpage(void);
2890 or_options_t
*get_options(void);
2891 int set_options(or_options_t
*new_val
, char **msg
);
2892 void config_free_all(void);
2893 const char *safe_str(const char *address
);
2894 const char *escaped_safe_str(const char *address
);
2895 const char *get_version(void);
2897 int config_get_lines(const char *string
, config_line_t
**result
);
2898 void config_free_lines(config_line_t
*front
);
2899 setopt_err_t
options_trial_assign(config_line_t
*list
, int use_defaults
,
2900 int clear_first
, char **msg
);
2901 int resolve_my_address(int warn_severity
, or_options_t
*options
,
2902 uint32_t *addr
, char **hostname_out
);
2903 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
2904 void options_init(or_options_t
*options
);
2905 int options_init_from_torrc(int argc
, char **argv
);
2906 setopt_err_t
options_init_from_string(const char *cf
,
2907 int command
, const char *command_arg
, char **msg
);
2908 int option_is_recognized(const char *key
);
2909 const char *option_get_canonical_name(const char *key
);
2910 config_line_t
*option_get_assignment(or_options_t
*options
,
2912 int options_save_current(void);
2913 const char *get_torrc_fname(void);
2914 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
2915 const char *sub1
, const char *sub2
,
2916 const char *suffix
);
2917 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
2918 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
2919 /** Return a newly allocated string containing datadir/sub1. See
2920 * get_datadir_fname2_suffix. */
2921 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
2922 /** Return a newly allocated string containing datadir/sub1/sub2. See
2923 * get_datadir_fname2_suffix. */
2924 #define get_datadir_fname2(sub1,sub2) \
2925 get_datadir_fname2_suffix((sub1), (sub2), NULL)
2926 /** Return a newly allocated string containing datadir/sub1suffix. See
2927 * get_datadir_fname2_suffix. */
2928 #define get_datadir_fname_suffix(sub1, suffix) \
2929 get_datadir_fname2_suffix((sub1), NULL, (suffix))
2931 or_state_t
*get_or_state(void);
2932 int or_state_save(time_t now
);
2934 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
2935 int getinfo_helper_config(control_connection_t
*conn
,
2936 const char *question
, char **answer
);
2938 uint32_t get_effective_bwrate(or_options_t
*options
);
2939 uint32_t get_effective_bwburst(or_options_t
*options
);
2941 #ifdef CONFIG_PRIVATE
2942 /* Used only by config.c and test.c */
2943 or_options_t
*options_new(void);
2946 /********************************* connection.c ***************************/
2948 const char *conn_type_to_string(int type
);
2949 const char *conn_state_to_string(int type
, int state
);
2951 dir_connection_t
*dir_connection_new(int socket_family
);
2952 or_connection_t
*or_connection_new(int socket_family
);
2953 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
2954 control_connection_t
*control_connection_new(int socket_family
);
2955 connection_t
*connection_new(int type
, int socket_family
);
2957 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
2958 void connection_unregister_events(connection_t
*conn
);
2959 void connection_free(connection_t
*conn
);
2960 void connection_free_all(void);
2961 void connection_about_to_close_connection(connection_t
*conn
);
2962 void connection_close_immediate(connection_t
*conn
);
2963 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
2965 #define connection_mark_for_close(c) \
2966 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
2968 void connection_expire_held_open(void);
2970 int connection_connect(connection_t
*conn
, const char *address
,
2971 const tor_addr_t
*addr
,
2972 uint16_t port
, int *socket_error
);
2973 int retry_all_listeners(smartlist_t
*replaced_conns
,
2974 smartlist_t
*new_conns
);
2976 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
2977 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
2978 void connection_bucket_init(void);
2979 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
2981 int connection_handle_read(connection_t
*conn
);
2983 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
2985 int connection_wants_to_flush(connection_t
*conn
);
2986 int connection_outbuf_too_full(connection_t
*conn
);
2987 int connection_handle_write(connection_t
*conn
, int force
);
2988 void _connection_write_to_buf_impl(const char *string
, size_t len
,
2989 connection_t
*conn
, int zlib
);
2990 static void connection_write_to_buf(const char *string
, size_t len
,
2991 connection_t
*conn
);
2992 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
2993 dir_connection_t
*conn
, int done
);
2995 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
2997 _connection_write_to_buf_impl(string
, len
, conn
, 0);
3000 connection_write_to_buf_zlib(const char *string
, size_t len
,
3001 dir_connection_t
*conn
, int done
)
3003 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
3006 connection_t
*connection_get_by_global_id(uint64_t id
);
3008 connection_t
*connection_get_by_type(int type
);
3009 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
3010 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
3011 const tor_addr_t
*addr
,
3012 uint16_t port
, int purpose
);
3013 connection_t
*connection_get_by_type_state(int type
, int state
);
3014 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
3015 const char *rendquery
,
3018 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
3019 int connection_is_listener(connection_t
*conn
);
3020 int connection_state_is_open(connection_t
*conn
);
3021 int connection_state_is_connecting(connection_t
*conn
);
3023 char *alloc_http_authenticator(const char *authenticator
);
3025 void assert_connection_ok(connection_t
*conn
, time_t now
);
3026 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
3027 void connection_dump_buffer_mem_stats(int severity
);
3028 void remove_file_if_very_old(const char *fname
, time_t now
);
3030 /********************************* connection_edge.c *************************/
3032 #define connection_mark_unattached_ap(conn, endreason) \
3033 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
3035 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
3036 int line
, const char *file
);
3037 int connection_edge_reached_eof(edge_connection_t
*conn
);
3038 int connection_edge_process_inbuf(edge_connection_t
*conn
,
3039 int package_partial
);
3040 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
3041 int connection_edge_end(edge_connection_t
*conn
, uint8_t reason
);
3042 int connection_edge_end_errno(edge_connection_t
*conn
);
3043 int connection_edge_finished_flushing(edge_connection_t
*conn
);
3044 int connection_edge_finished_connecting(edge_connection_t
*conn
);
3046 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
3047 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
3049 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
3051 int use_begindir
, int want_onehop
);
3052 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
3055 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
3058 const uint8_t *answer
,
3062 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
3063 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
3064 void connection_exit_connect(edge_connection_t
*conn
);
3065 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
3066 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
3067 void connection_ap_expire_beginning(void);
3068 void connection_ap_attach_pending(void);
3069 void connection_ap_fail_onehop(const char *failed_digest
,
3070 cpath_build_state_t
*build_state
);
3071 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
3072 int connection_ap_detach_retriable(edge_connection_t
*conn
,
3073 origin_circuit_t
*circ
,
3075 int connection_ap_process_transparent(edge_connection_t
*conn
);
3077 int address_is_invalid_destination(const char *address
, int client
);
3079 void addressmap_init(void);
3080 void addressmap_clean(time_t now
);
3081 void addressmap_clear_configured(void);
3082 void addressmap_clear_transient(void);
3083 void addressmap_free_all(void);
3084 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
3085 int addressmap_have_mapping(const char *address
, int update_timeout
);
3086 /** Enumerates possible origins of a client-side address mapping. */
3088 /** We're remapping this address because the controller told us to. */
3089 ADDRMAPSRC_CONTROLLER
,
3090 /** We're remapping this address because our configuration (via torrc, the
3091 * command line, or a SETCONF command) told us to. */
3093 /** We're remapping this address because we have TrackHostExit configured,
3094 * and we want to remember to use the same exit next time. */
3095 ADDRMAPSRC_TRACKEXIT
,
3096 /** We're remapping this address because we got a DNS resolution from a
3097 * Tor server that told us what its value was. */
3099 } addressmap_entry_source_t
;
3100 void addressmap_register(const char *address
, char *new_address
,
3101 time_t expires
, addressmap_entry_source_t source
);
3102 int parse_virtual_addr_network(const char *val
, int validate_only
,
3104 int client_dns_incr_failures(const char *address
);
3105 void client_dns_clear_failures(const char *address
);
3106 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3107 const char *exitname
, int ttl
);
3108 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3109 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3110 time_t max_expires
, int want_expiry
);
3111 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3112 origin_circuit_t
*circ
,
3113 crypt_path_t
*cpath
);
3114 int hostname_is_noconnect_address(const char *address
);
3116 /** Possible return values for parse_extended_hostname. */
3117 typedef enum hostname_type_t
{
3118 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3120 hostname_type_t
parse_extended_hostname(char *address
);
3122 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3123 int get_pf_socket(void);
3126 /********************************* connection_or.c ***************************/
3128 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3129 void connection_or_clear_identity_map(void);
3130 or_connection_t
*connection_or_get_for_extend(const char *digest
,
3131 const tor_addr_t
*target_addr
,
3132 const char **msg_out
,
3134 void connection_or_set_bad_connections(void);
3136 int connection_or_reached_eof(or_connection_t
*conn
);
3137 int connection_or_process_inbuf(or_connection_t
*conn
);
3138 int connection_or_flushed_some(or_connection_t
*conn
);
3139 int connection_or_finished_flushing(or_connection_t
*conn
);
3140 int connection_or_finished_connecting(or_connection_t
*conn
);
3142 void connection_or_connect_failed(or_connection_t
*conn
,
3143 int reason
, const char *msg
);
3144 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3145 const char *id_digest
);
3147 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3148 int connection_tls_continue_handshake(or_connection_t
*conn
);
3150 void or_handshake_state_free(or_handshake_state_t
*state
);
3151 int connection_or_set_state_open(or_connection_t
*conn
);
3152 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3153 or_connection_t
*conn
);
3154 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3155 or_connection_t
*conn
);
3156 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3158 int connection_or_send_netinfo(or_connection_t
*conn
);
3159 int connection_or_send_cert(or_connection_t
*conn
);
3160 int connection_or_send_link_auth(or_connection_t
*conn
);
3161 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3163 int is_or_protocol_version_known(uint16_t version
);
3165 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3166 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3167 var_cell_t
*var_cell_new(uint16_t payload_len
);
3168 void var_cell_free(var_cell_t
*cell
);
3170 /********************************* control.c ***************************/
3172 /** Used to indicate the type of a circuit event passed to the controller.
3173 * The various types are defined in control-spec.txt */
3174 typedef enum circuit_status_event_t
{
3175 CIRC_EVENT_LAUNCHED
= 0,
3176 CIRC_EVENT_BUILT
= 1,
3177 CIRC_EVENT_EXTENDED
= 2,
3178 CIRC_EVENT_FAILED
= 3,
3179 CIRC_EVENT_CLOSED
= 4,
3180 } circuit_status_event_t
;
3182 /** Used to indicate the type of a stream event passed to the controller.
3183 * The various types are defined in control-spec.txt */
3184 typedef enum stream_status_event_t
{
3185 STREAM_EVENT_SENT_CONNECT
= 0,
3186 STREAM_EVENT_SENT_RESOLVE
= 1,
3187 STREAM_EVENT_SUCCEEDED
= 2,
3188 STREAM_EVENT_FAILED
= 3,
3189 STREAM_EVENT_CLOSED
= 4,
3190 STREAM_EVENT_NEW
= 5,
3191 STREAM_EVENT_NEW_RESOLVE
= 6,
3192 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3193 STREAM_EVENT_REMAP
= 8
3194 } stream_status_event_t
;
3196 /** Used to indicate the type of an OR connection event passed to the
3197 * controller. The various types are defined in control-spec.txt */
3198 typedef enum or_conn_status_event_t
{
3199 OR_CONN_EVENT_LAUNCHED
= 0,
3200 OR_CONN_EVENT_CONNECTED
= 1,
3201 OR_CONN_EVENT_FAILED
= 2,
3202 OR_CONN_EVENT_CLOSED
= 3,
3203 OR_CONN_EVENT_NEW
= 4,
3204 } or_conn_status_event_t
;
3206 void control_update_global_event_mask(void);
3207 void control_adjust_event_log_severity(void);
3209 /** Execute the statement <b>stmt</b>, which may log events concerning the
3210 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3211 * being sent to controllers if <b>conn</b> is a control connection.
3213 * Stmt must not contain any return or goto statements.
3215 #define CONN_LOG_PROTECT(conn, stmt) \
3217 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3218 if (_log_conn_is_control) \
3219 disable_control_logging(); \
3220 STMT_BEGIN stmt; STMT_END; \
3221 if (_log_conn_is_control) \
3222 enable_control_logging(); \
3225 /** Log information about the connection <b>conn</b>, protecting it as with
3226 * CONN_LOG_PROTECT. Example:
3228 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3230 #define LOG_FN_CONN(conn, args) \
3231 CONN_LOG_PROTECT(conn, log_fn args)
3233 int connection_control_finished_flushing(control_connection_t
*conn
);
3234 int connection_control_reached_eof(control_connection_t
*conn
);
3235 int connection_control_process_inbuf(control_connection_t
*conn
);
3237 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3238 #define EVENT_NS 0x000F
3239 int control_event_is_interesting(int event
);
3241 int control_event_circuit_status(origin_circuit_t
*circ
,
3242 circuit_status_event_t e
, int reason
);
3243 int control_event_stream_status(edge_connection_t
*conn
,
3244 stream_status_event_t e
,
3246 int control_event_or_conn_status(or_connection_t
*conn
,
3247 or_conn_status_event_t e
, int reason
);
3248 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3249 int control_event_stream_bandwidth(edge_connection_t
*edge_conn
);
3250 int control_event_stream_bandwidth_used(void);
3251 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3252 int control_event_descriptors_changed(smartlist_t
*routers
);
3253 int control_event_address_mapped(const char *from
, const char *to
,
3254 time_t expires
, const char *error
);
3255 int control_event_or_authdir_new_descriptor(const char *action
,
3259 int control_event_my_descriptor_changed(void);
3260 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3261 int control_event_newconsensus(const networkstatus_t
*consensus
);
3262 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3263 int control_event_general_status(int severity
, const char *format
, ...)
3265 int control_event_client_status(int severity
, const char *format
, ...)
3267 int control_event_server_status(int severity
, const char *format
, ...)
3269 int control_event_guard(const char *nickname
, const char *digest
,
3270 const char *status
);
3272 int init_cookie_authentication(int enabled
);
3273 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3274 void disable_control_logging(void);
3275 void enable_control_logging(void);
3277 /** Enum describing various stages of bootstrapping, for use with controller
3278 * bootstrap status events. The values range from 0 to 100. */
3280 BOOTSTRAP_STATUS_UNDEF
=-1,
3281 BOOTSTRAP_STATUS_STARTING
=0,
3282 BOOTSTRAP_STATUS_CONN_DIR
=5,
3283 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3284 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3285 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3286 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3287 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3288 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3289 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3290 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3291 BOOTSTRAP_STATUS_CONN_OR
=80,
3292 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3293 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3294 BOOTSTRAP_STATUS_DONE
=100
3295 } bootstrap_status_t
;
3297 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3298 void control_event_bootstrap_problem(const char *warn
, int reason
);
3300 void control_event_clients_seen(const char *timestarted
,
3301 const char *countries
);
3303 #ifdef CONTROL_PRIVATE
3304 /* Used only by control.c and test.c */
3305 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3306 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3309 /********************************* cpuworker.c *****************************/
3311 void cpu_init(void);
3312 void cpuworkers_rotate(void);
3313 int connection_cpu_finished_flushing(connection_t
*conn
);
3314 int connection_cpu_reached_eof(connection_t
*conn
);
3315 int connection_cpu_process_inbuf(connection_t
*conn
);
3316 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3320 /********************************* directory.c ***************************/
3322 int directories_have_accepted_server_descriptor(void);
3323 char *authority_type_to_string(authority_type_t auth
);
3324 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3325 authority_type_t type
, const char *payload
,
3326 size_t payload_len
, size_t extrainfo_len
);
3327 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3328 const char *resource
,
3330 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3331 uint8_t router_purpose
,
3332 const char *resource
);
3333 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3334 uint8_t dir_purpose
,
3335 uint8_t router_purpose
,
3336 int anonymized_connection
,
3337 const char *resource
,
3338 const char *payload
,
3340 time_t if_modified_since
);
3341 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3342 uint8_t dir_purpose
,
3343 uint8_t router_purpose
,
3344 int anonymized_connection
,
3345 const char *resource
,
3346 const char *payload
,
3348 time_t if_modified_since
,
3349 const rend_data_t
*rend_query
);
3351 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3352 compress_method_t
*compression
, char **response
);
3354 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3355 int connection_dir_reached_eof(dir_connection_t
*conn
);
3356 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3357 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3358 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3359 void connection_dir_request_failed(dir_connection_t
*conn
);
3360 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3361 uint16_t or_port
, uint16_t dir_port
,
3362 int supports_conditional_consensus
,
3363 int supports_begindir
, const char *digest
,
3364 uint8_t dir_purpose
, uint8_t router_purpose
,
3365 int anonymized_connection
,
3366 const char *resource
,
3367 const char *payload
, size_t payload_len
,
3368 time_t if_modified_since
);
3370 int dir_split_resource_into_fingerprints(const char *resource
,
3371 smartlist_t
*fp_out
, int *compresseed_out
,
3372 int decode_hex
, int sort_uniq
);
3373 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
3375 char first
[DIGEST_LEN
];
3376 char second
[DIGEST_LEN
];
3378 int dir_split_resource_into_fingerprint_pairs(const char *res
,
3379 smartlist_t
*pairs_out
);
3380 char *directory_dump_request_log(void);
3381 void note_request(const char *key
, size_t bytes
);
3382 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3384 time_t download_status_increment_failure(download_status_t
*dls
,
3385 int status_code
, const char *item
,
3386 int server
, time_t now
);
3387 /** Increment the failure count of the download_status_t <b>dls</b>, with
3388 * the optional status code <b>sc</b>. */
3389 #define download_status_failed(dls, sc) \
3390 download_status_increment_failure((dls), (sc), NULL, \
3391 get_options()->DirPort, time(NULL))
3393 void download_status_reset(download_status_t
*dls
);
3394 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3396 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3397 * ready to get its download reattempted. */
3399 download_status_is_ready(download_status_t
*dls
, time_t now
,
3402 return (dls
->n_download_failures
<= max_failures
3403 && dls
->next_attempt_at
<= now
);
3406 static void download_status_mark_impossible(download_status_t
*dl
);
3407 /** Mark <b>dl</b> as never downloadable. */
3409 download_status_mark_impossible(download_status_t
*dl
)
3411 dl
->n_download_failures
= IMPOSSIBLE_TO_DOWNLOAD
;
3414 /********************************* dirserv.c ***************************/
3415 /** Maximum length of an exit policy summary. */
3416 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3418 /** Maximum allowable length of a version line in a networkstatus. */
3419 #define MAX_V_LINE_LEN 128
3420 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3421 * Running Stable Unnamed V2Dir Valid\n". */
3422 #define MAX_FLAG_LINE_LEN 96
3423 /** Length of "w" line for weighting. Currently at most
3424 * "w Bandwidth=<uint32t>\n" */
3425 #define MAX_WEIGHT_LINE_LEN (13+10)
3426 /** Maximum length of an exit policy summary line. */
3427 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3428 /** Amount of space to allocate for each entry: r, s, and v lines. */
3429 #define RS_ENTRY_LEN \
3430 ( /* first line */ \
3431 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3432 5*2 /* ports */ + 10 /* punctuation */ + \
3434 MAX_FLAG_LINE_LEN + \
3436 MAX_WEIGHT_LINE_LEN + \
3438 MAX_POLICY_LINE_LEN + \
3442 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3444 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3446 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3447 int dirserv_load_fingerprint_file(void);
3448 void dirserv_free_fingerprint_list(void);
3449 const char *dirserv_get_nickname_by_digest(const char *digest
);
3450 enum was_router_added_t
dirserv_add_multiple_descriptors(
3451 const char *desc
, uint8_t purpose
,
3454 enum was_router_added_t
dirserv_add_descriptor(routerinfo_t
*ri
,
3456 const char *source
);
3457 int getinfo_helper_dirserv_unregistered(control_connection_t
*conn
,
3458 const char *question
, char **answer
);
3459 void dirserv_free_descriptors(void);
3460 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3461 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3462 int for_controller
);
3463 int dirserv_dump_directory_to_string(char **dir_out
,
3464 crypto_pk_env_t
*private_key
);
3466 int directory_fetches_from_authorities(or_options_t
*options
);
3467 int directory_fetches_dir_info_early(or_options_t
*options
);
3468 int directory_fetches_dir_info_later(or_options_t
*options
);
3469 int directory_caches_v2_dir_info(or_options_t
*options
);
3470 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3471 int directory_caches_dir_info(or_options_t
*options
);
3472 int directory_permits_begindir_requests(or_options_t
*options
);
3473 int directory_permits_controller_requests(or_options_t
*options
);
3474 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3476 void directory_set_dirty(void);
3477 cached_dir_t
*dirserv_get_directory(void);
3478 cached_dir_t
*dirserv_get_runningrouters(void);
3479 cached_dir_t
*dirserv_get_consensus(void);
3480 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3481 int is_running_routers
);
3482 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3483 const char *identity
,
3485 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
3487 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3488 void dirserv_clear_old_v1_info(time_t now
);
3489 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3490 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3492 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3494 int for_unencrypted_conn
,
3496 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3498 void dirserv_orconn_tls_done(const char *address
,
3500 const char *digest_rcvd
,
3502 void dirserv_test_reachability(time_t now
, int try_all
);
3503 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3505 int dirserv_would_reject_router(routerstatus_t
*rs
);
3506 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3507 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3508 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3510 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3511 routerstatus_t
*rs
, const char *platform
,
3512 int first_line_only
, int v2_format
);
3513 void dirserv_free_all(void);
3514 void cached_dir_decref(cached_dir_t
*d
);
3515 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3517 /********************************* dirvote.c ************************/
3519 /** Lowest allowable value for VoteSeconds. */
3520 #define MIN_VOTE_SECONDS 20
3521 /** Lowest allowable value for DistSeconds. */
3522 #define MIN_DIST_SECONDS 20
3523 /** Smallest allowable voting interval. */
3524 #define MIN_VOTE_INTERVAL 300
3526 void dirvote_free_all(void);
3528 /* vote manipulation */
3529 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3530 int total_authorities
,
3531 crypto_pk_env_t
*identity_key
,
3532 crypto_pk_env_t
*signing_key
,
3533 const char *legacy_identity_key_digest
,
3534 crypto_pk_env_t
*legacy_signing_key
);
3535 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3536 ns_detached_signatures_t
*sigs
,
3537 const char **msg_out
);
3538 char *networkstatus_get_detached_signatures(networkstatus_t
*consensus
);
3539 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3541 /* cert manipulation */
3542 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3544 /** Describes the schedule by which votes should be generated. */
3545 typedef struct vote_timing_t
{
3547 int n_intervals_valid
;
3551 /* vote scheduling */
3552 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3553 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3554 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3555 void dirvote_act(or_options_t
*options
, time_t now
);
3557 /* invoked on timers and by outside triggers. */
3558 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3559 const char **msg_out
,
3561 int dirvote_add_signatures(const char *detached_signatures_body
,
3563 const char **msg_out
);
3566 const char *dirvote_get_pending_consensus(void);
3567 const char *dirvote_get_pending_detached_signatures(void);
3569 #define DGV_INCLUDE_PENDING 2
3570 #define DGV_INCLUDE_PREVIOUS 4
3571 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3572 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3573 routerinfo_t
*ri
, time_t now
,
3574 int naming
, int exits_can_be_guards
,
3575 int listbadexits
, int listbaddirs
);
3576 void router_clear_status_flags(routerinfo_t
*ri
);
3578 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3579 authority_cert_t
*cert
);
3581 #ifdef DIRVOTE_PRIVATE
3582 char *format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3583 networkstatus_t
*v3_ns
);
3584 char *dirvote_compute_params(smartlist_t
*votes
);
3587 /********************************* dns.c ***************************/
3590 int has_dns_init_failed(void);
3591 void dns_free_all(void);
3592 uint32_t dns_clip_ttl(uint32_t ttl
);
3593 int dns_reset(void);
3594 void connection_dns_remove(edge_connection_t
*conn
);
3595 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3596 void assert_all_pending_dns_resolves_ok(void);
3597 void dns_cancel_pending_resolve(const char *question
);
3598 int dns_resolve(edge_connection_t
*exitconn
);
3599 void dns_launch_correctness_checks(void);
3600 int dns_seems_to_be_broken(void);
3601 void dns_reset_correctness_checks(void);
3603 /********************************* dnsserv.c ************************/
3605 void dnsserv_configure_listener(connection_t
*conn
);
3606 void dnsserv_close_listener(connection_t
*conn
);
3607 void dnsserv_resolved(edge_connection_t
*conn
,
3612 void dnsserv_reject_request(edge_connection_t
*conn
);
3613 int dnsserv_launch_request(const char *name
, int is_reverse
);
3615 /********************************* geoip.c **************************/
3617 #ifdef GEOIP_PRIVATE
3618 int geoip_parse_entry(const char *line
);
3620 int should_record_bridge_info(or_options_t
*options
);
3621 int geoip_load_file(const char *filename
, or_options_t
*options
);
3622 int geoip_get_country_by_ip(uint32_t ipaddr
);
3623 int geoip_get_n_countries(void);
3624 const char *geoip_get_country_name(country_t num
);
3625 int geoip_is_loaded(void);
3626 country_t
geoip_get_country(const char *countrycode
);
3627 /** Indicates an action that we might be noting geoip statistics on.
3628 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3629 * the others, we're not.
3632 /** We've noticed a connection as a bridge relay. */
3633 GEOIP_CLIENT_CONNECT
= 0,
3634 /** We've served a networkstatus consensus as a directory server. */
3635 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3636 /** We've served a v2 networkstatus consensus as a directory server. */
3637 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3638 } geoip_client_action_t
;
3639 void geoip_note_client_seen(geoip_client_action_t action
,
3640 uint32_t addr
, time_t now
);
3641 void geoip_remove_old_clients(time_t cutoff
);
3642 time_t geoip_get_history_start(void);
3643 char *geoip_get_client_history(time_t now
, geoip_client_action_t action
);
3644 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
3645 int getinfo_helper_geoip(control_connection_t
*control_conn
,
3646 const char *question
, char **answer
);
3647 void geoip_free_all(void);
3648 void dump_geoip_stats(void);
3650 /********************************* hibernate.c **********************/
3652 int accounting_parse_options(or_options_t
*options
, int validate_only
);
3653 int accounting_is_enabled(or_options_t
*options
);
3654 void configure_accounting(time_t now
);
3655 void accounting_run_housekeeping(time_t now
);
3656 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
3657 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
3658 void hibernate_begin_shutdown(void);
3659 int we_are_hibernating(void);
3660 void consider_hibernation(time_t now
);
3661 int getinfo_helper_accounting(control_connection_t
*conn
,
3662 const char *question
, char **answer
);
3663 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
3665 /********************************* main.c ***************************/
3667 extern int has_completed_circuit
;
3669 int connection_add(connection_t
*conn
);
3670 int connection_remove(connection_t
*conn
);
3671 int connection_in_array(connection_t
*conn
);
3672 void add_connection_to_closeable_list(connection_t
*conn
);
3673 int connection_is_on_closeable_list(connection_t
*conn
);
3675 smartlist_t
*get_connection_array(void);
3677 void connection_watch_events(connection_t
*conn
, short events
);
3678 int connection_is_reading(connection_t
*conn
);
3679 void connection_stop_reading(connection_t
*conn
);
3680 void connection_start_reading(connection_t
*conn
);
3682 int connection_is_writing(connection_t
*conn
);
3683 void connection_stop_writing(connection_t
*conn
);
3684 void connection_start_writing(connection_t
*conn
);
3686 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
3688 void directory_all_unreachable(time_t now
);
3689 void directory_info_has_arrived(time_t now
, int from_cache
);
3691 void ip_address_changed(int at_interface
);
3692 void dns_servers_relaunch_checks(void);
3694 void control_signal_act(int the_signal
);
3695 void handle_signals(int is_parent
);
3697 int try_locking(or_options_t
*options
, int err_if_locked
);
3698 int have_lockfile(void);
3699 void release_lockfile(void);
3701 void tor_cleanup(void);
3702 void tor_free_all(int postfork
);
3704 int tor_main(int argc
, char *argv
[]);
3707 int do_main_loop(void);
3708 int do_list_fingerprint(void);
3709 void do_hash_password(void);
3710 int tor_init(int argc
, char **argv
);
3713 /********************************* networkstatus.c *********************/
3715 /** How old do we allow a v2 network-status to get before removing it
3717 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
3719 /** Location where we found a v2 networkstatus. */
3721 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3722 } v2_networkstatus_source_t
;
3724 /** Possible statuses of a version of Tor, given opinions from the directory
3726 typedef enum version_status_t
{
3727 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3728 VS_OLD
=1, /**< This version is older than any recommended version. */
3729 VS_NEW
=2, /**< This version is newer than any recommended version. */
3730 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3731 * in its series, but later recommended versions exist.
3733 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
3734 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
3735 VS_UNKNOWN
, /**< We have no idea. */
3738 void networkstatus_reset_warnings(void);
3739 void networkstatus_reset_download_failures(void);
3740 int router_reload_v2_networkstatus(void);
3741 int router_reload_consensus_networkstatus(void);
3742 void routerstatus_free(routerstatus_t
*rs
);
3743 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
3744 void networkstatus_vote_free(networkstatus_t
*ns
);
3745 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
3746 networkstatus_t
*vote
,
3747 const char *identity
);
3748 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
3750 int networkstatus_check_voter_signature(networkstatus_t
*consensus
,
3751 networkstatus_voter_info_t
*voter
,
3752 authority_cert_t
*cert
);
3753 char *networkstatus_get_cache_filename(const char *identity_digest
);
3754 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
3755 v2_networkstatus_source_t source
,
3756 smartlist_t
*requested_fingerprints
);
3757 void networkstatus_v2_list_clean(time_t now
);
3758 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
3759 const char *digest
);
3760 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
3761 const char *digest
);
3762 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
3763 const char *digest
, int *found_out
);
3764 const smartlist_t
*networkstatus_get_v2_list(void);
3765 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
3766 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
3767 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
3768 const char *digest
);
3769 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
3770 int warn_if_unnamed
);
3771 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
3772 int networkstatus_nickname_is_unnamed(const char *nickname
);
3773 void networkstatus_consensus_download_failed(int status_code
);
3774 void update_consensus_networkstatus_fetch_time(time_t now
);
3775 int should_delay_dir_fetches(or_options_t
*options
);
3776 void update_networkstatus_downloads(time_t now
);
3777 void update_certificate_downloads(time_t now
);
3778 int consensus_is_waiting_for_certs(void);
3779 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
3780 networkstatus_t
*networkstatus_get_latest_consensus(void);
3781 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
3782 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
3783 #define NSSET_FROM_CACHE 1
3784 #define NSSET_WAS_WAITING_FOR_CERTS 2
3785 #define NSSET_DONT_DOWNLOAD_CERTS 4
3786 #define NSSET_ACCEPT_OBSOLETE 8
3787 int networkstatus_set_current_consensus(const char *consensus
, unsigned flags
);
3788 void networkstatus_note_certs_arrived(void);
3789 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
3790 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
3791 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
3792 int reset_failures
);
3793 void signed_descs_update_status_from_consensus_networkstatus(
3794 smartlist_t
*descs
);
3796 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
3797 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
3798 void networkstatus_dump_bridge_status_to_file(time_t now
);
3799 int32_t networkstatus_get_param(networkstatus_t
*ns
, const char *param_name
,
3800 int32_t default_val
);
3801 int getinfo_helper_networkstatus(control_connection_t
*conn
,
3802 const char *question
, char **answer
);
3803 void networkstatus_free_all(void);
3805 /********************************* ntmain.c ***************************/
3811 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
3812 int nt_service_is_stopping(void);
3813 void nt_service_set_state(DWORD state
);
3815 #define nt_service_is_stopping() (0)
3818 /********************************* onion.c ***************************/
3820 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
3821 or_circuit_t
*onion_next_task(char **onionskin_out
);
3822 void onion_pending_remove(or_circuit_t
*circ
);
3824 int onion_skin_create(crypto_pk_env_t
*router_key
,
3825 crypto_dh_env_t
**handshake_state_out
,
3826 char *onion_skin_out
);
3828 int onion_skin_server_handshake(const char *onion_skin
,
3829 crypto_pk_env_t
*private_key
,
3830 crypto_pk_env_t
*prev_private_key
,
3831 char *handshake_reply_out
,
3833 size_t key_out_len
);
3835 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
3836 const char *handshake_reply
,
3838 size_t key_out_len
);
3840 int fast_server_handshake(const uint8_t *key_in
,
3841 uint8_t *handshake_reply_out
,
3843 size_t key_out_len
);
3845 int fast_client_handshake(const uint8_t *handshake_state
,
3846 const uint8_t *handshake_reply_out
,
3848 size_t key_out_len
);
3850 void clear_pending_onions(void);
3852 /********************************* policies.c ************************/
3854 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
3857 #define POLICY_BUF_LEN 52
3859 /** Outcome of applying an address policy to an address. */
3861 /** The address was accepted */
3862 ADDR_POLICY_ACCEPTED
=0,
3863 /** The address was rejected */
3864 ADDR_POLICY_REJECTED
=-1,
3865 /** Part of the address was unknown, but as far as we can tell, it was
3867 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3868 /** Part of the address was unknown, but as far as we can tell, it was
3870 ADDR_POLICY_PROBABLY_REJECTED
=2
3871 } addr_policy_result_t
;
3873 int firewall_is_fascist_or(void);
3874 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
3875 int fascist_firewall_allows_or(routerinfo_t
*ri
);
3876 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
3877 int dir_policy_permits_address(const tor_addr_t
*addr
);
3878 int socks_policy_permits_address(const tor_addr_t
*addr
);
3879 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
3880 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
3881 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
3882 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
3884 int validate_addr_policies(or_options_t
*options
, char **msg
);
3885 void policy_expand_private(smartlist_t
**policy
);
3886 int policies_parse_from_options(or_options_t
*options
);
3888 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
3889 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
3890 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
3891 uint16_t port
, const smartlist_t
*policy
);
3892 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
3893 uint16_t port
, const smartlist_t
*policy
);
3894 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
3895 int rejectprivate
, const char *local_address
);
3896 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
3897 int exit_policy_is_general_exit(smartlist_t
*policy
);
3898 int policy_is_reject_star(const smartlist_t
*policy
);
3899 int getinfo_helper_policies(control_connection_t
*conn
,
3900 const char *question
, char **answer
);
3901 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
3902 int format_for_desc
);
3904 void addr_policy_list_free(smartlist_t
*p
);
3905 void addr_policy_free(addr_policy_t
*p
);
3906 void policies_free_all(void);
3908 char *policy_summarize(smartlist_t
*policy
);
3910 /********************************* reasons.c ***************************/
3912 const char *stream_end_reason_to_control_string(int reason
);
3913 const char *stream_end_reason_to_string(int reason
);
3914 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
3915 uint8_t errno_to_stream_end_reason(int e
);
3917 const char *orconn_end_reason_to_control_string(int r
);
3918 int tls_error_to_orconn_end_reason(int e
);
3919 int errno_to_orconn_end_reason(int e
);
3921 const char *circuit_end_reason_to_control_string(int reason
);
3923 /********************************* relay.c ***************************/
3925 extern uint64_t stats_n_relay_cells_relayed
;
3926 extern uint64_t stats_n_relay_cells_delivered
;
3928 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
3929 cell_direction_t cell_direction
);
3931 void relay_header_pack(uint8_t *dest
, const relay_header_t
*src
);
3932 void relay_header_unpack(relay_header_t
*dest
, const uint8_t *src
);
3933 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
3934 uint8_t relay_command
, const char *payload
,
3935 size_t payload_len
, crypt_path_t
*cpath_layer
);
3936 int connection_edge_send_command(edge_connection_t
*fromconn
,
3937 uint8_t relay_command
, const char *payload
,
3938 size_t payload_len
);
3939 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
3940 int package_partial
);
3941 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
3943 extern uint64_t stats_n_data_cells_packaged
;
3944 extern uint64_t stats_n_data_bytes_packaged
;
3945 extern uint64_t stats_n_data_cells_received
;
3946 extern uint64_t stats_n_data_bytes_received
;
3948 void init_cell_pool(void);
3949 void free_cell_pool(void);
3950 void clean_cell_pool(void);
3951 void dump_cell_pool_usage(int severity
);
3953 void cell_queue_clear(cell_queue_t
*queue
);
3954 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
3955 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
3957 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
3958 cell_t
*cell
, cell_direction_t direction
);
3959 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
3960 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
3961 int max
, time_t now
);
3962 void assert_active_circuits_ok(or_connection_t
*orconn
);
3963 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3964 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3966 int append_address_to_payload(uint8_t *payload_out
, const tor_addr_t
*addr
);
3967 const uint8_t *decode_address_from_payload(tor_addr_t
*addr_out
,
3968 const uint8_t *payload
,
3971 /********************************* rephist.c ***************************/
3973 void rep_hist_init(void);
3974 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
3975 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
3976 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
3977 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
3978 void rep_hist_note_extend_succeeded(const char *from_name
,
3979 const char *to_name
);
3980 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
3981 void rep_hist_dump_stats(time_t now
, int severity
);
3982 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
3983 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
3984 int rep_hist_bandwidth_assess(void);
3985 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
3986 void rep_hist_update_state(or_state_t
*state
);
3987 int rep_hist_load_state(or_state_t
*state
, char **err
);
3988 void rep_history_clean(time_t before
);
3990 void rep_hist_note_router_reachable(const char *id
, time_t when
);
3991 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
3992 int rep_hist_record_mtbf_data(time_t now
, int missing_means_down
);
3993 int rep_hist_load_mtbf_data(time_t now
);
3995 time_t rep_hist_downrate_old_runs(time_t now
);
3996 double rep_hist_get_stability(const char *id
, time_t when
);
3997 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
3998 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
3999 int rep_hist_have_measured_enough_stability(void);
4000 const char *rep_hist_get_router_stability_doc(time_t now
);
4002 void rep_hist_note_used_port(time_t now
, uint16_t port
);
4003 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
4004 void rep_hist_note_used_resolve(time_t now
);
4005 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
4007 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
4008 int *need_capacity
);
4010 int any_predicted_circuits(time_t now
);
4011 int rep_hist_circbuilding_dormant(time_t now
);
4013 /** Possible public/private key operations in Tor: used to keep track of where
4014 * we're spending our time. */
4017 VERIFY_DIR
, VERIFY_RTR
,
4018 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4019 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4020 REND_CLIENT
, REND_MID
, REND_SERVER
,
4022 void note_crypto_pk_op(pk_op_t operation
);
4023 void dump_pk_ops(int severity
);
4025 void rep_hist_free_all(void);
4027 /* for hidden service usage statistics */
4028 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
4029 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
4030 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
4031 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
4032 void hs_usage_write_statistics_to_file(time_t now
);
4033 void hs_usage_free_all(void);
4035 /********************************* rendclient.c ***************************/
4037 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
4038 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
4039 int rend_client_introduction_acked(origin_circuit_t
*circ
,
4040 const uint8_t *request
,
4041 size_t request_len
);
4042 void rend_client_refetch_renddesc(const char *query
);
4043 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
4044 void rend_client_cancel_descriptor_fetches(void);
4045 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
4046 const rend_data_t
*rend_query
);
4047 int rend_client_rendezvous_acked(origin_circuit_t
*circ
,
4048 const uint8_t *request
,
4049 size_t request_len
);
4050 int rend_client_receive_rendezvous(origin_circuit_t
*circ
,
4051 const uint8_t *request
,
4052 size_t request_len
);
4053 void rend_client_desc_trynow(const char *query
, int rend_version
);
4055 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
4057 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
4058 origin_circuit_t
*rendcirc
);
4059 int rend_parse_service_authorization(or_options_t
*options
,
4061 rend_service_authorization_t
*rend_client_lookup_service_authorization(
4062 const char *onion_address
);
4063 void rend_service_authorization_free_all(void);
4064 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
4066 /********************************* rendcommon.c ***************************/
4068 /** Hidden-service side configuration of client authorization. */
4069 typedef struct rend_authorized_client_t
{
4071 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4072 crypto_pk_env_t
*client_key
;
4073 } rend_authorized_client_t
;
4075 /** ASCII-encoded v2 hidden service descriptor. */
4076 typedef struct rend_encoded_v2_service_descriptor_t
{
4077 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4078 char *desc_str
; /**< Descriptor string. */
4079 } rend_encoded_v2_service_descriptor_t
;
4081 /** Introduction point information. */
4082 typedef struct rend_intro_point_t
{
4083 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4084 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
4085 * key, if this descriptor is V2. */
4086 } rend_intro_point_t
;
4088 /** Information used to connect to a hidden service. */
4089 typedef struct rend_service_descriptor_t
{
4090 crypto_pk_env_t
*pk
; /**< This service's public key. */
4091 int version
; /**< Version of the descriptor format: 0 or 2. */
4092 time_t timestamp
; /**< Time when the descriptor was generated. */
4093 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
4094 * (We allow bits '0', '1', and '2' to be set.) */
4095 /** List of the service's introduction points. Elements are removed if
4096 * introduction attempts fail. */
4097 smartlist_t
*intro_nodes
;
4098 /** Has descriptor been uploaded to all hidden service directories? */
4099 int all_uploads_performed
;
4100 /** List of hidden service directories to which an upload request for
4101 * this descriptor could be sent. Smartlist exists only when at least one
4102 * of the previous upload requests failed (otherwise it's not important
4103 * to know which uploads succeeded and which not). */
4104 smartlist_t
*successful_uploads
;
4105 } rend_service_descriptor_t
;
4107 /** Free all storage associated with <b>data</b> */
4109 rend_data_free(rend_data_t
*data
)
4114 int rend_cmp_service_ids(const char *one
, const char *two
);
4116 void rend_process_relay_cell(circuit_t
*circ
, const crypt_path_t
*layer_hint
,
4117 int command
, size_t length
,
4118 const uint8_t *payload
);
4120 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
4121 int rend_encode_service_descriptor(rend_service_descriptor_t
*desc
,
4122 crypto_pk_env_t
*key
,
4125 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
4127 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
4128 void rend_encoded_v2_service_descriptor_free(
4129 rend_encoded_v2_service_descriptor_t
*desc
);
4130 void rend_intro_point_free(rend_intro_point_t
*intro
);
4132 /** A cached rendezvous descriptor. */
4133 typedef struct rend_cache_entry_t
{
4134 size_t len
; /**< Length of <b>desc</b> */
4135 time_t received
; /**< When was the descriptor received? */
4136 char *desc
; /**< Service descriptor */
4137 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
4138 } rend_cache_entry_t
;
4140 void rend_cache_init(void);
4141 void rend_cache_clean(void);
4142 void rend_cache_clean_v2_descs_as_dir(void);
4143 void rend_cache_purge(void);
4144 void rend_cache_free_all(void);
4145 int rend_valid_service_id(const char *query
);
4146 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
4148 int rend_cache_lookup_entry(const char *query
, int version
,
4149 rend_cache_entry_t
**entry_out
);
4150 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
4151 int rend_cache_store(const char *desc
, size_t desc_len
, int published
,
4152 const char *service_id
);
4153 int rend_cache_store_v2_desc_as_client(const char *desc
,
4154 const rend_data_t
*rend_query
);
4155 int rend_cache_store_v2_desc_as_dir(const char *desc
);
4156 int rend_cache_size(void);
4157 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
4158 rend_service_descriptor_t
*desc
, time_t now
,
4159 uint8_t period
, rend_auth_type_t auth_type
,
4160 crypto_pk_env_t
*client_key
,
4161 smartlist_t
*client_cookies
);
4162 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
4163 const char *descriptor_cookie
,
4164 time_t now
, uint8_t replica
);
4165 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4166 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4167 const char *service_id
,
4168 const char *secret_id_part
);
4170 /********************************* rendservice.c ***************************/
4172 int num_rend_services(void);
4173 int rend_config_services(or_options_t
*options
, int validate_only
);
4174 int rend_service_load_keys(void);
4175 void rend_services_init(void);
4176 void rend_services_introduce(void);
4177 void rend_consider_services_upload(time_t now
);
4178 void rend_hsdir_routers_changed(void);
4179 void rend_consider_descriptor_republication(void);
4181 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4182 int rend_service_intro_established(origin_circuit_t
*circuit
,
4183 const uint8_t *request
,
4184 size_t request_len
);
4185 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4186 int rend_service_introduce(origin_circuit_t
*circuit
, const uint8_t *request
,
4187 size_t request_len
);
4188 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4189 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4190 origin_circuit_t
*circ
);
4191 void rend_service_dump_stats(int severity
);
4192 void rend_service_free_all(void);
4194 /********************************* rendmid.c *******************************/
4195 int rend_mid_establish_intro(or_circuit_t
*circ
, const uint8_t *request
,
4196 size_t request_len
);
4197 int rend_mid_introduce(or_circuit_t
*circ
, const uint8_t *request
,
4198 size_t request_len
);
4199 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const uint8_t *request
,
4200 size_t request_len
);
4201 int rend_mid_rendezvous(or_circuit_t
*circ
, const uint8_t *request
,
4202 size_t request_len
);
4204 /********************************* router.c ***************************/
4206 crypto_pk_env_t
*get_onion_key(void);
4207 time_t get_onion_key_set_at(void);
4208 void set_client_identity_key(crypto_pk_env_t
*k
);
4209 void set_server_identity_key(crypto_pk_env_t
*k
);
4210 crypto_pk_env_t
*get_tlsclient_identity_key(void);
4211 crypto_pk_env_t
*get_server_identity_key(void);
4212 int client_identity_key_is_set(void);
4213 int server_identity_key_is_set(void);
4214 authority_cert_t
*get_my_v3_authority_cert(void);
4215 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4216 authority_cert_t
*get_my_v3_legacy_cert(void);
4217 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4218 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4219 void rotate_onion_key(void);
4220 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4222 void v3_authority_check_key_expiry(void);
4224 int init_keys(void);
4226 int check_whether_orport_reachable(void);
4227 int check_whether_dirport_reachable(void);
4228 void consider_testing_reachability(int test_or
, int test_dir
);
4229 void router_orport_found_reachable(void);
4230 void router_dirport_found_reachable(void);
4231 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4233 int authdir_mode(or_options_t
*options
);
4234 int authdir_mode_v1(or_options_t
*options
);
4235 int authdir_mode_v2(or_options_t
*options
);
4236 int authdir_mode_v3(or_options_t
*options
);
4237 int authdir_mode_any_main(or_options_t
*options
);
4238 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4239 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4240 int authdir_mode_publishes_statuses(or_options_t
*options
);
4241 int authdir_mode_tests_reachability(or_options_t
*options
);
4242 int authdir_mode_bridge(or_options_t
*options
);
4244 int server_mode(or_options_t
*options
);
4245 int public_server_mode(or_options_t
*options
);
4246 int advertised_server_mode(void);
4247 int proxy_mode(or_options_t
*options
);
4248 void consider_publishable_server(int force
);
4250 void router_upload_dir_desc_to_dirservers(int force
);
4251 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4252 void mark_my_descriptor_dirty(void);
4253 void check_descriptor_bandwidth_changed(time_t now
);
4254 void check_descriptor_ipaddress_changed(time_t now
);
4255 void router_new_address_suggestion(const char *suggestion
,
4256 const dir_connection_t
*d_conn
);
4257 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4258 routerinfo_t
*router_get_my_routerinfo(void);
4259 extrainfo_t
*router_get_my_extrainfo(void);
4260 const char *router_get_my_descriptor(void);
4261 int router_digest_is_me(const char *digest
);
4262 int router_extrainfo_digest_is_me(const char *digest
);
4263 int router_is_me(routerinfo_t
*router
);
4264 int router_fingerprint_is_me(const char *fp
);
4265 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4266 int router_rebuild_descriptor(int force
);
4267 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4268 crypto_pk_env_t
*ident_key
);
4269 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4270 crypto_pk_env_t
*ident_key
);
4271 char *extrainfo_get_client_geoip_summary(time_t);
4272 int is_legal_nickname(const char *s
);
4273 int is_legal_nickname_or_hexdigest(const char *s
);
4274 int is_legal_hexdigest(const char *s
);
4275 void router_get_verbose_nickname(char *buf
, const routerinfo_t
*router
);
4276 void routerstatus_get_verbose_nickname(char *buf
,
4277 const routerstatus_t
*router
);
4278 void router_reset_warnings(void);
4279 void router_reset_reachability(void);
4280 void router_free_all(void);
4282 const char *router_purpose_to_string(uint8_t p
);
4283 uint8_t router_purpose_from_string(const char *s
);
4285 #ifdef ROUTER_PRIVATE
4286 /* Used only by router.c and test.c */
4287 void get_platform_str(char *platform
, size_t len
);
4290 /********************************* routerlist.c ***************************/
4292 /** Represents information about a single trusted directory server. */
4293 typedef struct trusted_dir_server_t
{
4296 char *address
; /**< Hostname. */
4297 uint32_t addr
; /**< IPv4 address. */
4298 uint16_t dir_port
; /**< Directory port. */
4299 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4300 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4301 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4302 * high-security) identity key. */
4304 unsigned int is_running
:1; /**< True iff we think this server is running. */
4306 /** True iff this server has accepted the most recent server descriptor
4307 * we tried to upload to it. */
4308 unsigned int has_accepted_serverdesc
:1;
4310 /** What kind of authority is this? (Bitfield.) */
4311 authority_type_t type
;
4313 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4314 * v2 network status. */
4315 time_t addr_current_at
; /**< When was the document that we derived the
4316 * address information from published? */
4318 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4319 * dir_server_t to directory_initiate_command_*
4320 * as a routerstatus_t. Not updated by the
4321 * router-status management code!
4323 } trusted_dir_server_t
;
4325 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
4327 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4329 int get_n_authorities(authority_type_t type
);
4330 int trusted_dirs_reload_certs(void);
4331 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4333 void trusted_dirs_flush_certs_to_disk(void);
4334 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4335 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4336 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4337 const char *sk_digest
);
4338 void authority_cert_get_all(smartlist_t
*certs_out
);
4339 void authority_cert_dl_failed(const char *id_digest
, int status
);
4340 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4341 int router_reload_router_list(void);
4342 smartlist_t
*router_get_trusted_dir_servers(void);
4344 /* Flags for pick_directory_server and pick_trusteddirserver. */
4345 /** Flag to indicate that we should not automatically be willing to use
4346 * ourself to answer a directory request.
4347 * Passed to router_pick_directory_server (et al).*/
4348 #define PDS_ALLOW_SELF (1<<0)
4349 /** Flag to indicate that if no servers seem to be up, we should mark all
4350 * directory servers as up and try again.
4351 * Passed to router_pick_directory_server (et al).*/
4352 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4353 /** Flag to indicate that we should not exclude directory servers that
4354 * our ReachableAddress settings would exclude. This usually means that
4355 * we're going to connect to the server over Tor, and so we don't need to
4356 * worry about our firewall telling us we can't.
4357 * Passed to router_pick_directory_server (et al).*/
4358 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4359 /** Flag to indicate that we should not use any directory authority to which
4360 * we have an existing directory connection for downloading server descriptors
4361 * or extrainfo documents.
4363 * Passed to router_pick_directory_server (et al)
4365 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
4366 * not pick_directory_server. If we make it work on pick_directory_server
4367 * too, we could conservatively make it only prevent multiple fetches to
4368 * the same authority, or we could aggressively make it prevent multiple
4369 * fetches to _any_ single directory server.]
4371 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4372 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4373 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4374 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4375 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4376 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4377 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4378 double *v3_share_out
);
4379 void router_reset_status_download_failures(void);
4380 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4381 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4382 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4383 int must_be_running
);
4384 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4385 routerinfo_t
*routerlist_find_my_routerinfo(void);
4386 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4388 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4389 int need_capacity
, int need_guard
);
4390 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4391 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4393 /** Possible ways to weight routers when choosing one randomly. See
4394 * routerlist_sl_choose_by_bandwidth() for more information.*/
4396 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4397 } bandwidth_weight_rule_t
;
4398 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4399 bandwidth_weight_rule_t rule
);
4400 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4402 /** Flags to be passed to control router_choose_random_node() to indicate what
4403 * kind of nodes to pick according to what algorithm. */
4405 CRN_NEED_UPTIME
= 1<<0,
4406 CRN_NEED_CAPACITY
= 1<<1,
4407 CRN_NEED_GUARD
= 1<<2,
4408 CRN_ALLOW_INVALID
= 1<<3,
4409 /* XXXX not used, apparently. */
4410 CRN_STRICT_PREFERRED
= 1<<4,
4411 /* XXXX not used, apparently. */
4412 CRN_WEIGHT_AS_EXIT
= 1<<5
4413 } router_crn_flags_t
;
4415 routerinfo_t
*router_choose_random_node(const char *preferred
,
4416 smartlist_t
*excludedsmartlist
,
4417 struct routerset_t
*excludedset
,
4418 router_crn_flags_t flags
);
4420 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4421 int warn_if_unnamed
);
4422 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4423 int router_digest_is_trusted_dir_type(const char *digest
,
4424 authority_type_t type
);
4425 #define router_digest_is_trusted_dir(d) \
4426 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4428 int router_addr_is_trusted_dir(uint32_t addr
);
4429 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4430 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4431 routerinfo_t
*router_get_by_digest(const char *digest
);
4432 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4433 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4434 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4435 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4436 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4437 routerlist_t
*router_get_routerlist(void);
4438 void routerinfo_free(routerinfo_t
*router
);
4439 void extrainfo_free(extrainfo_t
*extrainfo
);
4440 void routerlist_free(routerlist_t
*rl
);
4441 void dump_routerlist_mem_usage(int severity
);
4442 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
,
4444 void routerlist_free_all(void);
4445 void routerlist_reset_warnings(void);
4446 void router_set_status(const char *digest
, int up
);
4448 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
4449 typedef enum was_router_added_t
{
4450 ROUTER_ADDED_SUCCESSFULLY
= 1,
4451 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
4453 ROUTER_WAS_NOT_NEW
= -2,
4454 ROUTER_NOT_IN_CONSENSUS
= -3,
4455 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
4456 ROUTER_AUTHDIR_REJECTS
= -5,
4457 } was_router_added_t
;
4459 static int WRA_WAS_ADDED(was_router_added_t s
);
4460 static int WRA_WAS_OUTDATED(was_router_added_t s
);
4461 static int WRA_WAS_REJECTED(was_router_added_t s
);
4462 /** Return true iff the descriptor was added. It might still be necessary to
4463 * check whether the descriptor generator should be notified.
4466 WRA_WAS_ADDED(was_router_added_t s
) {
4467 return s
== ROUTER_ADDED_SUCCESSFULLY
|| s
== ROUTER_ADDED_NOTIFY_GENERATOR
;
4469 /** Return true iff the descriptor was not added because it was either:
4470 * - not in the consensus
4471 * - neither in the consensus nor in any networkstatus document
4472 * - it was outdated.
4474 static INLINE
int WRA_WAS_OUTDATED(was_router_added_t s
)
4476 return (s
== ROUTER_WAS_NOT_NEW
||
4477 s
== ROUTER_NOT_IN_CONSENSUS
||
4478 s
== ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
);
4480 /** Return true iff the descriptor rejected because it was malformed. */
4481 static INLINE
int WRA_WAS_REJECTED(was_router_added_t s
)
4483 return (s
== ROUTER_AUTHDIR_REJECTS
);
4485 was_router_added_t
router_add_to_routerlist(routerinfo_t
*router
,
4489 was_router_added_t
router_add_extrainfo_to_routerlist(
4490 extrainfo_t
*ei
, const char **msg
,
4491 int from_cache
, int from_fetch
);
4492 void routerlist_remove_old_routers(void);
4493 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4495 int router_load_routers_from_string(const char *s
, const char *eos
,
4496 saved_location_t saved_location
,
4497 smartlist_t
*requested_fingerprints
,
4498 int descriptor_digests
,
4499 const char *prepend_annotations
);
4500 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4501 saved_location_t saved_location
,
4502 smartlist_t
*requested_fingerprints
,
4503 int descriptor_digests
);
4504 void routerlist_retry_directory_downloads(time_t now
);
4505 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4507 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4508 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4509 const char *address
,
4510 uint16_t dir_port
, uint16_t or_port
,
4511 const char *digest
, const char *v3_auth_digest
,
4512 authority_type_t type
);
4513 void authority_cert_free(authority_cert_t
*cert
);
4514 void clear_trusted_dir_servers(void);
4515 int any_trusted_dir_is_v1_authority(void);
4516 void update_router_descriptor_downloads(time_t now
);
4517 void update_extrainfo_downloads(time_t now
);
4518 int router_have_minimum_dir_info(void);
4519 void router_dir_info_changed(void);
4520 const char *get_dir_info_status_string(void);
4521 int count_loading_descriptors_progress(void);
4522 void router_reset_descriptor_download_failures(void);
4523 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
4524 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
4525 signed_descriptor_t
*sd
,
4527 void routerlist_assert_ok(routerlist_t
*rl
);
4528 const char *esc_router_info(routerinfo_t
*router
);
4529 void routers_sort_by_identity(smartlist_t
*routers
);
4531 routerset_t
*routerset_new(void);
4532 int routerset_parse(routerset_t
*target
, const char *s
,
4533 const char *description
);
4534 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
4535 int routerset_is_list(const routerset_t
*set
);
4536 int routerset_needs_geoip(const routerset_t
*set
);
4537 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
4538 int routerset_contains_routerstatus(const routerset_t
*set
,
4539 routerstatus_t
*rs
);
4540 int routerset_contains_extendinfo(const routerset_t
*set
,
4541 const extend_info_t
*ei
);
4542 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
4544 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
4545 const routerset_t
*include
,
4546 const routerset_t
*exclude
, int running_only
);
4547 void routerset_subtract_routers(smartlist_t
*out
,
4548 const routerset_t
*routerset
);
4549 char *routerset_to_string(const routerset_t
*routerset
);
4550 void routerset_refresh_countries(routerset_t
*target
);
4551 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
4552 void routerset_free(routerset_t
*routerset
);
4553 void routerinfo_set_country(routerinfo_t
*ri
);
4554 void routerlist_refresh_countries(void);
4555 void refresh_all_country_info(void);
4557 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
4559 int hid_serv_acting_as_directory(void);
4560 int hid_serv_responsible_for_desc_id(const char *id
);
4562 /********************************* routerparse.c ************************/
4564 #define MAX_STATUS_TAG_LEN 32
4565 /** Structure to hold parsed Tor versions. This is a little messier
4566 * than we would like it to be, because we changed version schemes with 0.1.0.
4568 * See version-spec.txt for the whole business.
4570 typedef struct tor_version_t
{
4574 /** Release status. For version in the post-0.1 format, this is always
4576 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4578 char status_tag
[MAX_STATUS_TAG_LEN
];
4582 int router_get_router_hash(const char *s
, size_t s_len
, char *digest
);
4583 int router_get_dir_hash(const char *s
, char *digest
);
4584 int router_get_runningrouters_hash(const char *s
, char *digest
);
4585 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
4586 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
4587 int router_get_extrainfo_hash(const char *s
, char *digest
);
4588 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
4590 crypto_pk_env_t
*private_key
);
4591 int router_parse_list_from_string(const char **s
, const char *eos
,
4593 saved_location_t saved_location
,
4595 int allow_annotations
,
4596 const char *prepend_annotations
);
4597 int router_parse_routerlist_from_directory(const char *s
,
4598 routerlist_t
**dest
,
4599 crypto_pk_env_t
*pkey
,
4601 int write_to_cache
);
4602 int router_parse_runningrouters(const char *str
);
4603 int router_parse_directory(const char *str
);
4604 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
4606 int allow_annotations
,
4607 const char *prepend_annotations
);
4608 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
4609 int cache_copy
, struct digest_ri_map_t
*routermap
);
4610 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
4612 version_status_t
tor_version_is_obsolete(const char *myversion
,
4613 const char *versionlist
);
4614 int tor_version_parse(const char *s
, tor_version_t
*out
);
4615 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
4616 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
4617 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
4618 void assert_addr_policy_ok(smartlist_t
*t
);
4619 void dump_distinct_digest_count(int severity
);
4621 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
4622 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
4623 const char **eos_out
,
4624 networkstatus_type_t ns_type
);
4625 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
4626 const char *s
, const char *eos
);
4628 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
4629 const char **end_of_string
);
4630 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
4632 char **intro_points_encrypted_out
,
4633 size_t *intro_points_encrypted_size_out
,
4634 size_t *encoded_size_out
,
4635 const char **next_out
, const char *desc
);
4636 int rend_decrypt_introduction_points(char **ipos_decrypted
,
4637 size_t *ipos_decrypted_size
,
4638 const char *descriptor_cookie
,
4639 const char *ipos_encrypted
,
4640 size_t ipos_encrypted_size
);
4641 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
4642 const char *intro_points_encoded
,
4643 size_t intro_points_encoded_size
);
4644 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);