1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4 * Copyright (c) 2007-2009, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Master header file for Tor-specific functionality.
18 /* If we're building for a static analysis, turn on all the off-by-default
20 #ifndef INSTRUMENT_DOWNLOADS
21 #define INSTRUMENT_DOWNLOADS 1
23 #ifndef ENABLE_GEOIP_STATS
24 #define ENABLE_GEOIP_STATS 1
26 #ifndef ENABLE_BUFFER_STATS
27 #define ENABLE_BUFFER_STATS 1
32 #define WIN32_WINNT 0x400
33 #define _WIN32_WINNT 0x400
34 #define WIN32_LEAN_AND_MEAN
46 #ifdef HAVE_SYS_PARAM_H
47 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
50 #ifdef HAVE_SYS_WAIT_H
53 #ifdef HAVE_SYS_FCNTL_H
54 #include <sys/fcntl.h>
59 #ifdef HAVE_SYS_IOCTL_H
60 #include <sys/ioctl.h>
65 #ifdef HAVE_SYS_STAT_H
68 #ifdef HAVE_ARPA_INET_H
69 #include <arpa/inet.h>
86 #define snprintf _snprintf
93 #include "container.h"
97 #include "compat_libevent.h"
99 /* These signals are defined to help control_signal_act work.
116 /* Controller signals start at a high number so we don't
117 * conflict with system-defined signals. */
118 #define SIGNEWNYM 129
119 #define SIGCLEARDNSCACHE 130
121 #if (SIZEOF_CELL_T != 0)
122 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
123 * that our stuff always calls cell_t something different. */
124 #define cell_t tor_cell_t
127 /** Length of longest allowable configured nickname. */
128 #define MAX_NICKNAME_LEN 19
129 /** Length of a router identity encoded as a hexadecimal digest, plus
130 * possible dollar sign. */
131 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
132 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
133 * equal sign or tilde, nickname. */
134 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
136 /** Maximum size, in bytes, for resized buffers. */
137 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
138 /** Maximum size, in bytes, for any directory object that we've downloaded. */
139 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
141 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
142 * of an HTTP request or response. */
143 #define MAX_HEADERS_SIZE 50000
144 /** Maximum size, in bytes, for any directory object that we're accepting
146 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
148 /** Maximum size, in bytes, of a single router descriptor uploaded to us
149 * as a directory authority. Caches and clients fetch whatever descriptors
150 * the authorities tell them to fetch, and don't care about size. */
151 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
153 /** Maximum size of a single extrainfo document, as above. */
154 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
156 /** How long do we keep DNS cache entries before purging them (regardless of
158 #define MAX_DNS_ENTRY_AGE (30*60)
159 /** How long do we cache/tell clients to cache DNS records when no TTL is
161 #define DEFAULT_DNS_TTL (30*60)
162 /** How long can a TTL be before we stop believing it? */
163 #define MAX_DNS_TTL (3*60*60)
164 /** How small can a TTL be before we stop believing it? Provides rudimentary
166 #define MIN_DNS_TTL (60)
168 /** How often do we rotate onion keys? */
169 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
170 /** How often do we rotate TLS contexts? */
171 #define MAX_SSL_KEY_LIFETIME (2*60*60)
173 /** How old do we allow a router to get before removing it
174 * from the router list? In seconds. */
175 #define ROUTER_MAX_AGE (60*60*48)
176 /** How old can a router get before we (as a server) will no longer
177 * consider it live? In seconds. */
178 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
179 /** How old do we let a saved descriptor get before force-removing it? */
180 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
182 /** Possible rules for generating circuit IDs on an OR connection. */
184 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
185 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
186 /** The other side of a connection is an OP: never create circuits to it,
187 * and let it use any circuit ID it wants. */
188 CIRC_ID_TYPE_NEITHER
=2
191 #define _CONN_TYPE_MIN 3
192 /** Type for sockets listening for OR connections. */
193 #define CONN_TYPE_OR_LISTENER 3
194 /** A bidirectional TLS connection transmitting a sequence of cells.
195 * May be from an OR to an OR, or from an OP to an OR. */
196 #define CONN_TYPE_OR 4
197 /** A TCP connection from an onion router to a stream's destination. */
198 #define CONN_TYPE_EXIT 5
199 /** Type for sockets listening for SOCKS connections. */
200 #define CONN_TYPE_AP_LISTENER 6
201 /** A SOCKS proxy connection from the user application to the onion
203 #define CONN_TYPE_AP 7
204 /** Type for sockets listening for HTTP connections to the directory server. */
205 #define CONN_TYPE_DIR_LISTENER 8
206 /** Type for HTTP connections to the directory server. */
207 #define CONN_TYPE_DIR 9
208 /** Connection from the main process to a CPU worker process. */
209 #define CONN_TYPE_CPUWORKER 10
210 /** Type for listening for connections from user interface process. */
211 #define CONN_TYPE_CONTROL_LISTENER 11
212 /** Type for connections from user interface process. */
213 #define CONN_TYPE_CONTROL 12
214 /** Type for sockets listening for transparent connections redirected by pf or
216 #define CONN_TYPE_AP_TRANS_LISTENER 13
217 /** Type for sockets listening for transparent connections redirected by
219 #define CONN_TYPE_AP_NATD_LISTENER 14
220 /** Type for sockets listening for DNS requests. */
221 #define CONN_TYPE_AP_DNS_LISTENER 15
222 #define _CONN_TYPE_MAX 15
223 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
226 /** True iff <b>x</b> is an edge connection. */
227 #define CONN_IS_EDGE(x) \
228 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
230 /** State for any listener connection. */
231 #define LISTENER_STATE_READY 0
233 #define _CPUWORKER_STATE_MIN 1
234 /** State for a connection to a cpuworker process that's idle. */
235 #define CPUWORKER_STATE_IDLE 1
236 /** State for a connection to a cpuworker process that's processing a
238 #define CPUWORKER_STATE_BUSY_ONION 2
239 #define _CPUWORKER_STATE_MAX 2
241 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
243 #define _OR_CONN_STATE_MIN 1
244 /** State for a connection to an OR: waiting for connect() to finish. */
245 #define OR_CONN_STATE_CONNECTING 1
246 /** State for a connection to an OR: waiting for proxy command to flush. */
247 #define OR_CONN_STATE_PROXY_FLUSHING 2
248 /** State for a connection to an OR: waiting for proxy response. */
249 #define OR_CONN_STATE_PROXY_READING 3
250 /** State for a connection to an OR or client: SSL is handshaking, not done
252 #define OR_CONN_STATE_TLS_HANDSHAKING 4
253 /** State for a connection to an OR: We're doing a second SSL handshake for
254 * renegotiation purposes. */
255 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 5
256 /** State for a connection at an OR: We're waiting for the client to
258 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 6
259 /** State for a connection to an OR: We're done with our SSL handshake, but we
260 * haven't yet negotiated link protocol versions and sent a netinfo cell.
262 #define OR_CONN_STATE_OR_HANDSHAKING 7
263 /** State for a connection to an OR: Ready to send/receive cells. */
264 #define OR_CONN_STATE_OPEN 8
265 #define _OR_CONN_STATE_MAX 8
267 #define _EXIT_CONN_STATE_MIN 1
268 /** State for an exit connection: waiting for response from DNS farm. */
269 #define EXIT_CONN_STATE_RESOLVING 1
270 /** State for an exit connection: waiting for connect() to finish. */
271 #define EXIT_CONN_STATE_CONNECTING 2
272 /** State for an exit connection: open and ready to transmit data. */
273 #define EXIT_CONN_STATE_OPEN 3
274 /** State for an exit connection: waiting to be removed. */
275 #define EXIT_CONN_STATE_RESOLVEFAILED 4
276 #define _EXIT_CONN_STATE_MAX 4
278 /* The AP state values must be disjoint from the EXIT state values. */
279 #define _AP_CONN_STATE_MIN 5
280 /** State for a SOCKS connection: waiting for SOCKS request. */
281 #define AP_CONN_STATE_SOCKS_WAIT 5
282 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
283 * rendezvous descriptor. */
284 #define AP_CONN_STATE_RENDDESC_WAIT 6
285 /** The controller will attach this connection to a circuit; it isn't our
287 #define AP_CONN_STATE_CONTROLLER_WAIT 7
288 /** State for a SOCKS connection: waiting for a completed circuit. */
289 #define AP_CONN_STATE_CIRCUIT_WAIT 8
290 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
291 #define AP_CONN_STATE_CONNECT_WAIT 9
292 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
293 #define AP_CONN_STATE_RESOLVE_WAIT 10
294 /** State for a SOCKS connection: ready to send and receive. */
295 #define AP_CONN_STATE_OPEN 11
296 /** State for a transparent natd connection: waiting for original
298 #define AP_CONN_STATE_NATD_WAIT 12
299 #define _AP_CONN_STATE_MAX 12
301 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
302 * edge connection is not attached to any circuit. */
303 #define AP_CONN_STATE_IS_UNATTACHED(s) \
304 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
306 #define _DIR_CONN_STATE_MIN 1
307 /** State for connection to directory server: waiting for connect(). */
308 #define DIR_CONN_STATE_CONNECTING 1
309 /** State for connection to directory server: sending HTTP request. */
310 #define DIR_CONN_STATE_CLIENT_SENDING 2
311 /** State for connection to directory server: reading HTTP response. */
312 #define DIR_CONN_STATE_CLIENT_READING 3
313 /** State for connection to directory server: happy and finished. */
314 #define DIR_CONN_STATE_CLIENT_FINISHED 4
315 /** State for connection at directory server: waiting for HTTP request. */
316 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
317 /** State for connection at directory server: sending HTTP response. */
318 #define DIR_CONN_STATE_SERVER_WRITING 6
319 #define _DIR_CONN_STATE_MAX 6
321 /** True iff the purpose of <b>conn</b> means that it's a server-side
322 * directory connection. */
323 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
325 #define _CONTROL_CONN_STATE_MIN 1
326 /** State for a control connection: Authenticated and accepting v1 commands. */
327 #define CONTROL_CONN_STATE_OPEN 1
328 /** State for a control connection: Waiting for authentication; speaking
330 #define CONTROL_CONN_STATE_NEEDAUTH 2
331 #define _CONTROL_CONN_STATE_MAX 2
333 #define _DIR_PURPOSE_MIN 3
334 /** A connection to a directory server: download a rendezvous
336 #define DIR_PURPOSE_FETCH_RENDDESC 3
337 /** A connection to a directory server: set after a rendezvous
338 * descriptor is downloaded. */
339 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
340 /** A connection to a directory server: download one or more v2
341 * network-status objects */
342 #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
343 /** A connection to a directory server: download one or more server
345 #define DIR_PURPOSE_FETCH_SERVERDESC 6
346 /** A connection to a directory server: download one or more extra-info
348 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
349 /** A connection to a directory server: upload a server descriptor. */
350 #define DIR_PURPOSE_UPLOAD_DIR 8
351 /** A connection to a directory server: upload a rendezvous
353 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
354 /** A connection to a directory server: upload a v3 networkstatus vote. */
355 #define DIR_PURPOSE_UPLOAD_VOTE 10
356 /** A connection to a directory server: upload a v3 consensus signature */
357 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
358 /** A connection to a directory server: download one or more v3 networkstatus
360 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
361 /** A connection to a directory server: download a v3 detached signatures
362 * object for a consensus. */
363 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
364 /** A connection to a directory server: download a v3 networkstatus
366 #define DIR_PURPOSE_FETCH_CONSENSUS 14
367 /** A connection to a directory server: download one or more directory
368 * authority certificates. */
369 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
371 /** Purpose for connection at a directory server. */
372 #define DIR_PURPOSE_SERVER 16
373 /** A connection to a hidden service directory server: upload a v2 rendezvous
375 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
376 /** A connection to a hidden service directory server: download a v2 rendezvous
378 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
379 #define _DIR_PURPOSE_MAX 18
381 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
382 * directory server. */
383 #define DIR_PURPOSE_IS_UPLOAD(p) \
384 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
385 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
386 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
387 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
389 #define _EXIT_PURPOSE_MIN 1
390 /** This exit stream wants to do an ordinary connect. */
391 #define EXIT_PURPOSE_CONNECT 1
392 /** This exit stream wants to do a resolve (either normal or reverse). */
393 #define EXIT_PURPOSE_RESOLVE 2
394 #define _EXIT_PURPOSE_MAX 2
396 /* !!!! If any connection purpose is ever over 31, we must grow the type
397 * field in connection_t. */
399 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
400 #define CIRCUIT_STATE_BUILDING 0
401 /** Circuit state: Waiting to process the onionskin. */
402 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
403 /** Circuit state: I'd like to deliver a create, but my n_conn is still
405 #define CIRCUIT_STATE_OR_WAIT 2
406 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
407 #define CIRCUIT_STATE_OPEN 3
409 #define _CIRCUIT_PURPOSE_MIN 1
411 /* these circuits were initiated elsewhere */
412 #define _CIRCUIT_PURPOSE_OR_MIN 1
413 /** OR-side circuit purpose: normal circuit, at OR. */
414 #define CIRCUIT_PURPOSE_OR 1
415 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
416 #define CIRCUIT_PURPOSE_INTRO_POINT 2
417 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
418 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
419 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
420 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
421 #define _CIRCUIT_PURPOSE_OR_MAX 4
423 /* these circuits originate at this node */
425 /* here's how circ client-side purposes work:
426 * normal circuits are C_GENERAL.
427 * circuits that are c_introducing are either on their way to
428 * becoming open, or they are open and waiting for a
429 * suitable rendcirc before they send the intro.
430 * circuits that are c_introduce_ack_wait have sent the intro,
431 * but haven't gotten a response yet.
432 * circuits that are c_establish_rend are either on their way
433 * to becoming open, or they are open and have sent the
434 * establish_rendezvous cell but haven't received an ack.
435 * circuits that are c_rend_ready are open and have received a
436 * rend ack, but haven't heard from bob yet. if they have a
437 * buildstate->pending_final_cpath then they're expecting a
438 * cell from bob, else they're not.
439 * circuits that are c_rend_ready_intro_acked are open, and
440 * some intro circ has sent its intro and received an ack.
441 * circuits that are c_rend_joined are open, have heard from
442 * bob, and are talking to him.
444 /** Client-side circuit purpose: Normal circuit, with cpath. */
445 #define CIRCUIT_PURPOSE_C_GENERAL 5
446 /** Client-side circuit purpose: at Alice, connecting to intro point. */
447 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
448 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
449 * waiting for ACK/NAK. */
450 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
451 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
452 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
453 /** Client-side circuit purpose: at Alice, waiting for ack. */
454 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
455 /** Client-side circuit purpose: at Alice, waiting for Bob. */
456 #define CIRCUIT_PURPOSE_C_REND_READY 10
457 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
458 * has been acknowledged. */
459 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
460 /** Client-side circuit purpose: at Alice, rendezvous established. */
461 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
463 #define _CIRCUIT_PURPOSE_C_MAX 12
465 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
466 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
467 /** Hidden-service-side circuit purpose: at Bob, successfully established
469 #define CIRCUIT_PURPOSE_S_INTRO 14
470 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
471 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
472 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
473 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
474 /** A testing circuit; not meant to be used for actual traffic. */
475 #define CIRCUIT_PURPOSE_TESTING 17
476 /** A controller made this circuit and Tor should not use it. */
477 #define CIRCUIT_PURPOSE_CONTROLLER 18
478 #define _CIRCUIT_PURPOSE_MAX 18
479 /** A catch-all for unrecognized purposes. Currently we don't expect
480 * to make or see any circuits with this purpose. */
481 #define CIRCUIT_PURPOSE_UNKNOWN 255
483 /** True iff the circuit purpose <b>p</b> is for a circuit that
484 * originated at this node. */
485 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
486 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
487 * here to serve as a client. (Hidden services don't count here.) */
488 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
489 ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
490 (p)<=_CIRCUIT_PURPOSE_C_MAX)
491 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
492 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
494 /** How many circuits do we want simultaneously in-progress to handle
496 #define MIN_CIRCUITS_HANDLING_STREAM 2
498 /* These RELAY_COMMAND constants define values for relay cell commands, and
499 * must match those defined in tor-spec.txt. */
500 #define RELAY_COMMAND_BEGIN 1
501 #define RELAY_COMMAND_DATA 2
502 #define RELAY_COMMAND_END 3
503 #define RELAY_COMMAND_CONNECTED 4
504 #define RELAY_COMMAND_SENDME 5
505 #define RELAY_COMMAND_EXTEND 6
506 #define RELAY_COMMAND_EXTENDED 7
507 #define RELAY_COMMAND_TRUNCATE 8
508 #define RELAY_COMMAND_TRUNCATED 9
509 #define RELAY_COMMAND_DROP 10
510 #define RELAY_COMMAND_RESOLVE 11
511 #define RELAY_COMMAND_RESOLVED 12
512 #define RELAY_COMMAND_BEGIN_DIR 13
514 #define RELAY_COMMAND_ESTABLISH_INTRO 32
515 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
516 #define RELAY_COMMAND_INTRODUCE1 34
517 #define RELAY_COMMAND_INTRODUCE2 35
518 #define RELAY_COMMAND_RENDEZVOUS1 36
519 #define RELAY_COMMAND_RENDEZVOUS2 37
520 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
521 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
522 #define RELAY_COMMAND_INTRODUCE_ACK 40
524 /* Reasons why an OR connection is closed. */
525 #define END_OR_CONN_REASON_DONE 1
526 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
527 #define END_OR_CONN_REASON_OR_IDENTITY 3
528 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
529 #define END_OR_CONN_REASON_TIMEOUT 5
530 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
531 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
532 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
533 #define END_OR_CONN_REASON_MISC 9
535 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
536 * documentation of these. The values must match. */
537 #define END_STREAM_REASON_MISC 1
538 #define END_STREAM_REASON_RESOLVEFAILED 2
539 #define END_STREAM_REASON_CONNECTREFUSED 3
540 #define END_STREAM_REASON_EXITPOLICY 4
541 #define END_STREAM_REASON_DESTROY 5
542 #define END_STREAM_REASON_DONE 6
543 #define END_STREAM_REASON_TIMEOUT 7
544 /* 8 is unallocated for historical reasons. */
545 #define END_STREAM_REASON_HIBERNATING 9
546 #define END_STREAM_REASON_INTERNAL 10
547 #define END_STREAM_REASON_RESOURCELIMIT 11
548 #define END_STREAM_REASON_CONNRESET 12
549 #define END_STREAM_REASON_TORPROTOCOL 13
550 #define END_STREAM_REASON_NOTDIRECTORY 14
551 #define END_STREAM_REASON_ENTRYPOLICY 15
553 /* These high-numbered end reasons are not part of the official spec,
554 * and are not intended to be put in relay end cells. They are here
555 * to be more informative when sending back socks replies to the
557 /* XXXX 256 is no longer used; feel free to reuse it. */
558 /** We were unable to attach the connection to any circuit at all. */
559 /* XXXX the ways we use this one don't make a lot of sense. */
560 #define END_STREAM_REASON_CANT_ATTACH 257
561 /** We can't connect to any directories at all, so we killed our streams
562 * before they can time out. */
563 #define END_STREAM_REASON_NET_UNREACHABLE 258
564 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
565 * protocol in a way we couldn't handle. */
566 #define END_STREAM_REASON_SOCKSPROTOCOL 259
567 /** This is a transparent proxy connection, but we can't extract the original
568 * target address:port. */
569 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
570 /** This is a connection on the NATD port, and the destination IP:Port was
571 * either ill-formed or out-of-range. */
572 #define END_STREAM_REASON_INVALID_NATD_DEST 261
574 /** Bitwise-and this value with endreason to mask out all flags. */
575 #define END_STREAM_REASON_MASK 511
577 /** Bitwise-or this with the argument to control_event_stream_status
578 * to indicate that the reason came from an END cell. */
579 #define END_STREAM_REASON_FLAG_REMOTE 512
580 /** Bitwise-or this with the argument to control_event_stream_status
581 * to indicate that we already sent a CLOSED stream event. */
582 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
583 /** Bitwise-or this with endreason to indicate that we already sent
584 * a socks reply, and no further reply needs to be sent from
585 * connection_mark_unattached_ap(). */
586 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
588 /** Reason for remapping an AP connection's address: we have a cached
590 #define REMAP_STREAM_SOURCE_CACHE 1
591 /** Reason for remapping an AP connection's address: the exit node told us an
593 #define REMAP_STREAM_SOURCE_EXIT 2
595 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
596 #define RESOLVED_TYPE_HOSTNAME 0
597 #define RESOLVED_TYPE_IPV4 4
598 #define RESOLVED_TYPE_IPV6 6
599 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
600 #define RESOLVED_TYPE_ERROR 0xF1
602 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
603 * call; they only go to the controller for tracking */
604 /** We couldn't build a path for this circuit. */
605 #define END_CIRC_REASON_NOPATH -2
606 /** Catch-all "other" reason for closing origin circuits. */
607 #define END_CIRC_AT_ORIGIN -1
609 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
610 * documentation of these. */
611 #define _END_CIRC_REASON_MIN 0
612 #define END_CIRC_REASON_NONE 0
613 #define END_CIRC_REASON_TORPROTOCOL 1
614 #define END_CIRC_REASON_INTERNAL 2
615 #define END_CIRC_REASON_REQUESTED 3
616 #define END_CIRC_REASON_HIBERNATING 4
617 #define END_CIRC_REASON_RESOURCELIMIT 5
618 #define END_CIRC_REASON_CONNECTFAILED 6
619 #define END_CIRC_REASON_OR_IDENTITY 7
620 #define END_CIRC_REASON_OR_CONN_CLOSED 8
621 #define END_CIRC_REASON_FINISHED 9
622 #define END_CIRC_REASON_TIMEOUT 10
623 #define END_CIRC_REASON_DESTROYED 11
624 #define END_CIRC_REASON_NOSUCHSERVICE 12
625 #define _END_CIRC_REASON_MAX 12
627 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
628 * control_event_circuit_status() to indicate that the reason was
629 * passed through from a destroy or truncate cell. */
630 #define END_CIRC_REASON_FLAG_REMOTE 512
632 /** Length of 'y' portion of 'y.onion' URL. */
633 #define REND_SERVICE_ID_LEN_BASE32 16
635 /** Length of 'y.onion' including '.onion' URL. */
636 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
638 /** Length of a binary-encoded rendezvous service ID. */
639 #define REND_SERVICE_ID_LEN 10
641 /** Time period for which a v2 descriptor will be valid. */
642 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
644 /** Time period within which two sets of v2 descriptors will be uploaded in
646 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
648 /** Number of non-consecutive replicas (i.e. distributed somewhere
649 * in the ring) for a descriptor. */
650 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
652 /** Number of consecutive replicas for a descriptor. */
653 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
655 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
656 #define REND_DESC_ID_V2_LEN_BASE32 32
658 /** Length of the base32-encoded secret ID part of versioned hidden service
660 #define REND_SECRET_ID_PART_LEN_BASE32 32
662 /** Length of the base32-encoded hash of an introduction point's
664 #define REND_INTRO_POINT_ID_LEN_BASE32 32
666 /** Length of the descriptor cookie that is used for client authorization
667 * to hidden services. */
668 #define REND_DESC_COOKIE_LEN 16
670 /** Length of the base64-encoded descriptor cookie that is used for
671 * exchanging client authorization between hidden service and client. */
672 #define REND_DESC_COOKIE_LEN_BASE64 22
674 /** Length of client identifier in encrypted introduction points for hidden
675 * service authorization type 'basic'. */
676 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
678 /** Multiple of the number of clients to which the real number of clients
679 * is padded with fake clients for hidden service authorization type
681 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
683 /** Length of client entry consisting of client identifier and encrypted
684 * session key for hidden service authorization type 'basic'. */
685 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
688 /** Maximum size of v2 hidden service descriptors. */
689 #define REND_DESC_MAX_SIZE (20 * 1024)
691 /** Legal characters for use in authorized client names for a hidden
693 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
694 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
696 /** Maximum length of authorized client names for a hidden service. */
697 #define REND_CLIENTNAME_MAX_LEN 16
699 /** Length of the rendezvous cookie that is used to connect circuits at the
700 * rendezvous point. */
701 #define REND_COOKIE_LEN DIGEST_LEN
703 /** Client authorization type that a hidden service performs. */
704 typedef enum rend_auth_type_t
{
707 REND_STEALTH_AUTH
= 2,
710 /** Client-side configuration of authorization for a hidden service. */
711 typedef struct rend_service_authorization_t
{
712 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
713 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
714 rend_auth_type_t auth_type
;
715 } rend_service_authorization_t
;
717 /** Client- and server-side data that is used for hidden service connection
718 * establishment. Not all fields contain data depending on where this struct
720 typedef struct rend_data_t
{
721 /** Onion address (without the .onion part) that a client requests. */
722 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
724 /** (Optional) descriptor cookie that is used by a client. */
725 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
727 /** Authorization type for accessing a service used by a client. */
728 rend_auth_type_t auth_type
;
730 /** Hash of the hidden service's PK used by a service. */
731 char rend_pk_digest
[DIGEST_LEN
];
733 /** Rendezvous cookie used by both, client and service. */
734 char rend_cookie
[REND_COOKIE_LEN
];
737 /** Time interval for tracking possible replays of INTRODUCE2 cells.
738 * Incoming cells with timestamps half of this interval in the past or
739 * future are dropped immediately. */
740 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
742 /** Used to indicate which way a cell is going on a circuit. */
744 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
745 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
748 /** Initial value for both sides of a circuit transmission window when the
749 * circuit is initialized. Measured in cells. */
750 #define CIRCWINDOW_START 1000
751 /** Amount to increment a circuit window when we get a circuit SENDME. */
752 #define CIRCWINDOW_INCREMENT 100
753 /** Initial value on both sides of a stream transmission window when the
754 * stream is initialized. Measured in cells. */
755 #define STREAMWINDOW_START 500
756 /** Amount to increment a stream window when we get a stream SENDME. */
757 #define STREAMWINDOW_INCREMENT 50
759 /* Cell commands. These values are defined in tor-spec.txt. */
760 #define CELL_PADDING 0
761 #define CELL_CREATE 1
762 #define CELL_CREATED 2
764 #define CELL_DESTROY 4
765 #define CELL_CREATE_FAST 5
766 #define CELL_CREATED_FAST 6
767 #define CELL_VERSIONS 7
768 #define CELL_NETINFO 8
769 #define CELL_RELAY_EARLY 9
771 /** True iff the cell command <b>x</b> is one that implies a variable-length
773 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
775 /** How long to test reachability before complaining to the user. */
776 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
778 /** Legal characters in a nickname. */
779 #define LEGAL_NICKNAME_CHARACTERS \
780 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
782 /** Name to use in client TLS certificates if no nickname is given. Once
783 * Tor 0.1.2.x is obsolete, we can remove this. */
784 #define DEFAULT_CLIENT_NICKNAME "client"
786 /** Number of bytes in a SOCKS4 header. */
787 #define SOCKS4_NETWORK_LEN 8
791 * Relay command [1 byte]
792 * Recognized [2 bytes]
793 * Stream ID [2 bytes]
794 * Partial SHA-1 [4 bytes]
796 * Relay payload [498 bytes]
799 /** Number of bytes in a cell, minus cell header. */
800 #define CELL_PAYLOAD_SIZE 509
801 /** Number of bytes in a cell transmitted over the network. */
802 #define CELL_NETWORK_SIZE 512
804 /** Length of a header on a variable-length cell. */
805 #define VAR_CELL_HEADER_SIZE 5
807 /** Number of bytes in a relay cell's header (not including general cell
809 #define RELAY_HEADER_SIZE (1+2+2+4+2)
810 /** Largest number of bytes that can fit in a relay cell payload. */
811 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
813 /** Identifies a circuit on an or_connection */
814 typedef uint16_t circid_t
;
815 /** Identifies a stream on a circuit */
816 typedef uint16_t streamid_t
;
818 /** Parsed onion routing cell. All communication between nodes
820 typedef struct cell_t
{
821 circid_t circ_id
; /**< Circuit which received the cell. */
822 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
823 * CELL_DESTROY, etc */
824 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
827 /** Parsed variable-length onion routing cell. */
828 typedef struct var_cell_t
{
831 uint16_t payload_len
;
835 /** A cell as packed for writing to the network. */
836 typedef struct packed_cell_t
{
837 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
838 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
839 #ifdef ENABLE_BUFFER_STATS
840 struct timeval packed_timeval
; /**< When was this cell packed? */
844 /** A queue of cells on a circuit, waiting to be added to the
845 * or_connection_t's outbuf. */
846 typedef struct cell_queue_t
{
847 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
848 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
849 int n
; /**< The number of cells in the queue. */
852 /** Beginning of a RELAY cell payload. */
854 uint8_t command
; /**< The end-to-end relay command. */
855 uint16_t recognized
; /**< Used to tell whether cell is for us. */
856 streamid_t stream_id
; /**< Which stream is this cell associated with? */
857 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
858 uint16_t length
; /**< How long is the payload body? */
861 typedef struct buf_t buf_t
;
862 typedef struct socks_request_t socks_request_t
;
864 /* Values for connection_t.magic: used to make sure that downcasts (casts from
865 * connection_t to foo_connection_t) are safe. */
866 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
867 #define OR_CONNECTION_MAGIC 0x7D31FF03u
868 #define EDGE_CONNECTION_MAGIC 0xF0374013u
869 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
870 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
872 /** Description of a connection to another host or process, and associated
875 * A connection is named based on what it's connected to -- an "OR
876 * connection" has a Tor node on the other end, an "exit
877 * connection" has a website or other server on the other end, and an
878 * "AP connection" has an application proxy (and thus a user) on the
881 * Every connection has a type and a state. Connections never change
882 * their type, but can go through many state changes in their lifetime.
884 * Every connection has two associated input and output buffers.
885 * Listeners don't use them. For non-listener connections, incoming
886 * data is appended to conn->inbuf, and outgoing data is taken from
887 * conn->outbuf. Connections differ primarily in the functions called
888 * to fill and drain these buffers.
890 typedef struct connection_t
{
891 uint32_t magic
; /**< For memory debugging: must equal one of
892 * *_CONNECTION_MAGIC. */
894 uint8_t state
; /**< Current state of this connection. */
895 unsigned int type
:4; /**< What kind of connection is this? */
896 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
898 /* The next fields are all one-bit booleans. Some are only applicable to
899 * connection subtypes, but we hold them here anyway, to save space.
901 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
902 * again once the bandwidth throttler allows it? */
903 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
904 * again once the bandwidth throttler allows
906 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
907 * marked for close, do we flush it
908 * before closing it? */
909 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
911 /** Set to 1 when we're inside connection_flushed_some to keep us from
912 * calling connection_handle_write() recursively. */
913 unsigned int in_flushed_some
:1;
915 /* For linked connections:
917 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
918 /** True iff we'd like to be notified about read events from the
920 unsigned int reading_from_linked_conn
:1;
921 /** True iff we're willing to write to the linked conn. */
922 unsigned int writing_to_linked_conn
:1;
923 /** True iff we're currently able to read on the linked conn, and our
924 * read_event should be made active with libevent. */
925 unsigned int active_on_link
:1;
926 /** True iff we've called connection_close_immediate() on this linked
928 unsigned int linked_conn_is_closed
:1;
930 /** Our socket; -1 if this connection is closed, or has no socket. */
932 int conn_array_index
; /**< Index into the global connection array. */
933 struct event
*read_event
; /**< Libevent event structure. */
934 struct event
*write_event
; /**< Libevent event structure. */
935 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
936 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
937 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
939 time_t timestamp_lastread
; /**< When was the last time libevent said we could
941 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
943 time_t timestamp_created
; /**< When was this connection_t created? */
945 /* XXXX_IP6 make this IPv6-capable */
946 int socket_family
; /**< Address family of this connection's socket. Usually
947 * AF_INET, but it can also be AF_UNIX, or in the future
949 tor_addr_t addr
; /**< IP of the other side of the connection; used to
950 * identify routers, along with port. */
951 uint16_t port
; /**< If non-zero, port on the other end
952 * of the connection. */
953 uint16_t marked_for_close
; /**< Should we close this conn on the next
954 * iteration of the main loop? (If true, holds
955 * the line number where this connection was
957 const char *marked_for_close_file
; /**< For debugging: in which file were
958 * we marked for close? */
959 char *address
; /**< FQDN (or IP) of the guy on the other end.
960 * strdup into this, because free_connection() frees it. */
961 /** Another connection that's connected to this one in lieu of a socket. */
962 struct connection_t
*linked_conn
;
964 /** Unique identifier for this connection on this Tor instance. */
965 uint64_t global_identifier
;
967 /* XXXX022 move this field, and all the listener-only fields (just
968 socket_family, I think), into a new listener_connection_t subtype. */
969 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
970 * to the evdns_server_port is uses to listen to and answer connections. */
971 struct evdns_server_port
*dns_server_port
;
975 /** Stores flags and information related to the portion of a v2 Tor OR
976 * connection handshake that happens after the TLS handshake is finished.
978 typedef struct or_handshake_state_t
{
979 /** When was the VERSIONS cell sent on this connection? Used to get
980 * an estimate of the skew in the returning NETINFO reply. */
981 time_t sent_versions_at
;
982 /** True iff we originated this connection */
983 unsigned int started_here
: 1;
984 /** True iff we have received and processed a VERSIONS cell. */
985 unsigned int received_versions
: 1;
986 } or_handshake_state_t
;
988 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
990 typedef struct or_connection_t
{
993 /** Hash of the public RSA key for the other side's identity key, or zeroes
994 * if the other side hasn't shown us a valid identity key. */
995 char identity_digest
[DIGEST_LEN
];
996 char *nickname
; /**< Nickname of OR on other side (if any). */
998 tor_tls_t
*tls
; /**< TLS connection state. */
999 int tls_error
; /**< Last tor_tls error code. */
1000 /** When we last used this conn for any client traffic. If not
1001 * recent, we can rate limit it further. */
1004 tor_addr_t real_addr
; /**< The actual address that this connection came from
1005 * or went to. The <b>addr</b> field is prone to
1006 * getting overridden by the address from the router
1007 * descriptor matching <b>identity_digest</b>. */
1009 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1010 * connection, which half of the space should
1012 /** Should this connection be used for extending circuits to the server
1013 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1014 * sure we aren't getting MITMed, either because we're connected to an
1015 * address listed in a server descriptor, or because an authenticated
1016 * NETINFO cell listed the address we're connected to as recognized. */
1017 unsigned int is_canonical
:1;
1018 /** True iff this connection shouldn't get any new circs attached to it,
1019 * because the connection is too old, or because there's a better one, etc.
1021 unsigned int is_bad_for_new_circs
:1;
1022 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1023 * "none negotiated yet." */
1024 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1025 * this connection? This is always in the
1026 * range 0..1<<15-1. */
1028 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1029 * up, state information to do so. */
1030 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1031 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1032 * non-padding cell to the outbuf? */
1034 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
1035 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1036 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1037 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1038 * add 'bandwidthrate' to this, capping it at
1039 * bandwidthburst. (OPEN ORs only) */
1040 int n_circuits
; /**< How many circuits use this connection as p_conn or
1043 /** Double-linked ring of circuits with queued cells waiting for room to
1044 * free up on this connection's outbuf. Every time we pull cells from a
1045 * circuit, we advance this pointer to the next circuit in the ring. */
1046 struct circuit_t
*active_circuits
;
1047 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1048 * identity digest as this one. */
1051 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1052 * connection, or an exit. */
1053 typedef struct edge_connection_t
{
1056 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1058 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1059 * this conn exits at. */
1060 int package_window
; /**< How many more relay cells can I send into the
1062 int deliver_window
; /**< How many more relay cells can end at me? */
1064 /** Nickname of planned exit node -- used with .exit support. */
1065 char *chosen_exit_name
;
1067 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1069 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1070 * connection is using. */
1072 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1073 * connection. Exit connections only. */
1075 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1078 /** The reason why this connection is closing; passed to the controller. */
1079 uint16_t end_reason
;
1081 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1084 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1087 /** What rendezvous service are we querying for? (AP only) */
1088 rend_data_t
*rend_data
;
1090 /** Number of times we've reassigned this application connection to
1091 * a new circuit. We keep track because the timeout is longer if we've
1092 * already retried several times. */
1093 uint8_t num_socks_retries
;
1095 /** True iff this connection is for a DNS request only. */
1096 unsigned int is_dns_request
:1;
1098 /** True iff this stream must attach to a one-hop circuit (e.g. for
1100 unsigned int want_onehop
:1;
1101 /** True iff this stream should use a BEGIN_DIR relay command to establish
1102 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1103 unsigned int use_begindir
:1;
1105 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1106 * connections. Set once we've set the stream end,
1107 * and check in connection_about_to_close_connection().
1109 /** True iff we've blocked reading until the circuit has fewer queued
1111 unsigned int edge_blocked_on_circ
:1;
1112 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1113 * stop requiring it. */
1114 unsigned int chosen_exit_optional
:1;
1115 /** For AP connections only. If non-zero, this exit node was picked as
1116 * a result of the TrackHostExit, and the value decrements every time
1117 * we fail to complete a circuit to our chosen exit -- if it reaches
1118 * zero, abandon the associated mapaddress. */
1119 unsigned int chosen_exit_retries
:3;
1121 /** If this is a DNSPort connection, this field holds the pending DNS
1122 * request that we're going to try to answer. */
1123 struct evdns_server_request
*dns_server_request
;
1125 } edge_connection_t
;
1127 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1128 * connection to retrieve or serve directory material. */
1129 typedef struct dir_connection_t
{
1132 char *requested_resource
; /**< Which 'resource' did we ask the directory
1134 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1136 /* Used only for server sides of some dir connections, to implement
1137 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1138 * to append everything to the outbuf in one enormous chunk. */
1139 /** What exactly are we spooling right now? */
1141 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1142 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1143 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
1144 } dir_spool_src
: 3;
1145 /** If we're fetching descriptors, what router purpose shall we assign
1147 uint8_t router_purpose
;
1148 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1149 smartlist_t
*fingerprint_stack
;
1150 /** A cached_dir_t object that we're currently spooling out */
1151 struct cached_dir_t
*cached_dir
;
1152 /** The current offset into cached_dir. */
1153 off_t cached_dir_offset
;
1154 /** The zlib object doing on-the-fly compression for spooled data. */
1155 tor_zlib_state_t
*zlib_state
;
1157 /** What rendezvous service are we querying for? */
1158 rend_data_t
*rend_data
;
1160 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1161 * the directory server's signing key. */
1165 /** Subtype of connection_t for an connection to a controller. */
1166 typedef struct control_connection_t
{
1169 uint32_t event_mask
; /**< Bitfield: which events does this controller
1172 /** True if we have sent a protocolinfo reply on this connection. */
1173 unsigned int have_sent_protocolinfo
:1;
1175 /** Amount of space allocated in incoming_cmd. */
1176 uint32_t incoming_cmd_len
;
1177 /** Number of bytes currently stored in incoming_cmd. */
1178 uint32_t incoming_cmd_cur_len
;
1179 /** A control command that we're reading from the inbuf, but which has not
1180 * yet arrived completely. */
1182 } control_connection_t
;
1184 /** Cast a connection_t subtype pointer to a connection_t **/
1185 #define TO_CONN(c) (&(((c)->_base)))
1186 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1187 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1189 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1191 static or_connection_t
*TO_OR_CONN(connection_t
*);
1192 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1194 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1195 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1197 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1198 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1200 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1202 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1204 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1205 return DOWNCAST(or_connection_t
, c
);
1207 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1209 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1210 return DOWNCAST(dir_connection_t
, c
);
1212 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1214 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1215 return DOWNCAST(edge_connection_t
, c
);
1217 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1219 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1220 return DOWNCAST(control_connection_t
, c
);
1223 /** What action type does an address policy indicate: accept or reject? */
1225 ADDR_POLICY_ACCEPT
=1,
1226 ADDR_POLICY_REJECT
=2,
1227 } addr_policy_action_t
;
1229 /** A reference-counted address policy rule. */
1230 typedef struct addr_policy_t
{
1231 int refcnt
; /**< Reference count */
1232 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1233 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1235 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1236 * copy (stored in a hash table to avoid
1237 * duplication of common policies) */
1238 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1239 * first <b>maskbits</b> bits of <b>a</b> match
1241 tor_addr_t addr
; /**< Base address to accept or reject. */
1242 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1243 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1246 /** A cached_dir_t represents a cacheable directory object, along with its
1247 * compressed form. */
1248 typedef struct cached_dir_t
{
1249 char *dir
; /**< Contents of this object, NUL-terminated. */
1250 char *dir_z
; /**< Compressed contents of this object. */
1251 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1252 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1253 time_t published
; /**< When was this object published. */
1254 int refcnt
; /**< Reference count for this cached_dir_t. */
1257 /** Enum used to remember where a signed_descriptor_t is stored and how to
1258 * manage the memory for signed_descriptor_body. */
1260 /** The descriptor isn't stored on disk at all: the copy in memory is
1261 * canonical; the saved_offset field is meaningless. */
1263 /** The descriptor is stored in the cached_routers file: the
1264 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1265 * saved_offset are used to index into the mmaped cache file. */
1267 /** The descriptor is stored in the cached_routers.new file: the
1268 * signed_descriptor_body and saved_offset fields are both set. */
1269 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1270 * lazy-load the descriptor text by using seek and read. We don't, for
1276 /** Enumeration: what kind of download schedule are we using for a given
1279 DL_SCHED_GENERIC
= 0,
1280 DL_SCHED_CONSENSUS
= 1,
1281 DL_SCHED_BRIDGE
= 2,
1282 } download_schedule_t
;
1284 /** Information about our plans for retrying downloads for a downloadable
1286 typedef struct download_status_t
{
1287 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1289 uint8_t n_download_failures
; /**< Number of failures trying to download the
1290 * most recent descriptor. */
1291 download_schedule_t schedule
: 8;
1292 } download_status_t
;
1294 /** If n_download_failures is this high, the download can never happen. */
1295 #define IMPOSSIBLE_TO_DOWNLOAD 255
1297 /** The max size we expect router descriptor annotations we create to
1298 * be. We'll accept larger ones if we see them on disk, but we won't
1299 * create any that are larger than this. */
1300 #define ROUTER_ANNOTATION_BUF_LEN 256
1302 /** Information need to cache an onion router's descriptor. */
1303 typedef struct signed_descriptor_t
{
1304 /** Pointer to the raw server descriptor, preceded by annotations. Not
1305 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1306 * pointer is null. */
1307 char *signed_descriptor_body
;
1308 /** Length of the annotations preceding the server descriptor. */
1309 size_t annotations_len
;
1310 /** Length of the server descriptor. */
1311 size_t signed_descriptor_len
;
1312 /** Digest of the server descriptor, computed as specified in
1314 char signed_descriptor_digest
[DIGEST_LEN
];
1315 /** Identity digest of the router. */
1316 char identity_digest
[DIGEST_LEN
];
1317 /** Declared publication time of the descriptor. */
1318 time_t published_on
;
1319 /** For routerdescs only: digest of the corresponding extrainfo. */
1320 char extra_info_digest
[DIGEST_LEN
];
1321 /** For routerdescs only: Status of downloading the corresponding
1323 download_status_t ei_dl_status
;
1324 /** Where is the descriptor saved? */
1325 saved_location_t saved_location
;
1326 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1327 * this descriptor in the corresponding file. */
1329 /** What position is this descriptor within routerlist->routers or
1330 * routerlist->old_routers? -1 for none. */
1331 int routerlist_index
;
1332 /** The valid-until time of the most recent consensus that listed this
1333 * descriptor, or a bit after the publication time of the most recent v2
1334 * networkstatus that listed it. 0 for "never listed in a consensus or
1335 * status, so far as we know." */
1336 time_t last_listed_as_valid_until
;
1337 #ifdef TRACK_SERVED_TIME
1338 /** The last time we served anybody this descriptor. Used for internal
1339 * testing to see whether we're holding on to descriptors too long. */
1340 time_t last_served_at
; /*XXXX remove if not useful. */
1342 /* If true, we do not ever try to save this object in the cache. */
1343 unsigned int do_not_cache
: 1;
1344 /* If true, this item is meant to represent an extrainfo. */
1345 unsigned int is_extrainfo
: 1;
1346 /* If true, we got an extrainfo for this item, and the digest was right,
1347 * but it was incompatible. */
1348 unsigned int extrainfo_is_bogus
: 1;
1349 /* If true, we are willing to transmit this item unencrypted. */
1350 unsigned int send_unencrypted
: 1;
1351 } signed_descriptor_t
;
1353 /** A signed integer representing a country code. */
1354 typedef int16_t country_t
;
1356 /** Information about another onion router in the network. */
1358 signed_descriptor_t cache_info
;
1359 char *address
; /**< Location of OR: either a hostname or an IP address. */
1360 char *nickname
; /**< Human-readable OR name. */
1362 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1363 uint16_t or_port
; /**< Port for TLS connections. */
1364 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1366 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1367 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1369 char *platform
; /**< What software/operating system is this OR using? */
1372 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1373 * bucket per second? */
1374 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1375 /** How many bytes/s is this router known to handle? */
1376 uint32_t bandwidthcapacity
;
1377 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1378 * to exit? NULL for 'reject *:*'. */
1379 long uptime
; /**< How many seconds the router claims to have been up */
1380 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1381 * claims are its family. */
1382 char *contact_info
; /**< Declared contact info for this router. */
1383 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1385 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1386 * dnsworker code. */
1387 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1388 * extrainfo documents. */
1389 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1390 * single hop exits. */
1393 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1395 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1396 * (For Authdir: Have we validated this OR?)
1398 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1400 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1401 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1402 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1403 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1404 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1405 * or otherwise nasty? */
1406 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1407 * underpowered, or otherwise useless? */
1408 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1409 * a hidden service directory. */
1410 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1411 * directory according to the authorities. */
1412 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1413 * router rejects everything. */
1415 /** Tor can use this router for general positions in circuits. */
1416 #define ROUTER_PURPOSE_GENERAL 0
1417 /** Tor should avoid using this router for circuit-building. */
1418 #define ROUTER_PURPOSE_CONTROLLER 1
1419 /** Tor should use this router only for bridge positions in circuits. */
1420 #define ROUTER_PURPOSE_BRIDGE 2
1421 /** Tor should not use this router; it was marked in cached-descriptors with
1422 * a purpose we didn't recognize. */
1423 #define ROUTER_PURPOSE_UNKNOWN 255
1425 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1427 /* The below items are used only by authdirservers for
1428 * reachability testing. */
1429 /** When was the last time we could reach this OR? */
1430 time_t last_reachable
;
1431 /** When did we start testing reachability for this OR? */
1432 time_t testing_since
;
1433 /** According to the geoip db what country is this router in? */
1437 /** Information needed to keep and cache a signed extra-info document. */
1438 typedef struct extrainfo_t
{
1439 signed_descriptor_t cache_info
;
1440 /** The router's nickname. */
1441 char nickname
[MAX_NICKNAME_LEN
+1];
1442 /** True iff we found the right key for this extra-info, verified the
1443 * signature, and found it to be bad. */
1444 unsigned int bad_sig
: 1;
1445 /** If present, we didn't have the right key to verify this extra-info,
1446 * so this is a copy of the signature in the document. */
1448 /** Length of pending_sig. */
1449 size_t pending_sig_len
;
1452 /** Contents of a single router entry in a network status object.
1454 typedef struct routerstatus_t
{
1455 time_t published_on
; /**< When was this router published? */
1456 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1458 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1460 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1462 uint32_t addr
; /**< IPv4 address for this router. */
1463 uint16_t or_port
; /**< OR port for this router. */
1464 uint16_t dir_port
; /**< Directory port for this router. */
1465 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1466 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1467 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1468 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1469 unsigned int is_running
:1; /**< True iff this router is up. */
1470 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1471 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1473 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1474 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1475 * information with v2 of the directory
1476 * protocol. (All directory caches cache v1
1478 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1479 * choice as an entry guard. */
1480 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1482 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1483 * underpowered, or otherwise useless? */
1484 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1485 * service directory. */
1486 /** True iff we know version info for this router. (i.e., a "v" entry was
1487 * included.) We'll replace all these with a big tor_version_t or a char[]
1488 * if the number of traits we care about ever becomes incredibly big. */
1489 unsigned int version_known
:1;
1490 /** True iff this router is a version that supports BEGIN_DIR cells. */
1491 unsigned int version_supports_begindir
:1;
1492 /** True iff this router is a version that supports conditional consensus
1493 * downloads (signed by list of authorities). */
1494 unsigned int version_supports_conditional_consensus
:1;
1495 /** True iff this router is a version that we can post extrainfo docs to. */
1496 unsigned int version_supports_extrainfo_upload
:1;
1497 /** True iff this router is a version that, if it caches directory info,
1498 * we can get v3 downloads from. */
1499 unsigned int version_supports_v3_dir
:1;
1501 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1502 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1504 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1505 * the vote/consensus, in kilobytes/sec. */
1506 char *exitsummary
; /**< exit policy summary -
1507 * XXX weasel: this probably should not stay a string. */
1509 /* ---- The fields below aren't derived from the networkstatus; they
1510 * hold local information only. */
1512 /** True if we, as a directory mirror, want to download the corresponding
1513 * routerinfo from the authority who gave us this routerstatus. (That is,
1514 * if we don't have the routerinfo, and if we haven't already tried to get it
1515 * from this authority.) Applies in v2 networkstatus document only.
1517 unsigned int need_to_mirror
:1;
1518 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1519 * to this (unnamed) router by nickname?
1521 time_t last_dir_503_at
; /**< When did this router last tell us that it
1522 * was too busy to serve directory info? */
1523 download_status_t dl_status
;
1527 /** How many times will we try to download a router's descriptor before giving
1529 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1531 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1532 typedef struct networkstatus_v2_t
{
1533 /** When did we receive the network-status document? */
1536 /** What was the digest of the document? */
1537 char networkstatus_digest
[DIGEST_LEN
];
1539 /* These fields come from the actual network-status document.*/
1540 time_t published_on
; /**< Declared publication date. */
1542 char *source_address
; /**< Canonical directory server hostname. */
1543 uint32_t source_addr
; /**< Canonical directory server IP. */
1544 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1546 unsigned int binds_names
:1; /**< True iff this directory server binds
1548 unsigned int recommends_versions
:1; /**< True iff this directory server
1549 * recommends client and server software
1551 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1552 * malfunctioning exits as bad. */
1553 /** True iff this directory server marks malfunctioning directories as
1555 unsigned int lists_bad_directories
:1;
1557 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1558 char *contact
; /**< How to contact directory admin? (may be NULL). */
1559 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1560 char *client_versions
; /**< comma-separated list of recommended client
1562 char *server_versions
; /**< comma-separated list of recommended server
1565 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1566 * sorted by identity_digest. */
1567 } networkstatus_v2_t
;
1569 /** The claim about a single router, made in a vote. */
1570 typedef struct vote_routerstatus_t
{
1571 routerstatus_t status
; /**< Underlying 'status' object for this router.
1572 * Flags are redundant. */
1573 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1574 * networkstatus_t.known_flags. */
1575 char *version
; /**< The version that the authority says this router is
1577 } vote_routerstatus_t
;
1579 /** Information about a single voter in a vote or a consensus. */
1580 typedef struct networkstatus_voter_info_t
{
1581 char *nickname
; /**< Nickname of this voter */
1582 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1583 char *address
; /**< Address of this voter, in string format. */
1584 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1585 uint16_t dir_port
; /**< Directory port of this voter */
1586 uint16_t or_port
; /**< OR port of this voter */
1587 char *contact
; /**< Contact information for this voter. */
1588 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1589 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
1590 * consensuses, we treat legacy keys as additional signers. */
1591 char legacy_id_digest
[DIGEST_LEN
];
1593 /* Nothing from here on is signed. */
1594 char signing_key_digest
[DIGEST_LEN
]; /**< Declared digest of signing key
1595 * used by this voter. */
1596 char *signature
; /**< Signature from this voter. */
1597 int signature_len
; /**< Length of <b>signature</b> */
1598 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1599 * the sig, and we know it's bad. */
1600 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1602 } networkstatus_voter_info_t
;
1604 /** Enumerates the possible seriousness values of a networkstatus document. */
1609 } networkstatus_type_t
;
1611 /** A common structure to hold a v3 network status vote, or a v3 network
1612 * status consensus. */
1613 typedef struct networkstatus_t
{
1614 networkstatus_type_t type
; /**< Vote, consensus, or opinion? */
1615 time_t published
; /**< Vote only: Time when vote was written. */
1616 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1617 time_t fresh_until
; /**< Time before which this is the most recent vote or
1619 time_t valid_until
; /**< Time after which this vote or consensus should not
1622 /** Consensus only: what method was used to produce this consensus? */
1623 int consensus_method
;
1624 /** Vote only: what methods is this voter willing to use? */
1625 smartlist_t
*supported_methods
;
1627 /** How long does this vote/consensus claim that authorities take to
1628 * distribute their votes to one another? */
1630 /** How long does this vote/consensus claim that authorities take to
1631 * distribute their consensus signatures to one another? */
1634 /** Comma-separated list of recommended client software, or NULL if this
1635 * voter has no opinion. */
1636 char *client_versions
;
1637 char *server_versions
;
1638 /** List of flags that this vote/consensus applies to routers. If a flag is
1639 * not listed here, the voter has no opinion on what its value should be. */
1640 smartlist_t
*known_flags
;
1642 /** List of networkstatus_voter_info_t. For a vote, only one element
1643 * is included. For a consensus, one element is included for every voter
1644 * whose vote contributed to the consensus. */
1645 smartlist_t
*voters
;
1647 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1649 /** Digest of this document, as signed. */
1650 char networkstatus_digest
[DIGEST_LEN
];
1652 /** List of router statuses, sorted by identity digest. For a vote,
1653 * the elements are vote_routerstatus_t; for a consensus, the elements
1654 * are routerstatus_t. */
1655 smartlist_t
*routerstatus_list
;
1657 /** If present, a map from descriptor digest to elements of
1658 * routerstatus_list. */
1659 digestmap_t
*desc_digest_map
;
1662 /** A set of signatures for a networkstatus consensus. All fields are as for
1663 * networkstatus_t. */
1664 typedef struct ns_detached_signatures_t
{
1668 char networkstatus_digest
[DIGEST_LEN
];
1669 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1670 } ns_detached_signatures_t
;
1672 /** Allowable types of desc_store_t. */
1673 typedef enum store_type_t
{
1678 /** A 'store' is a set of descriptors saved on disk, with accompanying
1679 * journal, mmaped as needed, rebuilt as needed. */
1680 typedef struct desc_store_t
{
1681 /** Filename (within DataDir) for the store. We append .tmp to this
1682 * filename for a temporary file when rebuilding the store, and .new to this
1683 * filename for the journal. */
1684 const char *fname_base
;
1685 /** Alternative (obsolete) value for fname_base: if the file named by
1686 * fname_base isn't present, we read from here instead, but we never write
1688 const char *fname_alt_base
;
1689 /** Human-readable description of what this store contains. */
1690 const char *description
;
1692 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1694 store_type_t type
; /**< What's stored in this store? */
1696 /** The size of the router log, in bytes. */
1698 /** The size of the router store, in bytes. */
1700 /** Total bytes dropped since last rebuild: this is space currently
1701 * used in the cache and the journal that could be freed by a rebuild. */
1702 size_t bytes_dropped
;
1705 /** Contents of a directory of onion routers. */
1707 /** Map from server identity digest to a member of routers. */
1708 struct digest_ri_map_t
*identity_map
;
1709 /** Map from server descriptor digest to a signed_descriptor_t from
1710 * routers or old_routers. */
1711 struct digest_sd_map_t
*desc_digest_map
;
1712 /** Map from extra-info digest to an extrainfo_t. Only exists for
1713 * routers in routers or old_routers. */
1714 struct digest_ei_map_t
*extra_info_map
;
1715 /** Map from extra-info digests to a signed_descriptor_t for a router
1716 * descriptor having that extra-info digest. Only exists for
1717 * routers in routers or old_routers. */
1718 struct digest_sd_map_t
*desc_by_eid_map
;
1719 /** List of routerinfo_t for all currently live routers we know. */
1720 smartlist_t
*routers
;
1721 /** List of signed_descriptor_t for older router descriptors we're
1723 smartlist_t
*old_routers
;
1724 /** Store holding server descriptors. If present, any router whose
1725 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1726 * starting at cache_info.saved_offset */
1727 desc_store_t desc_store
;
1728 /** Store holding extra-info documents. */
1729 desc_store_t extrainfo_store
;
1732 /** Information on router used when extending a circuit. We don't need a
1733 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1734 * connection, and onion_key to create the onionskin. Note that for onehop
1735 * general-purpose tunnels, the onion_key is NULL. */
1736 typedef struct extend_info_t
{
1737 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1739 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1740 uint16_t port
; /**< OR port. */
1741 tor_addr_t addr
; /**< IP address. */
1742 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1745 /** Certificate for v3 directory protocol: binds long-term authority identity
1746 * keys to medium-term authority signing keys. */
1747 typedef struct authority_cert_t
{
1748 /** Information relating to caching this cert on disk and looking it up. */
1749 signed_descriptor_t cache_info
;
1750 /** This authority's long-term authority identity key. */
1751 crypto_pk_env_t
*identity_key
;
1752 /** This authority's medium-term signing key. */
1753 crypto_pk_env_t
*signing_key
;
1754 /** The digest of <b>signing_key</b> */
1755 char signing_key_digest
[DIGEST_LEN
];
1756 /** The listed expiration time of this certificate. */
1758 /** This authority's IPv4 address, in host order. */
1760 /** This authority's directory port. */
1762 /** True iff this certificate was cross-certified by signing the identity
1763 * key with the signing key. */
1764 uint8_t is_cross_certified
;
1767 /** Bitfield enum type listing types of directory authority/directory
1771 /** Serves/signs v1 directory information: Big lists of routers, and short
1772 * routerstatus documents. */
1773 V1_AUTHORITY
= 1 << 0,
1774 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
1775 V2_AUTHORITY
= 1 << 1,
1776 /** Serves/signs v3 directory information: votes, consensuses, certs */
1777 V3_AUTHORITY
= 1 << 2,
1778 /** Serves hidden service descriptors. */
1779 HIDSERV_AUTHORITY
= 1 << 3,
1780 /** Serves bridge descriptors. */
1781 BRIDGE_AUTHORITY
= 1 << 4,
1782 /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
1783 EXTRAINFO_CACHE
= 1 << 5,
1786 #define CRYPT_PATH_MAGIC 0x70127012u
1788 /** Holds accounting information for a single step in the layered encryption
1789 * performed by a circuit. Used only at the client edge of a circuit. */
1790 typedef struct crypt_path_t
{
1793 /* crypto environments */
1794 /** Encryption key and counter for cells heading towards the OR at this
1796 crypto_cipher_env_t
*f_crypto
;
1797 /** Encryption key and counter for cells heading back from the OR at this
1799 crypto_cipher_env_t
*b_crypto
;
1801 /** Digest state for cells heading towards the OR at this step. */
1802 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1803 /** Digest state for cells heading away from the OR at this step. */
1804 crypto_digest_env_t
*b_digest
;
1806 /** Current state of Diffie-Hellman key negotiation with the OR at this
1808 crypto_dh_env_t
*dh_handshake_state
;
1809 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1810 * step. Used to save CPU when TLS is already providing all the
1811 * authentication, secrecy, and integrity we need, and we're already
1812 * distinguishable from an OR.
1814 char fast_handshake_state
[DIGEST_LEN
];
1815 /** Negotiated key material shared with the OR at this step. */
1816 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1818 /** Information to extend to the OR at this step. */
1819 extend_info_t
*extend_info
;
1821 /** Is the circuit built to this step? Must be one of:
1822 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1823 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1824 * and not received an EXTENDED/CREATED)
1825 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1827 #define CPATH_STATE_CLOSED 0
1828 #define CPATH_STATE_AWAITING_KEYS 1
1829 #define CPATH_STATE_OPEN 2
1830 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1831 * (The list is circular, so the last node
1832 * links to the first.) */
1833 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1836 int package_window
; /**< How many bytes are we allowed to originate ending
1838 int deliver_window
; /**< How many bytes are we willing to deliver originating
1842 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1844 #define DH_KEY_LEN DH_BYTES
1845 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1848 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1850 /** Information used to build a circuit. */
1852 /** Intended length of the final circuit. */
1853 int desired_path_len
;
1854 /** How to extend to the planned exit node. */
1855 extend_info_t
*chosen_exit
;
1856 /** Whether every node in the circ must have adequate uptime. */
1858 /** Whether every node in the circ must have adequate capacity. */
1860 /** Whether the last hop was picked with exiting in mind. */
1862 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1863 * These are for encrypted connections that exit to this router, not
1864 * for arbitrary exits from the circuit. */
1866 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1867 crypt_path_t
*pending_final_cpath
;
1868 /** How many times has building a circuit for this task failed? */
1870 /** At what time should we give up on this task? */
1872 } cpath_build_state_t
;
1874 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1875 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1878 * A circuit is a path over the onion routing
1879 * network. Applications can connect to one end of the circuit, and can
1880 * create exit connections at the other end of the circuit. AP and exit
1881 * connections have only one circuit associated with them (and thus these
1882 * connection types are closed when the circuit is closed), whereas
1883 * OR connections multiplex many circuits at once, and stay standing even
1884 * when there are no circuits running over them.
1886 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1887 * links two connections together: either an edge connection and an OR
1888 * connection, or two OR connections. (When joined to an OR connection, a
1889 * circuit_t affects only cells sent to a particular circID on that
1890 * connection. When joined to an edge connection, a circuit_t affects all
1893 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1894 * along a given circuit. At the OP, it has a sequence of ciphers, each
1895 * of which is shared with a single OR along the circuit. Separate
1896 * ciphers are used for data going "forward" (away from the OP) and
1897 * "backward" (towards the OP). At the OR, a circuit has only two stream
1898 * ciphers: one for data going forward, and one for data going backward.
1900 typedef struct circuit_t
{
1901 uint32_t magic
; /**< For memory and type debugging: must equal
1902 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1904 /** Queue of cells waiting to be transmitted on n_conn. */
1905 cell_queue_t n_conn_cells
;
1906 /** The OR connection that is next in this circuit. */
1907 or_connection_t
*n_conn
;
1908 /** The circuit_id used in the next (forward) hop of this circuit. */
1911 /** The hop to which we want to extend this circuit. Should be NULL if
1912 * the circuit has attached to a connection. */
1913 extend_info_t
*n_hop
;
1915 /** True iff we are waiting for n_conn_cells to become less full before
1916 * allowing p_streams to add any more cells. (Origin circuit only.) */
1917 unsigned int streams_blocked_on_n_conn
: 1;
1918 /** True iff we are waiting for p_conn_cells to become less full before
1919 * allowing n_streams to add any more cells. (OR circuit only.) */
1920 unsigned int streams_blocked_on_p_conn
: 1;
1922 uint8_t state
; /**< Current status of this circuit. */
1923 uint8_t purpose
; /**< Why are we creating this circuit? */
1925 /** How many relay data cells can we package (read from edge streams)
1926 * on this circuit before we receive a circuit-level sendme cell asking
1929 /** How many relay data cells will we deliver (write to edge streams)
1930 * on this circuit? When deliver_window gets low, we send some
1931 * circuit-level sendme cells to indicate that we're willing to accept
1935 /** For storage while n_conn is pending
1936 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1937 * length ONIONSKIN_CHALLENGE_LEN. */
1938 char *n_conn_onionskin
;
1940 time_t timestamp_created
; /**< When was this circuit created? */
1941 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1942 * circuit is clean. */
1944 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1945 * the main loop? (If true, holds the line number
1946 * where this circuit was marked.) */
1947 const char *marked_for_close_file
; /**< For debugging: in which file was this
1948 * circuit marked for close? */
1950 /** Next circuit in the doubly-linked ring of circuits waiting to add
1951 * cells to n_conn. NULL if we have no cells pending, or if we're not
1952 * linked to an OR connection. */
1953 struct circuit_t
*next_active_on_n_conn
;
1954 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1955 * cells to n_conn. NULL if we have no cells pending, or if we're not
1956 * linked to an OR connection. */
1957 struct circuit_t
*prev_active_on_n_conn
;
1958 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1961 /** Largest number of relay_early cells that we can send on a given
1963 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
1965 /** An origin_circuit_t holds data necessary to build and use a circuit.
1967 typedef struct origin_circuit_t
{
1970 /** Linked list of AP streams (or EXIT streams if hidden service)
1971 * associated with this circuit. */
1972 edge_connection_t
*p_streams
;
1973 /** Build state for this circuit. It includes the intended path
1974 * length, the chosen exit router, rendezvous information, etc.
1976 cpath_build_state_t
*build_state
;
1977 /** The doubly-linked list of crypt_path_t entries, one per hop,
1978 * for this circuit. This includes ciphers for each hop,
1979 * integrity-checking digests for each hop, and package/delivery
1980 * windows for each hop.
1982 crypt_path_t
*cpath
;
1984 /** Holds all rendezvous data on either client or service side. */
1985 rend_data_t
*rend_data
;
1987 /** How many more relay_early cells can we send on this circuit, according
1988 * to the specification? */
1989 unsigned int remaining_relay_early_cells
: 4;
1991 /** What commands were sent over this circuit that decremented the
1992 * RELAY_EARLY counter? This is for debugging task 878. */
1993 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
1995 /** How many RELAY_EARLY cells have been sent over this circuit? This is
1996 * for debugging task 878, too. */
1997 int relay_early_cells_sent
;
1999 /** The next stream_id that will be tried when we're attempting to
2000 * construct a new AP stream originating at this circuit. */
2001 streamid_t next_stream_id
;
2003 /* The intro key replaces the hidden service's public key if purpose is
2004 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2005 * descriptor is used. */
2006 crypto_pk_env_t
*intro_key
;
2008 /** Quasi-global identifier for this circuit; used for control.c */
2009 /* XXXX NM This can get re-used after 2**32 circuits. */
2010 uint32_t global_identifier
;
2014 /** An or_circuit_t holds information needed to implement a circuit at an
2016 typedef struct or_circuit_t
{
2019 /** Next circuit in the doubly-linked ring of circuits waiting to add
2020 * cells to p_conn. NULL if we have no cells pending, or if we're not
2021 * linked to an OR connection. */
2022 struct circuit_t
*next_active_on_p_conn
;
2023 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2024 * cells to p_conn. NULL if we have no cells pending, or if we're not
2025 * linked to an OR connection. */
2026 struct circuit_t
*prev_active_on_p_conn
;
2028 /** The circuit_id used in the previous (backward) hop of this circuit. */
2030 /** Queue of cells waiting to be transmitted on p_conn. */
2031 cell_queue_t p_conn_cells
;
2032 /** The OR connection that is previous in this circuit. */
2033 or_connection_t
*p_conn
;
2034 /** Linked list of Exit streams associated with this circuit. */
2035 edge_connection_t
*n_streams
;
2036 /** Linked list of Exit streams associated with this circuit that are
2037 * still being resolved. */
2038 edge_connection_t
*resolving_streams
;
2039 /** The cipher used by intermediate hops for cells heading toward the
2041 crypto_cipher_env_t
*p_crypto
;
2042 /** The cipher used by intermediate hops for cells heading away from
2044 crypto_cipher_env_t
*n_crypto
;
2046 /** The integrity-checking digest used by intermediate hops, for
2047 * cells packaged here and heading towards the OP.
2049 crypto_digest_env_t
*p_digest
;
2050 /** The integrity-checking digest used by intermediate hops, for
2051 * cells packaged at the OP and arriving here.
2053 crypto_digest_env_t
*n_digest
;
2055 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2056 * is not marked for close. */
2057 struct or_circuit_t
*rend_splice
;
2059 #if REND_COOKIE_LEN >= DIGEST_LEN
2060 #define REND_TOKEN_LEN REND_COOKIE_LEN
2062 #define REND_TOKEN_LEN DIGEST_LEN
2065 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2066 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2068 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2070 char rend_token
[REND_TOKEN_LEN
];
2072 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2073 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2075 /** How many more relay_early cells can we send on this circuit, according
2076 * to the specification? */
2077 unsigned int remaining_relay_early_cells
: 4;
2079 /** True iff this circuit was made with a CREATE_FAST cell. */
2080 unsigned int is_first_hop
: 1;
2082 #ifdef ENABLE_BUFFER_STATS
2083 /** Number of cells that were removed from circuit queue; reset every
2084 * time when writing buffer stats to disk. */
2085 uint32_t processed_cells
;
2087 /** Total time in milliseconds that cells spent in both app-ward and
2088 * exit-ward queues of this circuit; reset every time when writing
2089 * buffer stats to disk. */
2090 uint64_t total_cell_waiting_time
;
2094 /** Convert a circuit subtype to a circuit_t.*/
2095 #define TO_CIRCUIT(x) (&((x)->_base))
2097 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2098 * if the cast is impossible. */
2099 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2100 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2101 * Asserts if the cast is impossible. */
2102 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2104 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2106 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2107 return DOWNCAST(or_circuit_t
, x
);
2109 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2111 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2112 return DOWNCAST(origin_circuit_t
, x
);
2115 /** Bitfield type: things that we're willing to use invalid routers for. */
2116 typedef enum invalid_router_usage_t
{
2117 ALLOW_INVALID_ENTRY
=1,
2118 ALLOW_INVALID_EXIT
=2,
2119 ALLOW_INVALID_MIDDLE
=4,
2120 ALLOW_INVALID_RENDEZVOUS
=8,
2121 ALLOW_INVALID_INTRODUCTION
=16,
2122 } invalid_router_usage_t
;
2124 /* limits for TCP send and recv buffer size used for constrained sockets */
2125 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2126 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2128 /** A linked list of lines in a config file. */
2129 typedef struct config_line_t
{
2132 struct config_line_t
*next
;
2135 typedef struct routerset_t routerset_t
;
2137 /** Configuration options for a Tor process. */
2141 /** What should the tor process actually do? */
2143 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2144 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2146 const char *command_arg
; /**< Argument for command-line option. */
2148 config_line_t
*Logs
; /**< New-style list of configuration lines
2151 char *DebugLogFile
; /**< Where to send verbose log messages. */
2152 char *DataDirectory
; /**< OR only: where to store long-term data. */
2153 char *Nickname
; /**< OR only: nickname of this onion router. */
2154 char *Address
; /**< OR only: configured address for this onion router. */
2155 char *PidFile
; /**< Where to store PID of Tor process. */
2157 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2158 * country codes and IP address patterns of ORs to
2159 * consider as exits. */
2160 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2161 * country codes and IP address patterns of ORs to
2162 * consider as entry points. */
2163 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2164 * stop building circuits? */
2165 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2166 * stop building circuits? */
2167 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2168 * country codes and IP address patterns of ORs
2169 * not to use in circuits. */
2170 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2171 * country codes and IP address patterns of
2172 * ORs not to consider as exits. */
2174 /** Union of ExcludeNodes and ExcludeExitNodes */
2175 struct routerset_t
*_ExcludeExitNodesUnion
;
2177 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2178 smartlist_t
*AllowInvalidNodes
;
2179 /** Bitmask; derived from AllowInvalidNodes. */
2180 invalid_router_usage_t _AllowInvalid
;
2181 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2182 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2183 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2184 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2185 /** Addresses to bind for listening for SOCKS connections. */
2186 config_line_t
*SocksListenAddress
;
2187 /** Addresses to bind for listening for transparent pf/netfilter
2189 config_line_t
*TransListenAddress
;
2190 /** Addresses to bind for listening for transparent natd connections */
2191 config_line_t
*NatdListenAddress
;
2192 /** Addresses to bind for listening for SOCKS connections. */
2193 config_line_t
*DNSListenAddress
;
2194 /** Addresses to bind for listening for OR connections. */
2195 config_line_t
*ORListenAddress
;
2196 /** Addresses to bind for listening for directory connections. */
2197 config_line_t
*DirListenAddress
;
2198 /** Addresses to bind for listening for control connections. */
2199 config_line_t
*ControlListenAddress
;
2200 /** Local address to bind outbound sockets */
2201 char *OutboundBindAddress
;
2202 /** Directory server only: which versions of
2203 * Tor should we tell users to run? */
2204 config_line_t
*RecommendedVersions
;
2205 config_line_t
*RecommendedClientVersions
;
2206 config_line_t
*RecommendedServerVersions
;
2207 /** Whether dirservers refuse router descriptors with private IPs. */
2208 int DirAllowPrivateAddresses
;
2209 char *User
; /**< Name of user to run Tor as. */
2210 char *Group
; /**< Name of group to run Tor as. */
2211 int ORPort
; /**< Port to listen on for OR connections. */
2212 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2213 /** Port to listen on for transparent pf/netfilter connections. */
2215 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2216 int ControlPort
; /**< Port to listen on for control connections. */
2217 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2218 * for control connections. */
2219 int DirPort
; /**< Port to listen on for directory connections. */
2220 int DNSPort
; /**< Port to listen on for DNS requests. */
2221 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2222 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2223 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2224 * for version 1 directories? */
2225 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2226 * for version 2 directories? */
2227 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2228 * for version 3 directories? */
2229 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2230 * handle hidden service requests? */
2231 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
2232 * directory record statistics? */
2233 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2234 * that's willing to bind names? */
2235 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2236 * directory that's willing to recommend
2238 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2239 * that aggregates bridge descriptors? */
2241 /** If set on a bridge authority, it will answer requests on its dirport
2242 * for bridge statuses -- but only if the requests use this password.
2243 * If set on a bridge user, request bridge statuses, and use this password
2245 char *BridgePassword
;
2247 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2248 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2250 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2251 * this explicit so we can change how we behave in the
2254 /** Boolean: if we know the bridge's digest, should we get new
2255 * descriptors from the bridge authorities or from the bridge itself? */
2256 int UpdateBridgesFromAuthority
;
2258 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2260 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2261 /** Boolean: should we never publish a descriptor? Deprecated. */
2263 /** To what authority types do we publish our descriptor? Choices are
2264 * "v1", "v2", "v3", "bridge", or "". */
2265 smartlist_t
*PublishServerDescriptor
;
2266 /** An authority type, derived from PublishServerDescriptor. */
2267 authority_type_t _PublishServerDescriptor
;
2268 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2269 int PublishHidServDescriptors
;
2270 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2271 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2272 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2274 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2275 * service directories after what time? */
2276 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2277 int AllDirActionsPrivate
; /**< Should every directory action be sent
2278 * through a Tor circuit? */
2280 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2281 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2282 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2283 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2284 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2286 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2287 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2288 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2290 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2291 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2293 /** Application ports that require all nodes in circ to have sufficient
2295 smartlist_t
*LongLivedPorts
;
2296 /** Application ports that are likely to be unencrypted and
2297 * unauthenticated; we reject requests for them to prevent the
2298 * user from screwing up and leaking plaintext secrets to an
2299 * observer somewhere on the Internet. */
2300 smartlist_t
*RejectPlaintextPorts
;
2301 /** Related to RejectPlaintextPorts above, except this config option
2302 * controls whether we warn (in the log and via a controller status
2303 * event) every time a risky connection is attempted. */
2304 smartlist_t
*WarnPlaintextPorts
;
2305 /** Should we try to reuse the same exit node for a given host */
2306 smartlist_t
*TrackHostExits
;
2307 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2309 config_line_t
*AddressMap
; /**< List of address map directives. */
2310 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2311 * hostname ending with one of the suffixes in
2312 * <b>AutomapHostsSuffixes</b>, map it to a
2313 * virtual address. */
2314 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2315 * <b>AutomapHostsOnResolve</b>. */
2316 int RendPostPeriod
; /**< How often do we post each rendezvous service
2317 * descriptor? Remember to publish them independently. */
2318 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2319 * connections alive? */
2320 int SocksTimeout
; /**< How long do we let a socks connection wait
2321 * unattached before we fail it? */
2322 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2323 * at least this many seconds ago. */
2324 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2325 * at least this many seconds ago. */
2326 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2327 * to wait simultaneously before we start dropping
2329 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2331 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2332 this interval ago. */
2333 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2334 * to use in a second? */
2335 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2336 * to use in a second? */
2337 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2338 * tell people we have? */
2339 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2340 * willing to use for all relayed conns? */
2341 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2342 * use in a second for all relayed conns? */
2343 int NumCpus
; /**< How many CPUs should we try to use? */
2344 int RunTesting
; /**< If true, create testing circuits to measure how well the
2345 * other ORs are running. */
2346 config_line_t
*RendConfigLines
; /**< List of configuration lines
2347 * for rendezvous services. */
2348 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2349 * authorizations for hidden services */
2350 char *ContactInfo
; /**< Contact info to be published in the directory. */
2352 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2353 uint32_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2354 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2355 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2357 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2358 uint32_t HttpsProxyAddr
; /**< Parsed IPv4 addr for https proxy, if any. */
2359 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2360 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2362 /** List of configuration lines for replacement directory authorities.
2363 * If you just want to replace one class of authority at a time,
2364 * use the "Alternate*Authority" options below instead. */
2365 config_line_t
*DirServers
;
2367 /** If set, use these main (currently v3) directory authorities and
2368 * not the default ones. */
2369 config_line_t
*AlternateDirAuthority
;
2371 /** If set, use these bridge authorities and not the default one. */
2372 config_line_t
*AlternateBridgeAuthority
;
2374 /** If set, use these HS authorities and not the default ones. */
2375 config_line_t
*AlternateHSAuthority
;
2377 char *MyFamily
; /**< Declared family for this OR. */
2378 config_line_t
*NodeFamilies
; /**< List of config lines for
2380 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2381 * mark as bad dir mirrors. */
2382 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2383 * mark as bad exits. */
2384 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2386 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2387 * never mark as valid. */
2388 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2389 * and vote for all other dir mirrors as good. */
2390 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2391 * and vote for all other exits as good. */
2392 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2393 * aren't named in our fingerprint file? */
2394 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2395 * number of servers per IP address. */
2396 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2397 * number of servers per IP address shared
2398 * with an authority. */
2400 char *AccountingStart
; /**< How long is the accounting interval, and when
2402 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2403 * interval before hibernation? 0 for "never
2406 /** Base64-encoded hash of accepted passwords for the control system. */
2407 config_line_t
*HashedControlPassword
;
2408 /** As HashedControlPassword, but not saved. */
2409 config_line_t
*HashedControlSessionPassword
;
2411 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2412 * the control system? */
2413 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2414 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2415 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2416 * circuits itself (0), or does it expect a controller
2418 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2419 * make circuits in the background (0),
2421 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2422 * long do we wait before exiting? */
2423 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2424 * such as addresses (0), or do we scrub them first (1)? */
2425 int SafeSocks
; /**< Boolean: should we outright refuse application
2426 * connections that use socks4 or socks5-with-local-dns? */
2427 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2428 LOG_WARN : LOG_INFO)
2429 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2430 * protocol, is it a warn or an info in our logs? */
2431 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2432 * log whether it was DNS-leaking or not? */
2433 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2434 * acceleration where available? */
2435 char *AccelName
; /**< Optional hardware acceleration engine name. */
2436 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
2437 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2438 * of fixed nodes? */
2439 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2440 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2441 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2442 * of our PK time by sending CREATE_FAST cells? */
2443 /** Should we always fetch our dir info on the mirror schedule (which
2444 * means directly from the authorities) no matter our other config? */
2445 int FetchDirInfoEarly
;
2447 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2448 * MAPADDRESS requests. */
2449 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2450 * addresses to be FQDNs, but rather search for them in
2451 * the local domains. */
2452 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2454 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2455 * DNS poisoning attacks. */
2456 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2457 * resolver from the file here rather than from
2458 * /etc/resolv.conf (Unix) or the registry (Windows). */
2459 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2460 disclaimer. This allows a server administrator to show
2461 that they're running Tor and anyone visiting their server
2462 will know this without any specialized knowledge. */
2463 /** Boolean: if set, we start even if our resolv.conf file is missing
2465 int ServerDNSAllowBrokenConfig
;
2467 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2468 * should be resolvable. Used for
2469 * testing our DNS server. */
2470 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2471 * same network zone in the same circuit. */
2472 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2474 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2475 * support BEGIN_DIR, when possible. */
2476 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2477 * with weird characters. */
2478 /** If true, we try resolving hostnames with weird characters. */
2479 int ServerDNSAllowNonRFC953Hostnames
;
2481 /** If true, we try to download extra-info documents (and we serve them,
2482 * if we are a cache). For authorities, this is always true. */
2483 int DownloadExtraInfo
;
2485 /** If true, and we are acting as a relay, allow exit circuits even when
2486 * we are the first hop of a circuit. */
2487 int AllowSingleHopExits
;
2488 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2489 * circuits that we build. */
2490 int ExcludeSingleHopRelays
;
2491 /** If true, and the controller tells us to use a one-hop circuit, and the
2492 * exit allows it, we use it. */
2493 int AllowSingleHopCircuits
;
2495 /** If true, the user wants us to collect statistics on port usage. */
2496 int ExitPortStatistics
;
2498 /** If true, the user wants us to collect cell statistics. */
2501 /** If true, the user wants us to collect statistics as entry node. */
2502 int EntryStatistics
;
2504 /** If true, do not believe anybody who tells us that a domain resolves
2505 * to an internal address, or that an internal address has a PTR mapping.
2506 * Helps avoid some cross-site attacks. */
2507 int ClientDNSRejectInternalAddresses
;
2509 /** The length of time that we think a consensus should be fresh. */
2510 int V3AuthVotingInterval
;
2511 /** The length of time we think it will take to distribute votes. */
2512 int V3AuthVoteDelay
;
2513 /** The length of time we think it will take to distribute signatures. */
2514 int V3AuthDistDelay
;
2515 /** The number of intervals we think a consensus should be valid. */
2516 int V3AuthNIntervalsValid
;
2518 /** Should advertise and sign consensuses with a legacy key, for key
2519 * migration purposes? */
2520 int V3AuthUseLegacyKey
;
2522 /** The length of time that we think an initial consensus should be fresh.
2523 * Only altered on testing networks. */
2524 int TestingV3AuthInitialVotingInterval
;
2526 /** The length of time we think it will take to distribute initial votes.
2527 * Only altered on testing networks. */
2528 int TestingV3AuthInitialVoteDelay
;
2530 /** The length of time we think it will take to distribute initial
2531 * signatures. Only altered on testing networks.*/
2532 int TestingV3AuthInitialDistDelay
;
2534 /** If an authority has been around for less than this amount of time, it
2535 * does not believe its reachability information is accurate. Only
2536 * altered on testing networks. */
2537 int TestingAuthDirTimeToLearnReachability
;
2539 /** Clients don't download any descriptor this recent, since it will
2540 * probably not have propagated to enough caches. Only altered on testing
2542 int TestingEstimatedDescriptorPropagationTime
;
2544 /** If true, we take part in a testing network. Change the defaults of a
2545 * couple of other configuration options and allow to change the values
2546 * of certain configuration options. */
2547 int TestingTorNetwork
;
2549 /** File to check for a consensus networkstatus, if we don't have one
2551 char *FallbackNetworkstatusFile
;
2553 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2554 * count of how many client addresses have contacted us so that we can help
2555 * the bridge authority guess which countries have blocked access to us. */
2556 int BridgeRecordUsageByCountry
;
2559 /** If true, and Tor is built with GEOIP_STATS support, and we're a
2560 * directory, record how many directory requests we get from each country. */
2561 int DirRecordUsageByCountry
;
2562 /** Round all GeoIP results to the next multiple of this value, to avoid
2563 * leaking information. */
2564 int DirRecordUsageGranularity
;
2565 /** Time interval: purge geoip stats after this long. */
2566 int DirRecordUsageRetainIPs
;
2567 /** Time interval: Flush geoip data to disk this often. */
2568 int DirRecordUsageSaveInterval
;
2571 /** Optionally, a file with GeoIP data. */
2574 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2575 * to make this false. */
2576 int ReloadTorrcOnSIGHUP
;
2580 /** Persistent state for an onion router, as saved to disk. */
2583 /** The time at which we next plan to write the state to the disk. Equal to
2584 * TIME_MAX if there are no savable changes, 0 if there are changes that
2585 * should be saved right away. */
2588 /** When was the state last written to disk? */
2591 /** Fields for accounting bandwidth use. */
2592 time_t AccountingIntervalStart
;
2593 uint64_t AccountingBytesReadInInterval
;
2594 uint64_t AccountingBytesWrittenInInterval
;
2595 int AccountingSecondsActive
;
2596 uint64_t AccountingExpectedUsage
;
2598 /** A list of Entry Guard-related configuration lines. */
2599 config_line_t
*EntryGuards
;
2601 /** These fields hold information on the history of bandwidth usage for
2602 * servers. The "Ends" fields hold the time when we last updated the
2603 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2604 * of the entries of Values. The "Values" lists hold decimal string
2605 * representations of the number of bytes read or written in each
2607 time_t BWHistoryReadEnds
;
2608 int BWHistoryReadInterval
;
2609 smartlist_t
*BWHistoryReadValues
;
2610 time_t BWHistoryWriteEnds
;
2611 int BWHistoryWriteInterval
;
2612 smartlist_t
*BWHistoryWriteValues
;
2614 /** What version of Tor wrote this state file? */
2617 /** Holds any unrecognized values we found in the state file, in the order
2618 * in which we found them. */
2619 config_line_t
*ExtraLines
;
2621 /** When did we last rotate our onion key? "0" for 'no idea'. */
2622 time_t LastRotatedOnionKey
;
2625 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2626 * state is already scheduled to be written to disk earlier than <b>when</b>.
2628 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2630 if (state
->next_write
> when
)
2631 state
->next_write
= when
;
2634 #define MAX_SOCKS_REPLY_LEN 1024
2635 #define MAX_SOCKS_ADDR_LEN 256
2637 /** Please open a TCP connection to this addr:port. */
2638 #define SOCKS_COMMAND_CONNECT 0x01
2639 /** Please turn this FQDN into an IP address, privately. */
2640 #define SOCKS_COMMAND_RESOLVE 0xF0
2641 /** Please turn this IP address into an FQDN, privately. */
2642 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2644 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2645 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2646 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2648 /** State of a SOCKS request from a user to an OP. Also used to encode other
2649 * information for non-socks user request (such as those on TransPort and
2651 struct socks_request_t
{
2652 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2653 * 0 means that no socks handshake ever took place, and this is just a
2654 * stub connection (e.g. see connection_ap_make_link()). */
2656 int command
; /**< What is this stream's goal? One from the above list. */
2657 size_t replylen
; /**< Length of <b>reply</b>. */
2658 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2659 * we want to specify our own socks reply,
2660 * rather than using the default socks4 or
2661 * socks5 socks reply. We use this for the
2662 * two-stage socks5 handshake.
2664 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2665 connect to/resolve? */
2666 uint16_t port
; /**< What port did the client ask to connect to? */
2667 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2668 * make sure we send back a socks reply for
2669 * every connection. */
2672 /* all the function prototypes go here */
2674 /********************************* buffers.c ***************************/
2676 buf_t
*buf_new(void);
2677 buf_t
*buf_new_with_capacity(size_t size
);
2678 void buf_free(buf_t
*buf
);
2679 void buf_clear(buf_t
*buf
);
2680 void buf_shrink(buf_t
*buf
);
2681 void buf_shrink_freelists(int free_all
);
2682 void buf_dump_freelist_sizes(int severity
);
2684 size_t buf_datalen(const buf_t
*buf
);
2685 size_t buf_allocation(const buf_t
*buf
);
2686 size_t buf_slack(const buf_t
*buf
);
2687 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2689 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
,
2691 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2693 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2694 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2696 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2697 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2698 const char *data
, size_t data_len
, int done
);
2699 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2700 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2701 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2702 int fetch_from_buf_http(buf_t
*buf
,
2703 char **headers_out
, size_t max_headerlen
,
2704 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2705 int force_complete
);
2706 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2707 int log_sockstype
, int safe_socks
);
2708 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2710 int peek_buf_has_control0_command(buf_t
*buf
);
2712 void assert_buf_ok(buf_t
*buf
);
2714 #ifdef BUFFERS_PRIVATE
2715 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2718 /********************************* circuitbuild.c **********************/
2720 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2721 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2722 void circuit_log_path(int severity
, unsigned int domain
,
2723 origin_circuit_t
*circ
);
2724 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2725 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2726 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2727 extend_info_t
*exit
,
2729 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2730 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2731 int inform_testing_reachability(void);
2732 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2733 void circuit_note_clock_jumped(int seconds_elapsed
);
2734 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2735 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2737 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2739 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2740 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2741 const char *payload
, const char *keys
);
2742 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2743 int *need_capacity
);
2745 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2746 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2747 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2748 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2749 crypto_pk_env_t
*onion_key
,
2750 const tor_addr_t
*addr
, uint16_t port
);
2751 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2752 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2753 void extend_info_free(extend_info_t
*info
);
2754 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2755 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2757 void entry_guards_compute_status(void);
2758 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2759 int mark_relay_status
, time_t now
);
2760 void entry_nodes_should_be_added(void);
2761 int entry_list_can_grow(or_options_t
*options
);
2762 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2763 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2764 void entry_guards_update_state(or_state_t
*state
);
2765 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2766 const char *question
, char **answer
);
2768 void clear_bridge_list(void);
2769 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2770 void bridge_add_from_config(const tor_addr_t
*addr
, uint16_t port
,
2772 void retry_bridge_descriptor_fetch_directly(const char *digest
);
2773 void fetch_bridge_descriptors(time_t now
);
2774 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2775 int any_bridge_descriptors_known(void);
2776 int any_pending_bridge_descriptor_fetches(void);
2777 int bridges_known_but_down(void);
2778 void bridges_retry_all(void);
2780 void entry_guards_free_all(void);
2782 /********************************* circuitlist.c ***********************/
2784 circuit_t
* _circuit_get_global_list(void);
2785 const char *circuit_state_to_string(int state
);
2786 const char *circuit_purpose_to_controller_string(uint8_t purpose
);
2787 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
2788 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, circid_t id
,
2789 or_connection_t
*conn
);
2790 void circuit_set_n_circid_orconn(circuit_t
*circ
, circid_t id
,
2791 or_connection_t
*conn
);
2792 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
2793 void circuit_close_all_marked(void);
2794 origin_circuit_t
*origin_circuit_new(void);
2795 or_circuit_t
*or_circuit_new(circid_t p_circ_id
, or_connection_t
*p_conn
);
2796 circuit_t
*circuit_get_by_circid_orconn(circid_t circ_id
,
2797 or_connection_t
*conn
);
2798 int circuit_id_in_use_on_orconn(circid_t circ_id
, or_connection_t
*conn
);
2799 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
2800 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
2801 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
2802 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
2804 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
2805 const char *digest
, uint8_t purpose
);
2806 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
2807 or_circuit_t
*circuit_get_intro_point(const char *digest
);
2808 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
2809 extend_info_t
*info
, int flags
);
2810 void circuit_mark_all_unused_circs(void);
2811 void circuit_expire_all_dirty_circs(void);
2812 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
2813 int line
, const char *file
);
2814 int circuit_get_cpath_len(origin_circuit_t
*circ
);
2815 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
2816 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
2817 or_connection_t
*or_conn
);
2818 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
2820 #define circuit_mark_for_close(c, reason) \
2821 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
2823 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
2824 void assert_circuit_ok(const circuit_t
*c
);
2825 void circuit_free_all(void);
2827 /********************************* circuituse.c ************************/
2829 void circuit_expire_building(time_t now
);
2830 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
2831 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
2833 int circuit_conforms_to_options(const origin_circuit_t
*circ
,
2834 const or_options_t
*options
);
2835 void circuit_build_needed_circs(time_t now
);
2836 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
2838 void reset_bandwidth_test(void);
2839 int circuit_enough_testing_circs(void);
2841 void circuit_has_opened(origin_circuit_t
*circ
);
2842 void circuit_build_failed(origin_circuit_t
*circ
);
2844 /** Flag to set when a circuit should have only a single hop. */
2845 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
2846 /** Flag to set when a circuit needs to be built of high-uptime nodes */
2847 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
2848 /** Flag to set when a circuit needs to be built of high-capacity nodes */
2849 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
2850 /** Flag to set when the last hop of a circuit doesn't need to be an
2852 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
2853 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
2854 extend_info_t
*info
,
2856 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
2857 routerinfo_t
*exit
, int flags
);
2858 void circuit_reset_failure_count(int timeout
);
2859 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
2860 origin_circuit_t
*circ
,
2861 crypt_path_t
*cpath
);
2862 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
2864 /********************************* command.c ***************************/
2866 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
2867 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
2869 extern uint64_t stats_n_padding_cells_processed
;
2870 extern uint64_t stats_n_create_cells_processed
;
2871 extern uint64_t stats_n_created_cells_processed
;
2872 extern uint64_t stats_n_relay_cells_processed
;
2873 extern uint64_t stats_n_destroy_cells_processed
;
2875 /********************************* config.c ***************************/
2877 /** An error from options_trial_assign() or options_init_from_string(). */
2878 typedef enum setopt_err_t
{
2880 SETOPT_ERR_MISC
= -1,
2881 SETOPT_ERR_PARSE
= -2,
2882 SETOPT_ERR_TRANSITION
= -3,
2883 SETOPT_ERR_SETTING
= -4,
2886 const char *get_dirportfrontpage(void);
2887 or_options_t
*get_options(void);
2888 int set_options(or_options_t
*new_val
, char **msg
);
2889 void config_free_all(void);
2890 const char *safe_str(const char *address
);
2891 const char *escaped_safe_str(const char *address
);
2892 const char *get_version(void);
2894 int config_get_lines(const char *string
, config_line_t
**result
);
2895 void config_free_lines(config_line_t
*front
);
2896 setopt_err_t
options_trial_assign(config_line_t
*list
, int use_defaults
,
2897 int clear_first
, char **msg
);
2898 int resolve_my_address(int warn_severity
, or_options_t
*options
,
2899 uint32_t *addr
, char **hostname_out
);
2900 int is_local_addr(const tor_addr_t
*addr
) ATTR_PURE
;
2901 void options_init(or_options_t
*options
);
2902 int options_init_from_torrc(int argc
, char **argv
);
2903 setopt_err_t
options_init_from_string(const char *cf
,
2904 int command
, const char *command_arg
, char **msg
);
2905 int option_is_recognized(const char *key
);
2906 const char *option_get_canonical_name(const char *key
);
2907 config_line_t
*option_get_assignment(or_options_t
*options
,
2909 int options_save_current(void);
2910 const char *get_torrc_fname(void);
2911 char *options_get_datadir_fname2_suffix(or_options_t
*options
,
2912 const char *sub1
, const char *sub2
,
2913 const char *suffix
);
2914 #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
2915 options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
2916 /** Return a newly allocated string containing datadir/sub1. See
2917 * get_datadir_fname2_suffix. */
2918 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
2919 /** Return a newly allocated string containing datadir/sub1/sub2. See
2920 * get_datadir_fname2_suffix. */
2921 #define get_datadir_fname2(sub1,sub2) \
2922 get_datadir_fname2_suffix((sub1), (sub2), NULL)
2923 /** Return a newly allocated string containing datadir/sub1suffix. See
2924 * get_datadir_fname2_suffix. */
2925 #define get_datadir_fname_suffix(sub1, suffix) \
2926 get_datadir_fname2_suffix((sub1), NULL, (suffix))
2928 or_state_t
*get_or_state(void);
2929 int or_state_save(time_t now
);
2931 int options_need_geoip_info(or_options_t
*options
, const char **reason_out
);
2932 int getinfo_helper_config(control_connection_t
*conn
,
2933 const char *question
, char **answer
);
2935 const char *tor_get_digests(void);
2937 #ifdef CONFIG_PRIVATE
2938 /* Used only by config.c and test.c */
2939 or_options_t
*options_new(void);
2942 /********************************* connection.c ***************************/
2944 const char *conn_type_to_string(int type
);
2945 const char *conn_state_to_string(int type
, int state
);
2947 dir_connection_t
*dir_connection_new(int socket_family
);
2948 or_connection_t
*or_connection_new(int socket_family
);
2949 edge_connection_t
*edge_connection_new(int type
, int socket_family
);
2950 control_connection_t
*control_connection_new(int socket_family
);
2951 connection_t
*connection_new(int type
, int socket_family
);
2953 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
2954 void connection_free(connection_t
*conn
);
2955 void connection_free_all(void);
2956 void connection_about_to_close_connection(connection_t
*conn
);
2957 void connection_close_immediate(connection_t
*conn
);
2958 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
2960 #define connection_mark_for_close(c) \
2961 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
2963 void connection_expire_held_open(void);
2965 int connection_connect(connection_t
*conn
, const char *address
,
2966 const tor_addr_t
*addr
,
2967 uint16_t port
, int *socket_error
);
2968 int retry_all_listeners(smartlist_t
*replaced_conns
,
2969 smartlist_t
*new_conns
);
2971 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
2972 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
2973 void connection_bucket_init(void);
2974 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
2976 int connection_handle_read(connection_t
*conn
);
2978 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
2980 int connection_wants_to_flush(connection_t
*conn
);
2981 int connection_outbuf_too_full(connection_t
*conn
);
2982 int connection_handle_write(connection_t
*conn
, int force
);
2983 void _connection_write_to_buf_impl(const char *string
, size_t len
,
2984 connection_t
*conn
, int zlib
);
2985 static void connection_write_to_buf(const char *string
, size_t len
,
2986 connection_t
*conn
);
2987 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
2988 dir_connection_t
*conn
, int done
);
2990 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
2992 _connection_write_to_buf_impl(string
, len
, conn
, 0);
2995 connection_write_to_buf_zlib(const char *string
, size_t len
,
2996 dir_connection_t
*conn
, int done
)
2998 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
3001 connection_t
*connection_get_by_global_id(uint64_t id
);
3003 connection_t
*connection_get_by_type(int type
);
3004 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
3005 connection_t
*connection_get_by_type_addr_port_purpose(int type
,
3006 const tor_addr_t
*addr
,
3007 uint16_t port
, int purpose
);
3008 connection_t
*connection_get_by_type_state(int type
, int state
);
3009 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
3010 const char *rendquery
);
3012 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
3013 int connection_is_listener(connection_t
*conn
);
3014 int connection_state_is_open(connection_t
*conn
);
3015 int connection_state_is_connecting(connection_t
*conn
);
3017 char *alloc_http_authenticator(const char *authenticator
);
3019 void assert_connection_ok(connection_t
*conn
, time_t now
);
3020 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
3021 void connection_dump_buffer_mem_stats(int severity
);
3022 void remove_file_if_very_old(const char *fname
, time_t now
);
3024 /********************************* connection_edge.c *************************/
3026 #define connection_mark_unattached_ap(conn, endreason) \
3027 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
3029 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
3030 int line
, const char *file
);
3031 int connection_edge_reached_eof(edge_connection_t
*conn
);
3032 int connection_edge_process_inbuf(edge_connection_t
*conn
,
3033 int package_partial
);
3034 int connection_edge_destroy(circid_t circ_id
, edge_connection_t
*conn
);
3035 int connection_edge_end(edge_connection_t
*conn
, uint8_t reason
);
3036 int connection_edge_end_errno(edge_connection_t
*conn
);
3037 int connection_edge_finished_flushing(edge_connection_t
*conn
);
3038 int connection_edge_finished_connecting(edge_connection_t
*conn
);
3040 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
3041 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
3043 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
3045 int use_begindir
, int want_onehop
);
3046 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
3049 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
3056 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
3057 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
3058 void connection_exit_connect(edge_connection_t
*conn
);
3059 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
3060 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
3061 void connection_ap_expire_beginning(void);
3062 void connection_ap_attach_pending(void);
3063 void connection_ap_fail_onehop(const char *failed_digest
,
3064 cpath_build_state_t
*build_state
);
3065 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
3066 int connection_ap_detach_retriable(edge_connection_t
*conn
,
3067 origin_circuit_t
*circ
,
3069 int connection_ap_process_transparent(edge_connection_t
*conn
);
3071 int address_is_invalid_destination(const char *address
, int client
);
3073 void addressmap_init(void);
3074 void addressmap_clean(time_t now
);
3075 void addressmap_clear_configured(void);
3076 void addressmap_clear_transient(void);
3077 void addressmap_free_all(void);
3078 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
3079 int addressmap_have_mapping(const char *address
, int update_timeout
);
3080 /** Enumerates possible origins of a client-side address mapping. */
3082 /** We're remapping this address because the controller told us to. */
3083 ADDRMAPSRC_CONTROLLER
,
3084 /** We're remapping this address because our configuration (via torrc, the
3085 * command line, or a SETCONF command) told us to. */
3087 /** We're remapping this address because we have TrackHostExit configured,
3088 * and we want to remember to use the same exit next time. */
3089 ADDRMAPSRC_TRACKEXIT
,
3090 /** We're remapping this address because we got a DNS resolution from a
3091 * Tor server that told us what its value was. */
3093 } addressmap_entry_source_t
;
3094 void addressmap_register(const char *address
, char *new_address
,
3095 time_t expires
, addressmap_entry_source_t source
);
3096 int parse_virtual_addr_network(const char *val
, int validate_only
,
3098 int client_dns_incr_failures(const char *address
);
3099 void client_dns_clear_failures(const char *address
);
3100 void client_dns_set_addressmap(const char *address
, uint32_t val
,
3101 const char *exitname
, int ttl
);
3102 const char *addressmap_register_virtual_address(int type
, char *new_address
);
3103 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
3104 time_t max_expires
, int want_expiry
);
3105 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
3106 origin_circuit_t
*circ
,
3107 crypt_path_t
*cpath
);
3108 int hostname_is_noconnect_address(const char *address
);
3110 /** Possible return values for parse_extended_hostname. */
3111 typedef enum hostname_type_t
{
3112 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
3114 hostname_type_t
parse_extended_hostname(char *address
);
3116 #if defined(HAVE_NET_IF_H) && defined(HAVE_NET_PFVAR_H)
3117 int get_pf_socket(void);
3120 /********************************* connection_or.c ***************************/
3122 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
3123 void connection_or_clear_identity_map(void);
3124 or_connection_t
*connection_or_get_for_extend(const char *digest
,
3125 const tor_addr_t
*target_addr
,
3126 const char **msg_out
,
3128 void connection_or_set_bad_connections(void);
3130 int connection_or_reached_eof(or_connection_t
*conn
);
3131 int connection_or_process_inbuf(or_connection_t
*conn
);
3132 int connection_or_flushed_some(or_connection_t
*conn
);
3133 int connection_or_finished_flushing(or_connection_t
*conn
);
3134 int connection_or_finished_connecting(or_connection_t
*conn
);
3136 void connection_or_connect_failed(or_connection_t
*conn
,
3137 int reason
, const char *msg
);
3138 or_connection_t
*connection_or_connect(const tor_addr_t
*addr
, uint16_t port
,
3139 const char *id_digest
);
3141 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
3142 int connection_tls_continue_handshake(or_connection_t
*conn
);
3144 void or_handshake_state_free(or_handshake_state_t
*state
);
3145 int connection_or_set_state_open(or_connection_t
*conn
);
3146 void connection_or_write_cell_to_buf(const cell_t
*cell
,
3147 or_connection_t
*conn
);
3148 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
3149 or_connection_t
*conn
);
3150 int connection_or_send_destroy(circid_t circ_id
, or_connection_t
*conn
,
3152 int connection_or_send_netinfo(or_connection_t
*conn
);
3153 int connection_or_send_cert(or_connection_t
*conn
);
3154 int connection_or_send_link_auth(or_connection_t
*conn
);
3155 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
3157 int is_or_protocol_version_known(uint16_t version
);
3159 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
3160 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
3161 var_cell_t
*var_cell_new(uint16_t payload_len
);
3162 void var_cell_free(var_cell_t
*cell
);
3164 /********************************* control.c ***************************/
3166 /** Used to indicate the type of a circuit event passed to the controller.
3167 * The various types are defined in control-spec.txt */
3168 typedef enum circuit_status_event_t
{
3169 CIRC_EVENT_LAUNCHED
= 0,
3170 CIRC_EVENT_BUILT
= 1,
3171 CIRC_EVENT_EXTENDED
= 2,
3172 CIRC_EVENT_FAILED
= 3,
3173 CIRC_EVENT_CLOSED
= 4,
3174 } circuit_status_event_t
;
3176 /** Used to indicate the type of a stream event passed to the controller.
3177 * The various types are defined in control-spec.txt */
3178 typedef enum stream_status_event_t
{
3179 STREAM_EVENT_SENT_CONNECT
= 0,
3180 STREAM_EVENT_SENT_RESOLVE
= 1,
3181 STREAM_EVENT_SUCCEEDED
= 2,
3182 STREAM_EVENT_FAILED
= 3,
3183 STREAM_EVENT_CLOSED
= 4,
3184 STREAM_EVENT_NEW
= 5,
3185 STREAM_EVENT_NEW_RESOLVE
= 6,
3186 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3187 STREAM_EVENT_REMAP
= 8
3188 } stream_status_event_t
;
3190 /** Used to indicate the type of an OR connection event passed to the
3191 * controller. The various types are defined in control-spec.txt */
3192 typedef enum or_conn_status_event_t
{
3193 OR_CONN_EVENT_LAUNCHED
= 0,
3194 OR_CONN_EVENT_CONNECTED
= 1,
3195 OR_CONN_EVENT_FAILED
= 2,
3196 OR_CONN_EVENT_CLOSED
= 3,
3197 OR_CONN_EVENT_NEW
= 4,
3198 } or_conn_status_event_t
;
3200 void control_update_global_event_mask(void);
3201 void control_adjust_event_log_severity(void);
3203 /** Execute the statement <b>stmt</b>, which may log events concerning the
3204 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3205 * being sent to controllers if <b>conn</b> is a control connection.
3207 * Stmt must not contain any return or goto statements.
3209 #define CONN_LOG_PROTECT(conn, stmt) \
3211 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3212 if (_log_conn_is_control) \
3213 disable_control_logging(); \
3214 STMT_BEGIN stmt; STMT_END; \
3215 if (_log_conn_is_control) \
3216 enable_control_logging(); \
3219 /** Log information about the connection <b>conn</b>, protecting it as with
3220 * CONN_LOG_PROTECT. Example:
3222 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3224 #define LOG_FN_CONN(conn, args) \
3225 CONN_LOG_PROTECT(conn, log_fn args)
3227 int connection_control_finished_flushing(control_connection_t
*conn
);
3228 int connection_control_reached_eof(control_connection_t
*conn
);
3229 int connection_control_process_inbuf(control_connection_t
*conn
);
3231 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3232 #define EVENT_NS 0x000F
3233 int control_event_is_interesting(int event
);
3235 int control_event_circuit_status(origin_circuit_t
*circ
,
3236 circuit_status_event_t e
, int reason
);
3237 int control_event_stream_status(edge_connection_t
*conn
,
3238 stream_status_event_t e
,
3240 int control_event_or_conn_status(or_connection_t
*conn
,
3241 or_conn_status_event_t e
, int reason
);
3242 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3243 int control_event_stream_bandwidth(edge_connection_t
*edge_conn
);
3244 int control_event_stream_bandwidth_used(void);
3245 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3246 int control_event_descriptors_changed(smartlist_t
*routers
);
3247 int control_event_address_mapped(const char *from
, const char *to
,
3248 time_t expires
, const char *error
);
3249 int control_event_or_authdir_new_descriptor(const char *action
,
3253 int control_event_my_descriptor_changed(void);
3254 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3255 int control_event_newconsensus(const networkstatus_t
*consensus
);
3256 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3257 int control_event_general_status(int severity
, const char *format
, ...)
3259 int control_event_client_status(int severity
, const char *format
, ...)
3261 int control_event_server_status(int severity
, const char *format
, ...)
3263 int control_event_guard(const char *nickname
, const char *digest
,
3264 const char *status
);
3266 int init_cookie_authentication(int enabled
);
3267 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3268 void disable_control_logging(void);
3269 void enable_control_logging(void);
3271 /** Enum describing various stages of bootstrapping, for use with controller
3272 * bootstrap status events. The values range from 0 to 100. */
3274 BOOTSTRAP_STATUS_UNDEF
=-1,
3275 BOOTSTRAP_STATUS_STARTING
=0,
3276 BOOTSTRAP_STATUS_CONN_DIR
=5,
3277 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3278 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3279 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3280 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3281 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3282 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3283 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3284 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3285 BOOTSTRAP_STATUS_CONN_OR
=80,
3286 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3287 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3288 BOOTSTRAP_STATUS_DONE
=100
3289 } bootstrap_status_t
;
3291 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3292 void control_event_bootstrap_problem(const char *warn
, int reason
);
3294 void control_event_clients_seen(const char *timestarted
,
3295 const char *countries
);
3297 #ifdef CONTROL_PRIVATE
3298 /* Used only by control.c and test.c */
3299 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3300 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3303 /********************************* cpuworker.c *****************************/
3305 void cpu_init(void);
3306 void cpuworkers_rotate(void);
3307 int connection_cpu_finished_flushing(connection_t
*conn
);
3308 int connection_cpu_reached_eof(connection_t
*conn
);
3309 int connection_cpu_process_inbuf(connection_t
*conn
);
3310 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3314 /********************************* directory.c ***************************/
3316 int directories_have_accepted_server_descriptor(void);
3317 char *authority_type_to_string(authority_type_t auth
);
3318 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3319 authority_type_t type
, const char *payload
,
3320 size_t payload_len
, size_t extrainfo_len
);
3321 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3322 const char *resource
,
3324 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3325 uint8_t router_purpose
,
3326 const char *resource
);
3327 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3328 uint8_t dir_purpose
,
3329 uint8_t router_purpose
,
3330 int anonymized_connection
,
3331 const char *resource
,
3332 const char *payload
,
3334 time_t if_modified_since
);
3335 void directory_initiate_command_routerstatus_rend(routerstatus_t
*status
,
3336 uint8_t dir_purpose
,
3337 uint8_t router_purpose
,
3338 int anonymized_connection
,
3339 const char *resource
,
3340 const char *payload
,
3342 time_t if_modified_since
,
3343 const rend_data_t
*rend_query
);
3345 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3346 compress_method_t
*compression
, char **response
);
3348 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3349 int connection_dir_reached_eof(dir_connection_t
*conn
);
3350 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3351 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3352 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3353 void connection_dir_request_failed(dir_connection_t
*conn
);
3354 void directory_initiate_command(const char *address
, const tor_addr_t
*addr
,
3355 uint16_t or_port
, uint16_t dir_port
,
3356 int supports_conditional_consensus
,
3357 int supports_begindir
, const char *digest
,
3358 uint8_t dir_purpose
, uint8_t router_purpose
,
3359 int anonymized_connection
,
3360 const char *resource
,
3361 const char *payload
, size_t payload_len
,
3362 time_t if_modified_since
);
3364 int dir_split_resource_into_fingerprints(const char *resource
,
3365 smartlist_t
*fp_out
, int *compresseed_out
,
3366 int decode_hex
, int sort_uniq
);
3367 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
3369 char first
[DIGEST_LEN
];
3370 char second
[DIGEST_LEN
];
3372 int dir_split_resource_into_fingerprint_pairs(const char *res
,
3373 smartlist_t
*pairs_out
);
3374 char *directory_dump_request_log(void);
3375 void note_request(const char *key
, size_t bytes
);
3376 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3378 time_t download_status_increment_failure(download_status_t
*dls
,
3379 int status_code
, const char *item
,
3380 int server
, time_t now
);
3381 /** Increment the failure count of the download_status_t <b>dls</b>, with
3382 * the optional status code <b>sc</b>. */
3383 #define download_status_failed(dls, sc) \
3384 download_status_increment_failure((dls), (sc), NULL, \
3385 get_options()->DirPort, time(NULL))
3387 void download_status_reset(download_status_t
*dls
);
3388 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3390 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3391 * ready to get its download reattempted. */
3393 download_status_is_ready(download_status_t
*dls
, time_t now
,
3396 return (dls
->n_download_failures
<= max_failures
3397 && dls
->next_attempt_at
<= now
);
3400 static void download_status_mark_impossible(download_status_t
*dl
);
3401 /** Mark <b>dl</b> as never downloadable. */
3403 download_status_mark_impossible(download_status_t
*dl
)
3405 dl
->n_download_failures
= IMPOSSIBLE_TO_DOWNLOAD
;
3408 /********************************* dirserv.c ***************************/
3409 /** Maximum length of an exit policy summary. */
3410 #define MAX_EXITPOLICY_SUMMARY_LEN (1000)
3412 /** Maximum allowable length of a version line in a networkstatus. */
3413 #define MAX_V_LINE_LEN 128
3414 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3415 * Running Stable Unnamed V2Dir Valid\n". */
3416 #define MAX_FLAG_LINE_LEN 96
3417 /** Length of "w" line for weighting. Currently at most
3418 * "w Bandwidth=<uint32t>\n" */
3419 #define MAX_WEIGHT_LINE_LEN (13+10)
3420 /** Maximum length of an exit policy summary line. */
3421 #define MAX_POLICY_LINE_LEN (3+MAX_EXITPOLICY_SUMMARY_LEN)
3422 /** Amount of space to allocate for each entry: r, s, and v lines. */
3423 #define RS_ENTRY_LEN \
3424 ( /* first line */ \
3425 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3426 5*2 /* ports */ + 10 /* punctuation */ + \
3428 MAX_FLAG_LINE_LEN + \
3430 MAX_WEIGHT_LINE_LEN + \
3432 MAX_POLICY_LINE_LEN + \
3436 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3438 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3440 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3441 int dirserv_load_fingerprint_file(void);
3442 void dirserv_free_fingerprint_list(void);
3443 const char *dirserv_get_nickname_by_digest(const char *digest
);
3444 enum was_router_added_t
dirserv_add_multiple_descriptors(
3445 const char *desc
, uint8_t purpose
,
3448 enum was_router_added_t
dirserv_add_descriptor(routerinfo_t
*ri
,
3450 const char *source
);
3451 int getinfo_helper_dirserv_unregistered(control_connection_t
*conn
,
3452 const char *question
, char **answer
);
3453 void dirserv_free_descriptors(void);
3454 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3455 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3456 int for_controller
);
3457 int dirserv_dump_directory_to_string(char **dir_out
,
3458 crypto_pk_env_t
*private_key
);
3460 int directory_fetches_from_authorities(or_options_t
*options
);
3461 int directory_fetches_dir_info_early(or_options_t
*options
);
3462 int directory_fetches_dir_info_later(or_options_t
*options
);
3463 int directory_caches_v2_dir_info(or_options_t
*options
);
3464 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3465 int directory_caches_dir_info(or_options_t
*options
);
3466 int directory_permits_begindir_requests(or_options_t
*options
);
3467 int directory_permits_controller_requests(or_options_t
*options
);
3468 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3470 void directory_set_dirty(void);
3471 cached_dir_t
*dirserv_get_directory(void);
3472 cached_dir_t
*dirserv_get_runningrouters(void);
3473 cached_dir_t
*dirserv_get_consensus(void);
3474 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3475 int is_running_routers
);
3476 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3477 const char *identity
,
3479 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
3481 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3482 void dirserv_clear_old_v1_info(time_t now
);
3483 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3484 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3486 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3488 int for_unencrypted_conn
,
3490 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3492 void dirserv_orconn_tls_done(const char *address
,
3494 const char *digest_rcvd
,
3496 void dirserv_test_reachability(time_t now
, int try_all
);
3497 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3499 int dirserv_would_reject_router(routerstatus_t
*rs
);
3500 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3501 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3502 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3504 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3505 routerstatus_t
*rs
, const char *platform
,
3506 int first_line_only
, int v2_format
);
3507 void dirserv_free_all(void);
3508 void cached_dir_decref(cached_dir_t
*d
);
3509 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3511 /********************************* dirvote.c ************************/
3513 /** Lowest allowable value for VoteSeconds. */
3514 #define MIN_VOTE_SECONDS 20
3515 /** Lowest allowable value for DistSeconds. */
3516 #define MIN_DIST_SECONDS 20
3517 /** Smallest allowable voting interval. */
3518 #define MIN_VOTE_INTERVAL 300
3520 void dirvote_free_all(void);
3522 /* vote manipulation */
3523 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3524 int total_authorities
,
3525 crypto_pk_env_t
*identity_key
,
3526 crypto_pk_env_t
*signing_key
,
3527 const char *legacy_identity_key_digest
,
3528 crypto_pk_env_t
*legacy_signing_key
);
3529 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3530 ns_detached_signatures_t
*sigs
,
3531 const char **msg_out
);
3532 char *networkstatus_get_detached_signatures(networkstatus_t
*consensus
);
3533 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3535 /* cert manipulation */
3536 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3538 /** Describes the schedule by which votes should be generated. */
3539 typedef struct vote_timing_t
{
3541 int n_intervals_valid
;
3545 /* vote scheduling */
3546 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3547 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3548 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3549 void dirvote_act(or_options_t
*options
, time_t now
);
3551 /* invoked on timers and by outside triggers. */
3552 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3553 const char **msg_out
,
3555 int dirvote_add_signatures(const char *detached_signatures_body
,
3557 const char **msg_out
);
3560 const char *dirvote_get_pending_consensus(void);
3561 const char *dirvote_get_pending_detached_signatures(void);
3563 #define DGV_INCLUDE_PENDING 2
3564 #define DGV_INCLUDE_PREVIOUS 4
3565 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3566 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3567 routerinfo_t
*ri
, time_t now
,
3568 int naming
, int exits_can_be_guards
,
3569 int listbadexits
, int listbaddirs
);
3570 void router_clear_status_flags(routerinfo_t
*ri
);
3572 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3573 authority_cert_t
*cert
);
3575 #ifdef DIRVOTE_PRIVATE
3577 format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3578 networkstatus_t
*v3_ns
);
3581 /********************************* dns.c ***************************/
3584 int has_dns_init_failed(void);
3585 void dns_free_all(void);
3586 uint32_t dns_clip_ttl(uint32_t ttl
);
3587 int dns_reset(void);
3588 void connection_dns_remove(edge_connection_t
*conn
);
3589 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3590 void assert_all_pending_dns_resolves_ok(void);
3591 void dns_cancel_pending_resolve(const char *question
);
3592 int dns_resolve(edge_connection_t
*exitconn
);
3593 void dns_launch_correctness_checks(void);
3594 int dns_seems_to_be_broken(void);
3595 void dns_reset_correctness_checks(void);
3596 void dump_dns_mem_usage(int severity
);
3598 /********************************* dnsserv.c ************************/
3600 void dnsserv_configure_listener(connection_t
*conn
);
3601 void dnsserv_close_listener(connection_t
*conn
);
3602 void dnsserv_resolved(edge_connection_t
*conn
,
3607 void dnsserv_reject_request(edge_connection_t
*conn
);
3608 int dnsserv_launch_request(const char *name
, int is_reverse
);
3610 /********************************* geoip.c **************************/
3612 /** Round all GeoIP results to the next multiple of this value, to avoid
3613 * leaking information. */
3614 #define DIR_RECORD_USAGE_GRANULARITY 8
3615 /** Time interval: Flush geoip data to disk this often. */
3616 #define DIR_RECORD_USAGE_RETAIN_IPS (24*60*60)
3617 /** How long do we have to have observed per-country request history before
3618 * we are willing to talk about it? */
3619 #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (24*60*60)
3621 /** Time interval: Flush geoip data to disk this often when measuring on an
3623 #define ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
3625 #ifdef GEOIP_PRIVATE
3626 int geoip_parse_entry(const char *line
);
3628 int should_record_bridge_info(or_options_t
*options
);
3629 int geoip_load_file(const char *filename
, or_options_t
*options
);
3630 int geoip_get_country_by_ip(uint32_t ipaddr
);
3631 int geoip_get_n_countries(void);
3632 const char *geoip_get_country_name(country_t num
);
3633 int geoip_is_loaded(void);
3634 country_t
geoip_get_country(const char *countrycode
);
3635 /** Indicates an action that we might be noting geoip statistics on.
3636 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3637 * the others, we're not.
3640 /** We've noticed a connection as a bridge relay or entry guard. */
3641 GEOIP_CLIENT_CONNECT
= 0,
3642 /** We've served a networkstatus consensus as a directory server. */
3643 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3644 /** We've served a v2 networkstatus consensus as a directory server. */
3645 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3646 } geoip_client_action_t
;
3647 void geoip_note_client_seen(geoip_client_action_t action
,
3648 uint32_t addr
, time_t now
);
3649 void geoip_remove_old_clients(time_t cutoff
);
3650 /** Indicates either a positive reply or a reason for rejectng a network
3651 * status request that will be included in geoip statistics. */
3653 /** Request is answered successfully. */
3655 /** V3 network status is not signed by a sufficient number of requested
3657 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
3658 /** Requested network status object is unavailable. */
3659 GEOIP_REJECT_UNAVAILABLE
= 2,
3660 /** Requested network status not found. */
3661 GEOIP_REJECT_NOT_FOUND
= 3,
3662 /** Network status has not been modified since If-Modified-Since time. */
3663 GEOIP_REJECT_NOT_MODIFIED
= 4,
3664 /** Directory is busy. */
3665 GEOIP_REJECT_BUSY
= 5,
3666 } geoip_ns_response_t
;
3667 #define GEOIP_NS_RESPONSE_NUM 6
3668 void geoip_note_ns_response(geoip_client_action_t action
,
3669 geoip_ns_response_t response
);
3670 time_t geoip_get_history_start(void);
3671 char *geoip_get_client_history(time_t now
, geoip_client_action_t action
);
3672 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
3673 int getinfo_helper_geoip(control_connection_t
*control_conn
,
3674 const char *question
, char **answer
);
3675 void geoip_free_all(void);
3677 /********************************* hibernate.c **********************/
3679 int accounting_parse_options(or_options_t
*options
, int validate_only
);
3680 int accounting_is_enabled(or_options_t
*options
);
3681 void configure_accounting(time_t now
);
3682 void accounting_run_housekeeping(time_t now
);
3683 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
3684 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
3685 void hibernate_begin_shutdown(void);
3686 int we_are_hibernating(void);
3687 void consider_hibernation(time_t now
);
3688 int getinfo_helper_accounting(control_connection_t
*conn
,
3689 const char *question
, char **answer
);
3690 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
3692 /********************************* main.c ***************************/
3694 extern int has_completed_circuit
;
3696 int connection_add(connection_t
*conn
);
3697 int connection_remove(connection_t
*conn
);
3698 void connection_unregister_events(connection_t
*conn
);
3699 int connection_in_array(connection_t
*conn
);
3700 void add_connection_to_closeable_list(connection_t
*conn
);
3701 int connection_is_on_closeable_list(connection_t
*conn
);
3703 smartlist_t
*get_connection_array(void);
3705 typedef enum watchable_events
{
3708 } watchable_events_t
;
3709 void connection_watch_events(connection_t
*conn
, watchable_events_t events
);
3710 int connection_is_reading(connection_t
*conn
);
3711 void connection_stop_reading(connection_t
*conn
);
3712 void connection_start_reading(connection_t
*conn
);
3714 int connection_is_writing(connection_t
*conn
);
3715 void connection_stop_writing(connection_t
*conn
);
3716 void connection_start_writing(connection_t
*conn
);
3718 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
3720 void directory_all_unreachable(time_t now
);
3721 void directory_info_has_arrived(time_t now
, int from_cache
);
3723 void ip_address_changed(int at_interface
);
3724 void dns_servers_relaunch_checks(void);
3726 void control_signal_act(int the_signal
);
3727 void handle_signals(int is_parent
);
3729 int try_locking(or_options_t
*options
, int err_if_locked
);
3730 int have_lockfile(void);
3731 void release_lockfile(void);
3733 void tor_cleanup(void);
3734 void tor_free_all(int postfork
);
3736 int tor_main(int argc
, char *argv
[]);
3739 int do_main_loop(void);
3740 int do_list_fingerprint(void);
3741 void do_hash_password(void);
3742 int tor_init(int argc
, char **argv
);
3745 /********************************* networkstatus.c *********************/
3747 /** How old do we allow a v2 network-status to get before removing it
3749 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
3751 /** Location where we found a v2 networkstatus. */
3753 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3754 } v2_networkstatus_source_t
;
3756 /** Possible statuses of a version of Tor, given opinions from the directory
3758 typedef enum version_status_t
{
3759 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3760 VS_OLD
=1, /**< This version is older than any recommended version. */
3761 VS_NEW
=2, /**< This version is newer than any recommended version. */
3762 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3763 * in its series, but later recommended versions exist.
3765 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
3766 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
3767 VS_UNKNOWN
, /**< We have no idea. */
3770 void networkstatus_reset_warnings(void);
3771 void networkstatus_reset_download_failures(void);
3772 int router_reload_v2_networkstatus(void);
3773 int router_reload_consensus_networkstatus(void);
3774 void routerstatus_free(routerstatus_t
*rs
);
3775 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
3776 void networkstatus_vote_free(networkstatus_t
*ns
);
3777 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
3778 networkstatus_t
*vote
,
3779 const char *identity
);
3780 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
3782 int networkstatus_check_voter_signature(networkstatus_t
*consensus
,
3783 networkstatus_voter_info_t
*voter
,
3784 authority_cert_t
*cert
);
3785 char *networkstatus_get_cache_filename(const char *identity_digest
);
3786 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
3787 v2_networkstatus_source_t source
,
3788 smartlist_t
*requested_fingerprints
);
3789 void networkstatus_v2_list_clean(time_t now
);
3790 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
3791 const char *digest
);
3792 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
3793 const char *digest
);
3794 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
3795 const char *digest
, int *found_out
);
3796 const smartlist_t
*networkstatus_get_v2_list(void);
3797 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
3798 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
3799 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
3800 const char *digest
);
3801 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
3802 int warn_if_unnamed
);
3803 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
3804 int networkstatus_nickname_is_unnamed(const char *nickname
);
3805 void networkstatus_consensus_download_failed(int status_code
);
3806 void update_consensus_networkstatus_fetch_time(time_t now
);
3807 int should_delay_dir_fetches(or_options_t
*options
);
3808 void update_networkstatus_downloads(time_t now
);
3809 void update_certificate_downloads(time_t now
);
3810 int consensus_is_waiting_for_certs(void);
3811 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
3812 networkstatus_t
*networkstatus_get_latest_consensus(void);
3813 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
3814 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
3815 #define NSSET_FROM_CACHE 1
3816 #define NSSET_WAS_WAITING_FOR_CERTS 2
3817 #define NSSET_DONT_DOWNLOAD_CERTS 4
3818 #define NSSET_ACCEPT_OBSOLETE 8
3819 int networkstatus_set_current_consensus(const char *consensus
, unsigned flags
);
3820 void networkstatus_note_certs_arrived(void);
3821 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
3822 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
3823 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
3824 int reset_failures
);
3825 void signed_descs_update_status_from_consensus_networkstatus(
3826 smartlist_t
*descs
);
3828 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
3829 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
3830 void networkstatus_dump_bridge_status_to_file(time_t now
);
3831 int getinfo_helper_networkstatus(control_connection_t
*conn
,
3832 const char *question
, char **answer
);
3833 void networkstatus_free_all(void);
3835 /********************************* ntmain.c ***************************/
3841 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
3842 int nt_service_is_stopping(void);
3843 void nt_service_set_state(DWORD state
);
3845 #define nt_service_is_stopping() (0)
3848 /********************************* onion.c ***************************/
3850 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
3851 or_circuit_t
*onion_next_task(char **onionskin_out
);
3852 void onion_pending_remove(or_circuit_t
*circ
);
3854 int onion_skin_create(crypto_pk_env_t
*router_key
,
3855 crypto_dh_env_t
**handshake_state_out
,
3856 char *onion_skin_out
);
3858 int onion_skin_server_handshake(const char *onion_skin
,
3859 crypto_pk_env_t
*private_key
,
3860 crypto_pk_env_t
*prev_private_key
,
3861 char *handshake_reply_out
,
3863 size_t key_out_len
);
3865 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
3866 const char *handshake_reply
,
3868 size_t key_out_len
);
3870 int fast_server_handshake(const char *key_in
,
3871 char *handshake_reply_out
,
3873 size_t key_out_len
);
3875 int fast_client_handshake(const char *handshake_state
,
3876 const char *handshake_reply_out
,
3878 size_t key_out_len
);
3880 void clear_pending_onions(void);
3882 /********************************* policies.c ************************/
3884 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
3887 #define POLICY_BUF_LEN 52
3889 /** Outcome of applying an address policy to an address. */
3891 /** The address was accepted */
3892 ADDR_POLICY_ACCEPTED
=0,
3893 /** The address was rejected */
3894 ADDR_POLICY_REJECTED
=-1,
3895 /** Part of the address was unknown, but as far as we can tell, it was
3897 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3898 /** Part of the address was unknown, but as far as we can tell, it was
3900 ADDR_POLICY_PROBABLY_REJECTED
=2
3901 } addr_policy_result_t
;
3903 int firewall_is_fascist_or(void);
3904 int fascist_firewall_allows_address_or(const tor_addr_t
*addr
, uint16_t port
);
3905 int fascist_firewall_allows_or(routerinfo_t
*ri
);
3906 int fascist_firewall_allows_address_dir(const tor_addr_t
*addr
, uint16_t port
);
3907 int dir_policy_permits_address(const tor_addr_t
*addr
);
3908 int socks_policy_permits_address(const tor_addr_t
*addr
);
3909 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
3910 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
3911 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
3912 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
3914 int validate_addr_policies(or_options_t
*options
, char **msg
);
3915 void policy_expand_private(smartlist_t
**policy
);
3916 int policies_parse_from_options(or_options_t
*options
);
3918 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
3919 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
3920 addr_policy_result_t
compare_tor_addr_to_addr_policy(const tor_addr_t
*addr
,
3921 uint16_t port
, const smartlist_t
*policy
);
3922 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
3923 uint16_t port
, const smartlist_t
*policy
);
3924 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
3925 int rejectprivate
, const char *local_address
);
3926 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
3927 int exit_policy_is_general_exit(smartlist_t
*policy
);
3928 int policy_is_reject_star(const smartlist_t
*policy
);
3929 int getinfo_helper_policies(control_connection_t
*conn
,
3930 const char *question
, char **answer
);
3931 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
,
3932 int format_for_desc
);
3934 void addr_policy_list_free(smartlist_t
*p
);
3935 void addr_policy_free(addr_policy_t
*p
);
3936 void policies_free_all(void);
3938 char *policy_summarize(smartlist_t
*policy
);
3940 /********************************* reasons.c ***************************/
3942 const char *stream_end_reason_to_control_string(int reason
);
3943 const char *stream_end_reason_to_string(int reason
);
3944 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
3945 uint8_t errno_to_stream_end_reason(int e
);
3947 const char *orconn_end_reason_to_control_string(int r
);
3948 int tls_error_to_orconn_end_reason(int e
);
3949 int errno_to_orconn_end_reason(int e
);
3951 const char *circuit_end_reason_to_control_string(int reason
);
3953 /********************************* relay.c ***************************/
3955 extern uint64_t stats_n_relay_cells_relayed
;
3956 extern uint64_t stats_n_relay_cells_delivered
;
3958 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
3959 cell_direction_t cell_direction
);
3961 void relay_header_pack(char *dest
, const relay_header_t
*src
);
3962 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
3963 int relay_send_command_from_edge(streamid_t stream_id
, circuit_t
*circ
,
3964 uint8_t relay_command
, const char *payload
,
3965 size_t payload_len
, crypt_path_t
*cpath_layer
);
3966 int connection_edge_send_command(edge_connection_t
*fromconn
,
3967 uint8_t relay_command
, const char *payload
,
3968 size_t payload_len
);
3969 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
3970 int package_partial
);
3971 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
3973 extern uint64_t stats_n_data_cells_packaged
;
3974 extern uint64_t stats_n_data_bytes_packaged
;
3975 extern uint64_t stats_n_data_cells_received
;
3976 extern uint64_t stats_n_data_bytes_received
;
3978 void init_cell_pool(void);
3979 void free_cell_pool(void);
3980 void clean_cell_pool(void);
3981 void dump_cell_pool_usage(int severity
);
3983 void cell_queue_clear(cell_queue_t
*queue
);
3984 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
3985 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
3987 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
3988 cell_t
*cell
, cell_direction_t direction
);
3989 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
3990 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
3991 int max
, time_t now
);
3992 void assert_active_circuits_ok(or_connection_t
*orconn
);
3993 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3994 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3996 int append_address_to_payload(char *payload_out
, const tor_addr_t
*addr
);
3997 const char *decode_address_from_payload(tor_addr_t
*addr_out
,
3998 const char *payload
,
4001 /********************************* rephist.c ***************************/
4003 void rep_hist_init(void);
4004 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
4005 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
4006 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
4007 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
4008 void rep_hist_note_extend_succeeded(const char *from_name
,
4009 const char *to_name
);
4010 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
4011 void rep_hist_dump_stats(time_t now
, int severity
);
4012 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
4013 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
4014 #ifdef ENABLE_EXIT_STATS
4015 void rep_hist_note_exit_bytes_read(uint16_t port
, size_t num_bytes
,
4017 void rep_hist_note_exit_bytes_written(uint16_t port
, size_t num_bytes
,
4019 void rep_hist_note_exit_stream_opened(uint16_t port
, time_t now
);
4021 #define rep_hist_note_exit_bytes_read(p,n,t) STMT_NIL
4022 #define rep_hist_note_exit_bytes_written(p,n,t) STMT_NIL
4023 #define rep_hist_note_exit_stream_opened(p,t) STMT_NIL
4025 int rep_hist_bandwidth_assess(void);
4026 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
4027 void rep_hist_update_state(or_state_t
*state
);
4028 int rep_hist_load_state(or_state_t
*state
, char **err
);
4029 void rep_history_clean(time_t before
);
4031 void rep_hist_note_router_reachable(const char *id
, time_t when
);
4032 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
4033 int rep_hist_record_mtbf_data(time_t now
, int missing_means_down
);
4034 int rep_hist_load_mtbf_data(time_t now
);
4036 time_t rep_hist_downrate_old_runs(time_t now
);
4037 double rep_hist_get_stability(const char *id
, time_t when
);
4038 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
4039 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
4040 int rep_hist_have_measured_enough_stability(void);
4041 const char *rep_hist_get_router_stability_doc(time_t now
);
4043 void rep_hist_note_used_port(time_t now
, uint16_t port
);
4044 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
4045 void rep_hist_note_used_resolve(time_t now
);
4046 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
4048 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
4049 int *need_capacity
);
4051 int any_predicted_circuits(time_t now
);
4052 int rep_hist_circbuilding_dormant(time_t now
);
4054 /** Possible public/private key operations in Tor: used to keep track of where
4055 * we're spending our time. */
4058 VERIFY_DIR
, VERIFY_RTR
,
4059 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4060 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4061 REND_CLIENT
, REND_MID
, REND_SERVER
,
4063 void note_crypto_pk_op(pk_op_t operation
);
4064 void dump_pk_ops(int severity
);
4066 void rep_hist_free_all(void);
4068 /* for hidden service usage statistics */
4069 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
4070 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
4071 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
4072 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
4073 void hs_usage_write_statistics_to_file(time_t now
);
4074 void hs_usage_free_all(void);
4076 #ifdef ENABLE_BUFFER_STATS
4077 #define DUMP_BUFFER_STATS_INTERVAL (24*60*60)
4078 void add_circ_to_buffer_stats(circuit_t
*circ
, time_t end_of_interval
);
4079 void dump_buffer_stats(void);
4082 /********************************* rendclient.c ***************************/
4084 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
4085 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
4086 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
4087 size_t request_len
);
4088 void rend_client_refetch_v2_renddesc(const rend_data_t
*rend_query
);
4089 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
4090 const rend_data_t
*rend_query
);
4091 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
4092 size_t request_len
);
4093 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
4094 size_t request_len
);
4095 void rend_client_desc_trynow(const char *query
);
4097 extend_info_t
*rend_client_get_random_intro(const rend_data_t
*rend_query
);
4099 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
4100 origin_circuit_t
*rendcirc
);
4101 int rend_parse_service_authorization(or_options_t
*options
,
4103 rend_service_authorization_t
*rend_client_lookup_service_authorization(
4104 const char *onion_address
);
4105 void rend_service_authorization_free_all(void);
4106 rend_data_t
*rend_data_dup(const rend_data_t
*request
);
4108 /********************************* rendcommon.c ***************************/
4110 /** Hidden-service side configuration of client authorization. */
4111 typedef struct rend_authorized_client_t
{
4113 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4114 crypto_pk_env_t
*client_key
;
4115 } rend_authorized_client_t
;
4117 /** ASCII-encoded v2 hidden service descriptor. */
4118 typedef struct rend_encoded_v2_service_descriptor_t
{
4119 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4120 char *desc_str
; /**< Descriptor string. */
4121 } rend_encoded_v2_service_descriptor_t
;
4123 /** Introduction point information. */
4124 typedef struct rend_intro_point_t
{
4125 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4126 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
4127 * key, if this descriptor is V2. */
4128 } rend_intro_point_t
;
4130 /** Information used to connect to a hidden service. */
4131 typedef struct rend_service_descriptor_t
{
4132 crypto_pk_env_t
*pk
; /**< This service's public key. */
4133 int version
; /**< Version of the descriptor format: 0 or 2. */
4134 time_t timestamp
; /**< Time when the descriptor was generated. */
4135 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
4136 * (We allow bits '0', '1', and '2' to be set.) */
4137 /** List of the service's introduction points. Elements are removed if
4138 * introduction attempts fail. */
4139 smartlist_t
*intro_nodes
;
4140 /** Has descriptor been uploaded to all hidden service directories? */
4141 int all_uploads_performed
;
4142 /** List of hidden service directories to which an upload request for
4143 * this descriptor could be sent. Smartlist exists only when at least one
4144 * of the previous upload requests failed (otherwise it's not important
4145 * to know which uploads succeeded and which not). */
4146 smartlist_t
*successful_uploads
;
4147 } rend_service_descriptor_t
;
4149 /** Free all storage associated with <b>data</b> */
4151 rend_data_free(rend_data_t
*data
)
4156 int rend_cmp_service_ids(const char *one
, const char *two
);
4158 void rend_process_relay_cell(circuit_t
*circ
, const crypt_path_t
*layer_hint
,
4159 int command
, size_t length
, const char *payload
);
4161 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
4162 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
4164 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
4165 void rend_encoded_v2_service_descriptor_free(
4166 rend_encoded_v2_service_descriptor_t
*desc
);
4167 void rend_intro_point_free(rend_intro_point_t
*intro
);
4169 /** A cached rendezvous descriptor. */
4170 typedef struct rend_cache_entry_t
{
4171 size_t len
; /**< Length of <b>desc</b> */
4172 time_t received
; /**< When was the descriptor received? */
4173 char *desc
; /**< Service descriptor */
4174 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
4175 } rend_cache_entry_t
;
4177 void rend_cache_init(void);
4178 void rend_cache_clean(void);
4179 void rend_cache_clean_v2_descs_as_dir(void);
4180 void rend_cache_free_all(void);
4181 int rend_valid_service_id(const char *query
);
4182 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
4184 int rend_cache_lookup_entry(const char *query
, int version
,
4185 rend_cache_entry_t
**entry_out
);
4186 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
4187 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
4188 int rend_cache_store_v2_desc_as_client(const char *desc
,
4189 const rend_data_t
*rend_query
);
4190 int rend_cache_store_v2_desc_as_dir(const char *desc
);
4191 int rend_cache_size(void);
4192 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
4193 rend_service_descriptor_t
*desc
, time_t now
,
4194 uint8_t period
, rend_auth_type_t auth_type
,
4195 crypto_pk_env_t
*client_key
,
4196 smartlist_t
*client_cookies
);
4197 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
4198 const char *descriptor_cookie
,
4199 time_t now
, uint8_t replica
);
4200 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
4201 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
4202 const char *service_id
,
4203 const char *secret_id_part
);
4205 /********************************* rendservice.c ***************************/
4207 int num_rend_services(void);
4208 int rend_config_services(or_options_t
*options
, int validate_only
);
4209 int rend_service_load_keys(void);
4210 void rend_services_init(void);
4211 void rend_services_introduce(void);
4212 void rend_consider_services_upload(time_t now
);
4213 void rend_hsdir_routers_changed(void);
4214 void rend_consider_descriptor_republication(void);
4216 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
4217 int rend_service_intro_established(origin_circuit_t
*circuit
,
4218 const char *request
,
4219 size_t request_len
);
4220 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
4221 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
4222 size_t request_len
);
4223 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
4224 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
4225 origin_circuit_t
*circ
);
4226 void rend_service_dump_stats(int severity
);
4227 void rend_service_free_all(void);
4229 /********************************* rendmid.c *******************************/
4230 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
4231 size_t request_len
);
4232 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
4233 size_t request_len
);
4234 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
4235 size_t request_len
);
4236 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
4237 size_t request_len
);
4239 /********************************* router.c ***************************/
4241 crypto_pk_env_t
*get_onion_key(void);
4242 time_t get_onion_key_set_at(void);
4243 void set_identity_key(crypto_pk_env_t
*k
);
4244 crypto_pk_env_t
*get_identity_key(void);
4245 int identity_key_is_set(void);
4246 authority_cert_t
*get_my_v3_authority_cert(void);
4247 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
4248 authority_cert_t
*get_my_v3_legacy_cert(void);
4249 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
4250 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
4251 void rotate_onion_key(void);
4252 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
4254 void v3_authority_check_key_expiry(void);
4256 int init_keys(void);
4258 int check_whether_orport_reachable(void);
4259 int check_whether_dirport_reachable(void);
4260 void consider_testing_reachability(int test_or
, int test_dir
);
4261 void router_orport_found_reachable(void);
4262 void router_dirport_found_reachable(void);
4263 void router_perform_bandwidth_test(int num_circs
, time_t now
);
4265 int authdir_mode(or_options_t
*options
);
4266 int authdir_mode_v1(or_options_t
*options
);
4267 int authdir_mode_v2(or_options_t
*options
);
4268 int authdir_mode_v3(or_options_t
*options
);
4269 int authdir_mode_any_main(or_options_t
*options
);
4270 int authdir_mode_any_nonhidserv(or_options_t
*options
);
4271 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
4272 int authdir_mode_publishes_statuses(or_options_t
*options
);
4273 int authdir_mode_tests_reachability(or_options_t
*options
);
4274 int authdir_mode_bridge(or_options_t
*options
);
4276 int clique_mode(or_options_t
*options
);
4277 int server_mode(or_options_t
*options
);
4278 int advertised_server_mode(void);
4279 int proxy_mode(or_options_t
*options
);
4280 void consider_publishable_server(int force
);
4282 int router_is_clique_mode(routerinfo_t
*router
);
4283 void router_upload_dir_desc_to_dirservers(int force
);
4284 void mark_my_descriptor_dirty_if_older_than(time_t when
);
4285 void mark_my_descriptor_dirty(void);
4286 void check_descriptor_bandwidth_changed(time_t now
);
4287 void check_descriptor_ipaddress_changed(time_t now
);
4288 void router_new_address_suggestion(const char *suggestion
,
4289 const dir_connection_t
*d_conn
);
4290 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
4291 routerinfo_t
*router_get_my_routerinfo(void);
4292 extrainfo_t
*router_get_my_extrainfo(void);
4293 const char *router_get_my_descriptor(void);
4294 int router_digest_is_me(const char *digest
);
4295 int router_extrainfo_digest_is_me(const char *digest
);
4296 int router_is_me(routerinfo_t
*router
);
4297 int router_fingerprint_is_me(const char *fp
);
4298 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
4299 int router_rebuild_descriptor(int force
);
4300 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
4301 crypto_pk_env_t
*ident_key
);
4302 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
4303 crypto_pk_env_t
*ident_key
);
4304 char *extrainfo_get_client_geoip_summary(time_t);
4305 int is_legal_nickname(const char *s
);
4306 int is_legal_nickname_or_hexdigest(const char *s
);
4307 int is_legal_hexdigest(const char *s
);
4308 void router_get_verbose_nickname(char *buf
, const routerinfo_t
*router
);
4309 void routerstatus_get_verbose_nickname(char *buf
,
4310 const routerstatus_t
*router
);
4311 void router_reset_warnings(void);
4312 void router_reset_reachability(void);
4313 void router_free_all(void);
4315 const char *router_purpose_to_string(uint8_t p
);
4316 uint8_t router_purpose_from_string(const char *s
);
4318 #ifdef ROUTER_PRIVATE
4319 /* Used only by router.c and test.c */
4320 void get_platform_str(char *platform
, size_t len
);
4323 /********************************* routerlist.c ***************************/
4325 /** Represents information about a single trusted directory server. */
4326 typedef struct trusted_dir_server_t
{
4329 char *address
; /**< Hostname. */
4330 uint32_t addr
; /**< IPv4 address. */
4331 uint16_t dir_port
; /**< Directory port. */
4332 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4333 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4334 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4335 * high-security) identity key. */
4337 unsigned int is_running
:1; /**< True iff we think this server is running. */
4339 /** True iff this server has accepted the most recent server descriptor
4340 * we tried to upload to it. */
4341 unsigned int has_accepted_serverdesc
:1;
4343 /** What kind of authority is this? (Bitfield.) */
4344 authority_type_t type
;
4346 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4347 * v2 network status. */
4348 time_t addr_current_at
; /**< When was the document that we derived the
4349 * address information from published? */
4351 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4352 * dir_server_t to directory_initiate_command_*
4353 * as a routerstatus_t. Not updated by the
4354 * router-status management code!
4356 } trusted_dir_server_t
;
4358 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
4360 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4362 int get_n_authorities(authority_type_t type
);
4363 int trusted_dirs_reload_certs(void);
4364 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
4366 void trusted_dirs_flush_certs_to_disk(void);
4367 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
4368 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
4369 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
4370 const char *sk_digest
);
4371 void authority_cert_get_all(smartlist_t
*certs_out
);
4372 void authority_cert_dl_failed(const char *id_digest
, int status
);
4373 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4374 int router_reload_router_list(void);
4375 smartlist_t
*router_get_trusted_dir_servers(void);
4377 /* Flags for pick_directory_server and pick_trusteddirserver. */
4378 /** Flag to indicate that we should not automatically be willing to use
4379 * ourself to answer a directory request.
4380 * Passed to router_pick_directory_server (et al).*/
4381 #define PDS_ALLOW_SELF (1<<0)
4382 /** Flag to indicate that if no servers seem to be up, we should mark all
4383 * directory servers as up and try again.
4384 * Passed to router_pick_directory_server (et al).*/
4385 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4386 /** Flag to indicate that we should not exclude directory servers that
4387 * our ReachableAddress settings would exclude. This usually means that
4388 * we're going to connect to the server over Tor, and so we don't need to
4389 * worry about our firewall telling us we can't.
4390 * Passed to router_pick_directory_server (et al).*/
4391 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4392 /** Flag to indicate that we should not use any directory authority to which
4393 * we have an existing directory connection for downloading server descriptors
4394 * or extrainfo documents.
4396 * Passed to router_pick_directory_server (et al)
4398 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
4399 * not pick_directory_server. If we make it work on pick_directory_server
4400 * too, we could conservatively make it only prevent multiple fetches to
4401 * the same authority, or we could aggressively make it prevent multiple
4402 * fetches to _any_ single directory server.]
4404 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4405 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4406 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4407 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4408 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4409 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4410 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4411 double *v3_share_out
);
4412 void router_reset_status_download_failures(void);
4413 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4414 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4415 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4416 int must_be_running
);
4417 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4418 routerinfo_t
*routerlist_find_my_routerinfo(void);
4419 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4421 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4422 int need_capacity
, int need_guard
);
4423 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4424 uint32_t router_get_advertised_bandwidth_capped(routerinfo_t
*router
);
4426 /** Possible ways to weight routers when choosing one randomly. See
4427 * routerlist_sl_choose_by_bandwidth() for more information.*/
4429 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4430 } bandwidth_weight_rule_t
;
4431 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4432 bandwidth_weight_rule_t rule
);
4433 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4435 /** Flags to be passed to control router_choose_random_node() to indicate what
4436 * kind of nodes to pick according to what algorithm. */
4438 CRN_NEED_UPTIME
= 1<<0,
4439 CRN_NEED_CAPACITY
= 1<<1,
4440 CRN_NEED_GUARD
= 1<<2,
4441 CRN_ALLOW_INVALID
= 1<<3,
4442 /* XXXX not used, apparently. */
4443 CRN_STRICT_PREFERRED
= 1<<4,
4444 /* XXXX not used, apparently. */
4445 CRN_WEIGHT_AS_EXIT
= 1<<5
4446 } router_crn_flags_t
;
4448 routerinfo_t
*router_choose_random_node(const char *preferred
,
4449 smartlist_t
*excludedsmartlist
,
4450 struct routerset_t
*excludedset
,
4451 router_crn_flags_t flags
);
4453 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4454 int warn_if_unnamed
);
4455 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4456 int router_digest_is_trusted_dir_type(const char *digest
,
4457 authority_type_t type
);
4458 #define router_digest_is_trusted_dir(d) \
4459 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4461 int router_addr_is_trusted_dir(uint32_t addr
);
4462 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4463 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4464 routerinfo_t
*router_get_by_digest(const char *digest
);
4465 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4466 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4467 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4468 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4469 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4470 routerlist_t
*router_get_routerlist(void);
4471 void routerinfo_free(routerinfo_t
*router
);
4472 void extrainfo_free(extrainfo_t
*extrainfo
);
4473 void routerlist_free(routerlist_t
*rl
);
4474 void dump_routerlist_mem_usage(int severity
);
4475 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
,
4477 void routerlist_free_all(void);
4478 void routerlist_reset_warnings(void);
4479 void router_set_status(const char *digest
, int up
);
4481 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
4482 typedef enum was_router_added_t
{
4483 ROUTER_ADDED_SUCCESSFULLY
= 1,
4484 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
4486 ROUTER_WAS_NOT_NEW
= -2,
4487 ROUTER_NOT_IN_CONSENSUS
= -3,
4488 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
4489 ROUTER_AUTHDIR_REJECTS
= -5,
4490 } was_router_added_t
;
4492 static int WRA_WAS_ADDED(was_router_added_t s
);
4493 static int WRA_WAS_OUTDATED(was_router_added_t s
);
4494 static int WRA_WAS_REJECTED(was_router_added_t s
);
4495 /** Return true iff the descriptor was added. It might still be necessary to
4496 * check whether the descriptor generator should be notified.
4499 WRA_WAS_ADDED(was_router_added_t s
) {
4500 return s
== ROUTER_ADDED_SUCCESSFULLY
|| s
== ROUTER_ADDED_NOTIFY_GENERATOR
;
4502 /** Return true iff the descriptor was not added because it was either:
4503 * - not in the consensus
4504 * - neither in the consensus nor in any networkstatus document
4505 * - it was outdated.
4507 static INLINE
int WRA_WAS_OUTDATED(was_router_added_t s
)
4509 return (s
== ROUTER_WAS_NOT_NEW
||
4510 s
== ROUTER_NOT_IN_CONSENSUS
||
4511 s
== ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
);
4513 /** Return true iff the descriptor rejected because it was malformed. */
4514 static INLINE
int WRA_WAS_REJECTED(was_router_added_t s
)
4516 return (s
== ROUTER_AUTHDIR_REJECTS
);
4518 was_router_added_t
router_add_to_routerlist(routerinfo_t
*router
,
4522 was_router_added_t
router_add_extrainfo_to_routerlist(
4523 extrainfo_t
*ei
, const char **msg
,
4524 int from_cache
, int from_fetch
);
4525 void routerlist_remove_old_routers(void);
4526 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4528 int router_load_routers_from_string(const char *s
, const char *eos
,
4529 saved_location_t saved_location
,
4530 smartlist_t
*requested_fingerprints
,
4531 int descriptor_digests
,
4532 const char *prepend_annotations
);
4533 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4534 saved_location_t saved_location
,
4535 smartlist_t
*requested_fingerprints
,
4536 int descriptor_digests
);
4537 void routerlist_retry_directory_downloads(time_t now
);
4538 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4540 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4541 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4542 const char *address
,
4543 uint16_t dir_port
, uint16_t or_port
,
4544 const char *digest
, const char *v3_auth_digest
,
4545 authority_type_t type
);
4546 void authority_cert_free(authority_cert_t
*cert
);
4547 void clear_trusted_dir_servers(void);
4548 int any_trusted_dir_is_v1_authority(void);
4549 void update_router_descriptor_downloads(time_t now
);
4550 void update_extrainfo_downloads(time_t now
);
4551 int router_have_minimum_dir_info(void);
4552 void router_dir_info_changed(void);
4553 const char *get_dir_info_status_string(void);
4554 int count_loading_descriptors_progress(void);
4555 void router_reset_descriptor_download_failures(void);
4556 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
4557 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
4558 signed_descriptor_t
*sd
,
4560 void routerlist_assert_ok(routerlist_t
*rl
);
4561 const char *esc_router_info(routerinfo_t
*router
);
4562 void routers_sort_by_identity(smartlist_t
*routers
);
4564 routerset_t
*routerset_new(void);
4565 int routerset_parse(routerset_t
*target
, const char *s
,
4566 const char *description
);
4567 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
4568 int routerset_is_list(const routerset_t
*set
);
4569 int routerset_needs_geoip(const routerset_t
*set
);
4570 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
4571 int routerset_contains_routerstatus(const routerset_t
*set
,
4572 routerstatus_t
*rs
);
4573 int routerset_contains_extendinfo(const routerset_t
*set
,
4574 const extend_info_t
*ei
);
4575 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
4577 void routersets_get_disjunction(smartlist_t
*target
, const smartlist_t
*source
,
4578 const routerset_t
*include
,
4579 const routerset_t
*exclude
, int running_only
);
4580 void routerset_subtract_routers(smartlist_t
*out
,
4581 const routerset_t
*routerset
);
4582 char *routerset_to_string(const routerset_t
*routerset
);
4583 void routerset_refresh_countries(routerset_t
*target
);
4584 int routerset_equal(const routerset_t
*old
, const routerset_t
*new);
4585 void routerset_free(routerset_t
*routerset
);
4586 void routerinfo_set_country(routerinfo_t
*ri
);
4587 void routerlist_refresh_countries(void);
4588 void refresh_all_country_info(void);
4590 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
4592 int hid_serv_acting_as_directory(void);
4593 int hid_serv_responsible_for_desc_id(const char *id
);
4595 /********************************* routerparse.c ************************/
4597 #define MAX_STATUS_TAG_LEN 32
4598 /** Structure to hold parsed Tor versions. This is a little messier
4599 * than we would like it to be, because we changed version schemes with 0.1.0.
4601 * See version-spec.txt for the whole business.
4603 typedef struct tor_version_t
{
4607 /** Release status. For version in the post-0.1 format, this is always
4609 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4611 char status_tag
[MAX_STATUS_TAG_LEN
];
4615 int router_get_router_hash(const char *s
, char *digest
);
4616 int router_get_dir_hash(const char *s
, char *digest
);
4617 int router_get_runningrouters_hash(const char *s
, char *digest
);
4618 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
4619 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
4620 int router_get_extrainfo_hash(const char *s
, char *digest
);
4621 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
4623 crypto_pk_env_t
*private_key
);
4624 int router_parse_list_from_string(const char **s
, const char *eos
,
4626 saved_location_t saved_location
,
4628 int allow_annotations
,
4629 const char *prepend_annotations
);
4630 int router_parse_routerlist_from_directory(const char *s
,
4631 routerlist_t
**dest
,
4632 crypto_pk_env_t
*pkey
,
4634 int write_to_cache
);
4635 int router_parse_runningrouters(const char *str
);
4636 int router_parse_directory(const char *str
);
4637 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
4639 int allow_annotations
,
4640 const char *prepend_annotations
);
4641 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
4642 int cache_copy
, struct digest_ri_map_t
*routermap
);
4643 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
4645 version_status_t
tor_version_is_obsolete(const char *myversion
,
4646 const char *versionlist
);
4647 int tor_version_parse(const char *s
, tor_version_t
*out
);
4648 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
4649 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
4650 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
4651 void assert_addr_policy_ok(smartlist_t
*t
);
4652 void dump_distinct_digest_count(int severity
);
4654 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
4655 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
4656 const char **eos_out
,
4657 networkstatus_type_t ns_type
);
4658 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
4659 const char *s
, const char *eos
);
4661 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
4662 const char **end_of_string
);
4663 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
4665 char **intro_points_encrypted_out
,
4666 size_t *intro_points_encrypted_size_out
,
4667 size_t *encoded_size_out
,
4668 const char **next_out
, const char *desc
);
4669 int rend_decrypt_introduction_points(char **ipos_decrypted
,
4670 size_t *ipos_decrypted_size
,
4671 const char *descriptor_cookie
,
4672 const char *ipos_encrypted
,
4673 size_t ipos_encrypted_size
);
4674 int rend_parse_introduction_points(rend_service_descriptor_t
*parsed
,
4675 const char *intro_points_encoded
,
4676 size_t intro_points_encoded_size
);
4677 int rend_parse_client_keys(strmap_t
*parsed_clients
, const char *str
);