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 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1079 * identity digest as this one. */
1082 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1083 * connection, or an exit. */
1084 typedef struct edge_connection_t
{
1087 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1089 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1090 * this conn exits at. */
1091 int package_window
; /**< How many more relay cells can I send into the
1093 int deliver_window
; /**< How many more relay cells can end at me? */
1095 /** Nickname of planned exit node -- used with .exit support. */
1096 char *chosen_exit_name
;
1098 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1100 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1101 * connection is using. */
1103 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1104 * connection. Exit connections only. */
1106 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1109 /** The reason why this connection is closing; passed to the controller. */
1110 uint16_t end_reason
;
1112 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1115 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1118 /** What rendezvous service are we querying for? (AP only) */
1119 rend_data_t
*rend_data
;
1121 /** Number of times we've reassigned this application connection to
1122 * a new circuit. We keep track because the timeout is longer if we've
1123 * already retried several times. */
1124 uint8_t num_socks_retries
;
1126 /** True iff this connection is for a DNS request only. */
1127 unsigned int is_dns_request
:1;
1129 /** True iff this stream must attach to a one-hop circuit (e.g. for
1131 unsigned int want_onehop
:1;
1132 /** True iff this stream should use a BEGIN_DIR relay command to establish
1133 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1134 unsigned int use_begindir
:1;
1136 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1137 * connections. Set once we've set the stream end,
1138 * and check in connection_about_to_close_connection().
1140 /** True iff we've blocked reading until the circuit has fewer queued
1142 unsigned int edge_blocked_on_circ
:1;
1143 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1144 * stop requiring it. */
1145 unsigned int chosen_exit_optional
:1;
1146 /** For AP connections only. If non-zero, this exit node was picked as
1147 * a result of the TrackHostExit, and the value decrements every time
1148 * we fail to complete a circuit to our chosen exit -- if it reaches
1149 * zero, abandon the associated mapaddress. */
1150 unsigned int chosen_exit_retries
:3;
1152 /** If this is a DNSPort connection, this field holds the pending DNS
1153 * request that we're going to try to answer. */
1154 struct evdns_server_request
*dns_server_request
;
1156 } edge_connection_t
;
1158 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1159 * connection to retrieve or serve directory material. */
1160 typedef struct dir_connection_t
{
1163 char *requested_resource
; /**< Which 'resource' did we ask the directory
1165 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1167 /* Used only for server sides of some dir connections, to implement
1168 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1169 * to append everything to the outbuf in one enormous chunk. */
1170 /** What exactly are we spooling right now? */
1172 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1173 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1174 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
,
1175 DIR_SPOOL_MICRODESC
, /* NOTE: if we add another entry, add another bit. */
1176 } dir_spool_src
: 3;
1177 /** If we're fetching descriptors, what router purpose shall we assign
1179 uint8_t router_purpose
;
1180 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1181 smartlist_t
*fingerprint_stack
;
1182 /** A cached_dir_t object that we're currently spooling out */
1183 struct cached_dir_t
*cached_dir
;
1184 /** The current offset into cached_dir. */
1185 off_t cached_dir_offset
;
1186 /** The zlib object doing on-the-fly compression for spooled data. */
1187 tor_zlib_state_t
*zlib_state
;
1189 /** What rendezvous service are we querying for? */
1190 rend_data_t
*rend_data
;
1192 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1193 * the directory server's signing key. */
1197 /** Subtype of connection_t for an connection to a controller. */
1198 typedef struct control_connection_t
{
1201 uint32_t event_mask
; /**< Bitfield: which events does this controller
1204 /** True if we have sent a protocolinfo reply on this connection. */
1205 unsigned int have_sent_protocolinfo
:1;
1207 /** Amount of space allocated in incoming_cmd. */
1208 uint32_t incoming_cmd_len
;
1209 /** Number of bytes currently stored in incoming_cmd. */
1210 uint32_t incoming_cmd_cur_len
;
1211 /** A control command that we're reading from the inbuf, but which has not
1212 * yet arrived completely. */
1214 } control_connection_t
;
1216 /** Cast a connection_t subtype pointer to a connection_t **/
1217 #define TO_CONN(c) (&(((c)->_base)))
1218 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1219 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1221 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1223 static or_connection_t
*TO_OR_CONN(connection_t
*);
1224 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1226 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1227 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1229 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1230 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1232 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1234 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1236 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1237 return DOWNCAST(or_connection_t
, c
);
1239 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1241 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1242 return DOWNCAST(dir_connection_t
, c
);
1244 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1246 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1247 return DOWNCAST(edge_connection_t
, c
);
1249 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1251 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1252 return DOWNCAST(control_connection_t
, c
);
1255 /** What action type does an address policy indicate: accept or reject? */
1257 ADDR_POLICY_ACCEPT
=1,
1258 ADDR_POLICY_REJECT
=2,
1259 } addr_policy_action_t
;
1261 /** A reference-counted address policy rule. */
1262 typedef struct addr_policy_t
{
1263 int refcnt
; /**< Reference count */
1264 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1265 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1267 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1268 * copy (stored in a hash table to avoid
1269 * duplication of common policies) */
1270 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1271 * first <b>maskbits</b> bits of <b>a</b> match
1273 tor_addr_t addr
; /**< Base address to accept or reject. */
1274 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1275 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1278 /** A cached_dir_t represents a cacheable directory object, along with its
1279 * compressed form. */
1280 typedef struct cached_dir_t
{
1281 char *dir
; /**< Contents of this object, NUL-terminated. */
1282 char *dir_z
; /**< Compressed contents of this object. */
1283 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1284 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1285 time_t published
; /**< When was this object published. */
1286 digests_t digests
; /**< Digests of this object (networkstatus only) */
1287 int refcnt
; /**< Reference count for this cached_dir_t. */
1290 /** Enum used to remember where a signed_descriptor_t is stored and how to
1291 * manage the memory for signed_descriptor_body. */
1293 /** The descriptor isn't stored on disk at all: the copy in memory is
1294 * canonical; the saved_offset field is meaningless. */
1296 /** The descriptor is stored in the cached_routers file: the
1297 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1298 * saved_offset are used to index into the mmaped cache file. */
1300 /** The descriptor is stored in the cached_routers.new file: the
1301 * signed_descriptor_body and saved_offset fields are both set. */
1302 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1303 * lazy-load the descriptor text by using seek and read. We don't, for
1309 /** Enumeration: what kind of download schedule are we using for a given
1312 DL_SCHED_GENERIC
= 0,
1313 DL_SCHED_CONSENSUS
= 1,
1314 DL_SCHED_BRIDGE
= 2,
1315 } download_schedule_t
;
1317 /** Information about our plans for retrying downloads for a downloadable
1319 typedef struct download_status_t
{
1320 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1322 uint8_t n_download_failures
; /**< Number of failures trying to download the
1323 * most recent descriptor. */
1324 download_schedule_t schedule
: 8;
1325 } download_status_t
;
1327 /** If n_download_failures is this high, the download can never happen. */
1328 #define IMPOSSIBLE_TO_DOWNLOAD 255
1330 /** The max size we expect router descriptor annotations we create to
1331 * be. We'll accept larger ones if we see them on disk, but we won't
1332 * create any that are larger than this. */
1333 #define ROUTER_ANNOTATION_BUF_LEN 256
1335 /** Information need to cache an onion router's descriptor. */
1336 typedef struct signed_descriptor_t
{
1337 /** Pointer to the raw server descriptor, preceded by annotations. Not
1338 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1339 * pointer is null. */
1340 char *signed_descriptor_body
;
1341 /** Length of the annotations preceding the server descriptor. */
1342 size_t annotations_len
;
1343 /** Length of the server descriptor. */
1344 size_t signed_descriptor_len
;
1345 /** Digest of the server descriptor, computed as specified in
1347 char signed_descriptor_digest
[DIGEST_LEN
];
1348 /** Identity digest of the router. */
1349 char identity_digest
[DIGEST_LEN
];
1350 /** Declared publication time of the descriptor. */
1351 time_t published_on
;
1352 /** For routerdescs only: digest of the corresponding extrainfo. */
1353 char extra_info_digest
[DIGEST_LEN
];
1354 /** For routerdescs only: Status of downloading the corresponding
1356 download_status_t ei_dl_status
;
1357 /** Where is the descriptor saved? */
1358 saved_location_t saved_location
;
1359 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1360 * this descriptor in the corresponding file. */
1362 /** What position is this descriptor within routerlist->routers or
1363 * routerlist->old_routers? -1 for none. */
1364 int routerlist_index
;
1365 /** The valid-until time of the most recent consensus that listed this
1366 * descriptor, or a bit after the publication time of the most recent v2
1367 * networkstatus that listed it. 0 for "never listed in a consensus or
1368 * status, so far as we know." */
1369 time_t last_listed_as_valid_until
;
1370 #ifdef TRACK_SERVED_TIME
1371 /** The last time we served anybody this descriptor. Used for internal
1372 * testing to see whether we're holding on to descriptors too long. */
1373 time_t last_served_at
; /*XXXX remove if not useful. */
1375 /* If true, we do not ever try to save this object in the cache. */
1376 unsigned int do_not_cache
: 1;
1377 /* If true, this item is meant to represent an extrainfo. */
1378 unsigned int is_extrainfo
: 1;
1379 /* If true, we got an extrainfo for this item, and the digest was right,
1380 * but it was incompatible. */
1381 unsigned int extrainfo_is_bogus
: 1;
1382 /* If true, we are willing to transmit this item unencrypted. */
1383 unsigned int send_unencrypted
: 1;
1384 } signed_descriptor_t
;
1386 /** A signed integer representing a country code. */
1387 typedef int16_t country_t
;
1389 /** Information about another onion router in the network. */
1391 signed_descriptor_t cache_info
;
1392 char *address
; /**< Location of OR: either a hostname or an IP address. */
1393 char *nickname
; /**< Human-readable OR name. */
1395 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1396 uint16_t or_port
; /**< Port for TLS connections. */
1397 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1399 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1400 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1402 char *platform
; /**< What software/operating system is this OR using? */
1405 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1406 * bucket per second? */
1407 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1408 /** How many bytes/s is this router known to handle? */
1409 uint32_t bandwidthcapacity
;
1410 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1411 * to exit? NULL for 'reject *:*'. */
1412 long uptime
; /**< How many seconds the router claims to have been up */
1413 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1414 * claims are its family. */
1415 char *contact_info
; /**< Declared contact info for this router. */
1416 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1418 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1419 * dnsworker code. */
1420 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1421 * extrainfo documents. */
1422 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1423 * single hop exits. */
1426 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1428 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1429 * (For Authdir: Have we validated this OR?)
1431 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1433 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1434 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1435 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1436 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1437 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1438 * or otherwise nasty? */
1439 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1440 * underpowered, or otherwise useless? */
1441 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1442 * a hidden service directory. */
1443 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1444 * directory according to the authorities. */
1445 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1446 * router rejects everything. */
1448 /** Tor can use this router for general positions in circuits. */
1449 #define ROUTER_PURPOSE_GENERAL 0
1450 /** Tor should avoid using this router for circuit-building. */
1451 #define ROUTER_PURPOSE_CONTROLLER 1
1452 /** Tor should use this router only for bridge positions in circuits. */
1453 #define ROUTER_PURPOSE_BRIDGE 2
1454 /** Tor should not use this router; it was marked in cached-descriptors with
1455 * a purpose we didn't recognize. */
1456 #define ROUTER_PURPOSE_UNKNOWN 255
1458 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1460 /* The below items are used only by authdirservers for
1461 * reachability testing. */
1462 /** When was the last time we could reach this OR? */
1463 time_t last_reachable
;
1464 /** When did we start testing reachability for this OR? */
1465 time_t testing_since
;
1466 /** According to the geoip db what country is this router in? */
1470 /** Information needed to keep and cache a signed extra-info document. */
1471 typedef struct extrainfo_t
{
1472 signed_descriptor_t cache_info
;
1473 /** The router's nickname. */
1474 char nickname
[MAX_NICKNAME_LEN
+1];
1475 /** True iff we found the right key for this extra-info, verified the
1476 * signature, and found it to be bad. */
1477 unsigned int bad_sig
: 1;
1478 /** If present, we didn't have the right key to verify this extra-info,
1479 * so this is a copy of the signature in the document. */
1481 /** Length of pending_sig. */
1482 size_t pending_sig_len
;
1485 /** Contents of a single router entry in a network status object.
1487 typedef struct routerstatus_t
{
1488 time_t published_on
; /**< When was this router published? */
1489 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1491 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1493 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1495 uint32_t addr
; /**< IPv4 address for this router. */
1496 uint16_t or_port
; /**< OR port for this router. */
1497 uint16_t dir_port
; /**< Directory port for this router. */
1498 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1499 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1500 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1501 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1502 unsigned int is_running
:1; /**< True iff this router is up. */
1503 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1504 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1506 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1507 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1508 * information with v2 of the directory
1509 * protocol. (All directory caches cache v1
1511 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1512 * choice as an entry guard. */
1513 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1515 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1516 * underpowered, or otherwise useless? */
1517 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1518 * service directory. */
1519 /** True iff we know version info for this router. (i.e., a "v" entry was
1520 * included.) We'll replace all these with a big tor_version_t or a char[]
1521 * if the number of traits we care about ever becomes incredibly big. */
1522 unsigned int version_known
:1;
1523 /** True iff this router is a version that supports BEGIN_DIR cells. */
1524 unsigned int version_supports_begindir
:1;
1525 /** True iff this router is a version that supports conditional consensus
1526 * downloads (signed by list of authorities). */
1527 unsigned int version_supports_conditional_consensus
:1;
1528 /** True iff this router is a version that we can post extrainfo docs to. */
1529 unsigned int version_supports_extrainfo_upload
:1;
1530 /** True iff this router is a version that, if it caches directory info,
1531 * we can get v3 downloads from. */
1532 unsigned int version_supports_v3_dir
:1;
1534 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1535 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1536 unsigned int has_measured_bw
:1; /**< The vote/consensus had a measured bw */
1538 uint32_t measured_bw
; /**< Measured bandwidth (capacity) of the router */
1540 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1541 * the vote/consensus, in kilobytes/sec. */
1542 char *exitsummary
; /**< exit policy summary -
1543 * XXX weasel: this probably should not stay a string. */
1545 /* ---- The fields below aren't derived from the networkstatus; they
1546 * hold local information only. */
1548 /** True if we, as a directory mirror, want to download the corresponding
1549 * routerinfo from the authority who gave us this routerstatus. (That is,
1550 * if we don't have the routerinfo, and if we haven't already tried to get it
1551 * from this authority.) Applies in v2 networkstatus document only.
1553 unsigned int need_to_mirror
:1;
1554 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1555 * to this (unnamed) router by nickname?
1557 time_t last_dir_503_at
; /**< When did this router last tell us that it
1558 * was too busy to serve directory info? */
1559 download_status_t dl_status
;
1563 /** A microdescriptor is the smallest amount of information needed to build a
1564 * circuit through a router. They are generated by the directory authorities,
1565 * using information from the uploaded routerinfo documents. They are not
1566 * self-signed, but are rather authenticated by having their hash in a signed
1567 * networkstatus document. */
1568 typedef struct microdesc_t
{
1569 /** Hashtable node, used to look up the microdesc by its digest. */
1570 HT_ENTRY(microdesc_t
) node
;
1572 /* Cache information */
1574 /** When was this microdescriptor last listed in a consensus document?
1575 * Once a microdesc has been unlisted long enough, we can drop it.
1578 /** Where is this microdescriptor currently stored? */
1579 saved_location_t saved_location
: 3;
1580 /** If true, do not attempt to cache this microdescriptor on disk. */
1581 unsigned int no_save
: 1;
1582 /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
1583 * microdescriptor in the cache. */
1586 /* The string containing the microdesc. */
1588 /** A pointer to the encoded body of the microdescriptor. If the
1589 * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
1590 * mmap'd region. Otherwise, it is a malloc'd string. The string might not
1591 * be NUL-terminated; take the length from <b>bodylen</b>. */
1593 /** The length of the microdescriptor in <b>body</b>. */
1595 /** A SHA256-digest of the microdescriptor. */
1596 char digest
[DIGEST256_LEN
];
1598 /* Fields in the microdescriptor. */
1600 /** As routerinfo_t.onion_pkey */
1601 crypto_pk_env_t
*onion_pkey
;
1602 /** As routerinfo_t.family */
1603 smartlist_t
*family
;
1604 /** Encoded exit policy summary */
1605 char *exitsummary
; /**< exit policy summary -
1606 * XXX this probably should not stay a string. */
1609 /** How many times will we try to download a router's descriptor before giving
1611 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1613 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1614 typedef struct networkstatus_v2_t
{
1615 /** When did we receive the network-status document? */
1618 /** What was the digest of the document? */
1619 char networkstatus_digest
[DIGEST_LEN
];
1621 /* These fields come from the actual network-status document.*/
1622 time_t published_on
; /**< Declared publication date. */
1624 char *source_address
; /**< Canonical directory server hostname. */
1625 uint32_t source_addr
; /**< Canonical directory server IP. */
1626 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1628 unsigned int binds_names
:1; /**< True iff this directory server binds
1630 unsigned int recommends_versions
:1; /**< True iff this directory server
1631 * recommends client and server software
1633 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1634 * malfunctioning exits as bad. */
1635 /** True iff this directory server marks malfunctioning directories as
1637 unsigned int lists_bad_directories
:1;
1639 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1640 char *contact
; /**< How to contact directory admin? (may be NULL). */
1641 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1642 char *client_versions
; /**< comma-separated list of recommended client
1644 char *server_versions
; /**< comma-separated list of recommended server
1647 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1648 * sorted by identity_digest. */
1649 } networkstatus_v2_t
;
1651 typedef struct vote_microdesc_hash_t
{
1652 struct vote_microdesc_hash_t
*next
;
1653 char *microdesc_hash_line
;
1654 } vote_microdesc_hash_t
;
1656 /** The claim about a single router, made in a vote. */
1657 typedef struct vote_routerstatus_t
{
1658 routerstatus_t status
; /**< Underlying 'status' object for this router.
1659 * Flags are redundant. */
1660 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1661 * networkstatus_t.known_flags. */
1662 char *version
; /**< The version that the authority says this router is
1664 vote_microdesc_hash_t
*microdesc
;
1665 } vote_routerstatus_t
;
1667 /** A signature of some document by an authority. */
1668 typedef struct document_signature_t
{
1669 /** Declared SHA-1 digest of this voter's identity key */
1670 char identity_digest
[DIGEST_LEN
];
1671 /** Declared SHA-1 digest of signing key used by this voter. */
1672 char signing_key_digest
[DIGEST_LEN
];
1673 /** Algorithm used to compute the digest of the document. */
1674 digest_algorithm_t alg
;
1675 /** Signature of the signed thing. */
1677 /** Length of <b>signature</b> */
1679 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1680 * the sig, and we know it's bad. */
1681 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1683 } document_signature_t
;
1685 /** Information about a single voter in a vote or a consensus. */
1686 typedef struct networkstatus_voter_info_t
{
1687 /** Declared SHA-1 digest of this voter's identity key */
1688 char identity_digest
[DIGEST_LEN
];
1689 char *nickname
; /**< Nickname of this voter */
1690 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
1691 * consensuses, we treat legacy keys as additional signers. */
1692 char legacy_id_digest
[DIGEST_LEN
];
1693 char *address
; /**< Address of this voter, in string format. */
1694 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1695 uint16_t dir_port
; /**< Directory port of this voter */
1696 uint16_t or_port
; /**< OR port of this voter */
1697 char *contact
; /**< Contact information for this voter. */
1698 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1700 /* Nothing from here on is signed. */
1701 /** The signature of the document and the signature's status. */
1703 } networkstatus_voter_info_t
;
1705 /** Enumerates the possible seriousness values of a networkstatus document. */
1710 } networkstatus_type_t
;
1712 /** Enumerates recognized flavors of a consensus networkstatus document. All
1713 * flavors of a consensus are generated from the same set of votes, but they
1714 * present different types information to different versions of Tor. */
1718 } consensus_flavor_t
;
1720 /** Which consensus flavor do we actually want to use to build circuits? */
1721 #define USABLE_CONSENSUS_FLAVOR FLAV_NS
1723 /** How many different consensus flavors are there? */
1724 #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
1726 /** A common structure to hold a v3 network status vote, or a v3 network
1727 * status consensus. */
1728 typedef struct networkstatus_t
{
1729 networkstatus_type_t type
: 8; /**< Vote, consensus, or opinion? */
1730 consensus_flavor_t flavor
: 8; /**< If a consensus, what kind? */
1731 time_t published
; /**< Vote only: Time when vote was written. */
1732 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1733 time_t fresh_until
; /**< Time before which this is the most recent vote or
1735 time_t valid_until
; /**< Time after which this vote or consensus should not
1738 /** Consensus only: what method was used to produce this consensus? */
1739 int consensus_method
;
1740 /** Vote only: what methods is this voter willing to use? */
1741 smartlist_t
*supported_methods
;
1743 /** How long does this vote/consensus claim that authorities take to
1744 * distribute their votes to one another? */
1746 /** How long does this vote/consensus claim that authorities take to
1747 * distribute their consensus signatures to one another? */
1750 /** Comma-separated list of recommended client software, or NULL if this
1751 * voter has no opinion. */
1752 char *client_versions
;
1753 char *server_versions
;
1754 /** List of flags that this vote/consensus applies to routers. If a flag is
1755 * not listed here, the voter has no opinion on what its value should be. */
1756 smartlist_t
*known_flags
;
1758 /** List of key=value strings for the parameters in this vote or
1759 * consensus, sorted by key. */
1760 smartlist_t
*net_params
;
1762 /** List of networkstatus_voter_info_t. For a vote, only one element
1763 * is included. For a consensus, one element is included for every voter
1764 * whose vote contributed to the consensus. */
1765 smartlist_t
*voters
;
1767 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1769 /** Digests of this document, as signed. */
1772 /** List of router statuses, sorted by identity digest. For a vote,
1773 * the elements are vote_routerstatus_t; for a consensus, the elements
1774 * are routerstatus_t. */
1775 smartlist_t
*routerstatus_list
;
1777 /** If present, a map from descriptor digest to elements of
1778 * routerstatus_list. */
1779 digestmap_t
*desc_digest_map
;
1782 /** A set of signatures for a networkstatus consensus. Unless otherwise
1783 * noted, all fields are as for networkstatus_t. */
1784 typedef struct ns_detached_signatures_t
{
1788 strmap_t
*digests
; /**< Map from flavor name to digestset_t */
1789 strmap_t
*signatures
; /**< Map from flavor name to list of
1790 * document_signature_t */
1791 } ns_detached_signatures_t
;
1793 /** Allowable types of desc_store_t. */
1794 typedef enum store_type_t
{
1799 /** A 'store' is a set of descriptors saved on disk, with accompanying
1800 * journal, mmaped as needed, rebuilt as needed. */
1801 typedef struct desc_store_t
{
1802 /** Filename (within DataDir) for the store. We append .tmp to this
1803 * filename for a temporary file when rebuilding the store, and .new to this
1804 * filename for the journal. */
1805 const char *fname_base
;
1806 /** Alternative (obsolete) value for fname_base: if the file named by
1807 * fname_base isn't present, we read from here instead, but we never write
1809 const char *fname_alt_base
;
1810 /** Human-readable description of what this store contains. */
1811 const char *description
;
1813 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1815 store_type_t type
; /**< What's stored in this store? */
1817 /** The size of the router log, in bytes. */
1819 /** The size of the router store, in bytes. */
1821 /** Total bytes dropped since last rebuild: this is space currently
1822 * used in the cache and the journal that could be freed by a rebuild. */
1823 size_t bytes_dropped
;
1826 /** Contents of a directory of onion routers. */
1828 /** Map from server identity digest to a member of routers. */
1829 struct digest_ri_map_t
*identity_map
;
1830 /** Map from server descriptor digest to a signed_descriptor_t from
1831 * routers or old_routers. */
1832 struct digest_sd_map_t
*desc_digest_map
;
1833 /** Map from extra-info digest to an extrainfo_t. Only exists for
1834 * routers in routers or old_routers. */
1835 struct digest_ei_map_t
*extra_info_map
;
1836 /** Map from extra-info digests to a signed_descriptor_t for a router
1837 * descriptor having that extra-info digest. Only exists for
1838 * routers in routers or old_routers. */
1839 struct digest_sd_map_t
*desc_by_eid_map
;
1840 /** List of routerinfo_t for all currently live routers we know. */
1841 smartlist_t
*routers
;
1842 /** List of signed_descriptor_t for older router descriptors we're
1844 smartlist_t
*old_routers
;
1845 /** Store holding server descriptors. If present, any router whose
1846 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1847 * starting at cache_info.saved_offset */
1848 desc_store_t desc_store
;
1849 /** Store holding extra-info documents. */
1850 desc_store_t extrainfo_store
;
1853 /** Information on router used when extending a circuit. We don't need a
1854 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1855 * connection, and onion_key to create the onionskin. Note that for onehop
1856 * general-purpose tunnels, the onion_key is NULL. */
1857 typedef struct extend_info_t
{
1858 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1860 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1861 uint16_t port
; /**< OR port. */
1862 tor_addr_t addr
; /**< IP address. */
1863 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1866 /** Certificate for v3 directory protocol: binds long-term authority identity
1867 * keys to medium-term authority signing keys. */
1868 typedef struct authority_cert_t
{
1869 /** Information relating to caching this cert on disk and looking it up. */
1870 signed_descriptor_t cache_info
;
1871 /** This authority's long-term authority identity key. */
1872 crypto_pk_env_t
*identity_key
;
1873 /** This authority's medium-term signing key. */
1874 crypto_pk_env_t
*signing_key
;
1875 /** The digest of <b>signing_key</b> */
1876 char signing_key_digest
[DIGEST_LEN
];
1877 /** The listed expiration time of this certificate. */
1879 /** This authority's IPv4 address, in host order. */
1881 /** This authority's directory port. */
1883 /** True iff this certificate was cross-certified by signing the identity
1884 * key with the signing key. */
1885 uint8_t is_cross_certified
;
1888 /** Bitfield enum type listing types of directory authority/directory
1892 /** Serves/signs v1 directory information: Big lists of routers, and short
1893 * routerstatus documents. */
1894 V1_AUTHORITY
= 1 << 0,
1895 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
1896 V2_AUTHORITY
= 1 << 1,
1897 /** Serves/signs v3 directory information: votes, consensuses, certs */
1898 V3_AUTHORITY
= 1 << 2,
1899 /** Serves hidden service descriptors. */
1900 HIDSERV_AUTHORITY
= 1 << 3,
1901 /** Serves bridge descriptors. */
1902 BRIDGE_AUTHORITY
= 1 << 4,
1903 /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
1904 EXTRAINFO_CACHE
= 1 << 5,
1907 #define CRYPT_PATH_MAGIC 0x70127012u
1909 /** Holds accounting information for a single step in the layered encryption
1910 * performed by a circuit. Used only at the client edge of a circuit. */
1911 typedef struct crypt_path_t
{
1914 /* crypto environments */
1915 /** Encryption key and counter for cells heading towards the OR at this
1917 crypto_cipher_env_t
*f_crypto
;
1918 /** Encryption key and counter for cells heading back from the OR at this
1920 crypto_cipher_env_t
*b_crypto
;
1922 /** Digest state for cells heading towards the OR at this step. */
1923 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1924 /** Digest state for cells heading away from the OR at this step. */
1925 crypto_digest_env_t
*b_digest
;
1927 /** Current state of Diffie-Hellman key negotiation with the OR at this
1929 crypto_dh_env_t
*dh_handshake_state
;
1930 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1931 * step. Used to save CPU when TLS is already providing all the
1932 * authentication, secrecy, and integrity we need, and we're already
1933 * distinguishable from an OR.
1935 char fast_handshake_state
[DIGEST_LEN
];
1936 /** Negotiated key material shared with the OR at this step. */
1937 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1939 /** Information to extend to the OR at this step. */
1940 extend_info_t
*extend_info
;
1942 /** Is the circuit built to this step? Must be one of:
1943 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1944 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1945 * and not received an EXTENDED/CREATED)
1946 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1948 #define CPATH_STATE_CLOSED 0
1949 #define CPATH_STATE_AWAITING_KEYS 1
1950 #define CPATH_STATE_OPEN 2
1951 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1952 * (The list is circular, so the last node
1953 * links to the first.) */
1954 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1957 int package_window
; /**< How many cells are we allowed to originate ending
1959 int deliver_window
; /**< How many cells are we willing to deliver originating
1963 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1965 #define DH_KEY_LEN DH_BYTES
1966 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1969 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1971 /** Information used to build a circuit. */
1973 /** Intended length of the final circuit. */
1974 int desired_path_len
;
1975 /** How to extend to the planned exit node. */
1976 extend_info_t
*chosen_exit
;
1977 /** Whether every node in the circ must have adequate uptime. */
1979 /** Whether every node in the circ must have adequate capacity. */
1981 /** Whether the last hop was picked with exiting in mind. */
1983 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1984 * These are for encrypted connections that exit to this router, not
1985 * for arbitrary exits from the circuit. */
1987 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1988 crypt_path_t
*pending_final_cpath
;
1989 /** How many times has building a circuit for this task failed? */
1991 /** At what time should we give up on this task? */
1993 } cpath_build_state_t
;
1995 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1996 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1999 * A circuit is a path over the onion routing
2000 * network. Applications can connect to one end of the circuit, and can
2001 * create exit connections at the other end of the circuit. AP and exit
2002 * connections have only one circuit associated with them (and thus these
2003 * connection types are closed when the circuit is closed), whereas
2004 * OR connections multiplex many circuits at once, and stay standing even
2005 * when there are no circuits running over them.
2007 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
2008 * links two connections together: either an edge connection and an OR
2009 * connection, or two OR connections. (When joined to an OR connection, a
2010 * circuit_t affects only cells sent to a particular circID on that
2011 * connection. When joined to an edge connection, a circuit_t affects all
2014 * Second, an origin_circuit_t holds the cipher keys and state for sending data
2015 * along a given circuit. At the OP, it has a sequence of ciphers, each
2016 * of which is shared with a single OR along the circuit. Separate
2017 * ciphers are used for data going "forward" (away from the OP) and
2018 * "backward" (towards the OP). At the OR, a circuit has only two stream
2019 * ciphers: one for data going forward, and one for data going backward.
2021 typedef struct circuit_t
{
2022 uint32_t magic
; /**< For memory and type debugging: must equal
2023 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
2025 /** Queue of cells waiting to be transmitted on n_conn. */
2026 cell_queue_t n_conn_cells
;
2027 /** The OR connection that is next in this circuit. */
2028 or_connection_t
*n_conn
;
2029 /** The circuit_id used in the next (forward) hop of this circuit. */
2032 /** The hop to which we want to extend this circuit. Should be NULL if
2033 * the circuit has attached to a connection. */
2034 extend_info_t
*n_hop
;
2036 /** True iff we are waiting for n_conn_cells to become less full before
2037 * allowing p_streams to add any more cells. (Origin circuit only.) */
2038 unsigned int streams_blocked_on_n_conn
: 1;
2039 /** True iff we are waiting for p_conn_cells to become less full before
2040 * allowing n_streams to add any more cells. (OR circuit only.) */
2041 unsigned int streams_blocked_on_p_conn
: 1;
2043 uint8_t state
; /**< Current status of this circuit. */
2044 uint8_t purpose
; /**< Why are we creating this circuit? */
2046 /** How many relay data cells can we package (read from edge streams)
2047 * on this circuit before we receive a circuit-level sendme cell asking
2050 /** How many relay data cells will we deliver (write to edge streams)
2051 * on this circuit? When deliver_window gets low, we send some
2052 * circuit-level sendme cells to indicate that we're willing to accept
2056 /** For storage while n_conn is pending
2057 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
2058 * length ONIONSKIN_CHALLENGE_LEN. */
2059 char *n_conn_onionskin
;
2061 time_t timestamp_created
; /**< When was this circuit created? */
2062 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
2063 * circuit is clean. */
2064 struct timeval highres_created
; /**< When exactly was the circuit created? */
2066 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
2067 * the main loop? (If true, holds the line number
2068 * where this circuit was marked.) */
2069 const char *marked_for_close_file
; /**< For debugging: in which file was this
2070 * circuit marked for close? */
2072 /** Next circuit in the doubly-linked ring of circuits waiting to add
2073 * cells to n_conn. NULL if we have no cells pending, or if we're not
2074 * linked to an OR connection. */
2075 struct circuit_t
*next_active_on_n_conn
;
2076 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2077 * cells to n_conn. NULL if we have no cells pending, or if we're not
2078 * linked to an OR connection. */
2079 struct circuit_t
*prev_active_on_n_conn
;
2080 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
2082 /** Unique ID for measuring tunneled network status requests. */
2086 /** Largest number of relay_early cells that we can send on a given
2088 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
2090 /** An origin_circuit_t holds data necessary to build and use a circuit.
2092 typedef struct origin_circuit_t
{
2095 /** Linked list of AP streams (or EXIT streams if hidden service)
2096 * associated with this circuit. */
2097 edge_connection_t
*p_streams
;
2098 /** Build state for this circuit. It includes the intended path
2099 * length, the chosen exit router, rendezvous information, etc.
2101 cpath_build_state_t
*build_state
;
2102 /** The doubly-linked list of crypt_path_t entries, one per hop,
2103 * for this circuit. This includes ciphers for each hop,
2104 * integrity-checking digests for each hop, and package/delivery
2105 * windows for each hop.
2107 crypt_path_t
*cpath
;
2109 /** Holds all rendezvous data on either client or service side. */
2110 rend_data_t
*rend_data
;
2112 /** How many more relay_early cells can we send on this circuit, according
2113 * to the specification? */
2114 unsigned int remaining_relay_early_cells
: 4;
2116 /** What commands were sent over this circuit that decremented the
2117 * RELAY_EARLY counter? This is for debugging task 878. */
2118 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
2120 /** How many RELAY_EARLY cells have been sent over this circuit? This is
2121 * for debugging task 878, too. */
2122 int relay_early_cells_sent
;
2124 /** The next stream_id that will be tried when we're attempting to
2125 * construct a new AP stream originating at this circuit. */
2126 streamid_t next_stream_id
;
2128 /* The intro key replaces the hidden service's public key if purpose is
2129 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2130 * descriptor is used. */
2131 crypto_pk_env_t
*intro_key
;
2133 /** Quasi-global identifier for this circuit; used for control.c */
2134 /* XXXX NM This can get re-used after 2**32 circuits. */
2135 uint32_t global_identifier
;
2139 /** An or_circuit_t holds information needed to implement a circuit at an
2141 typedef struct or_circuit_t
{
2144 /** Next circuit in the doubly-linked ring of circuits waiting to add
2145 * cells to p_conn. NULL if we have no cells pending, or if we're not
2146 * linked to an OR connection. */
2147 struct circuit_t
*next_active_on_p_conn
;
2148 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2149 * cells to p_conn. NULL if we have no cells pending, or if we're not
2150 * linked to an OR connection. */
2151 struct circuit_t
*prev_active_on_p_conn
;
2153 /** The circuit_id used in the previous (backward) hop of this circuit. */
2155 /** Queue of cells waiting to be transmitted on p_conn. */
2156 cell_queue_t p_conn_cells
;
2157 /** The OR connection that is previous in this circuit. */
2158 or_connection_t
*p_conn
;
2159 /** Linked list of Exit streams associated with this circuit. */
2160 edge_connection_t
*n_streams
;
2161 /** Linked list of Exit streams associated with this circuit that are
2162 * still being resolved. */
2163 edge_connection_t
*resolving_streams
;
2164 /** The cipher used by intermediate hops for cells heading toward the
2166 crypto_cipher_env_t
*p_crypto
;
2167 /** The cipher used by intermediate hops for cells heading away from
2169 crypto_cipher_env_t
*n_crypto
;
2171 /** The integrity-checking digest used by intermediate hops, for
2172 * cells packaged here and heading towards the OP.
2174 crypto_digest_env_t
*p_digest
;
2175 /** The integrity-checking digest used by intermediate hops, for
2176 * cells packaged at the OP and arriving here.
2178 crypto_digest_env_t
*n_digest
;
2180 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2181 * is not marked for close. */
2182 struct or_circuit_t
*rend_splice
;
2184 #if REND_COOKIE_LEN >= DIGEST_LEN
2185 #define REND_TOKEN_LEN REND_COOKIE_LEN
2187 #define REND_TOKEN_LEN DIGEST_LEN
2190 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2191 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2193 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2195 char rend_token
[REND_TOKEN_LEN
];
2197 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2198 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2200 /** How many more relay_early cells can we send on this circuit, according
2201 * to the specification? */
2202 unsigned int remaining_relay_early_cells
: 4;
2204 /** True iff this circuit was made with a CREATE_FAST cell. */
2205 unsigned int is_first_hop
: 1;
2207 /** Number of cells that were removed from circuit queue; reset every
2208 * time when writing buffer stats to disk. */
2209 uint32_t processed_cells
;
2211 /** Total time in milliseconds that cells spent in both app-ward and
2212 * exit-ward queues of this circuit; reset every time when writing
2213 * buffer stats to disk. */
2214 uint64_t total_cell_waiting_time
;
2217 /** Convert a circuit subtype to a circuit_t.*/
2218 #define TO_CIRCUIT(x) (&((x)->_base))
2220 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2221 * if the cast is impossible. */
2222 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2223 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2224 * Asserts if the cast is impossible. */
2225 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2227 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2229 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2230 return DOWNCAST(or_circuit_t
, x
);
2232 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2234 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2235 return DOWNCAST(origin_circuit_t
, x
);
2238 /** Bitfield type: things that we're willing to use invalid routers for. */
2239 typedef enum invalid_router_usage_t
{
2240 ALLOW_INVALID_ENTRY
=1,
2241 ALLOW_INVALID_EXIT
=2,
2242 ALLOW_INVALID_MIDDLE
=4,
2243 ALLOW_INVALID_RENDEZVOUS
=8,
2244 ALLOW_INVALID_INTRODUCTION
=16,
2245 } invalid_router_usage_t
;
2247 /* limits for TCP send and recv buffer size used for constrained sockets */
2248 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2249 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2251 /** A linked list of lines in a config file. */
2252 typedef struct config_line_t
{
2255 struct config_line_t
*next
;
2258 typedef struct routerset_t routerset_t
;
2260 /** Configuration options for a Tor process. */
2264 /** What should the tor process actually do? */
2266 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2267 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2269 const char *command_arg
; /**< Argument for command-line option. */
2271 config_line_t
*Logs
; /**< New-style list of configuration lines
2274 char *DebugLogFile
; /**< Where to send verbose log messages. */
2275 char *DataDirectory
; /**< OR only: where to store long-term data. */
2276 char *Nickname
; /**< OR only: nickname of this onion router. */
2277 char *Address
; /**< OR only: configured address for this onion router. */
2278 char *PidFile
; /**< Where to store PID of Tor process. */
2280 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2281 * country codes and IP address patterns of ORs to
2282 * consider as exits. */
2283 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2284 * country codes and IP address patterns of ORs to
2285 * consider as entry points. */
2286 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2287 * stop building circuits? */
2288 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2289 * stop building circuits? */
2290 int DisableAllSwap
; /**< Boolean: Attempt to call mlockall() on our
2291 * process for all current and future memory. */
2293 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2294 * country codes and IP address patterns of ORs
2295 * not to use in circuits. */
2296 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2297 * country codes and IP address patterns of
2298 * ORs not to consider as exits. */
2300 /** Union of ExcludeNodes and ExcludeExitNodes */
2301 struct routerset_t
*_ExcludeExitNodesUnion
;
2303 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2304 smartlist_t
*AllowInvalidNodes
;
2305 /** Bitmask; derived from AllowInvalidNodes. */
2306 invalid_router_usage_t _AllowInvalid
;
2307 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2308 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2309 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2310 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2311 /** Addresses to bind for listening for SOCKS connections. */
2312 config_line_t
*SocksListenAddress
;
2313 /** Addresses to bind for listening for transparent pf/netfilter
2315 config_line_t
*TransListenAddress
;
2316 /** Addresses to bind for listening for transparent natd connections */
2317 config_line_t
*NatdListenAddress
;
2318 /** Addresses to bind for listening for SOCKS connections. */
2319 config_line_t
*DNSListenAddress
;
2320 /** Addresses to bind for listening for OR connections. */
2321 config_line_t
*ORListenAddress
;
2322 /** Addresses to bind for listening for directory connections. */
2323 config_line_t
*DirListenAddress
;
2324 /** Addresses to bind for listening for control connections. */
2325 config_line_t
*ControlListenAddress
;
2326 /** Local address to bind outbound sockets */
2327 char *OutboundBindAddress
;
2328 /** Directory server only: which versions of
2329 * Tor should we tell users to run? */
2330 config_line_t
*RecommendedVersions
;
2331 config_line_t
*RecommendedClientVersions
;
2332 config_line_t
*RecommendedServerVersions
;
2333 /** Whether dirservers refuse router descriptors with private IPs. */
2334 int DirAllowPrivateAddresses
;
2335 char *User
; /**< Name of user to run Tor as. */
2336 char *Group
; /**< Name of group to run Tor as. */
2337 int ORPort
; /**< Port to listen on for OR connections. */
2338 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2339 /** Port to listen on for transparent pf/netfilter connections. */
2341 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2342 int ControlPort
; /**< Port to listen on for control connections. */
2343 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2344 * for control connections. */
2345 int DirPort
; /**< Port to listen on for directory connections. */
2346 int DNSPort
; /**< Port to listen on for DNS requests. */
2347 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2348 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2349 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2350 * for version 1 directories? */
2351 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2352 * for version 2 directories? */
2353 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2354 * for version 3 directories? */
2355 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2356 * handle hidden service requests? */
2357 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2358 * that's willing to bind names? */
2359 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2360 * directory that's willing to recommend
2362 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2363 * that aggregates bridge descriptors? */
2365 /** If set on a bridge authority, it will answer requests on its dirport
2366 * for bridge statuses -- but only if the requests use this password.
2367 * If set on a bridge user, request bridge statuses, and use this password
2369 char *BridgePassword
;
2371 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2372 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2374 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2375 * this explicit so we can change how we behave in the
2378 /** Boolean: if we know the bridge's digest, should we get new
2379 * descriptors from the bridge authorities or from the bridge itself? */
2380 int UpdateBridgesFromAuthority
;
2382 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2384 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2385 /** Boolean: should we never publish a descriptor? Deprecated. */
2387 /** To what authority types do we publish our descriptor? Choices are
2388 * "v1", "v2", "v3", "bridge", or "". */
2389 smartlist_t
*PublishServerDescriptor
;
2390 /** An authority type, derived from PublishServerDescriptor. */
2391 authority_type_t _PublishServerDescriptor
;
2392 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2393 int PublishHidServDescriptors
;
2394 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2395 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2396 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2398 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2399 * service directories after what time? */
2400 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2401 int AllDirActionsPrivate
; /**< Should every directory action be sent
2402 * through a Tor circuit? */
2404 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2405 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2406 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2407 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2408 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2410 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2411 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2412 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2414 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2415 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2417 /** Application ports that require all nodes in circ to have sufficient
2419 smartlist_t
*LongLivedPorts
;
2420 /** Application ports that are likely to be unencrypted and
2421 * unauthenticated; we reject requests for them to prevent the
2422 * user from screwing up and leaking plaintext secrets to an
2423 * observer somewhere on the Internet. */
2424 smartlist_t
*RejectPlaintextPorts
;
2425 /** Related to RejectPlaintextPorts above, except this config option
2426 * controls whether we warn (in the log and via a controller status
2427 * event) every time a risky connection is attempted. */
2428 smartlist_t
*WarnPlaintextPorts
;
2429 /** Should we try to reuse the same exit node for a given host */
2430 smartlist_t
*TrackHostExits
;
2431 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2433 config_line_t
*AddressMap
; /**< List of address map directives. */
2434 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2435 * hostname ending with one of the suffixes in
2436 * <b>AutomapHostsSuffixes</b>, map it to a
2437 * virtual address. */
2438 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2439 * <b>AutomapHostsOnResolve</b>. */
2440 int RendPostPeriod
; /**< How often do we post each rendezvous service
2441 * descriptor? Remember to publish them independently. */
2442 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2443 * connections alive? */
2444 int SocksTimeout
; /**< How long do we let a socks connection wait
2445 * unattached before we fail it? */
2446 int CircuitBuildTimeout
; /**< If non-zero, cull non-open circuits that
2447 * were born at least this many seconds ago. If
2448 * zero, use the internal adaptive algorithm. */
2449 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2450 * at least this many seconds ago. */
2451 int CircuitStreamTimeout
; /**< If non-zero, detach streams from circuits
2452 * and try a new circuit if the stream has been
2453 * waiting for this many seconds. If zero, use
2454 * our default internal timeout schedule. */
2455 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2456 * to wait simultaneously before we start dropping
2458 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2460 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2461 this interval ago. */
2462 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2463 * to use in a second? */
2464 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2465 * to use in a second? */
2466 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2467 * tell people we have? */
2468 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2469 * willing to use for all relayed conns? */
2470 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2471 * use in a second for all relayed conns? */
2472 int NumCpus
; /**< How many CPUs should we try to use? */
2473 int RunTesting
; /**< If true, create testing circuits to measure how well the
2474 * other ORs are running. */
2475 config_line_t
*RendConfigLines
; /**< List of configuration lines
2476 * for rendezvous services. */
2477 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2478 * authorizations for hidden services */
2479 char *ContactInfo
; /**< Contact info to be published in the directory. */
2481 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2482 tor_addr_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2483 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2484 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2486 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2487 tor_addr_t HttpsProxyAddr
; /**< Parsed addr for https proxy, if any. */
2488 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2489 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2491 char *Socks4Proxy
; /**< hostname:port to use as a SOCKS4 proxy, if any. */
2492 tor_addr_t Socks4ProxyAddr
; /**< Derived from Socks4Proxy. */
2493 uint16_t Socks4ProxyPort
; /**< Derived from Socks4Proxy. */
2495 char *Socks5Proxy
; /**< hostname:port to use as a SOCKS5 proxy, if any. */
2496 tor_addr_t Socks5ProxyAddr
; /**< Derived from Sock5Proxy. */
2497 uint16_t Socks5ProxyPort
; /**< Derived from Socks5Proxy. */
2498 char *Socks5ProxyUsername
; /**< Username for SOCKS5 authentication, if any */
2499 char *Socks5ProxyPassword
; /**< Password for SOCKS5 authentication, if any */
2501 /** List of configuration lines for replacement directory authorities.
2502 * If you just want to replace one class of authority at a time,
2503 * use the "Alternate*Authority" options below instead. */
2504 config_line_t
*DirServers
;
2506 /** If set, use these main (currently v3) directory authorities and
2507 * not the default ones. */
2508 config_line_t
*AlternateDirAuthority
;
2510 /** If set, use these bridge authorities and not the default one. */
2511 config_line_t
*AlternateBridgeAuthority
;
2513 /** If set, use these HS authorities and not the default ones. */
2514 config_line_t
*AlternateHSAuthority
;
2516 char *MyFamily
; /**< Declared family for this OR. */
2517 config_line_t
*NodeFamilies
; /**< List of config lines for
2519 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2520 * mark as bad dir mirrors. */
2521 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2522 * mark as bad exits. */
2523 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2525 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2526 * never mark as valid. */
2527 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2528 * and vote for all other dir mirrors as good. */
2529 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2530 * and vote for all other exits as good. */
2531 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2532 * aren't named in our fingerprint file? */
2533 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2534 * number of servers per IP address. */
2535 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2536 * number of servers per IP address shared
2537 * with an authority. */
2539 char *AccountingStart
; /**< How long is the accounting interval, and when
2541 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2542 * interval before hibernation? 0 for "never
2545 /** Base64-encoded hash of accepted passwords for the control system. */
2546 config_line_t
*HashedControlPassword
;
2547 /** As HashedControlPassword, but not saved. */
2548 config_line_t
*HashedControlSessionPassword
;
2550 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2551 * the control system? */
2552 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2553 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2554 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2555 * circuits itself (0), or does it expect a controller
2557 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2558 * make circuits in the background (0),
2560 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2561 * long do we wait before exiting? */
2562 char *SafeLogging
; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
2564 /* Derived from SafeLogging */
2566 SAFELOG_SCRUB_ALL
, SAFELOG_SCRUB_RELAY
, SAFELOG_SCRUB_NONE
2569 int SafeSocks
; /**< Boolean: should we outright refuse application
2570 * connections that use socks4 or socks5-with-local-dns? */
2571 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2572 LOG_WARN : LOG_INFO)
2573 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2574 * protocol, is it a warn or an info in our logs? */
2575 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2576 * log whether it was DNS-leaking or not? */
2577 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2578 * acceleration where available? */
2579 char *AccelName
; /**< Optional hardware acceleration engine name. */
2580 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
2581 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2582 * of fixed nodes? */
2583 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2584 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2585 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2586 * of our PK time by sending CREATE_FAST cells? */
2587 /** Should we always fetch our dir info on the mirror schedule (which
2588 * means directly from the authorities) no matter our other config? */
2589 int FetchDirInfoEarly
;
2591 /** Should we fetch our dir info at the start of the consensus period? */
2592 int FetchDirInfoExtraEarly
;
2594 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2595 * MAPADDRESS requests. */
2596 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2597 * addresses to be FQDNs, but rather search for them in
2598 * the local domains. */
2599 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2601 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2602 * DNS poisoning attacks. */
2603 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2604 * resolver from the file here rather than from
2605 * /etc/resolv.conf (Unix) or the registry (Windows). */
2606 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2607 disclaimer. This allows a server administrator to show
2608 that they're running Tor and anyone visiting their server
2609 will know this without any specialized knowledge. */
2610 /** Boolean: if set, we start even if our resolv.conf file is missing
2612 int ServerDNSAllowBrokenConfig
;
2614 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2615 * should be resolvable. Used for
2616 * testing our DNS server. */
2617 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2618 * same network zone in the same circuit. */
2619 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2621 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2622 * support BEGIN_DIR, when possible. */
2623 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2624 * with weird characters. */
2625 /** If true, we try resolving hostnames with weird characters. */
2626 int ServerDNSAllowNonRFC953Hostnames
;
2628 /** If true, we try to download extra-info documents (and we serve them,
2629 * if we are a cache). For authorities, this is always true. */
2630 int DownloadExtraInfo
;
2632 /** If true, and we are acting as a relay, allow exit circuits even when
2633 * we are the first hop of a circuit. */
2634 int AllowSingleHopExits
;
2635 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2636 * circuits that we build. */
2637 int ExcludeSingleHopRelays
;
2638 /** If true, and the controller tells us to use a one-hop circuit, and the
2639 * exit allows it, we use it. */
2640 int AllowSingleHopCircuits
;
2642 /** If true, we convert "www.google.com.foo.exit" addresses on the
2643 * socks/trans/natd ports into "www.google.com" addresses that
2644 * exit from the node "foo". Disabled by default since attacking
2645 * websites and exit relays can use it to manipulate your path
2649 /** If true, the user wants us to collect statistics on clients
2650 * requesting network statuses from us as directory. */
2651 int DirReqStatistics
;
2653 /** If true, the user wants us to collect statistics on port usage. */
2654 int ExitPortStatistics
;
2656 /** If true, the user wants us to collect cell statistics. */
2659 /** If true, the user wants us to collect statistics as entry node. */
2660 int EntryStatistics
;
2662 /** If true, include statistics file contents in extra-info documents. */
2663 int ExtraInfoStatistics
;
2665 /** If true, do not believe anybody who tells us that a domain resolves
2666 * to an internal address, or that an internal address has a PTR mapping.
2667 * Helps avoid some cross-site attacks. */
2668 int ClientDNSRejectInternalAddresses
;
2670 /** The length of time that we think a consensus should be fresh. */
2671 int V3AuthVotingInterval
;
2672 /** The length of time we think it will take to distribute votes. */
2673 int V3AuthVoteDelay
;
2674 /** The length of time we think it will take to distribute signatures. */
2675 int V3AuthDistDelay
;
2676 /** The number of intervals we think a consensus should be valid. */
2677 int V3AuthNIntervalsValid
;
2679 /** Should advertise and sign consensuses with a legacy key, for key
2680 * migration purposes? */
2681 int V3AuthUseLegacyKey
;
2683 /** Location of bandwidth measurement file */
2684 char *V3BandwidthsFile
;
2686 /** Authority only: key=value pairs that we add to our networkstatus
2687 * consensus vote on the 'params' line. */
2688 char *ConsensusParams
;
2690 /** The length of time that we think an initial consensus should be fresh.
2691 * Only altered on testing networks. */
2692 int TestingV3AuthInitialVotingInterval
;
2694 /** The length of time we think it will take to distribute initial votes.
2695 * Only altered on testing networks. */
2696 int TestingV3AuthInitialVoteDelay
;
2698 /** The length of time we think it will take to distribute initial
2699 * signatures. Only altered on testing networks.*/
2700 int TestingV3AuthInitialDistDelay
;
2702 /** If an authority has been around for less than this amount of time, it
2703 * does not believe its reachability information is accurate. Only
2704 * altered on testing networks. */
2705 int TestingAuthDirTimeToLearnReachability
;
2707 /** Clients don't download any descriptor this recent, since it will
2708 * probably not have propagated to enough caches. Only altered on testing
2710 int TestingEstimatedDescriptorPropagationTime
;
2712 /** If true, we take part in a testing network. Change the defaults of a
2713 * couple of other configuration options and allow to change the values
2714 * of certain configuration options. */
2715 int TestingTorNetwork
;
2717 /** File to check for a consensus networkstatus, if we don't have one
2719 char *FallbackNetworkstatusFile
;
2721 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2722 * count of how many client addresses have contacted us so that we can help
2723 * the bridge authority guess which countries have blocked access to us. */
2724 int BridgeRecordUsageByCountry
;
2727 /** If true, and Tor is built with DIRREQ_STATS support, and we're a
2728 * directory, record how many directory requests we get from each country. */
2729 int DirRecordUsageByCountry
;
2730 /** Round all GeoIP results to the next multiple of this value, to avoid
2731 * leaking information. */
2732 int DirRecordUsageGranularity
;
2733 /** Time interval: purge geoip stats after this long. */
2734 int DirRecordUsageRetainIPs
;
2735 /** Time interval: Flush geoip data to disk this often. */
2736 int DirRecordUsageSaveInterval
;
2739 /** Optionally, a file with GeoIP data. */
2742 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2743 * to make this false. */
2744 int ReloadTorrcOnSIGHUP
;
2748 /** Persistent state for an onion router, as saved to disk. */
2751 /** The time at which we next plan to write the state to the disk. Equal to
2752 * TIME_MAX if there are no savable changes, 0 if there are changes that
2753 * should be saved right away. */
2756 /** When was the state last written to disk? */
2759 /** Fields for accounting bandwidth use. */
2760 time_t AccountingIntervalStart
;
2761 uint64_t AccountingBytesReadInInterval
;
2762 uint64_t AccountingBytesWrittenInInterval
;
2763 int AccountingSecondsActive
;
2764 uint64_t AccountingExpectedUsage
;
2766 /** A list of Entry Guard-related configuration lines. */
2767 config_line_t
*EntryGuards
;
2769 /** These fields hold information on the history of bandwidth usage for
2770 * servers. The "Ends" fields hold the time when we last updated the
2771 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2772 * of the entries of Values. The "Values" lists hold decimal string
2773 * representations of the number of bytes read or written in each
2775 time_t BWHistoryReadEnds
;
2776 int BWHistoryReadInterval
;
2777 smartlist_t
*BWHistoryReadValues
;
2778 time_t BWHistoryWriteEnds
;
2779 int BWHistoryWriteInterval
;
2780 smartlist_t
*BWHistoryWriteValues
;
2782 /** Build time histogram */
2783 config_line_t
* BuildtimeHistogram
;
2784 uint16_t TotalBuildTimes
;
2786 /** What version of Tor wrote this state file? */
2789 /** Holds any unrecognized values we found in the state file, in the order
2790 * in which we found them. */
2791 config_line_t
*ExtraLines
;
2793 /** When did we last rotate our onion key? "0" for 'no idea'. */
2794 time_t LastRotatedOnionKey
;
2797 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2798 * state is already scheduled to be written to disk earlier than <b>when</b>.
2800 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2802 if (state
->next_write
> when
)
2803 state
->next_write
= when
;
2806 #define MAX_SOCKS_REPLY_LEN 1024
2807 #define MAX_SOCKS_ADDR_LEN 256
2809 /** Please open a TCP connection to this addr:port. */
2810 #define SOCKS_COMMAND_CONNECT 0x01
2811 /** Please turn this FQDN into an IP address, privately. */
2812 #define SOCKS_COMMAND_RESOLVE 0xF0
2813 /** Please turn this IP address into an FQDN, privately. */
2814 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2816 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2817 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2818 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2820 /** State of a SOCKS request from a user to an OP. Also used to encode other
2821 * information for non-socks user request (such as those on TransPort and
2823 struct socks_request_t
{
2824 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2825 * 0 means that no socks handshake ever took place, and this is just a
2826 * stub connection (e.g. see connection_ap_make_link()). */
2828 int command
; /**< What is this stream's goal? One from the above list. */
2829 size_t replylen
; /**< Length of <b>reply</b>. */
2830 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2831 * we want to specify our own socks reply,
2832 * rather than using the default socks4 or
2833 * socks5 socks reply. We use this for the
2834 * two-stage socks5 handshake.
2836 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2837 connect to/resolve? */
2838 uint16_t port
; /**< What port did the client ask to connect to? */
2839 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2840 * make sure we send back a socks reply for
2841 * every connection. */
2844 /* all the function prototypes go here */
2846 /********************************* buffers.c ***************************/
2848 buf_t
*buf_new(void);
2849 buf_t
*buf_new_with_capacity(size_t size
);
2850 void buf_free(buf_t
*buf
);
2851 void buf_clear(buf_t
*buf
);
2852 void buf_shrink(buf_t
*buf
);
2853 void buf_shrink_freelists(int free_all
);
2854 void buf_dump_freelist_sizes(int severity
);
2856 size_t buf_datalen(const buf_t
*buf
);
2857 size_t buf_allocation(const buf_t
*buf
);
2858 size_t buf_slack(const buf_t
*buf
);
2859 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2861 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2863 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2865 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2866 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2868 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2869 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2870 const char *data
, size_t data_len
, int done
);
2871 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2872 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2873 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2874 int fetch_from_buf_http(buf_t
*buf
,
2875 char **headers_out
, size_t max_headerlen
,
2876 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2877 int force_complete
);
2878 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2879 int log_sockstype
, int safe_socks
);
2880 int fetch_from_buf_socks_client(buf_t
*buf
, int state
, char **reason
);
2881 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2883 int peek_buf_has_control0_command(buf_t
*buf
);
2885 void assert_buf_ok(buf_t
*buf
);
2887 #ifdef BUFFERS_PRIVATE
2888 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2891 /********************************* circuitbuild.c **********************/
2893 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2894 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2895 void circuit_log_path(int severity
, unsigned int domain
,
2896 origin_circuit_t
*circ
);
2897 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2898 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2899 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2900 extend_info_t
*exit
,
2902 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2903 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2904 int inform_testing_reachability(void);
2905 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2906 void circuit_note_clock_jumped(int seconds_elapsed
);
2907 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2908 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2910 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2912 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2913 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2914 const char *payload
, const char *keys
);
2915 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2916 int *need_capacity
);
2918 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2919 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2920 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2921 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2922 crypto_pk_env_t
*onion_key
,
2923 const tor_addr_t
*addr
, uint16_t port
);
2924 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2925 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2926 void extend_info_free(extend_info_t
*info
);
2927 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2928 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2930 void entry_guards_compute_status(void);
2931 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2932 int mark_relay_status
, time_t now
);
2933 void entry_nodes_should_be_added(void);
2934 int entry_list_can_grow(or_options_t
*options
);
2935 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2936 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2937 void entry_guards_update_state(or_state_t
*state
);
2938 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2939 const char *question
, char **answer
);
2941 void clear_bridge_list(void);
2942 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2943 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
2945 void retry_bridge_descriptor_fetch_directly(const char *digest
);
2946 void fetch_bridge_descriptors(time_t now
);
2947 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2948 int any_bridge_descriptors_known(void);
2949 int any_pending_bridge_descriptor_fetches(void);
2950 int bridges_known_but_down(void);
2951 void bridges_retry_all(void);
2953 void entry_guards_free_all(void);
2955 /* Circuit Build Timeout "public" functions and structures. */
2957 /** Maximum quantile to use to generate synthetic timeouts.
2958 * We want to stay a bit short of 1.0, because longtail is
2959 * loooooooooooooooooooooooooooooooooooooooooooooooooooong. */
2960 #define MAX_SYNTHETIC_QUANTILE 0.985
2962 /** Minimum circuits before estimating a timeout */
2963 #define MIN_CIRCUITS_TO_OBSERVE 500
2965 /** Total size of the circuit timeout history to accumulate.
2966 * 5000 is approx 1.5 weeks worth of continual-use circuits. */
2967 #define NCIRCUITS_TO_OBSERVE 5000
2969 /** Width of the histogram bins in milliseconds */
2970 #define BUILDTIME_BIN_WIDTH ((build_time_t)50)
2972 /** Cutoff point on the CDF for our timeout estimation.
2973 * TODO: This should be moved to the consensus */
2974 #define BUILDTIMEOUT_QUANTILE_CUTOFF 0.8
2976 /** A build_time_t is milliseconds */
2977 typedef uint32_t build_time_t
;
2978 #define BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
2980 /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
2981 #define BUILD_TIMEOUT_MIN_VALUE (3*1000)
2983 /** Initial circuit build timeout in milliseconds */
2984 #define BUILD_TIMEOUT_INITIAL_VALUE (60*1000)
2986 /** How often in seconds should we build a test circuit */
2987 #define BUILD_TIMES_TEST_FREQUENCY 60
2989 /** Save state every 10 circuits */
2990 #define BUILD_TIMES_SAVE_STATE_EVERY 10
2992 /* Circuit Build Timeout network liveness constants */
2995 * How many circuits count as recent when considering if the
2996 * connection has gone gimpy or changed.
2998 #define RECENT_CIRCUITS 20
3001 * Have we received a cell in the last N circ attempts?
3003 * This tells us when to temporarily switch back to
3004 * BUILD_TIMEOUT_INITIAL_VALUE until we start getting cells,
3005 * at which point we switch back to computing the timeout from
3006 * our saved history.
3008 #define NETWORK_NONLIVE_TIMEOUT_COUNT (RECENT_CIRCUITS*3/20)
3011 * This tells us when to toss out the last streak of N timeouts.
3013 * If instead we start getting cells, we switch back to computing the timeout
3014 * from our saved history.
3016 #define NETWORK_NONLIVE_DISCARD_COUNT (NETWORK_NONLIVE_TIMEOUT_COUNT*2)
3019 * Maximum count of timeouts that finish the first hop in the past
3020 * RECENT_CIRCUITS before calculating a new timeout.
3022 * This tells us to abandon timeout history and set
3023 * the timeout back to BUILD_TIMEOUT_INITIAL_VALUE.
3025 #define MAX_RECENT_TIMEOUT_COUNT (RECENT_CIRCUITS*4/5)
3027 #if MAX_RECENT_TIMEOUT_COUNT < 1 || NETWORK_NONLIVE_DISCARD_COUNT < 1 || \
3028 NETWORK_NONLIVE_TIMEOUT_COUNT < 1
3029 #error "RECENT_CIRCUITS is set too low."
3032 /** Information about the state of our local network connection */
3034 /** The timestamp we last completed a TLS handshake or received a cell */
3035 time_t network_last_live
;
3036 /** If the network is not live, how many timeouts has this caused? */
3037 int nonlive_timeouts
;
3038 /** If the network is not live, have we yet discarded our history? */
3039 int nonlive_discarded
;
3040 /** Circular array of circuits that have made it to the first hop. Slot is
3041 * 1 if circuit timed out, 0 if circuit succeeded */
3042 int8_t timeouts_after_firsthop
[RECENT_CIRCUITS
];
3043 /** Index into circular array. */
3044 int after_firsthop_idx
;
3045 } network_liveness_t
;
3047 /** Structure for circuit build times history */
3049 /** The circular array of recorded build times in milliseconds */
3050 build_time_t circuit_build_times
[NCIRCUITS_TO_OBSERVE
];
3051 /** Current index in the circuit_build_times circular array */
3052 int build_times_idx
;
3053 /** Total number of build times accumulated. Maxes at NCIRCUITS_TO_OBSERVE */
3054 int total_build_times
;
3055 /** Information about the state of our local network connection */
3056 network_liveness_t liveness
;
3057 /** Last time we built a circuit. Used to decide to build new test circs */
3058 time_t last_circ_at
;
3059 /** Number of timeouts that have happened before estimating pareto
3062 /** "Minimum" value of our pareto distribution (actually mode) */
3064 /** alpha exponent for pareto dist. */
3066 /** Have we computed a timeout? */
3067 int have_computed_timeout
;
3068 /** The exact value for that timeout in milliseconds */
3070 } circuit_build_times_t
;
3072 extern circuit_build_times_t circ_times
;
3073 void circuit_build_times_update_state(circuit_build_times_t
*cbt
,
3075 int circuit_build_times_parse_state(circuit_build_times_t
*cbt
,
3076 or_state_t
*state
, char **msg
);
3077 int circuit_build_times_add_timeout(circuit_build_times_t
*cbt
,
3078 int did_onehop
, time_t start_time
);
3079 void circuit_build_times_set_timeout(circuit_build_times_t
*cbt
);
3080 int circuit_build_times_add_time(circuit_build_times_t
*cbt
,
3082 int circuit_build_times_needs_circuits(circuit_build_times_t
*cbt
);
3083 int circuit_build_times_needs_circuits_now(circuit_build_times_t
*cbt
);
3084 void circuit_build_times_init(circuit_build_times_t
*cbt
);
3086 #ifdef CIRCUIT_PRIVATE
3087 double circuit_build_times_calculate_timeout(circuit_build_times_t
*cbt
,
3089 build_time_t
circuit_build_times_generate_sample(circuit_build_times_t
*cbt
,
3090 double q_lo
, double q_hi
);
3091 void circuit_build_times_initial_alpha(circuit_build_times_t
*cbt
,
3092 double quantile
, double time_ms
);
3093 void circuit_build_times_update_alpha(circuit_build_times_t
*cbt
);
3094 double circuit_build_times_cdf(circuit_build_times_t
*cbt
, double x
);
3095 void circuit_build_times_add_timeout_worker(circuit_build_times_t
*cbt
,
3096 double quantile_cutoff
);
3097 void circuitbuild_running_unit_tests(void);
3098 void circuit_build_times_reset(circuit_build_times_t
*cbt
);
3100 /* Network liveness functions */
3101 int circuit_build_times_network_check_changed(circuit_build_times_t
*cbt
);
3104 /* Network liveness functions */
3105 void circuit_build_times_network_is_live(circuit_build_times_t
*cbt
);
3106 int circuit_build_times_network_check_live(circuit_build_times_t
*cbt
);
3107 void circuit_build_times_network_circ_success(circuit_build_times_t
*cbt
);
3109 /********************************* circuitlist.c ***********************/
3111 circuit_t
* _circuit_get_global_list(void);
3112 const char *circuit_state_to_string(int state
);
3113 const char *circuit_purpose_to_controller_string(uint8_t purpose
);
3114 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
3115 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
3116 or_connection_t
*conn
);
3117 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
3118 or_connection_t
*conn
);
3119 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
3120 void circuit_close_all_marked(void);
3121 int32_t circuit_initial_package_window(void);
3122 origin_circuit_t
*origin_circuit_new(void);
3123 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
3124 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
3125 or_connection_t
*conn
);
3126 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
3127 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
3128 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
3129 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
3130 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
3132 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
3133 const char *digest
, uint8_t purpose
);
3134 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
3135 or_circuit_t
*circuit_get_intro_point(const char *digest
);
3136 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
3137 extend_info_t
*info
, int flags
);
3138 void circuit_mark_all_unused_circs(void);
3139 void circuit_expire_all_dirty_circs(void);
3140 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
3141 int line
, const char *file
);
3142 int circuit_get_cpath_len(origin_circuit_t
*circ
);
3143 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
3144 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
3145 or_connection_t
*or_conn
);
3146 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
3148 #define circuit_mark_for_close(c, reason) \
3149 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
3151 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
3152 void assert_circuit_ok(const circuit_t
*c
);
3153 void circuit_free_all(void);
3155 /********************************* circuituse.c ************************/
3157 void circuit_expire_building(time_t now
);
3158 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
3159 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
3161 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
3162 const or_options_t
*options
);
3163 void circuit_build_needed_circs(time_t now
);
3164 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
3166 void reset_bandwidth_test(void);
3167 int circuit_enough_testing_circs(void);
3169 void circuit_has_opened(origin_circuit_t
*circ
);
3170 void circuit_build_failed(origin_circuit_t
*circ
);
3172 /** Flag to set when a circuit should have only a single hop. */
3173 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
3174 /** Flag to set when a circuit needs to be built of high-uptime nodes */
3175 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
3176 /** Flag to set when a circuit needs to be built of high-capacity nodes */
3177 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
3178 /** Flag to set when the last hop of a circuit doesn't need to be an
3180 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
3181 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
3182 extend_info_t
*info
,
3184 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
3185 routerinfo_t
*exit
, int flags
);
3186 void circuit_reset_failure_count(int timeout
);
3187 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
3188 origin_circuit_t
*circ
,
3189 crypt_path_t
*cpath
);
3190 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
3192 /********************************* command.c ***************************/
3194 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
3195 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
3197 extern uint64_t stats_n_padding_cells_processed
;
3198 extern uint64_t stats_n_create_cells_processed
;
3199 extern uint64_t stats_n_created_cells_processed
;
3200 extern uint64_t stats_n_relay_cells_processed
;
3201 extern uint64_t stats_n_destroy_cells_processed
;
3203 /********************************* config.c ***************************/
3205 /** An error from options_trial_assign() or options_init_from_string(). */
3206 typedef enum setopt_err_t
{
3208 SETOPT_ERR_MISC
= -1,
3209 SETOPT_ERR_PARSE
= -2,
3210 SETOPT_ERR_TRANSITION
= -3,
3211 SETOPT_ERR_SETTING
= -4,
3214 const char *get_dirportfrontpage(void);
3215 or_options_t
*get_options(void);
3216 int set_options(or_options_t
*new_val
, char **msg
);
3217 void config_free_all(void);
3218 const char *safe_str_client(const char *address
);
3219 const char *safe_str(const char *address
);
3220 const char *escaped_safe_str_client(const char *address
);
3221 const char *escaped_safe_str(const char *address
);
3222 const char *get_version(void);
3224 int config_get_lines(const char *string
, config_line_t
**result
);
3225 void config_free_lines(config_line_t
*front
);
3226 setopt_err_t
options_trial_assign(config_line_t
*list
, int use_defaults
,
3227 int clear_first
, char **msg
);
3228 int resolve_my_address(int warn_severity
, or_options_t
*options
,
3229 uint32_t *addr
, char **hostname_out
);
3230 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
3231 void options_init(or_options_t
*options
);
3232 char *options_dump(or_options_t
*options
, int minimal
);
3233 int options_init_from_torrc(int argc
, char **argv
);
3234 setopt_err_t
options_init_from_string(const char *cf
,
3235 int command
, const char *command_arg
, char **msg
);
3236 int option_is_recognized(const char *key
);
3237 const char *option_get_canonical_name(const char *key
);
3238 config_line_t
*option_get_assignment(or_options_t
*options
,
3240 int options_save_current(void);
3241 const char *get_torrc_fname(void);
3242 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
3243 const char *sub1
, const char *sub2
,
3244 const char *suffix
);
3245 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
3246 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
3247 /** Return a newly allocated string containing datadir/sub1. See
3248 * get_datadir_fname2_suffix. */
3249 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
3250 /** Return a newly allocated string containing datadir/sub1/sub2. See
3251 * get_datadir_fname2_suffix. */
3252 #define get_datadir_fname2(sub1,sub2) \
3253 get_datadir_fname2_suffix((sub1), (sub2), NULL)
3254 /** Return a newly allocated string containing datadir/sub1suffix. See
3255 * get_datadir_fname2_suffix. */
3256 #define get_datadir_fname_suffix(sub1, suffix) \
3257 get_datadir_fname2_suffix((sub1), NULL, (suffix))
3259 or_state_t
*get_or_state(void);
3260 int or_state_save(time_t now
);
3262 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
3263 int getinfo_helper_config(control_connection_t
*conn
,
3264 const char *question
, char **answer
);
3266 const char *tor_get_digests(void);
3267 uint32_t get_effective_bwrate(or_options_t
*options
);
3268 uint32_t get_effective_bwburst(or_options_t
*options
);
3270 #ifdef CONFIG_PRIVATE
3271 /* Used only by config.c and test.c */
3272 or_options_t
*options_new(void);
3275 /********************************* connection.c ***************************/
3277 const char *conn_type_to_string(int type
);
3278 const char *conn_state_to_string(int type
, int state
);
3280 dir_connection_t
*dir_connection_new(int socket_family
);
3281 or_connection_t
*or_connection_new(int socket_family
);
3282 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
3283 control_connection_t
*control_connection_new(int socket_family
);
3284 connection_t
*connection_new(int type
, int socket_family
);
3286 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
3287 void connection_free(connection_t
*conn
);
3288 void connection_free_all(void);
3289 void connection_about_to_close_connection(connection_t
*conn
);
3290 void connection_close_immediate(connection_t
*conn
);
3291 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
3293 #define connection_mark_for_close(c) \
3294 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
3296 void connection_expire_held_open(void);
3298 int connection_connect(connection_t
*conn
, const char *address
,
3299 const tor_addr_t
*addr
,
3300 uint16_t port
, int *socket_error
);
3302 int connection_proxy_connect(connection_t
*conn
, int type
);
3303 int connection_read_proxy_handshake(connection_t
*conn
);
3305 int retry_all_listeners(smartlist_t
*replaced_conns
,
3306 smartlist_t
*new_conns
);
3308 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
3309 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
3310 void connection_bucket_init(void);
3311 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
3313 int connection_handle_read(connection_t
*conn
);
3315 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
3317 int connection_wants_to_flush(connection_t
*conn
);
3318 int connection_outbuf_too_full(connection_t
*conn
);
3319 int connection_handle_write(connection_t
*conn
, int force
);
3320 void _connection_write_to_buf_impl(const char *string
, size_t len
,
3321 connection_t
*conn
, int zlib
);
3322 static void connection_write_to_buf(const char *string
, size_t len
,
3323 connection_t
*conn
);
3324 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
3325 dir_connection_t
*conn
, int done
);
3327 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
3329 _connection_write_to_buf_impl(string
, len
, conn
, 0);
3332 connection_write_to_buf_zlib(const char *string
, size_t len
,
3333 dir_connection_t
*conn
, int done
)
3335 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
3338 connection_t
*connection_get_by_global_id(uint64_t id
);
3340 connection_t
*connection_get_by_type(int type
);
3341 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
3342 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
3343 const tor_addr_t
*addr
,
3344 uint16_t port
, int purpose
);
3345 connection_t
*connection_get_by_type_state(int type
, int state
);
3346 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
3347 const char *rendquery
);
3349 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
3350 int connection_is_listener(connection_t
*conn
);
3351 int connection_state_is_open(connection_t
*conn
);
3352 int connection_state_is_connecting(connection_t
*conn
);
3354 char *alloc_http_authenticator(const char *authenticator
);
3356 void assert_connection_ok(connection_t
*conn
, time_t now
);
3357 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
3358 void connection_dump_buffer_mem_stats(int severity
);
3359 void remove_file_if_very_old(const char *fname
, time_t now
);
3361 /********************************* connection_edge.c *************************/
3363 #define connection_mark_unattached_ap(conn, endreason) \
3364 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
3366 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
3367 int line
, const char *file
);
3368 int connection_edge_reached_eof(edge_connection_t
*conn
);
3369 int connection_edge_process_inbuf(edge_connection_t
*conn
,
3370 int package_partial
);
3371 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
3372 int connection_edge_end(edge_connection_t
*conn
, uint8_t reason
);
3373 int connection_edge_end_errno(edge_connection_t
*conn
);
3374 int connection_edge_finished_flushing(edge_connection_t
*conn
);
3375 int connection_edge_finished_connecting(edge_connection_t
*conn
);
3377 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
3378 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
3380 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
3382 int use_begindir
, int want_onehop
);
3383 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
3386 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
3393 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
3394 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
3395 void connection_exit_connect(edge_connection_t
*conn
);
3396 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
3397 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
3398 void connection_ap_expire_beginning(void);
3399 void connection_ap_attach_pending(void);
3400 void connection_ap_fail_onehop(const char *failed_digest
,
3401 cpath_build_state_t
*build_state
);
3402 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
3403 int connection_ap_detach_retriable(edge_connection_t
*conn
,
3404 origin_circuit_t
*circ
,
3406 int connection_ap_process_transparent(edge_connection_t
*conn
);
3408 int address_is_invalid_destination(const char *address
, int client
);
3410 void addressmap_init(void);
3411 void addressmap_clean(time_t now
);
3412 void addressmap_clear_configured(void);
3413 void addressmap_clear_transient(void);
3414 void addressmap_free_all(void);
3415 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
3416 int addressmap_have_mapping(const char *address
, int update_timeout
);
3417 /** Enumerates possible origins of a client-side address mapping. */
3419 /** We're remapping this address because the controller told us to. */
3420 ADDRMAPSRC_CONTROLLER
,
3421 /** We're remapping this address because our configuration (via torrc, the
3422 * command line, or a SETCONF command) told us to. */
3424 /** We're remapping this address because we have TrackHostExit configured,
3425 * and we want to remember to use the same exit next time. */
3426 ADDRMAPSRC_TRACKEXIT
,
3427 /** We're remapping this address because we got a DNS resolution from a
3428 * Tor server that told us what its value was. */
3430 } addressmap_entry_source_t
;
3431 void addressmap_register(const char *address
, char *new_address
,
3432 time_t expires
, addressmap_entry_source_t source
);
3433 int parse_virtual_addr_network(const char *val
, int validate_only
,
3435 int client_dns_incr_failures(const char *address
);
3436 void client_dns_clear_failures(const char *address
);
3437 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3438 const char *exitname
, int ttl
);
3439 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3440 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3441 time_t max_expires
, int want_expiry
);
3442 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3443 origin_circuit_t
*circ
,
3444 crypt_path_t
*cpath
);
3445 int hostname_is_noconnect_address(const char *address
);
3447 /** Possible return values for parse_extended_hostname. */
3448 typedef enum hostname_type_t
{
3449 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3451 hostname_type_t
parse_extended_hostname(char *address
, int allowdotexit
);
3453 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3454 int get_pf_socket(void);
3457 /********************************* connection_or.c ***************************/
3459 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3460 void connection_or_clear_identity_map(void);
3461 or_connection_t
*connection_or_get_for_extend(const char *digest
,
3462 const tor_addr_t
*target_addr
,
3463 const char **msg_out
,
3465 void connection_or_set_bad_connections(void);
3467 int connection_or_reached_eof(or_connection_t
*conn
);
3468 int connection_or_process_inbuf(or_connection_t
*conn
);
3469 int connection_or_flushed_some(or_connection_t
*conn
);
3470 int connection_or_finished_flushing(or_connection_t
*conn
);
3471 int connection_or_finished_connecting(or_connection_t
*conn
);
3473 void connection_or_connect_failed(or_connection_t
*conn
,
3474 int reason
, const char *msg
);
3475 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3476 const char *id_digest
);
3478 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3479 int connection_tls_continue_handshake(or_connection_t
*conn
);
3481 void or_handshake_state_free(or_handshake_state_t
*state
);
3482 int connection_or_set_state_open(or_connection_t
*conn
);
3483 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3484 or_connection_t
*conn
);
3485 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3486 or_connection_t
*conn
);
3487 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3489 int connection_or_send_netinfo(or_connection_t
*conn
);
3490 int connection_or_send_cert(or_connection_t
*conn
);
3491 int connection_or_send_link_auth(or_connection_t
*conn
);
3492 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3494 int is_or_protocol_version_known(uint16_t version
);
3496 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3497 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3498 var_cell_t
*var_cell_new(uint16_t payload_len
);
3499 void var_cell_free(var_cell_t
*cell
);
3501 /********************************* control.c ***************************/
3503 /** Used to indicate the type of a circuit event passed to the controller.
3504 * The various types are defined in control-spec.txt */
3505 typedef enum circuit_status_event_t
{
3506 CIRC_EVENT_LAUNCHED
= 0,
3507 CIRC_EVENT_BUILT
= 1,
3508 CIRC_EVENT_EXTENDED
= 2,
3509 CIRC_EVENT_FAILED
= 3,
3510 CIRC_EVENT_CLOSED
= 4,
3511 } circuit_status_event_t
;
3513 /** Used to indicate the type of a stream event passed to the controller.
3514 * The various types are defined in control-spec.txt */
3515 typedef enum stream_status_event_t
{
3516 STREAM_EVENT_SENT_CONNECT
= 0,
3517 STREAM_EVENT_SENT_RESOLVE
= 1,
3518 STREAM_EVENT_SUCCEEDED
= 2,
3519 STREAM_EVENT_FAILED
= 3,
3520 STREAM_EVENT_CLOSED
= 4,
3521 STREAM_EVENT_NEW
= 5,
3522 STREAM_EVENT_NEW_RESOLVE
= 6,
3523 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3524 STREAM_EVENT_REMAP
= 8
3525 } stream_status_event_t
;
3527 /** Used to indicate the type of an OR connection event passed to the
3528 * controller. The various types are defined in control-spec.txt */
3529 typedef enum or_conn_status_event_t
{
3530 OR_CONN_EVENT_LAUNCHED
= 0,
3531 OR_CONN_EVENT_CONNECTED
= 1,
3532 OR_CONN_EVENT_FAILED
= 2,
3533 OR_CONN_EVENT_CLOSED
= 3,
3534 OR_CONN_EVENT_NEW
= 4,
3535 } or_conn_status_event_t
;
3537 void control_update_global_event_mask(void);
3538 void control_adjust_event_log_severity(void);
3540 /** Execute the statement <b>stmt</b>, which may log events concerning the
3541 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3542 * being sent to controllers if <b>conn</b> is a control connection.
3544 * Stmt must not contain any return or goto statements.
3546 #define CONN_LOG_PROTECT(conn, stmt) \
3548 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3549 if (_log_conn_is_control) \
3550 disable_control_logging(); \
3551 STMT_BEGIN stmt; STMT_END; \
3552 if (_log_conn_is_control) \
3553 enable_control_logging(); \
3556 /** Log information about the connection <b>conn</b>, protecting it as with
3557 * CONN_LOG_PROTECT. Example:
3559 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3561 #define LOG_FN_CONN(conn, args) \
3562 CONN_LOG_PROTECT(conn, log_fn args)
3564 int connection_control_finished_flushing(control_connection_t
*conn
);
3565 int connection_control_reached_eof(control_connection_t
*conn
);
3566 int connection_control_process_inbuf(control_connection_t
*conn
);
3568 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3569 #define EVENT_NS 0x000F
3570 int control_event_is_interesting(int event
);
3572 int control_event_circuit_status(origin_circuit_t
*circ
,
3573 circuit_status_event_t e
, int reason
);
3574 int control_event_stream_status(edge_connection_t
*conn
,
3575 stream_status_event_t e
,
3577 int control_event_or_conn_status(or_connection_t
*conn
,
3578 or_conn_status_event_t e
, int reason
);
3579 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3580 int control_event_stream_bandwidth(edge_connection_t
*edge_conn
);
3581 int control_event_stream_bandwidth_used(void);
3582 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3583 int control_event_descriptors_changed(smartlist_t
*routers
);
3584 int control_event_address_mapped(const char *from
, const char *to
,
3585 time_t expires
, const char *error
);
3586 int control_event_or_authdir_new_descriptor(const char *action
,
3590 int control_event_my_descriptor_changed(void);
3591 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3592 int control_event_newconsensus(const networkstatus_t
*consensus
);
3593 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3594 int control_event_general_status(int severity
, const char *format
, ...)
3596 int control_event_client_status(int severity
, const char *format
, ...)
3598 int control_event_server_status(int severity
, const char *format
, ...)
3600 int control_event_guard(const char *nickname
, const char *digest
,
3601 const char *status
);
3603 int init_cookie_authentication(int enabled
);
3604 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3605 void disable_control_logging(void);
3606 void enable_control_logging(void);
3608 /** Enum describing various stages of bootstrapping, for use with controller
3609 * bootstrap status events. The values range from 0 to 100. */
3611 BOOTSTRAP_STATUS_UNDEF
=-1,
3612 BOOTSTRAP_STATUS_STARTING
=0,
3613 BOOTSTRAP_STATUS_CONN_DIR
=5,
3614 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3615 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3616 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3617 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3618 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3619 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3620 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3621 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3622 BOOTSTRAP_STATUS_CONN_OR
=80,
3623 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3624 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3625 BOOTSTRAP_STATUS_DONE
=100
3626 } bootstrap_status_t
;
3628 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3629 void control_event_bootstrap_problem(const char *warn
, int reason
);
3631 void control_event_clients_seen(const char *timestarted
,
3632 const char *countries
);
3634 #ifdef CONTROL_PRIVATE
3635 /* Used only by control.c and test.c */
3636 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3637 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3640 /********************************* cpuworker.c *****************************/
3642 void cpu_init(void);
3643 void cpuworkers_rotate(void);
3644 int connection_cpu_finished_flushing(connection_t
*conn
);
3645 int connection_cpu_reached_eof(connection_t
*conn
);
3646 int connection_cpu_process_inbuf(connection_t
*conn
);
3647 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3651 /********************************* directory.c ***************************/
3653 int directories_have_accepted_server_descriptor(void);
3654 char *authority_type_to_string(authority_type_t auth
);
3655 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3656 authority_type_t type
, const char *payload
,
3657 size_t payload_len
, size_t extrainfo_len
);
3658 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3659 const char *resource
,
3661 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3662 uint8_t router_purpose
,
3663 const char *resource
);
3664 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3665 uint8_t dir_purpose
,
3666 uint8_t router_purpose
,
3667 int anonymized_connection
,
3668 const char *resource
,
3669 const char *payload
,
3671 time_t if_modified_since
);
3672 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3673 uint8_t dir_purpose
,
3674 uint8_t router_purpose
,
3675 int anonymized_connection
,
3676 const char *resource
,
3677 const char *payload
,
3679 time_t if_modified_since
,
3680 const rend_data_t
*rend_query
);
3682 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3683 compress_method_t
*compression
, char **response
);
3685 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3686 int connection_dir_reached_eof(dir_connection_t
*conn
);
3687 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3688 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3689 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3690 void connection_dir_request_failed(dir_connection_t
*conn
);
3691 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3692 uint16_t or_port
, uint16_t dir_port
,
3693 int supports_conditional_consensus
,
3694 int supports_begindir
, const char *digest
,
3695 uint8_t dir_purpose
, uint8_t router_purpose
,
3696 int anonymized_connection
,
3697 const char *resource
,
3698 const char *payload
, size_t payload_len
,
3699 time_t if_modified_since
);
3701 #define DSR_HEX (1<<0)
3702 #define DSR_BASE64 (1<<1)
3703 #define DSR_DIGEST256 (1<<2)
3704 #define DSR_SORT_UNIQ (1<<3)
3705 int dir_split_resource_into_fingerprints(const char *resource
,
3706 smartlist_t
*fp_out
, int *compressed_out
,
3708 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
3710 char first
[DIGEST_LEN
];
3711 char second
[DIGEST_LEN
];
3713 int dir_split_resource_into_fingerprint_pairs(const char *res
,
3714 smartlist_t
*pairs_out
);
3715 char *directory_dump_request_log(void);
3716 void note_request(const char *key
, size_t bytes
);
3717 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3719 time_t download_status_increment_failure(download_status_t
*dls
,
3720 int status_code
, const char *item
,
3721 int server
, time_t now
);
3722 /** Increment the failure count of the download_status_t <b>dls</b>, with
3723 * the optional status code <b>sc</b>. */
3724 #define download_status_failed(dls, sc) \
3725 download_status_increment_failure((dls), (sc), NULL, \
3726 get_options()->DirPort, time(NULL))
3728 void download_status_reset(download_status_t
*dls
);
3729 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3731 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3732 * ready to get its download reattempted. */
3734 download_status_is_ready(download_status_t
*dls
, time_t now
,
3737 return (dls
->n_download_failures
<= max_failures
3738 && dls
->next_attempt_at
<= now
);
3741 static void download_status_mark_impossible(download_status_t
*dl
);
3742 /** Mark <b>dl</b> as never downloadable. */
3744 download_status_mark_impossible(download_status_t
*dl
)
3746 dl
->n_download_failures
= IMPOSSIBLE_TO_DOWNLOAD
;
3749 /********************************* dirserv.c ***************************/
3750 /** Maximum length of an exit policy summary. */
3751 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3753 /** Maximum allowable length of a version line in a networkstatus. */
3754 #define MAX_V_LINE_LEN 128
3755 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3756 * Running Stable Unnamed V2Dir Valid\n". */
3757 #define MAX_FLAG_LINE_LEN 96
3758 /** Length of "w" line for weighting. Currently at most
3759 * "w Bandwidth=<uint32t> Measured=<uint32t>\n" */
3760 #define MAX_WEIGHT_LINE_LEN (12+10+10+10+1)
3761 /** Maximum length of an exit policy summary line. */
3762 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3763 /** Amount of space to allocate for each entry: r, s, and v lines. */
3764 #define RS_ENTRY_LEN \
3765 ( /* first line */ \
3766 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3767 5*2 /* ports */ + 10 /* punctuation */ + \
3769 MAX_FLAG_LINE_LEN + \
3771 MAX_WEIGHT_LINE_LEN + \
3773 MAX_POLICY_LINE_LEN + \
3777 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3779 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3781 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3782 int dirserv_load_fingerprint_file(void);
3783 void dirserv_free_fingerprint_list(void);
3784 const char *dirserv_get_nickname_by_digest(const char *digest
);
3785 enum was_router_added_t
dirserv_add_multiple_descriptors(
3786 const char *desc
, uint8_t purpose
,
3789 enum was_router_added_t
dirserv_add_descriptor(routerinfo_t
*ri
,
3791 const char *source
);
3792 void dirserv_free_descriptors(void);
3793 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3794 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3795 int for_controller
);
3796 int dirserv_dump_directory_to_string(char **dir_out
,
3797 crypto_pk_env_t
*private_key
);
3799 int directory_fetches_from_authorities(or_options_t
*options
);
3800 int directory_fetches_dir_info_early(or_options_t
*options
);
3801 int directory_fetches_dir_info_later(or_options_t
*options
);
3802 int directory_caches_v2_dir_info(or_options_t
*options
);
3803 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3804 int directory_caches_dir_info(or_options_t
*options
);
3805 int directory_permits_begindir_requests(or_options_t
*options
);
3806 int directory_permits_controller_requests(or_options_t
*options
);
3807 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3809 void directory_set_dirty(void);
3810 cached_dir_t
*dirserv_get_directory(void);
3811 cached_dir_t
*dirserv_get_runningrouters(void);
3812 cached_dir_t
*dirserv_get_consensus(const char *flavor_name
);
3813 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3814 int is_running_routers
);
3815 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3816 const char *identity
,
3818 void dirserv_set_cached_consensus_networkstatus(const char *consensus
,
3819 const char *flavor_name
,
3820 const digests_t
*digests
,
3822 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3823 void dirserv_clear_old_v1_info(time_t now
);
3824 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3825 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3827 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3829 int for_unencrypted_conn
,
3831 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3833 void dirserv_orconn_tls_done(const char *address
,
3835 const char *digest_rcvd
,
3837 void dirserv_test_reachability(time_t now
, int try_all
);
3838 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3840 int dirserv_would_reject_router(routerstatus_t
*rs
);
3841 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3842 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3843 int dirserv_have_any_microdesc(const smartlist_t
*fps
);
3844 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3846 size_t dirserv_estimate_microdesc_size(const smartlist_t
*fps
, int compressed
);
3849 NS_V2
, NS_V3_CONSENSUS
, NS_V3_VOTE
, NS_CONTROL_PORT
,
3850 NS_V3_CONSENSUS_MICRODESC
3851 } routerstatus_format_type_t
;
3852 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3853 routerstatus_t
*rs
, const char *platform
,
3854 routerstatus_format_type_t format
);
3855 void dirserv_free_all(void);
3856 void cached_dir_decref(cached_dir_t
*d
);
3857 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3859 #ifdef DIRSERV_PRIVATE
3860 typedef struct measured_bw_line_t
{
3861 char node_id
[DIGEST_LEN
];
3862 char node_hex
[MAX_HEX_NICKNAME_LEN
+1];
3864 } measured_bw_line_t
;
3866 int measured_bw_line_parse(measured_bw_line_t
*out
, const char *line
);
3868 int measured_bw_line_apply(measured_bw_line_t
*parsed_line
,
3869 smartlist_t
*routerstatuses
);
3872 int dirserv_read_measured_bandwidths(const char *from_file
,
3873 smartlist_t
*routerstatuses
);
3875 /********************************* dirvote.c ************************/
3877 /** Lowest allowable value for VoteSeconds. */
3878 #define MIN_VOTE_SECONDS 20
3879 /** Lowest allowable value for DistSeconds. */
3880 #define MIN_DIST_SECONDS 20
3881 /** Smallest allowable voting interval. */
3882 #define MIN_VOTE_INTERVAL 300
3884 void dirvote_free_all(void);
3886 /* vote manipulation */
3887 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3888 int total_authorities
,
3889 crypto_pk_env_t
*identity_key
,
3890 crypto_pk_env_t
*signing_key
,
3891 const char *legacy_identity_key_digest
,
3892 crypto_pk_env_t
*legacy_signing_key
,
3893 consensus_flavor_t flavor
);
3894 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3895 ns_detached_signatures_t
*sigs
,
3896 const char **msg_out
);
3897 char *networkstatus_get_detached_signatures(smartlist_t
*consensuses
);
3898 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3900 /* cert manipulation */
3901 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3903 /** Describes the schedule by which votes should be generated. */
3904 typedef struct vote_timing_t
{
3906 int n_intervals_valid
;
3910 /* vote scheduling */
3911 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3912 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3913 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3914 void dirvote_act(or_options_t
*options
, time_t now
);
3916 /* invoked on timers and by outside triggers. */
3917 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3918 const char **msg_out
,
3920 int dirvote_add_signatures(const char *detached_signatures_body
,
3922 const char **msg_out
);
3925 const char *dirvote_get_pending_consensus(consensus_flavor_t flav
);
3926 const char *dirvote_get_pending_detached_signatures(void);
3928 #define DGV_INCLUDE_PENDING 2
3929 #define DGV_INCLUDE_PREVIOUS 4
3930 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3931 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3932 routerinfo_t
*ri
, time_t now
,
3933 int naming
, int exits_can_be_guards
,
3934 int listbadexits
, int listbaddirs
);
3935 void router_clear_status_flags(routerinfo_t
*ri
);
3937 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3938 authority_cert_t
*cert
);
3940 microdesc_t
*dirvote_create_microdescriptor(const routerinfo_t
*ri
);
3941 ssize_t
dirvote_format_microdesc_vote_line(char *out
, size_t out_len
,
3942 const microdesc_t
*md
);
3943 int vote_routerstatus_find_microdesc_hash(char *digest256_out
,
3944 const vote_routerstatus_t
*vrs
,
3946 digest_algorithm_t alg
);
3947 document_signature_t
*voter_get_sig_by_algorithm(
3948 const networkstatus_voter_info_t
*voter
,
3949 digest_algorithm_t alg
);
3951 #ifdef DIRVOTE_PRIVATE
3952 char *format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3953 networkstatus_t
*v3_ns
);
3954 char *dirvote_compute_params(smartlist_t
*votes
);
3957 /********************************* dns.c ***************************/
3960 int has_dns_init_failed(void);
3961 void dns_free_all(void);
3962 uint32_t dns_clip_ttl(uint32_t ttl
);
3963 int dns_reset(void);
3964 void connection_dns_remove(edge_connection_t
*conn
);
3965 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3966 void assert_all_pending_dns_resolves_ok(void);
3967 void dns_cancel_pending_resolve(const char *question
);
3968 int dns_resolve(edge_connection_t
*exitconn
);
3969 void dns_launch_correctness_checks(void);
3970 int dns_seems_to_be_broken(void);
3971 void dns_reset_correctness_checks(void);
3972 void dump_dns_mem_usage(int severity
);
3974 /********************************* dnsserv.c ************************/
3976 void dnsserv_configure_listener(connection_t
*conn
);
3977 void dnsserv_close_listener(connection_t
*conn
);
3978 void dnsserv_resolved(edge_connection_t
*conn
,
3983 void dnsserv_reject_request(edge_connection_t
*conn
);
3984 int dnsserv_launch_request(const char *name
, int is_reverse
);
3986 /********************************* geoip.c **************************/
3988 /** Round all GeoIP results to the next multiple of this value, to avoid
3989 * leaking information. */
3990 #define DIR_RECORD_USAGE_GRANULARITY 8
3991 /** Time interval: Flush geoip data to disk this often. */
3992 #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
3993 /** How long do we have to have observed per-country request history before
3994 * we are willing to talk about it? */
3995 #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
3997 #ifdef GEOIP_PRIVATE
3998 int geoip_parse_entry(const char *line
);
4000 int should_record_bridge_info(or_options_t
*options
);
4001 int geoip_load_file(const char *filename
, or_options_t
*options
);
4002 int geoip_get_country_by_ip(uint32_t ipaddr
);
4003 int geoip_get_n_countries(void);
4004 const char *geoip_get_country_name(country_t num
);
4005 int geoip_is_loaded(void);
4006 country_t
geoip_get_country(const char *countrycode
);
4007 /** Indicates an action that we might be noting geoip statistics on.
4008 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
4009 * the others, we're not.
4012 /** We've noticed a connection as a bridge relay or entry guard. */
4013 GEOIP_CLIENT_CONNECT
= 0,
4014 /** We've served a networkstatus consensus as a directory server. */
4015 GEOIP_CLIENT_NETWORKSTATUS
= 1,
4016 /** We've served a v2 networkstatus consensus as a directory server. */
4017 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
4018 } geoip_client_action_t
;
4019 void geoip_note_client_seen(geoip_client_action_t action
,
4020 uint32_t addr
, time_t now
);
4021 void geoip_remove_old_clients(time_t cutoff
);
4022 /** Indicates either a positive reply or a reason for rejectng a network
4023 * status request that will be included in geoip statistics. */
4025 /** Request is answered successfully. */
4027 /** V3 network status is not signed by a sufficient number of requested
4029 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
4030 /** Requested network status object is unavailable. */
4031 GEOIP_REJECT_UNAVAILABLE
= 2,
4032 /** Requested network status not found. */
4033 GEOIP_REJECT_NOT_FOUND
= 3,
4034 /** Network status has not been modified since If-Modified-Since time. */
4035 GEOIP_REJECT_NOT_MODIFIED
= 4,
4036 /** Directory is busy. */
4037 GEOIP_REJECT_BUSY
= 5,
4038 } geoip_ns_response_t
;
4039 #define GEOIP_NS_RESPONSE_NUM 6
4040 void geoip_note_ns_response(geoip_client_action_t action
,
4041 geoip_ns_response_t response
);
4042 time_t geoip_get_history_start(void);
4043 char *geoip_get_client_history_dirreq(time_t now
,
4044 geoip_client_action_t action
);
4045 char *geoip_get_client_history_bridge(time_t now
,
4046 geoip_client_action_t action
);
4047 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
4048 int getinfo_helper_geoip(control_connection_t
*control_conn
,
4049 const char *question
, char **answer
);
4050 void geoip_free_all(void);
4052 /** Directory requests that we are measuring can be either direct or
4056 DIRREQ_TUNNELED
= 1,
4059 /** Possible states for either direct or tunneled directory requests that
4060 * are relevant for determining network status download times. */
4062 /** Found that the client requests a network status; applies to both
4063 * direct and tunneled requests; initial state of a request that we are
4065 DIRREQ_IS_FOR_NETWORK_STATUS
= 0,
4066 /** Finished writing a network status to the directory connection;
4067 * applies to both direct and tunneled requests; completes a direct
4069 DIRREQ_FLUSHING_DIR_CONN_FINISHED
= 1,
4070 /** END cell sent to circuit that initiated a tunneled request. */
4071 DIRREQ_END_CELL_SENT
= 2,
4072 /** Flushed last cell from queue of the circuit that initiated a
4073 * tunneled request to the outbuf of the OR connection. */
4074 DIRREQ_CIRC_QUEUE_FLUSHED
= 3,
4075 /** Flushed last byte from buffer of the OR connection belonging to the
4076 * circuit that initiated a tunneled request; completes a tunneled
4078 DIRREQ_OR_CONN_BUFFER_FLUSHED
= 4
4081 void geoip_start_dirreq(uint64_t dirreq_id
, size_t response_size
,
4082 geoip_client_action_t action
, dirreq_type_t type
);
4083 void geoip_change_dirreq_state(uint64_t dirreq_id
, dirreq_type_t type
,
4084 dirreq_state_t new_state
);
4086 void geoip_dirreq_stats_init(time_t now
);
4087 void geoip_dirreq_stats_write(time_t now
);
4088 void geoip_entry_stats_init(time_t now
);
4089 void geoip_entry_stats_write(time_t now
);
4091 /********************************* hibernate.c **********************/
4093 int accounting_parse_options(or_options_t
*options
, int validate_only
);
4094 int accounting_is_enabled(or_options_t
*options
);
4095 void configure_accounting(time_t now
);
4096 void accounting_run_housekeeping(time_t now
);
4097 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
4098 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
4099 void hibernate_begin_shutdown(void);
4100 int we_are_hibernating(void);
4101 void consider_hibernation(time_t now
);
4102 int getinfo_helper_accounting(control_connection_t
*conn
,
4103 const char *question
, char **answer
);
4104 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
4106 /********************************* main.c ***************************/
4108 extern int has_completed_circuit
;
4110 int connection_add(connection_t
*conn
);
4111 int connection_remove(connection_t
*conn
);
4112 void connection_unregister_events(connection_t
*conn
);
4113 int connection_in_array(connection_t
*conn
);
4114 void add_connection_to_closeable_list(connection_t
*conn
);
4115 int connection_is_on_closeable_list(connection_t
*conn
);
4117 smartlist_t
*get_connection_array(void);
4119 typedef enum watchable_events
{
4122 } watchable_events_t
;
4123 void connection_watch_events(connection_t
*conn
, watchable_events_t events
);
4124 int connection_is_reading(connection_t
*conn
);
4125 void connection_stop_reading(connection_t
*conn
);
4126 void connection_start_reading(connection_t
*conn
);
4128 int connection_is_writing(connection_t
*conn
);
4129 void connection_stop_writing(connection_t
*conn
);
4130 void connection_start_writing(connection_t
*conn
);
4132 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
4134 void directory_all_unreachable(time_t now
);
4135 void directory_info_has_arrived(time_t now
, int from_cache
);
4137 void ip_address_changed(int at_interface
);
4138 void dns_servers_relaunch_checks(void);
4140 void control_signal_act(int the_signal
);
4141 void handle_signals(int is_parent
);
4143 int try_locking(or_options_t
*options
, int err_if_locked
);
4144 int have_lockfile(void);
4145 void release_lockfile(void);
4147 void tor_cleanup(void);
4148 void tor_free_all(int postfork
);
4150 int tor_main(int argc
, char *argv
[]);
4153 int do_main_loop(void);
4154 int do_list_fingerprint(void);
4155 void do_hash_password(void);
4156 int tor_init(int argc
, char **argv
);
4159 /********************************* microdesc.c *************************/
4161 typedef struct microdesc_cache_t microdesc_cache_t
;
4163 microdesc_cache_t
*get_microdesc_cache(void);
4165 smartlist_t
*microdescs_add_to_cache(microdesc_cache_t
*cache
,
4166 const char *s
, const char *eos
, saved_location_t where
,
4168 smartlist_t
*microdescs_add_list_to_cache(microdesc_cache_t
*cache
,
4169 smartlist_t
*descriptors
, saved_location_t where
,
4172 int microdesc_cache_rebuild(microdesc_cache_t
*cache
);
4173 int microdesc_cache_reload(microdesc_cache_t
*cache
);
4174 void microdesc_cache_clear(microdesc_cache_t
*cache
);
4176 microdesc_t
*microdesc_cache_lookup_by_digest256(microdesc_cache_t
*cache
,
4179 size_t microdesc_average_size(microdesc_cache_t
*cache
);
4181 void microdesc_free(microdesc_t
*md
);
4182 void microdesc_free_all(void);
4184 /********************************* networkstatus.c *********************/
4186 /** How old do we allow a v2 network-status to get before removing it
4188 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
4190 /** Location where we found a v2 networkstatus. */
4192 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
4193 } v2_networkstatus_source_t
;
4195 /** Possible statuses of a version of Tor, given opinions from the directory
4197 typedef enum version_status_t
{
4198 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
4199 VS_OLD
=1, /**< This version is older than any recommended version. */
4200 VS_NEW
=2, /**< This version is newer than any recommended version. */
4201 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
4202 * in its series, but later recommended versions exist.
4204 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
4205 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
4206 VS_UNKNOWN
, /**< We have no idea. */
4209 void networkstatus_reset_warnings(void);
4210 void networkstatus_reset_download_failures(void);
4211 int router_reload_v2_networkstatus(void);
4212 int router_reload_consensus_networkstatus(void);
4213 void routerstatus_free(routerstatus_t
*rs
);
4214 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
4215 void networkstatus_vote_free(networkstatus_t
*ns
);
4216 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
4217 networkstatus_t
*vote
,
4218 const char *identity
);
4219 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
4221 int networkstatus_check_document_signature(const networkstatus_t
*consensus
,
4222 document_signature_t
*sig
,
4223 const authority_cert_t
*cert
);
4224 char *networkstatus_get_cache_filename(const char *identity_digest
);
4225 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
4226 v2_networkstatus_source_t source
,
4227 smartlist_t
*requested_fingerprints
);
4228 void networkstatus_v2_list_clean(time_t now
);
4229 int compare_digest_to_routerstatus_entry(const void *_key
,
4230 const void **_member
);
4231 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
4232 const char *digest
);
4233 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
4234 const char *digest
);
4235 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
4236 const char *digest
, int *found_out
);
4237 const smartlist_t
*networkstatus_get_v2_list(void);
4238 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
4239 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
4240 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
4241 const char *digest
);
4242 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
4243 int warn_if_unnamed
);
4244 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
4245 int networkstatus_nickname_is_unnamed(const char *nickname
);
4246 void networkstatus_consensus_download_failed(int status_code
);
4247 void update_consensus_networkstatus_fetch_time(time_t now
);
4248 int should_delay_dir_fetches(or_options_t
*options
);
4249 void update_networkstatus_downloads(time_t now
);
4250 void update_certificate_downloads(time_t now
);
4251 int consensus_is_waiting_for_certs(void);
4252 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
4253 networkstatus_t
*networkstatus_get_latest_consensus(void);
4254 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
4255 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
4256 #define NSSET_FROM_CACHE 1
4257 #define NSSET_WAS_WAITING_FOR_CERTS 2
4258 #define NSSET_DONT_DOWNLOAD_CERTS 4
4259 #define NSSET_ACCEPT_OBSOLETE 8
4260 #define NSSET_REQUIRE_FLAVOR 16
4261 int networkstatus_set_current_consensus(const char *consensus
,
4264 void networkstatus_note_certs_arrived(void);
4265 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
4266 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
4267 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
4268 int reset_failures
);
4269 void signed_descs_update_status_from_consensus_networkstatus(
4270 smartlist_t
*descs
);
4272 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
4273 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
4274 void networkstatus_dump_bridge_status_to_file(time_t now
);
4275 int32_t networkstatus_get_param(networkstatus_t
*ns
, const char *param_name
,
4276 int32_t default_val
);
4277 int getinfo_helper_networkstatus(control_connection_t
*conn
,
4278 const char *question
, char **answer
);
4279 const char *networkstatus_get_flavor_name(consensus_flavor_t flav
);
4280 int networkstatus_parse_flavor_name(const char *flavname
);
4281 void document_signature_free(document_signature_t
*sig
);
4282 document_signature_t
*document_signature_dup(const document_signature_t
*sig
);
4283 void networkstatus_free_all(void);
4285 /********************************* ntmain.c ***************************/
4291 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
4292 int nt_service_is_stopping(void);
4293 void nt_service_set_state(DWORD state
);
4295 #define nt_service_is_stopping() (0)
4298 /********************************* onion.c ***************************/
4300 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
4301 or_circuit_t
*onion_next_task(char **onionskin_out
);
4302 void onion_pending_remove(or_circuit_t
*circ
);
4304 int onion_skin_create(crypto_pk_env_t
*router_key
,
4305 crypto_dh_env_t
**handshake_state_out
,
4306 char *onion_skin_out
);
4308 int onion_skin_server_handshake(const char *onion_skin
,
4309 crypto_pk_env_t
*private_key
,
4310 crypto_pk_env_t
*prev_private_key
,
4311 char *handshake_reply_out
,
4313 size_t key_out_len
);
4315 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
4316 const char *handshake_reply
,
4318 size_t key_out_len
);
4320 int fast_server_handshake(const char *key_in
,
4321 char *handshake_reply_out
,
4323 size_t key_out_len
);
4325 int fast_client_handshake(const char *handshake_state
,
4326 const char *handshake_reply_out
,
4328 size_t key_out_len
);
4330 void clear_pending_onions(void);
4332 /********************************* policies.c ************************/
4334 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
4337 #define POLICY_BUF_LEN 52
4339 /** Outcome of applying an address policy to an address. */
4341 /** The address was accepted */
4342 ADDR_POLICY_ACCEPTED
=0,
4343 /** The address was rejected */
4344 ADDR_POLICY_REJECTED
=-1,
4345 /** Part of the address was unknown, but as far as we can tell, it was
4347 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
4348 /** Part of the address was unknown, but as far as we can tell, it was
4350 ADDR_POLICY_PROBABLY_REJECTED
=2
4351 } addr_policy_result_t
;
4353 int firewall_is_fascist_or(void);
4354 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
4355 int fascist_firewall_allows_or(routerinfo_t
*ri
);
4356 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
4357 int dir_policy_permits_address(const tor_addr_t
*addr
);
4358 int socks_policy_permits_address(const tor_addr_t
*addr
);
4359 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
4360 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
4361 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
4362 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
4364 int validate_addr_policies(or_options_t
*options
, char **msg
);
4365 void policy_expand_private(smartlist_t
**policy
);
4366 int policies_parse_from_options(or_options_t
*options
);
4368 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
4369 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
4370 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
4371 uint16_t port
, const smartlist_t
*policy
);
4372 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
4373 uint16_t port
, const smartlist_t
*policy
);
4374 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
4375 int rejectprivate
, const char *local_address
,
4376 int add_default_policy
);
4377 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
4378 int exit_policy_is_general_exit(smartlist_t
*policy
);
4379 int policy_is_reject_star(const smartlist_t
*policy
);
4380 int getinfo_helper_policies(control_connection_t
*conn
,
4381 const char *question
, char **answer
);
4382 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
4383 int format_for_desc
);
4385 void addr_policy_list_free(smartlist_t
*p
);
4386 void addr_policy_free(addr_policy_t
*p
);
4387 void policies_free_all(void);
4389 char *policy_summarize(smartlist_t
*policy
);
4391 /********************************* reasons.c ***************************/
4393 const char *stream_end_reason_to_control_string(int reason
);
4394 const char *stream_end_reason_to_string(int reason
);
4395 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
4396 uint8_t errno_to_stream_end_reason(int e
);
4398 const char *orconn_end_reason_to_control_string(int r
);
4399 int tls_error_to_orconn_end_reason(int e
);
4400 int errno_to_orconn_end_reason(int e
);
4402 const char *circuit_end_reason_to_control_string(int reason
);
4403 const char *socks4_response_code_to_string(uint8_t code
);
4404 const char *socks5_response_code_to_string(uint8_t code
);
4406 /********************************* relay.c ***************************/
4408 extern uint64_t stats_n_relay_cells_relayed
;
4409 extern uint64_t stats_n_relay_cells_delivered
;
4411 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
4412 cell_direction_t cell_direction
);
4414 void relay_header_pack(char *dest
, const relay_header_t
*src
);
4415 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
4416 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
4417 uint8_t relay_command
, const char *payload
,
4418 size_t payload_len
, crypt_path_t
*cpath_layer
);
4419 int connection_edge_send_command(edge_connection_t
*fromconn
,
4420 uint8_t relay_command
, const char *payload
,
4421 size_t payload_len
);
4422 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
4423 int package_partial
);
4424 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
4426 extern uint64_t stats_n_data_cells_packaged
;
4427 extern uint64_t stats_n_data_bytes_packaged
;
4428 extern uint64_t stats_n_data_cells_received
;
4429 extern uint64_t stats_n_data_bytes_received
;
4431 void init_cell_pool(void);
4432 void free_cell_pool(void);
4433 void clean_cell_pool(void);
4434 void dump_cell_pool_usage(int severity
);
4436 void cell_queue_clear(cell_queue_t
*queue
);
4437 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
4438 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
4440 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
4441 cell_t
*cell
, cell_direction_t direction
);
4442 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
4443 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
4444 int max
, time_t now
);
4445 void assert_active_circuits_ok(or_connection_t
*orconn
);
4446 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
4447 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
4449 int append_address_to_payload(char *payload_out
, const tor_addr_t
*addr
);
4450 const char *decode_address_from_payload(tor_addr_t
*addr_out
,
4451 const char *payload
,
4454 /********************************* rephist.c ***************************/
4456 void rep_hist_init(void);
4457 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
4458 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
4459 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
4460 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
4461 void rep_hist_note_extend_succeeded(const char *from_name
,
4462 const char *to_name
);
4463 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
4464 void rep_hist_dump_stats(time_t now
, int severity
);
4465 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
4466 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
4467 void rep_hist_note_exit_bytes_read(uint16_t port
, size_t num_bytes
);
4468 void rep_hist_note_exit_bytes_written(uint16_t port
, size_t num_bytes
);
4469 void rep_hist_note_exit_stream_opened(uint16_t port
);
4470 void rep_hist_exit_stats_init(time_t now
);
4471 void rep_hist_exit_stats_write(time_t now
);
4472 int rep_hist_bandwidth_assess(void);
4473 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
4474 void rep_hist_update_state(or_state_t
*state
);
4475 int rep_hist_load_state(or_state_t
*state
, char **err
);
4476 void rep_history_clean(time_t before
);
4478 void rep_hist_note_router_reachable(const char *id
, time_t when
);
4479 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
4480 int rep_hist_record_mtbf_data(time_t now
, int missing_means_down
);
4481 int rep_hist_load_mtbf_data(time_t now
);
4483 time_t rep_hist_downrate_old_runs(time_t now
);
4484 double rep_hist_get_stability(const char *id
, time_t when
);
4485 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
4486 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
4487 int rep_hist_have_measured_enough_stability(void);
4488 const char *rep_hist_get_router_stability_doc(time_t now
);
4490 void rep_hist_note_used_port(time_t now
, uint16_t port
);
4491 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
4492 void rep_hist_note_used_resolve(time_t now
);
4493 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
4495 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
4496 int *need_capacity
);
4498 int any_predicted_circuits(time_t now
);
4499 int rep_hist_circbuilding_dormant(time_t now
);
4501 /** Possible public/private key operations in Tor: used to keep track of where
4502 * we're spending our time. */
4505 VERIFY_DIR
, VERIFY_RTR
,
4506 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4507 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4508 REND_CLIENT
, REND_MID
, REND_SERVER
,
4510 void note_crypto_pk_op(pk_op_t operation
);
4511 void dump_pk_ops(int severity
);
4513 void rep_hist_free_all(void);
4515 /* for hidden service usage statistics */
4516 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
4517 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
4518 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
4519 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
4520 void hs_usage_write_statistics_to_file(time_t now
);
4521 void hs_usage_free_all(void);
4523 void rep_hist_buffer_stats_init(time_t now
);
4524 void rep_hist_buffer_stats_add_circ(circuit_t
*circ
,
4525 time_t end_of_interval
);
4526 void rep_hist_buffer_stats_write(time_t now
);
4528 /********************************* rendclient.c ***************************/
4530 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
4531 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
4532 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
4533 size_t request_len
);
4534 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
4535 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
4536 const rend_data_t
*rend_query
);
4537 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
4538 size_t request_len
);
4539 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
4540 size_t request_len
);
4541 void rend_client_desc_trynow(const char *query
);
4543 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
4545 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
4546 origin_circuit_t
*rendcirc
);
4547 int rend_parse_service_authorization(or_options_t
*options
,
4549 rend_service_authorization_t
*rend_client_lookup_service_authorization(
4550 const char *onion_address
);
4551 void rend_service_authorization_free_all(void);
4552 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
4554 /********************************* rendcommon.c ***************************/
4556 /** Hidden-service side configuration of client authorization. */
4557 typedef struct rend_authorized_client_t
{
4559 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4560 crypto_pk_env_t
*client_key
;
4561 } rend_authorized_client_t
;
4563 /** ASCII-encoded v2 hidden service descriptor. */
4564 typedef struct rend_encoded_v2_service_descriptor_t
{
4565 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4566 char *desc_str
; /**< Descriptor string. */
4567 } rend_encoded_v2_service_descriptor_t
;
4569 /** Introduction point information. */
4570 typedef struct rend_intro_point_t
{
4571 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4572 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
4573 * key, if this descriptor is V2. */
4574 } rend_intro_point_t
;
4576 /** Information used to connect to a hidden service. */
4577 typedef struct rend_service_descriptor_t
{
4578 crypto_pk_env_t
*pk
; /**< This service's public key. */
4579 int version
; /**< Version of the descriptor format: 0 or 2. */
4580 time_t timestamp
; /**< Time when the descriptor was generated. */
4581 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
4582 * (We allow bits '0', '1', and '2' to be set.) */
4583 /** List of the service's introduction points. Elements are removed if
4584 * introduction attempts fail. */
4585 smartlist_t
*intro_nodes
;
4586 /** Has descriptor been uploaded to all hidden service directories? */
4587 int all_uploads_performed
;
4588 /** List of hidden service directories to which an upload request for
4589 * this descriptor could be sent. Smartlist exists only when at least one
4590 * of the previous upload requests failed (otherwise it's not important
4591 * to know which uploads succeeded and which not). */
4592 smartlist_t
*successful_uploads
;
4593 } rend_service_descriptor_t
;
4595 /** Free all storage associated with <b>data</b> */
4597 rend_data_free(rend_data_t
*data
)
4602 int rend_cmp_service_ids(const char *one
, const char *two
);
4604 void rend_process_relay_cell(circuit_t
*circ
, const crypt_path_t
*layer_hint
,
4605 int command
, size_t length
, const char *payload
);
4607 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
4608 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
4610 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
4611 void rend_encoded_v2_service_descriptor_free(
4612 rend_encoded_v2_service_descriptor_t
*desc
);
4613 void rend_intro_point_free(rend_intro_point_t
*intro
);
4615 /** A cached rendezvous descriptor. */
4616 typedef struct rend_cache_entry_t
{
4617 size_t len
; /**< Length of <b>desc</b> */
4618 time_t received
; /**< When was the descriptor received? */
4619 char *desc
; /**< Service descriptor */
4620 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
4621 } rend_cache_entry_t
;
4623 void rend_cache_init(void);
4624 void rend_cache_clean(void);
4625 void rend_cache_clean_v2_descs_as_dir(void);
4626 void rend_cache_free_all(void);
4627 int rend_valid_service_id(const char *query
);
4628 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
4630 int rend_cache_lookup_entry(const char *query
, int version
,
4631 rend_cache_entry_t
**entry_out
);
4632 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
4633 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
4634 int rend_cache_store_v2_desc_as_client(const char *desc
,
4635 const rend_data_t
*rend_query
);
4636 int rend_cache_store_v2_desc_as_dir(const char *desc
);
4637 int rend_cache_size(void);
4638 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
4639 rend_service_descriptor_t
*desc
, time_t now
,
4640 uint8_t period
, rend_auth_type_t auth_type
,
4641 crypto_pk_env_t
*client_key
,
4642 smartlist_t
*client_cookies
);
4643 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
4644 const char *descriptor_cookie
,
4645 time_t now
, uint8_t replica
);
4646 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4647 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4648 const char *service_id
,
4649 const char *secret_id_part
);
4651 /********************************* rendservice.c ***************************/
4653 int num_rend_services(void);
4654 int rend_config_services(or_options_t
*options
, int validate_only
);
4655 int rend_service_load_keys(void);
4656 void rend_services_init(void);
4657 void rend_services_introduce(void);
4658 void rend_consider_services_upload(time_t now
);
4659 void rend_hsdir_routers_changed(void);
4660 void rend_consider_descriptor_republication(void);
4662 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4663 int rend_service_intro_established(origin_circuit_t
*circuit
,
4664 const char *request
,
4665 size_t request_len
);
4666 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4667 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
4668 size_t request_len
);
4669 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4670 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4671 origin_circuit_t
*circ
);
4672 void rend_service_dump_stats(int severity
);
4673 void rend_service_free_all(void);
4675 /********************************* rendmid.c *******************************/
4676 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
4677 size_t request_len
);
4678 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
4679 size_t request_len
);
4680 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
4681 size_t request_len
);
4682 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
4683 size_t request_len
);
4685 /********************************* router.c ***************************/
4687 crypto_pk_env_t
*get_onion_key(void);
4688 time_t get_onion_key_set_at(void);
4689 void set_identity_key(crypto_pk_env_t
*k
);
4690 crypto_pk_env_t
*get_identity_key(void);
4691 int identity_key_is_set(void);
4692 authority_cert_t
*get_my_v3_authority_cert(void);
4693 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4694 authority_cert_t
*get_my_v3_legacy_cert(void);
4695 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4696 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4697 void rotate_onion_key(void);
4698 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4700 void v3_authority_check_key_expiry(void);
4702 int init_keys(void);
4704 int check_whether_orport_reachable(void);
4705 int check_whether_dirport_reachable(void);
4706 void consider_testing_reachability(int test_or
, int test_dir
);
4707 void router_orport_found_reachable(void);
4708 void router_dirport_found_reachable(void);
4709 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4711 int authdir_mode(or_options_t
*options
);
4712 int authdir_mode_v1(or_options_t
*options
);
4713 int authdir_mode_v2(or_options_t
*options
);
4714 int authdir_mode_v3(or_options_t
*options
);
4715 int authdir_mode_any_main(or_options_t
*options
);
4716 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4717 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4718 int authdir_mode_publishes_statuses(or_options_t
*options
);
4719 int authdir_mode_tests_reachability(or_options_t
*options
);
4720 int authdir_mode_bridge(or_options_t
*options
);
4722 int clique_mode(or_options_t
*options
);
4723 int server_mode(or_options_t
*options
);
4724 int advertised_server_mode(void);
4725 int proxy_mode(or_options_t
*options
);
4726 void consider_publishable_server(int force
);
4728 int router_is_clique_mode(routerinfo_t
*router
);
4729 void router_upload_dir_desc_to_dirservers(int force
);
4730 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4731 void mark_my_descriptor_dirty(void);
4732 void check_descriptor_bandwidth_changed(time_t now
);
4733 void check_descriptor_ipaddress_changed(time_t now
);
4734 void router_new_address_suggestion(const char *suggestion
,
4735 const dir_connection_t
*d_conn
);
4736 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4737 routerinfo_t
*router_get_my_routerinfo(void);
4738 extrainfo_t
*router_get_my_extrainfo(void);
4739 const char *router_get_my_descriptor(void);
4740 int router_digest_is_me(const char *digest
);
4741 int router_extrainfo_digest_is_me(const char *digest
);
4742 int router_is_me(routerinfo_t
*router
);
4743 int router_fingerprint_is_me(const char *fp
);
4744 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4745 int router_rebuild_descriptor(int force
);
4746 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4747 crypto_pk_env_t
*ident_key
);
4748 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4749 crypto_pk_env_t
*ident_key
);
4750 char *extrainfo_get_client_geoip_summary(time_t);
4751 int is_legal_nickname(const char *s
);
4752 int is_legal_nickname_or_hexdigest(const char *s
);
4753 int is_legal_hexdigest(const char *s
);
4754 void router_get_verbose_nickname(char *buf
, const routerinfo_t
*router
);
4755 void routerstatus_get_verbose_nickname(char *buf
,
4756 const routerstatus_t
*router
);
4757 void router_reset_warnings(void);
4758 void router_reset_reachability(void);
4759 void router_free_all(void);
4761 const char *router_purpose_to_string(uint8_t p
);
4762 uint8_t router_purpose_from_string(const char *s
);
4764 #ifdef ROUTER_PRIVATE
4765 /* Used only by router.c and test.c */
4766 void get_platform_str(char *platform
, size_t len
);
4769 /********************************* routerlist.c ***************************/
4771 /** Represents information about a single trusted directory server. */
4772 typedef struct trusted_dir_server_t
{
4775 char *address
; /**< Hostname. */
4776 uint32_t addr
; /**< IPv4 address. */
4777 uint16_t dir_port
; /**< Directory port. */
4778 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4779 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4780 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4781 * high-security) identity key. */
4783 unsigned int is_running
:1; /**< True iff we think this server is running. */
4785 /** True iff this server has accepted the most recent server descriptor
4786 * we tried to upload to it. */
4787 unsigned int has_accepted_serverdesc
:1;
4789 /** What kind of authority is this? (Bitfield.) */
4790 authority_type_t type
;
4792 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4793 * v2 network status. */
4794 time_t addr_current_at
; /**< When was the document that we derived the
4795 * address information from published? */
4797 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4798 * dir_server_t to directory_initiate_command_*
4799 * as a routerstatus_t. Not updated by the
4800 * router-status management code!
4802 } trusted_dir_server_t
;
4804 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
4806 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4808 int get_n_authorities(authority_type_t type
);
4809 int trusted_dirs_reload_certs(void);
4810 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4812 void trusted_dirs_flush_certs_to_disk(void);
4813 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4814 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4815 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4816 const char *sk_digest
);
4817 void authority_cert_get_all(smartlist_t
*certs_out
);
4818 void authority_cert_dl_failed(const char *id_digest
, int status
);
4819 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4820 int router_reload_router_list(void);
4821 smartlist_t
*router_get_trusted_dir_servers(void);
4823 /* Flags for pick_directory_server and pick_trusteddirserver. */
4824 /** Flag to indicate that we should not automatically be willing to use
4825 * ourself to answer a directory request.
4826 * Passed to router_pick_directory_server (et al).*/
4827 #define PDS_ALLOW_SELF (1<<0)
4828 /** Flag to indicate that if no servers seem to be up, we should mark all
4829 * directory servers as up and try again.
4830 * Passed to router_pick_directory_server (et al).*/
4831 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4832 /** Flag to indicate that we should not exclude directory servers that
4833 * our ReachableAddress settings would exclude. This usually means that
4834 * we're going to connect to the server over Tor, and so we don't need to
4835 * worry about our firewall telling us we can't.
4836 * Passed to router_pick_directory_server (et al).*/
4837 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4838 /** Flag to indicate that we should not use any directory authority to which
4839 * we have an existing directory connection for downloading server descriptors
4840 * or extrainfo documents.
4842 * Passed to router_pick_directory_server (et al)
4844 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
4845 * not pick_directory_server. If we make it work on pick_directory_server
4846 * too, we could conservatively make it only prevent multiple fetches to
4847 * the same authority, or we could aggressively make it prevent multiple
4848 * fetches to _any_ single directory server.]
4850 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4851 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4852 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4853 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4854 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4855 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4856 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4857 double *v3_share_out
);
4858 void router_reset_status_download_failures(void);
4859 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4860 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4861 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4862 int must_be_running
);
4863 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4864 routerinfo_t
*routerlist_find_my_routerinfo(void);
4865 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4867 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4868 int need_capacity
, int need_guard
);
4869 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4870 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4872 /** Possible ways to weight routers when choosing one randomly. See
4873 * routerlist_sl_choose_by_bandwidth() for more information.*/
4875 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4876 } bandwidth_weight_rule_t
;
4877 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4878 bandwidth_weight_rule_t rule
);
4879 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4881 /** Flags to be passed to control router_choose_random_node() to indicate what
4882 * kind of nodes to pick according to what algorithm. */
4884 CRN_NEED_UPTIME
= 1<<0,
4885 CRN_NEED_CAPACITY
= 1<<1,
4886 CRN_NEED_GUARD
= 1<<2,
4887 CRN_ALLOW_INVALID
= 1<<3,
4888 /* XXXX not used, apparently. */
4889 CRN_STRICT_PREFERRED
= 1<<4,
4890 /* XXXX not used, apparently. */
4891 CRN_WEIGHT_AS_EXIT
= 1<<5
4892 } router_crn_flags_t
;
4894 routerinfo_t
*router_choose_random_node(const char *preferred
,
4895 smartlist_t
*excludedsmartlist
,
4896 struct routerset_t
*excludedset
,
4897 router_crn_flags_t flags
);
4899 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4900 int warn_if_unnamed
);
4901 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4902 int router_digest_is_trusted_dir_type(const char *digest
,
4903 authority_type_t type
);
4904 #define router_digest_is_trusted_dir(d) \
4905 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4907 int router_addr_is_trusted_dir(uint32_t addr
);
4908 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4909 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4910 routerinfo_t
*router_get_by_digest(const char *digest
);
4911 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4912 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4913 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4914 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4915 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4916 routerlist_t
*router_get_routerlist(void);
4917 void routerinfo_free(routerinfo_t
*router
);
4918 void extrainfo_free(extrainfo_t
*extrainfo
);
4919 void routerlist_free(routerlist_t
*rl
);
4920 void dump_routerlist_mem_usage(int severity
);
4921 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
,
4923 void routerlist_free_all(void);
4924 void routerlist_reset_warnings(void);
4925 void router_set_status(const char *digest
, int up
);
4927 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
4928 typedef enum was_router_added_t
{
4929 ROUTER_ADDED_SUCCESSFULLY
= 1,
4930 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
4932 ROUTER_WAS_NOT_NEW
= -2,
4933 ROUTER_NOT_IN_CONSENSUS
= -3,
4934 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
4935 ROUTER_AUTHDIR_REJECTS
= -5,
4936 } was_router_added_t
;
4938 static int WRA_WAS_ADDED(was_router_added_t s
);
4939 static int WRA_WAS_OUTDATED(was_router_added_t s
);
4940 static int WRA_WAS_REJECTED(was_router_added_t s
);
4941 /** Return true iff the descriptor was added. It might still be necessary to
4942 * check whether the descriptor generator should be notified.
4945 WRA_WAS_ADDED(was_router_added_t s
) {
4946 return s
== ROUTER_ADDED_SUCCESSFULLY
|| s
== ROUTER_ADDED_NOTIFY_GENERATOR
;
4948 /** Return true iff the descriptor was not added because it was either:
4949 * - not in the consensus
4950 * - neither in the consensus nor in any networkstatus document
4951 * - it was outdated.
4953 static INLINE
int WRA_WAS_OUTDATED(was_router_added_t s
)
4955 return (s
== ROUTER_WAS_NOT_NEW
||
4956 s
== ROUTER_NOT_IN_CONSENSUS
||
4957 s
== ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
);
4959 /** Return true iff the descriptor rejected because it was malformed. */
4960 static INLINE
int WRA_WAS_REJECTED(was_router_added_t s
)
4962 return (s
== ROUTER_AUTHDIR_REJECTS
);
4964 was_router_added_t
router_add_to_routerlist(routerinfo_t
*router
,
4968 was_router_added_t
router_add_extrainfo_to_routerlist(
4969 extrainfo_t
*ei
, const char **msg
,
4970 int from_cache
, int from_fetch
);
4971 void routerlist_remove_old_routers(void);
4972 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4974 int router_load_routers_from_string(const char *s
, const char *eos
,
4975 saved_location_t saved_location
,
4976 smartlist_t
*requested_fingerprints
,
4977 int descriptor_digests
,
4978 const char *prepend_annotations
);
4979 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4980 saved_location_t saved_location
,
4981 smartlist_t
*requested_fingerprints
,
4982 int descriptor_digests
);
4983 void routerlist_retry_directory_downloads(time_t now
);
4984 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4986 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4987 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4988 const char *address
,
4989 uint16_t dir_port
, uint16_t or_port
,
4990 const char *digest
, const char *v3_auth_digest
,
4991 authority_type_t type
);
4992 void authority_cert_free(authority_cert_t
*cert
);
4993 void clear_trusted_dir_servers(void);
4994 int any_trusted_dir_is_v1_authority(void);
4995 void update_router_descriptor_downloads(time_t now
);
4996 void update_extrainfo_downloads(time_t now
);
4997 int router_have_minimum_dir_info(void);
4998 void router_dir_info_changed(void);
4999 const char *get_dir_info_status_string(void);
5000 int count_loading_descriptors_progress(void);
5001 void router_reset_descriptor_download_failures(void);
5002 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
5003 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
5004 signed_descriptor_t
*sd
,
5006 void routerlist_assert_ok(routerlist_t
*rl
);
5007 const char *esc_router_info(routerinfo_t
*router
);
5008 void routers_sort_by_identity(smartlist_t
*routers
);
5010 routerset_t
*routerset_new(void);
5011 int routerset_parse(routerset_t
*target
, const char *s
,
5012 const char *description
);
5013 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
5014 int routerset_is_list(const routerset_t
*set
);
5015 int routerset_needs_geoip(const routerset_t
*set
);
5016 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
5017 int routerset_contains_routerstatus(const routerset_t
*set
,
5018 routerstatus_t
*rs
);
5019 int routerset_contains_extendinfo(const routerset_t
*set
,
5020 const extend_info_t
*ei
);
5021 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
5023 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
5024 const routerset_t
*include
,
5025 const routerset_t
*exclude
, int running_only
);
5026 void routerset_subtract_routers(smartlist_t
*out
,
5027 const routerset_t
*routerset
);
5028 char *routerset_to_string(const routerset_t
*routerset
);
5029 void routerset_refresh_countries(routerset_t
*target
);
5030 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
5031 void routerset_free(routerset_t
*routerset
);
5032 void routerinfo_set_country(routerinfo_t
*ri
);
5033 void routerlist_refresh_countries(void);
5034 void refresh_all_country_info(void);
5036 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
5038 int hid_serv_acting_as_directory(void);
5039 int hid_serv_responsible_for_desc_id(const char *id
);
5041 /********************************* routerparse.c ************************/
5043 #define MAX_STATUS_TAG_LEN 32
5044 /** Structure to hold parsed Tor versions. This is a little messier
5045 * than we would like it to be, because we changed version schemes with 0.1.0.
5047 * See version-spec.txt for the whole business.
5049 typedef struct tor_version_t
{
5053 /** Release status. For version in the post-0.1 format, this is always
5055 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
5057 char status_tag
[MAX_STATUS_TAG_LEN
];
5061 char git_tag
[DIGEST_LEN
];
5064 int router_get_router_hash(const char *s
, char *digest
);
5065 int router_get_dir_hash(const char *s
, char *digest
);
5066 int router_get_runningrouters_hash(const char *s
, char *digest
);
5067 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
5068 int router_get_networkstatus_v3_hash(const char *s
, char *digest
,
5069 digest_algorithm_t algorithm
);
5070 int router_get_networkstatus_v3_hashes(const char *s
, digests_t
*digests
);
5071 int router_get_extrainfo_hash(const char *s
, char *digest
);
5072 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
5075 crypto_pk_env_t
*private_key
);
5076 int router_parse_list_from_string(const char **s
, const char *eos
,
5078 saved_location_t saved_location
,
5080 int allow_annotations
,
5081 const char *prepend_annotations
);
5082 int router_parse_routerlist_from_directory(const char *s
,
5083 routerlist_t
**dest
,
5084 crypto_pk_env_t
*pkey
,
5086 int write_to_cache
);
5087 int router_parse_runningrouters(const char *str
);
5088 int router_parse_directory(const char *str
);
5089 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
5091 int allow_annotations
,
5092 const char *prepend_annotations
);
5093 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
5094 int cache_copy
, struct digest_ri_map_t
*routermap
);
5095 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
5097 version_status_t
tor_version_is_obsolete(const char *myversion
,
5098 const char *versionlist
);
5099 int tor_version_parse(const char *s
, tor_version_t
*out
);
5100 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
5101 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
5102 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
5103 void assert_addr_policy_ok(smartlist_t
*t
);
5104 void dump_distinct_digest_count(int severity
);
5106 int compare_routerstatus_entries(const void **_a
, const void **_b
);
5107 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
5108 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
5109 const char **eos_out
,
5110 networkstatus_type_t ns_type
);
5111 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
5112 const char *s
, const char *eos
);
5114 smartlist_t
*microdescs_parse_from_string(const char *s
, const char *eos
,
5115 int allow_annotations
,
5118 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
5119 const char **end_of_string
);
5120 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
5122 char **intro_points_encrypted_out
,
5123 size_t *intro_points_encrypted_size_out
,
5124 size_t *encoded_size_out
,
5125 const char **next_out
, const char *desc
);
5126 int rend_decrypt_introduction_points(char **ipos_decrypted
,
5127 size_t *ipos_decrypted_size
,
5128 const char *descriptor_cookie
,
5129 const char *ipos_encrypted
,
5130 size_t ipos_encrypted_size
);
5131 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
5132 const char *intro_points_encoded
,
5133 size_t intro_points_encoded_size
);
5134 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);