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-2008, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
10 * \brief Master header file for Tor-specific functionality.
15 #define OR_H_ID "$Id$"
19 #define WIN32_WINNT 0x400
20 #define _WIN32_WINNT 0x400
21 #define WIN32_LEAN_AND_MEAN
33 #ifdef HAVE_SYS_PARAM_H
34 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
37 #ifdef HAVE_SYS_WAIT_H
40 #ifdef HAVE_SYS_FCNTL_H
41 #include <sys/fcntl.h>
46 #ifdef HAVE_SYS_IOCTL_H
47 #include <sys/ioctl.h>
52 #ifdef HAVE_SYS_STAT_H
55 #ifdef HAVE_ARPA_INET_H
56 #include <arpa/inet.h>
73 #define snprintf _snprintf
80 #include "container.h"
87 /* These signals are defined to help control_signal_act work.
104 /* Controller signals start at a high number so we don't
105 * conflict with system-defined signals. */
106 #define SIGNEWNYM 129
107 #define SIGCLEARDNSCACHE 130
109 #if (SIZEOF_CELL_T != 0)
110 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
111 * that our stuff always calls cell_t something different. */
112 #define cell_t tor_cell_t
115 /** Length of longest allowable configured nickname. */
116 #define MAX_NICKNAME_LEN 19
117 /** Length of a router identity encoded as a hexadecimal digest, plus
118 * possible dollar sign. */
119 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
120 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
121 * equal sign or tilde, nickname. */
122 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
124 /** Maximum size, in bytes, for resized buffers. */
125 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
126 /** Maximum size, in bytes, for any directory object that we've downloaded. */
127 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
129 /** For http parsing: Maximum number of bytes we'll accept in the headers
130 * of an HTTP request or response. */
131 #define MAX_HEADERS_SIZE 50000
132 /** Maximum size, in bytes, for any directory object that we're accepting
134 #define MAX_DIR_UL_SIZE 500000
136 /** Maximum size, in bytes, of a single router descriptor uploaded to us
137 * as a directory authority. Caches and clients fetch whatever descriptors
138 * the authorities tell them to fetch, and don't care about size. */
139 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
141 /** Maximum size of a single extrainfo document, as above. */
142 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
144 /** How long do we keep DNS cache entries before purging them (regardless of
146 #define MAX_DNS_ENTRY_AGE (30*60)
147 /** How long do we cache/tell clients to cache DNS records when no TTL is
149 #define DEFAULT_DNS_TTL (30*60)
150 /** How long can a TTL be before we stop believing it? */
151 #define MAX_DNS_TTL (3*60*60)
152 /** How small can a TTL be before we stop believing it? Provides rudimentary
154 #define MIN_DNS_TTL (60)
156 /** How often do we rotate onion keys? */
157 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
158 /** How often do we rotate TLS contexts? */
159 #define MAX_SSL_KEY_LIFETIME (2*60*60)
161 /** How old do we allow a router to get before removing it
162 * from the router list? In seconds. */
163 #define ROUTER_MAX_AGE (60*60*48)
164 /** How old can a router get before we (as a server) will no longer
165 * consider it live? In seconds. */
166 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
167 /** How old do we let a saved descriptor get before force-removing it? */
168 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
170 /** Possible rules for generating circuit IDs on an OR connection. */
172 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
173 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
174 /** The other side of a connection is an OP: never create circuits to it,
175 * and let it use any circuit ID it wants. */
176 CIRC_ID_TYPE_NEITHER
=2
179 #define _CONN_TYPE_MIN 3
180 /** Type for sockets listening for OR connections. */
181 #define CONN_TYPE_OR_LISTENER 3
182 /** A bidirectional TLS connection transmitting a sequence of cells.
183 * May be from an OR to an OR, or from an OP to an OR. */
184 #define CONN_TYPE_OR 4
185 /** A TCP connection from an onion router to a stream's destination. */
186 #define CONN_TYPE_EXIT 5
187 /** Type for sockets listening for SOCKS connections. */
188 #define CONN_TYPE_AP_LISTENER 6
189 /** A SOCKS proxy connection from the user application to the onion
191 #define CONN_TYPE_AP 7
192 /** Type for sockets listening for HTTP connections to the directory server. */
193 #define CONN_TYPE_DIR_LISTENER 8
194 /** Type for HTTP connections to the directory server. */
195 #define CONN_TYPE_DIR 9
196 /** Connection from the main process to a CPU worker process. */
197 #define CONN_TYPE_CPUWORKER 10
198 /** Type for listening for connections from user interface process. */
199 #define CONN_TYPE_CONTROL_LISTENER 11
200 /** Type for connections from user interface process. */
201 #define CONN_TYPE_CONTROL 12
202 /** Type for sockets listening for transparent connections redirected by pf or
204 #define CONN_TYPE_AP_TRANS_LISTENER 13
205 /** Type for sockets listening for transparent connections redirected by
207 #define CONN_TYPE_AP_NATD_LISTENER 14
208 /** Type for sockets listening for DNS requests. */
209 #define CONN_TYPE_AP_DNS_LISTENER 15
210 #define _CONN_TYPE_MAX 15
211 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
214 #define CONN_IS_EDGE(x) \
215 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
217 /** State for any listener connection. */
218 #define LISTENER_STATE_READY 0
220 #define _CPUWORKER_STATE_MIN 1
221 /** State for a connection to a cpuworker process that's idle. */
222 #define CPUWORKER_STATE_IDLE 1
223 /** State for a connection to a cpuworker process that's processing a
225 #define CPUWORKER_STATE_BUSY_ONION 2
226 #define _CPUWORKER_STATE_MAX 2
228 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
230 #define _OR_CONN_STATE_MIN 1
231 /** State for a connection to an OR: waiting for connect() to finish. */
232 #define OR_CONN_STATE_CONNECTING 1
233 /** State for a connection to an OR: waiting for proxy command to flush. */
234 #define OR_CONN_STATE_PROXY_FLUSHING 2
235 /** State for a connection to an OR: waiting for proxy response. */
236 #define OR_CONN_STATE_PROXY_READING 3
237 /** State for a connection to an OR or client: SSL is handshaking, not done
239 #define OR_CONN_STATE_TLS_HANDSHAKING 4
240 /** State for a connection to an OR: We're doing a second SSL handshake for
241 * renegotiation purposes. */
242 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 5
243 /** State for a connection at an OR: We're waiting for the client to
245 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 6
246 /** State for a connection to an OR: We're done with our SSL handshake, but we
247 * haven't yet negotiated link protocol versions and sent a netinfo cell.
249 #define OR_CONN_STATE_OR_HANDSHAKING 7
250 /** State for a connection to an OR: Ready to send/receive cells. */
251 #define OR_CONN_STATE_OPEN 8
252 #define _OR_CONN_STATE_MAX 8
254 #define _EXIT_CONN_STATE_MIN 1
255 /** State for an exit connection: waiting for response from dns farm. */
256 #define EXIT_CONN_STATE_RESOLVING 1
257 /** State for an exit connection: waiting for connect() to finish. */
258 #define EXIT_CONN_STATE_CONNECTING 2
259 /** State for an exit connection: open and ready to transmit data. */
260 #define EXIT_CONN_STATE_OPEN 3
261 /** State for an exit connection: waiting to be removed. */
262 #define EXIT_CONN_STATE_RESOLVEFAILED 4
263 #define _EXIT_CONN_STATE_MAX 4
265 /* The AP state values must be disjoint from the EXIT state values. */
266 #define _AP_CONN_STATE_MIN 5
267 /** State for a SOCKS connection: waiting for SOCKS request. */
268 #define AP_CONN_STATE_SOCKS_WAIT 5
269 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
270 * rendezvous descriptor. */
271 #define AP_CONN_STATE_RENDDESC_WAIT 6
272 /** The controller will attach this connection to a circuit; it isn't our
274 #define AP_CONN_STATE_CONTROLLER_WAIT 7
275 /** State for a SOCKS connection: waiting for a completed circuit. */
276 #define AP_CONN_STATE_CIRCUIT_WAIT 8
277 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
278 #define AP_CONN_STATE_CONNECT_WAIT 9
279 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
280 #define AP_CONN_STATE_RESOLVE_WAIT 10
281 /** State for a SOCKS connection: ready to send and receive. */
282 #define AP_CONN_STATE_OPEN 11
283 /** State for a transparent natd connection: waiting for original
285 #define AP_CONN_STATE_NATD_WAIT 12
286 #define _AP_CONN_STATE_MAX 12
288 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
289 * edge connection is not attached to any circuit. */
290 #define AP_CONN_STATE_IS_UNATTACHED(s) \
291 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
293 #define _DIR_CONN_STATE_MIN 1
294 /** State for connection to directory server: waiting for connect(). */
295 #define DIR_CONN_STATE_CONNECTING 1
296 /** State for connection to directory server: sending HTTP request. */
297 #define DIR_CONN_STATE_CLIENT_SENDING 2
298 /** State for connection to directory server: reading HTTP response. */
299 #define DIR_CONN_STATE_CLIENT_READING 3
300 /** State for connection to directory server: happy and finished. */
301 #define DIR_CONN_STATE_CLIENT_FINISHED 4
302 /** State for connection at directory server: waiting for HTTP request. */
303 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
304 /** State for connection at directory server: sending HTTP response. */
305 #define DIR_CONN_STATE_SERVER_WRITING 6
306 #define _DIR_CONN_STATE_MAX 6
308 /** True iff the purpose of <b>conn</b> means that it's a server-side
309 * directory connection. */
310 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
312 #define _CONTROL_CONN_STATE_MIN 1
313 /** State for a control connection: Authenticated and accepting v1 commands. */
314 #define CONTROL_CONN_STATE_OPEN 1
315 /** State for a control connection: Waiting for authentication; speaking
317 #define CONTROL_CONN_STATE_NEEDAUTH 2
318 #define _CONTROL_CONN_STATE_MAX 2
320 #define _DIR_PURPOSE_MIN 1
321 /** A connection to a directory server: download a directory. */
322 #define DIR_PURPOSE_FETCH_DIR 1
323 /** A connection to a directory server: download just the list
324 * of running routers. */
325 #define DIR_PURPOSE_FETCH_RUNNING_LIST 2
326 /** A connection to a directory server: download a rendezvous
328 #define DIR_PURPOSE_FETCH_RENDDESC 3
329 /** A connection to a directory server: set after a rendezvous
330 * descriptor is downloaded. */
331 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
332 /** A connection to a directory server: download one or more v2
333 * network-status objects */
334 #define DIR_PURPOSE_FETCH_NETWORKSTATUS 5
335 /** A connection to a directory server: download one or more server
337 #define DIR_PURPOSE_FETCH_SERVERDESC 6
338 /** A connection to a directory server: download one or more extra-info
340 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
341 /** A connection to a directory server: upload a server descriptor. */
342 #define DIR_PURPOSE_UPLOAD_DIR 8
343 /** A connection to a directory server: upload a rendezvous
345 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
346 /** A connection to a directory server: upload a v3 networkstatus vote. */
347 #define DIR_PURPOSE_UPLOAD_VOTE 10
348 /** A connection to a directory server: upload a v3 consensus signature */
349 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
350 /** A connection to a directory server: download one or more network-status
351 * objects [XXX wtf, these are all the same comment] */
352 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
353 /** A connection to a directory server: download one or more network-status
355 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
356 /** A connection to a directory server: download one or more network-status
358 #define DIR_PURPOSE_FETCH_CONSENSUS 14
359 /** A connection to a directory server: download one or more network-status
361 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
363 /** Purpose for connection at a directory server. */
364 #define DIR_PURPOSE_SERVER 16
365 /** A connection to a hidden service directory server: upload a v2 rendezvous
367 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
368 /** A connection to a hidden service directory server: download a v2 rendezvous
370 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
371 #define _DIR_PURPOSE_MAX 18
373 #define DIR_PURPOSE_IS_UPLOAD(p) \
374 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
375 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
376 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
377 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
379 #define _EXIT_PURPOSE_MIN 1
380 /** This exit stream wants to do an ordinary connect. */
381 #define EXIT_PURPOSE_CONNECT 1
382 /** This exit stream wants to do a resolve (either normal or reverse). */
383 #define EXIT_PURPOSE_RESOLVE 2
384 #define _EXIT_PURPOSE_MAX 2
386 /* !!!! If any connection purpose is ever over over 31, we must grow the type
387 * field in connection_t. */
389 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
390 #define CIRCUIT_STATE_BUILDING 0
391 /** Circuit state: Waiting to process the onionskin. */
392 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
393 /** Circuit state: I'd like to deliver a create, but my n_conn is still
395 #define CIRCUIT_STATE_OR_WAIT 2
396 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
397 #define CIRCUIT_STATE_OPEN 3
399 #define _CIRCUIT_PURPOSE_MIN 1
401 /* these circuits were initiated elsewhere */
402 #define _CIRCUIT_PURPOSE_OR_MIN 1
403 /** OR-side circuit purpose: normal circuit, at OR. */
404 #define CIRCUIT_PURPOSE_OR 1
405 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
406 #define CIRCUIT_PURPOSE_INTRO_POINT 2
407 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
408 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
409 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
410 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
411 #define _CIRCUIT_PURPOSE_OR_MAX 4
413 /* these circuits originate at this node */
415 /* here's how circ client-side purposes work:
416 * normal circuits are C_GENERAL.
417 * circuits that are c_introducing are either on their way to
418 * becoming open, or they are open and waiting for a
419 * suitable rendcirc before they send the intro.
420 * circuits that are c_introduce_ack_wait have sent the intro,
421 * but haven't gotten a response yet.
422 * circuits that are c_establish_rend are either on their way
423 * to becoming open, or they are open and have sent the
424 * establish_rendezvous cell but haven't received an ack.
425 * circuits that are c_rend_ready are open and have received a
426 * rend ack, but haven't heard from bob yet. if they have a
427 * buildstate->pending_final_cpath then they're expecting a
428 * cell from bob, else they're not.
429 * circuits that are c_rend_ready_intro_acked are open, and
430 * some intro circ has sent its intro and received an ack.
431 * circuits that are c_rend_joined are open, have heard from
432 * bob, and are talking to him.
434 /** Client-side circuit purpose: Normal circuit, with cpath. */
435 #define CIRCUIT_PURPOSE_C_GENERAL 5
436 /** Client-side circuit purpose: at Alice, connecting to intro point. */
437 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
438 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
439 * waiting for ACK/NAK. */
440 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
441 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
442 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
443 /** Client-side circuit purpose: at Alice, waiting for ack. */
444 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
445 /** Client-side circuit purpose: at Alice, waiting for Bob. */
446 #define CIRCUIT_PURPOSE_C_REND_READY 10
447 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
448 * has been acknowledged. */
449 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
450 /** Client-side circuit purpose: at Alice, rendezvous established. */
451 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
453 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
454 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
455 /** Hidden-service-side circuit purpose: at Bob, successfully established
457 #define CIRCUIT_PURPOSE_S_INTRO 14
458 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
459 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
460 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
461 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
462 /** A testing circuit; not meant to be used for actual traffic. */
463 #define CIRCUIT_PURPOSE_TESTING 17
464 /** A controller made this circuit and Tor should not use it. */
465 #define CIRCUIT_PURPOSE_CONTROLLER 18
466 #define _CIRCUIT_PURPOSE_MAX 18
467 /** A catch-all for unrecognized purposes. Currently we don't expect
468 * to make or see any circuits with this purpose. */
469 #define CIRCUIT_PURPOSE_UNKNOWN 255
471 /** True iff the circuit purpose <b>p</b> is for a circuit that
472 * originated at this node. */
473 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
474 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
476 /** How many circuits do we want simultaneously in-progress to handle
478 #define MIN_CIRCUITS_HANDLING_STREAM 2
480 #define RELAY_COMMAND_BEGIN 1
481 #define RELAY_COMMAND_DATA 2
482 #define RELAY_COMMAND_END 3
483 #define RELAY_COMMAND_CONNECTED 4
484 #define RELAY_COMMAND_SENDME 5
485 #define RELAY_COMMAND_EXTEND 6
486 #define RELAY_COMMAND_EXTENDED 7
487 #define RELAY_COMMAND_TRUNCATE 8
488 #define RELAY_COMMAND_TRUNCATED 9
489 #define RELAY_COMMAND_DROP 10
490 #define RELAY_COMMAND_RESOLVE 11
491 #define RELAY_COMMAND_RESOLVED 12
492 #define RELAY_COMMAND_BEGIN_DIR 13
494 #define RELAY_COMMAND_ESTABLISH_INTRO 32
495 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
496 #define RELAY_COMMAND_INTRODUCE1 34
497 #define RELAY_COMMAND_INTRODUCE2 35
498 #define RELAY_COMMAND_RENDEZVOUS1 36
499 #define RELAY_COMMAND_RENDEZVOUS2 37
500 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
501 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
502 #define RELAY_COMMAND_INTRODUCE_ACK 40
504 /* Reasons why an OR connection is closed */
505 #define END_OR_CONN_REASON_DONE 1
506 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
507 #define END_OR_CONN_REASON_OR_IDENTITY 3
508 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
509 #define END_OR_CONN_REASON_TIMEOUT 5
510 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
511 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
512 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
513 #define END_OR_CONN_REASON_MISC 9
515 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
516 * documentation of these. */
517 #define END_STREAM_REASON_MISC 1
518 #define END_STREAM_REASON_RESOLVEFAILED 2
519 #define END_STREAM_REASON_CONNECTREFUSED 3
520 #define END_STREAM_REASON_EXITPOLICY 4
521 #define END_STREAM_REASON_DESTROY 5
522 #define END_STREAM_REASON_DONE 6
523 #define END_STREAM_REASON_TIMEOUT 7
524 /* 8 is unallocated for historical reasons. */
525 #define END_STREAM_REASON_HIBERNATING 9
526 #define END_STREAM_REASON_INTERNAL 10
527 #define END_STREAM_REASON_RESOURCELIMIT 11
528 #define END_STREAM_REASON_CONNRESET 12
529 #define END_STREAM_REASON_TORPROTOCOL 13
530 #define END_STREAM_REASON_NOTDIRECTORY 14
531 #define END_STREAM_REASON_ENTRYPOLICY 15
533 /* These high-numbered end reasons are not part of the official spec,
534 * and are not intended to be put in relay end cells. They are here
535 * to be more informative when sending back socks replies to the
537 /* XXXX 256 is no longer used; feel free to reuse it. */
538 /** We were unable to attach the connection to any circuit at all. */
539 /* XXXX the ways we use this one don't make a lot of sense. */
540 #define END_STREAM_REASON_CANT_ATTACH 257
541 /** We can't connect to any directories at all, so we killed our streams
542 * before they can time out. */
543 #define END_STREAM_REASON_NET_UNREACHABLE 258
544 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
545 * protocol in a way we couldn't handle. */
546 #define END_STREAM_REASON_SOCKSPROTOCOL 259
547 /** This is a transparent proxy connection, but we can't extract the original
548 * target address:port. */
549 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
550 /** This is a connection on the NATD port, and the destination IP:Port was
551 * either ill-formed or out-of-range. */
552 #define END_STREAM_REASON_INVALID_NATD_DEST 261
554 /** Bitwise-and this value with endreason to mask out all flags. */
555 #define END_STREAM_REASON_MASK 511
557 /** Bitwise-or this with the argument to control_event_stream_status
558 * to indicate that the reason came from an END cell. */
559 #define END_STREAM_REASON_FLAG_REMOTE 512
560 /** Bitwise-or this with the argument to control_event_stream_status
561 * to indicate that we already sent a CLOSED stream event. */
562 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
563 /** Bitwise-or this with endreason to indicate that we already sent
564 * a socks reply, and no further reply needs to be sent from
565 * connection_mark_unattached_ap(). */
566 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
568 /** Reason for remapping an AP connection's address: we have a cached
570 #define REMAP_STREAM_SOURCE_CACHE 1
571 /** Reason for remapping an AP connection's address: the exit node told us an
573 #define REMAP_STREAM_SOURCE_EXIT 2
575 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
576 #define RESOLVED_TYPE_HOSTNAME 0
577 #define RESOLVED_TYPE_IPV4 4
578 #define RESOLVED_TYPE_IPV6 6
579 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
580 #define RESOLVED_TYPE_ERROR 0xF1
582 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
583 * call; they only go to the controller for tracking */
584 /** We couldn't build a path for this circuit. */
585 #define END_CIRC_REASON_NOPATH -2
586 /** Catch-all "other" reason for closing origin circuits. */
587 #define END_CIRC_AT_ORIGIN -1
589 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
590 * documentation of these. */
591 #define _END_CIRC_REASON_MIN 0
592 #define END_CIRC_REASON_NONE 0
593 #define END_CIRC_REASON_TORPROTOCOL 1
594 #define END_CIRC_REASON_INTERNAL 2
595 #define END_CIRC_REASON_REQUESTED 3
596 #define END_CIRC_REASON_HIBERNATING 4
597 #define END_CIRC_REASON_RESOURCELIMIT 5
598 #define END_CIRC_REASON_CONNECTFAILED 6
599 #define END_CIRC_REASON_OR_IDENTITY 7
600 #define END_CIRC_REASON_OR_CONN_CLOSED 8
601 #define END_CIRC_REASON_FINISHED 9
602 #define END_CIRC_REASON_TIMEOUT 10
603 #define END_CIRC_REASON_DESTROYED 11
604 #define END_CIRC_REASON_NOSUCHSERVICE 12
605 #define _END_CIRC_REASON_MAX 12
607 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
608 * control_event_circuit_status() to indicate that the reason was
609 * passed through from a destroy or truncate cell. */
610 #define END_CIRC_REASON_FLAG_REMOTE 512
612 /** Length of 'y' portion of 'y.onion' URL. */
613 #define REND_SERVICE_ID_LEN_BASE32 16
615 /** Length of 'y.onion' including '.onion' URL. */
616 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
618 /** Length of a binary-encoded rendezvous service ID. */
619 #define REND_SERVICE_ID_LEN 10
621 /** Time period for which a v2 descriptor will be valid. */
622 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
624 /** Time period within which two sets of v2 descriptors will be uploaded in
626 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
628 /** Number of non-consecutive replicas (i.e. distributed somewhere
629 * in the ring) for a descriptor. */
630 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
632 /** Number of consecutive replicas for a descriptor. */
633 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
635 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
636 #define REND_DESC_ID_V2_LEN_BASE32 32
638 /** Length of the base32-encoded secret ID part of versioned hidden service
640 #define REND_SECRET_ID_PART_LEN_BASE32 32
642 /** Length of the base32-encoded hash of an introduction point's
644 #define REND_INTRO_POINT_ID_LEN_BASE32 32
646 /** Length of the descriptor cookie that is used for client authorization
647 * to hidden services. */
648 #define REND_DESC_COOKIE_LEN 16
650 /** Length of the base64-encoded descriptor cookie that is used for
651 * exchanging client authorization between hidden service and client. */
652 #define REND_DESC_COOKIE_LEN_BASE64 22
654 /** Length of client identifier in encrypted introduction points for hidden
655 * service authorization type 'basic'. */
656 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
658 /** Multiple of the number of clients to which the real number of clients
659 * is padded with fake clients for hidden service authorization type
661 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
663 /** Length of client entry consisting of client identifier and encrypted
664 * session key for hidden service authorization type 'basic'. */
665 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
668 /** Maximum size of v2 hidden service descriptors. */
669 #define REND_DESC_MAX_SIZE (20 * 1024)
671 /** Legal characters for use in authorized client names for a hidden
673 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
674 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
676 /** Maximum length of authorized client names for a hidden service. */
677 #define REND_CLIENTNAME_MAX_LEN 16
679 /** Length of the rendezvous cookie that is used to connect circuits at the
680 * rendezvous point. */
681 #define REND_COOKIE_LEN DIGEST_LEN
683 /** Client authorization type that a hidden service performs. */
684 typedef enum rend_auth_type_t
{
687 REND_STEALTH_AUTH
= 2,
690 /** Client-side configuration of authorization for a hidden service. */
691 typedef struct rend_service_authorization_t
{
692 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
693 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
694 rend_auth_type_t auth_type
;
695 } rend_service_authorization_t
;
697 /** Client- and server-side data that is used for hidden service connection
698 * establishment. Not all fields contain data depending on where this struct
700 typedef struct rend_data_t
{
701 /** Onion address (without the .onion part) that a client requests. */
702 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
704 /** (Optional) descriptor cookie that is used by a client. */
705 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
707 /** Authorization type for accessing a service used by a client. */
708 rend_auth_type_t auth_type
;
710 /** Hash of the hidden service's PK used by a service. */
711 char rend_pk_digest
[DIGEST_LEN
];
713 /** Rendezvous cookie used by both, client and service. */
714 char rend_cookie
[REND_COOKIE_LEN
];
716 /** Rendezvous descriptor version that is used by a service. Used to
717 * distinguish introduction and rendezvous points belonging to the same
718 * rendezvous service ID, but different descriptor versions.
720 uint8_t rend_desc_version
;
723 /** Time interval for tracking possible replays of INTRODUCE2 cells.
724 * Incoming cells with timestamps half of this interval in the past or
725 * future are dropped immediately. */
726 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
728 #define CELL_DIRECTION_IN 1
729 #define CELL_DIRECTION_OUT 2
731 /** Initial value for both sides of a circuit transmission window when the
732 * circuit is initialized. Measured in cells. */
733 #define CIRCWINDOW_START 1000
734 /** Amount to increment a circuit window when we get a circuit SENDME. */
735 #define CIRCWINDOW_INCREMENT 100
736 /** Initial value on both sides of a stream transmission window when the
737 * stream is initialized. Measured in cells. */
738 #define STREAMWINDOW_START 500
739 /** Amount to increment a stream window when we get a stream SENDME. */
740 #define STREAMWINDOW_INCREMENT 50
743 #define CELL_PADDING 0
744 #define CELL_CREATE 1
745 #define CELL_CREATED 2
747 #define CELL_DESTROY 4
748 #define CELL_CREATE_FAST 5
749 #define CELL_CREATED_FAST 6
750 #define CELL_VERSIONS 7
751 #define CELL_NETINFO 8
752 #define CELL_RELAY_EARLY 9
754 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
756 /** How long to test reachability before complaining to the user. */
757 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
759 /** Legal characters in a nickname. */
760 #define LEGAL_NICKNAME_CHARACTERS \
761 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
763 /** Name to use in client TLS certificates if no nickname is given. Once
764 * Tor 0.1.2.x is obsolete, we can remove this. */
765 #define DEFAULT_CLIENT_NICKNAME "client"
767 /** Number of bytes in a SOCKS4 header. */
768 #define SOCKS4_NETWORK_LEN 8
772 * Relay command [1 byte]
773 * Recognized [2 bytes]
774 * Stream ID [2 bytes]
775 * Partial SHA-1 [4 bytes]
777 * Relay payload [498 bytes]
780 /** Number of bytes in a cell, minus cell header. */
781 #define CELL_PAYLOAD_SIZE 509
782 /** Number of bytes in a cell transmitted over the network. */
783 #define CELL_NETWORK_SIZE 512
785 #define VAR_CELL_HEADER_SIZE 5
787 /** Number of bytes in a relay cell's header (not including general cell
789 #define RELAY_HEADER_SIZE (1+2+2+4+2)
790 /** Largest number of bytes that can fit in a relay cell payload. */
791 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
793 /** Identifies a circuit on an or_connection */
794 typedef uint16_t circid_t
;
795 /** Identifies a stream on a circuit */
796 typedef uint16_t streamid_t
;
798 /** Parsed onion routing cell. All communication between nodes
800 typedef struct cell_t
{
801 circid_t circ_id
; /**< Circuit which received the cell. */
802 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
803 * CELL_DESTROY, etc */
804 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
807 /** Parsed variable-length onion routing cell. */
808 typedef struct var_cell_t
{
811 uint16_t payload_len
;
815 /** A cell as packed for writing to the network. */
816 typedef struct packed_cell_t
{
817 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
818 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
821 /** A queue of cells on a circuit, waiting to be added to the
822 * or_connection_t's outbuf. */
823 typedef struct cell_queue_t
{
824 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
825 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
826 int n
; /**< The number of cells in the queue. */
829 /** Beginning of a RELAY cell payload. */
831 uint8_t command
; /**< The end-to-end relay command. */
832 uint16_t recognized
; /**< Used to tell whether cell is for us. */
833 streamid_t stream_id
; /**< Which stream is this cell associated with? */
834 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
835 uint16_t length
; /**< How long is the payload body? */
838 typedef struct buf_t buf_t
;
839 typedef struct socks_request_t socks_request_t
;
841 /* Values for connection_t.magic: used to make sure that downcasts (casts from
842 * connection_t to foo_connection_t) are safe. */
843 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
844 #define OR_CONNECTION_MAGIC 0x7D31FF03u
845 #define EDGE_CONNECTION_MAGIC 0xF0374013u
846 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
847 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
849 /** Description of a connection to another host or process, and associated
852 * A connection is named based on what it's connected to -- an "OR
853 * connection" has a Tor node on the other end, an "exit
854 * connection" has a website or other server on the other end, and an
855 * "AP connection" has an application proxy (and thus a user) on the
858 * Every connection has a type and a state. Connections never change
859 * their type, but can go through many state changes in their lifetime.
861 * Every connection has two associated input and output buffers.
862 * Listeners don't use them. For non-listener connections, incoming
863 * data is appended to conn->inbuf, and outgoing data is taken from
864 * conn->outbuf. Connections differ primarily in the functions called
865 * to fill and drain these buffers.
867 typedef struct connection_t
{
868 uint32_t magic
; /**< For memory debugging: must equal one of
869 * *_CONNECTION_MAGIC. */
871 uint8_t state
; /**< Current state of this connection. */
872 unsigned int type
:4; /**< What kind of connection is this? */
873 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
875 /* The next fields are all one-bit booleans. Some are only applicable to
876 * connection subtypes, but we hold them here anyway, to save space.
878 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
879 * again once the bandwidth throttler allows it? */
880 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
881 * again once the bandwidth throttler allows
883 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
884 * marked for close, do we flush it
885 * before closing it? */
886 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
888 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
889 * connections. Set once we've set the stream end,
890 * and check in connection_about_to_close_connection().
892 /** Edge connections only: true if we've blocked reading until the
893 * circuit has fewer queued cells. */
894 unsigned int edge_blocked_on_circ
:1;
895 /** Used for OR conns that shouldn't get any new circs attached to them,
896 * because the connection is too old. */
897 /* XXXX "obsolete" isn't really a good name here. */
898 unsigned int or_is_obsolete
:1;
899 /** For AP connections only. If 1, and we fail to reach the chosen exit,
900 * stop requiring it. */
901 unsigned int chosen_exit_optional
:1;
902 /** For AP connections only. If non-zero, this exit node was picked as
903 * a result of the TrackHostExit, and the value decrements every time
904 * we fail to complete a circuit to our chosen exit -- if it reaches
905 * zero, abandon the associated mapaddress. */
906 unsigned int chosen_exit_retries
:3;
907 /** Set to 1 when we're inside connection_flushed_some to keep us from
908 * calling connection_handle_write() recursively. */
909 unsigned int in_flushed_some
:1;
911 /* For linked connections:
913 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
914 /** True iff we'd like to be notified about read events from the
916 unsigned int reading_from_linked_conn
:1;
917 /** True iff we're willing to write to the linked conn. */
918 unsigned int writing_to_linked_conn
:1;
919 /** True iff we're currently able to read on the linked conn, and our
920 * read_event should be made active with libevent. */
921 unsigned int active_on_link
:1;
922 /** True iff we've called connection_close_immediate() on this linked
924 unsigned int linked_conn_is_closed
:1;
926 int s
; /**< Our socket; -1 if this connection is closed, or has no
928 int conn_array_index
; /**< Index into the global connection array. */
929 struct event
*read_event
; /**< Libevent event structure. */
930 struct event
*write_event
; /**< Libevent event structure. */
931 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
932 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
933 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
935 time_t timestamp_lastread
; /**< When was the last time libevent said we could
937 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
939 time_t timestamp_created
; /**< When was this connection_t created? */
941 /* XXXX_IP6 make this ipv6-capable */
942 int socket_family
; /**< Address family of this connection's socket. Usually
943 * AF_INET, but it can also be AF_UNIX, or in the future
945 tor_addr_t addr
; /**< IP of the other side of the connection; used to
946 * identify routers, along with port. */
947 uint16_t port
; /**< If non-zero, port on the other end
948 * of the connection. */
949 uint16_t marked_for_close
; /**< Should we close this conn on the next
950 * iteration of the main loop? (If true, holds
951 * the line number where this connection was
953 const char *marked_for_close_file
; /**< For debugging: in which file were
954 * we marked for close? */
955 char *address
; /**< FQDN (or IP) of the guy on the other end.
956 * strdup into this, because free_connection() frees it. */
957 /** Another connection that's connected to this one in lieu of a socket. */
958 struct connection_t
*linked_conn
;
960 /** Unique identifier for this connection. */
961 uint64_t global_identifier
;
963 /* XXXX021 move this into a subtype. */
964 struct evdns_server_port
*dns_server_port
;
968 /** Stores flags and information related to the portion of a v2 Tor OR
969 * connection handshake that happens after the TLS handshake is finished.
971 typedef struct or_handshake_state_t
{
972 /** When was the VERSIONS cell sent on this connection? Used to get
973 * an estimate of the skew in the returning NETINFO reply. */
974 time_t sent_versions_at
;
975 /** True iff we originated this connection */
976 unsigned int started_here
: 1;
977 /** True iff we have received and processed a VERSIONS cell. */
978 unsigned int received_versions
: 1;
979 } or_handshake_state_t
;
981 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
983 typedef struct or_connection_t
{
986 /** Hash of the public RSA key for the other side's identity key, or zeroes
987 * if the other side hasn't shown us a valid identity key. */
988 char identity_digest
[DIGEST_LEN
];
989 char *nickname
; /**< Nickname of OR on other side (if any). */
991 tor_tls_t
*tls
; /**< TLS connection state. */
992 int tls_error
; /**< Last tor_tls error code. */
993 /** When we last used this conn for any client traffic. If not
994 * recent, we can rate limit it further. */
997 tor_addr_t real_addr
; /**< The actual address that this connection came from
998 * or went to. The <b>addr</b> field is prone to
999 * getting overridden by the address from the router
1000 * descriptor matching <b>identity_digest</b>. */
1002 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1003 * connection, which half of the space should
1005 /** Should this connection be used for extending circuits to the server
1006 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1007 * sure we aren't getting MITMed, either because we're connected to an
1008 * address listed in a server descriptor, or because an authenticated
1009 * NETINFO cell listed the address we're connected to as recognized. */
1010 unsigned int is_canonical
:1;
1011 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1012 * "none negotiated yet." */
1013 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1014 * this connection? This is always in the
1015 * range 0..1<<15-1. */
1017 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1018 * up, state information to do so. */
1019 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1020 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1021 * non-padding cell to the outbuf? */
1023 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
1024 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1025 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1026 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1027 * add 'bandwidthrate' to this, capping it at
1028 * bandwidthburst. (OPEN ORs only) */
1029 int n_circuits
; /**< How many circuits use this connection as p_conn or
1032 /** Double-linked ring of circuits with queued cells waiting for room to
1033 * free up on this connection's outbuf. Every time we pull cells from a
1034 * circuit, we advance this pointer to the next circuit in the ring. */
1035 struct circuit_t
*active_circuits
;
1036 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1037 * identity digest as this one. */
1040 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1041 * connection, or an exit. */
1042 typedef struct edge_connection_t
{
1045 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1047 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1048 * this conn exits at. */
1049 int package_window
; /**< How many more relay cells can I send into the
1051 int deliver_window
; /**< How many more relay cells can end at me? */
1053 /** Nickname of planned exit node -- used with .exit support. */
1054 char *chosen_exit_name
;
1056 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1058 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1059 * connection is using. */
1061 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1062 * connection. Exit connections only. */
1064 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1067 /** The reason why this connection is closing; passed to the controller. */
1068 uint16_t end_reason
;
1070 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1073 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1076 /** What rendezvous service are we querying for? (AP only) */
1077 rend_data_t
*rend_data
;
1079 /** Number of times we've reassigned this application connection to
1080 * a new circuit. We keep track because the timeout is longer if we've
1081 * already retried several times. */
1082 uint8_t num_socks_retries
;
1084 /** True iff this connection is for a dns request only. */
1085 unsigned int is_dns_request
:1;
1087 /** True iff this stream must attach to a one-hop circuit (e.g. for
1089 unsigned int want_onehop
:1;
1090 /** True iff this stream should use a BEGIN_DIR relay command to establish
1091 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1092 unsigned int use_begindir
:1;
1094 /** If this is a DNSPort connection, this field holds the pending DNS
1095 * request that we're going to try to answer. */
1096 struct evdns_server_request
*dns_server_request
;
1098 } edge_connection_t
;
1100 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1101 * connection to retrieve or serve directory material. */
1102 typedef struct dir_connection_t
{
1105 char *requested_resource
; /**< Which 'resource' did we ask the directory
1107 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1109 /* Used only for server sides of some dir connections, to implement
1110 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1111 * to append everything to the outbuf in one enormous chunk. */
1112 /** What exactly are we spooling right now? */
1114 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1115 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1116 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
1117 } dir_spool_src
: 3;
1118 /** If we're fetching descriptors, what router purpose shall we assign
1120 uint8_t router_purpose
;
1121 /** List of fingerprints for networkstatuses or desriptors to be spooled. */
1122 smartlist_t
*fingerprint_stack
;
1123 /** A cached_dir_t object that we're currently spooling out */
1124 struct cached_dir_t
*cached_dir
;
1125 /** The current offset into cached_dir. */
1126 off_t cached_dir_offset
;
1127 /** The zlib object doing on-the-fly compression for spooled data. */
1128 tor_zlib_state_t
*zlib_state
;
1130 /** What rendezvous service are we querying for? */
1131 rend_data_t
*rend_data
;
1133 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1134 * the directory server's signing key. */
1138 /** Subtype of connection_t for an connection to a controller. */
1139 typedef struct control_connection_t
{
1142 uint32_t event_mask
; /**< Bitfield: which events does this controller
1144 unsigned int use_long_names
:1; /**< True if we should use long nicknames
1145 * on this (v1) connection. Only settable
1146 * via v1 controllers. */
1147 /** For control connections only. If set, we send extended info with control
1148 * events as appropriate. */
1149 unsigned int use_extended_events
:1;
1151 /** True if we have sent a protocolinfo reply on this connection. */
1152 unsigned int have_sent_protocolinfo
:1;
1154 uint32_t incoming_cmd_len
;
1155 uint32_t incoming_cmd_cur_len
;
1157 /* Used only by control v0 connections */
1158 uint16_t incoming_cmd_type
;
1159 } control_connection_t
;
1161 /** Cast a connection_t subtype pointer to a connection_t **/
1162 #define TO_CONN(c) (&(((c)->_base)))
1163 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1164 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1166 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1168 static or_connection_t
*TO_OR_CONN(connection_t
*);
1169 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1171 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1172 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1174 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1175 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1177 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1179 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1181 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1182 return DOWNCAST(or_connection_t
, c
);
1184 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1186 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1187 return DOWNCAST(dir_connection_t
, c
);
1189 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1191 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1192 return DOWNCAST(edge_connection_t
, c
);
1194 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1196 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1197 return DOWNCAST(control_connection_t
, c
);
1201 ADDR_POLICY_ACCEPT
=1,
1202 ADDR_POLICY_REJECT
=2,
1203 } addr_policy_action_t
;
1205 /** A reference-counted address policy rule. */
1206 typedef struct addr_policy_t
{
1207 int refcnt
; /**< Reference count */
1208 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1209 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1211 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1212 * copy (stored in a hash table to avoid
1213 * duplication of common policies) */
1214 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1215 * first <b>maskbits</b> bits of <b>a</b> match
1217 tor_addr_t addr
; /**< Base address to accept or reject. */
1218 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1219 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1222 /** A cached_dir_t represents a cacheable directory object, along with its
1223 * compressed form. */
1224 typedef struct cached_dir_t
{
1225 char *dir
; /**< Contents of this object, nul-terminated. */
1226 char *dir_z
; /**< Compressed contents of this object. */
1227 size_t dir_len
; /**< Length of <b>dir</b> (not counting its nul). */
1228 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1229 time_t published
; /**< When was this object published. */
1230 int refcnt
; /**< Reference count for this cached_dir_t. */
1233 /** Enum used to remember where a signed_descriptor_t is stored and how to
1234 * manage the memory for signed_descriptor_body. */
1236 /** The descriptor isn't stored on disk at all: the copy in memory is
1237 * canonical; the saved_offset field is meaningless. */
1239 /** The descriptor is stored in the cached_routers file: the
1240 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1241 * saved_offset are used to index into the mmaped cache file. */
1243 /** The descriptor is stored in the cached_routers.new file: the
1244 * signed_descriptor_body and saved_offset fields are both set. */
1245 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1246 * lazy-load the descriptor text by using seek and read. We don't, for
1252 /** Enumeration: what kind of downlaod schedule are we using for a given
1255 DL_SCHED_GENERIC
= 0,
1256 DL_SCHED_CONSENSUS
= 1,
1257 } download_schedule_t
;
1259 /** Information about our plans for retrying downloads for a downloadable
1261 typedef struct download_status_t
{
1262 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1264 uint8_t n_download_failures
; /**< Number of failures trying to download the
1265 * most recent descriptor. */
1266 download_schedule_t schedule
: 8;
1267 } download_status_t
;
1269 /** The max size we expect router descriptor annotations we create to
1270 * be. We'll accept larger ones if we see them on disk, but we won't
1271 * create any that are larger than this. */
1272 #define ROUTER_ANNOTATION_BUF_LEN 256
1274 /** Information need to cache an onion router's descriptor. */
1275 typedef struct signed_descriptor_t
{
1276 /** Pointer to the raw server descriptor, preceded by annotations. Not
1277 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1278 * pointer is null. */
1279 char *signed_descriptor_body
;
1280 /** Length of the annotations preceeding the server descriptor. */
1281 size_t annotations_len
;
1282 /** Length of the server descriptor. */
1283 size_t signed_descriptor_len
;
1284 /** Digest of the server descriptor, computed as specified in
1286 char signed_descriptor_digest
[DIGEST_LEN
];
1287 /** Identity digest of the router. */
1288 char identity_digest
[DIGEST_LEN
];
1289 /** Declared publication time of the descriptor. */
1290 time_t published_on
;
1291 /** For routerdescs only: digest of the corresponding extrainfo. */
1292 char extra_info_digest
[DIGEST_LEN
];
1293 /** For routerdescs only: Status of downloading the corresponding
1295 download_status_t ei_dl_status
;
1296 /** Where is the descriptor saved? */
1297 saved_location_t saved_location
;
1298 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1299 * this descriptor in the corresponding file. */
1301 /** What position is this descriptor within routerlist->routers or
1302 * routerlist->old_routers? -1 for none. */
1303 int routerlist_index
;
1304 /** The valid-until time of the most recent consensus that listed this
1305 * descriptor, or a bit after the publication time of the most recent v2
1306 * networkstatus that listed it. 0 for "never listed in a consensus or
1307 * status, so far as we know." */
1308 time_t last_listed_as_valid_until
;
1309 #ifdef TRACK_SERVED_TIME
1311 time_t last_served_at
; /*XXXX021 remove if not useful. */
1313 /* If true, we do not ever try to save this object in the cache. */
1314 unsigned int do_not_cache
: 1;
1315 /* If true, this item is meant to represent an extrainfo. */
1316 unsigned int is_extrainfo
: 1;
1317 /* If true, we got an extrainfo for this item, and the digest was right,
1318 * but it was incompatible. */
1319 unsigned int extrainfo_is_bogus
: 1;
1320 /* If true, we are willing to transmit this item unencrypted. */
1321 unsigned int send_unencrypted
: 1;
1322 } signed_descriptor_t
;
1324 /** A signed integer representing a country code. */
1325 typedef int16_t country_t
;
1327 /** Information about another onion router in the network. */
1329 signed_descriptor_t cache_info
;
1330 char *address
; /**< Location of OR: either a hostname or an IP address. */
1331 char *nickname
; /**< Human-readable OR name. */
1333 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1334 uint16_t or_port
; /**< Port for TLS connections. */
1335 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1337 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1338 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1340 char *platform
; /**< What software/operating system is this OR using? */
1343 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1344 * bucket per second? */
1345 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1346 /** How many bytes/s is this router known to handle? */
1347 uint32_t bandwidthcapacity
;
1348 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1349 * to exit? NULL for 'reject *:*'. */
1350 long uptime
; /**< How many seconds the router claims to have been up */
1351 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1352 * claims are its family. */
1353 char *contact_info
; /**< Declared contact info for this router. */
1354 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1356 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1357 * dnsworker code. */
1358 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1359 * extrainfo documents. */
1362 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1364 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1365 * (For Authdir: Have we validated this OR?)
1367 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1369 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1370 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1371 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1372 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1373 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1374 * or otherwise nasty? */
1375 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1376 * underpowered, or otherwise useless? */
1377 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1378 * a hidden service directory. */
1379 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1380 * directory according to the authorities. */
1382 /** Tor can use this router for general positions in circuits. */
1383 #define ROUTER_PURPOSE_GENERAL 0
1384 /** Tor should avoid using this router for circuit-building. */
1385 #define ROUTER_PURPOSE_CONTROLLER 1
1386 /** Tor should use this router only for bridge positions in circuits. */
1387 #define ROUTER_PURPOSE_BRIDGE 2
1388 /** Tor should not use this router; it was marked in cached-descriptors with
1389 * a purpose we didn't recognize. */
1390 #define ROUTER_PURPOSE_UNKNOWN 255
1392 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1394 /* The below items are used only by authdirservers for
1395 * reachability testing. */
1396 /** When was the last time we could reach this OR? */
1397 time_t last_reachable
;
1398 /** When did we start testing reachability for this OR? */
1399 time_t testing_since
;
1400 /** According to the geoip db what country is this router in? */
1404 /** Information needed to keep and cache a signed extra-info document. */
1405 typedef struct extrainfo_t
{
1406 signed_descriptor_t cache_info
;
1407 /** The router's nickname. */
1408 char nickname
[MAX_NICKNAME_LEN
+1];
1409 /** True iff we found the right key for this extra-info, verified the
1410 * signature, and found it to be bad. */
1411 unsigned int bad_sig
: 1;
1412 /** If present, we didn't have the right key to verify this extra-info,
1413 * so this is a copy of the signature in the document. */
1415 /** Length of pending_sig. */
1416 size_t pending_sig_len
;
1419 /** Contents of a single router entry in a network status object.
1421 typedef struct routerstatus_t
{
1422 time_t published_on
; /**< When was this router published? */
1423 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1425 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1427 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1429 uint32_t addr
; /**< IPv4 address for this router. */
1430 uint16_t or_port
; /**< OR port for this router. */
1431 uint16_t dir_port
; /**< Directory port for this router. */
1432 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1433 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1434 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1435 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1436 unsigned int is_running
:1; /**< True iff this router is up. */
1437 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1438 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1440 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1441 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1442 * information with v2 of the directory
1443 * protocol. (All directory caches cache v1
1445 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1446 * choice as an entry guard. */
1447 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1449 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1450 * underpowered, or otherwise useless? */
1451 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1452 * service directory. */
1453 /** True iff we know version info for this router. (i.e., a "v" entry was
1454 * included.) We'll replace all these with a big tor_version_t or a char[]
1455 * if the number of traits we care about ever becomes incredibly big. */
1456 unsigned int version_known
:1;
1457 /** True iff this router is a version that supports BEGIN_DIR cells. */
1458 unsigned int version_supports_begindir
:1;
1459 /** True iff this router is a version that supports conditional consensus
1460 * downloads (signed by list of authorities). */
1461 unsigned int version_supports_conditional_consensus
:1;
1462 /** True iff this router is a version that we can post extrainfo docs to. */
1463 unsigned int version_supports_extrainfo_upload
:1;
1464 /** True iff this router is a version that, if it caches directory info,
1465 * we can get v3 downloads from. */
1466 unsigned int version_supports_v3_dir
:1;
1468 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1469 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1471 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1472 * the vote/consensus, in kilobytes/sec. */
1473 char *exitsummary
; /**< exit policy summary -
1474 * XXX weasel: this probably should not stay a string. */
1476 /* ---- The fields below aren't derived from the networkstatus; they
1477 * hold local information only. */
1479 /** True if we, as a directory mirror, want to download the corresponding
1480 * routerinfo from the authority who gave us this routerstatus. (That is,
1481 * if we don't have the routerinfo, and if we haven't already tried to get it
1482 * from this authority.) Applies in v2 networkstatus document only.
1484 unsigned int need_to_mirror
:1;
1485 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1486 * to this (unnamed) router by nickname?
1488 time_t last_dir_503_at
; /**< When did this router last tell us that it
1489 * was too busy to serve directory info? */
1490 download_status_t dl_status
;
1494 /** How many times will we try to download a router's descriptor before giving
1496 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1498 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1499 typedef struct networkstatus_v2_t
{
1500 /** When did we receive the network-status document? */
1503 /** What was the digest of the document? */
1504 char networkstatus_digest
[DIGEST_LEN
];
1506 unsigned int is_recent
; /**< Is this recent enough to influence running
1509 /* These fields come from the actual network-status document.*/
1510 time_t published_on
; /**< Declared publication date. */
1512 char *source_address
; /**< Canonical directory server hostname. */
1513 uint32_t source_addr
; /**< Canonical directory server IP. */
1514 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1516 unsigned int binds_names
:1; /**< True iff this directory server binds
1518 unsigned int recommends_versions
:1; /**< True iff this directory server
1519 * recommends client and server software
1521 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1522 * malfunctioning exits as bad. */
1523 /** True iff this directory server marks malfunctioning directories as
1525 unsigned int lists_bad_directories
:1;
1527 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1528 char *contact
; /**< How to contact directory admin? (may be NULL). */
1529 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1530 char *client_versions
; /**< comma-separated list of recommended client
1532 char *server_versions
; /**< comma-separated list of recommended server
1535 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1536 * sorted by identity_digest. */
1537 } networkstatus_v2_t
;
1539 /** The claim about a single router, make in a vote. */
1540 typedef struct vote_routerstatus_t
{
1541 routerstatus_t status
; /**< Underlying 'status' object for this router.
1542 * Flags are redundant. */
1543 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1544 * networkstatus_t.known_flags. */
1545 char *version
; /**< The version that the authority says this router is
1547 } vote_routerstatus_t
;
1549 /** Information about a single voter in a vote or a consensus. */
1550 typedef struct networkstatus_voter_info_t
{
1551 char *nickname
; /**< Nickname of this voter */
1552 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1553 char *address
; /**< Address of this voter, in string format. */
1554 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1555 uint16_t dir_port
; /**< Directory port of this voter */
1556 uint16_t or_port
; /**< OR port of this voter */
1557 char *contact
; /**< Contact information for this voter. */
1558 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1559 char legacy_id_digest
[DIGEST_LEN
]; /**< From vote only. DOCDOC */
1561 /* Nothing from here on is signed. */
1562 char signing_key_digest
[DIGEST_LEN
]; /**< Declared digest of signing key
1563 * used by this voter. */
1564 char *signature
; /**< Signature from this voter. */
1565 int signature_len
; /**< Length of <b>signature</b> */
1566 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1567 * the sig, and we know it's bad. */
1568 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1570 } networkstatus_voter_info_t
;
1572 /** Enumerates the possible seriousness values of a networkstatus document. */
1577 } networkstatus_type_t
;
1579 /** A common structure to hold a v3 network status vote, or a v3 network
1580 * status consensus. */
1581 typedef struct networkstatus_t
{
1582 networkstatus_type_t type
; /**< Vote, consensus, or opinion? */
1583 time_t published
; /**< Vote only: Tiem when vote was written. */
1584 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1585 time_t fresh_until
; /**< Time before which this is the most recent vote or
1587 time_t valid_until
; /**< Time after which this vote or consensus should not
1590 /** Consensus only: what method was used to produce this consensus? */
1591 int consensus_method
;
1592 /** Vote only: what methods is this voter willing to use? */
1593 smartlist_t
*supported_methods
;
1595 /** How long does this vote/consensus claim that authorities take to
1596 * distribute their votes to one another? */
1598 /** How long does this vote/consensus claim that authorites take to
1599 * distribute their consensus signatures to one another? */
1602 /** Comma-separated list of recommended client software, or NULL if this
1603 * voter has no opinion. */
1604 char *client_versions
;
1605 char *server_versions
;
1606 /** List of flags that this vote/consensus applies to routers. If a flag is
1607 * not listed here, the voter has no opinion on what its value should be. */
1608 smartlist_t
*known_flags
;
1610 /** List of networkstatus_voter_info_t. For a vote, only one element
1611 * is included. For a consensus, one element is included for every voter
1612 * whose vote contributed to the consensus. */
1613 smartlist_t
*voters
;
1615 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1617 /** Digest of this document, as signed. */
1618 char networkstatus_digest
[DIGEST_LEN
];
1620 /** List of router statuses, sorted by identity digest. For a vote,
1621 * the elements are vote_routerstatus_t; for a consensus, the elements
1622 * are routerstatus_t. */
1623 smartlist_t
*routerstatus_list
;
1625 /** If present, a map from descriptor digest to elements of
1626 * routerstatus_list. */
1627 digestmap_t
*desc_digest_map
;
1630 /** A set of signatures for a networkstatus consensus. All fields are as for
1631 * networkstatus_t. */
1632 typedef struct ns_detached_signatures_t
{
1636 char networkstatus_digest
[DIGEST_LEN
];
1637 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1638 } ns_detached_signatures_t
;
1640 /** Allowable types of desc_store_t. */
1641 typedef enum store_type_t
{
1646 /** A 'store' is a set of descriptors saved on disk, with accompanying
1647 * journal, mmaped as needed, rebuilt as needed. */
1648 typedef struct desc_store_t
{
1649 /** Filename (within DataDir) for the store. We append .tmp to this
1650 * filename for a temporary file when rebuilding the store, and .new to this
1651 * filename for the journal. */
1652 const char *fname_base
;
1653 /** Alternative (obsolete) value for fname_base: if the file named by
1654 * fname_base isn't present, we read from here instead, but we never write
1656 const char *fname_alt_base
;
1657 /** Human-readable description of what this store contains. */
1658 const char *description
;
1660 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1662 store_type_t type
; /**< What's stored in this store? */
1664 /** The size of the router log, in bytes. */
1666 /** The size of the router store, in bytes. */
1668 /** Total bytes dropped since last rebuild: this is space currently
1669 * used in the cache and the journal that could be freed by a rebuild. */
1670 size_t bytes_dropped
;
1673 /** Contents of a directory of onion routers. */
1675 /** Map from server identity digest to a member of routers. */
1676 struct digest_ri_map_t
*identity_map
;
1677 /** Map from server descriptor digest to a signed_descriptor_t from
1678 * routers or old_routers. */
1679 struct digest_sd_map_t
*desc_digest_map
;
1680 /** Map from extra-info digest to an extrainfo_t. Only exists for
1681 * routers in routers or old_routers. */
1682 struct digest_ei_map_t
*extra_info_map
;
1683 /** Map from extra-info digests to a signed_descriptor_t for a router
1684 * descriptor having that extra-info digest. Only exists for
1685 * routers in routers or old_routers. */
1686 struct digest_sd_map_t
*desc_by_eid_map
;
1687 /** List of routerinfo_t for all currently live routers we know. */
1688 smartlist_t
*routers
;
1689 /** List of signed_descriptor_t for older router descriptors we're
1691 smartlist_t
*old_routers
;
1692 /** Store holding server descriptors. If present, any router whose
1693 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1694 * starting at cache_info.saved_offset */
1695 desc_store_t desc_store
;
1696 /** Store holding extra-info documents. */
1697 desc_store_t extrainfo_store
;
1700 /** Information on router used when extending a circuit. We don't need a
1701 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1702 * connection, and onion_key to create the onionskin. Note that for onehop
1703 * general-purpose tunnels, the onion_key is NULL. */
1704 typedef struct extend_info_t
{
1705 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1707 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1708 uint16_t port
; /**< OR port. */
1709 tor_addr_t addr
; /**< IP address. */
1710 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1713 /** Certificate for v3 directory protocol: binds long-term authority identity
1714 * keys to medium-term authority signing keys. */
1715 typedef struct authority_cert_t
{
1716 signed_descriptor_t cache_info
;
1717 crypto_pk_env_t
*identity_key
;
1718 crypto_pk_env_t
*signing_key
;
1719 char signing_key_digest
[DIGEST_LEN
];
1725 /** Bitfield enum type listing types of directory authority/directory
1729 V1_AUTHORITY
= 1 << 0,
1730 V2_AUTHORITY
= 1 << 1,
1731 V3_AUTHORITY
= 1 << 2,
1732 HIDSERV_AUTHORITY
= 1 << 3,
1733 BRIDGE_AUTHORITY
= 1 << 4,
1734 EXTRAINFO_CACHE
= 1 << 5, /* not precisely an authority type. */
1737 #define CRYPT_PATH_MAGIC 0x70127012u
1739 /** Holds accounting information for a single step in the layered encryption
1740 * performed by a circuit. Used only at the client edge of a circuit. */
1741 typedef struct crypt_path_t
{
1744 /* crypto environments */
1745 /** Encryption key and counter for cells heading towards the OR at this
1747 crypto_cipher_env_t
*f_crypto
;
1748 /** Encryption key and counter for cells heading back from the OR at this
1750 crypto_cipher_env_t
*b_crypto
;
1752 /** Digest state for cells heading towards the OR at this step. */
1753 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1754 /** Digest state for cells heading away from the OR at this step. */
1755 crypto_digest_env_t
*b_digest
;
1757 /** Current state of Diffie-Hellman key negotiation with the OR at this
1759 crypto_dh_env_t
*dh_handshake_state
;
1760 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1761 * step. Used to save CPU when TLS is already providing all the
1762 * authentication, secrecy, and integrity we need, and we're already
1763 * distinguishable from an OR.
1765 char fast_handshake_state
[DIGEST_LEN
];
1766 /** Negotiated key material shared with the OR at this step. */
1767 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1769 /** Information to extend to the OR at this step. */
1770 extend_info_t
*extend_info
;
1772 /** Is the circuit built to this step? Must be one of:
1773 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1774 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1775 * and not received an EXTENDED/CREATED)
1776 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1778 #define CPATH_STATE_CLOSED 0
1779 #define CPATH_STATE_AWAITING_KEYS 1
1780 #define CPATH_STATE_OPEN 2
1781 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1782 * (The list is circular, so the last node
1783 * links to the first.) */
1784 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1787 int package_window
; /**< How many bytes are we allowed to originate ending
1789 int deliver_window
; /**< How many bytes are we willing to deliver originating
1793 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1795 #define DH_KEY_LEN DH_BYTES
1796 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1799 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1801 /** Information used to build a circuit. */
1803 /** Intended length of the final circuit. */
1804 int desired_path_len
;
1805 /** How to extend to the planned exit node. */
1806 extend_info_t
*chosen_exit
;
1807 /** Whether every node in the circ must have adequate uptime. */
1809 /** Whether every node in the circ must have adequate capacity. */
1811 /** Whether the last hop was picked with exiting in mind. */
1813 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1814 * These are for encrypted connections that exit to this router, not
1815 * for arbitrary exits from the circuit. */
1817 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1818 crypt_path_t
*pending_final_cpath
;
1819 /** How many times has building a circuit for this task failed? */
1821 /** At what time should we give up on this task? */
1823 } cpath_build_state_t
;
1825 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1826 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1829 * A circuit is a path over the onion routing
1830 * network. Applications can connect to one end of the circuit, and can
1831 * create exit connections at the other end of the circuit. AP and exit
1832 * connections have only one circuit associated with them (and thus these
1833 * connection types are closed when the circuit is closed), whereas
1834 * OR connections multiplex many circuits at once, and stay standing even
1835 * when there are no circuits running over them.
1837 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1838 * links two connections together: either an edge connection and an OR
1839 * connection, or two OR connections. (When joined to an OR connection, a
1840 * circuit_t affects only cells sent to a particular circID on that
1841 * connection. When joined to an edge connection, a circuit_t affects all
1844 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1845 * along a given circuit. At the OP, it has a sequence of ciphers, each
1846 * of which is shared with a single OR along the circuit. Separate
1847 * ciphers are used for data going "forward" (away from the OP) and
1848 * "backward" (towards the OP). At the OR, a circuit has only two stream
1849 * ciphers: one for data going forward, and one for data going backward.
1851 typedef struct circuit_t
{
1852 uint32_t magic
; /**< For memory and type debugging: must equal
1853 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1855 /** Queue of cells waiting to be transmitted on n_conn. */
1856 cell_queue_t n_conn_cells
;
1857 /** The OR connection that is next in this circuit. */
1858 or_connection_t
*n_conn
;
1859 /** The circuit_id used in the next (forward) hop of this circuit. */
1862 /** The hop to which we want to extend this ciruit. Should be NULL if
1863 * the circuit has attached to a connection. */
1864 extend_info_t
*n_hop
;
1866 /** True iff we are waiting for n_conn_cells to become less full before
1867 * allowing p_streams to add any more cells. (Origin circuit only.) */
1868 unsigned int streams_blocked_on_n_conn
: 1;
1869 /** True iff we are waiting for p_conn_cells to become less full before
1870 * allowing n_streams to add any more cells. (OR circuit only.) */
1871 unsigned int streams_blocked_on_p_conn
: 1;
1873 uint8_t state
; /**< Current status of this circuit. */
1874 uint8_t purpose
; /**< Why are we creating this circuit? */
1876 /** How many relay data cells can we package (read from edge streams)
1877 * on this circuit before we receive a circuit-level sendme cell asking
1880 /** How many relay data cells will we deliver (write to edge streams)
1881 * on this circuit? When deliver_window gets low, we send some
1882 * circuit-level sendme cells to indicate that we're willing to accept
1886 /** For storage while n_conn is pending
1887 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1888 * length ONIONSKIN_CHALLENGE_LEN. */
1889 char *n_conn_onionskin
;
1891 time_t timestamp_created
; /**< When was this circuit created? */
1892 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1893 * circuit is clean. */
1895 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1896 * the main loop? (If true, holds the line number
1897 * where this circuit was marked.) */
1898 const char *marked_for_close_file
; /**< For debugging: in which file was this
1899 * circuit marked for close? */
1901 /** Next circuit in the doubly-linked ring of circuits waiting to add
1902 * cells to n_conn. NULL if we have no cells pending, or if we're not
1903 * linked to an OR connection. */
1904 struct circuit_t
*next_active_on_n_conn
;
1905 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1906 * cells to n_conn. NULL if we have no cells pending, or if we're not
1907 * linked to an OR connection. */
1908 struct circuit_t
*prev_active_on_n_conn
;
1909 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1912 /** Largest number of relay_early cells that we can send on a given
1914 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
1916 /** An origin_circuit_t holds data necessary to build and use a circuit.
1918 typedef struct origin_circuit_t
{
1921 /** Linked list of AP streams (or EXIT streams if hidden service)
1922 * associated with this circuit. */
1923 edge_connection_t
*p_streams
;
1924 /** Build state for this circuit. It includes the intended path
1925 * length, the chosen exit router, rendezvous information, etc.
1927 cpath_build_state_t
*build_state
;
1928 /** The doubly-linked list of crypt_path_t entries, one per hop,
1929 * for this circuit. This includes ciphers for each hop,
1930 * integrity-checking digests for each hop, and package/delivery
1931 * windows for each hop.
1933 crypt_path_t
*cpath
;
1935 /** Holds all rendezvous data on either client or service side. */
1936 rend_data_t
*rend_data
;
1938 /** How many more relay_early cells can we send on this circuit, according
1939 * to the specification? */
1940 unsigned int remaining_relay_early_cells
: 4;
1942 /** The next stream_id that will be tried when we're attempting to
1943 * construct a new AP stream originating at this circuit. */
1944 streamid_t next_stream_id
;
1946 /* The intro key replaces the hidden service's public key if purpose is
1947 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
1948 * descriptor is used. */
1949 crypto_pk_env_t
*intro_key
;
1951 /** Quasi-global identifier for this circuit; used for control.c */
1952 /* XXXX NM This can get re-used after 2**32 circuits. */
1953 uint32_t global_identifier
;
1957 /** An or_circuit_t holds information needed to implement a circuit at an
1959 typedef struct or_circuit_t
{
1962 /** Next circuit in the doubly-linked ring of circuits waiting to add
1963 * cells to p_conn. NULL if we have no cells pending, or if we're not
1964 * linked to an OR connection. */
1965 struct circuit_t
*next_active_on_p_conn
;
1966 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1967 * cells to p_conn. NULL if we have no cells pending, or if we're not
1968 * linked to an OR connection. */
1969 struct circuit_t
*prev_active_on_p_conn
;
1971 /** The circuit_id used in the previous (backward) hop of this circuit. */
1973 /** Queue of cells waiting to be transmitted on p_conn. */
1974 cell_queue_t p_conn_cells
;
1975 /** The OR connection that is previous in this circuit. */
1976 or_connection_t
*p_conn
;
1977 /** Linked list of Exit streams associated with this circuit. */
1978 edge_connection_t
*n_streams
;
1979 /** Linked list of Exit streams associated with this circuit that are
1980 * still being resolved. */
1981 edge_connection_t
*resolving_streams
;
1982 /** The cipher used by intermediate hops for cells heading toward the
1984 crypto_cipher_env_t
*p_crypto
;
1985 /** The cipher used by intermediate hops for cells heading away from
1987 crypto_cipher_env_t
*n_crypto
;
1989 /** The integrity-checking digest used by intermediate hops, for
1990 * cells packaged here and heading towards the OP.
1992 crypto_digest_env_t
*p_digest
;
1993 /** The integrity-checking digest used by intermediate hops, for
1994 * cells packaged at the OP and arriving here.
1996 crypto_digest_env_t
*n_digest
;
1998 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
1999 * is not marked for close. */
2000 struct or_circuit_t
*rend_splice
;
2002 #if REND_COOKIE_LEN >= DIGEST_LEN
2003 #define REND_TOKEN_LEN REND_COOKIE_LEN
2005 #define REND_TOKEN_LEN DIGEST_LEN
2008 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2009 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2011 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2013 char rend_token
[REND_TOKEN_LEN
];
2015 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2016 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2018 /** How many more relay_early cells can we send on this circuit, according
2019 * to the specification? */
2020 unsigned int remaining_relay_early_cells
: 4;
2022 /** True iff this circuit was made with a CREATE_FAST cell. */
2023 unsigned int is_first_hop
: 1;
2026 /** Convert a circuit subtype to a circuit_t.*/
2027 #define TO_CIRCUIT(x) (&((x)->_base))
2029 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2030 * if the cast is impossible. */
2031 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2032 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2033 * Asserts if the cast is impossible. */
2034 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2036 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2038 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2039 return DOWNCAST(or_circuit_t
, x
);
2041 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2043 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2044 return DOWNCAST(origin_circuit_t
, x
);
2047 #define ALLOW_INVALID_ENTRY 1
2048 #define ALLOW_INVALID_EXIT 2
2049 #define ALLOW_INVALID_MIDDLE 4
2050 #define ALLOW_INVALID_RENDEZVOUS 8
2051 #define ALLOW_INVALID_INTRODUCTION 16
2053 /** An entry specifying a set of addresses and ports that should be remapped
2054 * to another address and port before exiting this exit node. */
2055 typedef struct exit_redirect_t
{
2059 maskbits_t maskbits
;
2061 tor_addr_t addr_dest
;
2063 unsigned int is_redirect
:1;
2066 /* limits for TCP send and recv buffer size used for constrained sockets */
2067 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2068 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2070 /** A linked list of lines in a config file. */
2071 typedef struct config_line_t
{
2074 struct config_line_t
*next
;
2077 typedef struct routerset_t routerset_t
;
2079 /** Configuration options for a Tor process. */
2083 /** What should the tor process actually do? */
2085 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2086 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2088 const char *command_arg
; /**< Argument for command-line option. */
2090 config_line_t
*Logs
; /**< New-style list of configuration lines
2093 char *DebugLogFile
; /**< Where to send verbose log messages. */
2094 char *DataDirectory
; /**< OR only: where to store long-term data. */
2095 char *Nickname
; /**< OR only: nickname of this onion router. */
2096 char *Address
; /**< OR only: configured address for this onion router. */
2097 char *PidFile
; /**< Where to store PID of Tor process. */
2099 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2100 * country codes and IP address patterns of ORs to
2101 * consider as exits. */
2102 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2103 * country codes and IP address patterns of ORs to
2104 * consider as entry points. */
2105 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2106 * stop building circuits? */
2107 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2108 * stop building circuits? */
2109 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2110 * country codes and IP address patterns of ORs
2111 * not to use in circuits. */
2112 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2113 * country codes and IP address patterns of
2114 * ORs not to consider as exits. */
2116 /** Union of ExcludeNodes and ExcludeExitNodes */
2117 struct routerset_t
*_ExcludeExitNodesUnion
;
2119 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2120 smartlist_t
*AllowInvalidNodes
;
2121 int _AllowInvalid
; /**< Bitmask; derived from AllowInvalidNodes. */
2122 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2123 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2124 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2125 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2126 /** Addresses to bind for listening for SOCKS connections. */
2127 config_line_t
*SocksListenAddress
;
2128 /** Addresses to bind for listening for transparent pf/nefilter
2130 config_line_t
*TransListenAddress
;
2131 /** Addresses to bind for listening for transparent natd connections */
2132 config_line_t
*NatdListenAddress
;
2133 /** Addresses to bind for listening for SOCKS connections. */
2134 config_line_t
*DNSListenAddress
;
2135 /** Addresses to bind for listening for OR connections. */
2136 config_line_t
*ORListenAddress
;
2137 /** Addresses to bind for listening for directory connections. */
2138 config_line_t
*DirListenAddress
;
2139 /** Addresses to bind for listening for control connections. */
2140 config_line_t
*ControlListenAddress
;
2141 /** Local address to bind outbound sockets */
2142 char *OutboundBindAddress
;
2143 /** Directory server only: which versions of
2144 * Tor should we tell users to run? */
2145 config_line_t
*RecommendedVersions
;
2146 config_line_t
*RecommendedClientVersions
;
2147 config_line_t
*RecommendedServerVersions
;
2148 /** Whether dirservers refuse router descriptors with private IPs. */
2149 int DirAllowPrivateAddresses
;
2150 char *User
; /**< Name of user to run Tor as. */
2151 char *Group
; /**< Name of group to run Tor as. */
2152 int ORPort
; /**< Port to listen on for OR connections. */
2153 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2154 /** Port to listen on for transparent pf/netfilter connections. */
2156 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2157 int ControlPort
; /**< Port to listen on for control connections. */
2158 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2159 * for control connections. */
2160 int DirPort
; /**< Port to listen on for directory connections. */
2161 int DNSPort
; /**< Port to listen on for DNS requests. */
2162 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2163 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2164 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2165 * for version 1 directories? */
2166 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2167 * for version 2 directories? */
2168 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2169 * for version 3 directories? */
2170 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2171 * handle hidden service requests? */
2172 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
2173 * directory record statistics? */
2174 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2175 * that's willing to bind names? */
2176 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2177 * directory that's willing to recommend
2179 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2180 * that aggregates bridge descriptors? */
2182 /** If set on a bridge authority, it will answer requests on its dirport
2183 * for bridge statuses -- but only if the requests use this password.
2184 * If set on a bridge user, request bridge statuses, and use this password
2186 char *BridgePassword
;
2188 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2189 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2191 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2192 * this explicit so we can change how we behave in the
2195 /** Boolean: if we know the bridge's digest, should we get new
2196 * descriptors from the bridge authorities or from the bridge itself? */
2197 int UpdateBridgesFromAuthority
;
2199 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2201 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2202 /** Boolean: should we never publish a descriptor? Deprecated. */
2204 /** To what authority types do we publish our descriptor? Choices are
2205 * "v1", "v2", "v3", "bridge", or "". */
2206 smartlist_t
*PublishServerDescriptor
;
2207 /** An authority type, derived from PublishServerDescriptor. */
2208 authority_type_t _PublishServerDescriptor
;
2209 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2210 int PublishHidServDescriptors
;
2211 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2212 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2213 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2215 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2216 * service directories after what time? */
2217 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2218 int AllDirActionsPrivate
; /**< Should every directory action be sent
2219 * through a Tor circuit? */
2221 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2222 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2223 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2224 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2225 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2227 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2228 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2229 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2231 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2232 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2234 /** Application ports that require all nodes in circ to have sufficient
2236 smartlist_t
*LongLivedPorts
;
2237 /** Application ports that are likely to be unencrypted and
2238 * unauthenticated; we reject requests for them to prevent the
2239 * user from screwing up and leaking plaintext secrets to an
2240 * observer somewhere on the Internet. */
2241 smartlist_t
*RejectPlaintextPorts
;
2242 /** Related to RejectPlaintextPorts above, except this config option
2243 * controls whether we warn (in the log and via a controller status
2244 * event) every time a risky connection is attempted. */
2245 smartlist_t
*WarnPlaintextPorts
;
2246 /** Should we try to reuse the same exit node for a given host */
2247 smartlist_t
*TrackHostExits
;
2248 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2250 config_line_t
*AddressMap
; /**< List of address map directives. */
2251 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2252 * hostname ending with one of the suffixes in
2253 * <b>AutomapHostsSuffixes</b>, map it to a
2254 * virtual address. */
2255 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2256 * <b>AutomapHostsOnResolve</b>. */
2257 int RendPostPeriod
; /**< How often do we post each rendezvous service
2258 * descriptor? Remember to publish them independently. */
2259 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2260 * connections alive? */
2261 int SocksTimeout
; /**< How long do we let a socks connection wait
2262 * unattached before we fail it? */
2263 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2264 * at least this many seconds ago. */
2265 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2266 * at least this many seconds ago. */
2267 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2268 * to wait simultaneously before we start dropping
2270 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2272 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2273 this interval ago. */
2274 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2275 * to use in a second? */
2276 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2277 * to use in a second? */
2278 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2279 * tell people we have? */
2280 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2281 * willing to use for all relayed conns? */
2282 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2283 * use in a second for all relayed conns? */
2284 int NumCpus
; /**< How many CPUs should we try to use? */
2285 int RunTesting
; /**< If true, create testing circuits to measure how well the
2286 * other ORs are running. */
2287 config_line_t
*RendConfigLines
; /**< List of configuration lines
2288 * for rendezvous services. */
2289 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2290 * authorizations for hidden services */
2291 char *ContactInfo
; /**< Contact info to be published in the directory. */
2293 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2294 uint32_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2295 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2296 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2298 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2299 uint32_t HttpsProxyAddr
; /**< Parsed IPv4 addr for https proxy, if any. */
2300 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2301 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2303 /** List of configuration lines for replacement directory authorities.
2304 * If you just want to replace one class of authority at a time,
2305 * use the "Alternate*Authority" options below instead. */
2306 config_line_t
*DirServers
;
2308 /** If set, use these main (currently v3) directory authorities and
2309 * not the default ones. */
2310 config_line_t
*AlternateDirAuthority
;
2312 /** If set, use these bridge authorities and not the default one. */
2313 config_line_t
*AlternateBridgeAuthority
;
2315 /** If set, use these HS authorities and not the default ones. */
2316 config_line_t
*AlternateHSAuthority
;
2318 char *MyFamily
; /**< Declared family for this OR. */
2319 config_line_t
*NodeFamilies
; /**< List of config lines for
2321 config_line_t
*RedirectExit
; /**< List of config lines for simple
2322 * addr/port redirection */
2323 smartlist_t
*RedirectExitList
; /**< List of exit_redirect_t */
2324 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2325 * mark as bad dir mirrors. */
2326 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2327 * mark as bad exits. */
2328 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2330 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2331 * never mark as valid. */
2332 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2333 * and vote for all other dir mirrors as good. */
2334 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2335 * and vote for all other exits as good. */
2336 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2337 * aren't named in our fingerprint file? */
2338 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2339 * number of servers per IP address. */
2340 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2341 * number of servers per IP address shared
2342 * with an authority. */
2344 char *AccountingStart
; /**< How long is the accounting interval, and when
2346 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2347 * interval before hibernation? 0 for "never
2350 /** Base64-encoded hash of accepted passwords for the control system. */
2351 config_line_t
*HashedControlPassword
;
2352 /** As HashedControlPassword, but not saved. */
2353 config_line_t
*HashedControlSessionPassword
;
2355 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2356 * the control system? */
2357 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2358 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2359 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2360 * circuits itself (0), or does it expect a controller
2362 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2363 * make circuits in the background (0),
2365 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2366 * long do we wait before exiting? */
2367 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2368 * such as addresses (0), or do we scrub them first (1)? */
2369 int SafeSocks
; /**< Boolean: should we outright refuse application
2370 * connections that use socks4 or socks5-with-local-dns? */
2371 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2372 LOG_WARN : LOG_INFO)
2373 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2374 * protocol, is it a warn or an info in our logs? */
2375 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2376 * log whether it was DNS-leaking or not? */
2377 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2378 * acceleration where available? */
2379 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2380 * of fixed nodes? */
2381 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2382 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2383 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2384 * of our PK time by sending CREATE_FAST cells? */
2385 /** Should we always fetch our dir info on the mirror schedule (which
2386 * means directly from the authorities) no matter our other config? */
2387 int FetchDirInfoEarly
;
2389 smartlist_t
*reachable_addr_policy
; /**< Parsed from ReachableAddresses */
2391 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2392 * MAPADDRESS requests. */
2393 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2394 * addresses to be FQDNs, but rather search for them in
2395 * the local domains. */
2396 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2398 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2399 * resolver from the file here rather than from
2400 * /etc/resolv.conf (Unix) or the registry (Windows). */
2401 /** Boolean: if set, we start even if our resolv.conf file is missing
2403 int ServerDNSAllowBrokenResolvConf
;
2405 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2406 * should be resolveable. Used for
2407 * testing our DNS server. */
2408 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2409 * same network zone in the same circuit. */
2410 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2412 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2413 * support BEGIN_DIR, when possible. */
2414 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2415 * with weird characters. */
2416 /** If true, we try resolving hostnames with weird characters. */
2417 int ServerDNSAllowNonRFC953Hostnames
;
2419 /** If true, we try to download extra-info documents (and we serve them,
2420 * if we are a cache). For authorities, this is always true. */
2421 int DownloadExtraInfo
;
2423 /** If true, do not believe anybody who tells us that a domain resolves
2424 * to an internal address, or that an internal address has a PTR mapping.
2425 * Helps avoid some cross-site attacks. */
2426 int ClientDNSRejectInternalAddresses
;
2428 /** The length of time that we think a consensus should be fresh. */
2429 int V3AuthVotingInterval
;
2430 /** The length of time we think it will take to distribute votes. */
2431 int V3AuthVoteDelay
;
2432 /** The length of time we think it will take to distribute signatures. */
2433 int V3AuthDistDelay
;
2434 /** The number of intervals we think a consensus should be valid. */
2435 int V3AuthNIntervalsValid
;
2437 /** Should advertise and sign consensuses with a legacy key, for key
2438 * migration purposes? */
2439 int V3AuthUseLegacyKey
;
2441 /** The length of time that we think an initial consensus should be fresh.
2442 * Only altered on testing networks. */
2443 int TestingV3AuthInitialVotingInterval
;
2445 /** The length of time we think it will take to distribute initial votes.
2446 * Only altered on testing networks. */
2447 int TestingV3AuthInitialVoteDelay
;
2449 /** The length of time we think it will take to distribute initial
2450 * signatures. Only altered on testing networks.*/
2451 int TestingV3AuthInitialDistDelay
;
2453 /** If an authority has been around for less than this amount of time, it
2454 * does not believe its reachability information is accurate. Only
2455 * altered on testing networks. */
2456 int TestingAuthDirTimeToLearnReachability
;
2458 /** Clients don't download any descriptor this recent, since it will
2459 * probably not have propagated to enough caches. Only altered on testing
2461 int TestingEstimatedDescriptorPropagationTime
;
2463 /** If true, we take part in a testing network. Change the defaults of a
2464 * couple of other configuration options and allow to change the values
2465 * of certain configuration options. */
2466 int TestingTorNetwork
;
2468 /** File to check for a consensus networkstatus, if we don't have one
2470 char *FallbackNetworkstatusFile
;
2472 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2473 * count of how many client addresses have contacted us so that we can help
2474 * the bridge authority guess which countries have blocked access to us. */
2475 int BridgeRecordUsageByCountry
;
2476 #ifdef ENABLE_GEOIP_STATS
2477 int DirRecordUsageByCountry
;
2478 int DirRecordUsageGranularity
;
2479 int DirRecordUsageRetainIPs
;
2480 int DirRecordUsageSaveInterval
;
2483 /** Optionally, a file with GeoIP data. */
2488 /** Persistent state for an onion router, as saved to disk. */
2491 /** The time at which we next plan to write the state to the disk. Equal to
2492 * TIME_MAX if there are no saveable changes, 0 if there are changes that
2493 * should be saved right away. */
2496 /** When was the state last written to disk? */
2499 /** Fields for accounting bandwidth use. */
2500 time_t AccountingIntervalStart
;
2501 uint64_t AccountingBytesReadInInterval
;
2502 uint64_t AccountingBytesWrittenInInterval
;
2503 int AccountingSecondsActive
;
2504 uint64_t AccountingExpectedUsage
;
2506 /** A list of Entry Guard-related configuration lines. */
2507 config_line_t
*EntryGuards
;
2509 /** These fields hold information on the history of bandwidth usage for
2510 * servers. The "Ends" fields hold the time when we last updated the
2511 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2512 * of the entries of Values. The "Values" lists hold decimal string
2513 * representations of the number of bytes read or written in each
2515 time_t BWHistoryReadEnds
;
2516 int BWHistoryReadInterval
;
2517 smartlist_t
*BWHistoryReadValues
;
2518 time_t BWHistoryWriteEnds
;
2519 int BWHistoryWriteInterval
;
2520 smartlist_t
*BWHistoryWriteValues
;
2522 /** What version of Tor wrote this state file? */
2525 /** Holds any unrecognized values we found in the state file, in the order
2526 * in which we found them. */
2527 config_line_t
*ExtraLines
;
2529 /** When did we last rotate our onion key? "0" for 'no idea'. */
2530 time_t LastRotatedOnionKey
;
2533 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2534 * state is already scheduled to be written to disk earlier than <b>when</b>.
2536 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2538 if (state
->next_write
> when
)
2539 state
->next_write
= when
;
2542 #define MAX_SOCKS_REPLY_LEN 1024
2543 #define MAX_SOCKS_ADDR_LEN 256
2545 /** Please open a TCP connection to this addr:port. */
2546 #define SOCKS_COMMAND_CONNECT 0x01
2547 /** Please turn this FQDN into an IP address, privately. */
2548 #define SOCKS_COMMAND_RESOLVE 0xF0
2549 /** Please turn this IP address into an FQDN, privately. */
2550 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2552 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2553 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2554 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2556 /** State of a SOCKS request from a user to an OP. Also used to encode other
2557 * information for non-socks user request (such as those on TransPort and
2559 struct socks_request_t
{
2560 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2561 * 0 means that no socks handshake ever took place, and this is just a
2562 * stub connection (e.g. see connection_ap_make_link()). */
2564 int command
; /**< What is this stream's goal? One from the above list. */
2565 size_t replylen
; /**< Length of <b>reply</b>. */
2566 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2567 * we want to specify our own socks reply,
2568 * rather than using the default socks4 or
2569 * socks5 socks reply. We use this for the
2570 * two-stage socks5 handshake.
2572 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2573 connect to/resolve? */
2574 uint16_t port
; /**< What port did the client ask to connect to? */
2575 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2576 * make sure we send back a socks reply for
2577 * every connection. */
2580 /* all the function prototypes go here */
2582 /********************************* buffers.c ***************************/
2584 buf_t
*buf_new(void);
2585 buf_t
*buf_new_with_capacity(size_t size
);
2586 void buf_free(buf_t
*buf
);
2587 void buf_clear(buf_t
*buf
);
2588 void buf_shrink(buf_t
*buf
);
2589 void buf_shrink_freelists(int free_all
);
2590 void buf_dump_freelist_sizes(int severity
);
2592 size_t buf_datalen(const buf_t
*buf
);
2593 size_t buf_allocation(const buf_t
*buf
);
2594 size_t buf_slack(const buf_t
*buf
);
2595 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2597 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2599 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2601 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2602 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2604 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2605 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2606 const char *data
, size_t data_len
, int done
);
2607 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2608 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2609 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2610 int fetch_from_buf_http(buf_t
*buf
,
2611 char **headers_out
, size_t max_headerlen
,
2612 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2613 int force_complete
);
2614 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2615 int log_sockstype
, int safe_socks
);
2616 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2618 int peek_buf_has_control0_command(buf_t
*buf
);
2620 void assert_buf_ok(buf_t
*buf
);
2622 #ifdef BUFFERS_PRIVATE
2623 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2626 /********************************* circuitbuild.c **********************/
2628 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2629 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2630 void circuit_log_path(int severity
, unsigned int domain
,
2631 origin_circuit_t
*circ
);
2632 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2633 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2634 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2635 extend_info_t
*exit
,
2637 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2638 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2639 int inform_testing_reachability(void);
2640 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2641 void circuit_note_clock_jumped(int seconds_elapsed
);
2642 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2643 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2645 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2647 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2648 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2649 const char *payload
, const char *keys
);
2650 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2651 int *need_capacity
);
2653 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2654 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2655 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2656 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2657 crypto_pk_env_t
*onion_key
,
2658 const tor_addr_t
*addr
, uint16_t port
);
2659 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2660 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2661 void extend_info_free(extend_info_t
*info
);
2662 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2663 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2665 void entry_guards_compute_status(void);
2666 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2668 void entry_nodes_should_be_added(void);
2669 int entry_list_can_grow(or_options_t
*options
);
2670 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2671 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2672 void entry_guards_update_state(or_state_t
*state
);
2673 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2674 const char *question
, char **answer
);
2676 void clear_bridge_list(void);
2677 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2678 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
2680 void retry_bridge_descriptor_fetch_directly(const char *digest
);
2681 void fetch_bridge_descriptors(time_t now
);
2682 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2683 int any_bridge_descriptors_known(void);
2684 int any_pending_bridge_descriptor_fetches(void);
2685 int bridges_known_but_down(void);
2686 void bridges_retry_all(void);
2688 void entry_guards_free_all(void);
2690 /********************************* circuitlist.c ***********************/
2692 circuit_t
* _circuit_get_global_list(void);
2693 const char *circuit_state_to_string(int state
);
2694 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
2695 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
2696 or_connection_t
*conn
);
2697 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
2698 or_connection_t
*conn
);
2699 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
2700 void circuit_close_all_marked(void);
2701 origin_circuit_t
*origin_circuit_new(void);
2702 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
2703 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
2704 or_connection_t
*conn
);
2705 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
2706 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
2707 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
2708 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
2709 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
2711 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
2712 const char *digest
, uint8_t purpose
);
2713 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
2714 or_circuit_t
*circuit_get_intro_point(const char *digest
);
2715 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
2716 extend_info_t
*info
, int flags
);
2717 void circuit_mark_all_unused_circs(void);
2718 void circuit_expire_all_dirty_circs(void);
2719 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
2720 int line
, const char *file
);
2721 int circuit_get_cpath_len(origin_circuit_t
*circ
);
2722 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
2723 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
2724 or_connection_t
*or_conn
);
2725 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
2727 #define circuit_mark_for_close(c, reason) \
2728 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
2730 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
2731 void assert_circuit_ok(const circuit_t
*c
);
2732 void circuit_free_all(void);
2734 /********************************* circuituse.c ************************/
2736 void circuit_expire_building(time_t now
);
2737 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
2738 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
2740 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
2741 const or_options_t
*options
);
2742 void circuit_build_needed_circs(time_t now
);
2743 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
2745 void reset_bandwidth_test(void);
2746 int circuit_enough_testing_circs(void);
2748 void circuit_has_opened(origin_circuit_t
*circ
);
2749 void circuit_build_failed(origin_circuit_t
*circ
);
2751 /** Flag to set when a circuit should have only a single hop. */
2752 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
2753 /** Flag to set when a circuit needs to be built of high-uptime nodes */
2754 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
2755 /** Flag to set when a circuit needs to be build of high-capcity nodes */
2756 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
2757 /** Flag to set when the last hop of a circuit doesn't need to be an
2759 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
2760 origin_circuit_t
*circuit_launch_by_nickname(uint8_t purpose
,
2761 const char *exit_nickname
,
2763 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
2764 extend_info_t
*info
,
2766 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
2767 routerinfo_t
*exit
, int flags
);
2768 void circuit_reset_failure_count(int timeout
);
2769 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
2770 origin_circuit_t
*circ
,
2771 crypt_path_t
*cpath
);
2772 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
2774 /********************************* command.c ***************************/
2776 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
2777 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
2779 extern uint64_t stats_n_padding_cells_processed
;
2780 extern uint64_t stats_n_create_cells_processed
;
2781 extern uint64_t stats_n_created_cells_processed
;
2782 extern uint64_t stats_n_relay_cells_processed
;
2783 extern uint64_t stats_n_destroy_cells_processed
;
2785 /********************************* config.c ***************************/
2787 /** An error from options_trial_assign() or options_init_from_string(). */
2788 typedef enum setopt_err_t
{
2790 SETOPT_ERR_MISC
= -1,
2791 SETOPT_ERR_PARSE
= -2,
2792 SETOPT_ERR_TRANSITION
= -3,
2793 SETOPT_ERR_SETTING
= -4,
2796 or_options_t
*get_options(void);
2797 int set_options(or_options_t
*new_val
, char **msg
);
2798 void config_free_all(void);
2799 const char *safe_str(const char *address
);
2800 const char *escaped_safe_str(const char *address
);
2801 const char *get_version(void);
2803 int config_get_lines(const char *string
, config_line_t
**result
);
2804 void config_free_lines(config_line_t
*front
);
2805 int options_trial_assign(config_line_t
*list
, int use_defaults
,
2806 int clear_first
, char **msg
);
2807 int resolve_my_address(int warn_severity
, or_options_t
*options
,
2808 uint32_t *addr
, char **hostname_out
);
2809 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
2810 void options_init(or_options_t
*options
);
2811 int options_init_from_torrc(int argc
, char **argv
);
2812 setopt_err_t
options_init_from_string(const char *cf
,
2813 int command
, const char *command_arg
, char **msg
);
2814 int option_is_recognized(const char *key
);
2815 const char *option_get_canonical_name(const char *key
);
2816 config_line_t
*option_get_assignment(or_options_t
*options
,
2818 int options_save_current(void);
2819 const char *get_torrc_fname(void);
2820 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
2821 const char *sub1
, const char *sub2
,
2822 const char *suffix
);
2823 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
2824 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
2825 /** Return a newly allocated string containing datadir/sub1. See
2826 * get_datadir_fname2_suffix. */
2827 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
2828 /** Return a newly allocated string containing datadir/sub1/sub2. See
2829 * get_datadir_fname2_suffix. */
2830 #define get_datadir_fname2(sub1,sub2) \
2831 get_datadir_fname2_suffix((sub1), (sub2), NULL)
2832 /** Return a newly allocated string containing datadir/sub1suffix. See
2833 * get_datadir_fname2_suffix. */
2834 #define get_datadir_fname_suffix(sub1, suffix) \
2835 get_datadir_fname2_suffix((sub1), NULL, (suffix))
2837 or_state_t
*get_or_state(void);
2838 int or_state_save(time_t now
);
2840 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
2841 int getinfo_helper_config(control_connection_t
*conn
,
2842 const char *question
, char **answer
);
2844 #ifdef CONFIG_PRIVATE
2845 /* Used only by config.c and test.c */
2846 or_options_t
*options_new(void);
2849 /********************************* connection.c ***************************/
2851 const char *conn_type_to_string(int type
);
2852 const char *conn_state_to_string(int type
, int state
);
2854 dir_connection_t
*dir_connection_new(int socket_family
);
2855 or_connection_t
*or_connection_new(int socket_family
);
2856 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
2857 control_connection_t
*control_connection_new(int socket_family
);
2858 connection_t
*connection_new(int type
, int socket_family
);
2860 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
2861 void connection_unregister_events(connection_t
*conn
);
2862 void connection_free(connection_t
*conn
);
2863 void connection_free_all(void);
2864 void connection_about_to_close_connection(connection_t
*conn
);
2865 void connection_close_immediate(connection_t
*conn
);
2866 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
2868 #define connection_mark_for_close(c) \
2869 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
2871 void connection_expire_held_open(void);
2873 int connection_connect(connection_t
*conn
, const char *address
,
2874 const tor_addr_t
*addr
,
2875 uint16_t port
, int *socket_error
);
2876 int retry_all_listeners(smartlist_t
*replaced_conns
,
2877 smartlist_t
*new_conns
);
2879 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
2880 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
2881 void connection_bucket_init(void);
2882 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
2884 int connection_handle_read(connection_t
*conn
);
2886 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
2888 int connection_wants_to_flush(connection_t
*conn
);
2889 int connection_outbuf_too_full(connection_t
*conn
);
2890 int connection_handle_write(connection_t
*conn
, int force
);
2891 void _connection_write_to_buf_impl(const char *string
, size_t len
,
2892 connection_t
*conn
, int zlib
);
2893 static void connection_write_to_buf(const char *string
, size_t len
,
2894 connection_t
*conn
);
2895 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
2896 dir_connection_t
*conn
, int done
);
2898 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
2900 _connection_write_to_buf_impl(string
, len
, conn
, 0);
2903 connection_write_to_buf_zlib(const char *string
, size_t len
,
2904 dir_connection_t
*conn
, int done
)
2906 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
2909 connection_t
*connection_get_by_global_id(uint64_t id
);
2911 connection_t
*connection_get_by_type(int type
);
2912 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
2913 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
2914 const tor_addr_t
*addr
,
2915 uint16_t port
, int purpose
);
2916 connection_t
*connection_get_by_type_state(int type
, int state
);
2917 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
2918 const char *rendquery
,
2921 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
2922 int connection_is_listener(connection_t
*conn
);
2923 int connection_state_is_open(connection_t
*conn
);
2924 int connection_state_is_connecting(connection_t
*conn
);
2926 char *alloc_http_authenticator(const char *authenticator
);
2928 void assert_connection_ok(connection_t
*conn
, time_t now
);
2929 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
2930 void connection_dump_buffer_mem_stats(int severity
);
2931 void remove_file_if_very_old(const char *fname
, time_t now
);
2933 /********************************* connection_edge.c *************************/
2935 #define connection_mark_unattached_ap(conn, endreason) \
2936 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
2938 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
2939 int line
, const char *file
);
2940 int connection_edge_reached_eof(edge_connection_t
*conn
);
2941 int connection_edge_process_inbuf(edge_connection_t
*conn
,
2942 int package_partial
);
2943 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
2944 int connection_edge_end(edge_connection_t
*conn
, char reason
);
2945 int connection_edge_end_errno(edge_connection_t
*conn
);
2946 int connection_edge_finished_flushing(edge_connection_t
*conn
);
2947 int connection_edge_finished_connecting(edge_connection_t
*conn
);
2949 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
2950 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
2952 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
2954 int use_begindir
, int want_onehop
);
2955 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
2958 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
2965 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
2966 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
2967 void connection_exit_connect(edge_connection_t
*conn
);
2968 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
2969 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
2970 void connection_ap_expire_beginning(void);
2971 void connection_ap_attach_pending(void);
2972 void connection_ap_fail_onehop(const char *failed_digest
,
2973 cpath_build_state_t
*build_state
);
2974 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
2975 int connection_ap_detach_retriable(edge_connection_t
*conn
,
2976 origin_circuit_t
*circ
,
2978 int connection_ap_process_transparent(edge_connection_t
*conn
);
2980 int address_is_invalid_destination(const char *address
, int client
);
2982 void addressmap_init(void);
2983 void addressmap_clean(time_t now
);
2984 void addressmap_clear_configured(void);
2985 void addressmap_clear_transient(void);
2986 void addressmap_free_all(void);
2987 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
2988 int addressmap_have_mapping(const char *address
);
2990 ADDRMAPSRC_CONTROLLER
, ADDRMAPSRC_TORRC
, ADDRMAPSRC_TRACKEXIT
,
2992 } addressmap_entry_source_t
;
2993 void addressmap_register(const char *address
, char *new_address
,
2994 time_t expires
, addressmap_entry_source_t source
);
2995 int parse_virtual_addr_network(const char *val
, int validate_only
,
2997 int client_dns_incr_failures(const char *address
);
2998 void client_dns_clear_failures(const char *address
);
2999 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3000 const char *exitname
, int ttl
);
3001 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3002 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3003 time_t max_expires
, int want_expiry
);
3004 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3005 origin_circuit_t
*circ
,
3006 crypt_path_t
*cpath
);
3007 int hostname_is_noconnect_address(const char *address
);
3009 void set_exit_redirects(smartlist_t
*lst
);
3010 typedef enum hostname_type_t
{
3011 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3013 hostname_type_t
parse_extended_hostname(char *address
);
3015 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3016 int get_pf_socket(void);
3019 /********************************* connection_or.c ***************************/
3021 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3022 void connection_or_clear_identity_map(void);
3023 or_connection_t
*connection_or_get_by_identity_digest(const char *digest
);
3025 int connection_or_reached_eof(or_connection_t
*conn
);
3026 int connection_or_process_inbuf(or_connection_t
*conn
);
3027 int connection_or_flushed_some(or_connection_t
*conn
);
3028 int connection_or_finished_flushing(or_connection_t
*conn
);
3029 int connection_or_finished_connecting(or_connection_t
*conn
);
3031 void connection_or_connect_failed(or_connection_t
*conn
,
3032 int reason
, const char *msg
);
3033 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3034 const char *id_digest
);
3036 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3037 int connection_tls_continue_handshake(or_connection_t
*conn
);
3039 void or_handshake_state_free(or_handshake_state_t
*state
);
3040 int connection_or_set_state_open(or_connection_t
*conn
);
3041 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3042 or_connection_t
*conn
);
3043 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3044 or_connection_t
*conn
);
3045 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3047 int connection_or_send_netinfo(or_connection_t
*conn
);
3048 int connection_or_send_cert(or_connection_t
*conn
);
3049 int connection_or_send_link_auth(or_connection_t
*conn
);
3050 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3052 int is_or_protocol_version_known(uint16_t version
);
3054 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3055 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3056 var_cell_t
*var_cell_new(uint16_t payload_len
);
3057 void var_cell_free(var_cell_t
*cell
);
3059 /********************************* control.c ***************************/
3061 typedef enum circuit_status_event_t
{
3062 CIRC_EVENT_LAUNCHED
= 0,
3063 CIRC_EVENT_BUILT
= 1,
3064 CIRC_EVENT_EXTENDED
= 2,
3065 CIRC_EVENT_FAILED
= 3,
3066 CIRC_EVENT_CLOSED
= 4,
3067 } circuit_status_event_t
;
3069 typedef enum stream_status_event_t
{
3070 STREAM_EVENT_SENT_CONNECT
= 0,
3071 STREAM_EVENT_SENT_RESOLVE
= 1,
3072 STREAM_EVENT_SUCCEEDED
= 2,
3073 STREAM_EVENT_FAILED
= 3,
3074 STREAM_EVENT_CLOSED
= 4,
3075 STREAM_EVENT_NEW
= 5,
3076 STREAM_EVENT_NEW_RESOLVE
= 6,
3077 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3078 STREAM_EVENT_REMAP
= 8
3079 } stream_status_event_t
;
3081 typedef enum or_conn_status_event_t
{
3082 OR_CONN_EVENT_LAUNCHED
= 0,
3083 OR_CONN_EVENT_CONNECTED
= 1,
3084 OR_CONN_EVENT_FAILED
= 2,
3085 OR_CONN_EVENT_CLOSED
= 3,
3086 OR_CONN_EVENT_NEW
= 4,
3087 } or_conn_status_event_t
;
3089 void control_update_global_event_mask(void);
3090 void control_adjust_event_log_severity(void);
3092 /** Execute the statement <b>stmt</b>, which may log events concerning the
3093 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3094 * being sent to controllers if <b>conn</b> is a control connection.
3096 * Stmt must not contain any return or goto statements.
3098 #define CONN_LOG_PROTECT(conn, stmt) \
3100 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3101 if (_log_conn_is_control) \
3102 disable_control_logging(); \
3103 STMT_BEGIN stmt; STMT_END; \
3104 if (_log_conn_is_control) \
3105 enable_control_logging(); \
3108 /** Log information about the connection <b>conn</b>, protecting it as with
3109 * CONN_LOG_PROTECT. Example:
3111 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3113 #define LOG_FN_CONN(conn, args) \
3114 CONN_LOG_PROTECT(conn, log_fn args)
3116 int connection_control_finished_flushing(control_connection_t
*conn
);
3117 int connection_control_reached_eof(control_connection_t
*conn
);
3118 int connection_control_process_inbuf(control_connection_t
*conn
);
3120 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3121 #define EVENT_NS 0x000F
3122 int control_event_is_interesting(int event
);
3124 int control_event_circuit_status(origin_circuit_t
*circ
,
3125 circuit_status_event_t e
, int reason
);
3126 int control_event_stream_status(edge_connection_t
*conn
,
3127 stream_status_event_t e
,
3129 int control_event_or_conn_status(or_connection_t
*conn
,
3130 or_conn_status_event_t e
, int reason
);
3131 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3132 int control_event_stream_bandwidth_used(void);
3133 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3134 int control_event_descriptors_changed(smartlist_t
*routers
);
3135 int control_event_address_mapped(const char *from
, const char *to
,
3136 time_t expires
, const char *error
);
3137 int control_event_or_authdir_new_descriptor(const char *action
,
3141 int control_event_my_descriptor_changed(void);
3142 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3143 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3144 int control_event_general_status(int severity
, const char *format
, ...)
3146 int control_event_client_status(int severity
, const char *format
, ...)
3148 int control_event_server_status(int severity
, const char *format
, ...)
3150 int control_event_guard(const char *nickname
, const char *digest
,
3151 const char *status
);
3153 int init_cookie_authentication(int enabled
);
3154 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3155 void disable_control_logging(void);
3156 void enable_control_logging(void);
3158 /** Enum describing various stages of bootstrapping, for use with controller
3159 * bootstrap status events. The values range from 0 to 100. */
3161 BOOTSTRAP_STATUS_UNDEF
=-1,
3162 BOOTSTRAP_STATUS_STARTING
=0,
3163 BOOTSTRAP_STATUS_CONN_DIR
=5,
3164 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3165 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3166 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3167 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3168 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3169 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3170 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3171 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3172 BOOTSTRAP_STATUS_CONN_OR
=80,
3173 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3174 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3175 BOOTSTRAP_STATUS_DONE
=100
3176 } bootstrap_status_t
;
3178 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3179 void control_event_bootstrap_problem(const char *warn
, int reason
);
3181 #ifdef CONTROL_PRIVATE
3182 /* Used only by control.c and test.c */
3183 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3184 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3187 /********************************* cpuworker.c *****************************/
3189 void cpu_init(void);
3190 void cpuworkers_rotate(void);
3191 int connection_cpu_finished_flushing(connection_t
*conn
);
3192 int connection_cpu_reached_eof(connection_t
*conn
);
3193 int connection_cpu_process_inbuf(connection_t
*conn
);
3194 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3198 /********************************* directory.c ***************************/
3200 int directories_have_accepted_server_descriptor(void);
3201 char *authority_type_to_string(authority_type_t auth
);
3202 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3203 authority_type_t type
, const char *payload
,
3204 size_t payload_len
, size_t extrainfo_len
);
3205 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3206 const char *resource
,
3207 int retry_if_no_servers
);
3208 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3209 uint8_t router_purpose
,
3210 const char *resource
);
3211 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3212 uint8_t dir_purpose
,
3213 uint8_t router_purpose
,
3214 int anonymized_connection
,
3215 const char *resource
,
3216 const char *payload
,
3218 time_t if_modified_since
);
3219 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3220 uint8_t dir_purpose
,
3221 uint8_t router_purpose
,
3222 int anonymized_connection
,
3223 const char *resource
,
3224 const char *payload
,
3226 time_t if_modified_since
,
3227 const rend_data_t
*rend_query
);
3229 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3230 compress_method_t
*compression
, char **response
);
3232 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3233 int connection_dir_reached_eof(dir_connection_t
*conn
);
3234 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3235 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3236 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3237 void connection_dir_request_failed(dir_connection_t
*conn
);
3238 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3239 uint16_t or_port
, uint16_t dir_port
,
3240 int supports_conditional_consensus
,
3241 int supports_begindir
, const char *digest
,
3242 uint8_t dir_purpose
, uint8_t router_purpose
,
3243 int anonymized_connection
,
3244 const char *resource
,
3245 const char *payload
, size_t payload_len
,
3246 time_t if_modified_since
);
3248 int dir_split_resource_into_fingerprints(const char *resource
,
3249 smartlist_t
*fp_out
, int *compresseed_out
,
3250 int decode_hex
, int sort_uniq
);
3251 char *directory_dump_request_log(void);
3252 void note_request(const char *key
, size_t bytes
);
3253 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3255 time_t download_status_increment_failure(download_status_t
*dls
,
3256 int status_code
, const char *item
,
3257 int server
, time_t now
);
3258 #define download_status_failed(dls, sc) \
3259 download_status_increment_failure((dls), (sc), NULL, \
3260 get_options()->DirPort, time(NULL))
3262 void download_status_reset(download_status_t
*dls
);
3263 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3265 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3266 * ready to get its download reattempted. */
3268 download_status_is_ready(download_status_t
*dls
, time_t now
,
3271 return (dls
->n_download_failures
<= max_failures
3272 && dls
->next_attempt_at
<= now
);
3275 /********************************* dirserv.c ***************************/
3276 /** Maximum length of an exit policy summary. */
3277 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3279 /** Maximum allowable length of a version line in a networkstatus. */
3280 #define MAX_V_LINE_LEN 128
3281 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3282 * Running Stable Unnamed V2Dir Valid\n". */
3283 #define MAX_FLAG_LINE_LEN 96
3284 /** Length of "w" line for weighting. Currently at most
3285 * "w Bandwidth=<uint32t>\n" */
3286 #define MAX_WEIGHT_LINE_LEN (13+10)
3287 /** Maximum length of an exit policy summary line. */
3288 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3289 /** Amount of space to allocate for each entry: r, s, and v lines. */
3290 #define RS_ENTRY_LEN \
3291 ( /* first line */ \
3292 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3293 5*2 /* ports */ + 10 /* punctuation */ + \
3295 MAX_FLAG_LINE_LEN + \
3297 MAX_WEIGHT_LINE_LEN + \
3299 MAX_POLICY_LINE_LEN + \
3303 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3305 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3307 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3308 int dirserv_load_fingerprint_file(void);
3309 void dirserv_free_fingerprint_list(void);
3310 const char *dirserv_get_nickname_by_digest(const char *digest
);
3311 int dirserv_add_multiple_descriptors(const char *desc
, uint8_t purpose
,
3314 int dirserv_add_descriptor(routerinfo_t
*ri
, const char **msg
);
3315 int getinfo_helper_dirserv_unregistered(control_connection_t
*conn
,
3316 const char *question
, char **answer
);
3317 void dirserv_free_descriptors(void);
3318 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3319 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3320 int for_controller
);
3321 int dirserv_dump_directory_to_string(char **dir_out
,
3322 crypto_pk_env_t
*private_key
);
3324 int directory_fetches_from_authorities(or_options_t
*options
);
3325 int directory_fetches_dir_info_early(or_options_t
*options
);
3326 int directory_fetches_dir_info_later(or_options_t
*options
);
3327 int directory_caches_v2_dir_info(or_options_t
*options
);
3328 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3329 int directory_caches_dir_info(or_options_t
*options
);
3330 int directory_permits_begindir_requests(or_options_t
*options
);
3331 int directory_permits_controller_requests(or_options_t
*options
);
3332 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3334 void directory_set_dirty(void);
3335 cached_dir_t
*dirserv_get_directory(void);
3336 cached_dir_t
*dirserv_get_runningrouters(void);
3337 cached_dir_t
*dirserv_get_consensus(void);
3338 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3339 int is_running_routers
);
3340 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3341 const char *identity
,
3343 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
3345 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3346 void dirserv_clear_old_v1_info(time_t now
);
3347 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3348 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3350 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3352 int for_unencrypted_conn
);
3353 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3355 void dirserv_orconn_tls_done(const char *address
,
3357 const char *digest_rcvd
,
3359 void dirserv_test_reachability(time_t now
, int try_all
);
3360 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3362 int dirserv_would_reject_router(routerstatus_t
*rs
);
3363 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3364 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3365 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3367 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3368 routerstatus_t
*rs
, const char *platform
,
3369 int first_line_only
, int v2_format
);
3370 void dirserv_free_all(void);
3371 void cached_dir_decref(cached_dir_t
*d
);
3372 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3374 /********************************* dirvote.c ************************/
3376 /** Lowest allowable value for VoteSeconds. */
3377 #define MIN_VOTE_SECONDS 20
3378 /** Lowest allowable value for DistSeconds. */
3379 #define MIN_DIST_SECONDS 20
3380 /** Smallest allowable voting interval. */
3381 #define MIN_VOTE_INTERVAL 300
3383 void dirvote_free_all(void);
3385 /* vote manipulation */
3386 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3387 int total_authorities
,
3388 crypto_pk_env_t
*identity_key
,
3389 crypto_pk_env_t
*signing_key
,
3390 const char *legacy_identity_key_digest
,
3391 crypto_pk_env_t
*legacy_signing_key
);
3392 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3393 ns_detached_signatures_t
*sigs
,
3394 const char **msg_out
);
3395 char *networkstatus_get_detached_signatures(networkstatus_t
*consensus
);
3396 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3398 /* cert manipulation */
3399 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3401 /** Describes the schedule by which votes should be generated. */
3402 typedef struct vote_timing_t
{
3404 int n_intervals_valid
;
3408 /* vote scheduling */
3409 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3410 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3411 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3412 void dirvote_act(or_options_t
*options
, time_t now
);
3414 /* invoked on timers and by outside triggers. */
3415 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3416 const char **msg_out
,
3418 int dirvote_add_signatures(const char *detached_signatures_body
,
3420 const char **msg_out
);
3423 const char *dirvote_get_pending_consensus(void);
3424 const char *dirvote_get_pending_detached_signatures(void);
3426 #define DGV_INCLUDE_PENDING 2
3427 #define DGV_INCLUDE_PREVIOUS 4
3428 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3429 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3430 routerinfo_t
*ri
, time_t now
,
3431 int naming
, int exits_can_be_guards
,
3432 int listbadexits
, int listbaddirs
);
3433 void router_clear_status_flags(routerinfo_t
*ri
);
3435 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3436 authority_cert_t
*cert
);
3438 #ifdef DIRVOTE_PRIVATE
3440 format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3441 networkstatus_t
*v3_ns
);
3444 /********************************* dns.c ***************************/
3447 void dns_free_all(void);
3448 uint32_t dns_clip_ttl(uint32_t ttl
);
3449 int dns_reset(void);
3450 void connection_dns_remove(edge_connection_t
*conn
);
3451 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3452 void assert_all_pending_dns_resolves_ok(void);
3453 void dns_cancel_pending_resolve(const char *question
);
3454 int dns_resolve(edge_connection_t
*exitconn
);
3455 void dns_launch_correctness_checks(void);
3456 int dns_seems_to_be_broken(void);
3457 void dns_reset_correctness_checks(void);
3458 int parse_inaddr_arpa_address(const char *address
, struct in_addr
*in
);
3460 /********************************* dnsserv.c ************************/
3462 void dnsserv_configure_listener(connection_t
*conn
);
3463 void dnsserv_close_listener(connection_t
*conn
);
3464 void dnsserv_resolved(edge_connection_t
*conn
,
3469 void dnsserv_reject_request(edge_connection_t
*conn
);
3470 int dnsserv_launch_request(const char *name
, int is_reverse
);
3472 /********************************* geoip.c **************************/
3474 #ifdef GEOIP_PRIVATE
3475 int geoip_parse_entry(const char *line
);
3477 int should_record_bridge_info(or_options_t
*options
);
3478 int geoip_load_file(const char *filename
, or_options_t
*options
);
3479 int geoip_get_country_by_ip(uint32_t ipaddr
);
3480 int geoip_get_n_countries(void);
3481 const char *geoip_get_country_name(country_t num
);
3482 int geoip_is_loaded(void);
3483 country_t
geoip_get_country(const char *countrycode
);
3484 /** Indicates an action that we might be noting geoip statistics on.
3485 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3486 * the others, we're not.
3489 /** We've noticed a connection as a bridge relay. */
3490 GEOIP_CLIENT_CONNECT
= 0,
3491 /** We've served a networkstatus consensus as a directory server. */
3492 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3493 /** We've served a v2 networkstatus consensus as a directory server. */
3494 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3495 } geoip_client_action_t
;
3496 void geoip_note_client_seen(geoip_client_action_t action
,
3497 uint32_t addr
, time_t now
);
3498 void geoip_remove_old_clients(time_t cutoff
);
3499 time_t geoip_get_history_start(void);
3500 char *geoip_get_client_history(time_t now
, geoip_client_action_t action
);
3501 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
3502 int getinfo_helper_geoip(control_connection_t
*control_conn
,
3503 const char *question
, char **answer
);
3504 void geoip_free_all(void);
3505 void dump_geoip_stats(void);
3507 /********************************* hibernate.c **********************/
3509 int accounting_parse_options(or_options_t
*options
, int validate_only
);
3510 int accounting_is_enabled(or_options_t
*options
);
3511 void configure_accounting(time_t now
);
3512 void accounting_run_housekeeping(time_t now
);
3513 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
3514 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
3515 void hibernate_begin_shutdown(void);
3516 int we_are_hibernating(void);
3517 void consider_hibernation(time_t now
);
3518 int getinfo_helper_accounting(control_connection_t
*conn
,
3519 const char *question
, char **answer
);
3520 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
3522 /********************************* main.c ***************************/
3524 extern int has_completed_circuit
;
3526 int connection_add(connection_t
*conn
);
3527 int connection_remove(connection_t
*conn
);
3528 int connection_in_array(connection_t
*conn
);
3529 void add_connection_to_closeable_list(connection_t
*conn
);
3530 int connection_is_on_closeable_list(connection_t
*conn
);
3532 smartlist_t
*get_connection_array(void);
3534 void connection_watch_events(connection_t
*conn
, short events
);
3535 int connection_is_reading(connection_t
*conn
);
3536 void connection_stop_reading(connection_t
*conn
);
3537 void connection_start_reading(connection_t
*conn
);
3539 int connection_is_writing(connection_t
*conn
);
3540 void connection_stop_writing(connection_t
*conn
);
3541 void connection_start_writing(connection_t
*conn
);
3543 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
3545 void directory_all_unreachable(time_t now
);
3546 void directory_info_has_arrived(time_t now
, int from_cache
);
3548 void ip_address_changed(int at_interface
);
3549 void dns_servers_relaunch_checks(void);
3551 void control_signal_act(int the_signal
);
3552 void handle_signals(int is_parent
);
3554 int try_locking(or_options_t
*options
, int err_if_locked
);
3555 int have_lockfile(void);
3556 void release_lockfile(void);
3558 void tor_cleanup(void);
3559 void tor_free_all(int postfork
);
3561 int tor_main(int argc
, char *argv
[]);
3564 int do_main_loop(void);
3565 int do_list_fingerprint(void);
3566 void do_hash_password(void);
3567 int tor_init(int argc
, char **argv
);
3570 /********************************* networkstatus.c *********************/
3572 /** How old do we allow a v2 network-status to get before removing it
3574 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
3577 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3578 } networkstatus_source_t
;
3580 typedef enum version_status_t
{
3581 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3582 VS_OLD
=1, /**< This version is older than any recommended version. */
3583 VS_NEW
=2, /**< This version is newer than any recommended version. */
3584 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3585 * in its series, but later recommended versions exist.
3587 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
3588 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
3589 VS_UNKNOWN
, /**< We have no idea. */
3592 void networkstatus_reset_warnings(void);
3593 void networkstatus_reset_download_failures(void);
3594 int router_reload_v2_networkstatus(void);
3595 int router_reload_consensus_networkstatus(void);
3596 void routerstatus_free(routerstatus_t
*rs
);
3597 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
3598 void networkstatus_vote_free(networkstatus_t
*ns
);
3599 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
3600 networkstatus_t
*vote
,
3601 const char *identity
);
3602 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
3604 int networkstatus_check_voter_signature(networkstatus_t
*consensus
,
3605 networkstatus_voter_info_t
*voter
,
3606 authority_cert_t
*cert
);
3607 char *networkstatus_get_cache_filename(const char *identity_digest
);
3608 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
3609 networkstatus_source_t source
,
3610 smartlist_t
*requested_fingerprints
);
3611 void networkstatus_v2_list_clean(time_t now
);
3612 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
3613 const char *digest
);
3614 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
3615 const char *digest
);
3616 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
3617 const char *digest
, int *found_out
);
3618 const smartlist_t
*networkstatus_get_v2_list(void);
3619 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
3620 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
3621 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
3622 const char *digest
);
3623 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
3624 int warn_if_unnamed
);
3625 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
3626 int networkstatus_nickname_is_unnamed(const char *nickname
);
3627 void networkstatus_consensus_download_failed(int status_code
);
3628 void update_consensus_networkstatus_fetch_time(time_t now
);
3629 int should_delay_dir_fetches(or_options_t
*options
);
3630 void update_networkstatus_downloads(time_t now
);
3631 void update_certificate_downloads(time_t now
);
3632 int consensus_is_waiting_for_certs(void);
3633 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
3634 networkstatus_t
*networkstatus_get_latest_consensus(void);
3635 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
3636 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
3637 #define NSSET_FROM_CACHE 1
3638 #define NSSET_WAS_WAITING_FOR_CERTS 2
3639 #define NSSET_DONT_DOWNLOAD_CERTS 4
3640 int networkstatus_set_current_consensus(const char *consensus
, unsigned flags
);
3641 void networkstatus_note_certs_arrived(void);
3642 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
3643 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
3644 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
3645 int reset_failures
);
3646 void signed_descs_update_status_from_consensus_networkstatus(
3647 smartlist_t
*descs
);
3649 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
3650 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
3651 void networkstatus_dump_bridge_status_to_file(time_t now
);
3652 int getinfo_helper_networkstatus(control_connection_t
*conn
,
3653 const char *question
, char **answer
);
3654 void networkstatus_free_all(void);
3656 /********************************* ntmain.c ***************************/
3662 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
3663 int nt_service_is_stopping(void);
3664 void nt_service_set_state(DWORD state
);
3666 #define nt_service_is_stopping() (0)
3669 /********************************* onion.c ***************************/
3671 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
3672 or_circuit_t
*onion_next_task(char **onionskin_out
);
3673 void onion_pending_remove(or_circuit_t
*circ
);
3675 int onion_skin_create(crypto_pk_env_t
*router_key
,
3676 crypto_dh_env_t
**handshake_state_out
,
3677 char *onion_skin_out
);
3679 int onion_skin_server_handshake(const char *onion_skin
,
3680 crypto_pk_env_t
*private_key
,
3681 crypto_pk_env_t
*prev_private_key
,
3682 char *handshake_reply_out
,
3684 size_t key_out_len
);
3686 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
3687 const char *handshake_reply
,
3689 size_t key_out_len
);
3691 int fast_server_handshake(const char *key_in
,
3692 char *handshake_reply_out
,
3694 size_t key_out_len
);
3696 int fast_client_handshake(const char *handshake_state
,
3697 const char *handshake_reply_out
,
3699 size_t key_out_len
);
3701 void clear_pending_onions(void);
3703 /********************************* policies.c ************************/
3705 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
3708 #define POLICY_BUF_LEN 52
3711 ADDR_POLICY_ACCEPTED
=0,
3712 ADDR_POLICY_REJECTED
=-1,
3713 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3714 ADDR_POLICY_PROBABLY_REJECTED
=2
3715 } addr_policy_result_t
;
3717 int firewall_is_fascist_or(void);
3718 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
3719 int fascist_firewall_allows_or(routerinfo_t
*ri
);
3720 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
3721 int dir_policy_permits_address(const tor_addr_t
*addr
);
3722 int socks_policy_permits_address(const tor_addr_t
*addr
);
3723 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
3724 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
3725 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
3726 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
3728 int validate_addr_policies(or_options_t
*options
, char **msg
);
3729 void policy_expand_private(smartlist_t
**policy
);
3730 int policies_parse_from_options(or_options_t
*options
);
3732 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
3733 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
3734 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
3735 uint16_t port
, smartlist_t
*policy
);
3736 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
3737 uint16_t port
, smartlist_t
*policy
);
3738 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
3739 int rejectprivate
, const char *local_address
);
3740 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
3741 int exit_policy_is_general_exit(smartlist_t
*policy
);
3742 int policy_is_reject_star(smartlist_t
*policy
);
3743 int getinfo_helper_policies(control_connection_t
*conn
,
3744 const char *question
, char **answer
);
3745 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
3746 int format_for_desc
);
3748 void addr_policy_list_free(smartlist_t
*p
);
3749 void addr_policy_free(addr_policy_t
*p
);
3750 void policies_free_all(void);
3752 char *policy_summarize(smartlist_t
*policy
);
3754 /********************************* reasons.c ***************************/
3756 const char *stream_end_reason_to_control_string(int reason
);
3757 const char *stream_end_reason_to_string(int reason
);
3758 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
3759 uint8_t errno_to_stream_end_reason(int e
);
3761 const char *orconn_end_reason_to_control_string(int r
);
3762 int tls_error_to_orconn_end_reason(int e
);
3763 int errno_to_orconn_end_reason(int e
);
3765 const char *circuit_end_reason_to_control_string(int reason
);
3767 /********************************* relay.c ***************************/
3769 extern uint64_t stats_n_relay_cells_relayed
;
3770 extern uint64_t stats_n_relay_cells_delivered
;
3772 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
3773 int cell_direction
);
3775 void relay_header_pack(char *dest
, const relay_header_t
*src
);
3776 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
3777 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
3778 uint8_t relay_command
, const char *payload
,
3779 size_t payload_len
, crypt_path_t
*cpath_layer
);
3780 int connection_edge_send_command(edge_connection_t
*fromconn
,
3781 uint8_t relay_command
, const char *payload
,
3782 size_t payload_len
);
3783 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
3784 int package_partial
);
3785 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
3787 extern uint64_t stats_n_data_cells_packaged
;
3788 extern uint64_t stats_n_data_bytes_packaged
;
3789 extern uint64_t stats_n_data_cells_received
;
3790 extern uint64_t stats_n_data_bytes_received
;
3792 void init_cell_pool(void);
3793 void free_cell_pool(void);
3794 void clean_cell_pool(void);
3795 void dump_cell_pool_usage(int severity
);
3797 void cell_queue_clear(cell_queue_t
*queue
);
3798 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
3799 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
3801 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
3802 cell_t
*cell
, int direction
);
3803 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
3804 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
3805 int max
, time_t now
);
3806 void assert_active_circuits_ok(or_connection_t
*orconn
);
3807 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3808 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3810 int append_address_to_payload(char *payload_out
, const tor_addr_t
*addr
);
3811 const char *decode_address_from_payload(tor_addr_t
*addr_out
,
3812 const char *payload
,
3815 /********************************* rephist.c ***************************/
3817 void rep_hist_init(void);
3818 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
3819 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
3820 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
3821 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
3822 void rep_hist_note_extend_succeeded(const char *from_name
,
3823 const char *to_name
);
3824 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
3825 void rep_hist_dump_stats(time_t now
, int severity
);
3826 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
3827 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
3828 int rep_hist_bandwidth_assess(void);
3829 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
3830 void rep_hist_update_state(or_state_t
*state
);
3831 int rep_hist_load_state(or_state_t
*state
, char **err
);
3832 void rep_history_clean(time_t before
);
3834 void rep_hist_note_router_reachable(const char *id
, time_t when
);
3835 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
3836 int rep_hist_record_mtbf_data(void);
3837 int rep_hist_load_mtbf_data(time_t now
);
3839 time_t rep_hist_downrate_old_runs(time_t now
);
3840 double rep_hist_get_stability(const char *id
, time_t when
);
3841 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
3842 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
3843 int rep_hist_have_measured_enough_stability(void);
3845 void rep_hist_note_used_port(time_t now
, uint16_t port
);
3846 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
3847 void rep_hist_note_used_resolve(time_t now
);
3848 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
3850 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
3851 int *need_capacity
);
3853 int any_predicted_circuits(time_t now
);
3854 int rep_hist_circbuilding_dormant(time_t now
);
3856 /** Possible public/private key operations in Tor: used to keep track of where
3857 * we're spending our time. */
3860 VERIFY_DIR
, VERIFY_RTR
,
3861 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
3862 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
3863 REND_CLIENT
, REND_MID
, REND_SERVER
,
3865 void note_crypto_pk_op(pk_op_t operation
);
3866 void dump_pk_ops(int severity
);
3868 void rep_hist_free_all(void);
3870 /* for hidden service usage statistics */
3871 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
3872 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
3873 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
3874 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
3875 void hs_usage_write_statistics_to_file(time_t now
);
3876 void hs_usage_free_all(void);
3878 /********************************* rendclient.c ***************************/
3880 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
3881 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
3882 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
3883 size_t request_len
);
3884 void rend_client_refetch_renddesc(const char *query
);
3885 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
3886 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
3887 const rend_data_t
*rend_query
);
3888 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
3889 size_t request_len
);
3890 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
3891 size_t request_len
);
3892 void rend_client_desc_trynow(const char *query
, int rend_version
);
3894 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
3896 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
3897 origin_circuit_t
*rendcirc
);
3898 int rend_parse_service_authorization(or_options_t
*options
,
3900 rend_service_authorization_t
*rend_client_lookup_service_authorization(
3901 const char *onion_address
);
3902 void rend_service_authorization_free_all(void);
3903 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
3905 /********************************* rendcommon.c ***************************/
3907 /** Hidden-service side configuration of client authorization. */
3908 typedef struct rend_authorized_client_t
{
3910 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
3911 crypto_pk_env_t
*client_key
;
3912 } rend_authorized_client_t
;
3914 /** ASCII-encoded v2 hidden service descriptor. */
3915 typedef struct rend_encoded_v2_service_descriptor_t
{
3916 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
3917 char *desc_str
; /**< Descriptor string. */
3918 } rend_encoded_v2_service_descriptor_t
;
3920 /** Introduction point information. */
3921 typedef struct rend_intro_point_t
{
3922 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
3923 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
3924 * key, if this descriptor is V2. */
3925 } rend_intro_point_t
;
3927 /** Information used to connect to a hidden service. */
3928 typedef struct rend_service_descriptor_t
{
3929 crypto_pk_env_t
*pk
; /**< This service's public key. */
3930 int version
; /**< Version of the descriptor format: 0 or 2. */
3931 time_t timestamp
; /**< Time when the descriptor was generated. */
3932 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
3933 * (We allow bits '0', '1', and '2' to be set.) */
3934 /** List of the service's introduction points. Elements are removed if
3935 * introduction attempts fail. */
3936 smartlist_t
*intro_nodes
;
3937 /** Has descriptor been uploaded to all hidden service directories? */
3938 int all_uploads_performed
;
3939 /** List of hidden service directories to which an upload request for
3940 * this descriptor could be sent. Smartlist exists only when at least one
3941 * of the previous upload requests failed (otherwise it's not important
3942 * to know which uploads succeeded and which not). */
3943 smartlist_t
*successful_uploads
;
3944 } rend_service_descriptor_t
;
3946 /** Free all storage associated with <b>data</b> */
3948 rend_data_free(rend_data_t
*data
)
3953 int rend_cmp_service_ids(const char *one
, const char *two
);
3955 void rend_process_relay_cell(circuit_t
*circ
, int command
, size_t length
,
3956 const char *payload
);
3958 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
3959 int rend_encode_service_descriptor(rend_service_descriptor_t
*desc
,
3960 crypto_pk_env_t
*key
,
3963 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
3965 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
3966 void rend_encoded_v2_service_descriptor_free(
3967 rend_encoded_v2_service_descriptor_t
*desc
);
3968 void rend_intro_point_free(rend_intro_point_t
*intro
);
3970 /** A cached rendezvous descriptor. */
3971 typedef struct rend_cache_entry_t
{
3972 size_t len
; /**< Length of <b>desc</b> */
3973 time_t received
; /**< When was the descriptor received? */
3974 char *desc
; /**< Service descriptor */
3975 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
3976 } rend_cache_entry_t
;
3978 void rend_cache_init(void);
3979 void rend_cache_clean(void);
3980 void rend_cache_clean_v2_descs_as_dir(void);
3981 void rend_cache_free_all(void);
3982 int rend_valid_service_id(const char *query
);
3983 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
3985 int rend_cache_lookup_entry(const char *query
, int version
,
3986 rend_cache_entry_t
**entry_out
);
3987 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
3988 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
3989 int rend_cache_store_v2_desc_as_client(const char *desc
,
3990 const rend_data_t
*rend_query
);
3991 int rend_cache_store_v2_desc_as_dir(const char *desc
);
3992 int rend_cache_size(void);
3993 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
3994 rend_service_descriptor_t
*desc
, time_t now
,
3995 uint8_t period
, rend_auth_type_t auth_type
,
3996 crypto_pk_env_t
*client_key
,
3997 smartlist_t
*client_cookies
);
3998 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
3999 const char *descriptor_cookie
,
4000 time_t now
, uint8_t replica
);
4001 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4002 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4003 const char *service_id
,
4004 const char *secret_id_part
);
4006 /********************************* rendservice.c ***************************/
4008 int num_rend_services(void);
4009 int rend_config_services(or_options_t
*options
, int validate_only
);
4010 int rend_service_load_keys(void);
4011 void rend_services_init(void);
4012 void rend_services_introduce(void);
4013 void rend_consider_services_upload(time_t now
);
4014 void rend_hsdir_routers_changed(void);
4015 void rend_consider_descriptor_republication(void);
4017 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4018 int rend_service_intro_established(origin_circuit_t
*circuit
,
4019 const char *request
,
4020 size_t request_len
);
4021 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4022 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
4023 size_t request_len
);
4024 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4025 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4026 origin_circuit_t
*circ
);
4027 void rend_service_dump_stats(int severity
);
4028 void rend_service_free_all(void);
4030 /********************************* rendmid.c *******************************/
4031 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
4032 size_t request_len
);
4033 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
4034 size_t request_len
);
4035 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
4036 size_t request_len
);
4037 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
4038 size_t request_len
);
4040 /********************************* router.c ***************************/
4042 crypto_pk_env_t
*get_onion_key(void);
4043 time_t get_onion_key_set_at(void);
4044 void set_identity_key(crypto_pk_env_t
*k
);
4045 crypto_pk_env_t
*get_identity_key(void);
4046 int identity_key_is_set(void);
4047 authority_cert_t
*get_my_v3_authority_cert(void);
4048 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4049 authority_cert_t
*get_my_v3_legacy_cert(void);
4050 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4051 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4052 void rotate_onion_key(void);
4053 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4055 void v3_authority_check_key_expiry(void);
4057 int init_keys(void);
4059 int check_whether_orport_reachable(void);
4060 int check_whether_dirport_reachable(void);
4061 void consider_testing_reachability(int test_or
, int test_dir
);
4062 void router_orport_found_reachable(void);
4063 void router_dirport_found_reachable(void);
4064 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4066 int authdir_mode(or_options_t
*options
);
4067 int authdir_mode_v1(or_options_t
*options
);
4068 int authdir_mode_v2(or_options_t
*options
);
4069 int authdir_mode_v3(or_options_t
*options
);
4070 int authdir_mode_any_main(or_options_t
*options
);
4071 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4072 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4073 int authdir_mode_publishes_statuses(or_options_t
*options
);
4074 int authdir_mode_tests_reachability(or_options_t
*options
);
4075 int authdir_mode_bridge(or_options_t
*options
);
4077 int clique_mode(or_options_t
*options
);
4078 int server_mode(or_options_t
*options
);
4079 int advertised_server_mode(void);
4080 int proxy_mode(or_options_t
*options
);
4081 void consider_publishable_server(int force
);
4083 int router_is_clique_mode(routerinfo_t
*router
);
4084 void router_upload_dir_desc_to_dirservers(int force
);
4085 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4086 void mark_my_descriptor_dirty(void);
4087 void check_descriptor_bandwidth_changed(time_t now
);
4088 void check_descriptor_ipaddress_changed(time_t now
);
4089 void router_new_address_suggestion(const char *suggestion
,
4090 const dir_connection_t
*d_conn
);
4091 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4092 routerinfo_t
*router_get_my_routerinfo(void);
4093 extrainfo_t
*router_get_my_extrainfo(void);
4094 const char *router_get_my_descriptor(void);
4095 int router_digest_is_me(const char *digest
);
4096 int router_extrainfo_digest_is_me(const char *digest
);
4097 int router_is_me(routerinfo_t
*router
);
4098 int router_fingerprint_is_me(const char *fp
);
4099 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4100 int router_rebuild_descriptor(int force
);
4101 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4102 crypto_pk_env_t
*ident_key
);
4103 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4104 crypto_pk_env_t
*ident_key
);
4105 int is_legal_nickname(const char *s
);
4106 int is_legal_nickname_or_hexdigest(const char *s
);
4107 int is_legal_hexdigest(const char *s
);
4108 void router_get_verbose_nickname(char *buf
, routerinfo_t
*router
);
4109 void router_reset_warnings(void);
4110 void router_reset_reachability(void);
4111 void router_free_all(void);
4113 const char *router_purpose_to_string(uint8_t p
);
4114 uint8_t router_purpose_from_string(const char *s
);
4116 #ifdef ROUTER_PRIVATE
4117 /* Used only by router.c and test.c */
4118 void get_platform_str(char *platform
, size_t len
);
4121 /********************************* routerlist.c ***************************/
4123 /** Represents information about a single trusted directory server. */
4124 typedef struct trusted_dir_server_t
{
4127 char *address
; /**< Hostname. */
4128 uint32_t addr
; /**< IPv4 address. */
4129 uint16_t dir_port
; /**< Directory port. */
4130 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4131 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4132 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4133 * high-security) identity key. */
4135 unsigned int is_running
:1; /**< True iff we think this server is running. */
4137 /** True iff this server has accepted the most recent server descriptor
4138 * we tried to upload to it. */
4139 unsigned int has_accepted_serverdesc
:1;
4141 /** What kind of authority is this? (Bitfield.) */
4142 authority_type_t type
;
4144 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4145 * v2 network status. */
4146 time_t addr_current_at
; /**< When was the document that we derived the
4147 * address information from published? */
4149 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4150 * dir_server_t to directory_initiate_command_*
4151 * as a routerstatus_t. Not updated by the
4152 * router-status management code!
4154 } trusted_dir_server_t
;
4156 #define ROUTER_REQUIRED_MIN_BANDWIDTH 10000
4158 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4160 int get_n_authorities(authority_type_t type
);
4161 int trusted_dirs_reload_certs(void);
4162 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4164 void trusted_dirs_flush_certs_to_disk(void);
4165 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4166 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4167 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4168 const char *sk_digest
);
4169 void authority_cert_get_all(smartlist_t
*certs_out
);
4170 void authority_cert_dl_failed(const char *id_digest
, int status
);
4171 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4172 int router_reload_router_list(void);
4173 smartlist_t
*router_get_trusted_dir_servers(void);
4175 /* Flags for pick_directory_server and pick_trusteddirserver. */
4176 #define PDS_ALLOW_SELF (1<<0)
4177 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4178 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4179 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4180 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4181 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4182 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4183 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4184 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4185 double *v3_share_out
);
4186 void router_reset_status_download_failures(void);
4187 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4188 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4189 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4190 int must_be_running
);
4191 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4192 routerinfo_t
*routerlist_find_my_routerinfo(void);
4193 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4195 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4196 int need_capacity
, int need_guard
);
4197 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4198 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4201 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4202 } bandwidth_weight_rule_t
;
4203 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4204 bandwidth_weight_rule_t rule
);
4205 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4207 /** Flags to be control router_choose_random_node */
4209 CRN_NEED_UPTIME
= 1<<0,
4210 CRN_NEED_CAPACITY
= 1<<1,
4211 CRN_NEED_GUARD
= 1<<2,
4212 CRN_ALLOW_INVALID
= 1<<3,
4213 /* XXXX021 not used, apparently. */
4214 CRN_STRICT_PREFERRED
= 1<<4,
4215 /* XXXX021 not used, apparently. */
4216 CRN_WEIGHT_AS_EXIT
= 1<<5
4217 } router_crn_flags_t
;
4219 routerinfo_t
*router_choose_random_node(const char *preferred
,
4220 smartlist_t
*excludedsmartlist
,
4221 struct routerset_t
*excludedset
,
4222 router_crn_flags_t flags
);
4224 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4225 int warn_if_unnamed
);
4226 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4227 int router_digest_is_trusted_dir_type(const char *digest
,
4228 authority_type_t type
);
4229 #define router_digest_is_trusted_dir(d) \
4230 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4232 int router_addr_is_trusted_dir(uint32_t addr
);
4233 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4234 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4235 routerinfo_t
*router_get_by_digest(const char *digest
);
4236 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4237 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4238 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4239 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4240 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4241 routerlist_t
*router_get_routerlist(void);
4242 void routerinfo_free(routerinfo_t
*router
);
4243 void extrainfo_free(extrainfo_t
*extrainfo
);
4244 void routerlist_free(routerlist_t
*rl
);
4245 void dump_routerlist_mem_usage(int severity
);
4246 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
);
4247 void routerlist_free_all(void);
4248 void routerlist_reset_warnings(void);
4249 void router_set_status(const char *digest
, int up
);
4250 int router_add_to_routerlist(routerinfo_t
*router
, const char **msg
,
4251 int from_cache
, int from_fetch
);
4252 int router_add_extrainfo_to_routerlist(extrainfo_t
*ei
, const char **msg
,
4253 int from_cache
, int from_fetch
);
4254 void routerlist_remove_old_routers(void);
4255 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4257 void router_load_routers_from_string(const char *s
, const char *eos
,
4258 saved_location_t saved_location
,
4259 smartlist_t
*requested_fingerprints
,
4260 int descriptor_digests
,
4261 const char *prepend_annotations
);
4262 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4263 saved_location_t saved_location
,
4264 smartlist_t
*requested_fingerprints
,
4265 int descriptor_digests
);
4266 void routerlist_retry_directory_downloads(time_t now
);
4267 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4269 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4270 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4271 const char *address
,
4272 uint16_t dir_port
, uint16_t or_port
,
4273 const char *digest
, const char *v3_auth_digest
,
4274 authority_type_t type
);
4275 void authority_cert_free(authority_cert_t
*cert
);
4276 void clear_trusted_dir_servers(void);
4277 int any_trusted_dir_is_v1_authority(void);
4278 void update_router_descriptor_downloads(time_t now
);
4279 void update_extrainfo_downloads(time_t now
);
4280 int router_have_minimum_dir_info(void);
4281 void router_dir_info_changed(void);
4282 const char *get_dir_info_status_string(void);
4283 int count_loading_descriptors_progress(void);
4284 void router_reset_descriptor_download_failures(void);
4285 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
4286 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
4287 signed_descriptor_t
*sd
,
4289 void routerlist_assert_ok(routerlist_t
*rl
);
4290 const char *esc_router_info(routerinfo_t
*router
);
4291 void routers_sort_by_identity(smartlist_t
*routers
);
4293 routerset_t
*routerset_new(void);
4294 int routerset_parse(routerset_t
*target
, const char *s
,
4295 const char *description
);
4296 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
4297 int routerset_is_list(const routerset_t
*set
);
4298 int routerset_needs_geoip(const routerset_t
*set
);
4299 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
4300 int routerset_contains_routerstatus(const routerset_t
*set
,
4301 routerstatus_t
*rs
);
4302 int routerset_contains_extendinfo(const routerset_t
*set
, extend_info_t
*ei
);
4303 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
4305 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
4306 const routerset_t
*include
,
4307 const routerset_t
*exclude
, int running_only
);
4308 void routerset_subtract_routers(smartlist_t
*out
,
4309 const routerset_t
*routerset
);
4310 char *routerset_to_string(const routerset_t
*routerset
);
4311 void routerset_refresh_countries(routerset_t
*target
);
4312 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
4313 void routerset_free(routerset_t
*routerset
);
4314 void routerinfo_set_country(routerinfo_t
*ri
);
4315 void routerlist_refresh_countries(void);
4317 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
4319 int hid_serv_acting_as_directory(void);
4320 int hid_serv_responsible_for_desc_id(const char *id
);
4322 /********************************* routerparse.c ************************/
4324 #define MAX_STATUS_TAG_LEN 32
4325 /** Structure to hold parsed Tor versions. This is a little messier
4326 * than we would like it to be, because we changed version schemes with 0.1.0.
4328 * See version-spec.txt for the whole business.
4330 typedef struct tor_version_t
{
4334 /** Release status. For version in the post-0.1 format, this is always
4336 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4338 char status_tag
[MAX_STATUS_TAG_LEN
];
4342 int router_get_router_hash(const char *s
, char *digest
);
4343 int router_get_dir_hash(const char *s
, char *digest
);
4344 int router_get_runningrouters_hash(const char *s
, char *digest
);
4345 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
4346 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
4347 int router_get_extrainfo_hash(const char *s
, char *digest
);
4348 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
4350 crypto_pk_env_t
*private_key
);
4351 int router_parse_list_from_string(const char **s
, const char *eos
,
4353 saved_location_t saved_location
,
4355 int allow_annotations
,
4356 const char *prepend_annotations
);
4357 int router_parse_routerlist_from_directory(const char *s
,
4358 routerlist_t
**dest
,
4359 crypto_pk_env_t
*pkey
,
4361 int write_to_cache
);
4362 int router_parse_runningrouters(const char *str
);
4363 int router_parse_directory(const char *str
);
4364 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
4366 int allow_annotations
,
4367 const char *prepend_annotations
);
4368 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
4369 int cache_copy
, struct digest_ri_map_t
*routermap
);
4370 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
4372 version_status_t
tor_version_is_obsolete(const char *myversion
,
4373 const char *versionlist
);
4374 int tor_version_parse(const char *s
, tor_version_t
*out
);
4375 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
4376 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
4377 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
4378 void assert_addr_policy_ok(smartlist_t
*t
);
4379 void dump_distinct_digest_count(int severity
);
4381 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
4382 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
4383 const char **eos_out
,
4384 networkstatus_type_t ns_type
);
4385 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
4386 const char *s
, const char *eos
);
4388 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
4389 const char **end_of_string
);
4390 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
4392 char **intro_points_encrypted_out
,
4393 size_t *intro_points_encrypted_size_out
,
4394 size_t *encoded_size_out
,
4395 const char **next_out
, const char *desc
);
4396 int rend_decrypt_introduction_points(char **ipos_decrypted
,
4397 size_t *ipos_decrypted_size
,
4398 const char *descriptor_cookie
,
4399 const char *ipos_encrypted
,
4400 size_t ipos_encrypted_size
);
4401 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
4402 const char *intro_points_encoded
,
4403 size_t intro_points_encoded_size
);
4404 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);