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-2009, 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
26 #define WIN32_WINNT 0x400
27 #define _WIN32_WINNT 0x400
28 #define WIN32_LEAN_AND_MEAN
40 #ifdef HAVE_SYS_PARAM_H
41 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
44 #ifdef HAVE_SYS_WAIT_H
47 #ifdef HAVE_SYS_FCNTL_H
48 #include <sys/fcntl.h>
53 #ifdef HAVE_SYS_IOCTL_H
54 #include <sys/ioctl.h>
59 #ifdef HAVE_SYS_STAT_H
62 #ifdef HAVE_ARPA_INET_H
63 #include <arpa/inet.h>
80 #define snprintf _snprintf
85 #include "../common/log.h"
87 #include "container.h"
91 #include "compat_libevent.h"
94 /* These signals are defined to help control_signal_act work.
111 /* Controller signals start at a high number so we don't
112 * conflict with system-defined signals. */
113 #define SIGNEWNYM 129
114 #define SIGCLEARDNSCACHE 130
116 #if (SIZEOF_CELL_T != 0)
117 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
118 * that our stuff always calls cell_t something different. */
119 #define cell_t tor_cell_t
122 /** Length of longest allowable configured nickname. */
123 #define MAX_NICKNAME_LEN 19
124 /** Length of a router identity encoded as a hexadecimal digest, plus
125 * possible dollar sign. */
126 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
127 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
128 * equal sign or tilde, nickname. */
129 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
131 /** Maximum size, in bytes, for resized buffers. */
132 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
133 /** Maximum size, in bytes, for any directory object that we've downloaded. */
134 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
136 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
137 * of an HTTP request or response. */
138 #define MAX_HEADERS_SIZE 50000
139 /** Maximum size, in bytes, for any directory object that we're accepting
141 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
143 /** Maximum size, in bytes, of a single router descriptor uploaded to us
144 * as a directory authority. Caches and clients fetch whatever descriptors
145 * the authorities tell them to fetch, and don't care about size. */
146 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
148 /** Maximum size of a single extrainfo document, as above. */
149 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
151 /** How long do we keep DNS cache entries before purging them (regardless of
153 #define MAX_DNS_ENTRY_AGE (30*60)
154 /** How long do we cache/tell clients to cache DNS records when no TTL is
156 #define DEFAULT_DNS_TTL (30*60)
157 /** How long can a TTL be before we stop believing it? */
158 #define MAX_DNS_TTL (3*60*60)
159 /** How small can a TTL be before we stop believing it? Provides rudimentary
161 #define MIN_DNS_TTL (60)
163 /** How often do we rotate onion keys? */
164 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
165 /** How often do we rotate TLS contexts? */
166 #define MAX_SSL_KEY_LIFETIME (2*60*60)
168 /** How old do we allow a router to get before removing it
169 * from the router list? In seconds. */
170 #define ROUTER_MAX_AGE (60*60*48)
171 /** How old can a router get before we (as a server) will no longer
172 * consider it live? In seconds. */
173 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
174 /** How old do we let a saved descriptor get before force-removing it? */
175 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
177 /** Possible rules for generating circuit IDs on an OR connection. */
179 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
180 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
181 /** The other side of a connection is an OP: never create circuits to it,
182 * and let it use any circuit ID it wants. */
183 CIRC_ID_TYPE_NEITHER
=2
186 #define _CONN_TYPE_MIN 3
187 /** Type for sockets listening for OR connections. */
188 #define CONN_TYPE_OR_LISTENER 3
189 /** A bidirectional TLS connection transmitting a sequence of cells.
190 * May be from an OR to an OR, or from an OP to an OR. */
191 #define CONN_TYPE_OR 4
192 /** A TCP connection from an onion router to a stream's destination. */
193 #define CONN_TYPE_EXIT 5
194 /** Type for sockets listening for SOCKS connections. */
195 #define CONN_TYPE_AP_LISTENER 6
196 /** A SOCKS proxy connection from the user application to the onion
198 #define CONN_TYPE_AP 7
199 /** Type for sockets listening for HTTP connections to the directory server. */
200 #define CONN_TYPE_DIR_LISTENER 8
201 /** Type for HTTP connections to the directory server. */
202 #define CONN_TYPE_DIR 9
203 /** Connection from the main process to a CPU worker process. */
204 #define CONN_TYPE_CPUWORKER 10
205 /** Type for listening for connections from user interface process. */
206 #define CONN_TYPE_CONTROL_LISTENER 11
207 /** Type for connections from user interface process. */
208 #define CONN_TYPE_CONTROL 12
209 /** Type for sockets listening for transparent connections redirected by pf or
211 #define CONN_TYPE_AP_TRANS_LISTENER 13
212 /** Type for sockets listening for transparent connections redirected by
214 #define CONN_TYPE_AP_NATD_LISTENER 14
215 /** Type for sockets listening for DNS requests. */
216 #define CONN_TYPE_AP_DNS_LISTENER 15
217 #define _CONN_TYPE_MAX 15
218 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
221 /* Proxy client types */
223 #define PROXY_CONNECT 1
224 #define PROXY_SOCKS4 2
225 #define PROXY_SOCKS5 3
227 /* Proxy client handshake states */
228 #define PROXY_HTTPS_WANT_CONNECT_OK 1
229 #define PROXY_SOCKS4_WANT_CONNECT_OK 2
230 #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 3
231 #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 4
232 #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 5
233 #define PROXY_SOCKS5_WANT_CONNECT_OK 6
234 #define PROXY_CONNECTED 7
236 /** True iff <b>x</b> is an edge connection. */
237 #define CONN_IS_EDGE(x) \
238 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
240 /** State for any listener connection. */
241 #define LISTENER_STATE_READY 0
243 #define _CPUWORKER_STATE_MIN 1
244 /** State for a connection to a cpuworker process that's idle. */
245 #define CPUWORKER_STATE_IDLE 1
246 /** State for a connection to a cpuworker process that's processing a
248 #define CPUWORKER_STATE_BUSY_ONION 2
249 #define _CPUWORKER_STATE_MAX 2
251 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
253 #define _OR_CONN_STATE_MIN 1
254 /** State for a connection to an OR: waiting for connect() to finish. */
255 #define OR_CONN_STATE_CONNECTING 1
256 /** State for a connection to an OR: waiting for proxy handshake to complete */
257 #define OR_CONN_STATE_PROXY_HANDSHAKING 2
258 /** State for a connection to an OR or client: SSL is handshaking, not done
260 #define OR_CONN_STATE_TLS_HANDSHAKING 3
261 /** State for a connection to an OR: We're doing a second SSL handshake for
262 * renegotiation purposes. */
263 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
264 /** State for a connection at an OR: We're waiting for the client to
266 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
267 /** State for a connection to an OR: We're done with our SSL handshake, but we
268 * haven't yet negotiated link protocol versions and sent a netinfo cell.
270 #define OR_CONN_STATE_OR_HANDSHAKING 6
271 /** State for a connection to an OR: Ready to send/receive cells. */
272 #define OR_CONN_STATE_OPEN 7
273 #define _OR_CONN_STATE_MAX 7
275 #define _EXIT_CONN_STATE_MIN 1
276 /** State for an exit connection: waiting for response from DNS farm. */
277 #define EXIT_CONN_STATE_RESOLVING 1
278 /** State for an exit connection: waiting for connect() to finish. */
279 #define EXIT_CONN_STATE_CONNECTING 2
280 /** State for an exit connection: open and ready to transmit data. */
281 #define EXIT_CONN_STATE_OPEN 3
282 /** State for an exit connection: waiting to be removed. */
283 #define EXIT_CONN_STATE_RESOLVEFAILED 4
284 #define _EXIT_CONN_STATE_MAX 4
286 /* The AP state values must be disjoint from the EXIT state values. */
287 #define _AP_CONN_STATE_MIN 5
288 /** State for a SOCKS connection: waiting for SOCKS request. */
289 #define AP_CONN_STATE_SOCKS_WAIT 5
290 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
291 * rendezvous descriptor. */
292 #define AP_CONN_STATE_RENDDESC_WAIT 6
293 /** The controller will attach this connection to a circuit; it isn't our
295 #define AP_CONN_STATE_CONTROLLER_WAIT 7
296 /** State for a SOCKS connection: waiting for a completed circuit. */
297 #define AP_CONN_STATE_CIRCUIT_WAIT 8
298 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
299 #define AP_CONN_STATE_CONNECT_WAIT 9
300 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
301 #define AP_CONN_STATE_RESOLVE_WAIT 10
302 /** State for a SOCKS connection: ready to send and receive. */
303 #define AP_CONN_STATE_OPEN 11
304 /** State for a transparent natd connection: waiting for original
306 #define AP_CONN_STATE_NATD_WAIT 12
307 #define _AP_CONN_STATE_MAX 12
309 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
310 * edge connection is not attached to any circuit. */
311 #define AP_CONN_STATE_IS_UNATTACHED(s) \
312 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
314 #define _DIR_CONN_STATE_MIN 1
315 /** State for connection to directory server: waiting for connect(). */
316 #define DIR_CONN_STATE_CONNECTING 1
317 /** State for connection to directory server: sending HTTP request. */
318 #define DIR_CONN_STATE_CLIENT_SENDING 2
319 /** State for connection to directory server: reading HTTP response. */
320 #define DIR_CONN_STATE_CLIENT_READING 3
321 /** State for connection to directory server: happy and finished. */
322 #define DIR_CONN_STATE_CLIENT_FINISHED 4
323 /** State for connection at directory server: waiting for HTTP request. */
324 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
325 /** State for connection at directory server: sending HTTP response. */
326 #define DIR_CONN_STATE_SERVER_WRITING 6
327 #define _DIR_CONN_STATE_MAX 6
329 /** True iff the purpose of <b>conn</b> means that it's a server-side
330 * directory connection. */
331 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
333 #define _CONTROL_CONN_STATE_MIN 1
334 /** State for a control connection: Authenticated and accepting v1 commands. */
335 #define CONTROL_CONN_STATE_OPEN 1
336 /** State for a control connection: Waiting for authentication; speaking
338 #define CONTROL_CONN_STATE_NEEDAUTH 2
339 #define _CONTROL_CONN_STATE_MAX 2
341 #define _DIR_PURPOSE_MIN 3
342 /** A connection to a directory server: download a rendezvous
344 #define DIR_PURPOSE_FETCH_RENDDESC 3
345 /** A connection to a directory server: set after a rendezvous
346 * descriptor is downloaded. */
347 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
348 /** A connection to a directory server: download one or more v2
349 * network-status objects */
350 #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
351 /** A connection to a directory server: download one or more server
353 #define DIR_PURPOSE_FETCH_SERVERDESC 6
354 /** A connection to a directory server: download one or more extra-info
356 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
357 /** A connection to a directory server: upload a server descriptor. */
358 #define DIR_PURPOSE_UPLOAD_DIR 8
359 /** A connection to a directory server: upload a rendezvous
361 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
362 /** A connection to a directory server: upload a v3 networkstatus vote. */
363 #define DIR_PURPOSE_UPLOAD_VOTE 10
364 /** A connection to a directory server: upload a v3 consensus signature */
365 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
366 /** A connection to a directory server: download one or more v3 networkstatus
368 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
369 /** A connection to a directory server: download a v3 detached signatures
370 * object for a consensus. */
371 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
372 /** A connection to a directory server: download a v3 networkstatus
374 #define DIR_PURPOSE_FETCH_CONSENSUS 14
375 /** A connection to a directory server: download one or more directory
376 * authority certificates. */
377 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
379 /** Purpose for connection at a directory server. */
380 #define DIR_PURPOSE_SERVER 16
381 /** A connection to a hidden service directory server: upload a v2 rendezvous
383 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
384 /** A connection to a hidden service directory server: download a v2 rendezvous
386 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
387 #define _DIR_PURPOSE_MAX 18
389 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
390 * directory server. */
391 #define DIR_PURPOSE_IS_UPLOAD(p) \
392 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
393 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
394 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
395 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
397 #define _EXIT_PURPOSE_MIN 1
398 /** This exit stream wants to do an ordinary connect. */
399 #define EXIT_PURPOSE_CONNECT 1
400 /** This exit stream wants to do a resolve (either normal or reverse). */
401 #define EXIT_PURPOSE_RESOLVE 2
402 #define _EXIT_PURPOSE_MAX 2
404 /* !!!! If any connection purpose is ever over 31, we must grow the type
405 * field in connection_t. */
407 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
408 #define CIRCUIT_STATE_BUILDING 0
409 /** Circuit state: Waiting to process the onionskin. */
410 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
411 /** Circuit state: I'd like to deliver a create, but my n_conn is still
413 #define CIRCUIT_STATE_OR_WAIT 2
414 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
415 #define CIRCUIT_STATE_OPEN 3
417 #define _CIRCUIT_PURPOSE_MIN 1
419 /* these circuits were initiated elsewhere */
420 #define _CIRCUIT_PURPOSE_OR_MIN 1
421 /** OR-side circuit purpose: normal circuit, at OR. */
422 #define CIRCUIT_PURPOSE_OR 1
423 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
424 #define CIRCUIT_PURPOSE_INTRO_POINT 2
425 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
426 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
427 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
428 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
429 #define _CIRCUIT_PURPOSE_OR_MAX 4
431 /* these circuits originate at this node */
433 /* here's how circ client-side purposes work:
434 * normal circuits are C_GENERAL.
435 * circuits that are c_introducing are either on their way to
436 * becoming open, or they are open and waiting for a
437 * suitable rendcirc before they send the intro.
438 * circuits that are c_introduce_ack_wait have sent the intro,
439 * but haven't gotten a response yet.
440 * circuits that are c_establish_rend are either on their way
441 * to becoming open, or they are open and have sent the
442 * establish_rendezvous cell but haven't received an ack.
443 * circuits that are c_rend_ready are open and have received a
444 * rend ack, but haven't heard from bob yet. if they have a
445 * buildstate->pending_final_cpath then they're expecting a
446 * cell from bob, else they're not.
447 * circuits that are c_rend_ready_intro_acked are open, and
448 * some intro circ has sent its intro and received an ack.
449 * circuits that are c_rend_joined are open, have heard from
450 * bob, and are talking to him.
452 /** Client-side circuit purpose: Normal circuit, with cpath. */
453 #define CIRCUIT_PURPOSE_C_GENERAL 5
454 /** Client-side circuit purpose: at Alice, connecting to intro point. */
455 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
456 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
457 * waiting for ACK/NAK. */
458 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
459 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
460 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
461 /** Client-side circuit purpose: at Alice, waiting for ack. */
462 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
463 /** Client-side circuit purpose: at Alice, waiting for Bob. */
464 #define CIRCUIT_PURPOSE_C_REND_READY 10
465 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
466 * has been acknowledged. */
467 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
468 /** Client-side circuit purpose: at Alice, rendezvous established. */
469 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
471 #define _CIRCUIT_PURPOSE_C_MAX 12
473 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
474 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
475 /** Hidden-service-side circuit purpose: at Bob, successfully established
477 #define CIRCUIT_PURPOSE_S_INTRO 14
478 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
479 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
480 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
481 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
482 /** A testing circuit; not meant to be used for actual traffic. */
483 #define CIRCUIT_PURPOSE_TESTING 17
484 /** A controller made this circuit and Tor should not use it. */
485 #define CIRCUIT_PURPOSE_CONTROLLER 18
486 #define _CIRCUIT_PURPOSE_MAX 18
487 /** A catch-all for unrecognized purposes. Currently we don't expect
488 * to make or see any circuits with this purpose. */
489 #define CIRCUIT_PURPOSE_UNKNOWN 255
491 /** True iff the circuit purpose <b>p</b> is for a circuit that
492 * originated at this node. */
493 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
494 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
495 * here to serve as a client. (Hidden services don't count here.) */
496 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
497 ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
498 (p)<=_CIRCUIT_PURPOSE_C_MAX)
499 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
500 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
501 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
503 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
504 ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
505 (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
507 /** How many circuits do we want simultaneously in-progress to handle
509 #define MIN_CIRCUITS_HANDLING_STREAM 2
511 /* These RELAY_COMMAND constants define values for relay cell commands, and
512 * must match those defined in tor-spec.txt. */
513 #define RELAY_COMMAND_BEGIN 1
514 #define RELAY_COMMAND_DATA 2
515 #define RELAY_COMMAND_END 3
516 #define RELAY_COMMAND_CONNECTED 4
517 #define RELAY_COMMAND_SENDME 5
518 #define RELAY_COMMAND_EXTEND 6
519 #define RELAY_COMMAND_EXTENDED 7
520 #define RELAY_COMMAND_TRUNCATE 8
521 #define RELAY_COMMAND_TRUNCATED 9
522 #define RELAY_COMMAND_DROP 10
523 #define RELAY_COMMAND_RESOLVE 11
524 #define RELAY_COMMAND_RESOLVED 12
525 #define RELAY_COMMAND_BEGIN_DIR 13
527 #define RELAY_COMMAND_ESTABLISH_INTRO 32
528 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
529 #define RELAY_COMMAND_INTRODUCE1 34
530 #define RELAY_COMMAND_INTRODUCE2 35
531 #define RELAY_COMMAND_RENDEZVOUS1 36
532 #define RELAY_COMMAND_RENDEZVOUS2 37
533 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
534 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
535 #define RELAY_COMMAND_INTRODUCE_ACK 40
537 /* Reasons why an OR connection is closed. */
538 #define END_OR_CONN_REASON_DONE 1
539 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
540 #define END_OR_CONN_REASON_OR_IDENTITY 3
541 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
542 #define END_OR_CONN_REASON_TIMEOUT 5
543 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
544 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
545 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
546 #define END_OR_CONN_REASON_MISC 9
548 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
549 * documentation of these. The values must match. */
550 #define END_STREAM_REASON_MISC 1
551 #define END_STREAM_REASON_RESOLVEFAILED 2
552 #define END_STREAM_REASON_CONNECTREFUSED 3
553 #define END_STREAM_REASON_EXITPOLICY 4
554 #define END_STREAM_REASON_DESTROY 5
555 #define END_STREAM_REASON_DONE 6
556 #define END_STREAM_REASON_TIMEOUT 7
557 /* 8 is unallocated for historical reasons. */
558 #define END_STREAM_REASON_HIBERNATING 9
559 #define END_STREAM_REASON_INTERNAL 10
560 #define END_STREAM_REASON_RESOURCELIMIT 11
561 #define END_STREAM_REASON_CONNRESET 12
562 #define END_STREAM_REASON_TORPROTOCOL 13
563 #define END_STREAM_REASON_NOTDIRECTORY 14
564 #define END_STREAM_REASON_ENTRYPOLICY 15
566 /* These high-numbered end reasons are not part of the official spec,
567 * and are not intended to be put in relay end cells. They are here
568 * to be more informative when sending back socks replies to the
570 /* XXXX 256 is no longer used; feel free to reuse it. */
571 /** We were unable to attach the connection to any circuit at all. */
572 /* XXXX the ways we use this one don't make a lot of sense. */
573 #define END_STREAM_REASON_CANT_ATTACH 257
574 /** We can't connect to any directories at all, so we killed our streams
575 * before they can time out. */
576 #define END_STREAM_REASON_NET_UNREACHABLE 258
577 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
578 * protocol in a way we couldn't handle. */
579 #define END_STREAM_REASON_SOCKSPROTOCOL 259
580 /** This is a transparent proxy connection, but we can't extract the original
581 * target address:port. */
582 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
583 /** This is a connection on the NATD port, and the destination IP:Port was
584 * either ill-formed or out-of-range. */
585 #define END_STREAM_REASON_INVALID_NATD_DEST 261
587 /** Bitwise-and this value with endreason to mask out all flags. */
588 #define END_STREAM_REASON_MASK 511
590 /** Bitwise-or this with the argument to control_event_stream_status
591 * to indicate that the reason came from an END cell. */
592 #define END_STREAM_REASON_FLAG_REMOTE 512
593 /** Bitwise-or this with the argument to control_event_stream_status
594 * to indicate that we already sent a CLOSED stream event. */
595 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
596 /** Bitwise-or this with endreason to indicate that we already sent
597 * a socks reply, and no further reply needs to be sent from
598 * connection_mark_unattached_ap(). */
599 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
601 /** Reason for remapping an AP connection's address: we have a cached
603 #define REMAP_STREAM_SOURCE_CACHE 1
604 /** Reason for remapping an AP connection's address: the exit node told us an
606 #define REMAP_STREAM_SOURCE_EXIT 2
608 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
609 #define RESOLVED_TYPE_HOSTNAME 0
610 #define RESOLVED_TYPE_IPV4 4
611 #define RESOLVED_TYPE_IPV6 6
612 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
613 #define RESOLVED_TYPE_ERROR 0xF1
615 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
616 * call; they only go to the controller for tracking */
617 /** We couldn't build a path for this circuit. */
618 #define END_CIRC_REASON_NOPATH -2
619 /** Catch-all "other" reason for closing origin circuits. */
620 #define END_CIRC_AT_ORIGIN -1
622 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
623 * documentation of these. */
624 #define _END_CIRC_REASON_MIN 0
625 #define END_CIRC_REASON_NONE 0
626 #define END_CIRC_REASON_TORPROTOCOL 1
627 #define END_CIRC_REASON_INTERNAL 2
628 #define END_CIRC_REASON_REQUESTED 3
629 #define END_CIRC_REASON_HIBERNATING 4
630 #define END_CIRC_REASON_RESOURCELIMIT 5
631 #define END_CIRC_REASON_CONNECTFAILED 6
632 #define END_CIRC_REASON_OR_IDENTITY 7
633 #define END_CIRC_REASON_OR_CONN_CLOSED 8
634 #define END_CIRC_REASON_FINISHED 9
635 #define END_CIRC_REASON_TIMEOUT 10
636 #define END_CIRC_REASON_DESTROYED 11
637 #define END_CIRC_REASON_NOSUCHSERVICE 12
638 #define _END_CIRC_REASON_MAX 12
640 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
641 * control_event_circuit_status() to indicate that the reason was
642 * passed through from a destroy or truncate cell. */
643 #define END_CIRC_REASON_FLAG_REMOTE 512
645 /** Length of 'y' portion of 'y.onion' URL. */
646 #define REND_SERVICE_ID_LEN_BASE32 16
648 /** Length of 'y.onion' including '.onion' URL. */
649 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
651 /** Length of a binary-encoded rendezvous service ID. */
652 #define REND_SERVICE_ID_LEN 10
654 /** Time period for which a v2 descriptor will be valid. */
655 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
657 /** Time period within which two sets of v2 descriptors will be uploaded in
659 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
661 /** Number of non-consecutive replicas (i.e. distributed somewhere
662 * in the ring) for a descriptor. */
663 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
665 /** Number of consecutive replicas for a descriptor. */
666 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
668 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
669 #define REND_DESC_ID_V2_LEN_BASE32 32
671 /** Length of the base32-encoded secret ID part of versioned hidden service
673 #define REND_SECRET_ID_PART_LEN_BASE32 32
675 /** Length of the base32-encoded hash of an introduction point's
677 #define REND_INTRO_POINT_ID_LEN_BASE32 32
679 /** Length of the descriptor cookie that is used for client authorization
680 * to hidden services. */
681 #define REND_DESC_COOKIE_LEN 16
683 /** Length of the base64-encoded descriptor cookie that is used for
684 * exchanging client authorization between hidden service and client. */
685 #define REND_DESC_COOKIE_LEN_BASE64 22
687 /** Length of client identifier in encrypted introduction points for hidden
688 * service authorization type 'basic'. */
689 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
691 /** Multiple of the number of clients to which the real number of clients
692 * is padded with fake clients for hidden service authorization type
694 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
696 /** Length of client entry consisting of client identifier and encrypted
697 * session key for hidden service authorization type 'basic'. */
698 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
701 /** Maximum size of v2 hidden service descriptors. */
702 #define REND_DESC_MAX_SIZE (20 * 1024)
704 /** Legal characters for use in authorized client names for a hidden
706 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
707 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
709 /** Maximum length of authorized client names for a hidden service. */
710 #define REND_CLIENTNAME_MAX_LEN 16
712 /** Length of the rendezvous cookie that is used to connect circuits at the
713 * rendezvous point. */
714 #define REND_COOKIE_LEN DIGEST_LEN
716 /** Client authorization type that a hidden service performs. */
717 typedef enum rend_auth_type_t
{
720 REND_STEALTH_AUTH
= 2,
723 /** Client-side configuration of authorization for a hidden service. */
724 typedef struct rend_service_authorization_t
{
725 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
726 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
727 rend_auth_type_t auth_type
;
728 } rend_service_authorization_t
;
730 /** Client- and server-side data that is used for hidden service connection
731 * establishment. Not all fields contain data depending on where this struct
733 typedef struct rend_data_t
{
734 /** Onion address (without the .onion part) that a client requests. */
735 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
737 /** (Optional) descriptor cookie that is used by a client. */
738 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
740 /** Authorization type for accessing a service used by a client. */
741 rend_auth_type_t auth_type
;
743 /** Hash of the hidden service's PK used by a service. */
744 char rend_pk_digest
[DIGEST_LEN
];
746 /** Rendezvous cookie used by both, client and service. */
747 char rend_cookie
[REND_COOKIE_LEN
];
750 /** Time interval for tracking possible replays of INTRODUCE2 cells.
751 * Incoming cells with timestamps half of this interval in the past or
752 * future are dropped immediately. */
753 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
755 /** Used to indicate which way a cell is going on a circuit. */
757 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
758 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
761 /** Initial value for both sides of a circuit transmission window when the
762 * circuit is initialized. Measured in cells. */
763 #define CIRCWINDOW_START 1000
764 /** Amount to increment a circuit window when we get a circuit SENDME. */
765 #define CIRCWINDOW_INCREMENT 100
766 /** Initial value on both sides of a stream transmission window when the
767 * stream is initialized. Measured in cells. */
768 #define STREAMWINDOW_START 500
769 /** Amount to increment a stream window when we get a stream SENDME. */
770 #define STREAMWINDOW_INCREMENT 50
772 /* Cell commands. These values are defined in tor-spec.txt. */
773 #define CELL_PADDING 0
774 #define CELL_CREATE 1
775 #define CELL_CREATED 2
777 #define CELL_DESTROY 4
778 #define CELL_CREATE_FAST 5
779 #define CELL_CREATED_FAST 6
780 #define CELL_VERSIONS 7
781 #define CELL_NETINFO 8
782 #define CELL_RELAY_EARLY 9
784 /** True iff the cell command <b>x</b> is one that implies a variable-length
786 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
788 /** How long to test reachability before complaining to the user. */
789 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
791 /** Legal characters in a nickname. */
792 #define LEGAL_NICKNAME_CHARACTERS \
793 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
795 /** Name to use in client TLS certificates if no nickname is given. Once
796 * Tor 0.1.2.x is obsolete, we can remove this. */
797 #define DEFAULT_CLIENT_NICKNAME "client"
799 /** Number of bytes in a SOCKS4 header. */
800 #define SOCKS4_NETWORK_LEN 8
804 * Relay command [1 byte]
805 * Recognized [2 bytes]
806 * Stream ID [2 bytes]
807 * Partial SHA-1 [4 bytes]
809 * Relay payload [498 bytes]
812 /** Number of bytes in a cell, minus cell header. */
813 #define CELL_PAYLOAD_SIZE 509
814 /** Number of bytes in a cell transmitted over the network. */
815 #define CELL_NETWORK_SIZE 512
817 /** Length of a header on a variable-length cell. */
818 #define VAR_CELL_HEADER_SIZE 5
820 /** Number of bytes in a relay cell's header (not including general cell
822 #define RELAY_HEADER_SIZE (1+2+2+4+2)
823 /** Largest number of bytes that can fit in a relay cell payload. */
824 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
826 /** Identifies a circuit on an or_connection */
827 typedef uint16_t circid_t
;
828 /** Identifies a stream on a circuit */
829 typedef uint16_t streamid_t
;
831 /** Parsed onion routing cell. All communication between nodes
833 typedef struct cell_t
{
834 circid_t circ_id
; /**< Circuit which received the cell. */
835 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
836 * CELL_DESTROY, etc */
837 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
840 /** Parsed variable-length onion routing cell. */
841 typedef struct var_cell_t
{
844 uint16_t payload_len
;
848 /** A cell as packed for writing to the network. */
849 typedef struct packed_cell_t
{
850 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
851 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
854 /** Number of cells added to a circuit queue including their insertion
855 * time on 10 millisecond detail; used for buffer statistics. */
856 typedef struct insertion_time_elem_t
{
857 struct insertion_time_elem_t
*next
; /**< Next element in queue. */
858 uint32_t insertion_time
; /**< When were cells inserted (in 10 ms steps
859 * starting at 0:00 of the current day)? */
860 unsigned counter
; /**< How many cells were inserted? */
861 } insertion_time_elem_t
;
863 /** Queue of insertion times. */
864 typedef struct insertion_time_queue_t
{
865 struct insertion_time_elem_t
*first
; /**< First element in queue. */
866 struct insertion_time_elem_t
*last
; /**< Last element in queue. */
867 } insertion_time_queue_t
;
869 /** A queue of cells on a circuit, waiting to be added to the
870 * or_connection_t's outbuf. */
871 typedef struct cell_queue_t
{
872 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
873 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
874 int n
; /**< The number of cells in the queue. */
875 insertion_time_queue_t
*insertion_times
; /**< Insertion times of cells. */
878 /** Beginning of a RELAY cell payload. */
880 uint8_t command
; /**< The end-to-end relay command. */
881 uint16_t recognized
; /**< Used to tell whether cell is for us. */
882 streamid_t stream_id
; /**< Which stream is this cell associated with? */
883 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
884 uint16_t length
; /**< How long is the payload body? */
887 typedef struct buf_t buf_t
;
888 typedef struct socks_request_t socks_request_t
;
890 /* Values for connection_t.magic: used to make sure that downcasts (casts from
891 * connection_t to foo_connection_t) are safe. */
892 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
893 #define OR_CONNECTION_MAGIC 0x7D31FF03u
894 #define EDGE_CONNECTION_MAGIC 0xF0374013u
895 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
896 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
898 /** Description of a connection to another host or process, and associated
901 * A connection is named based on what it's connected to -- an "OR
902 * connection" has a Tor node on the other end, an "exit
903 * connection" has a website or other server on the other end, and an
904 * "AP connection" has an application proxy (and thus a user) on the
907 * Every connection has a type and a state. Connections never change
908 * their type, but can go through many state changes in their lifetime.
910 * Every connection has two associated input and output buffers.
911 * Listeners don't use them. For non-listener connections, incoming
912 * data is appended to conn->inbuf, and outgoing data is taken from
913 * conn->outbuf. Connections differ primarily in the functions called
914 * to fill and drain these buffers.
916 typedef struct connection_t
{
917 uint32_t magic
; /**< For memory debugging: must equal one of
918 * *_CONNECTION_MAGIC. */
920 uint8_t state
; /**< Current state of this connection. */
921 unsigned int type
:4; /**< What kind of connection is this? */
922 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
924 /* The next fields are all one-bit booleans. Some are only applicable to
925 * connection subtypes, but we hold them here anyway, to save space.
927 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
928 * again once the bandwidth throttler allows it? */
929 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
930 * again once the bandwidth throttler allows
932 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
933 * marked for close, do we flush it
934 * before closing it? */
935 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
937 /** Set to 1 when we're inside connection_flushed_some to keep us from
938 * calling connection_handle_write() recursively. */
939 unsigned int in_flushed_some
:1;
941 /* For linked connections:
943 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
944 /** True iff we'd like to be notified about read events from the
946 unsigned int reading_from_linked_conn
:1;
947 /** True iff we're willing to write to the linked conn. */
948 unsigned int writing_to_linked_conn
:1;
949 /** True iff we're currently able to read on the linked conn, and our
950 * read_event should be made active with libevent. */
951 unsigned int active_on_link
:1;
952 /** True iff we've called connection_close_immediate() on this linked
954 unsigned int linked_conn_is_closed
:1;
956 /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
957 unsigned int proxy_state
:4;
959 /** Our socket; -1 if this connection is closed, or has no socket. */
961 int conn_array_index
; /**< Index into the global connection array. */
962 struct event
*read_event
; /**< Libevent event structure. */
963 struct event
*write_event
; /**< Libevent event structure. */
964 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
965 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
966 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
968 time_t timestamp_lastread
; /**< When was the last time libevent said we could
970 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
972 time_t timestamp_created
; /**< When was this connection_t created? */
974 /* XXXX_IP6 make this IPv6-capable */
975 int socket_family
; /**< Address family of this connection's socket. Usually
976 * AF_INET, but it can also be AF_UNIX, or in the future
978 tor_addr_t addr
; /**< IP of the other side of the connection; used to
979 * identify routers, along with port. */
980 uint16_t port
; /**< If non-zero, port on the other end
981 * of the connection. */
982 uint16_t marked_for_close
; /**< Should we close this conn on the next
983 * iteration of the main loop? (If true, holds
984 * the line number where this connection was
986 const char *marked_for_close_file
; /**< For debugging: in which file were
987 * we marked for close? */
988 char *address
; /**< FQDN (or IP) of the guy on the other end.
989 * strdup into this, because free_connection() frees it. */
990 /** Another connection that's connected to this one in lieu of a socket. */
991 struct connection_t
*linked_conn
;
993 /** Unique identifier for this connection on this Tor instance. */
994 uint64_t global_identifier
;
996 /* XXXX022 move this field, and all the listener-only fields (just
997 socket_family, I think), into a new listener_connection_t subtype. */
998 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
999 * to the evdns_server_port is uses to listen to and answer connections. */
1000 struct evdns_server_port
*dns_server_port
;
1002 /** Unique ID for measuring tunneled network status requests. */
1006 /** Stores flags and information related to the portion of a v2 Tor OR
1007 * connection handshake that happens after the TLS handshake is finished.
1009 typedef struct or_handshake_state_t
{
1010 /** When was the VERSIONS cell sent on this connection? Used to get
1011 * an estimate of the skew in the returning NETINFO reply. */
1012 time_t sent_versions_at
;
1013 /** True iff we originated this connection */
1014 unsigned int started_here
: 1;
1015 /** True iff we have received and processed a VERSIONS cell. */
1016 unsigned int received_versions
: 1;
1017 } or_handshake_state_t
;
1019 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
1020 * cells over TLS. */
1021 typedef struct or_connection_t
{
1024 /** Hash of the public RSA key for the other side's identity key, or zeroes
1025 * if the other side hasn't shown us a valid identity key. */
1026 char identity_digest
[DIGEST_LEN
];
1027 char *nickname
; /**< Nickname of OR on other side (if any). */
1029 tor_tls_t
*tls
; /**< TLS connection state. */
1030 int tls_error
; /**< Last tor_tls error code. */
1031 /** When we last used this conn for any client traffic. If not
1032 * recent, we can rate limit it further. */
1035 tor_addr_t real_addr
; /**< The actual address that this connection came from
1036 * or went to. The <b>addr</b> field is prone to
1037 * getting overridden by the address from the router
1038 * descriptor matching <b>identity_digest</b>. */
1040 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1041 * connection, which half of the space should
1043 /** Should this connection be used for extending circuits to the server
1044 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1045 * sure we aren't getting MITMed, either because we're connected to an
1046 * address listed in a server descriptor, or because an authenticated
1047 * NETINFO cell listed the address we're connected to as recognized. */
1048 unsigned int is_canonical
:1;
1049 /** True iff this connection shouldn't get any new circs attached to it,
1050 * because the connection is too old, or because there's a better one, etc.
1052 unsigned int is_bad_for_new_circs
:1;
1053 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1054 * "none negotiated yet." */
1055 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1056 * this connection? This is always in the
1057 * range 0..1<<15-1. */
1059 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1060 * up, state information to do so. */
1061 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1062 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1063 * non-padding cell to the outbuf? */
1065 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
1066 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1067 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1068 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1069 * add 'bandwidthrate' to this, capping it at
1070 * bandwidthburst. (OPEN ORs only) */
1071 int n_circuits
; /**< How many circuits use this connection as p_conn or
1074 /** Double-linked ring of circuits with queued cells waiting for room to
1075 * free up on this connection's outbuf. Every time we pull cells from a
1076 * circuit, we advance this pointer to the next circuit in the ring. */
1077 struct circuit_t
*active_circuits
;
1078 /** Priority queue of cell_ewma_t for circuits with queued cells waiting for
1079 * room to free up on this connection's outbuf. Kept in heap order
1080 * according to EWMA.
1082 * This is redundant with active_circuits; if we ever decide only to use the
1083 * cell_ewma algorithm for choosing circuits, we can remove active_circuits.
1085 smartlist_t
*active_circuit_pqueue
;
1086 /** The tick on which the cell_ewma_ts in active_circuit_pqueue last had
1087 * their ewma values rescaled. */
1088 unsigned active_circuit_pqueue_last_recalibrated
;
1089 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1090 * identity digest as this one. */
1093 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1094 * connection, or an exit. */
1095 typedef struct edge_connection_t
{
1098 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1100 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1101 * this conn exits at. */
1102 int package_window
; /**< How many more relay cells can I send into the
1104 int deliver_window
; /**< How many more relay cells can end at me? */
1106 /** Nickname of planned exit node -- used with .exit support. */
1107 char *chosen_exit_name
;
1109 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1111 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1112 * connection is using. */
1114 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1115 * connection. Exit connections only. */
1117 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1120 /** The reason why this connection is closing; passed to the controller. */
1121 uint16_t end_reason
;
1123 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1126 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1129 /** What rendezvous service are we querying for? (AP only) */
1130 rend_data_t
*rend_data
;
1132 /** Number of times we've reassigned this application connection to
1133 * a new circuit. We keep track because the timeout is longer if we've
1134 * already retried several times. */
1135 uint8_t num_socks_retries
;
1137 /** True iff this connection is for a DNS request only. */
1138 unsigned int is_dns_request
:1;
1140 /** True iff this stream must attach to a one-hop circuit (e.g. for
1142 unsigned int want_onehop
:1;
1143 /** True iff this stream should use a BEGIN_DIR relay command to establish
1144 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1145 unsigned int use_begindir
:1;
1147 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1148 * connections. Set once we've set the stream end,
1149 * and check in connection_about_to_close_connection().
1151 /** True iff we've blocked reading until the circuit has fewer queued
1153 unsigned int edge_blocked_on_circ
:1;
1154 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1155 * stop requiring it. */
1156 unsigned int chosen_exit_optional
:1;
1157 /** For AP connections only. If non-zero, this exit node was picked as
1158 * a result of the TrackHostExit, and the value decrements every time
1159 * we fail to complete a circuit to our chosen exit -- if it reaches
1160 * zero, abandon the associated mapaddress. */
1161 unsigned int chosen_exit_retries
:3;
1163 /** If this is a DNSPort connection, this field holds the pending DNS
1164 * request that we're going to try to answer. */
1165 struct evdns_server_request
*dns_server_request
;
1167 } edge_connection_t
;
1169 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1170 * connection to retrieve or serve directory material. */
1171 typedef struct dir_connection_t
{
1174 char *requested_resource
; /**< Which 'resource' did we ask the directory
1176 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1178 /* Used only for server sides of some dir connections, to implement
1179 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1180 * to append everything to the outbuf in one enormous chunk. */
1181 /** What exactly are we spooling right now? */
1183 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1184 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1185 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
,
1186 DIR_SPOOL_MICRODESC
, /* NOTE: if we add another entry, add another bit. */
1187 } dir_spool_src
: 3;
1188 /** If we're fetching descriptors, what router purpose shall we assign
1190 uint8_t router_purpose
;
1191 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1192 smartlist_t
*fingerprint_stack
;
1193 /** A cached_dir_t object that we're currently spooling out */
1194 struct cached_dir_t
*cached_dir
;
1195 /** The current offset into cached_dir. */
1196 off_t cached_dir_offset
;
1197 /** The zlib object doing on-the-fly compression for spooled data. */
1198 tor_zlib_state_t
*zlib_state
;
1200 /** What rendezvous service are we querying for? */
1201 rend_data_t
*rend_data
;
1203 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1204 * the directory server's signing key. */
1208 /** Subtype of connection_t for an connection to a controller. */
1209 typedef struct control_connection_t
{
1212 uint32_t event_mask
; /**< Bitfield: which events does this controller
1215 /** True if we have sent a protocolinfo reply on this connection. */
1216 unsigned int have_sent_protocolinfo
:1;
1218 /** Amount of space allocated in incoming_cmd. */
1219 uint32_t incoming_cmd_len
;
1220 /** Number of bytes currently stored in incoming_cmd. */
1221 uint32_t incoming_cmd_cur_len
;
1222 /** A control command that we're reading from the inbuf, but which has not
1223 * yet arrived completely. */
1225 } control_connection_t
;
1227 /** Cast a connection_t subtype pointer to a connection_t **/
1228 #define TO_CONN(c) (&(((c)->_base)))
1229 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1230 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1232 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1234 static or_connection_t
*TO_OR_CONN(connection_t
*);
1235 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1237 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1238 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1240 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1241 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1243 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1245 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1247 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1248 return DOWNCAST(or_connection_t
, c
);
1250 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1252 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1253 return DOWNCAST(dir_connection_t
, c
);
1255 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1257 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1258 return DOWNCAST(edge_connection_t
, c
);
1260 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1262 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1263 return DOWNCAST(control_connection_t
, c
);
1266 /** What action type does an address policy indicate: accept or reject? */
1268 ADDR_POLICY_ACCEPT
=1,
1269 ADDR_POLICY_REJECT
=2,
1270 } addr_policy_action_t
;
1272 /** A reference-counted address policy rule. */
1273 typedef struct addr_policy_t
{
1274 int refcnt
; /**< Reference count */
1275 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1276 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1278 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1279 * copy (stored in a hash table to avoid
1280 * duplication of common policies) */
1281 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1282 * first <b>maskbits</b> bits of <b>a</b> match
1284 tor_addr_t addr
; /**< Base address to accept or reject. */
1285 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1286 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1289 /** A cached_dir_t represents a cacheable directory object, along with its
1290 * compressed form. */
1291 typedef struct cached_dir_t
{
1292 char *dir
; /**< Contents of this object, NUL-terminated. */
1293 char *dir_z
; /**< Compressed contents of this object. */
1294 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1295 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1296 time_t published
; /**< When was this object published. */
1297 digests_t digests
; /**< Digests of this object (networkstatus only) */
1298 int refcnt
; /**< Reference count for this cached_dir_t. */
1301 /** Enum used to remember where a signed_descriptor_t is stored and how to
1302 * manage the memory for signed_descriptor_body. */
1304 /** The descriptor isn't stored on disk at all: the copy in memory is
1305 * canonical; the saved_offset field is meaningless. */
1307 /** The descriptor is stored in the cached_routers file: the
1308 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1309 * saved_offset are used to index into the mmaped cache file. */
1311 /** The descriptor is stored in the cached_routers.new file: the
1312 * signed_descriptor_body and saved_offset fields are both set. */
1313 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1314 * lazy-load the descriptor text by using seek and read. We don't, for
1320 /** Enumeration: what kind of download schedule are we using for a given
1323 DL_SCHED_GENERIC
= 0,
1324 DL_SCHED_CONSENSUS
= 1,
1325 DL_SCHED_BRIDGE
= 2,
1326 } download_schedule_t
;
1328 /** Information about our plans for retrying downloads for a downloadable
1330 typedef struct download_status_t
{
1331 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1333 uint8_t n_download_failures
; /**< Number of failures trying to download the
1334 * most recent descriptor. */
1335 download_schedule_t schedule
: 8;
1336 } download_status_t
;
1338 /** If n_download_failures is this high, the download can never happen. */
1339 #define IMPOSSIBLE_TO_DOWNLOAD 255
1341 /** The max size we expect router descriptor annotations we create to
1342 * be. We'll accept larger ones if we see them on disk, but we won't
1343 * create any that are larger than this. */
1344 #define ROUTER_ANNOTATION_BUF_LEN 256
1346 /** Information need to cache an onion router's descriptor. */
1347 typedef struct signed_descriptor_t
{
1348 /** Pointer to the raw server descriptor, preceded by annotations. Not
1349 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1350 * pointer is null. */
1351 char *signed_descriptor_body
;
1352 /** Length of the annotations preceding the server descriptor. */
1353 size_t annotations_len
;
1354 /** Length of the server descriptor. */
1355 size_t signed_descriptor_len
;
1356 /** Digest of the server descriptor, computed as specified in
1358 char signed_descriptor_digest
[DIGEST_LEN
];
1359 /** Identity digest of the router. */
1360 char identity_digest
[DIGEST_LEN
];
1361 /** Declared publication time of the descriptor. */
1362 time_t published_on
;
1363 /** For routerdescs only: digest of the corresponding extrainfo. */
1364 char extra_info_digest
[DIGEST_LEN
];
1365 /** For routerdescs only: Status of downloading the corresponding
1367 download_status_t ei_dl_status
;
1368 /** Where is the descriptor saved? */
1369 saved_location_t saved_location
;
1370 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1371 * this descriptor in the corresponding file. */
1373 /** What position is this descriptor within routerlist->routers or
1374 * routerlist->old_routers? -1 for none. */
1375 int routerlist_index
;
1376 /** The valid-until time of the most recent consensus that listed this
1377 * descriptor, or a bit after the publication time of the most recent v2
1378 * networkstatus that listed it. 0 for "never listed in a consensus or
1379 * status, so far as we know." */
1380 time_t last_listed_as_valid_until
;
1381 #ifdef TRACK_SERVED_TIME
1382 /** The last time we served anybody this descriptor. Used for internal
1383 * testing to see whether we're holding on to descriptors too long. */
1384 time_t last_served_at
; /*XXXX remove if not useful. */
1386 /* If true, we do not ever try to save this object in the cache. */
1387 unsigned int do_not_cache
: 1;
1388 /* If true, this item is meant to represent an extrainfo. */
1389 unsigned int is_extrainfo
: 1;
1390 /* If true, we got an extrainfo for this item, and the digest was right,
1391 * but it was incompatible. */
1392 unsigned int extrainfo_is_bogus
: 1;
1393 /* If true, we are willing to transmit this item unencrypted. */
1394 unsigned int send_unencrypted
: 1;
1395 } signed_descriptor_t
;
1397 /** A signed integer representing a country code. */
1398 typedef int16_t country_t
;
1400 /** Information about another onion router in the network. */
1402 signed_descriptor_t cache_info
;
1403 char *address
; /**< Location of OR: either a hostname or an IP address. */
1404 char *nickname
; /**< Human-readable OR name. */
1406 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1407 uint16_t or_port
; /**< Port for TLS connections. */
1408 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1410 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1411 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1413 char *platform
; /**< What software/operating system is this OR using? */
1416 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1417 * bucket per second? */
1418 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1419 /** How many bytes/s is this router known to handle? */
1420 uint32_t bandwidthcapacity
;
1421 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1422 * to exit? NULL for 'reject *:*'. */
1423 long uptime
; /**< How many seconds the router claims to have been up */
1424 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1425 * claims are its family. */
1426 char *contact_info
; /**< Declared contact info for this router. */
1427 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1429 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1430 * dnsworker code. */
1431 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1432 * extrainfo documents. */
1433 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1434 * single hop exits. */
1437 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1439 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1440 * (For Authdir: Have we validated this OR?)
1442 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1444 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1445 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1446 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1447 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1448 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1449 * or otherwise nasty? */
1450 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1451 * underpowered, or otherwise useless? */
1452 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1453 * a hidden service directory. */
1454 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1455 * directory according to the authorities. */
1456 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1457 * router rejects everything. */
1459 /** Tor can use this router for general positions in circuits. */
1460 #define ROUTER_PURPOSE_GENERAL 0
1461 /** Tor should avoid using this router for circuit-building. */
1462 #define ROUTER_PURPOSE_CONTROLLER 1
1463 /** Tor should use this router only for bridge positions in circuits. */
1464 #define ROUTER_PURPOSE_BRIDGE 2
1465 /** Tor should not use this router; it was marked in cached-descriptors with
1466 * a purpose we didn't recognize. */
1467 #define ROUTER_PURPOSE_UNKNOWN 255
1469 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1471 /* The below items are used only by authdirservers for
1472 * reachability testing. */
1473 /** When was the last time we could reach this OR? */
1474 time_t last_reachable
;
1475 /** When did we start testing reachability for this OR? */
1476 time_t testing_since
;
1477 /** According to the geoip db what country is this router in? */
1481 /** Information needed to keep and cache a signed extra-info document. */
1482 typedef struct extrainfo_t
{
1483 signed_descriptor_t cache_info
;
1484 /** The router's nickname. */
1485 char nickname
[MAX_NICKNAME_LEN
+1];
1486 /** True iff we found the right key for this extra-info, verified the
1487 * signature, and found it to be bad. */
1488 unsigned int bad_sig
: 1;
1489 /** If present, we didn't have the right key to verify this extra-info,
1490 * so this is a copy of the signature in the document. */
1492 /** Length of pending_sig. */
1493 size_t pending_sig_len
;
1496 /** Contents of a single router entry in a network status object.
1498 typedef struct routerstatus_t
{
1499 time_t published_on
; /**< When was this router published? */
1500 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1502 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1504 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1506 uint32_t addr
; /**< IPv4 address for this router. */
1507 uint16_t or_port
; /**< OR port for this router. */
1508 uint16_t dir_port
; /**< Directory port for this router. */
1509 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1510 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1511 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1512 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1513 unsigned int is_running
:1; /**< True iff this router is up. */
1514 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1515 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1517 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1518 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1519 * information with v2 of the directory
1520 * protocol. (All directory caches cache v1
1522 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1523 * choice as an entry guard. */
1524 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1526 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1527 * underpowered, or otherwise useless? */
1528 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1529 * service directory. */
1530 /** True iff we know version info for this router. (i.e., a "v" entry was
1531 * included.) We'll replace all these with a big tor_version_t or a char[]
1532 * if the number of traits we care about ever becomes incredibly big. */
1533 unsigned int version_known
:1;
1534 /** True iff this router is a version that supports BEGIN_DIR cells. */
1535 unsigned int version_supports_begindir
:1;
1536 /** True iff this router is a version that supports conditional consensus
1537 * downloads (signed by list of authorities). */
1538 unsigned int version_supports_conditional_consensus
:1;
1539 /** True iff this router is a version that we can post extrainfo docs to. */
1540 unsigned int version_supports_extrainfo_upload
:1;
1541 /** True iff this router is a version that, if it caches directory info,
1542 * we can get v3 downloads from. */
1543 unsigned int version_supports_v3_dir
:1;
1545 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1546 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1547 unsigned int has_measured_bw
:1; /**< The vote/consensus had a measured bw */
1549 uint32_t measured_bw
; /**< Measured bandwidth (capacity) of the router */
1551 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1552 * the vote/consensus, in kilobytes/sec. */
1553 char *exitsummary
; /**< exit policy summary -
1554 * XXX weasel: this probably should not stay a string. */
1556 /* ---- The fields below aren't derived from the networkstatus; they
1557 * hold local information only. */
1559 /** True if we, as a directory mirror, want to download the corresponding
1560 * routerinfo from the authority who gave us this routerstatus. (That is,
1561 * if we don't have the routerinfo, and if we haven't already tried to get it
1562 * from this authority.) Applies in v2 networkstatus document only.
1564 unsigned int need_to_mirror
:1;
1565 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1566 * to this (unnamed) router by nickname?
1568 time_t last_dir_503_at
; /**< When did this router last tell us that it
1569 * was too busy to serve directory info? */
1570 download_status_t dl_status
;
1574 /** A microdescriptor is the smallest amount of information needed to build a
1575 * circuit through a router. They are generated by the directory authorities,
1576 * using information from the uploaded routerinfo documents. They are not
1577 * self-signed, but are rather authenticated by having their hash in a signed
1578 * networkstatus document. */
1579 typedef struct microdesc_t
{
1580 /** Hashtable node, used to look up the microdesc by its digest. */
1581 HT_ENTRY(microdesc_t
) node
;
1583 /* Cache information */
1585 /** When was this microdescriptor last listed in a consensus document?
1586 * Once a microdesc has been unlisted long enough, we can drop it.
1589 /** Where is this microdescriptor currently stored? */
1590 saved_location_t saved_location
: 3;
1591 /** If true, do not attempt to cache this microdescriptor on disk. */
1592 unsigned int no_save
: 1;
1593 /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
1594 * microdescriptor in the cache. */
1597 /* The string containing the microdesc. */
1599 /** A pointer to the encoded body of the microdescriptor. If the
1600 * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
1601 * mmap'd region. Otherwise, it is a malloc'd string. The string might not
1602 * be NUL-terminated; take the length from <b>bodylen</b>. */
1604 /** The length of the microdescriptor in <b>body</b>. */
1606 /** A SHA256-digest of the microdescriptor. */
1607 char digest
[DIGEST256_LEN
];
1609 /* Fields in the microdescriptor. */
1611 /** As routerinfo_t.onion_pkey */
1612 crypto_pk_env_t
*onion_pkey
;
1613 /** As routerinfo_t.family */
1614 smartlist_t
*family
;
1615 /** Encoded exit policy summary */
1616 char *exitsummary
; /**< exit policy summary -
1617 * XXX this probably should not stay a string. */
1620 /** How many times will we try to download a router's descriptor before giving
1622 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1624 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1625 typedef struct networkstatus_v2_t
{
1626 /** When did we receive the network-status document? */
1629 /** What was the digest of the document? */
1630 char networkstatus_digest
[DIGEST_LEN
];
1632 /* These fields come from the actual network-status document.*/
1633 time_t published_on
; /**< Declared publication date. */
1635 char *source_address
; /**< Canonical directory server hostname. */
1636 uint32_t source_addr
; /**< Canonical directory server IP. */
1637 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1639 unsigned int binds_names
:1; /**< True iff this directory server binds
1641 unsigned int recommends_versions
:1; /**< True iff this directory server
1642 * recommends client and server software
1644 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1645 * malfunctioning exits as bad. */
1646 /** True iff this directory server marks malfunctioning directories as
1648 unsigned int lists_bad_directories
:1;
1650 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1651 char *contact
; /**< How to contact directory admin? (may be NULL). */
1652 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1653 char *client_versions
; /**< comma-separated list of recommended client
1655 char *server_versions
; /**< comma-separated list of recommended server
1658 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1659 * sorted by identity_digest. */
1660 } networkstatus_v2_t
;
1662 typedef struct vote_microdesc_hash_t
{
1663 struct vote_microdesc_hash_t
*next
;
1664 char *microdesc_hash_line
;
1665 } vote_microdesc_hash_t
;
1667 /** The claim about a single router, made in a vote. */
1668 typedef struct vote_routerstatus_t
{
1669 routerstatus_t status
; /**< Underlying 'status' object for this router.
1670 * Flags are redundant. */
1671 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1672 * networkstatus_t.known_flags. */
1673 char *version
; /**< The version that the authority says this router is
1675 vote_microdesc_hash_t
*microdesc
;
1676 } vote_routerstatus_t
;
1678 /** A signature of some document by an authority. */
1679 typedef struct document_signature_t
{
1680 /** Declared SHA-1 digest of this voter's identity key */
1681 char identity_digest
[DIGEST_LEN
];
1682 /** Declared SHA-1 digest of signing key used by this voter. */
1683 char signing_key_digest
[DIGEST_LEN
];
1684 /** Algorithm used to compute the digest of the document. */
1685 digest_algorithm_t alg
;
1686 /** Signature of the signed thing. */
1688 /** Length of <b>signature</b> */
1690 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1691 * the sig, and we know it's bad. */
1692 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1694 } document_signature_t
;
1696 /** Information about a single voter in a vote or a consensus. */
1697 typedef struct networkstatus_voter_info_t
{
1698 /** Declared SHA-1 digest of this voter's identity key */
1699 char identity_digest
[DIGEST_LEN
];
1700 char *nickname
; /**< Nickname of this voter */
1701 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
1702 * consensuses, we treat legacy keys as additional signers. */
1703 char legacy_id_digest
[DIGEST_LEN
];
1704 char *address
; /**< Address of this voter, in string format. */
1705 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1706 uint16_t dir_port
; /**< Directory port of this voter */
1707 uint16_t or_port
; /**< OR port of this voter */
1708 char *contact
; /**< Contact information for this voter. */
1709 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1711 /* Nothing from here on is signed. */
1712 /** The signature of the document and the signature's status. */
1714 } networkstatus_voter_info_t
;
1716 /** Enumerates the possible seriousness values of a networkstatus document. */
1721 } networkstatus_type_t
;
1723 /** Enumerates recognized flavors of a consensus networkstatus document. All
1724 * flavors of a consensus are generated from the same set of votes, but they
1725 * present different types information to different versions of Tor. */
1729 } consensus_flavor_t
;
1731 /** Which consensus flavor do we actually want to use to build circuits? */
1732 #define USABLE_CONSENSUS_FLAVOR FLAV_NS
1734 /** How many different consensus flavors are there? */
1735 #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
1737 /** A common structure to hold a v3 network status vote, or a v3 network
1738 * status consensus. */
1739 typedef struct networkstatus_t
{
1740 networkstatus_type_t type
: 8; /**< Vote, consensus, or opinion? */
1741 consensus_flavor_t flavor
: 8; /**< If a consensus, what kind? */
1742 time_t published
; /**< Vote only: Time when vote was written. */
1743 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1744 time_t fresh_until
; /**< Time before which this is the most recent vote or
1746 time_t valid_until
; /**< Time after which this vote or consensus should not
1749 /** Consensus only: what method was used to produce this consensus? */
1750 int consensus_method
;
1751 /** Vote only: what methods is this voter willing to use? */
1752 smartlist_t
*supported_methods
;
1754 /** How long does this vote/consensus claim that authorities take to
1755 * distribute their votes to one another? */
1757 /** How long does this vote/consensus claim that authorities take to
1758 * distribute their consensus signatures to one another? */
1761 /** Comma-separated list of recommended client software, or NULL if this
1762 * voter has no opinion. */
1763 char *client_versions
;
1764 char *server_versions
;
1765 /** List of flags that this vote/consensus applies to routers. If a flag is
1766 * not listed here, the voter has no opinion on what its value should be. */
1767 smartlist_t
*known_flags
;
1769 /** List of key=value strings for the parameters in this vote or
1770 * consensus, sorted by key. */
1771 smartlist_t
*net_params
;
1773 /** List of networkstatus_voter_info_t. For a vote, only one element
1774 * is included. For a consensus, one element is included for every voter
1775 * whose vote contributed to the consensus. */
1776 smartlist_t
*voters
;
1778 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1780 /** Digests of this document, as signed. */
1783 /** List of router statuses, sorted by identity digest. For a vote,
1784 * the elements are vote_routerstatus_t; for a consensus, the elements
1785 * are routerstatus_t. */
1786 smartlist_t
*routerstatus_list
;
1788 /** If present, a map from descriptor digest to elements of
1789 * routerstatus_list. */
1790 digestmap_t
*desc_digest_map
;
1793 /** A set of signatures for a networkstatus consensus. Unless otherwise
1794 * noted, all fields are as for networkstatus_t. */
1795 typedef struct ns_detached_signatures_t
{
1799 strmap_t
*digests
; /**< Map from flavor name to digestset_t */
1800 strmap_t
*signatures
; /**< Map from flavor name to list of
1801 * document_signature_t */
1802 } ns_detached_signatures_t
;
1804 /** Allowable types of desc_store_t. */
1805 typedef enum store_type_t
{
1810 /** A 'store' is a set of descriptors saved on disk, with accompanying
1811 * journal, mmaped as needed, rebuilt as needed. */
1812 typedef struct desc_store_t
{
1813 /** Filename (within DataDir) for the store. We append .tmp to this
1814 * filename for a temporary file when rebuilding the store, and .new to this
1815 * filename for the journal. */
1816 const char *fname_base
;
1817 /** Alternative (obsolete) value for fname_base: if the file named by
1818 * fname_base isn't present, we read from here instead, but we never write
1820 const char *fname_alt_base
;
1821 /** Human-readable description of what this store contains. */
1822 const char *description
;
1824 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1826 store_type_t type
; /**< What's stored in this store? */
1828 /** The size of the router log, in bytes. */
1830 /** The size of the router store, in bytes. */
1832 /** Total bytes dropped since last rebuild: this is space currently
1833 * used in the cache and the journal that could be freed by a rebuild. */
1834 size_t bytes_dropped
;
1837 /** Contents of a directory of onion routers. */
1839 /** Map from server identity digest to a member of routers. */
1840 struct digest_ri_map_t
*identity_map
;
1841 /** Map from server descriptor digest to a signed_descriptor_t from
1842 * routers or old_routers. */
1843 struct digest_sd_map_t
*desc_digest_map
;
1844 /** Map from extra-info digest to an extrainfo_t. Only exists for
1845 * routers in routers or old_routers. */
1846 struct digest_ei_map_t
*extra_info_map
;
1847 /** Map from extra-info digests to a signed_descriptor_t for a router
1848 * descriptor having that extra-info digest. Only exists for
1849 * routers in routers or old_routers. */
1850 struct digest_sd_map_t
*desc_by_eid_map
;
1851 /** List of routerinfo_t for all currently live routers we know. */
1852 smartlist_t
*routers
;
1853 /** List of signed_descriptor_t for older router descriptors we're
1855 smartlist_t
*old_routers
;
1856 /** Store holding server descriptors. If present, any router whose
1857 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1858 * starting at cache_info.saved_offset */
1859 desc_store_t desc_store
;
1860 /** Store holding extra-info documents. */
1861 desc_store_t extrainfo_store
;
1864 /** Information on router used when extending a circuit. We don't need a
1865 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1866 * connection, and onion_key to create the onionskin. Note that for onehop
1867 * general-purpose tunnels, the onion_key is NULL. */
1868 typedef struct extend_info_t
{
1869 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1871 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1872 uint16_t port
; /**< OR port. */
1873 tor_addr_t addr
; /**< IP address. */
1874 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1877 /** Certificate for v3 directory protocol: binds long-term authority identity
1878 * keys to medium-term authority signing keys. */
1879 typedef struct authority_cert_t
{
1880 /** Information relating to caching this cert on disk and looking it up. */
1881 signed_descriptor_t cache_info
;
1882 /** This authority's long-term authority identity key. */
1883 crypto_pk_env_t
*identity_key
;
1884 /** This authority's medium-term signing key. */
1885 crypto_pk_env_t
*signing_key
;
1886 /** The digest of <b>signing_key</b> */
1887 char signing_key_digest
[DIGEST_LEN
];
1888 /** The listed expiration time of this certificate. */
1890 /** This authority's IPv4 address, in host order. */
1892 /** This authority's directory port. */
1894 /** True iff this certificate was cross-certified by signing the identity
1895 * key with the signing key. */
1896 uint8_t is_cross_certified
;
1899 /** Bitfield enum type listing types of directory authority/directory
1903 /** Serves/signs v1 directory information: Big lists of routers, and short
1904 * routerstatus documents. */
1905 V1_AUTHORITY
= 1 << 0,
1906 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
1907 V2_AUTHORITY
= 1 << 1,
1908 /** Serves/signs v3 directory information: votes, consensuses, certs */
1909 V3_AUTHORITY
= 1 << 2,
1910 /** Serves hidden service descriptors. */
1911 HIDSERV_AUTHORITY
= 1 << 3,
1912 /** Serves bridge descriptors. */
1913 BRIDGE_AUTHORITY
= 1 << 4,
1914 /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
1915 EXTRAINFO_CACHE
= 1 << 5,
1918 #define CRYPT_PATH_MAGIC 0x70127012u
1920 /** Holds accounting information for a single step in the layered encryption
1921 * performed by a circuit. Used only at the client edge of a circuit. */
1922 typedef struct crypt_path_t
{
1925 /* crypto environments */
1926 /** Encryption key and counter for cells heading towards the OR at this
1928 crypto_cipher_env_t
*f_crypto
;
1929 /** Encryption key and counter for cells heading back from the OR at this
1931 crypto_cipher_env_t
*b_crypto
;
1933 /** Digest state for cells heading towards the OR at this step. */
1934 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1935 /** Digest state for cells heading away from the OR at this step. */
1936 crypto_digest_env_t
*b_digest
;
1938 /** Current state of Diffie-Hellman key negotiation with the OR at this
1940 crypto_dh_env_t
*dh_handshake_state
;
1941 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1942 * step. Used to save CPU when TLS is already providing all the
1943 * authentication, secrecy, and integrity we need, and we're already
1944 * distinguishable from an OR.
1946 char fast_handshake_state
[DIGEST_LEN
];
1947 /** Negotiated key material shared with the OR at this step. */
1948 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1950 /** Information to extend to the OR at this step. */
1951 extend_info_t
*extend_info
;
1953 /** Is the circuit built to this step? Must be one of:
1954 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1955 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1956 * and not received an EXTENDED/CREATED)
1957 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1959 #define CPATH_STATE_CLOSED 0
1960 #define CPATH_STATE_AWAITING_KEYS 1
1961 #define CPATH_STATE_OPEN 2
1962 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1963 * (The list is circular, so the last node
1964 * links to the first.) */
1965 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1968 int package_window
; /**< How many cells are we allowed to originate ending
1970 int deliver_window
; /**< How many cells are we willing to deliver originating
1974 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1976 #define DH_KEY_LEN DH_BYTES
1977 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1980 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1982 /** Information used to build a circuit. */
1984 /** Intended length of the final circuit. */
1985 int desired_path_len
;
1986 /** How to extend to the planned exit node. */
1987 extend_info_t
*chosen_exit
;
1988 /** Whether every node in the circ must have adequate uptime. */
1990 /** Whether every node in the circ must have adequate capacity. */
1992 /** Whether the last hop was picked with exiting in mind. */
1994 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1995 * These are for encrypted connections that exit to this router, not
1996 * for arbitrary exits from the circuit. */
1998 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1999 crypt_path_t
*pending_final_cpath
;
2000 /** How many times has building a circuit for this task failed? */
2002 /** At what time should we give up on this task? */
2004 } cpath_build_state_t
;
2007 * The cell_ewma_t structure keeps track of how many cells a circuit has
2008 * transferred recently. It keeps an EWMA (exponentially weighted moving
2009 * average) of the number of cells flushed from the circuit queue onto a
2010 * connection in connection_or_flush_from_first_active_circuit().
2013 /** The last 'tick' at which we recalibrated cell_count.
2015 * A cell sent at exactly the start of this tick has weight 1.0. Cells sent
2016 * since the start of this tick have weight greater than 1.0; ones sent
2017 * earlier have less weight. */
2018 unsigned last_adjusted_tick
;
2019 /** The EWMA of the cell count. */
2021 /** True iff this is the cell count for a circuit's previous
2023 unsigned int is_for_p_conn
: 1;
2024 /** The position of the circuit within the OR connection's priority
2029 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
2030 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
2033 * A circuit is a path over the onion routing
2034 * network. Applications can connect to one end of the circuit, and can
2035 * create exit connections at the other end of the circuit. AP and exit
2036 * connections have only one circuit associated with them (and thus these
2037 * connection types are closed when the circuit is closed), whereas
2038 * OR connections multiplex many circuits at once, and stay standing even
2039 * when there are no circuits running over them.
2041 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
2042 * links two connections together: either an edge connection and an OR
2043 * connection, or two OR connections. (When joined to an OR connection, a
2044 * circuit_t affects only cells sent to a particular circID on that
2045 * connection. When joined to an edge connection, a circuit_t affects all
2048 * Second, an origin_circuit_t holds the cipher keys and state for sending data
2049 * along a given circuit. At the OP, it has a sequence of ciphers, each
2050 * of which is shared with a single OR along the circuit. Separate
2051 * ciphers are used for data going "forward" (away from the OP) and
2052 * "backward" (towards the OP). At the OR, a circuit has only two stream
2053 * ciphers: one for data going forward, and one for data going backward.
2055 typedef struct circuit_t
{
2056 uint32_t magic
; /**< For memory and type debugging: must equal
2057 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
2059 /** Queue of cells waiting to be transmitted on n_conn. */
2060 cell_queue_t n_conn_cells
;
2061 /** The OR connection that is next in this circuit. */
2062 or_connection_t
*n_conn
;
2063 /** The circuit_id used in the next (forward) hop of this circuit. */
2066 /** The hop to which we want to extend this circuit. Should be NULL if
2067 * the circuit has attached to a connection. */
2068 extend_info_t
*n_hop
;
2070 /** True iff we are waiting for n_conn_cells to become less full before
2071 * allowing p_streams to add any more cells. (Origin circuit only.) */
2072 unsigned int streams_blocked_on_n_conn
: 1;
2073 /** True iff we are waiting for p_conn_cells to become less full before
2074 * allowing n_streams to add any more cells. (OR circuit only.) */
2075 unsigned int streams_blocked_on_p_conn
: 1;
2077 uint8_t state
; /**< Current status of this circuit. */
2078 uint8_t purpose
; /**< Why are we creating this circuit? */
2080 /** How many relay data cells can we package (read from edge streams)
2081 * on this circuit before we receive a circuit-level sendme cell asking
2084 /** How many relay data cells will we deliver (write to edge streams)
2085 * on this circuit? When deliver_window gets low, we send some
2086 * circuit-level sendme cells to indicate that we're willing to accept
2090 /** For storage while n_conn is pending
2091 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
2092 * length ONIONSKIN_CHALLENGE_LEN. */
2093 char *n_conn_onionskin
;
2095 time_t timestamp_created
; /**< When was this circuit created? */
2096 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
2097 * circuit is clean. */
2098 struct timeval highres_created
; /**< When exactly was the circuit created? */
2100 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
2101 * the main loop? (If true, holds the line number
2102 * where this circuit was marked.) */
2103 const char *marked_for_close_file
; /**< For debugging: in which file was this
2104 * circuit marked for close? */
2106 /** Next circuit in the doubly-linked ring of circuits waiting to add
2107 * cells to n_conn. NULL if we have no cells pending, or if we're not
2108 * linked to an OR connection. */
2109 struct circuit_t
*next_active_on_n_conn
;
2110 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2111 * cells to n_conn. NULL if we have no cells pending, or if we're not
2112 * linked to an OR connection. */
2113 struct circuit_t
*prev_active_on_n_conn
;
2114 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
2116 /** Unique ID for measuring tunneled network status requests. */
2119 /** The EWMA count for the number of cells flushed from the
2120 * n_conn_cells queue. Used to determine which circuit to flush from next.
2122 cell_ewma_t n_cell_ewma
;
2125 /** Largest number of relay_early cells that we can send on a given
2127 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
2129 /** An origin_circuit_t holds data necessary to build and use a circuit.
2131 typedef struct origin_circuit_t
{
2134 /** Linked list of AP streams (or EXIT streams if hidden service)
2135 * associated with this circuit. */
2136 edge_connection_t
*p_streams
;
2137 /** Build state for this circuit. It includes the intended path
2138 * length, the chosen exit router, rendezvous information, etc.
2140 cpath_build_state_t
*build_state
;
2141 /** The doubly-linked list of crypt_path_t entries, one per hop,
2142 * for this circuit. This includes ciphers for each hop,
2143 * integrity-checking digests for each hop, and package/delivery
2144 * windows for each hop.
2146 crypt_path_t
*cpath
;
2148 /** Holds all rendezvous data on either client or service side. */
2149 rend_data_t
*rend_data
;
2151 /** How many more relay_early cells can we send on this circuit, according
2152 * to the specification? */
2153 unsigned int remaining_relay_early_cells
: 4;
2155 /** What commands were sent over this circuit that decremented the
2156 * RELAY_EARLY counter? This is for debugging task 878. */
2157 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
2159 /** How many RELAY_EARLY cells have been sent over this circuit? This is
2160 * for debugging task 878, too. */
2161 int relay_early_cells_sent
;
2163 /** The next stream_id that will be tried when we're attempting to
2164 * construct a new AP stream originating at this circuit. */
2165 streamid_t next_stream_id
;
2167 /* The intro key replaces the hidden service's public key if purpose is
2168 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2169 * descriptor is used. */
2170 crypto_pk_env_t
*intro_key
;
2172 /** Quasi-global identifier for this circuit; used for control.c */
2173 /* XXXX NM This can get re-used after 2**32 circuits. */
2174 uint32_t global_identifier
;
2178 /** An or_circuit_t holds information needed to implement a circuit at an
2180 typedef struct or_circuit_t
{
2183 /** Next circuit in the doubly-linked ring of circuits waiting to add
2184 * cells to p_conn. NULL if we have no cells pending, or if we're not
2185 * linked to an OR connection. */
2186 struct circuit_t
*next_active_on_p_conn
;
2187 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2188 * cells to p_conn. NULL if we have no cells pending, or if we're not
2189 * linked to an OR connection. */
2190 struct circuit_t
*prev_active_on_p_conn
;
2192 /** The circuit_id used in the previous (backward) hop of this circuit. */
2194 /** Queue of cells waiting to be transmitted on p_conn. */
2195 cell_queue_t p_conn_cells
;
2196 /** The OR connection that is previous in this circuit. */
2197 or_connection_t
*p_conn
;
2198 /** Linked list of Exit streams associated with this circuit. */
2199 edge_connection_t
*n_streams
;
2200 /** Linked list of Exit streams associated with this circuit that are
2201 * still being resolved. */
2202 edge_connection_t
*resolving_streams
;
2203 /** The cipher used by intermediate hops for cells heading toward the
2205 crypto_cipher_env_t
*p_crypto
;
2206 /** The cipher used by intermediate hops for cells heading away from
2208 crypto_cipher_env_t
*n_crypto
;
2210 /** The integrity-checking digest used by intermediate hops, for
2211 * cells packaged here and heading towards the OP.
2213 crypto_digest_env_t
*p_digest
;
2214 /** The integrity-checking digest used by intermediate hops, for
2215 * cells packaged at the OP and arriving here.
2217 crypto_digest_env_t
*n_digest
;
2219 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2220 * is not marked for close. */
2221 struct or_circuit_t
*rend_splice
;
2223 #if REND_COOKIE_LEN >= DIGEST_LEN
2224 #define REND_TOKEN_LEN REND_COOKIE_LEN
2226 #define REND_TOKEN_LEN DIGEST_LEN
2229 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2230 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2232 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2234 char rend_token
[REND_TOKEN_LEN
];
2236 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2237 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2239 /** How many more relay_early cells can we send on this circuit, according
2240 * to the specification? */
2241 unsigned int remaining_relay_early_cells
: 4;
2243 /** True iff this circuit was made with a CREATE_FAST cell. */
2244 unsigned int is_first_hop
: 1;
2246 /** Number of cells that were removed from circuit queue; reset every
2247 * time when writing buffer stats to disk. */
2248 uint32_t processed_cells
;
2250 /** Total time in milliseconds that cells spent in both app-ward and
2251 * exit-ward queues of this circuit; reset every time when writing
2252 * buffer stats to disk. */
2253 uint64_t total_cell_waiting_time
;
2255 /** The EWMA count for the number of cells flushed from the
2256 * p_conn_cells queue. */
2257 cell_ewma_t p_cell_ewma
;
2260 /** Convert a circuit subtype to a circuit_t.*/
2261 #define TO_CIRCUIT(x) (&((x)->_base))
2263 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2264 * if the cast is impossible. */
2265 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2266 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2267 * Asserts if the cast is impossible. */
2268 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2270 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2272 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2273 return DOWNCAST(or_circuit_t
, x
);
2275 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2277 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2278 return DOWNCAST(origin_circuit_t
, x
);
2281 /** Bitfield type: things that we're willing to use invalid routers for. */
2282 typedef enum invalid_router_usage_t
{
2283 ALLOW_INVALID_ENTRY
=1,
2284 ALLOW_INVALID_EXIT
=2,
2285 ALLOW_INVALID_MIDDLE
=4,
2286 ALLOW_INVALID_RENDEZVOUS
=8,
2287 ALLOW_INVALID_INTRODUCTION
=16,
2288 } invalid_router_usage_t
;
2290 /* limits for TCP send and recv buffer size used for constrained sockets */
2291 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2292 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2294 /** A linked list of lines in a config file. */
2295 typedef struct config_line_t
{
2298 struct config_line_t
*next
;
2301 typedef struct routerset_t routerset_t
;
2303 /** Configuration options for a Tor process. */
2307 /** What should the tor process actually do? */
2309 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2310 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2312 const char *command_arg
; /**< Argument for command-line option. */
2314 config_line_t
*Logs
; /**< New-style list of configuration lines
2317 char *DebugLogFile
; /**< Where to send verbose log messages. */
2318 char *DataDirectory
; /**< OR only: where to store long-term data. */
2319 char *Nickname
; /**< OR only: nickname of this onion router. */
2320 char *Address
; /**< OR only: configured address for this onion router. */
2321 char *PidFile
; /**< Where to store PID of Tor process. */
2323 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2324 * country codes and IP address patterns of ORs to
2325 * consider as exits. */
2326 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2327 * country codes and IP address patterns of ORs to
2328 * consider as entry points. */
2329 int StrictNodes
; /**< Boolean: When none of our EntryNodes or ExitNodes
2330 * are up, or we need to access a node in ExcludeNodes,
2331 * do we just fail instead? */
2332 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2333 * country codes and IP address patterns of ORs
2334 * not to use in circuits. But see StrictNodes
2336 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2337 * country codes and IP address patterns of
2338 * ORs not to consider as exits. */
2340 /** Union of ExcludeNodes and ExcludeExitNodes */
2341 struct routerset_t
*_ExcludeExitNodesUnion
;
2343 int DisableAllSwap
; /**< Boolean: Attempt to call mlockall() on our
2344 * process for all current and future memory. */
2346 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2347 smartlist_t
*AllowInvalidNodes
;
2348 /** Bitmask; derived from AllowInvalidNodes. */
2349 invalid_router_usage_t _AllowInvalid
;
2350 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2351 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2352 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2353 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2354 /** Addresses to bind for listening for SOCKS connections. */
2355 config_line_t
*SocksListenAddress
;
2356 /** Addresses to bind for listening for transparent pf/netfilter
2358 config_line_t
*TransListenAddress
;
2359 /** Addresses to bind for listening for transparent natd connections */
2360 config_line_t
*NatdListenAddress
;
2361 /** Addresses to bind for listening for SOCKS connections. */
2362 config_line_t
*DNSListenAddress
;
2363 /** Addresses to bind for listening for OR connections. */
2364 config_line_t
*ORListenAddress
;
2365 /** Addresses to bind for listening for directory connections. */
2366 config_line_t
*DirListenAddress
;
2367 /** Addresses to bind for listening for control connections. */
2368 config_line_t
*ControlListenAddress
;
2369 /** Local address to bind outbound sockets */
2370 char *OutboundBindAddress
;
2371 /** Directory server only: which versions of
2372 * Tor should we tell users to run? */
2373 config_line_t
*RecommendedVersions
;
2374 config_line_t
*RecommendedClientVersions
;
2375 config_line_t
*RecommendedServerVersions
;
2376 /** Whether dirservers refuse router descriptors with private IPs. */
2377 int DirAllowPrivateAddresses
;
2378 char *User
; /**< Name of user to run Tor as. */
2379 char *Group
; /**< Name of group to run Tor as. */
2380 int ORPort
; /**< Port to listen on for OR connections. */
2381 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2382 /** Port to listen on for transparent pf/netfilter connections. */
2384 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2385 int ControlPort
; /**< Port to listen on for control connections. */
2386 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2387 * for control connections. */
2388 int DirPort
; /**< Port to listen on for directory connections. */
2389 int DNSPort
; /**< Port to listen on for DNS requests. */
2390 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2391 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2392 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2393 * for version 1 directories? */
2394 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2395 * for version 2 directories? */
2396 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2397 * for version 3 directories? */
2398 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2399 * handle hidden service requests? */
2400 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2401 * that's willing to bind names? */
2402 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2403 * directory that's willing to recommend
2405 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2406 * that aggregates bridge descriptors? */
2408 /** If set on a bridge authority, it will answer requests on its dirport
2409 * for bridge statuses -- but only if the requests use this password.
2410 * If set on a bridge user, request bridge statuses, and use this password
2412 char *BridgePassword
;
2414 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2415 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2417 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2418 * this explicit so we can change how we behave in the
2421 /** Boolean: if we know the bridge's digest, should we get new
2422 * descriptors from the bridge authorities or from the bridge itself? */
2423 int UpdateBridgesFromAuthority
;
2425 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2427 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2428 /** Boolean: should we never publish a descriptor? Deprecated. */
2430 /** To what authority types do we publish our descriptor? Choices are
2431 * "v1", "v2", "v3", "bridge", or "". */
2432 smartlist_t
*PublishServerDescriptor
;
2433 /** An authority type, derived from PublishServerDescriptor. */
2434 authority_type_t _PublishServerDescriptor
;
2435 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2436 int PublishHidServDescriptors
;
2437 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2438 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2439 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2441 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2442 * service directories after what time? */
2443 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2444 int AllDirActionsPrivate
; /**< Should every directory action be sent
2445 * through a Tor circuit? */
2447 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2448 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2449 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2450 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2451 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2453 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2454 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2455 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2457 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2458 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2460 /** Application ports that require all nodes in circ to have sufficient
2462 smartlist_t
*LongLivedPorts
;
2463 /** Application ports that are likely to be unencrypted and
2464 * unauthenticated; we reject requests for them to prevent the
2465 * user from screwing up and leaking plaintext secrets to an
2466 * observer somewhere on the Internet. */
2467 smartlist_t
*RejectPlaintextPorts
;
2468 /** Related to RejectPlaintextPorts above, except this config option
2469 * controls whether we warn (in the log and via a controller status
2470 * event) every time a risky connection is attempted. */
2471 smartlist_t
*WarnPlaintextPorts
;
2472 /** Should we try to reuse the same exit node for a given host */
2473 smartlist_t
*TrackHostExits
;
2474 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2476 config_line_t
*AddressMap
; /**< List of address map directives. */
2477 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2478 * hostname ending with one of the suffixes in
2479 * <b>AutomapHostsSuffixes</b>, map it to a
2480 * virtual address. */
2481 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2482 * <b>AutomapHostsOnResolve</b>. */
2483 int RendPostPeriod
; /**< How often do we post each rendezvous service
2484 * descriptor? Remember to publish them independently. */
2485 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2486 * connections alive? */
2487 int SocksTimeout
; /**< How long do we let a socks connection wait
2488 * unattached before we fail it? */
2489 int CircuitBuildTimeout
; /**< If non-zero, cull non-open circuits that
2490 * were born at least this many seconds ago. If
2491 * zero, use the internal adaptive algorithm. */
2492 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2493 * at least this many seconds ago. */
2494 int CircuitStreamTimeout
; /**< If non-zero, detach streams from circuits
2495 * and try a new circuit if the stream has been
2496 * waiting for this many seconds. If zero, use
2497 * our default internal timeout schedule. */
2498 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2499 * to wait simultaneously before we start dropping
2501 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2503 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2504 this interval ago. */
2505 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2506 * to use in a second? */
2507 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2508 * to use in a second? */
2509 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2510 * tell people we have? */
2511 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2512 * willing to use for all relayed conns? */
2513 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2514 * use in a second for all relayed conns? */
2515 int NumCpus
; /**< How many CPUs should we try to use? */
2516 int RunTesting
; /**< If true, create testing circuits to measure how well the
2517 * other ORs are running. */
2518 config_line_t
*RendConfigLines
; /**< List of configuration lines
2519 * for rendezvous services. */
2520 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2521 * authorizations for hidden services */
2522 char *ContactInfo
; /**< Contact info to be published in the directory. */
2524 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2525 tor_addr_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2526 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2527 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2529 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2530 tor_addr_t HttpsProxyAddr
; /**< Parsed addr for https proxy, if any. */
2531 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2532 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2534 char *Socks4Proxy
; /**< hostname:port to use as a SOCKS4 proxy, if any. */
2535 tor_addr_t Socks4ProxyAddr
; /**< Derived from Socks4Proxy. */
2536 uint16_t Socks4ProxyPort
; /**< Derived from Socks4Proxy. */
2538 char *Socks5Proxy
; /**< hostname:port to use as a SOCKS5 proxy, if any. */
2539 tor_addr_t Socks5ProxyAddr
; /**< Derived from Sock5Proxy. */
2540 uint16_t Socks5ProxyPort
; /**< Derived from Socks5Proxy. */
2541 char *Socks5ProxyUsername
; /**< Username for SOCKS5 authentication, if any */
2542 char *Socks5ProxyPassword
; /**< Password for SOCKS5 authentication, if any */
2544 /** List of configuration lines for replacement directory authorities.
2545 * If you just want to replace one class of authority at a time,
2546 * use the "Alternate*Authority" options below instead. */
2547 config_line_t
*DirServers
;
2549 /** If set, use these main (currently v3) directory authorities and
2550 * not the default ones. */
2551 config_line_t
*AlternateDirAuthority
;
2553 /** If set, use these bridge authorities and not the default one. */
2554 config_line_t
*AlternateBridgeAuthority
;
2556 /** If set, use these HS authorities and not the default ones. */
2557 config_line_t
*AlternateHSAuthority
;
2559 char *MyFamily
; /**< Declared family for this OR. */
2560 config_line_t
*NodeFamilies
; /**< List of config lines for
2562 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2563 * mark as bad dir mirrors. */
2564 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2565 * mark as bad exits. */
2566 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2568 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2569 * never mark as valid. */
2570 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2571 * and vote for all other dir mirrors as good. */
2572 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2573 * and vote for all other exits as good. */
2574 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2575 * aren't named in our fingerprint file? */
2576 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2577 * number of servers per IP address. */
2578 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2579 * number of servers per IP address shared
2580 * with an authority. */
2582 char *AccountingStart
; /**< How long is the accounting interval, and when
2584 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2585 * interval before hibernation? 0 for "never
2588 /** Base64-encoded hash of accepted passwords for the control system. */
2589 config_line_t
*HashedControlPassword
;
2590 /** As HashedControlPassword, but not saved. */
2591 config_line_t
*HashedControlSessionPassword
;
2593 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2594 * the control system? */
2595 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2596 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2597 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2598 * circuits itself (0), or does it expect a controller
2600 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2601 * make circuits in the background (0),
2603 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2604 * long do we wait before exiting? */
2605 char *SafeLogging
; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
2607 /* Derived from SafeLogging */
2609 SAFELOG_SCRUB_ALL
, SAFELOG_SCRUB_RELAY
, SAFELOG_SCRUB_NONE
2612 int SafeSocks
; /**< Boolean: should we outright refuse application
2613 * connections that use socks4 or socks5-with-local-dns? */
2614 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2615 LOG_WARN : LOG_INFO)
2616 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2617 * protocol, is it a warn or an info in our logs? */
2618 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2619 * log whether it was DNS-leaking or not? */
2620 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2621 * acceleration where available? */
2622 char *AccelName
; /**< Optional hardware acceleration engine name. */
2623 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
2624 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2625 * of fixed nodes? */
2626 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2627 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2628 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2629 * of our PK time by sending CREATE_FAST cells? */
2630 /** Should we always fetch our dir info on the mirror schedule (which
2631 * means directly from the authorities) no matter our other config? */
2632 int FetchDirInfoEarly
;
2634 /** Should we fetch our dir info at the start of the consensus period? */
2635 int FetchDirInfoExtraEarly
;
2637 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2638 * MAPADDRESS requests. */
2639 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2640 * addresses to be FQDNs, but rather search for them in
2641 * the local domains. */
2642 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2644 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2645 * DNS poisoning attacks. */
2646 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2647 * resolver from the file here rather than from
2648 * /etc/resolv.conf (Unix) or the registry (Windows). */
2649 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2650 disclaimer. This allows a server administrator to show
2651 that they're running Tor and anyone visiting their server
2652 will know this without any specialized knowledge. */
2653 /** Boolean: if set, we start even if our resolv.conf file is missing
2655 int ServerDNSAllowBrokenConfig
;
2657 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2658 * should be resolvable. Used for
2659 * testing our DNS server. */
2660 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2661 * same network zone in the same circuit. */
2662 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2664 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2665 * support BEGIN_DIR, when possible. */
2666 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2667 * with weird characters. */
2668 /** If true, we try resolving hostnames with weird characters. */
2669 int ServerDNSAllowNonRFC953Hostnames
;
2671 /** If true, we try to download extra-info documents (and we serve them,
2672 * if we are a cache). For authorities, this is always true. */
2673 int DownloadExtraInfo
;
2675 /** If true, and we are acting as a relay, allow exit circuits even when
2676 * we are the first hop of a circuit. */
2677 int AllowSingleHopExits
;
2678 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2679 * circuits that we build. */
2680 int ExcludeSingleHopRelays
;
2681 /** If true, and the controller tells us to use a one-hop circuit, and the
2682 * exit allows it, we use it. */
2683 int AllowSingleHopCircuits
;
2685 /** If true, we convert "www.google.com.foo.exit" addresses on the
2686 * socks/trans/natd ports into "www.google.com" addresses that
2687 * exit from the node "foo". Disabled by default since attacking
2688 * websites and exit relays can use it to manipulate your path
2692 /** If true, the user wants us to collect statistics on clients
2693 * requesting network statuses from us as directory. */
2694 int DirReqStatistics
;
2696 /** If true, the user wants us to collect statistics on port usage. */
2697 int ExitPortStatistics
;
2699 /** If true, the user wants us to collect cell statistics. */
2702 /** If true, the user wants us to collect statistics as entry node. */
2703 int EntryStatistics
;
2705 /** If true, include statistics file contents in extra-info documents. */
2706 int ExtraInfoStatistics
;
2708 /** If true, do not believe anybody who tells us that a domain resolves
2709 * to an internal address, or that an internal address has a PTR mapping.
2710 * Helps avoid some cross-site attacks. */
2711 int ClientDNSRejectInternalAddresses
;
2713 /** The length of time that we think a consensus should be fresh. */
2714 int V3AuthVotingInterval
;
2715 /** The length of time we think it will take to distribute votes. */
2716 int V3AuthVoteDelay
;
2717 /** The length of time we think it will take to distribute signatures. */
2718 int V3AuthDistDelay
;
2719 /** The number of intervals we think a consensus should be valid. */
2720 int V3AuthNIntervalsValid
;
2722 /** Should advertise and sign consensuses with a legacy key, for key
2723 * migration purposes? */
2724 int V3AuthUseLegacyKey
;
2726 /** Location of bandwidth measurement file */
2727 char *V3BandwidthsFile
;
2729 /** Authority only: key=value pairs that we add to our networkstatus
2730 * consensus vote on the 'params' line. */
2731 char *ConsensusParams
;
2733 /** The length of time that we think an initial consensus should be fresh.
2734 * Only altered on testing networks. */
2735 int TestingV3AuthInitialVotingInterval
;
2737 /** The length of time we think it will take to distribute initial votes.
2738 * Only altered on testing networks. */
2739 int TestingV3AuthInitialVoteDelay
;
2741 /** The length of time we think it will take to distribute initial
2742 * signatures. Only altered on testing networks.*/
2743 int TestingV3AuthInitialDistDelay
;
2745 /** If an authority has been around for less than this amount of time, it
2746 * does not believe its reachability information is accurate. Only
2747 * altered on testing networks. */
2748 int TestingAuthDirTimeToLearnReachability
;
2750 /** Clients don't download any descriptor this recent, since it will
2751 * probably not have propagated to enough caches. Only altered on testing
2753 int TestingEstimatedDescriptorPropagationTime
;
2755 /** If true, we take part in a testing network. Change the defaults of a
2756 * couple of other configuration options and allow to change the values
2757 * of certain configuration options. */
2758 int TestingTorNetwork
;
2760 /** File to check for a consensus networkstatus, if we don't have one
2762 char *FallbackNetworkstatusFile
;
2764 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2765 * count of how many client addresses have contacted us so that we can help
2766 * the bridge authority guess which countries have blocked access to us. */
2767 int BridgeRecordUsageByCountry
;
2770 /** If true, and Tor is built with DIRREQ_STATS support, and we're a
2771 * directory, record how many directory requests we get from each country. */
2772 int DirRecordUsageByCountry
;
2773 /** Round all GeoIP results to the next multiple of this value, to avoid
2774 * leaking information. */
2775 int DirRecordUsageGranularity
;
2776 /** Time interval: purge geoip stats after this long. */
2777 int DirRecordUsageRetainIPs
;
2778 /** Time interval: Flush geoip data to disk this often. */
2779 int DirRecordUsageSaveInterval
;
2782 /** Optionally, a file with GeoIP data. */
2785 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2786 * to make this false. */
2787 int ReloadTorrcOnSIGHUP
;
2789 /* The main parameter for picking circuits within a connection.
2791 * If this value is positive, when picking a cell to relay on a connection,
2792 * we always relay from the circuit whose weighted cell count is lowest.
2793 * Cells are weighted exponentially such that if one cell is sent
2794 * 'CircuitPriorityHalflife' seconds before another, it counts for half as
2797 * If this value is zero, we're disabling the cell-EWMA algorithm.
2799 * If this value is negative, we're using the default approach
2800 * according to either Tor or a parameter set in the consensus.
2802 double CircuitPriorityHalflife
;
2806 /** Persistent state for an onion router, as saved to disk. */
2809 /** The time at which we next plan to write the state to the disk. Equal to
2810 * TIME_MAX if there are no savable changes, 0 if there are changes that
2811 * should be saved right away. */
2814 /** When was the state last written to disk? */
2817 /** Fields for accounting bandwidth use. */
2818 time_t AccountingIntervalStart
;
2819 uint64_t AccountingBytesReadInInterval
;
2820 uint64_t AccountingBytesWrittenInInterval
;
2821 int AccountingSecondsActive
;
2822 uint64_t AccountingExpectedUsage
;
2824 /** A list of Entry Guard-related configuration lines. */
2825 config_line_t
*EntryGuards
;
2827 /** These fields hold information on the history of bandwidth usage for
2828 * servers. The "Ends" fields hold the time when we last updated the
2829 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2830 * of the entries of Values. The "Values" lists hold decimal string
2831 * representations of the number of bytes read or written in each
2833 time_t BWHistoryReadEnds
;
2834 int BWHistoryReadInterval
;
2835 smartlist_t
*BWHistoryReadValues
;
2836 time_t BWHistoryWriteEnds
;
2837 int BWHistoryWriteInterval
;
2838 smartlist_t
*BWHistoryWriteValues
;
2840 /** Build time histogram */
2841 config_line_t
* BuildtimeHistogram
;
2842 uint16_t TotalBuildTimes
;
2844 /** What version of Tor wrote this state file? */
2847 /** Holds any unrecognized values we found in the state file, in the order
2848 * in which we found them. */
2849 config_line_t
*ExtraLines
;
2851 /** When did we last rotate our onion key? "0" for 'no idea'. */
2852 time_t LastRotatedOnionKey
;
2855 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2856 * state is already scheduled to be written to disk earlier than <b>when</b>.
2858 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2860 if (state
->next_write
> when
)
2861 state
->next_write
= when
;
2864 #define MAX_SOCKS_REPLY_LEN 1024
2865 #define MAX_SOCKS_ADDR_LEN 256
2867 /** Please open a TCP connection to this addr:port. */
2868 #define SOCKS_COMMAND_CONNECT 0x01
2869 /** Please turn this FQDN into an IP address, privately. */
2870 #define SOCKS_COMMAND_RESOLVE 0xF0
2871 /** Please turn this IP address into an FQDN, privately. */
2872 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2874 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2875 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2876 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2878 /** State of a SOCKS request from a user to an OP. Also used to encode other
2879 * information for non-socks user request (such as those on TransPort and
2881 struct socks_request_t
{
2882 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2883 * 0 means that no socks handshake ever took place, and this is just a
2884 * stub connection (e.g. see connection_ap_make_link()). */
2886 int command
; /**< What is this stream's goal? One from the above list. */
2887 size_t replylen
; /**< Length of <b>reply</b>. */
2888 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2889 * we want to specify our own socks reply,
2890 * rather than using the default socks4 or
2891 * socks5 socks reply. We use this for the
2892 * two-stage socks5 handshake.
2894 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2895 connect to/resolve? */
2896 uint16_t port
; /**< What port did the client ask to connect to? */
2897 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2898 * make sure we send back a socks reply for
2899 * every connection. */
2902 /* all the function prototypes go here */
2904 /********************************* buffers.c ***************************/
2906 buf_t
*buf_new(void);
2907 buf_t
*buf_new_with_capacity(size_t size
);
2908 void buf_free(buf_t
*buf
);
2909 void buf_clear(buf_t
*buf
);
2910 void buf_shrink(buf_t
*buf
);
2911 void buf_shrink_freelists(int free_all
);
2912 void buf_dump_freelist_sizes(int severity
);
2914 size_t buf_datalen(const buf_t
*buf
);
2915 size_t buf_allocation(const buf_t
*buf
);
2916 size_t buf_slack(const buf_t
*buf
);
2917 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2919 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2921 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2923 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2924 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2926 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2927 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2928 const char *data
, size_t data_len
, int done
);
2929 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2930 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2931 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2932 int fetch_from_buf_http(buf_t
*buf
,
2933 char **headers_out
, size_t max_headerlen
,
2934 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2935 int force_complete
);
2936 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2937 int log_sockstype
, int safe_socks
);
2938 int fetch_from_buf_socks_client(buf_t
*buf
, int state
, char **reason
);
2939 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2941 int peek_buf_has_control0_command(buf_t
*buf
);
2943 void assert_buf_ok(buf_t
*buf
);
2945 #ifdef BUFFERS_PRIVATE
2946 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2949 /********************************* circuitbuild.c **********************/
2951 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2952 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2953 void circuit_log_path(int severity
, unsigned int domain
,
2954 origin_circuit_t
*circ
);
2955 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2956 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2957 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2958 extend_info_t
*exit
,
2960 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2961 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2962 int inform_testing_reachability(void);
2963 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2964 void circuit_note_clock_jumped(int seconds_elapsed
);
2965 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2966 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2968 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2970 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2971 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2972 const char *payload
, const char *keys
);
2973 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2974 int *need_capacity
);
2976 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2977 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2978 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2979 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2980 crypto_pk_env_t
*onion_key
,
2981 const tor_addr_t
*addr
, uint16_t port
);
2982 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2983 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2984 void extend_info_free(extend_info_t
*info
);
2985 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2986 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2988 void entry_guards_compute_status(void);
2989 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2990 int mark_relay_status
, time_t now
);
2991 void entry_nodes_should_be_added(void);
2992 int entry_list_is_constrained(or_options_t
*options
);
2993 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2994 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2995 void entry_guards_update_state(or_state_t
*state
);
2996 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2997 const char *question
, char **answer
);
2999 void clear_bridge_list(void);
3000 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
3001 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
3003 void retry_bridge_descriptor_fetch_directly(const char *digest
);
3004 void fetch_bridge_descriptors(time_t now
);
3005 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
3006 int any_bridge_descriptors_known(void);
3007 int any_pending_bridge_descriptor_fetches(void);
3008 int bridges_known_but_down(void);
3009 void bridges_retry_all(void);
3011 void entry_guards_free_all(void);
3013 /* Circuit Build Timeout "public" functions and structures. */
3015 /** Maximum quantile to use to generate synthetic timeouts.
3016 * We want to stay a bit short of 1.0, because longtail is
3017 * loooooooooooooooooooooooooooooooooooooooooooooooooooong. */
3018 #define MAX_SYNTHETIC_QUANTILE 0.985
3020 /** Minimum circuits before estimating a timeout */
3021 #define MIN_CIRCUITS_TO_OBSERVE 500
3023 /** Total size of the circuit timeout history to accumulate.
3024 * 5000 is approx 1.5 weeks worth of continual-use circuits. */
3025 #define NCIRCUITS_TO_OBSERVE 5000
3027 /** Width of the histogram bins in milliseconds */
3028 #define BUILDTIME_BIN_WIDTH ((build_time_t)50)
3030 /** Cutoff point on the CDF for our timeout estimation.
3031 * TODO: This should be moved to the consensus */
3032 #define BUILDTIMEOUT_QUANTILE_CUTOFF 0.8
3034 /** A build_time_t is milliseconds */
3035 typedef uint32_t build_time_t
;
3036 #define BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
3038 /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
3039 #define BUILD_TIMEOUT_MIN_VALUE (3*1000)
3041 /** Initial circuit build timeout in milliseconds */
3042 #define BUILD_TIMEOUT_INITIAL_VALUE (60*1000)
3044 /** How often in seconds should we build a test circuit */
3045 #define BUILD_TIMES_TEST_FREQUENCY 60
3047 /** Save state every 10 circuits */
3048 #define BUILD_TIMES_SAVE_STATE_EVERY 10
3050 /* Circuit Build Timeout network liveness constants */
3053 * How many circuits count as recent when considering if the
3054 * connection has gone gimpy or changed.
3056 #define RECENT_CIRCUITS 20
3059 * Have we received a cell in the last N circ attempts?
3061 * This tells us when to temporarily switch back to
3062 * BUILD_TIMEOUT_INITIAL_VALUE until we start getting cells,
3063 * at which point we switch back to computing the timeout from
3064 * our saved history.
3066 #define NETWORK_NONLIVE_TIMEOUT_COUNT (RECENT_CIRCUITS*3/20)
3069 * This tells us when to toss out the last streak of N timeouts.
3071 * If instead we start getting cells, we switch back to computing the timeout
3072 * from our saved history.
3074 #define NETWORK_NONLIVE_DISCARD_COUNT (NETWORK_NONLIVE_TIMEOUT_COUNT*2)
3077 * Maximum count of timeouts that finish the first hop in the past
3078 * RECENT_CIRCUITS before calculating a new timeout.
3080 * This tells us to abandon timeout history and set
3081 * the timeout back to BUILD_TIMEOUT_INITIAL_VALUE.
3083 #define MAX_RECENT_TIMEOUT_COUNT (RECENT_CIRCUITS*4/5)
3085 #if MAX_RECENT_TIMEOUT_COUNT < 1 || NETWORK_NONLIVE_DISCARD_COUNT < 1 || \
3086 NETWORK_NONLIVE_TIMEOUT_COUNT < 1
3087 #error "RECENT_CIRCUITS is set too low."
3090 /** Information about the state of our local network connection */
3092 /** The timestamp we last completed a TLS handshake or received a cell */
3093 time_t network_last_live
;
3094 /** If the network is not live, how many timeouts has this caused? */
3095 int nonlive_timeouts
;
3096 /** If the network is not live, have we yet discarded our history? */
3097 int nonlive_discarded
;
3098 /** Circular array of circuits that have made it to the first hop. Slot is
3099 * 1 if circuit timed out, 0 if circuit succeeded */
3100 int8_t timeouts_after_firsthop
[RECENT_CIRCUITS
];
3101 /** Index into circular array. */
3102 int after_firsthop_idx
;
3103 } network_liveness_t
;
3105 /** Structure for circuit build times history */
3107 /** The circular array of recorded build times in milliseconds */
3108 build_time_t circuit_build_times
[NCIRCUITS_TO_OBSERVE
];
3109 /** Current index in the circuit_build_times circular array */
3110 int build_times_idx
;
3111 /** Total number of build times accumulated. Maxes at NCIRCUITS_TO_OBSERVE */
3112 int total_build_times
;
3113 /** Information about the state of our local network connection */
3114 network_liveness_t liveness
;
3115 /** Last time we built a circuit. Used to decide to build new test circs */
3116 time_t last_circ_at
;
3117 /** Number of timeouts that have happened before estimating pareto
3120 /** "Minimum" value of our pareto distribution (actually mode) */
3122 /** alpha exponent for pareto dist. */
3124 /** Have we computed a timeout? */
3125 int have_computed_timeout
;
3126 /** The exact value for that timeout in milliseconds */
3128 } circuit_build_times_t
;
3130 extern circuit_build_times_t circ_times
;
3131 void circuit_build_times_update_state(circuit_build_times_t
*cbt
,
3133 int circuit_build_times_parse_state(circuit_build_times_t
*cbt
,
3134 or_state_t
*state
, char **msg
);
3135 int circuit_build_times_add_timeout(circuit_build_times_t
*cbt
,
3136 int did_onehop
, time_t start_time
);
3137 void circuit_build_times_set_timeout(circuit_build_times_t
*cbt
);
3138 int circuit_build_times_add_time(circuit_build_times_t
*cbt
,
3140 int circuit_build_times_needs_circuits(circuit_build_times_t
*cbt
);
3141 int circuit_build_times_needs_circuits_now(circuit_build_times_t
*cbt
);
3142 void circuit_build_times_init(circuit_build_times_t
*cbt
);
3144 #ifdef CIRCUIT_PRIVATE
3145 double circuit_build_times_calculate_timeout(circuit_build_times_t
*cbt
,
3147 build_time_t
circuit_build_times_generate_sample(circuit_build_times_t
*cbt
,
3148 double q_lo
, double q_hi
);
3149 void circuit_build_times_initial_alpha(circuit_build_times_t
*cbt
,
3150 double quantile
, double time_ms
);
3151 void circuit_build_times_update_alpha(circuit_build_times_t
*cbt
);
3152 double circuit_build_times_cdf(circuit_build_times_t
*cbt
, double x
);
3153 void circuit_build_times_add_timeout_worker(circuit_build_times_t
*cbt
,
3154 double quantile_cutoff
);
3155 void circuitbuild_running_unit_tests(void);
3156 void circuit_build_times_reset(circuit_build_times_t
*cbt
);
3158 /* Network liveness functions */
3159 int circuit_build_times_network_check_changed(circuit_build_times_t
*cbt
);
3162 /* Network liveness functions */
3163 void circuit_build_times_network_is_live(circuit_build_times_t
*cbt
);
3164 int circuit_build_times_network_check_live(circuit_build_times_t
*cbt
);
3165 void circuit_build_times_network_circ_success(circuit_build_times_t
*cbt
);
3167 /********************************* circuitlist.c ***********************/
3169 circuit_t
* _circuit_get_global_list(void);
3170 const char *circuit_state_to_string(int state
);
3171 const char *circuit_purpose_to_controller_string(uint8_t purpose
);
3172 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
3173 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
3174 or_connection_t
*conn
);
3175 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
3176 or_connection_t
*conn
);
3177 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
3178 void circuit_close_all_marked(void);
3179 int32_t circuit_initial_package_window(void);
3180 origin_circuit_t
*origin_circuit_new(void);
3181 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
3182 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
3183 or_connection_t
*conn
);
3184 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
3185 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
3186 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
3187 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
3188 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
3190 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
3191 const char *digest
, uint8_t purpose
);
3192 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
3193 or_circuit_t
*circuit_get_intro_point(const char *digest
);
3194 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
3195 extend_info_t
*info
, int flags
);
3196 void circuit_mark_all_unused_circs(void);
3197 void circuit_expire_all_dirty_circs(void);
3198 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
3199 int line
, const char *file
);
3200 int circuit_get_cpath_len(origin_circuit_t
*circ
);
3201 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
3202 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
3203 or_connection_t
*or_conn
);
3204 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
3206 #define circuit_mark_for_close(c, reason) \
3207 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
3209 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
3210 void assert_circuit_ok(const circuit_t
*c
);
3211 void circuit_free_all(void);
3213 /********************************* circuituse.c ************************/
3215 void circuit_expire_building(time_t now
);
3216 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
3217 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
3219 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
3220 const or_options_t
*options
);
3221 void circuit_build_needed_circs(time_t now
);
3222 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
3224 void reset_bandwidth_test(void);
3225 int circuit_enough_testing_circs(void);
3227 void circuit_has_opened(origin_circuit_t
*circ
);
3228 void circuit_build_failed(origin_circuit_t
*circ
);
3230 /** Flag to set when a circuit should have only a single hop. */
3231 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
3232 /** Flag to set when a circuit needs to be built of high-uptime nodes */
3233 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
3234 /** Flag to set when a circuit needs to be built of high-capacity nodes */
3235 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
3236 /** Flag to set when the last hop of a circuit doesn't need to be an
3238 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
3239 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
3240 extend_info_t
*info
,
3242 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
3243 routerinfo_t
*exit
, int flags
);
3244 void circuit_reset_failure_count(int timeout
);
3245 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
3246 origin_circuit_t
*circ
,
3247 crypt_path_t
*cpath
);
3248 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
3250 /********************************* command.c ***************************/
3252 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
3253 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
3255 extern uint64_t stats_n_padding_cells_processed
;
3256 extern uint64_t stats_n_create_cells_processed
;
3257 extern uint64_t stats_n_created_cells_processed
;
3258 extern uint64_t stats_n_relay_cells_processed
;
3259 extern uint64_t stats_n_destroy_cells_processed
;
3261 /********************************* config.c ***************************/
3263 /** An error from options_trial_assign() or options_init_from_string(). */
3264 typedef enum setopt_err_t
{
3266 SETOPT_ERR_MISC
= -1,
3267 SETOPT_ERR_PARSE
= -2,
3268 SETOPT_ERR_TRANSITION
= -3,
3269 SETOPT_ERR_SETTING
= -4,
3272 const char *get_dirportfrontpage(void);
3273 or_options_t
*get_options(void);
3274 int set_options(or_options_t
*new_val
, char **msg
);
3275 void config_free_all(void);
3276 const char *safe_str_client(const char *address
);
3277 const char *safe_str(const char *address
);
3278 const char *escaped_safe_str_client(const char *address
);
3279 const char *escaped_safe_str(const char *address
);
3280 const char *get_version(void);
3282 int config_get_lines(const char *string
, config_line_t
**result
);
3283 void config_free_lines(config_line_t
*front
);
3284 setopt_err_t
options_trial_assign(config_line_t
*list
, int use_defaults
,
3285 int clear_first
, char **msg
);
3286 int resolve_my_address(int warn_severity
, or_options_t
*options
,
3287 uint32_t *addr
, char **hostname_out
);
3288 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
3289 void options_init(or_options_t
*options
);
3290 char *options_dump(or_options_t
*options
, int minimal
);
3291 int options_init_from_torrc(int argc
, char **argv
);
3292 setopt_err_t
options_init_from_string(const char *cf
,
3293 int command
, const char *command_arg
, char **msg
);
3294 int option_is_recognized(const char *key
);
3295 const char *option_get_canonical_name(const char *key
);
3296 config_line_t
*option_get_assignment(or_options_t
*options
,
3298 int options_save_current(void);
3299 const char *get_torrc_fname(void);
3300 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
3301 const char *sub1
, const char *sub2
,
3302 const char *suffix
);
3303 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
3304 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
3305 /** Return a newly allocated string containing datadir/sub1. See
3306 * get_datadir_fname2_suffix. */
3307 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
3308 /** Return a newly allocated string containing datadir/sub1/sub2. See
3309 * get_datadir_fname2_suffix. */
3310 #define get_datadir_fname2(sub1,sub2) \
3311 get_datadir_fname2_suffix((sub1), (sub2), NULL)
3312 /** Return a newly allocated string containing datadir/sub1suffix. See
3313 * get_datadir_fname2_suffix. */
3314 #define get_datadir_fname_suffix(sub1, suffix) \
3315 get_datadir_fname2_suffix((sub1), NULL, (suffix))
3317 or_state_t
*get_or_state(void);
3318 int or_state_save(time_t now
);
3320 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
3321 int getinfo_helper_config(control_connection_t
*conn
,
3322 const char *question
, char **answer
);
3324 const char *tor_get_digests(void);
3325 uint32_t get_effective_bwrate(or_options_t
*options
);
3326 uint32_t get_effective_bwburst(or_options_t
*options
);
3328 #ifdef CONFIG_PRIVATE
3329 /* Used only by config.c and test.c */
3330 or_options_t
*options_new(void);
3333 /********************************* connection.c ***************************/
3335 const char *conn_type_to_string(int type
);
3336 const char *conn_state_to_string(int type
, int state
);
3338 dir_connection_t
*dir_connection_new(int socket_family
);
3339 or_connection_t
*or_connection_new(int socket_family
);
3340 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
3341 control_connection_t
*control_connection_new(int socket_family
);
3342 connection_t
*connection_new(int type
, int socket_family
);
3344 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
3345 void connection_free(connection_t
*conn
);
3346 void connection_free_all(void);
3347 void connection_about_to_close_connection(connection_t
*conn
);
3348 void connection_close_immediate(connection_t
*conn
);
3349 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
3351 #define connection_mark_for_close(c) \
3352 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
3354 void connection_expire_held_open(void);
3356 int connection_connect(connection_t
*conn
, const char *address
,
3357 const tor_addr_t
*addr
,
3358 uint16_t port
, int *socket_error
);
3360 int connection_proxy_connect(connection_t
*conn
, int type
);
3361 int connection_read_proxy_handshake(connection_t
*conn
);
3363 int retry_all_listeners(smartlist_t
*replaced_conns
,
3364 smartlist_t
*new_conns
);
3366 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
3367 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
3368 void connection_bucket_init(void);
3369 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
3371 int connection_handle_read(connection_t
*conn
);
3373 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
3375 int connection_wants_to_flush(connection_t
*conn
);
3376 int connection_outbuf_too_full(connection_t
*conn
);
3377 int connection_handle_write(connection_t
*conn
, int force
);
3378 void _connection_write_to_buf_impl(const char *string
, size_t len
,
3379 connection_t
*conn
, int zlib
);
3380 static void connection_write_to_buf(const char *string
, size_t len
,
3381 connection_t
*conn
);
3382 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
3383 dir_connection_t
*conn
, int done
);
3385 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
3387 _connection_write_to_buf_impl(string
, len
, conn
, 0);
3390 connection_write_to_buf_zlib(const char *string
, size_t len
,
3391 dir_connection_t
*conn
, int done
)
3393 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
3396 connection_t
*connection_get_by_global_id(uint64_t id
);
3398 connection_t
*connection_get_by_type(int type
);
3399 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
3400 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
3401 const tor_addr_t
*addr
,
3402 uint16_t port
, int purpose
);
3403 connection_t
*connection_get_by_type_state(int type
, int state
);
3404 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
3405 const char *rendquery
);
3407 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
3408 int connection_is_listener(connection_t
*conn
);
3409 int connection_state_is_open(connection_t
*conn
);
3410 int connection_state_is_connecting(connection_t
*conn
);
3412 char *alloc_http_authenticator(const char *authenticator
);
3414 void assert_connection_ok(connection_t
*conn
, time_t now
);
3415 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
3416 void connection_dump_buffer_mem_stats(int severity
);
3417 void remove_file_if_very_old(const char *fname
, time_t now
);
3419 /********************************* connection_edge.c *************************/
3421 #define connection_mark_unattached_ap(conn, endreason) \
3422 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
3424 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
3425 int line
, const char *file
);
3426 int connection_edge_reached_eof(edge_connection_t
*conn
);
3427 int connection_edge_process_inbuf(edge_connection_t
*conn
,
3428 int package_partial
);
3429 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
3430 int connection_edge_end(edge_connection_t
*conn
, uint8_t reason
);
3431 int connection_edge_end_errno(edge_connection_t
*conn
);
3432 int connection_edge_finished_flushing(edge_connection_t
*conn
);
3433 int connection_edge_finished_connecting(edge_connection_t
*conn
);
3435 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
3436 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
3438 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
3440 int use_begindir
, int want_onehop
);
3441 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
3444 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
3451 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
3452 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
3453 void connection_exit_connect(edge_connection_t
*conn
);
3454 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
3455 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
,
3456 int excluded_means_no
);
3457 void connection_ap_expire_beginning(void);
3458 void connection_ap_attach_pending(void);
3459 void connection_ap_fail_onehop(const char *failed_digest
,
3460 cpath_build_state_t
*build_state
);
3461 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
3462 int connection_ap_detach_retriable(edge_connection_t
*conn
,
3463 origin_circuit_t
*circ
,
3465 int connection_ap_process_transparent(edge_connection_t
*conn
);
3467 int address_is_invalid_destination(const char *address
, int client
);
3469 void addressmap_init(void);
3470 void addressmap_clean(time_t now
);
3471 void addressmap_clear_configured(void);
3472 void addressmap_clear_transient(void);
3473 void addressmap_free_all(void);
3474 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
3475 int addressmap_have_mapping(const char *address
, int update_timeout
);
3476 /** Enumerates possible origins of a client-side address mapping. */
3478 /** We're remapping this address because the controller told us to. */
3479 ADDRMAPSRC_CONTROLLER
,
3480 /** We're remapping this address because our configuration (via torrc, the
3481 * command line, or a SETCONF command) told us to. */
3483 /** We're remapping this address because we have TrackHostExit configured,
3484 * and we want to remember to use the same exit next time. */
3485 ADDRMAPSRC_TRACKEXIT
,
3486 /** We're remapping this address because we got a DNS resolution from a
3487 * Tor server that told us what its value was. */
3489 } addressmap_entry_source_t
;
3490 void addressmap_register(const char *address
, char *new_address
,
3491 time_t expires
, addressmap_entry_source_t source
);
3492 int parse_virtual_addr_network(const char *val
, int validate_only
,
3494 int client_dns_incr_failures(const char *address
);
3495 void client_dns_clear_failures(const char *address
);
3496 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3497 const char *exitname
, int ttl
);
3498 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3499 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3500 time_t max_expires
, int want_expiry
);
3501 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3502 origin_circuit_t
*circ
,
3503 crypt_path_t
*cpath
);
3504 int hostname_is_noconnect_address(const char *address
);
3506 /** Possible return values for parse_extended_hostname. */
3507 typedef enum hostname_type_t
{
3508 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3510 hostname_type_t
parse_extended_hostname(char *address
, int allowdotexit
);
3512 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3513 int get_pf_socket(void);
3516 /********************************* connection_or.c ***************************/
3518 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3519 void connection_or_clear_identity_map(void);
3520 or_connection_t
*connection_or_get_for_extend(const char *digest
,
3521 const tor_addr_t
*target_addr
,
3522 const char **msg_out
,
3524 void connection_or_set_bad_connections(void);
3526 int connection_or_reached_eof(or_connection_t
*conn
);
3527 int connection_or_process_inbuf(or_connection_t
*conn
);
3528 int connection_or_flushed_some(or_connection_t
*conn
);
3529 int connection_or_finished_flushing(or_connection_t
*conn
);
3530 int connection_or_finished_connecting(or_connection_t
*conn
);
3532 void connection_or_connect_failed(or_connection_t
*conn
,
3533 int reason
, const char *msg
);
3534 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3535 const char *id_digest
);
3537 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3538 int connection_tls_continue_handshake(or_connection_t
*conn
);
3540 void or_handshake_state_free(or_handshake_state_t
*state
);
3541 int connection_or_set_state_open(or_connection_t
*conn
);
3542 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3543 or_connection_t
*conn
);
3544 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3545 or_connection_t
*conn
);
3546 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3548 int connection_or_send_netinfo(or_connection_t
*conn
);
3549 int connection_or_send_cert(or_connection_t
*conn
);
3550 int connection_or_send_link_auth(or_connection_t
*conn
);
3551 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3553 int is_or_protocol_version_known(uint16_t version
);
3555 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3556 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3557 var_cell_t
*var_cell_new(uint16_t payload_len
);
3558 void var_cell_free(var_cell_t
*cell
);
3560 /********************************* control.c ***************************/
3562 /** Used to indicate the type of a circuit event passed to the controller.
3563 * The various types are defined in control-spec.txt */
3564 typedef enum circuit_status_event_t
{
3565 CIRC_EVENT_LAUNCHED
= 0,
3566 CIRC_EVENT_BUILT
= 1,
3567 CIRC_EVENT_EXTENDED
= 2,
3568 CIRC_EVENT_FAILED
= 3,
3569 CIRC_EVENT_CLOSED
= 4,
3570 } circuit_status_event_t
;
3572 /** Used to indicate the type of a stream event passed to the controller.
3573 * The various types are defined in control-spec.txt */
3574 typedef enum stream_status_event_t
{
3575 STREAM_EVENT_SENT_CONNECT
= 0,
3576 STREAM_EVENT_SENT_RESOLVE
= 1,
3577 STREAM_EVENT_SUCCEEDED
= 2,
3578 STREAM_EVENT_FAILED
= 3,
3579 STREAM_EVENT_CLOSED
= 4,
3580 STREAM_EVENT_NEW
= 5,
3581 STREAM_EVENT_NEW_RESOLVE
= 6,
3582 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3583 STREAM_EVENT_REMAP
= 8
3584 } stream_status_event_t
;
3586 /** Used to indicate the type of an OR connection event passed to the
3587 * controller. The various types are defined in control-spec.txt */
3588 typedef enum or_conn_status_event_t
{
3589 OR_CONN_EVENT_LAUNCHED
= 0,
3590 OR_CONN_EVENT_CONNECTED
= 1,
3591 OR_CONN_EVENT_FAILED
= 2,
3592 OR_CONN_EVENT_CLOSED
= 3,
3593 OR_CONN_EVENT_NEW
= 4,
3594 } or_conn_status_event_t
;
3596 void control_update_global_event_mask(void);
3597 void control_adjust_event_log_severity(void);
3599 /** Execute the statement <b>stmt</b>, which may log events concerning the
3600 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3601 * being sent to controllers if <b>conn</b> is a control connection.
3603 * Stmt must not contain any return or goto statements.
3605 #define CONN_LOG_PROTECT(conn, stmt) \
3607 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3608 if (_log_conn_is_control) \
3609 disable_control_logging(); \
3610 STMT_BEGIN stmt; STMT_END; \
3611 if (_log_conn_is_control) \
3612 enable_control_logging(); \
3615 /** Log information about the connection <b>conn</b>, protecting it as with
3616 * CONN_LOG_PROTECT. Example:
3618 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3620 #define LOG_FN_CONN(conn, args) \
3621 CONN_LOG_PROTECT(conn, log_fn args)
3623 int connection_control_finished_flushing(control_connection_t
*conn
);
3624 int connection_control_reached_eof(control_connection_t
*conn
);
3625 int connection_control_process_inbuf(control_connection_t
*conn
);
3627 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3628 #define EVENT_NS 0x000F
3629 int control_event_is_interesting(int event
);
3631 int control_event_circuit_status(origin_circuit_t
*circ
,
3632 circuit_status_event_t e
, int reason
);
3633 int control_event_stream_status(edge_connection_t
*conn
,
3634 stream_status_event_t e
,
3636 int control_event_or_conn_status(or_connection_t
*conn
,
3637 or_conn_status_event_t e
, int reason
);
3638 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3639 int control_event_stream_bandwidth(edge_connection_t
*edge_conn
);
3640 int control_event_stream_bandwidth_used(void);
3641 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3642 int control_event_descriptors_changed(smartlist_t
*routers
);
3643 int control_event_address_mapped(const char *from
, const char *to
,
3644 time_t expires
, const char *error
);
3645 int control_event_or_authdir_new_descriptor(const char *action
,
3649 int control_event_my_descriptor_changed(void);
3650 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3651 int control_event_newconsensus(const networkstatus_t
*consensus
);
3652 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3653 int control_event_general_status(int severity
, const char *format
, ...)
3655 int control_event_client_status(int severity
, const char *format
, ...)
3657 int control_event_server_status(int severity
, const char *format
, ...)
3659 int control_event_guard(const char *nickname
, const char *digest
,
3660 const char *status
);
3662 int init_cookie_authentication(int enabled
);
3663 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3664 void disable_control_logging(void);
3665 void enable_control_logging(void);
3667 /** Enum describing various stages of bootstrapping, for use with controller
3668 * bootstrap status events. The values range from 0 to 100. */
3670 BOOTSTRAP_STATUS_UNDEF
=-1,
3671 BOOTSTRAP_STATUS_STARTING
=0,
3672 BOOTSTRAP_STATUS_CONN_DIR
=5,
3673 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3674 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3675 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3676 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3677 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3678 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3679 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3680 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3681 BOOTSTRAP_STATUS_CONN_OR
=80,
3682 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3683 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3684 BOOTSTRAP_STATUS_DONE
=100
3685 } bootstrap_status_t
;
3687 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3688 void control_event_bootstrap_problem(const char *warn
, int reason
);
3690 void control_event_clients_seen(const char *controller_str
);
3692 #ifdef CONTROL_PRIVATE
3693 /* Used only by control.c and test.c */
3694 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3695 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3698 /********************************* cpuworker.c *****************************/
3700 void cpu_init(void);
3701 void cpuworkers_rotate(void);
3702 int connection_cpu_finished_flushing(connection_t
*conn
);
3703 int connection_cpu_reached_eof(connection_t
*conn
);
3704 int connection_cpu_process_inbuf(connection_t
*conn
);
3705 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3709 /********************************* directory.c ***************************/
3711 int directories_have_accepted_server_descriptor(void);
3712 char *authority_type_to_string(authority_type_t auth
);
3713 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3714 authority_type_t type
, const char *payload
,
3715 size_t payload_len
, size_t extrainfo_len
);
3716 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3717 const char *resource
,
3719 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3720 uint8_t router_purpose
,
3721 const char *resource
);
3722 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3723 uint8_t dir_purpose
,
3724 uint8_t router_purpose
,
3725 int anonymized_connection
,
3726 const char *resource
,
3727 const char *payload
,
3729 time_t if_modified_since
);
3730 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3731 uint8_t dir_purpose
,
3732 uint8_t router_purpose
,
3733 int anonymized_connection
,
3734 const char *resource
,
3735 const char *payload
,
3737 time_t if_modified_since
,
3738 const rend_data_t
*rend_query
);
3740 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3741 compress_method_t
*compression
, char **response
);
3743 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3744 int connection_dir_reached_eof(dir_connection_t
*conn
);
3745 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3746 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3747 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3748 void connection_dir_request_failed(dir_connection_t
*conn
);
3749 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3750 uint16_t or_port
, uint16_t dir_port
,
3751 int supports_conditional_consensus
,
3752 int supports_begindir
, const char *digest
,
3753 uint8_t dir_purpose
, uint8_t router_purpose
,
3754 int anonymized_connection
,
3755 const char *resource
,
3756 const char *payload
, size_t payload_len
,
3757 time_t if_modified_since
);
3759 #define DSR_HEX (1<<0)
3760 #define DSR_BASE64 (1<<1)
3761 #define DSR_DIGEST256 (1<<2)
3762 #define DSR_SORT_UNIQ (1<<3)
3763 int dir_split_resource_into_fingerprints(const char *resource
,
3764 smartlist_t
*fp_out
, int *compressed_out
,
3766 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
3768 char first
[DIGEST_LEN
];
3769 char second
[DIGEST_LEN
];
3771 int dir_split_resource_into_fingerprint_pairs(const char *res
,
3772 smartlist_t
*pairs_out
);
3773 char *directory_dump_request_log(void);
3774 void note_request(const char *key
, size_t bytes
);
3775 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3777 time_t download_status_increment_failure(download_status_t
*dls
,
3778 int status_code
, const char *item
,
3779 int server
, time_t now
);
3780 /** Increment the failure count of the download_status_t <b>dls</b>, with
3781 * the optional status code <b>sc</b>. */
3782 #define download_status_failed(dls, sc) \
3783 download_status_increment_failure((dls), (sc), NULL, \
3784 get_options()->DirPort, time(NULL))
3786 void download_status_reset(download_status_t
*dls
);
3787 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3789 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3790 * ready to get its download reattempted. */
3792 download_status_is_ready(download_status_t
*dls
, time_t now
,
3795 return (dls
->n_download_failures
<= max_failures
3796 && dls
->next_attempt_at
<= now
);
3799 static void download_status_mark_impossible(download_status_t
*dl
);
3800 /** Mark <b>dl</b> as never downloadable. */
3802 download_status_mark_impossible(download_status_t
*dl
)
3804 dl
->n_download_failures
= IMPOSSIBLE_TO_DOWNLOAD
;
3807 /********************************* dirserv.c ***************************/
3808 /** Maximum length of an exit policy summary. */
3809 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3811 /** Maximum allowable length of a version line in a networkstatus. */
3812 #define MAX_V_LINE_LEN 128
3813 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3814 * Running Stable Unnamed V2Dir Valid\n". */
3815 #define MAX_FLAG_LINE_LEN 96
3816 /** Length of "w" line for weighting. Currently at most
3817 * "w Bandwidth=<uint32t> Measured=<uint32t>\n" */
3818 #define MAX_WEIGHT_LINE_LEN (12+10+10+10+1)
3819 /** Maximum length of an exit policy summary line. */
3820 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3821 /** Amount of space to allocate for each entry: r, s, and v lines. */
3822 #define RS_ENTRY_LEN \
3823 ( /* first line */ \
3824 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3825 5*2 /* ports */ + 10 /* punctuation */ + \
3827 MAX_FLAG_LINE_LEN + \
3829 MAX_WEIGHT_LINE_LEN + \
3831 MAX_POLICY_LINE_LEN + \
3835 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3837 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3839 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3840 int dirserv_load_fingerprint_file(void);
3841 void dirserv_free_fingerprint_list(void);
3842 const char *dirserv_get_nickname_by_digest(const char *digest
);
3843 enum was_router_added_t
dirserv_add_multiple_descriptors(
3844 const char *desc
, uint8_t purpose
,
3847 enum was_router_added_t
dirserv_add_descriptor(routerinfo_t
*ri
,
3849 const char *source
);
3850 void dirserv_free_descriptors(void);
3851 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3852 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3853 int for_controller
);
3854 int dirserv_dump_directory_to_string(char **dir_out
,
3855 crypto_pk_env_t
*private_key
);
3857 int directory_fetches_from_authorities(or_options_t
*options
);
3858 int directory_fetches_dir_info_early(or_options_t
*options
);
3859 int directory_fetches_dir_info_later(or_options_t
*options
);
3860 int directory_caches_v2_dir_info(or_options_t
*options
);
3861 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3862 int directory_caches_dir_info(or_options_t
*options
);
3863 int directory_permits_begindir_requests(or_options_t
*options
);
3864 int directory_permits_controller_requests(or_options_t
*options
);
3865 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3867 void directory_set_dirty(void);
3868 cached_dir_t
*dirserv_get_directory(void);
3869 cached_dir_t
*dirserv_get_runningrouters(void);
3870 cached_dir_t
*dirserv_get_consensus(const char *flavor_name
);
3871 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3872 int is_running_routers
);
3873 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3874 const char *identity
,
3876 void dirserv_set_cached_consensus_networkstatus(const char *consensus
,
3877 const char *flavor_name
,
3878 const digests_t
*digests
,
3880 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3881 void dirserv_clear_old_v1_info(time_t now
);
3882 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3883 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3885 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3887 int for_unencrypted_conn
,
3889 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3891 void dirserv_orconn_tls_done(const char *address
,
3893 const char *digest_rcvd
,
3895 void dirserv_test_reachability(time_t now
, int try_all
);
3896 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3898 int dirserv_would_reject_router(routerstatus_t
*rs
);
3899 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3900 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3901 int dirserv_have_any_microdesc(const smartlist_t
*fps
);
3902 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3904 size_t dirserv_estimate_microdesc_size(const smartlist_t
*fps
, int compressed
);
3907 NS_V2
, NS_V3_CONSENSUS
, NS_V3_VOTE
, NS_CONTROL_PORT
,
3908 NS_V3_CONSENSUS_MICRODESC
3909 } routerstatus_format_type_t
;
3910 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3911 routerstatus_t
*rs
, const char *platform
,
3912 routerstatus_format_type_t format
);
3913 void dirserv_free_all(void);
3914 void cached_dir_decref(cached_dir_t
*d
);
3915 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3917 #ifdef DIRSERV_PRIVATE
3918 typedef struct measured_bw_line_t
{
3919 char node_id
[DIGEST_LEN
];
3920 char node_hex
[MAX_HEX_NICKNAME_LEN
+1];
3922 } measured_bw_line_t
;
3924 int measured_bw_line_parse(measured_bw_line_t
*out
, const char *line
);
3926 int measured_bw_line_apply(measured_bw_line_t
*parsed_line
,
3927 smartlist_t
*routerstatuses
);
3930 int dirserv_read_measured_bandwidths(const char *from_file
,
3931 smartlist_t
*routerstatuses
);
3933 /********************************* dirvote.c ************************/
3935 /** Lowest allowable value for VoteSeconds. */
3936 #define MIN_VOTE_SECONDS 20
3937 /** Lowest allowable value for DistSeconds. */
3938 #define MIN_DIST_SECONDS 20
3939 /** Smallest allowable voting interval. */
3940 #define MIN_VOTE_INTERVAL 300
3942 void dirvote_free_all(void);
3944 /* vote manipulation */
3945 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3946 int total_authorities
,
3947 crypto_pk_env_t
*identity_key
,
3948 crypto_pk_env_t
*signing_key
,
3949 const char *legacy_identity_key_digest
,
3950 crypto_pk_env_t
*legacy_signing_key
,
3951 consensus_flavor_t flavor
);
3952 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3953 ns_detached_signatures_t
*sigs
,
3954 const char **msg_out
);
3955 char *networkstatus_get_detached_signatures(smartlist_t
*consensuses
);
3956 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3958 /* cert manipulation */
3959 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3961 /** Describes the schedule by which votes should be generated. */
3962 typedef struct vote_timing_t
{
3964 int n_intervals_valid
;
3968 /* vote scheduling */
3969 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3970 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3971 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3972 void dirvote_act(or_options_t
*options
, time_t now
);
3974 /* invoked on timers and by outside triggers. */
3975 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3976 const char **msg_out
,
3978 int dirvote_add_signatures(const char *detached_signatures_body
,
3980 const char **msg_out
);
3983 const char *dirvote_get_pending_consensus(consensus_flavor_t flav
);
3984 const char *dirvote_get_pending_detached_signatures(void);
3986 #define DGV_INCLUDE_PENDING 2
3987 #define DGV_INCLUDE_PREVIOUS 4
3988 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3989 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3990 routerinfo_t
*ri
, time_t now
,
3991 int naming
, int exits_can_be_guards
,
3992 int listbadexits
, int listbaddirs
);
3993 void router_clear_status_flags(routerinfo_t
*ri
);
3995 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3996 authority_cert_t
*cert
);
3998 microdesc_t
*dirvote_create_microdescriptor(const routerinfo_t
*ri
);
3999 ssize_t
dirvote_format_microdesc_vote_line(char *out
, size_t out_len
,
4000 const microdesc_t
*md
);
4001 int vote_routerstatus_find_microdesc_hash(char *digest256_out
,
4002 const vote_routerstatus_t
*vrs
,
4004 digest_algorithm_t alg
);
4005 document_signature_t
*voter_get_sig_by_algorithm(
4006 const networkstatus_voter_info_t
*voter
,
4007 digest_algorithm_t alg
);
4009 #ifdef DIRVOTE_PRIVATE
4010 char *format_networkstatus_vote(crypto_pk_env_t
*private_key
,
4011 networkstatus_t
*v3_ns
);
4012 char *dirvote_compute_params(smartlist_t
*votes
);
4015 /********************************* dns.c ***************************/
4018 int has_dns_init_failed(void);
4019 void dns_free_all(void);
4020 uint32_t dns_clip_ttl(uint32_t ttl
);
4021 int dns_reset(void);
4022 void connection_dns_remove(edge_connection_t
*conn
);
4023 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
4024 void assert_all_pending_dns_resolves_ok(void);
4025 void dns_cancel_pending_resolve(const char *question
);
4026 int dns_resolve(edge_connection_t
*exitconn
);
4027 void dns_launch_correctness_checks(void);
4028 int dns_seems_to_be_broken(void);
4029 void dns_reset_correctness_checks(void);
4030 void dump_dns_mem_usage(int severity
);
4032 /********************************* dnsserv.c ************************/
4034 void dnsserv_configure_listener(connection_t
*conn
);
4035 void dnsserv_close_listener(connection_t
*conn
);
4036 void dnsserv_resolved(edge_connection_t
*conn
,
4041 void dnsserv_reject_request(edge_connection_t
*conn
);
4042 int dnsserv_launch_request(const char *name
, int is_reverse
);
4044 /********************************* geoip.c **************************/
4046 /** Round all GeoIP results to the next multiple of this value, to avoid
4047 * leaking information. */
4048 #define DIR_RECORD_USAGE_GRANULARITY 8
4049 /** Time interval: Flush geoip data to disk this often. */
4050 #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
4051 /** How long do we have to have observed per-country request history before
4052 * we are willing to talk about it? */
4053 #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
4055 #ifdef GEOIP_PRIVATE
4056 int geoip_parse_entry(const char *line
);
4058 int should_record_bridge_info(or_options_t
*options
);
4059 int geoip_load_file(const char *filename
, or_options_t
*options
);
4060 int geoip_get_country_by_ip(uint32_t ipaddr
);
4061 int geoip_get_n_countries(void);
4062 const char *geoip_get_country_name(country_t num
);
4063 int geoip_is_loaded(void);
4064 country_t
geoip_get_country(const char *countrycode
);
4065 /** Indicates an action that we might be noting geoip statistics on.
4066 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
4067 * the others, we're not.
4070 /** We've noticed a connection as a bridge relay or entry guard. */
4071 GEOIP_CLIENT_CONNECT
= 0,
4072 /** We've served a networkstatus consensus as a directory server. */
4073 GEOIP_CLIENT_NETWORKSTATUS
= 1,
4074 /** We've served a v2 networkstatus consensus as a directory server. */
4075 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
4076 } geoip_client_action_t
;
4077 void geoip_note_client_seen(geoip_client_action_t action
,
4078 uint32_t addr
, time_t now
);
4079 void geoip_remove_old_clients(time_t cutoff
);
4080 /** Indicates either a positive reply or a reason for rejectng a network
4081 * status request that will be included in geoip statistics. */
4083 /** Request is answered successfully. */
4085 /** V3 network status is not signed by a sufficient number of requested
4087 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
4088 /** Requested network status object is unavailable. */
4089 GEOIP_REJECT_UNAVAILABLE
= 2,
4090 /** Requested network status not found. */
4091 GEOIP_REJECT_NOT_FOUND
= 3,
4092 /** Network status has not been modified since If-Modified-Since time. */
4093 GEOIP_REJECT_NOT_MODIFIED
= 4,
4094 /** Directory is busy. */
4095 GEOIP_REJECT_BUSY
= 5,
4096 } geoip_ns_response_t
;
4097 #define GEOIP_NS_RESPONSE_NUM 6
4098 void geoip_note_ns_response(geoip_client_action_t action
,
4099 geoip_ns_response_t response
);
4100 time_t geoip_get_history_start(void);
4101 char *geoip_get_client_history_dirreq(time_t now
,
4102 geoip_client_action_t action
);
4103 char *geoip_get_client_history_bridge(time_t now
,
4104 geoip_client_action_t action
);
4105 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
4106 int getinfo_helper_geoip(control_connection_t
*control_conn
,
4107 const char *question
, char **answer
);
4108 void geoip_free_all(void);
4110 /** Directory requests that we are measuring can be either direct or
4114 DIRREQ_TUNNELED
= 1,
4117 /** Possible states for either direct or tunneled directory requests that
4118 * are relevant for determining network status download times. */
4120 /** Found that the client requests a network status; applies to both
4121 * direct and tunneled requests; initial state of a request that we are
4123 DIRREQ_IS_FOR_NETWORK_STATUS
= 0,
4124 /** Finished writing a network status to the directory connection;
4125 * applies to both direct and tunneled requests; completes a direct
4127 DIRREQ_FLUSHING_DIR_CONN_FINISHED
= 1,
4128 /** END cell sent to circuit that initiated a tunneled request. */
4129 DIRREQ_END_CELL_SENT
= 2,
4130 /** Flushed last cell from queue of the circuit that initiated a
4131 * tunneled request to the outbuf of the OR connection. */
4132 DIRREQ_CIRC_QUEUE_FLUSHED
= 3,
4133 /** Flushed last byte from buffer of the OR connection belonging to the
4134 * circuit that initiated a tunneled request; completes a tunneled
4136 DIRREQ_OR_CONN_BUFFER_FLUSHED
= 4
4139 void geoip_start_dirreq(uint64_t dirreq_id
, size_t response_size
,
4140 geoip_client_action_t action
, dirreq_type_t type
);
4141 void geoip_change_dirreq_state(uint64_t dirreq_id
, dirreq_type_t type
,
4142 dirreq_state_t new_state
);
4144 void geoip_dirreq_stats_init(time_t now
);
4145 void geoip_dirreq_stats_write(time_t now
);
4146 void geoip_entry_stats_init(time_t now
);
4147 void geoip_entry_stats_write(time_t now
);
4148 void geoip_bridge_stats_init(time_t now
);
4149 time_t geoip_bridge_stats_write(time_t now
);
4150 char *geoip_get_bridge_stats_extrainfo(time_t);
4151 char *geoip_get_bridge_stats_controller(time_t);
4153 /********************************* hibernate.c **********************/
4155 int accounting_parse_options(or_options_t
*options
, int validate_only
);
4156 int accounting_is_enabled(or_options_t
*options
);
4157 void configure_accounting(time_t now
);
4158 void accounting_run_housekeeping(time_t now
);
4159 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
4160 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
4161 void hibernate_begin_shutdown(void);
4162 int we_are_hibernating(void);
4163 void consider_hibernation(time_t now
);
4164 int getinfo_helper_accounting(control_connection_t
*conn
,
4165 const char *question
, char **answer
);
4166 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
4168 /********************************* main.c ***************************/
4170 extern int has_completed_circuit
;
4172 int connection_add(connection_t
*conn
);
4173 int connection_remove(connection_t
*conn
);
4174 void connection_unregister_events(connection_t
*conn
);
4175 int connection_in_array(connection_t
*conn
);
4176 void add_connection_to_closeable_list(connection_t
*conn
);
4177 int connection_is_on_closeable_list(connection_t
*conn
);
4179 smartlist_t
*get_connection_array(void);
4181 typedef enum watchable_events
{
4184 } watchable_events_t
;
4185 void connection_watch_events(connection_t
*conn
, watchable_events_t events
);
4186 int connection_is_reading(connection_t
*conn
);
4187 void connection_stop_reading(connection_t
*conn
);
4188 void connection_start_reading(connection_t
*conn
);
4190 int connection_is_writing(connection_t
*conn
);
4191 void connection_stop_writing(connection_t
*conn
);
4192 void connection_start_writing(connection_t
*conn
);
4194 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
4196 void directory_all_unreachable(time_t now
);
4197 void directory_info_has_arrived(time_t now
, int from_cache
);
4199 void ip_address_changed(int at_interface
);
4200 void dns_servers_relaunch_checks(void);
4202 void control_signal_act(int the_signal
);
4203 void handle_signals(int is_parent
);
4205 int try_locking(or_options_t
*options
, int err_if_locked
);
4206 int have_lockfile(void);
4207 void release_lockfile(void);
4209 void tor_cleanup(void);
4210 void tor_free_all(int postfork
);
4212 int tor_main(int argc
, char *argv
[]);
4215 int do_main_loop(void);
4216 int do_list_fingerprint(void);
4217 void do_hash_password(void);
4218 int tor_init(int argc
, char **argv
);
4221 /********************************* microdesc.c *************************/
4223 typedef struct microdesc_cache_t microdesc_cache_t
;
4225 microdesc_cache_t
*get_microdesc_cache(void);
4227 smartlist_t
*microdescs_add_to_cache(microdesc_cache_t
*cache
,
4228 const char *s
, const char *eos
, saved_location_t where
,
4230 smartlist_t
*microdescs_add_list_to_cache(microdesc_cache_t
*cache
,
4231 smartlist_t
*descriptors
, saved_location_t where
,
4234 int microdesc_cache_rebuild(microdesc_cache_t
*cache
);
4235 int microdesc_cache_reload(microdesc_cache_t
*cache
);
4236 void microdesc_cache_clear(microdesc_cache_t
*cache
);
4238 microdesc_t
*microdesc_cache_lookup_by_digest256(microdesc_cache_t
*cache
,
4241 size_t microdesc_average_size(microdesc_cache_t
*cache
);
4243 void microdesc_free(microdesc_t
*md
);
4244 void microdesc_free_all(void);
4246 /********************************* networkstatus.c *********************/
4248 /** How old do we allow a v2 network-status to get before removing it
4250 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
4252 /** Location where we found a v2 networkstatus. */
4254 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
4255 } v2_networkstatus_source_t
;
4257 /** Possible statuses of a version of Tor, given opinions from the directory
4259 typedef enum version_status_t
{
4260 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
4261 VS_OLD
=1, /**< This version is older than any recommended version. */
4262 VS_NEW
=2, /**< This version is newer than any recommended version. */
4263 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
4264 * in its series, but later recommended versions exist.
4266 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
4267 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
4268 VS_UNKNOWN
, /**< We have no idea. */
4271 void networkstatus_reset_warnings(void);
4272 void networkstatus_reset_download_failures(void);
4273 int router_reload_v2_networkstatus(void);
4274 int router_reload_consensus_networkstatus(void);
4275 void routerstatus_free(routerstatus_t
*rs
);
4276 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
4277 void networkstatus_vote_free(networkstatus_t
*ns
);
4278 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
4279 networkstatus_t
*vote
,
4280 const char *identity
);
4281 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
4283 int networkstatus_check_document_signature(const networkstatus_t
*consensus
,
4284 document_signature_t
*sig
,
4285 const authority_cert_t
*cert
);
4286 char *networkstatus_get_cache_filename(const char *identity_digest
);
4287 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
4288 v2_networkstatus_source_t source
,
4289 smartlist_t
*requested_fingerprints
);
4290 void networkstatus_v2_list_clean(time_t now
);
4291 int compare_digest_to_routerstatus_entry(const void *_key
,
4292 const void **_member
);
4293 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
4294 const char *digest
);
4295 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
4296 const char *digest
);
4297 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
4298 const char *digest
, int *found_out
);
4299 const smartlist_t
*networkstatus_get_v2_list(void);
4300 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
4301 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
4302 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
4303 const char *digest
);
4304 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
4305 int warn_if_unnamed
);
4306 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
4307 int networkstatus_nickname_is_unnamed(const char *nickname
);
4308 void networkstatus_consensus_download_failed(int status_code
);
4309 void update_consensus_networkstatus_fetch_time(time_t now
);
4310 int should_delay_dir_fetches(or_options_t
*options
);
4311 void update_networkstatus_downloads(time_t now
);
4312 void update_certificate_downloads(time_t now
);
4313 int consensus_is_waiting_for_certs(void);
4314 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
4315 networkstatus_t
*networkstatus_get_latest_consensus(void);
4316 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
4317 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
4318 #define NSSET_FROM_CACHE 1
4319 #define NSSET_WAS_WAITING_FOR_CERTS 2
4320 #define NSSET_DONT_DOWNLOAD_CERTS 4
4321 #define NSSET_ACCEPT_OBSOLETE 8
4322 #define NSSET_REQUIRE_FLAVOR 16
4323 int networkstatus_set_current_consensus(const char *consensus
,
4326 void networkstatus_note_certs_arrived(void);
4327 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
4328 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
4329 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
4330 int reset_failures
);
4331 void signed_descs_update_status_from_consensus_networkstatus(
4332 smartlist_t
*descs
);
4334 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
4335 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
4336 void networkstatus_dump_bridge_status_to_file(time_t now
);
4337 int32_t networkstatus_get_param(networkstatus_t
*ns
, const char *param_name
,
4338 int32_t default_val
);
4339 int getinfo_helper_networkstatus(control_connection_t
*conn
,
4340 const char *question
, char **answer
);
4341 const char *networkstatus_get_flavor_name(consensus_flavor_t flav
);
4342 int networkstatus_parse_flavor_name(const char *flavname
);
4343 void document_signature_free(document_signature_t
*sig
);
4344 document_signature_t
*document_signature_dup(const document_signature_t
*sig
);
4345 void networkstatus_free_all(void);
4347 /********************************* ntmain.c ***************************/
4353 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
4354 int nt_service_is_stopping(void);
4355 void nt_service_set_state(DWORD state
);
4357 #define nt_service_is_stopping() (0)
4360 /********************************* onion.c ***************************/
4362 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
4363 or_circuit_t
*onion_next_task(char **onionskin_out
);
4364 void onion_pending_remove(or_circuit_t
*circ
);
4366 int onion_skin_create(crypto_pk_env_t
*router_key
,
4367 crypto_dh_env_t
**handshake_state_out
,
4368 char *onion_skin_out
);
4370 int onion_skin_server_handshake(const char *onion_skin
,
4371 crypto_pk_env_t
*private_key
,
4372 crypto_pk_env_t
*prev_private_key
,
4373 char *handshake_reply_out
,
4375 size_t key_out_len
);
4377 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
4378 const char *handshake_reply
,
4380 size_t key_out_len
);
4382 int fast_server_handshake(const char *key_in
,
4383 char *handshake_reply_out
,
4385 size_t key_out_len
);
4387 int fast_client_handshake(const char *handshake_state
,
4388 const char *handshake_reply_out
,
4390 size_t key_out_len
);
4392 void clear_pending_onions(void);
4394 /********************************* policies.c ************************/
4396 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
4399 #define POLICY_BUF_LEN 52
4401 /** Outcome of applying an address policy to an address. */
4403 /** The address was accepted */
4404 ADDR_POLICY_ACCEPTED
=0,
4405 /** The address was rejected */
4406 ADDR_POLICY_REJECTED
=-1,
4407 /** Part of the address was unknown, but as far as we can tell, it was
4409 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
4410 /** Part of the address was unknown, but as far as we can tell, it was
4412 ADDR_POLICY_PROBABLY_REJECTED
=2
4413 } addr_policy_result_t
;
4415 int firewall_is_fascist_or(void);
4416 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
4417 int fascist_firewall_allows_or(routerinfo_t
*ri
);
4418 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
4419 int dir_policy_permits_address(const tor_addr_t
*addr
);
4420 int socks_policy_permits_address(const tor_addr_t
*addr
);
4421 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
4422 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
4423 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
4424 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
4426 int validate_addr_policies(or_options_t
*options
, char **msg
);
4427 void policy_expand_private(smartlist_t
**policy
);
4428 int policies_parse_from_options(or_options_t
*options
);
4430 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
4431 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
4432 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
4433 uint16_t port
, const smartlist_t
*policy
);
4434 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
4435 uint16_t port
, const smartlist_t
*policy
);
4436 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
4437 int rejectprivate
, const char *local_address
,
4438 int add_default_policy
);
4439 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
4440 int exit_policy_is_general_exit(smartlist_t
*policy
);
4441 int policy_is_reject_star(const smartlist_t
*policy
);
4442 int getinfo_helper_policies(control_connection_t
*conn
,
4443 const char *question
, char **answer
);
4444 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
4445 int format_for_desc
);
4447 void addr_policy_list_free(smartlist_t
*p
);
4448 void addr_policy_free(addr_policy_t
*p
);
4449 void policies_free_all(void);
4451 char *policy_summarize(smartlist_t
*policy
);
4453 /********************************* reasons.c ***************************/
4455 const char *stream_end_reason_to_control_string(int reason
);
4456 const char *stream_end_reason_to_string(int reason
);
4457 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
4458 uint8_t errno_to_stream_end_reason(int e
);
4460 const char *orconn_end_reason_to_control_string(int r
);
4461 int tls_error_to_orconn_end_reason(int e
);
4462 int errno_to_orconn_end_reason(int e
);
4464 const char *circuit_end_reason_to_control_string(int reason
);
4465 const char *socks4_response_code_to_string(uint8_t code
);
4466 const char *socks5_response_code_to_string(uint8_t code
);
4468 /********************************* relay.c ***************************/
4470 extern uint64_t stats_n_relay_cells_relayed
;
4471 extern uint64_t stats_n_relay_cells_delivered
;
4473 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
4474 cell_direction_t cell_direction
);
4476 void relay_header_pack(char *dest
, const relay_header_t
*src
);
4477 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
4478 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
4479 uint8_t relay_command
, const char *payload
,
4480 size_t payload_len
, crypt_path_t
*cpath_layer
);
4481 int connection_edge_send_command(edge_connection_t
*fromconn
,
4482 uint8_t relay_command
, const char *payload
,
4483 size_t payload_len
);
4484 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
4485 int package_partial
);
4486 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
4488 extern uint64_t stats_n_data_cells_packaged
;
4489 extern uint64_t stats_n_data_bytes_packaged
;
4490 extern uint64_t stats_n_data_cells_received
;
4491 extern uint64_t stats_n_data_bytes_received
;
4493 void init_cell_pool(void);
4494 void free_cell_pool(void);
4495 void clean_cell_pool(void);
4496 void dump_cell_pool_usage(int severity
);
4498 void cell_queue_clear(cell_queue_t
*queue
);
4499 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
4500 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
4502 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
4503 cell_t
*cell
, cell_direction_t direction
);
4504 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
4505 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
4506 int max
, time_t now
);
4507 void assert_active_circuits_ok(or_connection_t
*orconn
);
4508 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
4509 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
4511 int append_address_to_payload(char *payload_out
, const tor_addr_t
*addr
);
4512 const char *decode_address_from_payload(tor_addr_t
*addr_out
,
4513 const char *payload
,
4515 unsigned cell_ewma_get_tick(void);
4516 void cell_ewma_set_scale_factor(or_options_t
*options
,
4517 networkstatus_t
*consensus
);
4519 /********************************* rephist.c ***************************/
4521 void rep_hist_init(void);
4522 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
4523 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
4524 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
4525 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
4526 void rep_hist_note_extend_succeeded(const char *from_name
,
4527 const char *to_name
);
4528 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
4529 void rep_hist_dump_stats(time_t now
, int severity
);
4530 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
4531 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
4532 void rep_hist_note_exit_bytes_read(uint16_t port
, size_t num_bytes
);
4533 void rep_hist_note_exit_bytes_written(uint16_t port
, size_t num_bytes
);
4534 void rep_hist_note_exit_stream_opened(uint16_t port
);
4535 void rep_hist_exit_stats_init(time_t now
);
4536 void rep_hist_exit_stats_write(time_t now
);
4537 int rep_hist_bandwidth_assess(void);
4538 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
4539 void rep_hist_update_state(or_state_t
*state
);
4540 int rep_hist_load_state(or_state_t
*state
, char **err
);
4541 void rep_history_clean(time_t before
);
4543 void rep_hist_note_router_reachable(const char *id
, time_t when
);
4544 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
4545 int rep_hist_record_mtbf_data(time_t now
, int missing_means_down
);
4546 int rep_hist_load_mtbf_data(time_t now
);
4548 time_t rep_hist_downrate_old_runs(time_t now
);
4549 double rep_hist_get_stability(const char *id
, time_t when
);
4550 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
4551 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
4552 int rep_hist_have_measured_enough_stability(void);
4553 const char *rep_hist_get_router_stability_doc(time_t now
);
4555 void rep_hist_note_used_port(time_t now
, uint16_t port
);
4556 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
4557 void rep_hist_note_used_resolve(time_t now
);
4558 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
4560 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
4561 int *need_capacity
);
4563 int any_predicted_circuits(time_t now
);
4564 int rep_hist_circbuilding_dormant(time_t now
);
4566 /** Possible public/private key operations in Tor: used to keep track of where
4567 * we're spending our time. */
4570 VERIFY_DIR
, VERIFY_RTR
,
4571 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4572 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4573 REND_CLIENT
, REND_MID
, REND_SERVER
,
4575 void note_crypto_pk_op(pk_op_t operation
);
4576 void dump_pk_ops(int severity
);
4578 void rep_hist_free_all(void);
4580 /* for hidden service usage statistics */
4581 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
4582 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
4583 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
4584 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
4585 void hs_usage_write_statistics_to_file(time_t now
);
4586 void hs_usage_free_all(void);
4588 void rep_hist_buffer_stats_init(time_t now
);
4589 void rep_hist_buffer_stats_add_circ(circuit_t
*circ
,
4590 time_t end_of_interval
);
4591 void rep_hist_buffer_stats_write(time_t now
);
4593 /********************************* rendclient.c ***************************/
4595 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
4596 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
4597 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
4598 size_t request_len
);
4599 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
4600 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
4601 const rend_data_t
*rend_query
);
4602 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
4603 size_t request_len
);
4604 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
4605 size_t request_len
);
4606 void rend_client_desc_trynow(const char *query
);
4608 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
4610 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
4611 origin_circuit_t
*rendcirc
);
4612 int rend_parse_service_authorization(or_options_t
*options
,
4614 rend_service_authorization_t
*rend_client_lookup_service_authorization(
4615 const char *onion_address
);
4616 void rend_service_authorization_free_all(void);
4617 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
4619 /********************************* rendcommon.c ***************************/
4621 /** Hidden-service side configuration of client authorization. */
4622 typedef struct rend_authorized_client_t
{
4624 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4625 crypto_pk_env_t
*client_key
;
4626 } rend_authorized_client_t
;
4628 /** ASCII-encoded v2 hidden service descriptor. */
4629 typedef struct rend_encoded_v2_service_descriptor_t
{
4630 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4631 char *desc_str
; /**< Descriptor string. */
4632 } rend_encoded_v2_service_descriptor_t
;
4634 /** Introduction point information. */
4635 typedef struct rend_intro_point_t
{
4636 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4637 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
4638 * key, if this descriptor is V2. */
4639 } rend_intro_point_t
;
4641 /** Information used to connect to a hidden service. */
4642 typedef struct rend_service_descriptor_t
{
4643 crypto_pk_env_t
*pk
; /**< This service's public key. */
4644 int version
; /**< Version of the descriptor format: 0 or 2. */
4645 time_t timestamp
; /**< Time when the descriptor was generated. */
4646 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
4647 * (We allow bits '0', '1', and '2' to be set.) */
4648 /** List of the service's introduction points. Elements are removed if
4649 * introduction attempts fail. */
4650 smartlist_t
*intro_nodes
;
4651 /** Has descriptor been uploaded to all hidden service directories? */
4652 int all_uploads_performed
;
4653 /** List of hidden service directories to which an upload request for
4654 * this descriptor could be sent. Smartlist exists only when at least one
4655 * of the previous upload requests failed (otherwise it's not important
4656 * to know which uploads succeeded and which not). */
4657 smartlist_t
*successful_uploads
;
4658 } rend_service_descriptor_t
;
4660 /** Free all storage associated with <b>data</b> */
4662 rend_data_free(rend_data_t
*data
)
4667 int rend_cmp_service_ids(const char *one
, const char *two
);
4669 void rend_process_relay_cell(circuit_t
*circ
, const crypt_path_t
*layer_hint
,
4670 int command
, size_t length
, const char *payload
);
4672 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
4673 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
4675 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
4676 void rend_encoded_v2_service_descriptor_free(
4677 rend_encoded_v2_service_descriptor_t
*desc
);
4678 void rend_intro_point_free(rend_intro_point_t
*intro
);
4680 /** A cached rendezvous descriptor. */
4681 typedef struct rend_cache_entry_t
{
4682 size_t len
; /**< Length of <b>desc</b> */
4683 time_t received
; /**< When was the descriptor received? */
4684 char *desc
; /**< Service descriptor */
4685 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
4686 } rend_cache_entry_t
;
4688 void rend_cache_init(void);
4689 void rend_cache_clean(void);
4690 void rend_cache_clean_v2_descs_as_dir(void);
4691 void rend_cache_free_all(void);
4692 int rend_valid_service_id(const char *query
);
4693 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
4695 int rend_cache_lookup_entry(const char *query
, int version
,
4696 rend_cache_entry_t
**entry_out
);
4697 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
4698 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
4699 int rend_cache_store_v2_desc_as_client(const char *desc
,
4700 const rend_data_t
*rend_query
);
4701 int rend_cache_store_v2_desc_as_dir(const char *desc
);
4702 int rend_cache_size(void);
4703 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
4704 rend_service_descriptor_t
*desc
, time_t now
,
4705 uint8_t period
, rend_auth_type_t auth_type
,
4706 crypto_pk_env_t
*client_key
,
4707 smartlist_t
*client_cookies
);
4708 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
4709 const char *descriptor_cookie
,
4710 time_t now
, uint8_t replica
);
4711 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4712 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4713 const char *service_id
,
4714 const char *secret_id_part
);
4716 /********************************* rendservice.c ***************************/
4718 int num_rend_services(void);
4719 int rend_config_services(or_options_t
*options
, int validate_only
);
4720 int rend_service_load_keys(void);
4721 void rend_services_init(void);
4722 void rend_services_introduce(void);
4723 void rend_consider_services_upload(time_t now
);
4724 void rend_hsdir_routers_changed(void);
4725 void rend_consider_descriptor_republication(void);
4727 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4728 int rend_service_intro_established(origin_circuit_t
*circuit
,
4729 const char *request
,
4730 size_t request_len
);
4731 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4732 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
4733 size_t request_len
);
4734 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4735 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4736 origin_circuit_t
*circ
);
4737 void rend_service_dump_stats(int severity
);
4738 void rend_service_free_all(void);
4740 /********************************* rendmid.c *******************************/
4741 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
4742 size_t request_len
);
4743 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
4744 size_t request_len
);
4745 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
4746 size_t request_len
);
4747 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
4748 size_t request_len
);
4750 /********************************* router.c ***************************/
4752 crypto_pk_env_t
*get_onion_key(void);
4753 time_t get_onion_key_set_at(void);
4754 void set_identity_key(crypto_pk_env_t
*k
);
4755 crypto_pk_env_t
*get_identity_key(void);
4756 int identity_key_is_set(void);
4757 authority_cert_t
*get_my_v3_authority_cert(void);
4758 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4759 authority_cert_t
*get_my_v3_legacy_cert(void);
4760 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4761 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4762 void rotate_onion_key(void);
4763 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4765 void v3_authority_check_key_expiry(void);
4767 int init_keys(void);
4769 int check_whether_orport_reachable(void);
4770 int check_whether_dirport_reachable(void);
4771 void consider_testing_reachability(int test_or
, int test_dir
);
4772 void router_orport_found_reachable(void);
4773 void router_dirport_found_reachable(void);
4774 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4776 int authdir_mode(or_options_t
*options
);
4777 int authdir_mode_v1(or_options_t
*options
);
4778 int authdir_mode_v2(or_options_t
*options
);
4779 int authdir_mode_v3(or_options_t
*options
);
4780 int authdir_mode_any_main(or_options_t
*options
);
4781 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4782 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4783 int authdir_mode_publishes_statuses(or_options_t
*options
);
4784 int authdir_mode_tests_reachability(or_options_t
*options
);
4785 int authdir_mode_bridge(or_options_t
*options
);
4787 int clique_mode(or_options_t
*options
);
4788 int server_mode(or_options_t
*options
);
4789 int advertised_server_mode(void);
4790 int proxy_mode(or_options_t
*options
);
4791 void consider_publishable_server(int force
);
4793 int router_is_clique_mode(routerinfo_t
*router
);
4794 void router_upload_dir_desc_to_dirservers(int force
);
4795 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4796 void mark_my_descriptor_dirty(void);
4797 void check_descriptor_bandwidth_changed(time_t now
);
4798 void check_descriptor_ipaddress_changed(time_t now
);
4799 void router_new_address_suggestion(const char *suggestion
,
4800 const dir_connection_t
*d_conn
);
4801 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4802 routerinfo_t
*router_get_my_routerinfo(void);
4803 extrainfo_t
*router_get_my_extrainfo(void);
4804 const char *router_get_my_descriptor(void);
4805 int router_digest_is_me(const char *digest
);
4806 int router_extrainfo_digest_is_me(const char *digest
);
4807 int router_is_me(routerinfo_t
*router
);
4808 int router_fingerprint_is_me(const char *fp
);
4809 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4810 int router_rebuild_descriptor(int force
);
4811 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4812 crypto_pk_env_t
*ident_key
);
4813 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4814 crypto_pk_env_t
*ident_key
);
4815 int is_legal_nickname(const char *s
);
4816 int is_legal_nickname_or_hexdigest(const char *s
);
4817 int is_legal_hexdigest(const char *s
);
4818 void router_get_verbose_nickname(char *buf
, const routerinfo_t
*router
);
4819 void routerstatus_get_verbose_nickname(char *buf
,
4820 const routerstatus_t
*router
);
4821 void router_reset_warnings(void);
4822 void router_reset_reachability(void);
4823 void router_free_all(void);
4825 const char *router_purpose_to_string(uint8_t p
);
4826 uint8_t router_purpose_from_string(const char *s
);
4828 #ifdef ROUTER_PRIVATE
4829 /* Used only by router.c and test.c */
4830 void get_platform_str(char *platform
, size_t len
);
4833 /********************************* routerlist.c ***************************/
4835 /** Represents information about a single trusted directory server. */
4836 typedef struct trusted_dir_server_t
{
4839 char *address
; /**< Hostname. */
4840 uint32_t addr
; /**< IPv4 address. */
4841 uint16_t dir_port
; /**< Directory port. */
4842 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4843 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4844 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4845 * high-security) identity key. */
4847 unsigned int is_running
:1; /**< True iff we think this server is running. */
4849 /** True iff this server has accepted the most recent server descriptor
4850 * we tried to upload to it. */
4851 unsigned int has_accepted_serverdesc
:1;
4853 /** What kind of authority is this? (Bitfield.) */
4854 authority_type_t type
;
4856 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4857 * v2 network status. */
4858 time_t addr_current_at
; /**< When was the document that we derived the
4859 * address information from published? */
4861 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4862 * dir_server_t to directory_initiate_command_*
4863 * as a routerstatus_t. Not updated by the
4864 * router-status management code!
4866 } trusted_dir_server_t
;
4868 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
4870 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4872 int get_n_authorities(authority_type_t type
);
4873 int trusted_dirs_reload_certs(void);
4874 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4876 void trusted_dirs_flush_certs_to_disk(void);
4877 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4878 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4879 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4880 const char *sk_digest
);
4881 void authority_cert_get_all(smartlist_t
*certs_out
);
4882 void authority_cert_dl_failed(const char *id_digest
, int status
);
4883 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4884 int router_reload_router_list(void);
4885 smartlist_t
*router_get_trusted_dir_servers(void);
4887 /* Flags for pick_directory_server and pick_trusteddirserver. */
4888 /** Flag to indicate that we should not automatically be willing to use
4889 * ourself to answer a directory request.
4890 * Passed to router_pick_directory_server (et al).*/
4891 #define PDS_ALLOW_SELF (1<<0)
4892 /** Flag to indicate that if no servers seem to be up, we should mark all
4893 * directory servers as up and try again.
4894 * Passed to router_pick_directory_server (et al).*/
4895 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4896 /** Flag to indicate that we should not exclude directory servers that
4897 * our ReachableAddress settings would exclude. This usually means that
4898 * we're going to connect to the server over Tor, and so we don't need to
4899 * worry about our firewall telling us we can't.
4900 * Passed to router_pick_directory_server (et al).*/
4901 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4902 /** Flag to indicate that we should not use any directory authority to which
4903 * we have an existing directory connection for downloading server descriptors
4904 * or extrainfo documents.
4906 * Passed to router_pick_directory_server (et al)
4908 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
4909 * not pick_directory_server. If we make it work on pick_directory_server
4910 * too, we could conservatively make it only prevent multiple fetches to
4911 * the same authority, or we could aggressively make it prevent multiple
4912 * fetches to _any_ single directory server.]
4914 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4915 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4916 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4917 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4918 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4919 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4920 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4921 double *v3_share_out
);
4922 void router_reset_status_download_failures(void);
4923 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4924 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4925 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4926 int must_be_running
);
4927 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4928 routerinfo_t
*routerlist_find_my_routerinfo(void);
4929 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4931 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4932 int need_capacity
, int need_guard
);
4933 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4934 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4936 /** Possible ways to weight routers when choosing one randomly. See
4937 * routerlist_sl_choose_by_bandwidth() for more information.*/
4939 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4940 } bandwidth_weight_rule_t
;
4941 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4942 bandwidth_weight_rule_t rule
);
4943 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4945 /** Flags to be passed to control router_choose_random_node() to indicate what
4946 * kind of nodes to pick according to what algorithm. */
4948 CRN_NEED_UPTIME
= 1<<0,
4949 CRN_NEED_CAPACITY
= 1<<1,
4950 CRN_NEED_GUARD
= 1<<2,
4951 CRN_ALLOW_INVALID
= 1<<3,
4952 /* XXXX not used, apparently. */
4953 CRN_WEIGHT_AS_EXIT
= 1<<5
4954 } router_crn_flags_t
;
4956 routerinfo_t
*router_choose_random_node(smartlist_t
*excludedsmartlist
,
4957 struct routerset_t
*excludedset
,
4958 router_crn_flags_t flags
);
4960 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4961 int warn_if_unnamed
);
4962 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4963 int router_digest_is_trusted_dir_type(const char *digest
,
4964 authority_type_t type
);
4965 #define router_digest_is_trusted_dir(d) \
4966 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4968 int router_addr_is_trusted_dir(uint32_t addr
);
4969 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4970 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4971 routerinfo_t
*router_get_by_digest(const char *digest
);
4972 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4973 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4974 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4975 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4976 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4977 routerlist_t
*router_get_routerlist(void);
4978 void routerinfo_free(routerinfo_t
*router
);
4979 void extrainfo_free(extrainfo_t
*extrainfo
);
4980 void routerlist_free(routerlist_t
*rl
);
4981 void dump_routerlist_mem_usage(int severity
);
4982 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
,
4984 void routerlist_free_all(void);
4985 void routerlist_reset_warnings(void);
4986 void router_set_status(const char *digest
, int up
);
4988 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
4989 typedef enum was_router_added_t
{
4990 ROUTER_ADDED_SUCCESSFULLY
= 1,
4991 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
4993 ROUTER_WAS_NOT_NEW
= -2,
4994 ROUTER_NOT_IN_CONSENSUS
= -3,
4995 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
4996 ROUTER_AUTHDIR_REJECTS
= -5,
4997 } was_router_added_t
;
4999 static int WRA_WAS_ADDED(was_router_added_t s
);
5000 static int WRA_WAS_OUTDATED(was_router_added_t s
);
5001 static int WRA_WAS_REJECTED(was_router_added_t s
);
5002 /** Return true iff the descriptor was added. It might still be necessary to
5003 * check whether the descriptor generator should be notified.
5006 WRA_WAS_ADDED(was_router_added_t s
) {
5007 return s
== ROUTER_ADDED_SUCCESSFULLY
|| s
== ROUTER_ADDED_NOTIFY_GENERATOR
;
5009 /** Return true iff the descriptor was not added because it was either:
5010 * - not in the consensus
5011 * - neither in the consensus nor in any networkstatus document
5012 * - it was outdated.
5014 static INLINE
int WRA_WAS_OUTDATED(was_router_added_t s
)
5016 return (s
== ROUTER_WAS_NOT_NEW
||
5017 s
== ROUTER_NOT_IN_CONSENSUS
||
5018 s
== ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
);
5020 /** Return true iff the descriptor rejected because it was malformed. */
5021 static INLINE
int WRA_WAS_REJECTED(was_router_added_t s
)
5023 return (s
== ROUTER_AUTHDIR_REJECTS
);
5025 was_router_added_t
router_add_to_routerlist(routerinfo_t
*router
,
5029 was_router_added_t
router_add_extrainfo_to_routerlist(
5030 extrainfo_t
*ei
, const char **msg
,
5031 int from_cache
, int from_fetch
);
5032 void routerlist_remove_old_routers(void);
5033 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
5035 int router_load_routers_from_string(const char *s
, const char *eos
,
5036 saved_location_t saved_location
,
5037 smartlist_t
*requested_fingerprints
,
5038 int descriptor_digests
,
5039 const char *prepend_annotations
);
5040 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
5041 saved_location_t saved_location
,
5042 smartlist_t
*requested_fingerprints
,
5043 int descriptor_digests
);
5044 void routerlist_retry_directory_downloads(time_t now
);
5045 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
5047 int router_exit_policy_rejects_all(routerinfo_t
*router
);
5048 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
5049 const char *address
,
5050 uint16_t dir_port
, uint16_t or_port
,
5051 const char *digest
, const char *v3_auth_digest
,
5052 authority_type_t type
);
5053 void authority_cert_free(authority_cert_t
*cert
);
5054 void clear_trusted_dir_servers(void);
5055 int any_trusted_dir_is_v1_authority(void);
5056 void update_router_descriptor_downloads(time_t now
);
5057 void update_extrainfo_downloads(time_t now
);
5058 int router_have_minimum_dir_info(void);
5059 void router_dir_info_changed(void);
5060 const char *get_dir_info_status_string(void);
5061 int count_loading_descriptors_progress(void);
5062 void router_reset_descriptor_download_failures(void);
5063 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
5064 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
5065 signed_descriptor_t
*sd
,
5067 void routerlist_assert_ok(routerlist_t
*rl
);
5068 const char *esc_router_info(routerinfo_t
*router
);
5069 void routers_sort_by_identity(smartlist_t
*routers
);
5071 routerset_t
*routerset_new(void);
5072 int routerset_parse(routerset_t
*target
, const char *s
,
5073 const char *description
);
5074 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
5075 int routerset_is_list(const routerset_t
*set
);
5076 int routerset_needs_geoip(const routerset_t
*set
);
5077 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
5078 int routerset_contains_routerstatus(const routerset_t
*set
,
5079 routerstatus_t
*rs
);
5080 int routerset_contains_extendinfo(const routerset_t
*set
,
5081 const extend_info_t
*ei
);
5082 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
5084 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
5085 const routerset_t
*include
,
5086 const routerset_t
*exclude
, int running_only
);
5087 void routerset_subtract_routers(smartlist_t
*out
,
5088 const routerset_t
*routerset
);
5089 char *routerset_to_string(const routerset_t
*routerset
);
5090 void routerset_refresh_countries(routerset_t
*target
);
5091 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
5092 void routerset_free(routerset_t
*routerset
);
5093 void routerinfo_set_country(routerinfo_t
*ri
);
5094 void routerlist_refresh_countries(void);
5095 void refresh_all_country_info(void);
5097 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
5099 int hid_serv_acting_as_directory(void);
5100 int hid_serv_responsible_for_desc_id(const char *id
);
5102 /********************************* routerparse.c ************************/
5104 #define MAX_STATUS_TAG_LEN 32
5105 /** Structure to hold parsed Tor versions. This is a little messier
5106 * than we would like it to be, because we changed version schemes with 0.1.0.
5108 * See version-spec.txt for the whole business.
5110 typedef struct tor_version_t
{
5114 /** Release status. For version in the post-0.1 format, this is always
5116 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
5118 char status_tag
[MAX_STATUS_TAG_LEN
];
5122 char git_tag
[DIGEST_LEN
];
5125 int router_get_router_hash(const char *s
, char *digest
);
5126 int router_get_dir_hash(const char *s
, char *digest
);
5127 int router_get_runningrouters_hash(const char *s
, char *digest
);
5128 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
5129 int router_get_networkstatus_v3_hash(const char *s
, char *digest
,
5130 digest_algorithm_t algorithm
);
5131 int router_get_networkstatus_v3_hashes(const char *s
, digests_t
*digests
);
5132 int router_get_extrainfo_hash(const char *s
, char *digest
);
5133 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
5136 crypto_pk_env_t
*private_key
);
5137 int router_parse_list_from_string(const char **s
, const char *eos
,
5139 saved_location_t saved_location
,
5141 int allow_annotations
,
5142 const char *prepend_annotations
);
5143 int router_parse_routerlist_from_directory(const char *s
,
5144 routerlist_t
**dest
,
5145 crypto_pk_env_t
*pkey
,
5147 int write_to_cache
);
5148 int router_parse_runningrouters(const char *str
);
5149 int router_parse_directory(const char *str
);
5150 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
5152 int allow_annotations
,
5153 const char *prepend_annotations
);
5154 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
5155 int cache_copy
, struct digest_ri_map_t
*routermap
);
5156 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
5158 version_status_t
tor_version_is_obsolete(const char *myversion
,
5159 const char *versionlist
);
5160 int tor_version_parse(const char *s
, tor_version_t
*out
);
5161 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
5162 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
5163 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
5164 void assert_addr_policy_ok(smartlist_t
*t
);
5165 void dump_distinct_digest_count(int severity
);
5167 int compare_routerstatus_entries(const void **_a
, const void **_b
);
5168 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
5169 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
5170 const char **eos_out
,
5171 networkstatus_type_t ns_type
);
5172 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
5173 const char *s
, const char *eos
);
5175 smartlist_t
*microdescs_parse_from_string(const char *s
, const char *eos
,
5176 int allow_annotations
,
5179 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
5180 const char **end_of_string
);
5181 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
5183 char **intro_points_encrypted_out
,
5184 size_t *intro_points_encrypted_size_out
,
5185 size_t *encoded_size_out
,
5186 const char **next_out
, const char *desc
);
5187 int rend_decrypt_introduction_points(char **ipos_decrypted
,
5188 size_t *ipos_decrypted_size
,
5189 const char *descriptor_cookie
,
5190 const char *ipos_encrypted
,
5191 size_t ipos_encrypted_size
);
5192 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
5193 const char *intro_points_encoded
,
5194 size_t intro_points_encoded_size
);
5195 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);
5197 void tor_gettimeofday_cache_clear(void);