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
87 #include "container.h"
91 #include "compat_libevent.h"
93 /* These signals are defined to help control_signal_act work.
110 /* Controller signals start at a high number so we don't
111 * conflict with system-defined signals. */
112 #define SIGNEWNYM 129
113 #define SIGCLEARDNSCACHE 130
115 #if (SIZEOF_CELL_T != 0)
116 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
117 * that our stuff always calls cell_t something different. */
118 #define cell_t tor_cell_t
121 /** Length of longest allowable configured nickname. */
122 #define MAX_NICKNAME_LEN 19
123 /** Length of a router identity encoded as a hexadecimal digest, plus
124 * possible dollar sign. */
125 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
126 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
127 * equal sign or tilde, nickname. */
128 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
130 /** Maximum size, in bytes, for resized buffers. */
131 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
132 /** Maximum size, in bytes, for any directory object that we've downloaded. */
133 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
135 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
136 * of an HTTP request or response. */
137 #define MAX_HEADERS_SIZE 50000
138 /** Maximum size, in bytes, for any directory object that we're accepting
140 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
142 /** Maximum size, in bytes, of a single router descriptor uploaded to us
143 * as a directory authority. Caches and clients fetch whatever descriptors
144 * the authorities tell them to fetch, and don't care about size. */
145 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
147 /** Maximum size of a single extrainfo document, as above. */
148 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
150 /** How long do we keep DNS cache entries before purging them (regardless of
152 #define MAX_DNS_ENTRY_AGE (30*60)
153 /** How long do we cache/tell clients to cache DNS records when no TTL is
155 #define DEFAULT_DNS_TTL (30*60)
156 /** How long can a TTL be before we stop believing it? */
157 #define MAX_DNS_TTL (3*60*60)
158 /** How small can a TTL be before we stop believing it? Provides rudimentary
160 #define MIN_DNS_TTL (60)
162 /** How often do we rotate onion keys? */
163 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
164 /** How often do we rotate TLS contexts? */
165 #define MAX_SSL_KEY_LIFETIME (2*60*60)
167 /** How old do we allow a router to get before removing it
168 * from the router list? In seconds. */
169 #define ROUTER_MAX_AGE (60*60*48)
170 /** How old can a router get before we (as a server) will no longer
171 * consider it live? In seconds. */
172 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
173 /** How old do we let a saved descriptor get before force-removing it? */
174 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
176 /** Possible rules for generating circuit IDs on an OR connection. */
178 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
179 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
180 /** The other side of a connection is an OP: never create circuits to it,
181 * and let it use any circuit ID it wants. */
182 CIRC_ID_TYPE_NEITHER
=2
185 #define _CONN_TYPE_MIN 3
186 /** Type for sockets listening for OR connections. */
187 #define CONN_TYPE_OR_LISTENER 3
188 /** A bidirectional TLS connection transmitting a sequence of cells.
189 * May be from an OR to an OR, or from an OP to an OR. */
190 #define CONN_TYPE_OR 4
191 /** A TCP connection from an onion router to a stream's destination. */
192 #define CONN_TYPE_EXIT 5
193 /** Type for sockets listening for SOCKS connections. */
194 #define CONN_TYPE_AP_LISTENER 6
195 /** A SOCKS proxy connection from the user application to the onion
197 #define CONN_TYPE_AP 7
198 /** Type for sockets listening for HTTP connections to the directory server. */
199 #define CONN_TYPE_DIR_LISTENER 8
200 /** Type for HTTP connections to the directory server. */
201 #define CONN_TYPE_DIR 9
202 /** Connection from the main process to a CPU worker process. */
203 #define CONN_TYPE_CPUWORKER 10
204 /** Type for listening for connections from user interface process. */
205 #define CONN_TYPE_CONTROL_LISTENER 11
206 /** Type for connections from user interface process. */
207 #define CONN_TYPE_CONTROL 12
208 /** Type for sockets listening for transparent connections redirected by pf or
210 #define CONN_TYPE_AP_TRANS_LISTENER 13
211 /** Type for sockets listening for transparent connections redirected by
213 #define CONN_TYPE_AP_NATD_LISTENER 14
214 /** Type for sockets listening for DNS requests. */
215 #define CONN_TYPE_AP_DNS_LISTENER 15
216 #define _CONN_TYPE_MAX 15
217 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
220 /* Proxy client types */
222 #define PROXY_CONNECT 1
223 #define PROXY_SOCKS4 2
224 #define PROXY_SOCKS5 3
226 /* Proxy client handshake states */
227 #define PROXY_HTTPS_WANT_CONNECT_OK 1
228 #define PROXY_SOCKS4_WANT_CONNECT_OK 2
229 #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 3
230 #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 4
231 #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 5
232 #define PROXY_SOCKS5_WANT_CONNECT_OK 6
233 #define PROXY_CONNECTED 7
235 /** True iff <b>x</b> is an edge connection. */
236 #define CONN_IS_EDGE(x) \
237 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
239 /** State for any listener connection. */
240 #define LISTENER_STATE_READY 0
242 #define _CPUWORKER_STATE_MIN 1
243 /** State for a connection to a cpuworker process that's idle. */
244 #define CPUWORKER_STATE_IDLE 1
245 /** State for a connection to a cpuworker process that's processing a
247 #define CPUWORKER_STATE_BUSY_ONION 2
248 #define _CPUWORKER_STATE_MAX 2
250 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
252 #define _OR_CONN_STATE_MIN 1
253 /** State for a connection to an OR: waiting for connect() to finish. */
254 #define OR_CONN_STATE_CONNECTING 1
255 /** State for a connection to an OR: waiting for proxy handshake to complete */
256 #define OR_CONN_STATE_PROXY_HANDSHAKING 2
257 /** State for a connection to an OR or client: SSL is handshaking, not done
259 #define OR_CONN_STATE_TLS_HANDSHAKING 3
260 /** State for a connection to an OR: We're doing a second SSL handshake for
261 * renegotiation purposes. */
262 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
263 /** State for a connection at an OR: We're waiting for the client to
265 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
266 /** State for a connection to an OR: We're done with our SSL handshake, but we
267 * haven't yet negotiated link protocol versions and sent a netinfo cell.
269 #define OR_CONN_STATE_OR_HANDSHAKING 6
270 /** State for a connection to an OR: Ready to send/receive cells. */
271 #define OR_CONN_STATE_OPEN 7
272 #define _OR_CONN_STATE_MAX 7
274 #define _EXIT_CONN_STATE_MIN 1
275 /** State for an exit connection: waiting for response from DNS farm. */
276 #define EXIT_CONN_STATE_RESOLVING 1
277 /** State for an exit connection: waiting for connect() to finish. */
278 #define EXIT_CONN_STATE_CONNECTING 2
279 /** State for an exit connection: open and ready to transmit data. */
280 #define EXIT_CONN_STATE_OPEN 3
281 /** State for an exit connection: waiting to be removed. */
282 #define EXIT_CONN_STATE_RESOLVEFAILED 4
283 #define _EXIT_CONN_STATE_MAX 4
285 /* The AP state values must be disjoint from the EXIT state values. */
286 #define _AP_CONN_STATE_MIN 5
287 /** State for a SOCKS connection: waiting for SOCKS request. */
288 #define AP_CONN_STATE_SOCKS_WAIT 5
289 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
290 * rendezvous descriptor. */
291 #define AP_CONN_STATE_RENDDESC_WAIT 6
292 /** The controller will attach this connection to a circuit; it isn't our
294 #define AP_CONN_STATE_CONTROLLER_WAIT 7
295 /** State for a SOCKS connection: waiting for a completed circuit. */
296 #define AP_CONN_STATE_CIRCUIT_WAIT 8
297 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
298 #define AP_CONN_STATE_CONNECT_WAIT 9
299 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
300 #define AP_CONN_STATE_RESOLVE_WAIT 10
301 /** State for a SOCKS connection: ready to send and receive. */
302 #define AP_CONN_STATE_OPEN 11
303 /** State for a transparent natd connection: waiting for original
305 #define AP_CONN_STATE_NATD_WAIT 12
306 #define _AP_CONN_STATE_MAX 12
308 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
309 * edge connection is not attached to any circuit. */
310 #define AP_CONN_STATE_IS_UNATTACHED(s) \
311 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
313 #define _DIR_CONN_STATE_MIN 1
314 /** State for connection to directory server: waiting for connect(). */
315 #define DIR_CONN_STATE_CONNECTING 1
316 /** State for connection to directory server: sending HTTP request. */
317 #define DIR_CONN_STATE_CLIENT_SENDING 2
318 /** State for connection to directory server: reading HTTP response. */
319 #define DIR_CONN_STATE_CLIENT_READING 3
320 /** State for connection to directory server: happy and finished. */
321 #define DIR_CONN_STATE_CLIENT_FINISHED 4
322 /** State for connection at directory server: waiting for HTTP request. */
323 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
324 /** State for connection at directory server: sending HTTP response. */
325 #define DIR_CONN_STATE_SERVER_WRITING 6
326 #define _DIR_CONN_STATE_MAX 6
328 /** True iff the purpose of <b>conn</b> means that it's a server-side
329 * directory connection. */
330 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
332 #define _CONTROL_CONN_STATE_MIN 1
333 /** State for a control connection: Authenticated and accepting v1 commands. */
334 #define CONTROL_CONN_STATE_OPEN 1
335 /** State for a control connection: Waiting for authentication; speaking
337 #define CONTROL_CONN_STATE_NEEDAUTH 2
338 #define _CONTROL_CONN_STATE_MAX 2
340 #define _DIR_PURPOSE_MIN 3
341 /** A connection to a directory server: download a rendezvous
343 #define DIR_PURPOSE_FETCH_RENDDESC 3
344 /** A connection to a directory server: set after a rendezvous
345 * descriptor is downloaded. */
346 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
347 /** A connection to a directory server: download one or more v2
348 * network-status objects */
349 #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
350 /** A connection to a directory server: download one or more server
352 #define DIR_PURPOSE_FETCH_SERVERDESC 6
353 /** A connection to a directory server: download one or more extra-info
355 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
356 /** A connection to a directory server: upload a server descriptor. */
357 #define DIR_PURPOSE_UPLOAD_DIR 8
358 /** A connection to a directory server: upload a rendezvous
360 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
361 /** A connection to a directory server: upload a v3 networkstatus vote. */
362 #define DIR_PURPOSE_UPLOAD_VOTE 10
363 /** A connection to a directory server: upload a v3 consensus signature */
364 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
365 /** A connection to a directory server: download one or more v3 networkstatus
367 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
368 /** A connection to a directory server: download a v3 detached signatures
369 * object for a consensus. */
370 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
371 /** A connection to a directory server: download a v3 networkstatus
373 #define DIR_PURPOSE_FETCH_CONSENSUS 14
374 /** A connection to a directory server: download one or more directory
375 * authority certificates. */
376 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
378 /** Purpose for connection at a directory server. */
379 #define DIR_PURPOSE_SERVER 16
380 /** A connection to a hidden service directory server: upload a v2 rendezvous
382 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
383 /** A connection to a hidden service directory server: download a v2 rendezvous
385 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
386 #define _DIR_PURPOSE_MAX 18
388 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
389 * directory server. */
390 #define DIR_PURPOSE_IS_UPLOAD(p) \
391 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
392 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
393 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
394 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
396 #define _EXIT_PURPOSE_MIN 1
397 /** This exit stream wants to do an ordinary connect. */
398 #define EXIT_PURPOSE_CONNECT 1
399 /** This exit stream wants to do a resolve (either normal or reverse). */
400 #define EXIT_PURPOSE_RESOLVE 2
401 #define _EXIT_PURPOSE_MAX 2
403 /* !!!! If any connection purpose is ever over 31, we must grow the type
404 * field in connection_t. */
406 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
407 #define CIRCUIT_STATE_BUILDING 0
408 /** Circuit state: Waiting to process the onionskin. */
409 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
410 /** Circuit state: I'd like to deliver a create, but my n_conn is still
412 #define CIRCUIT_STATE_OR_WAIT 2
413 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
414 #define CIRCUIT_STATE_OPEN 3
416 #define _CIRCUIT_PURPOSE_MIN 1
418 /* these circuits were initiated elsewhere */
419 #define _CIRCUIT_PURPOSE_OR_MIN 1
420 /** OR-side circuit purpose: normal circuit, at OR. */
421 #define CIRCUIT_PURPOSE_OR 1
422 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
423 #define CIRCUIT_PURPOSE_INTRO_POINT 2
424 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
425 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
426 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
427 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
428 #define _CIRCUIT_PURPOSE_OR_MAX 4
430 /* these circuits originate at this node */
432 /* here's how circ client-side purposes work:
433 * normal circuits are C_GENERAL.
434 * circuits that are c_introducing are either on their way to
435 * becoming open, or they are open and waiting for a
436 * suitable rendcirc before they send the intro.
437 * circuits that are c_introduce_ack_wait have sent the intro,
438 * but haven't gotten a response yet.
439 * circuits that are c_establish_rend are either on their way
440 * to becoming open, or they are open and have sent the
441 * establish_rendezvous cell but haven't received an ack.
442 * circuits that are c_rend_ready are open and have received a
443 * rend ack, but haven't heard from bob yet. if they have a
444 * buildstate->pending_final_cpath then they're expecting a
445 * cell from bob, else they're not.
446 * circuits that are c_rend_ready_intro_acked are open, and
447 * some intro circ has sent its intro and received an ack.
448 * circuits that are c_rend_joined are open, have heard from
449 * bob, and are talking to him.
451 /** Client-side circuit purpose: Normal circuit, with cpath. */
452 #define CIRCUIT_PURPOSE_C_GENERAL 5
453 /** Client-side circuit purpose: at Alice, connecting to intro point. */
454 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
455 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
456 * waiting for ACK/NAK. */
457 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
458 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
459 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
460 /** Client-side circuit purpose: at Alice, waiting for ack. */
461 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
462 /** Client-side circuit purpose: at Alice, waiting for Bob. */
463 #define CIRCUIT_PURPOSE_C_REND_READY 10
464 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
465 * has been acknowledged. */
466 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
467 /** Client-side circuit purpose: at Alice, rendezvous established. */
468 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
470 #define _CIRCUIT_PURPOSE_C_MAX 12
472 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
473 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
474 /** Hidden-service-side circuit purpose: at Bob, successfully established
476 #define CIRCUIT_PURPOSE_S_INTRO 14
477 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
478 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
479 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
480 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
481 /** A testing circuit; not meant to be used for actual traffic. */
482 #define CIRCUIT_PURPOSE_TESTING 17
483 /** A controller made this circuit and Tor should not use it. */
484 #define CIRCUIT_PURPOSE_CONTROLLER 18
485 #define _CIRCUIT_PURPOSE_MAX 18
486 /** A catch-all for unrecognized purposes. Currently we don't expect
487 * to make or see any circuits with this purpose. */
488 #define CIRCUIT_PURPOSE_UNKNOWN 255
490 /** True iff the circuit purpose <b>p</b> is for a circuit that
491 * originated at this node. */
492 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
493 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
494 * here to serve as a client. (Hidden services don't count here.) */
495 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
496 ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
497 (p)<=_CIRCUIT_PURPOSE_C_MAX)
498 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
499 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
500 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
502 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
503 ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
504 (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
506 /** How many circuits do we want simultaneously in-progress to handle
508 #define MIN_CIRCUITS_HANDLING_STREAM 2
510 /* These RELAY_COMMAND constants define values for relay cell commands, and
511 * must match those defined in tor-spec.txt. */
512 #define RELAY_COMMAND_BEGIN 1
513 #define RELAY_COMMAND_DATA 2
514 #define RELAY_COMMAND_END 3
515 #define RELAY_COMMAND_CONNECTED 4
516 #define RELAY_COMMAND_SENDME 5
517 #define RELAY_COMMAND_EXTEND 6
518 #define RELAY_COMMAND_EXTENDED 7
519 #define RELAY_COMMAND_TRUNCATE 8
520 #define RELAY_COMMAND_TRUNCATED 9
521 #define RELAY_COMMAND_DROP 10
522 #define RELAY_COMMAND_RESOLVE 11
523 #define RELAY_COMMAND_RESOLVED 12
524 #define RELAY_COMMAND_BEGIN_DIR 13
526 #define RELAY_COMMAND_ESTABLISH_INTRO 32
527 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
528 #define RELAY_COMMAND_INTRODUCE1 34
529 #define RELAY_COMMAND_INTRODUCE2 35
530 #define RELAY_COMMAND_RENDEZVOUS1 36
531 #define RELAY_COMMAND_RENDEZVOUS2 37
532 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
533 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
534 #define RELAY_COMMAND_INTRODUCE_ACK 40
536 /* Reasons why an OR connection is closed. */
537 #define END_OR_CONN_REASON_DONE 1
538 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
539 #define END_OR_CONN_REASON_OR_IDENTITY 3
540 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
541 #define END_OR_CONN_REASON_TIMEOUT 5
542 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
543 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
544 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
545 #define END_OR_CONN_REASON_MISC 9
547 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
548 * documentation of these. The values must match. */
549 #define END_STREAM_REASON_MISC 1
550 #define END_STREAM_REASON_RESOLVEFAILED 2
551 #define END_STREAM_REASON_CONNECTREFUSED 3
552 #define END_STREAM_REASON_EXITPOLICY 4
553 #define END_STREAM_REASON_DESTROY 5
554 #define END_STREAM_REASON_DONE 6
555 #define END_STREAM_REASON_TIMEOUT 7
556 /* 8 is unallocated for historical reasons. */
557 #define END_STREAM_REASON_HIBERNATING 9
558 #define END_STREAM_REASON_INTERNAL 10
559 #define END_STREAM_REASON_RESOURCELIMIT 11
560 #define END_STREAM_REASON_CONNRESET 12
561 #define END_STREAM_REASON_TORPROTOCOL 13
562 #define END_STREAM_REASON_NOTDIRECTORY 14
563 #define END_STREAM_REASON_ENTRYPOLICY 15
565 /* These high-numbered end reasons are not part of the official spec,
566 * and are not intended to be put in relay end cells. They are here
567 * to be more informative when sending back socks replies to the
569 /* XXXX 256 is no longer used; feel free to reuse it. */
570 /** We were unable to attach the connection to any circuit at all. */
571 /* XXXX the ways we use this one don't make a lot of sense. */
572 #define END_STREAM_REASON_CANT_ATTACH 257
573 /** We can't connect to any directories at all, so we killed our streams
574 * before they can time out. */
575 #define END_STREAM_REASON_NET_UNREACHABLE 258
576 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
577 * protocol in a way we couldn't handle. */
578 #define END_STREAM_REASON_SOCKSPROTOCOL 259
579 /** This is a transparent proxy connection, but we can't extract the original
580 * target address:port. */
581 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
582 /** This is a connection on the NATD port, and the destination IP:Port was
583 * either ill-formed or out-of-range. */
584 #define END_STREAM_REASON_INVALID_NATD_DEST 261
586 /** Bitwise-and this value with endreason to mask out all flags. */
587 #define END_STREAM_REASON_MASK 511
589 /** Bitwise-or this with the argument to control_event_stream_status
590 * to indicate that the reason came from an END cell. */
591 #define END_STREAM_REASON_FLAG_REMOTE 512
592 /** Bitwise-or this with the argument to control_event_stream_status
593 * to indicate that we already sent a CLOSED stream event. */
594 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
595 /** Bitwise-or this with endreason to indicate that we already sent
596 * a socks reply, and no further reply needs to be sent from
597 * connection_mark_unattached_ap(). */
598 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
600 /** Reason for remapping an AP connection's address: we have a cached
602 #define REMAP_STREAM_SOURCE_CACHE 1
603 /** Reason for remapping an AP connection's address: the exit node told us an
605 #define REMAP_STREAM_SOURCE_EXIT 2
607 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
608 #define RESOLVED_TYPE_HOSTNAME 0
609 #define RESOLVED_TYPE_IPV4 4
610 #define RESOLVED_TYPE_IPV6 6
611 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
612 #define RESOLVED_TYPE_ERROR 0xF1
614 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
615 * call; they only go to the controller for tracking */
616 /** We couldn't build a path for this circuit. */
617 #define END_CIRC_REASON_NOPATH -2
618 /** Catch-all "other" reason for closing origin circuits. */
619 #define END_CIRC_AT_ORIGIN -1
621 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
622 * documentation of these. */
623 #define _END_CIRC_REASON_MIN 0
624 #define END_CIRC_REASON_NONE 0
625 #define END_CIRC_REASON_TORPROTOCOL 1
626 #define END_CIRC_REASON_INTERNAL 2
627 #define END_CIRC_REASON_REQUESTED 3
628 #define END_CIRC_REASON_HIBERNATING 4
629 #define END_CIRC_REASON_RESOURCELIMIT 5
630 #define END_CIRC_REASON_CONNECTFAILED 6
631 #define END_CIRC_REASON_OR_IDENTITY 7
632 #define END_CIRC_REASON_OR_CONN_CLOSED 8
633 #define END_CIRC_REASON_FINISHED 9
634 #define END_CIRC_REASON_TIMEOUT 10
635 #define END_CIRC_REASON_DESTROYED 11
636 #define END_CIRC_REASON_NOSUCHSERVICE 12
637 #define _END_CIRC_REASON_MAX 12
639 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
640 * control_event_circuit_status() to indicate that the reason was
641 * passed through from a destroy or truncate cell. */
642 #define END_CIRC_REASON_FLAG_REMOTE 512
644 /** Length of 'y' portion of 'y.onion' URL. */
645 #define REND_SERVICE_ID_LEN_BASE32 16
647 /** Length of 'y.onion' including '.onion' URL. */
648 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
650 /** Length of a binary-encoded rendezvous service ID. */
651 #define REND_SERVICE_ID_LEN 10
653 /** Time period for which a v2 descriptor will be valid. */
654 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
656 /** Time period within which two sets of v2 descriptors will be uploaded in
658 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
660 /** Number of non-consecutive replicas (i.e. distributed somewhere
661 * in the ring) for a descriptor. */
662 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
664 /** Number of consecutive replicas for a descriptor. */
665 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
667 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
668 #define REND_DESC_ID_V2_LEN_BASE32 32
670 /** Length of the base32-encoded secret ID part of versioned hidden service
672 #define REND_SECRET_ID_PART_LEN_BASE32 32
674 /** Length of the base32-encoded hash of an introduction point's
676 #define REND_INTRO_POINT_ID_LEN_BASE32 32
678 /** Length of the descriptor cookie that is used for client authorization
679 * to hidden services. */
680 #define REND_DESC_COOKIE_LEN 16
682 /** Length of the base64-encoded descriptor cookie that is used for
683 * exchanging client authorization between hidden service and client. */
684 #define REND_DESC_COOKIE_LEN_BASE64 22
686 /** Length of client identifier in encrypted introduction points for hidden
687 * service authorization type 'basic'. */
688 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
690 /** Multiple of the number of clients to which the real number of clients
691 * is padded with fake clients for hidden service authorization type
693 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
695 /** Length of client entry consisting of client identifier and encrypted
696 * session key for hidden service authorization type 'basic'. */
697 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
700 /** Maximum size of v2 hidden service descriptors. */
701 #define REND_DESC_MAX_SIZE (20 * 1024)
703 /** Legal characters for use in authorized client names for a hidden
705 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
706 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
708 /** Maximum length of authorized client names for a hidden service. */
709 #define REND_CLIENTNAME_MAX_LEN 16
711 /** Length of the rendezvous cookie that is used to connect circuits at the
712 * rendezvous point. */
713 #define REND_COOKIE_LEN DIGEST_LEN
715 /** Client authorization type that a hidden service performs. */
716 typedef enum rend_auth_type_t
{
719 REND_STEALTH_AUTH
= 2,
722 /** Client-side configuration of authorization for a hidden service. */
723 typedef struct rend_service_authorization_t
{
724 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
725 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
726 rend_auth_type_t auth_type
;
727 } rend_service_authorization_t
;
729 /** Client- and server-side data that is used for hidden service connection
730 * establishment. Not all fields contain data depending on where this struct
732 typedef struct rend_data_t
{
733 /** Onion address (without the .onion part) that a client requests. */
734 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
736 /** (Optional) descriptor cookie that is used by a client. */
737 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
739 /** Authorization type for accessing a service used by a client. */
740 rend_auth_type_t auth_type
;
742 /** Hash of the hidden service's PK used by a service. */
743 char rend_pk_digest
[DIGEST_LEN
];
745 /** Rendezvous cookie used by both, client and service. */
746 char rend_cookie
[REND_COOKIE_LEN
];
749 /** Time interval for tracking possible replays of INTRODUCE2 cells.
750 * Incoming cells with timestamps half of this interval in the past or
751 * future are dropped immediately. */
752 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
754 /** Used to indicate which way a cell is going on a circuit. */
756 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
757 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
760 /** Initial value for both sides of a circuit transmission window when the
761 * circuit is initialized. Measured in cells. */
762 #define CIRCWINDOW_START 1000
763 /** Amount to increment a circuit window when we get a circuit SENDME. */
764 #define CIRCWINDOW_INCREMENT 100
765 /** Initial value on both sides of a stream transmission window when the
766 * stream is initialized. Measured in cells. */
767 #define STREAMWINDOW_START 500
768 /** Amount to increment a stream window when we get a stream SENDME. */
769 #define STREAMWINDOW_INCREMENT 50
771 /* Cell commands. These values are defined in tor-spec.txt. */
772 #define CELL_PADDING 0
773 #define CELL_CREATE 1
774 #define CELL_CREATED 2
776 #define CELL_DESTROY 4
777 #define CELL_CREATE_FAST 5
778 #define CELL_CREATED_FAST 6
779 #define CELL_VERSIONS 7
780 #define CELL_NETINFO 8
781 #define CELL_RELAY_EARLY 9
783 /** True iff the cell command <b>x</b> is one that implies a variable-length
785 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
787 /** How long to test reachability before complaining to the user. */
788 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
790 /** Legal characters in a nickname. */
791 #define LEGAL_NICKNAME_CHARACTERS \
792 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
794 /** Name to use in client TLS certificates if no nickname is given. Once
795 * Tor 0.1.2.x is obsolete, we can remove this. */
796 #define DEFAULT_CLIENT_NICKNAME "client"
798 /** Number of bytes in a SOCKS4 header. */
799 #define SOCKS4_NETWORK_LEN 8
803 * Relay command [1 byte]
804 * Recognized [2 bytes]
805 * Stream ID [2 bytes]
806 * Partial SHA-1 [4 bytes]
808 * Relay payload [498 bytes]
811 /** Number of bytes in a cell, minus cell header. */
812 #define CELL_PAYLOAD_SIZE 509
813 /** Number of bytes in a cell transmitted over the network. */
814 #define CELL_NETWORK_SIZE 512
816 /** Length of a header on a variable-length cell. */
817 #define VAR_CELL_HEADER_SIZE 5
819 /** Number of bytes in a relay cell's header (not including general cell
821 #define RELAY_HEADER_SIZE (1+2+2+4+2)
822 /** Largest number of bytes that can fit in a relay cell payload. */
823 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
825 /** Identifies a circuit on an or_connection */
826 typedef uint16_t circid_t
;
827 /** Identifies a stream on a circuit */
828 typedef uint16_t streamid_t
;
830 /** Parsed onion routing cell. All communication between nodes
832 typedef struct cell_t
{
833 circid_t circ_id
; /**< Circuit which received the cell. */
834 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
835 * CELL_DESTROY, etc */
836 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
839 /** Parsed variable-length onion routing cell. */
840 typedef struct var_cell_t
{
843 uint16_t payload_len
;
847 /** A cell as packed for writing to the network. */
848 typedef struct packed_cell_t
{
849 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
850 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
853 /** Number of cells added to a circuit queue including their insertion
854 * time on 10 millisecond detail; used for buffer statistics. */
855 typedef struct insertion_time_elem_t
{
856 struct insertion_time_elem_t
*next
; /**< Next element in queue. */
857 uint32_t insertion_time
; /**< When were cells inserted (in 10 ms steps
858 * starting at 0:00 of the current day)? */
859 unsigned counter
; /**< How many cells were inserted? */
860 } insertion_time_elem_t
;
862 /** Queue of insertion times. */
863 typedef struct insertion_time_queue_t
{
864 struct insertion_time_elem_t
*first
; /**< First element in queue. */
865 struct insertion_time_elem_t
*last
; /**< Last element in queue. */
866 } insertion_time_queue_t
;
868 /** A queue of cells on a circuit, waiting to be added to the
869 * or_connection_t's outbuf. */
870 typedef struct cell_queue_t
{
871 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
872 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
873 int n
; /**< The number of cells in the queue. */
874 insertion_time_queue_t
*insertion_times
; /**< Insertion times of cells. */
877 /** Beginning of a RELAY cell payload. */
879 uint8_t command
; /**< The end-to-end relay command. */
880 uint16_t recognized
; /**< Used to tell whether cell is for us. */
881 streamid_t stream_id
; /**< Which stream is this cell associated with? */
882 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
883 uint16_t length
; /**< How long is the payload body? */
886 typedef struct buf_t buf_t
;
887 typedef struct socks_request_t socks_request_t
;
889 /* Values for connection_t.magic: used to make sure that downcasts (casts from
890 * connection_t to foo_connection_t) are safe. */
891 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
892 #define OR_CONNECTION_MAGIC 0x7D31FF03u
893 #define EDGE_CONNECTION_MAGIC 0xF0374013u
894 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
895 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
897 /** Description of a connection to another host or process, and associated
900 * A connection is named based on what it's connected to -- an "OR
901 * connection" has a Tor node on the other end, an "exit
902 * connection" has a website or other server on the other end, and an
903 * "AP connection" has an application proxy (and thus a user) on the
906 * Every connection has a type and a state. Connections never change
907 * their type, but can go through many state changes in their lifetime.
909 * Every connection has two associated input and output buffers.
910 * Listeners don't use them. For non-listener connections, incoming
911 * data is appended to conn->inbuf, and outgoing data is taken from
912 * conn->outbuf. Connections differ primarily in the functions called
913 * to fill and drain these buffers.
915 typedef struct connection_t
{
916 uint32_t magic
; /**< For memory debugging: must equal one of
917 * *_CONNECTION_MAGIC. */
919 uint8_t state
; /**< Current state of this connection. */
920 unsigned int type
:4; /**< What kind of connection is this? */
921 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
923 /* The next fields are all one-bit booleans. Some are only applicable to
924 * connection subtypes, but we hold them here anyway, to save space.
926 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
927 * again once the bandwidth throttler allows it? */
928 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
929 * again once the bandwidth throttler allows
931 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
932 * marked for close, do we flush it
933 * before closing it? */
934 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
936 /** Set to 1 when we're inside connection_flushed_some to keep us from
937 * calling connection_handle_write() recursively. */
938 unsigned int in_flushed_some
:1;
940 /* For linked connections:
942 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
943 /** True iff we'd like to be notified about read events from the
945 unsigned int reading_from_linked_conn
:1;
946 /** True iff we're willing to write to the linked conn. */
947 unsigned int writing_to_linked_conn
:1;
948 /** True iff we're currently able to read on the linked conn, and our
949 * read_event should be made active with libevent. */
950 unsigned int active_on_link
:1;
951 /** True iff we've called connection_close_immediate() on this linked
953 unsigned int linked_conn_is_closed
:1;
955 /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
956 unsigned int proxy_state
:4;
958 /** Our socket; -1 if this connection is closed, or has no socket. */
960 int conn_array_index
; /**< Index into the global connection array. */
961 struct event
*read_event
; /**< Libevent event structure. */
962 struct event
*write_event
; /**< Libevent event structure. */
963 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
964 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
965 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
967 time_t timestamp_lastread
; /**< When was the last time libevent said we could
969 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
971 time_t timestamp_created
; /**< When was this connection_t created? */
973 /* XXXX_IP6 make this IPv6-capable */
974 int socket_family
; /**< Address family of this connection's socket. Usually
975 * AF_INET, but it can also be AF_UNIX, or in the future
977 tor_addr_t addr
; /**< IP of the other side of the connection; used to
978 * identify routers, along with port. */
979 uint16_t port
; /**< If non-zero, port on the other end
980 * of the connection. */
981 uint16_t marked_for_close
; /**< Should we close this conn on the next
982 * iteration of the main loop? (If true, holds
983 * the line number where this connection was
985 const char *marked_for_close_file
; /**< For debugging: in which file were
986 * we marked for close? */
987 char *address
; /**< FQDN (or IP) of the guy on the other end.
988 * strdup into this, because free_connection() frees it. */
989 /** Another connection that's connected to this one in lieu of a socket. */
990 struct connection_t
*linked_conn
;
992 /** Unique identifier for this connection on this Tor instance. */
993 uint64_t global_identifier
;
995 /* XXXX022 move this field, and all the listener-only fields (just
996 socket_family, I think), into a new listener_connection_t subtype. */
997 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
998 * to the evdns_server_port is uses to listen to and answer connections. */
999 struct evdns_server_port
*dns_server_port
;
1001 /** Unique ID for measuring tunneled network status requests. */
1005 /** Stores flags and information related to the portion of a v2 Tor OR
1006 * connection handshake that happens after the TLS handshake is finished.
1008 typedef struct or_handshake_state_t
{
1009 /** When was the VERSIONS cell sent on this connection? Used to get
1010 * an estimate of the skew in the returning NETINFO reply. */
1011 time_t sent_versions_at
;
1012 /** True iff we originated this connection */
1013 unsigned int started_here
: 1;
1014 /** True iff we have received and processed a VERSIONS cell. */
1015 unsigned int received_versions
: 1;
1016 } or_handshake_state_t
;
1018 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
1019 * cells over TLS. */
1020 typedef struct or_connection_t
{
1023 /** Hash of the public RSA key for the other side's identity key, or zeroes
1024 * if the other side hasn't shown us a valid identity key. */
1025 char identity_digest
[DIGEST_LEN
];
1026 char *nickname
; /**< Nickname of OR on other side (if any). */
1028 tor_tls_t
*tls
; /**< TLS connection state. */
1029 int tls_error
; /**< Last tor_tls error code. */
1030 /** When we last used this conn for any client traffic. If not
1031 * recent, we can rate limit it further. */
1034 tor_addr_t real_addr
; /**< The actual address that this connection came from
1035 * or went to. The <b>addr</b> field is prone to
1036 * getting overridden by the address from the router
1037 * descriptor matching <b>identity_digest</b>. */
1039 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1040 * connection, which half of the space should
1042 /** Should this connection be used for extending circuits to the server
1043 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1044 * sure we aren't getting MITMed, either because we're connected to an
1045 * address listed in a server descriptor, or because an authenticated
1046 * NETINFO cell listed the address we're connected to as recognized. */
1047 unsigned int is_canonical
:1;
1048 /** True iff this connection shouldn't get any new circs attached to it,
1049 * because the connection is too old, or because there's a better one, etc.
1051 unsigned int is_bad_for_new_circs
:1;
1052 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1053 * "none negotiated yet." */
1054 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1055 * this connection? This is always in the
1056 * range 0..1<<15-1. */
1058 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1059 * up, state information to do so. */
1060 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1061 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1062 * non-padding cell to the outbuf? */
1064 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
1065 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1066 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1067 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1068 * add 'bandwidthrate' to this, capping it at
1069 * bandwidthburst. (OPEN ORs only) */
1070 int n_circuits
; /**< How many circuits use this connection as p_conn or
1073 /** Double-linked ring of circuits with queued cells waiting for room to
1074 * free up on this connection's outbuf. Every time we pull cells from a
1075 * circuit, we advance this pointer to the next circuit in the ring. */
1076 struct circuit_t
*active_circuits
;
1077 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1078 * identity digest as this one. */
1081 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1082 * connection, or an exit. */
1083 typedef struct edge_connection_t
{
1086 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1088 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1089 * this conn exits at. */
1090 int package_window
; /**< How many more relay cells can I send into the
1092 int deliver_window
; /**< How many more relay cells can end at me? */
1094 /** Nickname of planned exit node -- used with .exit support. */
1095 char *chosen_exit_name
;
1097 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1099 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1100 * connection is using. */
1102 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1103 * connection. Exit connections only. */
1105 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1108 /** The reason why this connection is closing; passed to the controller. */
1109 uint16_t end_reason
;
1111 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1114 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1117 /** What rendezvous service are we querying for? (AP only) */
1118 rend_data_t
*rend_data
;
1120 /** Number of times we've reassigned this application connection to
1121 * a new circuit. We keep track because the timeout is longer if we've
1122 * already retried several times. */
1123 uint8_t num_socks_retries
;
1125 /** True iff this connection is for a DNS request only. */
1126 unsigned int is_dns_request
:1;
1128 /** True iff this stream must attach to a one-hop circuit (e.g. for
1130 unsigned int want_onehop
:1;
1131 /** True iff this stream should use a BEGIN_DIR relay command to establish
1132 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1133 unsigned int use_begindir
:1;
1135 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1136 * connections. Set once we've set the stream end,
1137 * and check in connection_about_to_close_connection().
1139 /** True iff we've blocked reading until the circuit has fewer queued
1141 unsigned int edge_blocked_on_circ
:1;
1142 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1143 * stop requiring it. */
1144 unsigned int chosen_exit_optional
:1;
1145 /** For AP connections only. If non-zero, this exit node was picked as
1146 * a result of the TrackHostExit, and the value decrements every time
1147 * we fail to complete a circuit to our chosen exit -- if it reaches
1148 * zero, abandon the associated mapaddress. */
1149 unsigned int chosen_exit_retries
:3;
1151 /** If this is a DNSPort connection, this field holds the pending DNS
1152 * request that we're going to try to answer. */
1153 struct evdns_server_request
*dns_server_request
;
1155 } edge_connection_t
;
1157 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1158 * connection to retrieve or serve directory material. */
1159 typedef struct dir_connection_t
{
1162 char *requested_resource
; /**< Which 'resource' did we ask the directory
1164 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1166 /* Used only for server sides of some dir connections, to implement
1167 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1168 * to append everything to the outbuf in one enormous chunk. */
1169 /** What exactly are we spooling right now? */
1171 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1172 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1173 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
1174 } dir_spool_src
: 3;
1175 /** If we're fetching descriptors, what router purpose shall we assign
1177 uint8_t router_purpose
;
1178 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1179 smartlist_t
*fingerprint_stack
;
1180 /** A cached_dir_t object that we're currently spooling out */
1181 struct cached_dir_t
*cached_dir
;
1182 /** The current offset into cached_dir. */
1183 off_t cached_dir_offset
;
1184 /** The zlib object doing on-the-fly compression for spooled data. */
1185 tor_zlib_state_t
*zlib_state
;
1187 /** What rendezvous service are we querying for? */
1188 rend_data_t
*rend_data
;
1190 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1191 * the directory server's signing key. */
1195 /** Subtype of connection_t for an connection to a controller. */
1196 typedef struct control_connection_t
{
1199 uint32_t event_mask
; /**< Bitfield: which events does this controller
1202 /** True if we have sent a protocolinfo reply on this connection. */
1203 unsigned int have_sent_protocolinfo
:1;
1205 /** Amount of space allocated in incoming_cmd. */
1206 uint32_t incoming_cmd_len
;
1207 /** Number of bytes currently stored in incoming_cmd. */
1208 uint32_t incoming_cmd_cur_len
;
1209 /** A control command that we're reading from the inbuf, but which has not
1210 * yet arrived completely. */
1212 } control_connection_t
;
1214 /** Cast a connection_t subtype pointer to a connection_t **/
1215 #define TO_CONN(c) (&(((c)->_base)))
1216 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1217 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1219 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1221 static or_connection_t
*TO_OR_CONN(connection_t
*);
1222 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1224 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1225 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1227 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1228 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1230 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1232 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1234 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1235 return DOWNCAST(or_connection_t
, c
);
1237 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1239 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1240 return DOWNCAST(dir_connection_t
, c
);
1242 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1244 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1245 return DOWNCAST(edge_connection_t
, c
);
1247 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1249 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1250 return DOWNCAST(control_connection_t
, c
);
1253 /** What action type does an address policy indicate: accept or reject? */
1255 ADDR_POLICY_ACCEPT
=1,
1256 ADDR_POLICY_REJECT
=2,
1257 } addr_policy_action_t
;
1259 /** A reference-counted address policy rule. */
1260 typedef struct addr_policy_t
{
1261 int refcnt
; /**< Reference count */
1262 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1263 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1265 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1266 * copy (stored in a hash table to avoid
1267 * duplication of common policies) */
1268 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1269 * first <b>maskbits</b> bits of <b>a</b> match
1271 tor_addr_t addr
; /**< Base address to accept or reject. */
1272 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1273 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1276 /** A cached_dir_t represents a cacheable directory object, along with its
1277 * compressed form. */
1278 typedef struct cached_dir_t
{
1279 char *dir
; /**< Contents of this object, NUL-terminated. */
1280 char *dir_z
; /**< Compressed contents of this object. */
1281 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1282 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1283 time_t published
; /**< When was this object published. */
1284 int refcnt
; /**< Reference count for this cached_dir_t. */
1287 /** Enum used to remember where a signed_descriptor_t is stored and how to
1288 * manage the memory for signed_descriptor_body. */
1290 /** The descriptor isn't stored on disk at all: the copy in memory is
1291 * canonical; the saved_offset field is meaningless. */
1293 /** The descriptor is stored in the cached_routers file: the
1294 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1295 * saved_offset are used to index into the mmaped cache file. */
1297 /** The descriptor is stored in the cached_routers.new file: the
1298 * signed_descriptor_body and saved_offset fields are both set. */
1299 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1300 * lazy-load the descriptor text by using seek and read. We don't, for
1306 /** Enumeration: what kind of download schedule are we using for a given
1309 DL_SCHED_GENERIC
= 0,
1310 DL_SCHED_CONSENSUS
= 1,
1311 DL_SCHED_BRIDGE
= 2,
1312 } download_schedule_t
;
1314 /** Information about our plans for retrying downloads for a downloadable
1316 typedef struct download_status_t
{
1317 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1319 uint8_t n_download_failures
; /**< Number of failures trying to download the
1320 * most recent descriptor. */
1321 download_schedule_t schedule
: 8;
1322 } download_status_t
;
1324 /** If n_download_failures is this high, the download can never happen. */
1325 #define IMPOSSIBLE_TO_DOWNLOAD 255
1327 /** The max size we expect router descriptor annotations we create to
1328 * be. We'll accept larger ones if we see them on disk, but we won't
1329 * create any that are larger than this. */
1330 #define ROUTER_ANNOTATION_BUF_LEN 256
1332 /** Information need to cache an onion router's descriptor. */
1333 typedef struct signed_descriptor_t
{
1334 /** Pointer to the raw server descriptor, preceded by annotations. Not
1335 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1336 * pointer is null. */
1337 char *signed_descriptor_body
;
1338 /** Length of the annotations preceding the server descriptor. */
1339 size_t annotations_len
;
1340 /** Length of the server descriptor. */
1341 size_t signed_descriptor_len
;
1342 /** Digest of the server descriptor, computed as specified in
1344 char signed_descriptor_digest
[DIGEST_LEN
];
1345 /** Identity digest of the router. */
1346 char identity_digest
[DIGEST_LEN
];
1347 /** Declared publication time of the descriptor. */
1348 time_t published_on
;
1349 /** For routerdescs only: digest of the corresponding extrainfo. */
1350 char extra_info_digest
[DIGEST_LEN
];
1351 /** For routerdescs only: Status of downloading the corresponding
1353 download_status_t ei_dl_status
;
1354 /** Where is the descriptor saved? */
1355 saved_location_t saved_location
;
1356 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1357 * this descriptor in the corresponding file. */
1359 /** What position is this descriptor within routerlist->routers or
1360 * routerlist->old_routers? -1 for none. */
1361 int routerlist_index
;
1362 /** The valid-until time of the most recent consensus that listed this
1363 * descriptor, or a bit after the publication time of the most recent v2
1364 * networkstatus that listed it. 0 for "never listed in a consensus or
1365 * status, so far as we know." */
1366 time_t last_listed_as_valid_until
;
1367 #ifdef TRACK_SERVED_TIME
1368 /** The last time we served anybody this descriptor. Used for internal
1369 * testing to see whether we're holding on to descriptors too long. */
1370 time_t last_served_at
; /*XXXX remove if not useful. */
1372 /* If true, we do not ever try to save this object in the cache. */
1373 unsigned int do_not_cache
: 1;
1374 /* If true, this item is meant to represent an extrainfo. */
1375 unsigned int is_extrainfo
: 1;
1376 /* If true, we got an extrainfo for this item, and the digest was right,
1377 * but it was incompatible. */
1378 unsigned int extrainfo_is_bogus
: 1;
1379 /* If true, we are willing to transmit this item unencrypted. */
1380 unsigned int send_unencrypted
: 1;
1381 } signed_descriptor_t
;
1383 /** A signed integer representing a country code. */
1384 typedef int16_t country_t
;
1386 /** Information about another onion router in the network. */
1388 signed_descriptor_t cache_info
;
1389 char *address
; /**< Location of OR: either a hostname or an IP address. */
1390 char *nickname
; /**< Human-readable OR name. */
1392 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1393 uint16_t or_port
; /**< Port for TLS connections. */
1394 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1396 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1397 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1399 char *platform
; /**< What software/operating system is this OR using? */
1402 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1403 * bucket per second? */
1404 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1405 /** How many bytes/s is this router known to handle? */
1406 uint32_t bandwidthcapacity
;
1407 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1408 * to exit? NULL for 'reject *:*'. */
1409 long uptime
; /**< How many seconds the router claims to have been up */
1410 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1411 * claims are its family. */
1412 char *contact_info
; /**< Declared contact info for this router. */
1413 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1415 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1416 * dnsworker code. */
1417 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1418 * extrainfo documents. */
1419 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1420 * single hop exits. */
1423 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1425 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1426 * (For Authdir: Have we validated this OR?)
1428 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1430 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1431 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1432 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1433 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1434 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1435 * or otherwise nasty? */
1436 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1437 * underpowered, or otherwise useless? */
1438 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1439 * a hidden service directory. */
1440 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1441 * directory according to the authorities. */
1442 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1443 * router rejects everything. */
1445 /** Tor can use this router for general positions in circuits. */
1446 #define ROUTER_PURPOSE_GENERAL 0
1447 /** Tor should avoid using this router for circuit-building. */
1448 #define ROUTER_PURPOSE_CONTROLLER 1
1449 /** Tor should use this router only for bridge positions in circuits. */
1450 #define ROUTER_PURPOSE_BRIDGE 2
1451 /** Tor should not use this router; it was marked in cached-descriptors with
1452 * a purpose we didn't recognize. */
1453 #define ROUTER_PURPOSE_UNKNOWN 255
1455 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1457 /* The below items are used only by authdirservers for
1458 * reachability testing. */
1459 /** When was the last time we could reach this OR? */
1460 time_t last_reachable
;
1461 /** When did we start testing reachability for this OR? */
1462 time_t testing_since
;
1463 /** According to the geoip db what country is this router in? */
1467 /** Information needed to keep and cache a signed extra-info document. */
1468 typedef struct extrainfo_t
{
1469 signed_descriptor_t cache_info
;
1470 /** The router's nickname. */
1471 char nickname
[MAX_NICKNAME_LEN
+1];
1472 /** True iff we found the right key for this extra-info, verified the
1473 * signature, and found it to be bad. */
1474 unsigned int bad_sig
: 1;
1475 /** If present, we didn't have the right key to verify this extra-info,
1476 * so this is a copy of the signature in the document. */
1478 /** Length of pending_sig. */
1479 size_t pending_sig_len
;
1482 /** Contents of a single router entry in a network status object.
1484 typedef struct routerstatus_t
{
1485 time_t published_on
; /**< When was this router published? */
1486 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1488 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1490 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1492 uint32_t addr
; /**< IPv4 address for this router. */
1493 uint16_t or_port
; /**< OR port for this router. */
1494 uint16_t dir_port
; /**< Directory port for this router. */
1495 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1496 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1497 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1498 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1499 unsigned int is_running
:1; /**< True iff this router is up. */
1500 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1501 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1503 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1504 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1505 * information with v2 of the directory
1506 * protocol. (All directory caches cache v1
1508 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1509 * choice as an entry guard. */
1510 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1512 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1513 * underpowered, or otherwise useless? */
1514 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1515 * service directory. */
1516 /** True iff we know version info for this router. (i.e., a "v" entry was
1517 * included.) We'll replace all these with a big tor_version_t or a char[]
1518 * if the number of traits we care about ever becomes incredibly big. */
1519 unsigned int version_known
:1;
1520 /** True iff this router is a version that supports BEGIN_DIR cells. */
1521 unsigned int version_supports_begindir
:1;
1522 /** True iff this router is a version that supports conditional consensus
1523 * downloads (signed by list of authorities). */
1524 unsigned int version_supports_conditional_consensus
:1;
1525 /** True iff this router is a version that we can post extrainfo docs to. */
1526 unsigned int version_supports_extrainfo_upload
:1;
1527 /** True iff this router is a version that, if it caches directory info,
1528 * we can get v3 downloads from. */
1529 unsigned int version_supports_v3_dir
:1;
1531 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1532 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1533 unsigned int has_measured_bw
:1; /**< The vote/consensus had a measured bw */
1535 uint32_t measured_bw
; /**< Measured bandwidth (capacity) of the router */
1537 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1538 * the vote/consensus, in kilobytes/sec. */
1539 char *exitsummary
; /**< exit policy summary -
1540 * XXX weasel: this probably should not stay a string. */
1542 /* ---- The fields below aren't derived from the networkstatus; they
1543 * hold local information only. */
1545 /** True if we, as a directory mirror, want to download the corresponding
1546 * routerinfo from the authority who gave us this routerstatus. (That is,
1547 * if we don't have the routerinfo, and if we haven't already tried to get it
1548 * from this authority.) Applies in v2 networkstatus document only.
1550 unsigned int need_to_mirror
:1;
1551 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1552 * to this (unnamed) router by nickname?
1554 time_t last_dir_503_at
; /**< When did this router last tell us that it
1555 * was too busy to serve directory info? */
1556 download_status_t dl_status
;
1560 /** How many times will we try to download a router's descriptor before giving
1562 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1564 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1565 typedef struct networkstatus_v2_t
{
1566 /** When did we receive the network-status document? */
1569 /** What was the digest of the document? */
1570 char networkstatus_digest
[DIGEST_LEN
];
1572 /* These fields come from the actual network-status document.*/
1573 time_t published_on
; /**< Declared publication date. */
1575 char *source_address
; /**< Canonical directory server hostname. */
1576 uint32_t source_addr
; /**< Canonical directory server IP. */
1577 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1579 unsigned int binds_names
:1; /**< True iff this directory server binds
1581 unsigned int recommends_versions
:1; /**< True iff this directory server
1582 * recommends client and server software
1584 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1585 * malfunctioning exits as bad. */
1586 /** True iff this directory server marks malfunctioning directories as
1588 unsigned int lists_bad_directories
:1;
1590 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1591 char *contact
; /**< How to contact directory admin? (may be NULL). */
1592 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1593 char *client_versions
; /**< comma-separated list of recommended client
1595 char *server_versions
; /**< comma-separated list of recommended server
1598 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1599 * sorted by identity_digest. */
1600 } networkstatus_v2_t
;
1602 /** The claim about a single router, made in a vote. */
1603 typedef struct vote_routerstatus_t
{
1604 routerstatus_t status
; /**< Underlying 'status' object for this router.
1605 * Flags are redundant. */
1606 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1607 * networkstatus_t.known_flags. */
1608 char *version
; /**< The version that the authority says this router is
1610 } vote_routerstatus_t
;
1612 /** Information about a single voter in a vote or a consensus. */
1613 typedef struct networkstatus_voter_info_t
{
1614 char *nickname
; /**< Nickname of this voter */
1615 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1616 char *address
; /**< Address of this voter, in string format. */
1617 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1618 uint16_t dir_port
; /**< Directory port of this voter */
1619 uint16_t or_port
; /**< OR port of this voter */
1620 char *contact
; /**< Contact information for this voter. */
1621 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1622 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
1623 * consensuses, we treat legacy keys as additional signers. */
1624 char legacy_id_digest
[DIGEST_LEN
];
1626 /* Nothing from here on is signed. */
1627 char signing_key_digest
[DIGEST_LEN
]; /**< Declared digest of signing key
1628 * used by this voter. */
1629 char *signature
; /**< Signature from this voter. */
1630 int signature_len
; /**< Length of <b>signature</b> */
1631 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1632 * the sig, and we know it's bad. */
1633 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1635 } networkstatus_voter_info_t
;
1637 /** Enumerates the possible seriousness values of a networkstatus document. */
1642 } networkstatus_type_t
;
1644 /** A common structure to hold a v3 network status vote, or a v3 network
1645 * status consensus. */
1646 typedef struct networkstatus_t
{
1647 networkstatus_type_t type
; /**< Vote, consensus, or opinion? */
1648 time_t published
; /**< Vote only: Time when vote was written. */
1649 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1650 time_t fresh_until
; /**< Time before which this is the most recent vote or
1652 time_t valid_until
; /**< Time after which this vote or consensus should not
1655 /** Consensus only: what method was used to produce this consensus? */
1656 int consensus_method
;
1657 /** Vote only: what methods is this voter willing to use? */
1658 smartlist_t
*supported_methods
;
1660 /** How long does this vote/consensus claim that authorities take to
1661 * distribute their votes to one another? */
1663 /** How long does this vote/consensus claim that authorities take to
1664 * distribute their consensus signatures to one another? */
1667 /** Comma-separated list of recommended client software, or NULL if this
1668 * voter has no opinion. */
1669 char *client_versions
;
1670 char *server_versions
;
1671 /** List of flags that this vote/consensus applies to routers. If a flag is
1672 * not listed here, the voter has no opinion on what its value should be. */
1673 smartlist_t
*known_flags
;
1675 /** List of key=value strings for the parameters in this vote or
1676 * consensus, sorted by key. */
1677 smartlist_t
*net_params
;
1679 /** List of networkstatus_voter_info_t. For a vote, only one element
1680 * is included. For a consensus, one element is included for every voter
1681 * whose vote contributed to the consensus. */
1682 smartlist_t
*voters
;
1684 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1686 /** Digest of this document, as signed. */
1687 char networkstatus_digest
[DIGEST_LEN
];
1689 /** List of router statuses, sorted by identity digest. For a vote,
1690 * the elements are vote_routerstatus_t; for a consensus, the elements
1691 * are routerstatus_t. */
1692 smartlist_t
*routerstatus_list
;
1694 /** If present, a map from descriptor digest to elements of
1695 * routerstatus_list. */
1696 digestmap_t
*desc_digest_map
;
1699 /** A set of signatures for a networkstatus consensus. All fields are as for
1700 * networkstatus_t. */
1701 typedef struct ns_detached_signatures_t
{
1705 char networkstatus_digest
[DIGEST_LEN
];
1706 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1707 } ns_detached_signatures_t
;
1709 /** Allowable types of desc_store_t. */
1710 typedef enum store_type_t
{
1715 /** A 'store' is a set of descriptors saved on disk, with accompanying
1716 * journal, mmaped as needed, rebuilt as needed. */
1717 typedef struct desc_store_t
{
1718 /** Filename (within DataDir) for the store. We append .tmp to this
1719 * filename for a temporary file when rebuilding the store, and .new to this
1720 * filename for the journal. */
1721 const char *fname_base
;
1722 /** Alternative (obsolete) value for fname_base: if the file named by
1723 * fname_base isn't present, we read from here instead, but we never write
1725 const char *fname_alt_base
;
1726 /** Human-readable description of what this store contains. */
1727 const char *description
;
1729 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1731 store_type_t type
; /**< What's stored in this store? */
1733 /** The size of the router log, in bytes. */
1735 /** The size of the router store, in bytes. */
1737 /** Total bytes dropped since last rebuild: this is space currently
1738 * used in the cache and the journal that could be freed by a rebuild. */
1739 size_t bytes_dropped
;
1742 /** Contents of a directory of onion routers. */
1744 /** Map from server identity digest to a member of routers. */
1745 struct digest_ri_map_t
*identity_map
;
1746 /** Map from server descriptor digest to a signed_descriptor_t from
1747 * routers or old_routers. */
1748 struct digest_sd_map_t
*desc_digest_map
;
1749 /** Map from extra-info digest to an extrainfo_t. Only exists for
1750 * routers in routers or old_routers. */
1751 struct digest_ei_map_t
*extra_info_map
;
1752 /** Map from extra-info digests to a signed_descriptor_t for a router
1753 * descriptor having that extra-info digest. Only exists for
1754 * routers in routers or old_routers. */
1755 struct digest_sd_map_t
*desc_by_eid_map
;
1756 /** List of routerinfo_t for all currently live routers we know. */
1757 smartlist_t
*routers
;
1758 /** List of signed_descriptor_t for older router descriptors we're
1760 smartlist_t
*old_routers
;
1761 /** Store holding server descriptors. If present, any router whose
1762 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1763 * starting at cache_info.saved_offset */
1764 desc_store_t desc_store
;
1765 /** Store holding extra-info documents. */
1766 desc_store_t extrainfo_store
;
1769 /** Information on router used when extending a circuit. We don't need a
1770 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1771 * connection, and onion_key to create the onionskin. Note that for onehop
1772 * general-purpose tunnels, the onion_key is NULL. */
1773 typedef struct extend_info_t
{
1774 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1776 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1777 uint16_t port
; /**< OR port. */
1778 tor_addr_t addr
; /**< IP address. */
1779 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1782 /** Certificate for v3 directory protocol: binds long-term authority identity
1783 * keys to medium-term authority signing keys. */
1784 typedef struct authority_cert_t
{
1785 /** Information relating to caching this cert on disk and looking it up. */
1786 signed_descriptor_t cache_info
;
1787 /** This authority's long-term authority identity key. */
1788 crypto_pk_env_t
*identity_key
;
1789 /** This authority's medium-term signing key. */
1790 crypto_pk_env_t
*signing_key
;
1791 /** The digest of <b>signing_key</b> */
1792 char signing_key_digest
[DIGEST_LEN
];
1793 /** The listed expiration time of this certificate. */
1795 /** This authority's IPv4 address, in host order. */
1797 /** This authority's directory port. */
1799 /** True iff this certificate was cross-certified by signing the identity
1800 * key with the signing key. */
1801 uint8_t is_cross_certified
;
1804 /** Bitfield enum type listing types of directory authority/directory
1808 /** Serves/signs v1 directory information: Big lists of routers, and short
1809 * routerstatus documents. */
1810 V1_AUTHORITY
= 1 << 0,
1811 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
1812 V2_AUTHORITY
= 1 << 1,
1813 /** Serves/signs v3 directory information: votes, consensuses, certs */
1814 V3_AUTHORITY
= 1 << 2,
1815 /** Serves hidden service descriptors. */
1816 HIDSERV_AUTHORITY
= 1 << 3,
1817 /** Serves bridge descriptors. */
1818 BRIDGE_AUTHORITY
= 1 << 4,
1819 /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
1820 EXTRAINFO_CACHE
= 1 << 5,
1823 #define CRYPT_PATH_MAGIC 0x70127012u
1825 /** Holds accounting information for a single step in the layered encryption
1826 * performed by a circuit. Used only at the client edge of a circuit. */
1827 typedef struct crypt_path_t
{
1830 /* crypto environments */
1831 /** Encryption key and counter for cells heading towards the OR at this
1833 crypto_cipher_env_t
*f_crypto
;
1834 /** Encryption key and counter for cells heading back from the OR at this
1836 crypto_cipher_env_t
*b_crypto
;
1838 /** Digest state for cells heading towards the OR at this step. */
1839 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1840 /** Digest state for cells heading away from the OR at this step. */
1841 crypto_digest_env_t
*b_digest
;
1843 /** Current state of Diffie-Hellman key negotiation with the OR at this
1845 crypto_dh_env_t
*dh_handshake_state
;
1846 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1847 * step. Used to save CPU when TLS is already providing all the
1848 * authentication, secrecy, and integrity we need, and we're already
1849 * distinguishable from an OR.
1851 char fast_handshake_state
[DIGEST_LEN
];
1852 /** Negotiated key material shared with the OR at this step. */
1853 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1855 /** Information to extend to the OR at this step. */
1856 extend_info_t
*extend_info
;
1858 /** Is the circuit built to this step? Must be one of:
1859 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1860 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1861 * and not received an EXTENDED/CREATED)
1862 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1864 #define CPATH_STATE_CLOSED 0
1865 #define CPATH_STATE_AWAITING_KEYS 1
1866 #define CPATH_STATE_OPEN 2
1867 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1868 * (The list is circular, so the last node
1869 * links to the first.) */
1870 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1873 int package_window
; /**< How many cells are we allowed to originate ending
1875 int deliver_window
; /**< How many cells are we willing to deliver originating
1879 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1881 #define DH_KEY_LEN DH_BYTES
1882 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1885 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1887 /** Information used to build a circuit. */
1889 /** Intended length of the final circuit. */
1890 int desired_path_len
;
1891 /** How to extend to the planned exit node. */
1892 extend_info_t
*chosen_exit
;
1893 /** Whether every node in the circ must have adequate uptime. */
1895 /** Whether every node in the circ must have adequate capacity. */
1897 /** Whether the last hop was picked with exiting in mind. */
1899 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1900 * These are for encrypted connections that exit to this router, not
1901 * for arbitrary exits from the circuit. */
1903 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1904 crypt_path_t
*pending_final_cpath
;
1905 /** How many times has building a circuit for this task failed? */
1907 /** At what time should we give up on this task? */
1909 } cpath_build_state_t
;
1911 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1912 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1915 * A circuit is a path over the onion routing
1916 * network. Applications can connect to one end of the circuit, and can
1917 * create exit connections at the other end of the circuit. AP and exit
1918 * connections have only one circuit associated with them (and thus these
1919 * connection types are closed when the circuit is closed), whereas
1920 * OR connections multiplex many circuits at once, and stay standing even
1921 * when there are no circuits running over them.
1923 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1924 * links two connections together: either an edge connection and an OR
1925 * connection, or two OR connections. (When joined to an OR connection, a
1926 * circuit_t affects only cells sent to a particular circID on that
1927 * connection. When joined to an edge connection, a circuit_t affects all
1930 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1931 * along a given circuit. At the OP, it has a sequence of ciphers, each
1932 * of which is shared with a single OR along the circuit. Separate
1933 * ciphers are used for data going "forward" (away from the OP) and
1934 * "backward" (towards the OP). At the OR, a circuit has only two stream
1935 * ciphers: one for data going forward, and one for data going backward.
1937 typedef struct circuit_t
{
1938 uint32_t magic
; /**< For memory and type debugging: must equal
1939 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1941 /** Queue of cells waiting to be transmitted on n_conn. */
1942 cell_queue_t n_conn_cells
;
1943 /** The OR connection that is next in this circuit. */
1944 or_connection_t
*n_conn
;
1945 /** The circuit_id used in the next (forward) hop of this circuit. */
1948 /** The hop to which we want to extend this circuit. Should be NULL if
1949 * the circuit has attached to a connection. */
1950 extend_info_t
*n_hop
;
1952 /** True iff we are waiting for n_conn_cells to become less full before
1953 * allowing p_streams to add any more cells. (Origin circuit only.) */
1954 unsigned int streams_blocked_on_n_conn
: 1;
1955 /** True iff we are waiting for p_conn_cells to become less full before
1956 * allowing n_streams to add any more cells. (OR circuit only.) */
1957 unsigned int streams_blocked_on_p_conn
: 1;
1959 uint8_t state
; /**< Current status of this circuit. */
1960 uint8_t purpose
; /**< Why are we creating this circuit? */
1962 /** How many relay data cells can we package (read from edge streams)
1963 * on this circuit before we receive a circuit-level sendme cell asking
1966 /** How many relay data cells will we deliver (write to edge streams)
1967 * on this circuit? When deliver_window gets low, we send some
1968 * circuit-level sendme cells to indicate that we're willing to accept
1972 /** For storage while n_conn is pending
1973 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1974 * length ONIONSKIN_CHALLENGE_LEN. */
1975 char *n_conn_onionskin
;
1977 time_t timestamp_created
; /**< When was this circuit created? */
1978 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1979 * circuit is clean. */
1980 struct timeval highres_created
; /**< When exactly was the circuit created? */
1982 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1983 * the main loop? (If true, holds the line number
1984 * where this circuit was marked.) */
1985 const char *marked_for_close_file
; /**< For debugging: in which file was this
1986 * circuit marked for close? */
1988 /** Next circuit in the doubly-linked ring of circuits waiting to add
1989 * cells to n_conn. NULL if we have no cells pending, or if we're not
1990 * linked to an OR connection. */
1991 struct circuit_t
*next_active_on_n_conn
;
1992 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1993 * cells to n_conn. NULL if we have no cells pending, or if we're not
1994 * linked to an OR connection. */
1995 struct circuit_t
*prev_active_on_n_conn
;
1996 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1998 /** Unique ID for measuring tunneled network status requests. */
2002 /** Largest number of relay_early cells that we can send on a given
2004 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
2006 /** An origin_circuit_t holds data necessary to build and use a circuit.
2008 typedef struct origin_circuit_t
{
2011 /** Linked list of AP streams (or EXIT streams if hidden service)
2012 * associated with this circuit. */
2013 edge_connection_t
*p_streams
;
2014 /** Build state for this circuit. It includes the intended path
2015 * length, the chosen exit router, rendezvous information, etc.
2017 cpath_build_state_t
*build_state
;
2018 /** The doubly-linked list of crypt_path_t entries, one per hop,
2019 * for this circuit. This includes ciphers for each hop,
2020 * integrity-checking digests for each hop, and package/delivery
2021 * windows for each hop.
2023 crypt_path_t
*cpath
;
2025 /** Holds all rendezvous data on either client or service side. */
2026 rend_data_t
*rend_data
;
2028 /** How many more relay_early cells can we send on this circuit, according
2029 * to the specification? */
2030 unsigned int remaining_relay_early_cells
: 4;
2032 /** What commands were sent over this circuit that decremented the
2033 * RELAY_EARLY counter? This is for debugging task 878. */
2034 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
2036 /** How many RELAY_EARLY cells have been sent over this circuit? This is
2037 * for debugging task 878, too. */
2038 int relay_early_cells_sent
;
2040 /** The next stream_id that will be tried when we're attempting to
2041 * construct a new AP stream originating at this circuit. */
2042 streamid_t next_stream_id
;
2044 /* The intro key replaces the hidden service's public key if purpose is
2045 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2046 * descriptor is used. */
2047 crypto_pk_env_t
*intro_key
;
2049 /** Quasi-global identifier for this circuit; used for control.c */
2050 /* XXXX NM This can get re-used after 2**32 circuits. */
2051 uint32_t global_identifier
;
2055 /** An or_circuit_t holds information needed to implement a circuit at an
2057 typedef struct or_circuit_t
{
2060 /** Next circuit in the doubly-linked ring of circuits waiting to add
2061 * cells to p_conn. NULL if we have no cells pending, or if we're not
2062 * linked to an OR connection. */
2063 struct circuit_t
*next_active_on_p_conn
;
2064 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2065 * cells to p_conn. NULL if we have no cells pending, or if we're not
2066 * linked to an OR connection. */
2067 struct circuit_t
*prev_active_on_p_conn
;
2069 /** The circuit_id used in the previous (backward) hop of this circuit. */
2071 /** Queue of cells waiting to be transmitted on p_conn. */
2072 cell_queue_t p_conn_cells
;
2073 /** The OR connection that is previous in this circuit. */
2074 or_connection_t
*p_conn
;
2075 /** Linked list of Exit streams associated with this circuit. */
2076 edge_connection_t
*n_streams
;
2077 /** Linked list of Exit streams associated with this circuit that are
2078 * still being resolved. */
2079 edge_connection_t
*resolving_streams
;
2080 /** The cipher used by intermediate hops for cells heading toward the
2082 crypto_cipher_env_t
*p_crypto
;
2083 /** The cipher used by intermediate hops for cells heading away from
2085 crypto_cipher_env_t
*n_crypto
;
2087 /** The integrity-checking digest used by intermediate hops, for
2088 * cells packaged here and heading towards the OP.
2090 crypto_digest_env_t
*p_digest
;
2091 /** The integrity-checking digest used by intermediate hops, for
2092 * cells packaged at the OP and arriving here.
2094 crypto_digest_env_t
*n_digest
;
2096 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2097 * is not marked for close. */
2098 struct or_circuit_t
*rend_splice
;
2100 #if REND_COOKIE_LEN >= DIGEST_LEN
2101 #define REND_TOKEN_LEN REND_COOKIE_LEN
2103 #define REND_TOKEN_LEN DIGEST_LEN
2106 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2107 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2109 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2111 char rend_token
[REND_TOKEN_LEN
];
2113 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2114 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2116 /** How many more relay_early cells can we send on this circuit, according
2117 * to the specification? */
2118 unsigned int remaining_relay_early_cells
: 4;
2120 /** True iff this circuit was made with a CREATE_FAST cell. */
2121 unsigned int is_first_hop
: 1;
2123 /** Number of cells that were removed from circuit queue; reset every
2124 * time when writing buffer stats to disk. */
2125 uint32_t processed_cells
;
2127 /** Total time in milliseconds that cells spent in both app-ward and
2128 * exit-ward queues of this circuit; reset every time when writing
2129 * buffer stats to disk. */
2130 uint64_t total_cell_waiting_time
;
2133 /** Convert a circuit subtype to a circuit_t.*/
2134 #define TO_CIRCUIT(x) (&((x)->_base))
2136 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2137 * if the cast is impossible. */
2138 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2139 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2140 * Asserts if the cast is impossible. */
2141 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2143 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2145 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2146 return DOWNCAST(or_circuit_t
, x
);
2148 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2150 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2151 return DOWNCAST(origin_circuit_t
, x
);
2154 /** Bitfield type: things that we're willing to use invalid routers for. */
2155 typedef enum invalid_router_usage_t
{
2156 ALLOW_INVALID_ENTRY
=1,
2157 ALLOW_INVALID_EXIT
=2,
2158 ALLOW_INVALID_MIDDLE
=4,
2159 ALLOW_INVALID_RENDEZVOUS
=8,
2160 ALLOW_INVALID_INTRODUCTION
=16,
2161 } invalid_router_usage_t
;
2163 /* limits for TCP send and recv buffer size used for constrained sockets */
2164 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2165 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2167 /** A linked list of lines in a config file. */
2168 typedef struct config_line_t
{
2171 struct config_line_t
*next
;
2174 typedef struct routerset_t routerset_t
;
2176 /** Configuration options for a Tor process. */
2180 /** What should the tor process actually do? */
2182 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2183 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2185 const char *command_arg
; /**< Argument for command-line option. */
2187 config_line_t
*Logs
; /**< New-style list of configuration lines
2190 char *DebugLogFile
; /**< Where to send verbose log messages. */
2191 char *DataDirectory
; /**< OR only: where to store long-term data. */
2192 char *Nickname
; /**< OR only: nickname of this onion router. */
2193 char *Address
; /**< OR only: configured address for this onion router. */
2194 char *PidFile
; /**< Where to store PID of Tor process. */
2196 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2197 * country codes and IP address patterns of ORs to
2198 * consider as exits. */
2199 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2200 * country codes and IP address patterns of ORs to
2201 * consider as entry points. */
2202 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2203 * stop building circuits? */
2204 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2205 * stop building circuits? */
2206 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2207 * country codes and IP address patterns of ORs
2208 * not to use in circuits. */
2209 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2210 * country codes and IP address patterns of
2211 * ORs not to consider as exits. */
2213 /** Union of ExcludeNodes and ExcludeExitNodes */
2214 struct routerset_t
*_ExcludeExitNodesUnion
;
2216 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2217 smartlist_t
*AllowInvalidNodes
;
2218 /** Bitmask; derived from AllowInvalidNodes. */
2219 invalid_router_usage_t _AllowInvalid
;
2220 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2221 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2222 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2223 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2224 /** Addresses to bind for listening for SOCKS connections. */
2225 config_line_t
*SocksListenAddress
;
2226 /** Addresses to bind for listening for transparent pf/netfilter
2228 config_line_t
*TransListenAddress
;
2229 /** Addresses to bind for listening for transparent natd connections */
2230 config_line_t
*NatdListenAddress
;
2231 /** Addresses to bind for listening for SOCKS connections. */
2232 config_line_t
*DNSListenAddress
;
2233 /** Addresses to bind for listening for OR connections. */
2234 config_line_t
*ORListenAddress
;
2235 /** Addresses to bind for listening for directory connections. */
2236 config_line_t
*DirListenAddress
;
2237 /** Addresses to bind for listening for control connections. */
2238 config_line_t
*ControlListenAddress
;
2239 /** Local address to bind outbound sockets */
2240 char *OutboundBindAddress
;
2241 /** Directory server only: which versions of
2242 * Tor should we tell users to run? */
2243 config_line_t
*RecommendedVersions
;
2244 config_line_t
*RecommendedClientVersions
;
2245 config_line_t
*RecommendedServerVersions
;
2246 /** Whether dirservers refuse router descriptors with private IPs. */
2247 int DirAllowPrivateAddresses
;
2248 char *User
; /**< Name of user to run Tor as. */
2249 char *Group
; /**< Name of group to run Tor as. */
2250 int ORPort
; /**< Port to listen on for OR connections. */
2251 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2252 /** Port to listen on for transparent pf/netfilter connections. */
2254 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2255 int ControlPort
; /**< Port to listen on for control connections. */
2256 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2257 * for control connections. */
2258 int DirPort
; /**< Port to listen on for directory connections. */
2259 int DNSPort
; /**< Port to listen on for DNS requests. */
2260 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2261 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2262 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2263 * for version 1 directories? */
2264 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2265 * for version 2 directories? */
2266 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2267 * for version 3 directories? */
2268 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2269 * handle hidden service requests? */
2270 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
2271 * directory record statistics? */
2272 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2273 * that's willing to bind names? */
2274 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2275 * directory that's willing to recommend
2277 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2278 * that aggregates bridge descriptors? */
2280 /** If set on a bridge authority, it will answer requests on its dirport
2281 * for bridge statuses -- but only if the requests use this password.
2282 * If set on a bridge user, request bridge statuses, and use this password
2284 char *BridgePassword
;
2286 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2287 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2289 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2290 * this explicit so we can change how we behave in the
2293 /** Boolean: if we know the bridge's digest, should we get new
2294 * descriptors from the bridge authorities or from the bridge itself? */
2295 int UpdateBridgesFromAuthority
;
2297 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2299 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2300 /** Boolean: should we never publish a descriptor? Deprecated. */
2302 /** To what authority types do we publish our descriptor? Choices are
2303 * "v1", "v2", "v3", "bridge", or "". */
2304 smartlist_t
*PublishServerDescriptor
;
2305 /** An authority type, derived from PublishServerDescriptor. */
2306 authority_type_t _PublishServerDescriptor
;
2307 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2308 int PublishHidServDescriptors
;
2309 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2310 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2311 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2313 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2314 * service directories after what time? */
2315 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2316 int AllDirActionsPrivate
; /**< Should every directory action be sent
2317 * through a Tor circuit? */
2319 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2320 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2321 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2322 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2323 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2325 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2326 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2327 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2329 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2330 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2332 /** Application ports that require all nodes in circ to have sufficient
2334 smartlist_t
*LongLivedPorts
;
2335 /** Application ports that are likely to be unencrypted and
2336 * unauthenticated; we reject requests for them to prevent the
2337 * user from screwing up and leaking plaintext secrets to an
2338 * observer somewhere on the Internet. */
2339 smartlist_t
*RejectPlaintextPorts
;
2340 /** Related to RejectPlaintextPorts above, except this config option
2341 * controls whether we warn (in the log and via a controller status
2342 * event) every time a risky connection is attempted. */
2343 smartlist_t
*WarnPlaintextPorts
;
2344 /** Should we try to reuse the same exit node for a given host */
2345 smartlist_t
*TrackHostExits
;
2346 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2348 config_line_t
*AddressMap
; /**< List of address map directives. */
2349 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2350 * hostname ending with one of the suffixes in
2351 * <b>AutomapHostsSuffixes</b>, map it to a
2352 * virtual address. */
2353 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2354 * <b>AutomapHostsOnResolve</b>. */
2355 int RendPostPeriod
; /**< How often do we post each rendezvous service
2356 * descriptor? Remember to publish them independently. */
2357 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2358 * connections alive? */
2359 int SocksTimeout
; /**< How long do we let a socks connection wait
2360 * unattached before we fail it? */
2361 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2362 * at least this many seconds ago. */
2363 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2364 * at least this many seconds ago. */
2365 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2366 * to wait simultaneously before we start dropping
2368 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2370 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2371 this interval ago. */
2372 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2373 * to use in a second? */
2374 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2375 * to use in a second? */
2376 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2377 * tell people we have? */
2378 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2379 * willing to use for all relayed conns? */
2380 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2381 * use in a second for all relayed conns? */
2382 int NumCpus
; /**< How many CPUs should we try to use? */
2383 int RunTesting
; /**< If true, create testing circuits to measure how well the
2384 * other ORs are running. */
2385 config_line_t
*RendConfigLines
; /**< List of configuration lines
2386 * for rendezvous services. */
2387 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2388 * authorizations for hidden services */
2389 char *ContactInfo
; /**< Contact info to be published in the directory. */
2391 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2392 tor_addr_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2393 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2394 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2396 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2397 tor_addr_t HttpsProxyAddr
; /**< Parsed addr for https proxy, if any. */
2398 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2399 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2401 char *Socks4Proxy
; /**< hostname:port to use as a SOCKS4 proxy, if any. */
2402 tor_addr_t Socks4ProxyAddr
; /**< Derived from Socks4Proxy. */
2403 uint16_t Socks4ProxyPort
; /**< Derived from Socks4Proxy. */
2405 char *Socks5Proxy
; /**< hostname:port to use as a SOCKS5 proxy, if any. */
2406 tor_addr_t Socks5ProxyAddr
; /**< Derived from Sock5Proxy. */
2407 uint16_t Socks5ProxyPort
; /**< Derived from Socks5Proxy. */
2408 char *Socks5ProxyUsername
; /**< Username for SOCKS5 authentication, if any */
2409 char *Socks5ProxyPassword
; /**< Password for SOCKS5 authentication, if any */
2411 /** List of configuration lines for replacement directory authorities.
2412 * If you just want to replace one class of authority at a time,
2413 * use the "Alternate*Authority" options below instead. */
2414 config_line_t
*DirServers
;
2416 /** If set, use these main (currently v3) directory authorities and
2417 * not the default ones. */
2418 config_line_t
*AlternateDirAuthority
;
2420 /** If set, use these bridge authorities and not the default one. */
2421 config_line_t
*AlternateBridgeAuthority
;
2423 /** If set, use these HS authorities and not the default ones. */
2424 config_line_t
*AlternateHSAuthority
;
2426 char *MyFamily
; /**< Declared family for this OR. */
2427 config_line_t
*NodeFamilies
; /**< List of config lines for
2429 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2430 * mark as bad dir mirrors. */
2431 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2432 * mark as bad exits. */
2433 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2435 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2436 * never mark as valid. */
2437 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2438 * and vote for all other dir mirrors as good. */
2439 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2440 * and vote for all other exits as good. */
2441 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2442 * aren't named in our fingerprint file? */
2443 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2444 * number of servers per IP address. */
2445 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2446 * number of servers per IP address shared
2447 * with an authority. */
2449 char *AccountingStart
; /**< How long is the accounting interval, and when
2451 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2452 * interval before hibernation? 0 for "never
2455 /** Base64-encoded hash of accepted passwords for the control system. */
2456 config_line_t
*HashedControlPassword
;
2457 /** As HashedControlPassword, but not saved. */
2458 config_line_t
*HashedControlSessionPassword
;
2460 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2461 * the control system? */
2462 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2463 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2464 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2465 * circuits itself (0), or does it expect a controller
2467 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2468 * make circuits in the background (0),
2470 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2471 * long do we wait before exiting? */
2472 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2473 * such as addresses (0), or do we scrub them first (1)? */
2474 int SafeSocks
; /**< Boolean: should we outright refuse application
2475 * connections that use socks4 or socks5-with-local-dns? */
2476 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2477 LOG_WARN : LOG_INFO)
2478 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2479 * protocol, is it a warn or an info in our logs? */
2480 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2481 * log whether it was DNS-leaking or not? */
2482 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2483 * acceleration where available? */
2484 char *AccelName
; /**< Optional hardware acceleration engine name. */
2485 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
2486 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2487 * of fixed nodes? */
2488 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2489 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2490 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2491 * of our PK time by sending CREATE_FAST cells? */
2492 /** Should we always fetch our dir info on the mirror schedule (which
2493 * means directly from the authorities) no matter our other config? */
2494 int FetchDirInfoEarly
;
2496 /** Should we fetch our dir info at the start of the consensus period? */
2497 int FetchDirInfoExtraEarly
;
2499 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2500 * MAPADDRESS requests. */
2501 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2502 * addresses to be FQDNs, but rather search for them in
2503 * the local domains. */
2504 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2506 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2507 * DNS poisoning attacks. */
2508 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2509 * resolver from the file here rather than from
2510 * /etc/resolv.conf (Unix) or the registry (Windows). */
2511 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2512 disclaimer. This allows a server administrator to show
2513 that they're running Tor and anyone visiting their server
2514 will know this without any specialized knowledge. */
2515 /** Boolean: if set, we start even if our resolv.conf file is missing
2517 int ServerDNSAllowBrokenConfig
;
2519 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2520 * should be resolvable. Used for
2521 * testing our DNS server. */
2522 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2523 * same network zone in the same circuit. */
2524 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2526 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2527 * support BEGIN_DIR, when possible. */
2528 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2529 * with weird characters. */
2530 /** If true, we try resolving hostnames with weird characters. */
2531 int ServerDNSAllowNonRFC953Hostnames
;
2533 /** If true, we try to download extra-info documents (and we serve them,
2534 * if we are a cache). For authorities, this is always true. */
2535 int DownloadExtraInfo
;
2537 /** If true, and we are acting as a relay, allow exit circuits even when
2538 * we are the first hop of a circuit. */
2539 int AllowSingleHopExits
;
2540 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2541 * circuits that we build. */
2542 int ExcludeSingleHopRelays
;
2543 /** If true, and the controller tells us to use a one-hop circuit, and the
2544 * exit allows it, we use it. */
2545 int AllowSingleHopCircuits
;
2547 /** If true, we convert "www.google.com.foo.exit" addresses on the
2548 * socks/trans/natd ports into "www.google.com" addresses that
2549 * exit from the node "foo". Disabled by default since attacking
2550 * websites and exit relays can use it to manipulate your path
2554 /** If true, the user wants us to collect statistics on clients
2555 * requesting network statuses from us as directory. */
2556 int DirReqStatistics
;
2558 /** If true, the user wants us to collect statistics on port usage. */
2559 int ExitPortStatistics
;
2561 /** If true, the user wants us to collect cell statistics. */
2564 /** If true, the user wants us to collect statistics as entry node. */
2565 int EntryStatistics
;
2567 /** If true, include statistics file contents in extra-info documents. */
2568 int ExtraInfoStatistics
;
2570 /** If true, do not believe anybody who tells us that a domain resolves
2571 * to an internal address, or that an internal address has a PTR mapping.
2572 * Helps avoid some cross-site attacks. */
2573 int ClientDNSRejectInternalAddresses
;
2575 /** The length of time that we think a consensus should be fresh. */
2576 int V3AuthVotingInterval
;
2577 /** The length of time we think it will take to distribute votes. */
2578 int V3AuthVoteDelay
;
2579 /** The length of time we think it will take to distribute signatures. */
2580 int V3AuthDistDelay
;
2581 /** The number of intervals we think a consensus should be valid. */
2582 int V3AuthNIntervalsValid
;
2584 /** Should advertise and sign consensuses with a legacy key, for key
2585 * migration purposes? */
2586 int V3AuthUseLegacyKey
;
2588 /** Location of bandwidth measurement file */
2589 char *V3BandwidthsFile
;
2591 /** Authority only: key=value pairs that we add to our networkstatus
2592 * consensus vote on the 'params' line. */
2593 char *ConsensusParams
;
2595 /** The length of time that we think an initial consensus should be fresh.
2596 * Only altered on testing networks. */
2597 int TestingV3AuthInitialVotingInterval
;
2599 /** The length of time we think it will take to distribute initial votes.
2600 * Only altered on testing networks. */
2601 int TestingV3AuthInitialVoteDelay
;
2603 /** The length of time we think it will take to distribute initial
2604 * signatures. Only altered on testing networks.*/
2605 int TestingV3AuthInitialDistDelay
;
2607 /** If an authority has been around for less than this amount of time, it
2608 * does not believe its reachability information is accurate. Only
2609 * altered on testing networks. */
2610 int TestingAuthDirTimeToLearnReachability
;
2612 /** Clients don't download any descriptor this recent, since it will
2613 * probably not have propagated to enough caches. Only altered on testing
2615 int TestingEstimatedDescriptorPropagationTime
;
2617 /** If true, we take part in a testing network. Change the defaults of a
2618 * couple of other configuration options and allow to change the values
2619 * of certain configuration options. */
2620 int TestingTorNetwork
;
2622 /** File to check for a consensus networkstatus, if we don't have one
2624 char *FallbackNetworkstatusFile
;
2626 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2627 * count of how many client addresses have contacted us so that we can help
2628 * the bridge authority guess which countries have blocked access to us. */
2629 int BridgeRecordUsageByCountry
;
2632 /** If true, and Tor is built with DIRREQ_STATS support, and we're a
2633 * directory, record how many directory requests we get from each country. */
2634 int DirRecordUsageByCountry
;
2635 /** Round all GeoIP results to the next multiple of this value, to avoid
2636 * leaking information. */
2637 int DirRecordUsageGranularity
;
2638 /** Time interval: purge geoip stats after this long. */
2639 int DirRecordUsageRetainIPs
;
2640 /** Time interval: Flush geoip data to disk this often. */
2641 int DirRecordUsageSaveInterval
;
2644 /** Optionally, a file with GeoIP data. */
2647 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2648 * to make this false. */
2649 int ReloadTorrcOnSIGHUP
;
2653 /** Persistent state for an onion router, as saved to disk. */
2656 /** The time at which we next plan to write the state to the disk. Equal to
2657 * TIME_MAX if there are no savable changes, 0 if there are changes that
2658 * should be saved right away. */
2661 /** When was the state last written to disk? */
2664 /** Fields for accounting bandwidth use. */
2665 time_t AccountingIntervalStart
;
2666 uint64_t AccountingBytesReadInInterval
;
2667 uint64_t AccountingBytesWrittenInInterval
;
2668 int AccountingSecondsActive
;
2669 uint64_t AccountingExpectedUsage
;
2671 /** A list of Entry Guard-related configuration lines. */
2672 config_line_t
*EntryGuards
;
2674 /** These fields hold information on the history of bandwidth usage for
2675 * servers. The "Ends" fields hold the time when we last updated the
2676 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2677 * of the entries of Values. The "Values" lists hold decimal string
2678 * representations of the number of bytes read or written in each
2680 time_t BWHistoryReadEnds
;
2681 int BWHistoryReadInterval
;
2682 smartlist_t
*BWHistoryReadValues
;
2683 time_t BWHistoryWriteEnds
;
2684 int BWHistoryWriteInterval
;
2685 smartlist_t
*BWHistoryWriteValues
;
2687 /** Build time histogram */
2688 config_line_t
* BuildtimeHistogram
;
2689 uint16_t TotalBuildTimes
;
2691 /** What version of Tor wrote this state file? */
2694 /** Holds any unrecognized values we found in the state file, in the order
2695 * in which we found them. */
2696 config_line_t
*ExtraLines
;
2698 /** When did we last rotate our onion key? "0" for 'no idea'. */
2699 time_t LastRotatedOnionKey
;
2702 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2703 * state is already scheduled to be written to disk earlier than <b>when</b>.
2705 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2707 if (state
->next_write
> when
)
2708 state
->next_write
= when
;
2711 #define MAX_SOCKS_REPLY_LEN 1024
2712 #define MAX_SOCKS_ADDR_LEN 256
2714 /** Please open a TCP connection to this addr:port. */
2715 #define SOCKS_COMMAND_CONNECT 0x01
2716 /** Please turn this FQDN into an IP address, privately. */
2717 #define SOCKS_COMMAND_RESOLVE 0xF0
2718 /** Please turn this IP address into an FQDN, privately. */
2719 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2721 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2722 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2723 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2725 /** State of a SOCKS request from a user to an OP. Also used to encode other
2726 * information for non-socks user request (such as those on TransPort and
2728 struct socks_request_t
{
2729 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2730 * 0 means that no socks handshake ever took place, and this is just a
2731 * stub connection (e.g. see connection_ap_make_link()). */
2733 int command
; /**< What is this stream's goal? One from the above list. */
2734 size_t replylen
; /**< Length of <b>reply</b>. */
2735 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2736 * we want to specify our own socks reply,
2737 * rather than using the default socks4 or
2738 * socks5 socks reply. We use this for the
2739 * two-stage socks5 handshake.
2741 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2742 connect to/resolve? */
2743 uint16_t port
; /**< What port did the client ask to connect to? */
2744 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2745 * make sure we send back a socks reply for
2746 * every connection. */
2749 /* all the function prototypes go here */
2751 /********************************* buffers.c ***************************/
2753 buf_t
*buf_new(void);
2754 buf_t
*buf_new_with_capacity(size_t size
);
2755 void buf_free(buf_t
*buf
);
2756 void buf_clear(buf_t
*buf
);
2757 void buf_shrink(buf_t
*buf
);
2758 void buf_shrink_freelists(int free_all
);
2759 void buf_dump_freelist_sizes(int severity
);
2761 size_t buf_datalen(const buf_t
*buf
);
2762 size_t buf_allocation(const buf_t
*buf
);
2763 size_t buf_slack(const buf_t
*buf
);
2764 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2766 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2768 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2770 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2771 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2773 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2774 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2775 const char *data
, size_t data_len
, int done
);
2776 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2777 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2778 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2779 int fetch_from_buf_http(buf_t
*buf
,
2780 char **headers_out
, size_t max_headerlen
,
2781 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2782 int force_complete
);
2783 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2784 int log_sockstype
, int safe_socks
);
2785 int fetch_from_buf_socks_client(buf_t
*buf
, int state
, char **reason
);
2786 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2788 int peek_buf_has_control0_command(buf_t
*buf
);
2790 void assert_buf_ok(buf_t
*buf
);
2792 #ifdef BUFFERS_PRIVATE
2793 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2796 /********************************* circuitbuild.c **********************/
2798 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2799 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2800 void circuit_log_path(int severity
, unsigned int domain
,
2801 origin_circuit_t
*circ
);
2802 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2803 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2804 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2805 extend_info_t
*exit
,
2807 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2808 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2809 int inform_testing_reachability(void);
2810 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2811 void circuit_note_clock_jumped(int seconds_elapsed
);
2812 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2813 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2815 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2817 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2818 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2819 const char *payload
, const char *keys
);
2820 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2821 int *need_capacity
);
2823 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2824 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2825 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2826 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2827 crypto_pk_env_t
*onion_key
,
2828 const tor_addr_t
*addr
, uint16_t port
);
2829 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2830 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2831 void extend_info_free(extend_info_t
*info
);
2832 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2833 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2835 void entry_guards_compute_status(void);
2836 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2837 int mark_relay_status
, time_t now
);
2838 void entry_nodes_should_be_added(void);
2839 int entry_list_can_grow(or_options_t
*options
);
2840 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2841 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2842 void entry_guards_update_state(or_state_t
*state
);
2843 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2844 const char *question
, char **answer
);
2846 void clear_bridge_list(void);
2847 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2848 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
2850 void retry_bridge_descriptor_fetch_directly(const char *digest
);
2851 void fetch_bridge_descriptors(time_t now
);
2852 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2853 int any_bridge_descriptors_known(void);
2854 int any_pending_bridge_descriptor_fetches(void);
2855 int bridges_known_but_down(void);
2856 void bridges_retry_all(void);
2858 void entry_guards_free_all(void);
2860 /* Circuit Build Timeout "public" functions and structures. */
2862 /** Maximum quantile to use to generate synthetic timeouts.
2863 * We want to stay a bit short of 1.0, because longtail is
2864 * loooooooooooooooooooooooooooooooooooooooooooooooooooong. */
2865 #define MAX_SYNTHETIC_QUANTILE 0.985
2867 /** Minimum circuits before estimating a timeout */
2868 #define MIN_CIRCUITS_TO_OBSERVE 500
2870 /** Total size of the circuit timeout history to accumulate.
2871 * 5000 is approx 1.5 weeks worth of continual-use circuits. */
2872 #define NCIRCUITS_TO_OBSERVE 5000
2874 /** Width of the histogram bins in milliseconds */
2875 #define BUILDTIME_BIN_WIDTH ((build_time_t)50)
2877 /** Cutoff point on the CDF for our timeout estimation.
2878 * TODO: This should be moved to the consensus */
2879 #define BUILDTIMEOUT_QUANTILE_CUTOFF 0.8
2881 /** A build_time_t is milliseconds */
2882 typedef uint32_t build_time_t
;
2883 #define BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
2885 /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
2886 #define BUILD_TIMEOUT_MIN_VALUE (3*1000)
2888 /** Initial circuit build timeout in milliseconds */
2889 #define BUILD_TIMEOUT_INITIAL_VALUE (60*1000)
2891 /** How often in seconds should we build a test circuit */
2892 #define BUILD_TIMES_TEST_FREQUENCY 60
2894 /** Save state every 10 circuits */
2895 #define BUILD_TIMES_SAVE_STATE_EVERY 10
2897 /* Circuit Build Timeout network liveness constants */
2900 * How many circuits count as recent when considering if the
2901 * connection has gone gimpy or changed.
2903 #define RECENT_CIRCUITS 20
2906 * Have we received a cell in the last N circ attempts?
2908 * This tells us when to temporarily switch back to
2909 * BUILD_TIMEOUT_INITIAL_VALUE until we start getting cells,
2910 * at which point we switch back to computing the timeout from
2911 * our saved history.
2913 #define NETWORK_NONLIVE_TIMEOUT_COUNT (lround(RECENT_CIRCUITS*0.15))
2916 * This tells us when to toss out the last streak of N timeouts.
2918 * If instead we start getting cells, we switch back to computing the timeout
2919 * from our saved history.
2921 #define NETWORK_NONLIVE_DISCARD_COUNT (lround(NETWORK_NONLIVE_TIMEOUT_COUNT*2))
2924 * Maximum count of timeouts that finish the first hop in the past
2925 * RECENT_CIRCUITS before calculating a new timeout.
2927 * This tells us to abandon timeout history and set
2928 * the timeout back to BUILD_TIMEOUT_INITIAL_VALUE.
2930 #define MAX_RECENT_TIMEOUT_COUNT (lround(RECENT_CIRCUITS*0.75))
2932 /** Information about the state of our local network connection */
2934 /** The timestamp we last completed a TLS handshake or received a cell */
2935 time_t network_last_live
;
2936 /** If the network is not live, how many timeouts has this caused? */
2937 int nonlive_timeouts
;
2938 /** If the network is not live, have we yet discarded our history? */
2939 int nonlive_discarded
;
2940 /** Circular array of circuits that have made it to the first hop. Slot is
2941 * 1 if circuit timed out, 0 if circuit succeeded */
2942 int8_t timeouts_after_firsthop
[RECENT_CIRCUITS
];
2943 /** Index into circular array. */
2944 int after_firsthop_idx
;
2945 } network_liveness_t
;
2947 /** Structure for circuit build times history */
2949 /** The circular array of recorded build times in milliseconds */
2950 build_time_t circuit_build_times
[NCIRCUITS_TO_OBSERVE
];
2951 /** Current index in the circuit_build_times circular array */
2952 int build_times_idx
;
2953 /** Total number of build times accumulated. Maxes at NCIRCUITS_TO_OBSERVE */
2954 int total_build_times
;
2955 /** Information about the state of our local network connection */
2956 network_liveness_t liveness
;
2957 /** Last time we built a circuit. Used to decide to build new test circs */
2958 time_t last_circ_at
;
2959 /** Number of timeouts that have happened before estimating pareto
2962 /** "Minimum" value of our pareto distribution (actually mode) */
2964 /** alpha exponent for pareto dist. */
2966 /** Have we computed a timeout? */
2967 int have_computed_timeout
;
2968 /** The exact value for that timeout in milliseconds */
2970 } circuit_build_times_t
;
2972 extern circuit_build_times_t circ_times
;
2973 void circuit_build_times_update_state(circuit_build_times_t
*cbt
,
2975 int circuit_build_times_parse_state(circuit_build_times_t
*cbt
,
2976 or_state_t
*state
, char **msg
);
2977 int circuit_build_times_add_timeout(circuit_build_times_t
*cbt
,
2978 int did_onehop
, time_t start_time
);
2979 void circuit_build_times_set_timeout(circuit_build_times_t
*cbt
);
2980 int circuit_build_times_add_time(circuit_build_times_t
*cbt
,
2982 int circuit_build_times_needs_circuits(circuit_build_times_t
*cbt
);
2983 int circuit_build_times_needs_circuits_now(circuit_build_times_t
*cbt
);
2984 void circuit_build_times_init(circuit_build_times_t
*cbt
);
2986 #ifdef CIRCUIT_PRIVATE
2987 double circuit_build_times_calculate_timeout(circuit_build_times_t
*cbt
,
2989 build_time_t
circuit_build_times_generate_sample(circuit_build_times_t
*cbt
,
2990 double q_lo
, double q_hi
);
2991 void circuit_build_times_initial_alpha(circuit_build_times_t
*cbt
,
2992 double quantile
, double time_ms
);
2993 void circuit_build_times_update_alpha(circuit_build_times_t
*cbt
);
2994 double circuit_build_times_cdf(circuit_build_times_t
*cbt
, double x
);
2995 void circuit_build_times_add_timeout_worker(circuit_build_times_t
*cbt
,
2996 double quantile_cutoff
);
2997 void circuitbuild_running_unit_tests(void);
2998 void circuit_build_times_reset(circuit_build_times_t
*cbt
);
3000 /* Network liveness functions */
3001 int circuit_build_times_network_check_changed(circuit_build_times_t
*cbt
);
3004 /* Network liveness functions */
3005 void circuit_build_times_network_is_live(circuit_build_times_t
*cbt
);
3006 int circuit_build_times_network_check_live(circuit_build_times_t
*cbt
);
3007 void circuit_build_times_network_circ_success(circuit_build_times_t
*cbt
);
3009 /********************************* circuitlist.c ***********************/
3011 circuit_t
* _circuit_get_global_list(void);
3012 const char *circuit_state_to_string(int state
);
3013 const char *circuit_purpose_to_controller_string(uint8_t purpose
);
3014 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
3015 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
3016 or_connection_t
*conn
);
3017 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
3018 or_connection_t
*conn
);
3019 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
3020 void circuit_close_all_marked(void);
3021 int32_t circuit_initial_package_window(void);
3022 origin_circuit_t
*origin_circuit_new(void);
3023 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
3024 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
3025 or_connection_t
*conn
);
3026 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
3027 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
3028 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
3029 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
3030 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
3032 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
3033 const char *digest
, uint8_t purpose
);
3034 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
3035 or_circuit_t
*circuit_get_intro_point(const char *digest
);
3036 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
3037 extend_info_t
*info
, int flags
);
3038 void circuit_mark_all_unused_circs(void);
3039 void circuit_expire_all_dirty_circs(void);
3040 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
3041 int line
, const char *file
);
3042 int circuit_get_cpath_len(origin_circuit_t
*circ
);
3043 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
3044 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
3045 or_connection_t
*or_conn
);
3046 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
3048 #define circuit_mark_for_close(c, reason) \
3049 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
3051 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
3052 void assert_circuit_ok(const circuit_t
*c
);
3053 void circuit_free_all(void);
3055 /********************************* circuituse.c ************************/
3057 void circuit_expire_building(time_t now
);
3058 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
3059 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
3061 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
3062 const or_options_t
*options
);
3063 void circuit_build_needed_circs(time_t now
);
3064 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
3066 void reset_bandwidth_test(void);
3067 int circuit_enough_testing_circs(void);
3069 void circuit_has_opened(origin_circuit_t
*circ
);
3070 void circuit_build_failed(origin_circuit_t
*circ
);
3072 /** Flag to set when a circuit should have only a single hop. */
3073 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
3074 /** Flag to set when a circuit needs to be built of high-uptime nodes */
3075 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
3076 /** Flag to set when a circuit needs to be built of high-capacity nodes */
3077 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
3078 /** Flag to set when the last hop of a circuit doesn't need to be an
3080 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
3081 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
3082 extend_info_t
*info
,
3084 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
3085 routerinfo_t
*exit
, int flags
);
3086 void circuit_reset_failure_count(int timeout
);
3087 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
3088 origin_circuit_t
*circ
,
3089 crypt_path_t
*cpath
);
3090 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
3092 /********************************* command.c ***************************/
3094 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
3095 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
3097 extern uint64_t stats_n_padding_cells_processed
;
3098 extern uint64_t stats_n_create_cells_processed
;
3099 extern uint64_t stats_n_created_cells_processed
;
3100 extern uint64_t stats_n_relay_cells_processed
;
3101 extern uint64_t stats_n_destroy_cells_processed
;
3103 /********************************* config.c ***************************/
3105 /** An error from options_trial_assign() or options_init_from_string(). */
3106 typedef enum setopt_err_t
{
3108 SETOPT_ERR_MISC
= -1,
3109 SETOPT_ERR_PARSE
= -2,
3110 SETOPT_ERR_TRANSITION
= -3,
3111 SETOPT_ERR_SETTING
= -4,
3114 const char *get_dirportfrontpage(void);
3115 or_options_t
*get_options(void);
3116 int set_options(or_options_t
*new_val
, char **msg
);
3117 void config_free_all(void);
3118 const char *safe_str(const char *address
);
3119 const char *escaped_safe_str(const char *address
);
3120 const char *get_version(void);
3122 int config_get_lines(const char *string
, config_line_t
**result
);
3123 void config_free_lines(config_line_t
*front
);
3124 setopt_err_t
options_trial_assign(config_line_t
*list
, int use_defaults
,
3125 int clear_first
, char **msg
);
3126 int resolve_my_address(int warn_severity
, or_options_t
*options
,
3127 uint32_t *addr
, char **hostname_out
);
3128 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
3129 void options_init(or_options_t
*options
);
3130 int options_init_from_torrc(int argc
, char **argv
);
3131 setopt_err_t
options_init_from_string(const char *cf
,
3132 int command
, const char *command_arg
, char **msg
);
3133 int option_is_recognized(const char *key
);
3134 const char *option_get_canonical_name(const char *key
);
3135 config_line_t
*option_get_assignment(or_options_t
*options
,
3137 int options_save_current(void);
3138 const char *get_torrc_fname(void);
3139 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
3140 const char *sub1
, const char *sub2
,
3141 const char *suffix
);
3142 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
3143 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
3144 /** Return a newly allocated string containing datadir/sub1. See
3145 * get_datadir_fname2_suffix. */
3146 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
3147 /** Return a newly allocated string containing datadir/sub1/sub2. See
3148 * get_datadir_fname2_suffix. */
3149 #define get_datadir_fname2(sub1,sub2) \
3150 get_datadir_fname2_suffix((sub1), (sub2), NULL)
3151 /** Return a newly allocated string containing datadir/sub1suffix. See
3152 * get_datadir_fname2_suffix. */
3153 #define get_datadir_fname_suffix(sub1, suffix) \
3154 get_datadir_fname2_suffix((sub1), NULL, (suffix))
3156 or_state_t
*get_or_state(void);
3157 int or_state_save(time_t now
);
3159 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
3160 int getinfo_helper_config(control_connection_t
*conn
,
3161 const char *question
, char **answer
);
3163 const char *tor_get_digests(void);
3164 uint32_t get_effective_bwrate(or_options_t
*options
);
3165 uint32_t get_effective_bwburst(or_options_t
*options
);
3167 #ifdef CONFIG_PRIVATE
3168 /* Used only by config.c and test.c */
3169 or_options_t
*options_new(void);
3172 /********************************* connection.c ***************************/
3174 const char *conn_type_to_string(int type
);
3175 const char *conn_state_to_string(int type
, int state
);
3177 dir_connection_t
*dir_connection_new(int socket_family
);
3178 or_connection_t
*or_connection_new(int socket_family
);
3179 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
3180 control_connection_t
*control_connection_new(int socket_family
);
3181 connection_t
*connection_new(int type
, int socket_family
);
3183 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
3184 void connection_free(connection_t
*conn
);
3185 void connection_free_all(void);
3186 void connection_about_to_close_connection(connection_t
*conn
);
3187 void connection_close_immediate(connection_t
*conn
);
3188 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
3190 #define connection_mark_for_close(c) \
3191 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
3193 void connection_expire_held_open(void);
3195 int connection_connect(connection_t
*conn
, const char *address
,
3196 const tor_addr_t
*addr
,
3197 uint16_t port
, int *socket_error
);
3199 int connection_proxy_connect(connection_t
*conn
, int type
);
3200 int connection_read_proxy_handshake(connection_t
*conn
);
3202 int retry_all_listeners(smartlist_t
*replaced_conns
,
3203 smartlist_t
*new_conns
);
3205 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
3206 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
3207 void connection_bucket_init(void);
3208 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
3210 int connection_handle_read(connection_t
*conn
);
3212 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
3214 int connection_wants_to_flush(connection_t
*conn
);
3215 int connection_outbuf_too_full(connection_t
*conn
);
3216 int connection_handle_write(connection_t
*conn
, int force
);
3217 void _connection_write_to_buf_impl(const char *string
, size_t len
,
3218 connection_t
*conn
, int zlib
);
3219 static void connection_write_to_buf(const char *string
, size_t len
,
3220 connection_t
*conn
);
3221 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
3222 dir_connection_t
*conn
, int done
);
3224 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
3226 _connection_write_to_buf_impl(string
, len
, conn
, 0);
3229 connection_write_to_buf_zlib(const char *string
, size_t len
,
3230 dir_connection_t
*conn
, int done
)
3232 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
3235 connection_t
*connection_get_by_global_id(uint64_t id
);
3237 connection_t
*connection_get_by_type(int type
);
3238 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
3239 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
3240 const tor_addr_t
*addr
,
3241 uint16_t port
, int purpose
);
3242 connection_t
*connection_get_by_type_state(int type
, int state
);
3243 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
3244 const char *rendquery
);
3246 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
3247 int connection_is_listener(connection_t
*conn
);
3248 int connection_state_is_open(connection_t
*conn
);
3249 int connection_state_is_connecting(connection_t
*conn
);
3251 char *alloc_http_authenticator(const char *authenticator
);
3253 void assert_connection_ok(connection_t
*conn
, time_t now
);
3254 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
3255 void connection_dump_buffer_mem_stats(int severity
);
3256 void remove_file_if_very_old(const char *fname
, time_t now
);
3258 /********************************* connection_edge.c *************************/
3260 #define connection_mark_unattached_ap(conn, endreason) \
3261 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
3263 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
3264 int line
, const char *file
);
3265 int connection_edge_reached_eof(edge_connection_t
*conn
);
3266 int connection_edge_process_inbuf(edge_connection_t
*conn
,
3267 int package_partial
);
3268 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
3269 int connection_edge_end(edge_connection_t
*conn
, uint8_t reason
);
3270 int connection_edge_end_errno(edge_connection_t
*conn
);
3271 int connection_edge_finished_flushing(edge_connection_t
*conn
);
3272 int connection_edge_finished_connecting(edge_connection_t
*conn
);
3274 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
3275 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
3277 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
3279 int use_begindir
, int want_onehop
);
3280 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
3283 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
3290 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
3291 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
3292 void connection_exit_connect(edge_connection_t
*conn
);
3293 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
3294 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
3295 void connection_ap_expire_beginning(void);
3296 void connection_ap_attach_pending(void);
3297 void connection_ap_fail_onehop(const char *failed_digest
,
3298 cpath_build_state_t
*build_state
);
3299 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
3300 int connection_ap_detach_retriable(edge_connection_t
*conn
,
3301 origin_circuit_t
*circ
,
3303 int connection_ap_process_transparent(edge_connection_t
*conn
);
3305 int address_is_invalid_destination(const char *address
, int client
);
3307 void addressmap_init(void);
3308 void addressmap_clean(time_t now
);
3309 void addressmap_clear_configured(void);
3310 void addressmap_clear_transient(void);
3311 void addressmap_free_all(void);
3312 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
3313 int addressmap_have_mapping(const char *address
, int update_timeout
);
3314 /** Enumerates possible origins of a client-side address mapping. */
3316 /** We're remapping this address because the controller told us to. */
3317 ADDRMAPSRC_CONTROLLER
,
3318 /** We're remapping this address because our configuration (via torrc, the
3319 * command line, or a SETCONF command) told us to. */
3321 /** We're remapping this address because we have TrackHostExit configured,
3322 * and we want to remember to use the same exit next time. */
3323 ADDRMAPSRC_TRACKEXIT
,
3324 /** We're remapping this address because we got a DNS resolution from a
3325 * Tor server that told us what its value was. */
3327 } addressmap_entry_source_t
;
3328 void addressmap_register(const char *address
, char *new_address
,
3329 time_t expires
, addressmap_entry_source_t source
);
3330 int parse_virtual_addr_network(const char *val
, int validate_only
,
3332 int client_dns_incr_failures(const char *address
);
3333 void client_dns_clear_failures(const char *address
);
3334 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3335 const char *exitname
, int ttl
);
3336 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3337 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3338 time_t max_expires
, int want_expiry
);
3339 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3340 origin_circuit_t
*circ
,
3341 crypt_path_t
*cpath
);
3342 int hostname_is_noconnect_address(const char *address
);
3344 /** Possible return values for parse_extended_hostname. */
3345 typedef enum hostname_type_t
{
3346 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3348 hostname_type_t
parse_extended_hostname(char *address
, int allowdotexit
);
3350 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3351 int get_pf_socket(void);
3354 /********************************* connection_or.c ***************************/
3356 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3357 void connection_or_clear_identity_map(void);
3358 or_connection_t
*connection_or_get_for_extend(const char *digest
,
3359 const tor_addr_t
*target_addr
,
3360 const char **msg_out
,
3362 void connection_or_set_bad_connections(void);
3364 int connection_or_reached_eof(or_connection_t
*conn
);
3365 int connection_or_process_inbuf(or_connection_t
*conn
);
3366 int connection_or_flushed_some(or_connection_t
*conn
);
3367 int connection_or_finished_flushing(or_connection_t
*conn
);
3368 int connection_or_finished_connecting(or_connection_t
*conn
);
3370 void connection_or_connect_failed(or_connection_t
*conn
,
3371 int reason
, const char *msg
);
3372 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3373 const char *id_digest
);
3375 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3376 int connection_tls_continue_handshake(or_connection_t
*conn
);
3378 void or_handshake_state_free(or_handshake_state_t
*state
);
3379 int connection_or_set_state_open(or_connection_t
*conn
);
3380 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3381 or_connection_t
*conn
);
3382 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3383 or_connection_t
*conn
);
3384 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3386 int connection_or_send_netinfo(or_connection_t
*conn
);
3387 int connection_or_send_cert(or_connection_t
*conn
);
3388 int connection_or_send_link_auth(or_connection_t
*conn
);
3389 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3391 int is_or_protocol_version_known(uint16_t version
);
3393 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3394 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3395 var_cell_t
*var_cell_new(uint16_t payload_len
);
3396 void var_cell_free(var_cell_t
*cell
);
3398 /********************************* control.c ***************************/
3400 /** Used to indicate the type of a circuit event passed to the controller.
3401 * The various types are defined in control-spec.txt */
3402 typedef enum circuit_status_event_t
{
3403 CIRC_EVENT_LAUNCHED
= 0,
3404 CIRC_EVENT_BUILT
= 1,
3405 CIRC_EVENT_EXTENDED
= 2,
3406 CIRC_EVENT_FAILED
= 3,
3407 CIRC_EVENT_CLOSED
= 4,
3408 } circuit_status_event_t
;
3410 /** Used to indicate the type of a stream event passed to the controller.
3411 * The various types are defined in control-spec.txt */
3412 typedef enum stream_status_event_t
{
3413 STREAM_EVENT_SENT_CONNECT
= 0,
3414 STREAM_EVENT_SENT_RESOLVE
= 1,
3415 STREAM_EVENT_SUCCEEDED
= 2,
3416 STREAM_EVENT_FAILED
= 3,
3417 STREAM_EVENT_CLOSED
= 4,
3418 STREAM_EVENT_NEW
= 5,
3419 STREAM_EVENT_NEW_RESOLVE
= 6,
3420 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3421 STREAM_EVENT_REMAP
= 8
3422 } stream_status_event_t
;
3424 /** Used to indicate the type of an OR connection event passed to the
3425 * controller. The various types are defined in control-spec.txt */
3426 typedef enum or_conn_status_event_t
{
3427 OR_CONN_EVENT_LAUNCHED
= 0,
3428 OR_CONN_EVENT_CONNECTED
= 1,
3429 OR_CONN_EVENT_FAILED
= 2,
3430 OR_CONN_EVENT_CLOSED
= 3,
3431 OR_CONN_EVENT_NEW
= 4,
3432 } or_conn_status_event_t
;
3434 void control_update_global_event_mask(void);
3435 void control_adjust_event_log_severity(void);
3437 /** Execute the statement <b>stmt</b>, which may log events concerning the
3438 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3439 * being sent to controllers if <b>conn</b> is a control connection.
3441 * Stmt must not contain any return or goto statements.
3443 #define CONN_LOG_PROTECT(conn, stmt) \
3445 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3446 if (_log_conn_is_control) \
3447 disable_control_logging(); \
3448 STMT_BEGIN stmt; STMT_END; \
3449 if (_log_conn_is_control) \
3450 enable_control_logging(); \
3453 /** Log information about the connection <b>conn</b>, protecting it as with
3454 * CONN_LOG_PROTECT. Example:
3456 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3458 #define LOG_FN_CONN(conn, args) \
3459 CONN_LOG_PROTECT(conn, log_fn args)
3461 int connection_control_finished_flushing(control_connection_t
*conn
);
3462 int connection_control_reached_eof(control_connection_t
*conn
);
3463 int connection_control_process_inbuf(control_connection_t
*conn
);
3465 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3466 #define EVENT_NS 0x000F
3467 int control_event_is_interesting(int event
);
3469 int control_event_circuit_status(origin_circuit_t
*circ
,
3470 circuit_status_event_t e
, int reason
);
3471 int control_event_stream_status(edge_connection_t
*conn
,
3472 stream_status_event_t e
,
3474 int control_event_or_conn_status(or_connection_t
*conn
,
3475 or_conn_status_event_t e
, int reason
);
3476 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3477 int control_event_stream_bandwidth(edge_connection_t
*edge_conn
);
3478 int control_event_stream_bandwidth_used(void);
3479 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3480 int control_event_descriptors_changed(smartlist_t
*routers
);
3481 int control_event_address_mapped(const char *from
, const char *to
,
3482 time_t expires
, const char *error
);
3483 int control_event_or_authdir_new_descriptor(const char *action
,
3487 int control_event_my_descriptor_changed(void);
3488 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3489 int control_event_newconsensus(const networkstatus_t
*consensus
);
3490 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3491 int control_event_general_status(int severity
, const char *format
, ...)
3493 int control_event_client_status(int severity
, const char *format
, ...)
3495 int control_event_server_status(int severity
, const char *format
, ...)
3497 int control_event_guard(const char *nickname
, const char *digest
,
3498 const char *status
);
3500 int init_cookie_authentication(int enabled
);
3501 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3502 void disable_control_logging(void);
3503 void enable_control_logging(void);
3505 /** Enum describing various stages of bootstrapping, for use with controller
3506 * bootstrap status events. The values range from 0 to 100. */
3508 BOOTSTRAP_STATUS_UNDEF
=-1,
3509 BOOTSTRAP_STATUS_STARTING
=0,
3510 BOOTSTRAP_STATUS_CONN_DIR
=5,
3511 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3512 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3513 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3514 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3515 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3516 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3517 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3518 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3519 BOOTSTRAP_STATUS_CONN_OR
=80,
3520 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3521 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3522 BOOTSTRAP_STATUS_DONE
=100
3523 } bootstrap_status_t
;
3525 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3526 void control_event_bootstrap_problem(const char *warn
, int reason
);
3528 void control_event_clients_seen(const char *timestarted
,
3529 const char *countries
);
3531 #ifdef CONTROL_PRIVATE
3532 /* Used only by control.c and test.c */
3533 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3534 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3537 /********************************* cpuworker.c *****************************/
3539 void cpu_init(void);
3540 void cpuworkers_rotate(void);
3541 int connection_cpu_finished_flushing(connection_t
*conn
);
3542 int connection_cpu_reached_eof(connection_t
*conn
);
3543 int connection_cpu_process_inbuf(connection_t
*conn
);
3544 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3548 /********************************* directory.c ***************************/
3550 int directories_have_accepted_server_descriptor(void);
3551 char *authority_type_to_string(authority_type_t auth
);
3552 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3553 authority_type_t type
, const char *payload
,
3554 size_t payload_len
, size_t extrainfo_len
);
3555 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3556 const char *resource
,
3558 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3559 uint8_t router_purpose
,
3560 const char *resource
);
3561 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3562 uint8_t dir_purpose
,
3563 uint8_t router_purpose
,
3564 int anonymized_connection
,
3565 const char *resource
,
3566 const char *payload
,
3568 time_t if_modified_since
);
3569 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3570 uint8_t dir_purpose
,
3571 uint8_t router_purpose
,
3572 int anonymized_connection
,
3573 const char *resource
,
3574 const char *payload
,
3576 time_t if_modified_since
,
3577 const rend_data_t
*rend_query
);
3579 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3580 compress_method_t
*compression
, char **response
);
3582 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3583 int connection_dir_reached_eof(dir_connection_t
*conn
);
3584 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3585 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3586 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3587 void connection_dir_request_failed(dir_connection_t
*conn
);
3588 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3589 uint16_t or_port
, uint16_t dir_port
,
3590 int supports_conditional_consensus
,
3591 int supports_begindir
, const char *digest
,
3592 uint8_t dir_purpose
, uint8_t router_purpose
,
3593 int anonymized_connection
,
3594 const char *resource
,
3595 const char *payload
, size_t payload_len
,
3596 time_t if_modified_since
);
3598 int dir_split_resource_into_fingerprints(const char *resource
,
3599 smartlist_t
*fp_out
, int *compresseed_out
,
3600 int decode_hex
, int sort_uniq
);
3601 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
3603 char first
[DIGEST_LEN
];
3604 char second
[DIGEST_LEN
];
3606 int dir_split_resource_into_fingerprint_pairs(const char *res
,
3607 smartlist_t
*pairs_out
);
3608 char *directory_dump_request_log(void);
3609 void note_request(const char *key
, size_t bytes
);
3610 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3612 time_t download_status_increment_failure(download_status_t
*dls
,
3613 int status_code
, const char *item
,
3614 int server
, time_t now
);
3615 /** Increment the failure count of the download_status_t <b>dls</b>, with
3616 * the optional status code <b>sc</b>. */
3617 #define download_status_failed(dls, sc) \
3618 download_status_increment_failure((dls), (sc), NULL, \
3619 get_options()->DirPort, time(NULL))
3621 void download_status_reset(download_status_t
*dls
);
3622 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3624 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3625 * ready to get its download reattempted. */
3627 download_status_is_ready(download_status_t
*dls
, time_t now
,
3630 return (dls
->n_download_failures
<= max_failures
3631 && dls
->next_attempt_at
<= now
);
3634 static void download_status_mark_impossible(download_status_t
*dl
);
3635 /** Mark <b>dl</b> as never downloadable. */
3637 download_status_mark_impossible(download_status_t
*dl
)
3639 dl
->n_download_failures
= IMPOSSIBLE_TO_DOWNLOAD
;
3642 /********************************* dirserv.c ***************************/
3643 /** Maximum length of an exit policy summary. */
3644 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3646 /** Maximum allowable length of a version line in a networkstatus. */
3647 #define MAX_V_LINE_LEN 128
3648 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3649 * Running Stable Unnamed V2Dir Valid\n". */
3650 #define MAX_FLAG_LINE_LEN 96
3651 /** Length of "w" line for weighting. Currently at most
3652 * "w Bandwidth=<uint32t> Measured=<uint32t>\n" */
3653 #define MAX_WEIGHT_LINE_LEN (12+10+10+10+1)
3654 /** Maximum length of an exit policy summary line. */
3655 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3656 /** Amount of space to allocate for each entry: r, s, and v lines. */
3657 #define RS_ENTRY_LEN \
3658 ( /* first line */ \
3659 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3660 5*2 /* ports */ + 10 /* punctuation */ + \
3662 MAX_FLAG_LINE_LEN + \
3664 MAX_WEIGHT_LINE_LEN + \
3666 MAX_POLICY_LINE_LEN + \
3670 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3672 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3674 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3675 int dirserv_load_fingerprint_file(void);
3676 void dirserv_free_fingerprint_list(void);
3677 const char *dirserv_get_nickname_by_digest(const char *digest
);
3678 enum was_router_added_t
dirserv_add_multiple_descriptors(
3679 const char *desc
, uint8_t purpose
,
3682 enum was_router_added_t
dirserv_add_descriptor(routerinfo_t
*ri
,
3684 const char *source
);
3685 void dirserv_free_descriptors(void);
3686 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3687 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3688 int for_controller
);
3689 int dirserv_dump_directory_to_string(char **dir_out
,
3690 crypto_pk_env_t
*private_key
);
3692 int directory_fetches_from_authorities(or_options_t
*options
);
3693 int directory_fetches_dir_info_early(or_options_t
*options
);
3694 int directory_fetches_dir_info_later(or_options_t
*options
);
3695 int directory_caches_v2_dir_info(or_options_t
*options
);
3696 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3697 int directory_caches_dir_info(or_options_t
*options
);
3698 int directory_permits_begindir_requests(or_options_t
*options
);
3699 int directory_permits_controller_requests(or_options_t
*options
);
3700 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3702 void directory_set_dirty(void);
3703 cached_dir_t
*dirserv_get_directory(void);
3704 cached_dir_t
*dirserv_get_runningrouters(void);
3705 cached_dir_t
*dirserv_get_consensus(void);
3706 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3707 int is_running_routers
);
3708 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3709 const char *identity
,
3711 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
3713 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3714 void dirserv_clear_old_v1_info(time_t now
);
3715 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3716 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3718 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3720 int for_unencrypted_conn
,
3722 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3724 void dirserv_orconn_tls_done(const char *address
,
3726 const char *digest_rcvd
,
3728 void dirserv_test_reachability(time_t now
, int try_all
);
3729 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3731 int dirserv_would_reject_router(routerstatus_t
*rs
);
3732 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3733 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3734 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3737 NS_V2
, NS_V3_CONSENSUS
, NS_V3_VOTE
, NS_CONTROL_PORT
3738 } routerstatus_format_type_t
;
3739 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3740 routerstatus_t
*rs
, const char *platform
,
3741 routerstatus_format_type_t format
);
3742 void dirserv_free_all(void);
3743 void cached_dir_decref(cached_dir_t
*d
);
3744 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3746 #ifdef DIRSERV_PRIVATE
3747 typedef struct measured_bw_line_t
{
3748 char node_id
[DIGEST_LEN
];
3749 char node_hex
[MAX_HEX_NICKNAME_LEN
+1];
3751 } measured_bw_line_t
;
3753 int measured_bw_line_parse(measured_bw_line_t
*out
, const char *line
);
3755 int measured_bw_line_apply(measured_bw_line_t
*parsed_line
,
3756 smartlist_t
*routerstatuses
);
3759 int dirserv_read_measured_bandwidths(const char *from_file
,
3760 smartlist_t
*routerstatuses
);
3762 /********************************* dirvote.c ************************/
3764 /** Lowest allowable value for VoteSeconds. */
3765 #define MIN_VOTE_SECONDS 20
3766 /** Lowest allowable value for DistSeconds. */
3767 #define MIN_DIST_SECONDS 20
3768 /** Smallest allowable voting interval. */
3769 #define MIN_VOTE_INTERVAL 300
3771 void dirvote_free_all(void);
3773 /* vote manipulation */
3774 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3775 int total_authorities
,
3776 crypto_pk_env_t
*identity_key
,
3777 crypto_pk_env_t
*signing_key
,
3778 const char *legacy_identity_key_digest
,
3779 crypto_pk_env_t
*legacy_signing_key
);
3780 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3781 ns_detached_signatures_t
*sigs
,
3782 const char **msg_out
);
3783 char *networkstatus_get_detached_signatures(networkstatus_t
*consensus
);
3784 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3786 /* cert manipulation */
3787 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3789 /** Describes the schedule by which votes should be generated. */
3790 typedef struct vote_timing_t
{
3792 int n_intervals_valid
;
3796 /* vote scheduling */
3797 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3798 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3799 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3800 void dirvote_act(or_options_t
*options
, time_t now
);
3802 /* invoked on timers and by outside triggers. */
3803 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3804 const char **msg_out
,
3806 int dirvote_add_signatures(const char *detached_signatures_body
,
3808 const char **msg_out
);
3811 const char *dirvote_get_pending_consensus(void);
3812 const char *dirvote_get_pending_detached_signatures(void);
3814 #define DGV_INCLUDE_PENDING 2
3815 #define DGV_INCLUDE_PREVIOUS 4
3816 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3817 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3818 routerinfo_t
*ri
, time_t now
,
3819 int naming
, int exits_can_be_guards
,
3820 int listbadexits
, int listbaddirs
);
3821 void router_clear_status_flags(routerinfo_t
*ri
);
3823 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3824 authority_cert_t
*cert
);
3826 #ifdef DIRVOTE_PRIVATE
3827 char *format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3828 networkstatus_t
*v3_ns
);
3829 char *dirvote_compute_params(smartlist_t
*votes
);
3832 /********************************* dns.c ***************************/
3835 int has_dns_init_failed(void);
3836 void dns_free_all(void);
3837 uint32_t dns_clip_ttl(uint32_t ttl
);
3838 int dns_reset(void);
3839 void connection_dns_remove(edge_connection_t
*conn
);
3840 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3841 void assert_all_pending_dns_resolves_ok(void);
3842 void dns_cancel_pending_resolve(const char *question
);
3843 int dns_resolve(edge_connection_t
*exitconn
);
3844 void dns_launch_correctness_checks(void);
3845 int dns_seems_to_be_broken(void);
3846 void dns_reset_correctness_checks(void);
3847 void dump_dns_mem_usage(int severity
);
3849 /********************************* dnsserv.c ************************/
3851 void dnsserv_configure_listener(connection_t
*conn
);
3852 void dnsserv_close_listener(connection_t
*conn
);
3853 void dnsserv_resolved(edge_connection_t
*conn
,
3858 void dnsserv_reject_request(edge_connection_t
*conn
);
3859 int dnsserv_launch_request(const char *name
, int is_reverse
);
3861 /********************************* geoip.c **************************/
3863 /** Round all GeoIP results to the next multiple of this value, to avoid
3864 * leaking information. */
3865 #define DIR_RECORD_USAGE_GRANULARITY 8
3866 /** Time interval: Flush geoip data to disk this often. */
3867 #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
3868 /** How long do we have to have observed per-country request history before
3869 * we are willing to talk about it? */
3870 #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
3872 #ifdef GEOIP_PRIVATE
3873 int geoip_parse_entry(const char *line
);
3875 int should_record_bridge_info(or_options_t
*options
);
3876 int geoip_load_file(const char *filename
, or_options_t
*options
);
3877 int geoip_get_country_by_ip(uint32_t ipaddr
);
3878 int geoip_get_n_countries(void);
3879 const char *geoip_get_country_name(country_t num
);
3880 int geoip_is_loaded(void);
3881 country_t
geoip_get_country(const char *countrycode
);
3882 /** Indicates an action that we might be noting geoip statistics on.
3883 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3884 * the others, we're not.
3887 /** We've noticed a connection as a bridge relay or entry guard. */
3888 GEOIP_CLIENT_CONNECT
= 0,
3889 /** We've served a networkstatus consensus as a directory server. */
3890 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3891 /** We've served a v2 networkstatus consensus as a directory server. */
3892 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3893 } geoip_client_action_t
;
3894 void geoip_note_client_seen(geoip_client_action_t action
,
3895 uint32_t addr
, time_t now
);
3896 void geoip_remove_old_clients(time_t cutoff
);
3897 /** Indicates either a positive reply or a reason for rejectng a network
3898 * status request that will be included in geoip statistics. */
3900 /** Request is answered successfully. */
3902 /** V3 network status is not signed by a sufficient number of requested
3904 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
3905 /** Requested network status object is unavailable. */
3906 GEOIP_REJECT_UNAVAILABLE
= 2,
3907 /** Requested network status not found. */
3908 GEOIP_REJECT_NOT_FOUND
= 3,
3909 /** Network status has not been modified since If-Modified-Since time. */
3910 GEOIP_REJECT_NOT_MODIFIED
= 4,
3911 /** Directory is busy. */
3912 GEOIP_REJECT_BUSY
= 5,
3913 } geoip_ns_response_t
;
3914 #define GEOIP_NS_RESPONSE_NUM 6
3915 void geoip_note_ns_response(geoip_client_action_t action
,
3916 geoip_ns_response_t response
);
3917 time_t geoip_get_history_start(void);
3918 char *geoip_get_client_history_dirreq(time_t now
,
3919 geoip_client_action_t action
);
3920 char *geoip_get_client_history_bridge(time_t now
,
3921 geoip_client_action_t action
);
3922 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
3923 int getinfo_helper_geoip(control_connection_t
*control_conn
,
3924 const char *question
, char **answer
);
3925 void geoip_free_all(void);
3927 /** Directory requests that we are measuring can be either direct or
3931 DIRREQ_TUNNELED
= 1,
3934 /** Possible states for either direct or tunneled directory requests that
3935 * are relevant for determining network status download times. */
3937 /** Found that the client requests a network status; applies to both
3938 * direct and tunneled requests; initial state of a request that we are
3940 DIRREQ_IS_FOR_NETWORK_STATUS
= 0,
3941 /** Finished writing a network status to the directory connection;
3942 * applies to both direct and tunneled requests; completes a direct
3944 DIRREQ_FLUSHING_DIR_CONN_FINISHED
= 1,
3945 /** END cell sent to circuit that initiated a tunneled request. */
3946 DIRREQ_END_CELL_SENT
= 2,
3947 /** Flushed last cell from queue of the circuit that initiated a
3948 * tunneled request to the outbuf of the OR connection. */
3949 DIRREQ_CIRC_QUEUE_FLUSHED
= 3,
3950 /** Flushed last byte from buffer of the OR connection belonging to the
3951 * circuit that initiated a tunneled request; completes a tunneled
3953 DIRREQ_OR_CONN_BUFFER_FLUSHED
= 4
3956 void geoip_start_dirreq(uint64_t dirreq_id
, size_t response_size
,
3957 geoip_client_action_t action
, dirreq_type_t type
);
3958 void geoip_change_dirreq_state(uint64_t dirreq_id
, dirreq_type_t type
,
3959 dirreq_state_t new_state
);
3961 void geoip_dirreq_stats_init(time_t now
);
3962 void geoip_dirreq_stats_write(time_t now
);
3963 void geoip_entry_stats_init(time_t now
);
3964 void geoip_entry_stats_write(time_t now
);
3966 /********************************* hibernate.c **********************/
3968 int accounting_parse_options(or_options_t
*options
, int validate_only
);
3969 int accounting_is_enabled(or_options_t
*options
);
3970 void configure_accounting(time_t now
);
3971 void accounting_run_housekeeping(time_t now
);
3972 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
3973 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
3974 void hibernate_begin_shutdown(void);
3975 int we_are_hibernating(void);
3976 void consider_hibernation(time_t now
);
3977 int getinfo_helper_accounting(control_connection_t
*conn
,
3978 const char *question
, char **answer
);
3979 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
3981 /********************************* main.c ***************************/
3983 extern int has_completed_circuit
;
3985 int connection_add(connection_t
*conn
);
3986 int connection_remove(connection_t
*conn
);
3987 void connection_unregister_events(connection_t
*conn
);
3988 int connection_in_array(connection_t
*conn
);
3989 void add_connection_to_closeable_list(connection_t
*conn
);
3990 int connection_is_on_closeable_list(connection_t
*conn
);
3992 smartlist_t
*get_connection_array(void);
3994 typedef enum watchable_events
{
3997 } watchable_events_t
;
3998 void connection_watch_events(connection_t
*conn
, watchable_events_t events
);
3999 int connection_is_reading(connection_t
*conn
);
4000 void connection_stop_reading(connection_t
*conn
);
4001 void connection_start_reading(connection_t
*conn
);
4003 int connection_is_writing(connection_t
*conn
);
4004 void connection_stop_writing(connection_t
*conn
);
4005 void connection_start_writing(connection_t
*conn
);
4007 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
4009 void directory_all_unreachable(time_t now
);
4010 void directory_info_has_arrived(time_t now
, int from_cache
);
4012 void ip_address_changed(int at_interface
);
4013 void dns_servers_relaunch_checks(void);
4015 void control_signal_act(int the_signal
);
4016 void handle_signals(int is_parent
);
4018 int try_locking(or_options_t
*options
, int err_if_locked
);
4019 int have_lockfile(void);
4020 void release_lockfile(void);
4022 void tor_cleanup(void);
4023 void tor_free_all(int postfork
);
4025 int tor_main(int argc
, char *argv
[]);
4028 int do_main_loop(void);
4029 int do_list_fingerprint(void);
4030 void do_hash_password(void);
4031 int tor_init(int argc
, char **argv
);
4034 /********************************* networkstatus.c *********************/
4036 /** How old do we allow a v2 network-status to get before removing it
4038 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
4040 /** Location where we found a v2 networkstatus. */
4042 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
4043 } v2_networkstatus_source_t
;
4045 /** Possible statuses of a version of Tor, given opinions from the directory
4047 typedef enum version_status_t
{
4048 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
4049 VS_OLD
=1, /**< This version is older than any recommended version. */
4050 VS_NEW
=2, /**< This version is newer than any recommended version. */
4051 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
4052 * in its series, but later recommended versions exist.
4054 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
4055 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
4056 VS_UNKNOWN
, /**< We have no idea. */
4059 void networkstatus_reset_warnings(void);
4060 void networkstatus_reset_download_failures(void);
4061 int router_reload_v2_networkstatus(void);
4062 int router_reload_consensus_networkstatus(void);
4063 void routerstatus_free(routerstatus_t
*rs
);
4064 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
4065 void networkstatus_vote_free(networkstatus_t
*ns
);
4066 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
4067 networkstatus_t
*vote
,
4068 const char *identity
);
4069 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
4071 int networkstatus_check_voter_signature(networkstatus_t
*consensus
,
4072 networkstatus_voter_info_t
*voter
,
4073 authority_cert_t
*cert
);
4074 char *networkstatus_get_cache_filename(const char *identity_digest
);
4075 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
4076 v2_networkstatus_source_t source
,
4077 smartlist_t
*requested_fingerprints
);
4078 void networkstatus_v2_list_clean(time_t now
);
4079 int compare_digest_to_routerstatus_entry(const void *_key
,
4080 const void **_member
);
4081 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
4082 const char *digest
);
4083 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
4084 const char *digest
);
4085 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
4086 const char *digest
, int *found_out
);
4087 const smartlist_t
*networkstatus_get_v2_list(void);
4088 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
4089 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
4090 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
4091 const char *digest
);
4092 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
4093 int warn_if_unnamed
);
4094 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
4095 int networkstatus_nickname_is_unnamed(const char *nickname
);
4096 void networkstatus_consensus_download_failed(int status_code
);
4097 void update_consensus_networkstatus_fetch_time(time_t now
);
4098 int should_delay_dir_fetches(or_options_t
*options
);
4099 void update_networkstatus_downloads(time_t now
);
4100 void update_certificate_downloads(time_t now
);
4101 int consensus_is_waiting_for_certs(void);
4102 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
4103 networkstatus_t
*networkstatus_get_latest_consensus(void);
4104 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
4105 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
4106 #define NSSET_FROM_CACHE 1
4107 #define NSSET_WAS_WAITING_FOR_CERTS 2
4108 #define NSSET_DONT_DOWNLOAD_CERTS 4
4109 #define NSSET_ACCEPT_OBSOLETE 8
4110 int networkstatus_set_current_consensus(const char *consensus
, unsigned flags
);
4111 void networkstatus_note_certs_arrived(void);
4112 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
4113 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
4114 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
4115 int reset_failures
);
4116 void signed_descs_update_status_from_consensus_networkstatus(
4117 smartlist_t
*descs
);
4119 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
4120 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
4121 void networkstatus_dump_bridge_status_to_file(time_t now
);
4122 int32_t networkstatus_get_param(networkstatus_t
*ns
, const char *param_name
,
4123 int32_t default_val
);
4124 int getinfo_helper_networkstatus(control_connection_t
*conn
,
4125 const char *question
, char **answer
);
4126 void networkstatus_free_all(void);
4128 /********************************* ntmain.c ***************************/
4134 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
4135 int nt_service_is_stopping(void);
4136 void nt_service_set_state(DWORD state
);
4138 #define nt_service_is_stopping() (0)
4141 /********************************* onion.c ***************************/
4143 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
4144 or_circuit_t
*onion_next_task(char **onionskin_out
);
4145 void onion_pending_remove(or_circuit_t
*circ
);
4147 int onion_skin_create(crypto_pk_env_t
*router_key
,
4148 crypto_dh_env_t
**handshake_state_out
,
4149 char *onion_skin_out
);
4151 int onion_skin_server_handshake(const char *onion_skin
,
4152 crypto_pk_env_t
*private_key
,
4153 crypto_pk_env_t
*prev_private_key
,
4154 char *handshake_reply_out
,
4156 size_t key_out_len
);
4158 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
4159 const char *handshake_reply
,
4161 size_t key_out_len
);
4163 int fast_server_handshake(const char *key_in
,
4164 char *handshake_reply_out
,
4166 size_t key_out_len
);
4168 int fast_client_handshake(const char *handshake_state
,
4169 const char *handshake_reply_out
,
4171 size_t key_out_len
);
4173 void clear_pending_onions(void);
4175 /********************************* policies.c ************************/
4177 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
4180 #define POLICY_BUF_LEN 52
4182 /** Outcome of applying an address policy to an address. */
4184 /** The address was accepted */
4185 ADDR_POLICY_ACCEPTED
=0,
4186 /** The address was rejected */
4187 ADDR_POLICY_REJECTED
=-1,
4188 /** Part of the address was unknown, but as far as we can tell, it was
4190 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
4191 /** Part of the address was unknown, but as far as we can tell, it was
4193 ADDR_POLICY_PROBABLY_REJECTED
=2
4194 } addr_policy_result_t
;
4196 int firewall_is_fascist_or(void);
4197 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
4198 int fascist_firewall_allows_or(routerinfo_t
*ri
);
4199 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
4200 int dir_policy_permits_address(const tor_addr_t
*addr
);
4201 int socks_policy_permits_address(const tor_addr_t
*addr
);
4202 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
4203 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
4204 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
4205 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
4207 int validate_addr_policies(or_options_t
*options
, char **msg
);
4208 void policy_expand_private(smartlist_t
**policy
);
4209 int policies_parse_from_options(or_options_t
*options
);
4211 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
4212 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
4213 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
4214 uint16_t port
, const smartlist_t
*policy
);
4215 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
4216 uint16_t port
, const smartlist_t
*policy
);
4217 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
4218 int rejectprivate
, const char *local_address
);
4219 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
4220 int exit_policy_is_general_exit(smartlist_t
*policy
);
4221 int policy_is_reject_star(const smartlist_t
*policy
);
4222 int getinfo_helper_policies(control_connection_t
*conn
,
4223 const char *question
, char **answer
);
4224 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
4225 int format_for_desc
);
4227 void addr_policy_list_free(smartlist_t
*p
);
4228 void addr_policy_free(addr_policy_t
*p
);
4229 void policies_free_all(void);
4231 char *policy_summarize(smartlist_t
*policy
);
4233 /********************************* reasons.c ***************************/
4235 const char *stream_end_reason_to_control_string(int reason
);
4236 const char *stream_end_reason_to_string(int reason
);
4237 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
4238 uint8_t errno_to_stream_end_reason(int e
);
4240 const char *orconn_end_reason_to_control_string(int r
);
4241 int tls_error_to_orconn_end_reason(int e
);
4242 int errno_to_orconn_end_reason(int e
);
4244 const char *circuit_end_reason_to_control_string(int reason
);
4245 const char *socks4_response_code_to_string(uint8_t code
);
4246 const char *socks5_response_code_to_string(uint8_t code
);
4248 /********************************* relay.c ***************************/
4250 extern uint64_t stats_n_relay_cells_relayed
;
4251 extern uint64_t stats_n_relay_cells_delivered
;
4253 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
4254 cell_direction_t cell_direction
);
4256 void relay_header_pack(char *dest
, const relay_header_t
*src
);
4257 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
4258 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
4259 uint8_t relay_command
, const char *payload
,
4260 size_t payload_len
, crypt_path_t
*cpath_layer
);
4261 int connection_edge_send_command(edge_connection_t
*fromconn
,
4262 uint8_t relay_command
, const char *payload
,
4263 size_t payload_len
);
4264 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
4265 int package_partial
);
4266 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
4268 extern uint64_t stats_n_data_cells_packaged
;
4269 extern uint64_t stats_n_data_bytes_packaged
;
4270 extern uint64_t stats_n_data_cells_received
;
4271 extern uint64_t stats_n_data_bytes_received
;
4273 void init_cell_pool(void);
4274 void free_cell_pool(void);
4275 void clean_cell_pool(void);
4276 void dump_cell_pool_usage(int severity
);
4278 void cell_queue_clear(cell_queue_t
*queue
);
4279 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
4280 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
4282 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
4283 cell_t
*cell
, cell_direction_t direction
);
4284 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
4285 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
4286 int max
, time_t now
);
4287 void assert_active_circuits_ok(or_connection_t
*orconn
);
4288 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
4289 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
4291 int append_address_to_payload(char *payload_out
, const tor_addr_t
*addr
);
4292 const char *decode_address_from_payload(tor_addr_t
*addr_out
,
4293 const char *payload
,
4296 /********************************* rephist.c ***************************/
4298 void rep_hist_init(void);
4299 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
4300 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
4301 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
4302 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
4303 void rep_hist_note_extend_succeeded(const char *from_name
,
4304 const char *to_name
);
4305 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
4306 void rep_hist_dump_stats(time_t now
, int severity
);
4307 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
4308 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
4309 void rep_hist_note_exit_bytes_read(uint16_t port
, size_t num_bytes
);
4310 void rep_hist_note_exit_bytes_written(uint16_t port
, size_t num_bytes
);
4311 void rep_hist_note_exit_stream_opened(uint16_t port
);
4312 void rep_hist_exit_stats_init(time_t now
);
4313 void rep_hist_exit_stats_write(time_t now
);
4314 int rep_hist_bandwidth_assess(void);
4315 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
4316 void rep_hist_update_state(or_state_t
*state
);
4317 int rep_hist_load_state(or_state_t
*state
, char **err
);
4318 void rep_history_clean(time_t before
);
4320 void rep_hist_note_router_reachable(const char *id
, time_t when
);
4321 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
4322 int rep_hist_record_mtbf_data(time_t now
, int missing_means_down
);
4323 int rep_hist_load_mtbf_data(time_t now
);
4325 time_t rep_hist_downrate_old_runs(time_t now
);
4326 double rep_hist_get_stability(const char *id
, time_t when
);
4327 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
4328 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
4329 int rep_hist_have_measured_enough_stability(void);
4330 const char *rep_hist_get_router_stability_doc(time_t now
);
4332 void rep_hist_note_used_port(time_t now
, uint16_t port
);
4333 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
4334 void rep_hist_note_used_resolve(time_t now
);
4335 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
4337 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
4338 int *need_capacity
);
4340 int any_predicted_circuits(time_t now
);
4341 int rep_hist_circbuilding_dormant(time_t now
);
4343 /** Possible public/private key operations in Tor: used to keep track of where
4344 * we're spending our time. */
4347 VERIFY_DIR
, VERIFY_RTR
,
4348 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4349 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4350 REND_CLIENT
, REND_MID
, REND_SERVER
,
4352 void note_crypto_pk_op(pk_op_t operation
);
4353 void dump_pk_ops(int severity
);
4355 void rep_hist_free_all(void);
4357 /* for hidden service usage statistics */
4358 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
4359 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
4360 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
4361 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
4362 void hs_usage_write_statistics_to_file(time_t now
);
4363 void hs_usage_free_all(void);
4365 void rep_hist_buffer_stats_init(time_t now
);
4366 void rep_hist_buffer_stats_add_circ(circuit_t
*circ
,
4367 time_t end_of_interval
);
4368 void rep_hist_buffer_stats_write(time_t now
);
4370 /********************************* rendclient.c ***************************/
4372 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
4373 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
4374 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
4375 size_t request_len
);
4376 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
4377 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
4378 const rend_data_t
*rend_query
);
4379 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
4380 size_t request_len
);
4381 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
4382 size_t request_len
);
4383 void rend_client_desc_trynow(const char *query
);
4385 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
4387 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
4388 origin_circuit_t
*rendcirc
);
4389 int rend_parse_service_authorization(or_options_t
*options
,
4391 rend_service_authorization_t
*rend_client_lookup_service_authorization(
4392 const char *onion_address
);
4393 void rend_service_authorization_free_all(void);
4394 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
4396 /********************************* rendcommon.c ***************************/
4398 /** Hidden-service side configuration of client authorization. */
4399 typedef struct rend_authorized_client_t
{
4401 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4402 crypto_pk_env_t
*client_key
;
4403 } rend_authorized_client_t
;
4405 /** ASCII-encoded v2 hidden service descriptor. */
4406 typedef struct rend_encoded_v2_service_descriptor_t
{
4407 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4408 char *desc_str
; /**< Descriptor string. */
4409 } rend_encoded_v2_service_descriptor_t
;
4411 /** Introduction point information. */
4412 typedef struct rend_intro_point_t
{
4413 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4414 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
4415 * key, if this descriptor is V2. */
4416 } rend_intro_point_t
;
4418 /** Information used to connect to a hidden service. */
4419 typedef struct rend_service_descriptor_t
{
4420 crypto_pk_env_t
*pk
; /**< This service's public key. */
4421 int version
; /**< Version of the descriptor format: 0 or 2. */
4422 time_t timestamp
; /**< Time when the descriptor was generated. */
4423 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
4424 * (We allow bits '0', '1', and '2' to be set.) */
4425 /** List of the service's introduction points. Elements are removed if
4426 * introduction attempts fail. */
4427 smartlist_t
*intro_nodes
;
4428 /** Has descriptor been uploaded to all hidden service directories? */
4429 int all_uploads_performed
;
4430 /** List of hidden service directories to which an upload request for
4431 * this descriptor could be sent. Smartlist exists only when at least one
4432 * of the previous upload requests failed (otherwise it's not important
4433 * to know which uploads succeeded and which not). */
4434 smartlist_t
*successful_uploads
;
4435 } rend_service_descriptor_t
;
4437 /** Free all storage associated with <b>data</b> */
4439 rend_data_free(rend_data_t
*data
)
4444 int rend_cmp_service_ids(const char *one
, const char *two
);
4446 void rend_process_relay_cell(circuit_t
*circ
, const crypt_path_t
*layer_hint
,
4447 int command
, size_t length
, const char *payload
);
4449 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
4450 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
4452 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
4453 void rend_encoded_v2_service_descriptor_free(
4454 rend_encoded_v2_service_descriptor_t
*desc
);
4455 void rend_intro_point_free(rend_intro_point_t
*intro
);
4457 /** A cached rendezvous descriptor. */
4458 typedef struct rend_cache_entry_t
{
4459 size_t len
; /**< Length of <b>desc</b> */
4460 time_t received
; /**< When was the descriptor received? */
4461 char *desc
; /**< Service descriptor */
4462 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
4463 } rend_cache_entry_t
;
4465 void rend_cache_init(void);
4466 void rend_cache_clean(void);
4467 void rend_cache_clean_v2_descs_as_dir(void);
4468 void rend_cache_free_all(void);
4469 int rend_valid_service_id(const char *query
);
4470 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
4472 int rend_cache_lookup_entry(const char *query
, int version
,
4473 rend_cache_entry_t
**entry_out
);
4474 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
4475 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
4476 int rend_cache_store_v2_desc_as_client(const char *desc
,
4477 const rend_data_t
*rend_query
);
4478 int rend_cache_store_v2_desc_as_dir(const char *desc
);
4479 int rend_cache_size(void);
4480 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
4481 rend_service_descriptor_t
*desc
, time_t now
,
4482 uint8_t period
, rend_auth_type_t auth_type
,
4483 crypto_pk_env_t
*client_key
,
4484 smartlist_t
*client_cookies
);
4485 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
4486 const char *descriptor_cookie
,
4487 time_t now
, uint8_t replica
);
4488 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4489 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4490 const char *service_id
,
4491 const char *secret_id_part
);
4493 /********************************* rendservice.c ***************************/
4495 int num_rend_services(void);
4496 int rend_config_services(or_options_t
*options
, int validate_only
);
4497 int rend_service_load_keys(void);
4498 void rend_services_init(void);
4499 void rend_services_introduce(void);
4500 void rend_consider_services_upload(time_t now
);
4501 void rend_hsdir_routers_changed(void);
4502 void rend_consider_descriptor_republication(void);
4504 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4505 int rend_service_intro_established(origin_circuit_t
*circuit
,
4506 const char *request
,
4507 size_t request_len
);
4508 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4509 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
4510 size_t request_len
);
4511 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4512 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4513 origin_circuit_t
*circ
);
4514 void rend_service_dump_stats(int severity
);
4515 void rend_service_free_all(void);
4517 /********************************* rendmid.c *******************************/
4518 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
4519 size_t request_len
);
4520 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
4521 size_t request_len
);
4522 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
4523 size_t request_len
);
4524 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
4525 size_t request_len
);
4527 /********************************* router.c ***************************/
4529 crypto_pk_env_t
*get_onion_key(void);
4530 time_t get_onion_key_set_at(void);
4531 void set_identity_key(crypto_pk_env_t
*k
);
4532 crypto_pk_env_t
*get_identity_key(void);
4533 int identity_key_is_set(void);
4534 authority_cert_t
*get_my_v3_authority_cert(void);
4535 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4536 authority_cert_t
*get_my_v3_legacy_cert(void);
4537 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4538 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4539 void rotate_onion_key(void);
4540 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4542 void v3_authority_check_key_expiry(void);
4544 int init_keys(void);
4546 int check_whether_orport_reachable(void);
4547 int check_whether_dirport_reachable(void);
4548 void consider_testing_reachability(int test_or
, int test_dir
);
4549 void router_orport_found_reachable(void);
4550 void router_dirport_found_reachable(void);
4551 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4553 int authdir_mode(or_options_t
*options
);
4554 int authdir_mode_v1(or_options_t
*options
);
4555 int authdir_mode_v2(or_options_t
*options
);
4556 int authdir_mode_v3(or_options_t
*options
);
4557 int authdir_mode_any_main(or_options_t
*options
);
4558 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4559 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4560 int authdir_mode_publishes_statuses(or_options_t
*options
);
4561 int authdir_mode_tests_reachability(or_options_t
*options
);
4562 int authdir_mode_bridge(or_options_t
*options
);
4564 int clique_mode(or_options_t
*options
);
4565 int server_mode(or_options_t
*options
);
4566 int advertised_server_mode(void);
4567 int proxy_mode(or_options_t
*options
);
4568 void consider_publishable_server(int force
);
4570 int router_is_clique_mode(routerinfo_t
*router
);
4571 void router_upload_dir_desc_to_dirservers(int force
);
4572 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4573 void mark_my_descriptor_dirty(void);
4574 void check_descriptor_bandwidth_changed(time_t now
);
4575 void check_descriptor_ipaddress_changed(time_t now
);
4576 void router_new_address_suggestion(const char *suggestion
,
4577 const dir_connection_t
*d_conn
);
4578 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4579 routerinfo_t
*router_get_my_routerinfo(void);
4580 extrainfo_t
*router_get_my_extrainfo(void);
4581 const char *router_get_my_descriptor(void);
4582 int router_digest_is_me(const char *digest
);
4583 int router_extrainfo_digest_is_me(const char *digest
);
4584 int router_is_me(routerinfo_t
*router
);
4585 int router_fingerprint_is_me(const char *fp
);
4586 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4587 int router_rebuild_descriptor(int force
);
4588 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4589 crypto_pk_env_t
*ident_key
);
4590 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4591 crypto_pk_env_t
*ident_key
);
4592 char *extrainfo_get_client_geoip_summary(time_t);
4593 int is_legal_nickname(const char *s
);
4594 int is_legal_nickname_or_hexdigest(const char *s
);
4595 int is_legal_hexdigest(const char *s
);
4596 void router_get_verbose_nickname(char *buf
, const routerinfo_t
*router
);
4597 void routerstatus_get_verbose_nickname(char *buf
,
4598 const routerstatus_t
*router
);
4599 void router_reset_warnings(void);
4600 void router_reset_reachability(void);
4601 void router_free_all(void);
4603 const char *router_purpose_to_string(uint8_t p
);
4604 uint8_t router_purpose_from_string(const char *s
);
4606 #ifdef ROUTER_PRIVATE
4607 /* Used only by router.c and test.c */
4608 void get_platform_str(char *platform
, size_t len
);
4611 /********************************* routerlist.c ***************************/
4613 /** Represents information about a single trusted directory server. */
4614 typedef struct trusted_dir_server_t
{
4617 char *address
; /**< Hostname. */
4618 uint32_t addr
; /**< IPv4 address. */
4619 uint16_t dir_port
; /**< Directory port. */
4620 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4621 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4622 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4623 * high-security) identity key. */
4625 unsigned int is_running
:1; /**< True iff we think this server is running. */
4627 /** True iff this server has accepted the most recent server descriptor
4628 * we tried to upload to it. */
4629 unsigned int has_accepted_serverdesc
:1;
4631 /** What kind of authority is this? (Bitfield.) */
4632 authority_type_t type
;
4634 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4635 * v2 network status. */
4636 time_t addr_current_at
; /**< When was the document that we derived the
4637 * address information from published? */
4639 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4640 * dir_server_t to directory_initiate_command_*
4641 * as a routerstatus_t. Not updated by the
4642 * router-status management code!
4644 } trusted_dir_server_t
;
4646 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
4648 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4650 int get_n_authorities(authority_type_t type
);
4651 int trusted_dirs_reload_certs(void);
4652 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4654 void trusted_dirs_flush_certs_to_disk(void);
4655 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4656 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4657 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4658 const char *sk_digest
);
4659 void authority_cert_get_all(smartlist_t
*certs_out
);
4660 void authority_cert_dl_failed(const char *id_digest
, int status
);
4661 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4662 int router_reload_router_list(void);
4663 smartlist_t
*router_get_trusted_dir_servers(void);
4665 /* Flags for pick_directory_server and pick_trusteddirserver. */
4666 /** Flag to indicate that we should not automatically be willing to use
4667 * ourself to answer a directory request.
4668 * Passed to router_pick_directory_server (et al).*/
4669 #define PDS_ALLOW_SELF (1<<0)
4670 /** Flag to indicate that if no servers seem to be up, we should mark all
4671 * directory servers as up and try again.
4672 * Passed to router_pick_directory_server (et al).*/
4673 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4674 /** Flag to indicate that we should not exclude directory servers that
4675 * our ReachableAddress settings would exclude. This usually means that
4676 * we're going to connect to the server over Tor, and so we don't need to
4677 * worry about our firewall telling us we can't.
4678 * Passed to router_pick_directory_server (et al).*/
4679 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4680 /** Flag to indicate that we should not use any directory authority to which
4681 * we have an existing directory connection for downloading server descriptors
4682 * or extrainfo documents.
4684 * Passed to router_pick_directory_server (et al)
4686 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
4687 * not pick_directory_server. If we make it work on pick_directory_server
4688 * too, we could conservatively make it only prevent multiple fetches to
4689 * the same authority, or we could aggressively make it prevent multiple
4690 * fetches to _any_ single directory server.]
4692 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4693 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4694 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4695 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4696 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4697 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4698 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4699 double *v3_share_out
);
4700 void router_reset_status_download_failures(void);
4701 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4702 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4703 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4704 int must_be_running
);
4705 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4706 routerinfo_t
*routerlist_find_my_routerinfo(void);
4707 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4709 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4710 int need_capacity
, int need_guard
);
4711 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4712 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4714 /** Possible ways to weight routers when choosing one randomly. See
4715 * routerlist_sl_choose_by_bandwidth() for more information.*/
4717 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4718 } bandwidth_weight_rule_t
;
4719 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4720 bandwidth_weight_rule_t rule
);
4721 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4723 /** Flags to be passed to control router_choose_random_node() to indicate what
4724 * kind of nodes to pick according to what algorithm. */
4726 CRN_NEED_UPTIME
= 1<<0,
4727 CRN_NEED_CAPACITY
= 1<<1,
4728 CRN_NEED_GUARD
= 1<<2,
4729 CRN_ALLOW_INVALID
= 1<<3,
4730 /* XXXX not used, apparently. */
4731 CRN_STRICT_PREFERRED
= 1<<4,
4732 /* XXXX not used, apparently. */
4733 CRN_WEIGHT_AS_EXIT
= 1<<5
4734 } router_crn_flags_t
;
4736 routerinfo_t
*router_choose_random_node(const char *preferred
,
4737 smartlist_t
*excludedsmartlist
,
4738 struct routerset_t
*excludedset
,
4739 router_crn_flags_t flags
);
4741 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4742 int warn_if_unnamed
);
4743 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4744 int router_digest_is_trusted_dir_type(const char *digest
,
4745 authority_type_t type
);
4746 #define router_digest_is_trusted_dir(d) \
4747 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4749 int router_addr_is_trusted_dir(uint32_t addr
);
4750 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4751 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4752 routerinfo_t
*router_get_by_digest(const char *digest
);
4753 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4754 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4755 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4756 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4757 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4758 routerlist_t
*router_get_routerlist(void);
4759 void routerinfo_free(routerinfo_t
*router
);
4760 void extrainfo_free(extrainfo_t
*extrainfo
);
4761 void routerlist_free(routerlist_t
*rl
);
4762 void dump_routerlist_mem_usage(int severity
);
4763 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
,
4765 void routerlist_free_all(void);
4766 void routerlist_reset_warnings(void);
4767 void router_set_status(const char *digest
, int up
);
4769 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
4770 typedef enum was_router_added_t
{
4771 ROUTER_ADDED_SUCCESSFULLY
= 1,
4772 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
4774 ROUTER_WAS_NOT_NEW
= -2,
4775 ROUTER_NOT_IN_CONSENSUS
= -3,
4776 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
4777 ROUTER_AUTHDIR_REJECTS
= -5,
4778 } was_router_added_t
;
4780 static int WRA_WAS_ADDED(was_router_added_t s
);
4781 static int WRA_WAS_OUTDATED(was_router_added_t s
);
4782 static int WRA_WAS_REJECTED(was_router_added_t s
);
4783 /** Return true iff the descriptor was added. It might still be necessary to
4784 * check whether the descriptor generator should be notified.
4787 WRA_WAS_ADDED(was_router_added_t s
) {
4788 return s
== ROUTER_ADDED_SUCCESSFULLY
|| s
== ROUTER_ADDED_NOTIFY_GENERATOR
;
4790 /** Return true iff the descriptor was not added because it was either:
4791 * - not in the consensus
4792 * - neither in the consensus nor in any networkstatus document
4793 * - it was outdated.
4795 static INLINE
int WRA_WAS_OUTDATED(was_router_added_t s
)
4797 return (s
== ROUTER_WAS_NOT_NEW
||
4798 s
== ROUTER_NOT_IN_CONSENSUS
||
4799 s
== ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
);
4801 /** Return true iff the descriptor rejected because it was malformed. */
4802 static INLINE
int WRA_WAS_REJECTED(was_router_added_t s
)
4804 return (s
== ROUTER_AUTHDIR_REJECTS
);
4806 was_router_added_t
router_add_to_routerlist(routerinfo_t
*router
,
4810 was_router_added_t
router_add_extrainfo_to_routerlist(
4811 extrainfo_t
*ei
, const char **msg
,
4812 int from_cache
, int from_fetch
);
4813 void routerlist_remove_old_routers(void);
4814 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4816 int router_load_routers_from_string(const char *s
, const char *eos
,
4817 saved_location_t saved_location
,
4818 smartlist_t
*requested_fingerprints
,
4819 int descriptor_digests
,
4820 const char *prepend_annotations
);
4821 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4822 saved_location_t saved_location
,
4823 smartlist_t
*requested_fingerprints
,
4824 int descriptor_digests
);
4825 void routerlist_retry_directory_downloads(time_t now
);
4826 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4828 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4829 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4830 const char *address
,
4831 uint16_t dir_port
, uint16_t or_port
,
4832 const char *digest
, const char *v3_auth_digest
,
4833 authority_type_t type
);
4834 void authority_cert_free(authority_cert_t
*cert
);
4835 void clear_trusted_dir_servers(void);
4836 int any_trusted_dir_is_v1_authority(void);
4837 void update_router_descriptor_downloads(time_t now
);
4838 void update_extrainfo_downloads(time_t now
);
4839 int router_have_minimum_dir_info(void);
4840 void router_dir_info_changed(void);
4841 const char *get_dir_info_status_string(void);
4842 int count_loading_descriptors_progress(void);
4843 void router_reset_descriptor_download_failures(void);
4844 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
4845 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
4846 signed_descriptor_t
*sd
,
4848 void routerlist_assert_ok(routerlist_t
*rl
);
4849 const char *esc_router_info(routerinfo_t
*router
);
4850 void routers_sort_by_identity(smartlist_t
*routers
);
4852 routerset_t
*routerset_new(void);
4853 int routerset_parse(routerset_t
*target
, const char *s
,
4854 const char *description
);
4855 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
4856 int routerset_is_list(const routerset_t
*set
);
4857 int routerset_needs_geoip(const routerset_t
*set
);
4858 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
4859 int routerset_contains_routerstatus(const routerset_t
*set
,
4860 routerstatus_t
*rs
);
4861 int routerset_contains_extendinfo(const routerset_t
*set
,
4862 const extend_info_t
*ei
);
4863 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
4865 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
4866 const routerset_t
*include
,
4867 const routerset_t
*exclude
, int running_only
);
4868 void routerset_subtract_routers(smartlist_t
*out
,
4869 const routerset_t
*routerset
);
4870 char *routerset_to_string(const routerset_t
*routerset
);
4871 void routerset_refresh_countries(routerset_t
*target
);
4872 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
4873 void routerset_free(routerset_t
*routerset
);
4874 void routerinfo_set_country(routerinfo_t
*ri
);
4875 void routerlist_refresh_countries(void);
4876 void refresh_all_country_info(void);
4878 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
4880 int hid_serv_acting_as_directory(void);
4881 int hid_serv_responsible_for_desc_id(const char *id
);
4883 /********************************* routerparse.c ************************/
4885 #define MAX_STATUS_TAG_LEN 32
4886 /** Structure to hold parsed Tor versions. This is a little messier
4887 * than we would like it to be, because we changed version schemes with 0.1.0.
4889 * See version-spec.txt for the whole business.
4891 typedef struct tor_version_t
{
4895 /** Release status. For version in the post-0.1 format, this is always
4897 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4899 char status_tag
[MAX_STATUS_TAG_LEN
];
4903 char git_tag
[DIGEST_LEN
];
4906 int router_get_router_hash(const char *s
, char *digest
);
4907 int router_get_dir_hash(const char *s
, char *digest
);
4908 int router_get_runningrouters_hash(const char *s
, char *digest
);
4909 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
4910 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
4911 int router_get_extrainfo_hash(const char *s
, char *digest
);
4912 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
4914 crypto_pk_env_t
*private_key
);
4915 int router_parse_list_from_string(const char **s
, const char *eos
,
4917 saved_location_t saved_location
,
4919 int allow_annotations
,
4920 const char *prepend_annotations
);
4921 int router_parse_routerlist_from_directory(const char *s
,
4922 routerlist_t
**dest
,
4923 crypto_pk_env_t
*pkey
,
4925 int write_to_cache
);
4926 int router_parse_runningrouters(const char *str
);
4927 int router_parse_directory(const char *str
);
4928 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
4930 int allow_annotations
,
4931 const char *prepend_annotations
);
4932 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
4933 int cache_copy
, struct digest_ri_map_t
*routermap
);
4934 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
4936 version_status_t
tor_version_is_obsolete(const char *myversion
,
4937 const char *versionlist
);
4938 int tor_version_parse(const char *s
, tor_version_t
*out
);
4939 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
4940 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
4941 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
4942 void assert_addr_policy_ok(smartlist_t
*t
);
4943 void dump_distinct_digest_count(int severity
);
4945 int compare_routerstatus_entries(const void **_a
, const void **_b
);
4946 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
4947 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
4948 const char **eos_out
,
4949 networkstatus_type_t ns_type
);
4950 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
4951 const char *s
, const char *eos
);
4953 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
4954 const char **end_of_string
);
4955 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
4957 char **intro_points_encrypted_out
,
4958 size_t *intro_points_encrypted_size_out
,
4959 size_t *encoded_size_out
,
4960 const char **next_out
, const char *desc
);
4961 int rend_decrypt_introduction_points(char **ipos_decrypted
,
4962 size_t *ipos_decrypted_size
,
4963 const char *descriptor_cookie
,
4964 const char *ipos_encrypted
,
4965 size_t ipos_encrypted_size
);
4966 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
4967 const char *intro_points_encoded
,
4968 size_t intro_points_encoded_size
);
4969 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);