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