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-2010, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Master header file for Tor-specific functionality.
18 /* If we're building for a static analysis, turn on all the off-by-default
20 #ifndef INSTRUMENT_DOWNLOADS
21 #define INSTRUMENT_DOWNLOADS 1
26 #define WIN32_WINNT 0x400
27 #define _WIN32_WINNT 0x400
28 #define WIN32_LEAN_AND_MEAN
40 #ifdef HAVE_SYS_PARAM_H
41 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
44 #ifdef HAVE_SYS_WAIT_H
47 #ifdef HAVE_SYS_FCNTL_H
48 #include <sys/fcntl.h>
53 #ifdef HAVE_SYS_IOCTL_H
54 #include <sys/ioctl.h>
59 #ifdef HAVE_SYS_STAT_H
62 #ifdef HAVE_ARPA_INET_H
63 #include <arpa/inet.h>
80 #define snprintf _snprintf
84 #include "../common/torlog.h"
85 #include "container.h"
88 #include "compat_libevent.h"
91 /* These signals are defined to help control_signal_act work.
108 /* Controller signals start at a high number so we don't
109 * conflict with system-defined signals. */
110 #define SIGNEWNYM 129
111 #define SIGCLEARDNSCACHE 130
113 #if (SIZEOF_CELL_T != 0)
114 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
115 * that our stuff always calls cell_t something different. */
116 #define cell_t tor_cell_t
119 /** Length of longest allowable configured nickname. */
120 #define MAX_NICKNAME_LEN 19
121 /** Length of a router identity encoded as a hexadecimal digest, plus
122 * possible dollar sign. */
123 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
124 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
125 * equal sign or tilde, nickname. */
126 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
128 /** Maximum size, in bytes, for resized buffers. */
129 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
130 /** Maximum size, in bytes, for any directory object that we've downloaded. */
131 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
133 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
134 * of an HTTP request or response. */
135 #define MAX_HEADERS_SIZE 50000
136 /** Maximum size, in bytes, for any directory object that we're accepting
138 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
140 /** Maximum size, in bytes, of a single router descriptor uploaded to us
141 * as a directory authority. Caches and clients fetch whatever descriptors
142 * the authorities tell them to fetch, and don't care about size. */
143 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
145 /** Maximum size of a single extrainfo document, as above. */
146 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
148 /** How long do we keep DNS cache entries before purging them (regardless of
150 #define MAX_DNS_ENTRY_AGE (30*60)
151 /** How long do we cache/tell clients to cache DNS records when no TTL is
153 #define DEFAULT_DNS_TTL (30*60)
154 /** How long can a TTL be before we stop believing it? */
155 #define MAX_DNS_TTL (3*60*60)
156 /** How small can a TTL be before we stop believing it? Provides rudimentary
158 #define MIN_DNS_TTL 60
160 /** How often do we rotate onion keys? */
161 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
162 /** How often do we rotate TLS contexts? */
163 #define MAX_SSL_KEY_LIFETIME (2*60*60)
165 /** How old do we allow a router to get before removing it
166 * from the router list? In seconds. */
167 #define ROUTER_MAX_AGE (60*60*48)
168 /** How old can a router get before we (as a server) will no longer
169 * consider it live? In seconds. */
170 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
171 /** How old do we let a saved descriptor get before force-removing it? */
172 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
174 /** Possible rules for generating circuit IDs on an OR connection. */
176 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
177 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
178 /** The other side of a connection is an OP: never create circuits to it,
179 * and let it use any circuit ID it wants. */
180 CIRC_ID_TYPE_NEITHER
=2
183 #define _CONN_TYPE_MIN 3
184 /** Type for sockets listening for OR connections. */
185 #define CONN_TYPE_OR_LISTENER 3
186 /** A bidirectional TLS connection transmitting a sequence of cells.
187 * May be from an OR to an OR, or from an OP to an OR. */
188 #define CONN_TYPE_OR 4
189 /** A TCP connection from an onion router to a stream's destination. */
190 #define CONN_TYPE_EXIT 5
191 /** Type for sockets listening for SOCKS connections. */
192 #define CONN_TYPE_AP_LISTENER 6
193 /** A SOCKS proxy connection from the user application to the onion
195 #define CONN_TYPE_AP 7
196 /** Type for sockets listening for HTTP connections to the directory server. */
197 #define CONN_TYPE_DIR_LISTENER 8
198 /** Type for HTTP connections to the directory server. */
199 #define CONN_TYPE_DIR 9
200 /** Connection from the main process to a CPU worker process. */
201 #define CONN_TYPE_CPUWORKER 10
202 /** Type for listening for connections from user interface process. */
203 #define CONN_TYPE_CONTROL_LISTENER 11
204 /** Type for connections from user interface process. */
205 #define CONN_TYPE_CONTROL 12
206 /** Type for sockets listening for transparent connections redirected by pf or
208 #define CONN_TYPE_AP_TRANS_LISTENER 13
209 /** Type for sockets listening for transparent connections redirected by
211 #define CONN_TYPE_AP_NATD_LISTENER 14
212 /** Type for sockets listening for DNS requests. */
213 #define CONN_TYPE_AP_DNS_LISTENER 15
214 #define _CONN_TYPE_MAX 15
215 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
218 /* Proxy client types */
220 #define PROXY_CONNECT 1
221 #define PROXY_SOCKS4 2
222 #define PROXY_SOCKS5 3
224 /* Proxy client handshake states */
225 #define PROXY_HTTPS_WANT_CONNECT_OK 1
226 #define PROXY_SOCKS4_WANT_CONNECT_OK 2
227 #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 3
228 #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 4
229 #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 5
230 #define PROXY_SOCKS5_WANT_CONNECT_OK 6
231 #define PROXY_CONNECTED 7
233 /** True iff <b>x</b> is an edge connection. */
234 #define CONN_IS_EDGE(x) \
235 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
237 /** State for any listener connection. */
238 #define LISTENER_STATE_READY 0
240 #define _CPUWORKER_STATE_MIN 1
241 /** State for a connection to a cpuworker process that's idle. */
242 #define CPUWORKER_STATE_IDLE 1
243 /** State for a connection to a cpuworker process that's processing a
245 #define CPUWORKER_STATE_BUSY_ONION 2
246 #define _CPUWORKER_STATE_MAX 2
248 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
250 #define _OR_CONN_STATE_MIN 1
251 /** State for a connection to an OR: waiting for connect() to finish. */
252 #define OR_CONN_STATE_CONNECTING 1
253 /** State for a connection to an OR: waiting for proxy handshake to complete */
254 #define OR_CONN_STATE_PROXY_HANDSHAKING 2
255 /** State for a connection to an OR or client: SSL is handshaking, not done
257 #define OR_CONN_STATE_TLS_HANDSHAKING 3
258 /** State for a connection to an OR: We're doing a second SSL handshake for
259 * renegotiation purposes. */
260 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
261 /** State for a connection at an OR: We're waiting for the client to
263 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
264 /** State for a connection to an OR: We're done with our SSL handshake, but we
265 * haven't yet negotiated link protocol versions and sent a netinfo cell.
267 #define OR_CONN_STATE_OR_HANDSHAKING 6
268 /** State for a connection to an OR: Ready to send/receive cells. */
269 #define OR_CONN_STATE_OPEN 7
270 #define _OR_CONN_STATE_MAX 7
272 #define _EXIT_CONN_STATE_MIN 1
273 /** State for an exit connection: waiting for response from DNS farm. */
274 #define EXIT_CONN_STATE_RESOLVING 1
275 /** State for an exit connection: waiting for connect() to finish. */
276 #define EXIT_CONN_STATE_CONNECTING 2
277 /** State for an exit connection: open and ready to transmit data. */
278 #define EXIT_CONN_STATE_OPEN 3
279 /** State for an exit connection: waiting to be removed. */
280 #define EXIT_CONN_STATE_RESOLVEFAILED 4
281 #define _EXIT_CONN_STATE_MAX 4
283 /* The AP state values must be disjoint from the EXIT state values. */
284 #define _AP_CONN_STATE_MIN 5
285 /** State for a SOCKS connection: waiting for SOCKS request. */
286 #define AP_CONN_STATE_SOCKS_WAIT 5
287 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
288 * rendezvous descriptor. */
289 #define AP_CONN_STATE_RENDDESC_WAIT 6
290 /** The controller will attach this connection to a circuit; it isn't our
292 #define AP_CONN_STATE_CONTROLLER_WAIT 7
293 /** State for a SOCKS connection: waiting for a completed circuit. */
294 #define AP_CONN_STATE_CIRCUIT_WAIT 8
295 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
296 #define AP_CONN_STATE_CONNECT_WAIT 9
297 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
298 #define AP_CONN_STATE_RESOLVE_WAIT 10
299 /** State for a SOCKS connection: ready to send and receive. */
300 #define AP_CONN_STATE_OPEN 11
301 /** State for a transparent natd connection: waiting for original
303 #define AP_CONN_STATE_NATD_WAIT 12
304 #define _AP_CONN_STATE_MAX 12
306 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
307 * edge connection is not attached to any circuit. */
308 #define AP_CONN_STATE_IS_UNATTACHED(s) \
309 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
311 #define _DIR_CONN_STATE_MIN 1
312 /** State for connection to directory server: waiting for connect(). */
313 #define DIR_CONN_STATE_CONNECTING 1
314 /** State for connection to directory server: sending HTTP request. */
315 #define DIR_CONN_STATE_CLIENT_SENDING 2
316 /** State for connection to directory server: reading HTTP response. */
317 #define DIR_CONN_STATE_CLIENT_READING 3
318 /** State for connection to directory server: happy and finished. */
319 #define DIR_CONN_STATE_CLIENT_FINISHED 4
320 /** State for connection at directory server: waiting for HTTP request. */
321 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
322 /** State for connection at directory server: sending HTTP response. */
323 #define DIR_CONN_STATE_SERVER_WRITING 6
324 #define _DIR_CONN_STATE_MAX 6
326 /** True iff the purpose of <b>conn</b> means that it's a server-side
327 * directory connection. */
328 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
330 #define _CONTROL_CONN_STATE_MIN 1
331 /** State for a control connection: Authenticated and accepting v1 commands. */
332 #define CONTROL_CONN_STATE_OPEN 1
333 /** State for a control connection: Waiting for authentication; speaking
335 #define CONTROL_CONN_STATE_NEEDAUTH 2
336 #define _CONTROL_CONN_STATE_MAX 2
338 #define _DIR_PURPOSE_MIN 3
339 /** A connection to a directory server: download a rendezvous
341 #define DIR_PURPOSE_FETCH_RENDDESC 3
342 /** A connection to a directory server: set after a rendezvous
343 * descriptor is downloaded. */
344 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
345 /** A connection to a directory server: download one or more v2
346 * network-status objects */
347 #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
348 /** A connection to a directory server: download one or more server
350 #define DIR_PURPOSE_FETCH_SERVERDESC 6
351 /** A connection to a directory server: download one or more extra-info
353 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
354 /** A connection to a directory server: upload a server descriptor. */
355 #define DIR_PURPOSE_UPLOAD_DIR 8
356 /** A connection to a directory server: upload a rendezvous
358 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
359 /** A connection to a directory server: upload a v3 networkstatus vote. */
360 #define DIR_PURPOSE_UPLOAD_VOTE 10
361 /** A connection to a directory server: upload a v3 consensus signature */
362 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
363 /** A connection to a directory server: download one or more v3 networkstatus
365 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
366 /** A connection to a directory server: download a v3 detached signatures
367 * object for a consensus. */
368 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
369 /** A connection to a directory server: download a v3 networkstatus
371 #define DIR_PURPOSE_FETCH_CONSENSUS 14
372 /** A connection to a directory server: download one or more directory
373 * authority certificates. */
374 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
376 /** Purpose for connection at a directory server. */
377 #define DIR_PURPOSE_SERVER 16
378 /** A connection to a hidden service directory server: upload a v2 rendezvous
380 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
381 /** A connection to a hidden service directory server: download a v2 rendezvous
383 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
384 #define _DIR_PURPOSE_MAX 18
386 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
387 * directory server. */
388 #define DIR_PURPOSE_IS_UPLOAD(p) \
389 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
390 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
391 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
392 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
394 #define _EXIT_PURPOSE_MIN 1
395 /** This exit stream wants to do an ordinary connect. */
396 #define EXIT_PURPOSE_CONNECT 1
397 /** This exit stream wants to do a resolve (either normal or reverse). */
398 #define EXIT_PURPOSE_RESOLVE 2
399 #define _EXIT_PURPOSE_MAX 2
401 /* !!!! If any connection purpose is ever over 31, we must grow the type
402 * field in connection_t. */
404 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
405 #define CIRCUIT_STATE_BUILDING 0
406 /** Circuit state: Waiting to process the onionskin. */
407 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
408 /** Circuit state: I'd like to deliver a create, but my n_conn is still
410 #define CIRCUIT_STATE_OR_WAIT 2
411 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
412 #define CIRCUIT_STATE_OPEN 3
414 #define _CIRCUIT_PURPOSE_MIN 1
416 /* these circuits were initiated elsewhere */
417 #define _CIRCUIT_PURPOSE_OR_MIN 1
418 /** OR-side circuit purpose: normal circuit, at OR. */
419 #define CIRCUIT_PURPOSE_OR 1
420 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
421 #define CIRCUIT_PURPOSE_INTRO_POINT 2
422 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
423 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
424 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
425 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
426 #define _CIRCUIT_PURPOSE_OR_MAX 4
428 /* these circuits originate at this node */
430 /* here's how circ client-side purposes work:
431 * normal circuits are C_GENERAL.
432 * circuits that are c_introducing are either on their way to
433 * becoming open, or they are open and waiting for a
434 * suitable rendcirc before they send the intro.
435 * circuits that are c_introduce_ack_wait have sent the intro,
436 * but haven't gotten a response yet.
437 * circuits that are c_establish_rend are either on their way
438 * to becoming open, or they are open and have sent the
439 * establish_rendezvous cell but haven't received an ack.
440 * circuits that are c_rend_ready are open and have received a
441 * rend ack, but haven't heard from bob yet. if they have a
442 * buildstate->pending_final_cpath then they're expecting a
443 * cell from bob, else they're not.
444 * circuits that are c_rend_ready_intro_acked are open, and
445 * some intro circ has sent its intro and received an ack.
446 * circuits that are c_rend_joined are open, have heard from
447 * bob, and are talking to him.
449 /** Client-side circuit purpose: Normal circuit, with cpath. */
450 #define CIRCUIT_PURPOSE_C_GENERAL 5
451 /** Client-side circuit purpose: at Alice, connecting to intro point. */
452 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
453 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
454 * waiting for ACK/NAK. */
455 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
456 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
457 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
458 /** Client-side circuit purpose: at Alice, waiting for ack. */
459 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
460 /** Client-side circuit purpose: at Alice, waiting for Bob. */
461 #define CIRCUIT_PURPOSE_C_REND_READY 10
462 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
463 * has been acknowledged. */
464 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
465 /** Client-side circuit purpose: at Alice, rendezvous established. */
466 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
467 /** This circuit is used for build time measurement only */
468 #define CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT 13
469 #define _CIRCUIT_PURPOSE_C_MAX 13
470 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
471 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 14
472 /** Hidden-service-side circuit purpose: at Bob, successfully established
474 #define CIRCUIT_PURPOSE_S_INTRO 15
475 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
476 #define CIRCUIT_PURPOSE_S_CONNECT_REND 16
477 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
478 #define CIRCUIT_PURPOSE_S_REND_JOINED 17
479 /** A testing circuit; not meant to be used for actual traffic. */
480 #define CIRCUIT_PURPOSE_TESTING 18
481 /** A controller made this circuit and Tor should not use it. */
482 #define CIRCUIT_PURPOSE_CONTROLLER 19
483 #define _CIRCUIT_PURPOSE_MAX 19
484 /** A catch-all for unrecognized purposes. Currently we don't expect
485 * to make or see any circuits with this purpose. */
486 #define CIRCUIT_PURPOSE_UNKNOWN 255
488 /** True iff the circuit purpose <b>p</b> is for a circuit that
489 * originated at this node. */
490 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
491 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
492 * here to serve as a client. (Hidden services don't count here.) */
493 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
494 ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
495 (p)<=_CIRCUIT_PURPOSE_C_MAX)
496 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
497 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
498 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
500 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
501 ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
502 (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
504 /** How many circuits do we want simultaneously in-progress to handle
506 #define MIN_CIRCUITS_HANDLING_STREAM 2
508 /* These RELAY_COMMAND constants define values for relay cell commands, and
509 * must match those defined in tor-spec.txt. */
510 #define RELAY_COMMAND_BEGIN 1
511 #define RELAY_COMMAND_DATA 2
512 #define RELAY_COMMAND_END 3
513 #define RELAY_COMMAND_CONNECTED 4
514 #define RELAY_COMMAND_SENDME 5
515 #define RELAY_COMMAND_EXTEND 6
516 #define RELAY_COMMAND_EXTENDED 7
517 #define RELAY_COMMAND_TRUNCATE 8
518 #define RELAY_COMMAND_TRUNCATED 9
519 #define RELAY_COMMAND_DROP 10
520 #define RELAY_COMMAND_RESOLVE 11
521 #define RELAY_COMMAND_RESOLVED 12
522 #define RELAY_COMMAND_BEGIN_DIR 13
524 #define RELAY_COMMAND_ESTABLISH_INTRO 32
525 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
526 #define RELAY_COMMAND_INTRODUCE1 34
527 #define RELAY_COMMAND_INTRODUCE2 35
528 #define RELAY_COMMAND_RENDEZVOUS1 36
529 #define RELAY_COMMAND_RENDEZVOUS2 37
530 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
531 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
532 #define RELAY_COMMAND_INTRODUCE_ACK 40
534 /* Reasons why an OR connection is closed. */
535 #define END_OR_CONN_REASON_DONE 1
536 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
537 #define END_OR_CONN_REASON_OR_IDENTITY 3
538 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
539 #define END_OR_CONN_REASON_TIMEOUT 5
540 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
541 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
542 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
543 #define END_OR_CONN_REASON_MISC 9
545 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
546 * documentation of these. The values must match. */
547 #define END_STREAM_REASON_MISC 1
548 #define END_STREAM_REASON_RESOLVEFAILED 2
549 #define END_STREAM_REASON_CONNECTREFUSED 3
550 #define END_STREAM_REASON_EXITPOLICY 4
551 #define END_STREAM_REASON_DESTROY 5
552 #define END_STREAM_REASON_DONE 6
553 #define END_STREAM_REASON_TIMEOUT 7
554 /* 8 is unallocated for historical reasons. */
555 #define END_STREAM_REASON_HIBERNATING 9
556 #define END_STREAM_REASON_INTERNAL 10
557 #define END_STREAM_REASON_RESOURCELIMIT 11
558 #define END_STREAM_REASON_CONNRESET 12
559 #define END_STREAM_REASON_TORPROTOCOL 13
560 #define END_STREAM_REASON_NOTDIRECTORY 14
561 #define END_STREAM_REASON_ENTRYPOLICY 15
563 /* These high-numbered end reasons are not part of the official spec,
564 * and are not intended to be put in relay end cells. They are here
565 * to be more informative when sending back socks replies to the
567 /* XXXX 256 is no longer used; feel free to reuse it. */
568 /** We were unable to attach the connection to any circuit at all. */
569 /* XXXX the ways we use this one don't make a lot of sense. */
570 #define END_STREAM_REASON_CANT_ATTACH 257
571 /** We can't connect to any directories at all, so we killed our streams
572 * before they can time out. */
573 #define END_STREAM_REASON_NET_UNREACHABLE 258
574 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
575 * protocol in a way we couldn't handle. */
576 #define END_STREAM_REASON_SOCKSPROTOCOL 259
577 /** This is a transparent proxy connection, but we can't extract the original
578 * target address:port. */
579 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
580 /** This is a connection on the NATD port, and the destination IP:Port was
581 * either ill-formed or out-of-range. */
582 #define END_STREAM_REASON_INVALID_NATD_DEST 261
584 /** Bitwise-and this value with endreason to mask out all flags. */
585 #define END_STREAM_REASON_MASK 511
587 /** Bitwise-or this with the argument to control_event_stream_status
588 * to indicate that the reason came from an END cell. */
589 #define END_STREAM_REASON_FLAG_REMOTE 512
590 /** Bitwise-or this with the argument to control_event_stream_status
591 * to indicate that we already sent a CLOSED stream event. */
592 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
593 /** Bitwise-or this with endreason to indicate that we already sent
594 * a socks reply, and no further reply needs to be sent from
595 * connection_mark_unattached_ap(). */
596 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
598 /** Reason for remapping an AP connection's address: we have a cached
600 #define REMAP_STREAM_SOURCE_CACHE 1
601 /** Reason for remapping an AP connection's address: the exit node told us an
603 #define REMAP_STREAM_SOURCE_EXIT 2
605 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
606 #define RESOLVED_TYPE_HOSTNAME 0
607 #define RESOLVED_TYPE_IPV4 4
608 #define RESOLVED_TYPE_IPV6 6
609 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
610 #define RESOLVED_TYPE_ERROR 0xF1
612 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
613 * call; they only go to the controller for tracking */
614 /** We couldn't build a path for this circuit. */
615 #define END_CIRC_REASON_NOPATH -2
616 /** Catch-all "other" reason for closing origin circuits. */
617 #define END_CIRC_AT_ORIGIN -1
619 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
620 * documentation of these. */
621 #define _END_CIRC_REASON_MIN 0
622 #define END_CIRC_REASON_NONE 0
623 #define END_CIRC_REASON_TORPROTOCOL 1
624 #define END_CIRC_REASON_INTERNAL 2
625 #define END_CIRC_REASON_REQUESTED 3
626 #define END_CIRC_REASON_HIBERNATING 4
627 #define END_CIRC_REASON_RESOURCELIMIT 5
628 #define END_CIRC_REASON_CONNECTFAILED 6
629 #define END_CIRC_REASON_OR_IDENTITY 7
630 #define END_CIRC_REASON_OR_CONN_CLOSED 8
631 #define END_CIRC_REASON_FINISHED 9
632 #define END_CIRC_REASON_TIMEOUT 10
633 #define END_CIRC_REASON_DESTROYED 11
634 #define END_CIRC_REASON_NOSUCHSERVICE 12
635 #define _END_CIRC_REASON_MAX 12
637 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
638 * control_event_circuit_status() to indicate that the reason was
639 * passed through from a destroy or truncate cell. */
640 #define END_CIRC_REASON_FLAG_REMOTE 512
642 /** Length of 'y' portion of 'y.onion' URL. */
643 #define REND_SERVICE_ID_LEN_BASE32 16
645 /** Length of 'y.onion' including '.onion' URL. */
646 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
648 /** Length of a binary-encoded rendezvous service ID. */
649 #define REND_SERVICE_ID_LEN 10
651 /** Time period for which a v2 descriptor will be valid. */
652 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
654 /** Time period within which two sets of v2 descriptors will be uploaded in
656 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
658 /** Number of non-consecutive replicas (i.e. distributed somewhere
659 * in the ring) for a descriptor. */
660 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
662 /** Number of consecutive replicas for a descriptor. */
663 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
665 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
666 #define REND_DESC_ID_V2_LEN_BASE32 32
668 /** Length of the base32-encoded secret ID part of versioned hidden service
670 #define REND_SECRET_ID_PART_LEN_BASE32 32
672 /** Length of the base32-encoded hash of an introduction point's
674 #define REND_INTRO_POINT_ID_LEN_BASE32 32
676 /** Length of the descriptor cookie that is used for client authorization
677 * to hidden services. */
678 #define REND_DESC_COOKIE_LEN 16
680 /** Length of the base64-encoded descriptor cookie that is used for
681 * exchanging client authorization between hidden service and client. */
682 #define REND_DESC_COOKIE_LEN_BASE64 22
684 /** Length of client identifier in encrypted introduction points for hidden
685 * service authorization type 'basic'. */
686 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
688 /** Multiple of the number of clients to which the real number of clients
689 * is padded with fake clients for hidden service authorization type
691 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
693 /** Length of client entry consisting of client identifier and encrypted
694 * session key for hidden service authorization type 'basic'. */
695 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
698 /** Maximum size of v2 hidden service descriptors. */
699 #define REND_DESC_MAX_SIZE (20 * 1024)
701 /** Legal characters for use in authorized client names for a hidden
703 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
704 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
706 /** Maximum length of authorized client names for a hidden service. */
707 #define REND_CLIENTNAME_MAX_LEN 16
709 /** Length of the rendezvous cookie that is used to connect circuits at the
710 * rendezvous point. */
711 #define REND_COOKIE_LEN DIGEST_LEN
713 /** Client authorization type that a hidden service performs. */
714 typedef enum rend_auth_type_t
{
717 REND_STEALTH_AUTH
= 2,
720 /** Client-side configuration of authorization for a hidden service. */
721 typedef struct rend_service_authorization_t
{
722 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
723 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
724 rend_auth_type_t auth_type
;
725 } rend_service_authorization_t
;
727 /** Client- and server-side data that is used for hidden service connection
728 * establishment. Not all fields contain data depending on where this struct
730 typedef struct rend_data_t
{
731 /** Onion address (without the .onion part) that a client requests. */
732 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
734 /** (Optional) descriptor cookie that is used by a client. */
735 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
737 /** Authorization type for accessing a service used by a client. */
738 rend_auth_type_t auth_type
;
740 /** Hash of the hidden service's PK used by a service. */
741 char rend_pk_digest
[DIGEST_LEN
];
743 /** Rendezvous cookie used by both, client and service. */
744 char rend_cookie
[REND_COOKIE_LEN
];
747 /** Time interval for tracking possible replays of INTRODUCE2 cells.
748 * Incoming cells with timestamps half of this interval in the past or
749 * future are dropped immediately. */
750 #define REND_REPLAY_TIME_INTERVAL (60 * 60)
752 /** Used to indicate which way a cell is going on a circuit. */
754 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
755 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
758 /** Initial value for both sides of a circuit transmission window when the
759 * circuit is initialized. Measured in cells. */
760 #define CIRCWINDOW_START 1000
761 /** Amount to increment a circuit window when we get a circuit SENDME. */
762 #define CIRCWINDOW_INCREMENT 100
763 /** Initial value on both sides of a stream transmission window when the
764 * stream is initialized. Measured in cells. */
765 #define STREAMWINDOW_START 500
766 /** Amount to increment a stream window when we get a stream SENDME. */
767 #define STREAMWINDOW_INCREMENT 50
769 /* Cell commands. These values are defined in tor-spec.txt. */
770 #define CELL_PADDING 0
771 #define CELL_CREATE 1
772 #define CELL_CREATED 2
774 #define CELL_DESTROY 4
775 #define CELL_CREATE_FAST 5
776 #define CELL_CREATED_FAST 6
777 #define CELL_VERSIONS 7
778 #define CELL_NETINFO 8
779 #define CELL_RELAY_EARLY 9
781 /** True iff the cell command <b>x</b> is one that implies a variable-length
783 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
785 /** How long to test reachability before complaining to the user. */
786 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
788 /** Legal characters in a nickname. */
789 #define LEGAL_NICKNAME_CHARACTERS \
790 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
792 /** Name to use in client TLS certificates if no nickname is given. Once
793 * Tor 0.1.2.x is obsolete, we can remove this. */
794 #define DEFAULT_CLIENT_NICKNAME "client"
796 /** Number of bytes in a SOCKS4 header. */
797 #define SOCKS4_NETWORK_LEN 8
801 * Relay command [1 byte]
802 * Recognized [2 bytes]
803 * Stream ID [2 bytes]
804 * Partial SHA-1 [4 bytes]
806 * Relay payload [498 bytes]
809 /** Number of bytes in a cell, minus cell header. */
810 #define CELL_PAYLOAD_SIZE 509
811 /** Number of bytes in a cell transmitted over the network. */
812 #define CELL_NETWORK_SIZE 512
814 /** Length of a header on a variable-length cell. */
815 #define VAR_CELL_HEADER_SIZE 5
817 /** Number of bytes in a relay cell's header (not including general cell
819 #define RELAY_HEADER_SIZE (1+2+2+4+2)
820 /** Largest number of bytes that can fit in a relay cell payload. */
821 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
823 /** Identifies a circuit on an or_connection */
824 typedef uint16_t circid_t
;
825 /** Identifies a stream on a circuit */
826 typedef uint16_t streamid_t
;
828 /** Parsed onion routing cell. All communication between nodes
830 typedef struct cell_t
{
831 circid_t circ_id
; /**< Circuit which received the cell. */
832 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
833 * CELL_DESTROY, etc */
834 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
837 /** Parsed variable-length onion routing cell. */
838 typedef struct var_cell_t
{
841 uint16_t payload_len
;
845 /** A cell as packed for writing to the network. */
846 typedef struct packed_cell_t
{
847 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
848 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
851 /** Number of cells added to a circuit queue including their insertion
852 * time on 10 millisecond detail; used for buffer statistics. */
853 typedef struct insertion_time_elem_t
{
854 struct insertion_time_elem_t
*next
; /**< Next element in queue. */
855 uint32_t insertion_time
; /**< When were cells inserted (in 10 ms steps
856 * starting at 0:00 of the current day)? */
857 unsigned counter
; /**< How many cells were inserted? */
858 } insertion_time_elem_t
;
860 /** Queue of insertion times. */
861 typedef struct insertion_time_queue_t
{
862 struct insertion_time_elem_t
*first
; /**< First element in queue. */
863 struct insertion_time_elem_t
*last
; /**< Last element in queue. */
864 } insertion_time_queue_t
;
866 /** A queue of cells on a circuit, waiting to be added to the
867 * or_connection_t's outbuf. */
868 typedef struct cell_queue_t
{
869 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
870 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
871 int n
; /**< The number of cells in the queue. */
872 insertion_time_queue_t
*insertion_times
; /**< Insertion times of cells. */
875 /** Beginning of a RELAY cell payload. */
877 uint8_t command
; /**< The end-to-end relay command. */
878 uint16_t recognized
; /**< Used to tell whether cell is for us. */
879 streamid_t stream_id
; /**< Which stream is this cell associated with? */
880 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
881 uint16_t length
; /**< How long is the payload body? */
884 typedef struct buf_t buf_t
;
885 typedef struct socks_request_t socks_request_t
;
887 /* Values for connection_t.magic: used to make sure that downcasts (casts from
888 * connection_t to foo_connection_t) are safe. */
889 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
890 #define OR_CONNECTION_MAGIC 0x7D31FF03u
891 #define EDGE_CONNECTION_MAGIC 0xF0374013u
892 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
893 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
895 /** Description of a connection to another host or process, and associated
898 * A connection is named based on what it's connected to -- an "OR
899 * connection" has a Tor node on the other end, an "exit
900 * connection" has a website or other server on the other end, and an
901 * "AP connection" has an application proxy (and thus a user) on the
904 * Every connection has a type and a state. Connections never change
905 * their type, but can go through many state changes in their lifetime.
907 * Every connection has two associated input and output buffers.
908 * Listeners don't use them. For non-listener connections, incoming
909 * data is appended to conn->inbuf, and outgoing data is taken from
910 * conn->outbuf. Connections differ primarily in the functions called
911 * to fill and drain these buffers.
913 typedef struct connection_t
{
914 uint32_t magic
; /**< For memory debugging: must equal one of
915 * *_CONNECTION_MAGIC. */
917 uint8_t state
; /**< Current state of this connection. */
918 unsigned int type
:4; /**< What kind of connection is this? */
919 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
921 /* The next fields are all one-bit booleans. Some are only applicable to
922 * connection subtypes, but we hold them here anyway, to save space.
924 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
925 * again once the bandwidth throttler allows it? */
926 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
927 * again once the bandwidth throttler allows
929 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
930 * marked for close, do we flush it
931 * before closing it? */
932 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
934 /** Set to 1 when we're inside connection_flushed_some to keep us from
935 * calling connection_handle_write() recursively. */
936 unsigned int in_flushed_some
:1;
938 /* For linked connections:
940 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
941 /** True iff we'd like to be notified about read events from the
943 unsigned int reading_from_linked_conn
:1;
944 /** True iff we're willing to write to the linked conn. */
945 unsigned int writing_to_linked_conn
:1;
946 /** True iff we're currently able to read on the linked conn, and our
947 * read_event should be made active with libevent. */
948 unsigned int active_on_link
:1;
949 /** True iff we've called connection_close_immediate() on this linked
951 unsigned int linked_conn_is_closed
:1;
953 /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
954 unsigned int proxy_state
:4;
956 /** Our socket; -1 if this connection is closed, or has no socket. */
958 int conn_array_index
; /**< Index into the global connection array. */
959 struct event
*read_event
; /**< Libevent event structure. */
960 struct event
*write_event
; /**< Libevent event structure. */
961 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
962 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
963 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
965 time_t timestamp_lastread
; /**< When was the last time libevent said we could
967 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
969 time_t timestamp_created
; /**< When was this connection_t created? */
971 /* XXXX_IP6 make this IPv6-capable */
972 int socket_family
; /**< Address family of this connection's socket. Usually
973 * AF_INET, but it can also be AF_UNIX, or in the future
975 tor_addr_t addr
; /**< IP of the other side of the connection; used to
976 * identify routers, along with port. */
977 uint16_t port
; /**< If non-zero, port on the other end
978 * of the connection. */
979 uint16_t marked_for_close
; /**< Should we close this conn on the next
980 * iteration of the main loop? (If true, holds
981 * the line number where this connection was
983 const char *marked_for_close_file
; /**< For debugging: in which file were
984 * we marked for close? */
985 char *address
; /**< FQDN (or IP) of the guy on the other end.
986 * strdup into this, because free_connection() frees it. */
987 /** Another connection that's connected to this one in lieu of a socket. */
988 struct connection_t
*linked_conn
;
990 /** Unique identifier for this connection on this Tor instance. */
991 uint64_t global_identifier
;
993 /* XXXX022 move this field, and all the listener-only fields (just
994 socket_family, I think), into a new listener_connection_t subtype. */
995 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
996 * to the evdns_server_port is uses to listen to and answer connections. */
997 struct evdns_server_port
*dns_server_port
;
999 /** Unique ID for measuring tunneled network status requests. */
1003 /** Stores flags and information related to the portion of a v2 Tor OR
1004 * connection handshake that happens after the TLS handshake is finished.
1006 typedef struct or_handshake_state_t
{
1007 /** When was the VERSIONS cell sent on this connection? Used to get
1008 * an estimate of the skew in the returning NETINFO reply. */
1009 time_t sent_versions_at
;
1010 /** True iff we originated this connection */
1011 unsigned int started_here
: 1;
1012 /** True iff we have received and processed a VERSIONS cell. */
1013 unsigned int received_versions
: 1;
1014 } or_handshake_state_t
;
1016 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
1017 * cells over TLS. */
1018 typedef struct or_connection_t
{
1021 /** Hash of the public RSA key for the other side's identity key, or zeroes
1022 * if the other side hasn't shown us a valid identity key. */
1023 char identity_digest
[DIGEST_LEN
];
1024 char *nickname
; /**< Nickname of OR on other side (if any). */
1026 tor_tls_t
*tls
; /**< TLS connection state. */
1027 int tls_error
; /**< Last tor_tls error code. */
1028 /** When we last used this conn for any client traffic. If not
1029 * recent, we can rate limit it further. */
1032 tor_addr_t real_addr
; /**< The actual address that this connection came from
1033 * or went to. The <b>addr</b> field is prone to
1034 * getting overridden by the address from the router
1035 * descriptor matching <b>identity_digest</b>. */
1037 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1038 * connection, which half of the space should
1040 /** Should this connection be used for extending circuits to the server
1041 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1042 * sure we aren't getting MITMed, either because we're connected to an
1043 * address listed in a server descriptor, or because an authenticated
1044 * NETINFO cell listed the address we're connected to as recognized. */
1045 unsigned int is_canonical
:1;
1046 /** True iff this connection shouldn't get any new circs attached to it,
1047 * because the connection is too old, or because there's a better one, etc.
1049 unsigned int is_bad_for_new_circs
:1;
1050 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1051 * "none negotiated yet." */
1052 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1053 * this connection? This is always in the
1054 * range 0..1<<15-1. */
1056 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1057 * up, state information to do so. */
1058 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1059 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1060 * non-padding cell to the outbuf? */
1062 /* bandwidth* and *_bucket only used by ORs in OPEN state: */
1063 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1064 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1065 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1066 * add 'bandwidthrate' to this, capping it at
1067 * bandwidthburst. (OPEN ORs only) */
1068 int write_bucket
; /**< When this hits 0, stop writing. Like read_bucket. */
1069 int n_circuits
; /**< How many circuits use this connection as p_conn or
1072 /** Double-linked ring of circuits with queued cells waiting for room to
1073 * free up on this connection's outbuf. Every time we pull cells from a
1074 * circuit, we advance this pointer to the next circuit in the ring. */
1075 struct circuit_t
*active_circuits
;
1076 /** Priority queue of cell_ewma_t for circuits with queued cells waiting for
1077 * room to free up on this connection's outbuf. Kept in heap order
1078 * according to EWMA.
1080 * This is redundant with active_circuits; if we ever decide only to use the
1081 * cell_ewma algorithm for choosing circuits, we can remove active_circuits.
1083 smartlist_t
*active_circuit_pqueue
;
1084 /** The tick on which the cell_ewma_ts in active_circuit_pqueue last had
1085 * their ewma values rescaled. */
1086 unsigned active_circuit_pqueue_last_recalibrated
;
1087 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1088 * identity digest as this one. */
1091 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
1092 * connection, or an exit. */
1093 typedef struct edge_connection_t
{
1096 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1098 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
1099 * this conn exits at. */
1100 int package_window
; /**< How many more relay cells can I send into the
1102 int deliver_window
; /**< How many more relay cells can end at me? */
1104 /** Nickname of planned exit node -- used with .exit support. */
1105 char *chosen_exit_name
;
1107 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1109 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1110 * connection is using. */
1112 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1113 * connection. Exit connections only. */
1115 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1118 /** The reason why this connection is closing; passed to the controller. */
1119 uint16_t end_reason
;
1121 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1124 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1127 /** What rendezvous service are we querying for? (AP only) */
1128 rend_data_t
*rend_data
;
1130 /** Number of times we've reassigned this application connection to
1131 * a new circuit. We keep track because the timeout is longer if we've
1132 * already retried several times. */
1133 uint8_t num_socks_retries
;
1135 /** True iff this connection is for a DNS request only. */
1136 unsigned int is_dns_request
:1;
1138 /** True iff this stream must attach to a one-hop circuit (e.g. for
1140 unsigned int want_onehop
:1;
1141 /** True iff this stream should use a BEGIN_DIR relay command to establish
1142 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1143 unsigned int use_begindir
:1;
1145 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1146 * connections. Set once we've set the stream end,
1147 * and check in connection_about_to_close_connection().
1149 /** True iff we've blocked reading until the circuit has fewer queued
1151 unsigned int edge_blocked_on_circ
:1;
1152 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1153 * stop requiring it. */
1154 unsigned int chosen_exit_optional
:1;
1155 /** For AP connections only. If non-zero, this exit node was picked as
1156 * a result of the TrackHostExit, and the value decrements every time
1157 * we fail to complete a circuit to our chosen exit -- if it reaches
1158 * zero, abandon the associated mapaddress. */
1159 unsigned int chosen_exit_retries
:3;
1161 /** If this is a DNSPort connection, this field holds the pending DNS
1162 * request that we're going to try to answer. */
1163 struct evdns_server_request
*dns_server_request
;
1165 } edge_connection_t
;
1167 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1168 * connection to retrieve or serve directory material. */
1169 typedef struct dir_connection_t
{
1172 char *requested_resource
; /**< Which 'resource' did we ask the directory
1174 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1176 /* Used only for server sides of some dir connections, to implement
1177 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1178 * to append everything to the outbuf in one enormous chunk. */
1179 /** What exactly are we spooling right now? */
1181 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1182 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1183 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
,
1184 DIR_SPOOL_MICRODESC
, /* NOTE: if we add another entry, add another bit. */
1185 } dir_spool_src
: 3;
1186 /** If we're fetching descriptors, what router purpose shall we assign
1188 uint8_t router_purpose
;
1189 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1190 smartlist_t
*fingerprint_stack
;
1191 /** A cached_dir_t object that we're currently spooling out */
1192 struct cached_dir_t
*cached_dir
;
1193 /** The current offset into cached_dir. */
1194 off_t cached_dir_offset
;
1195 /** The zlib object doing on-the-fly compression for spooled data. */
1196 tor_zlib_state_t
*zlib_state
;
1198 /** What rendezvous service are we querying for? */
1199 rend_data_t
*rend_data
;
1201 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1202 * the directory server's signing key. */
1206 /** Subtype of connection_t for an connection to a controller. */
1207 typedef struct control_connection_t
{
1210 uint32_t event_mask
; /**< Bitfield: which events does this controller
1213 /** True if we have sent a protocolinfo reply on this connection. */
1214 unsigned int have_sent_protocolinfo
:1;
1216 /** Amount of space allocated in incoming_cmd. */
1217 uint32_t incoming_cmd_len
;
1218 /** Number of bytes currently stored in incoming_cmd. */
1219 uint32_t incoming_cmd_cur_len
;
1220 /** A control command that we're reading from the inbuf, but which has not
1221 * yet arrived completely. */
1223 } control_connection_t
;
1225 /** Cast a connection_t subtype pointer to a connection_t **/
1226 #define TO_CONN(c) (&(((c)->_base)))
1227 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1228 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1230 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1232 static or_connection_t
*TO_OR_CONN(connection_t
*);
1233 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1235 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1236 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1238 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1239 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1241 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1243 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1245 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1246 return DOWNCAST(or_connection_t
, c
);
1248 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1250 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1251 return DOWNCAST(dir_connection_t
, c
);
1253 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1255 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1256 return DOWNCAST(edge_connection_t
, c
);
1258 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1260 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1261 return DOWNCAST(control_connection_t
, c
);
1264 /** What action type does an address policy indicate: accept or reject? */
1266 ADDR_POLICY_ACCEPT
=1,
1267 ADDR_POLICY_REJECT
=2,
1268 } addr_policy_action_t
;
1270 /** A reference-counted address policy rule. */
1271 typedef struct addr_policy_t
{
1272 int refcnt
; /**< Reference count */
1273 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1274 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1276 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1277 * copy (stored in a hash table to avoid
1278 * duplication of common policies) */
1279 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1280 * first <b>maskbits</b> bits of <b>a</b> match
1282 tor_addr_t addr
; /**< Base address to accept or reject. */
1283 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1284 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1287 /** A cached_dir_t represents a cacheable directory object, along with its
1288 * compressed form. */
1289 typedef struct cached_dir_t
{
1290 char *dir
; /**< Contents of this object, NUL-terminated. */
1291 char *dir_z
; /**< Compressed contents of this object. */
1292 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1293 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1294 time_t published
; /**< When was this object published. */
1295 digests_t digests
; /**< Digests of this object (networkstatus only) */
1296 int refcnt
; /**< Reference count for this cached_dir_t. */
1299 /** Enum used to remember where a signed_descriptor_t is stored and how to
1300 * manage the memory for signed_descriptor_body. */
1302 /** The descriptor isn't stored on disk at all: the copy in memory is
1303 * canonical; the saved_offset field is meaningless. */
1305 /** The descriptor is stored in the cached_routers file: the
1306 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1307 * saved_offset are used to index into the mmaped cache file. */
1309 /** The descriptor is stored in the cached_routers.new file: the
1310 * signed_descriptor_body and saved_offset fields are both set. */
1311 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1312 * lazy-load the descriptor text by using seek and read. We don't, for
1318 /** Enumeration: what kind of download schedule are we using for a given
1321 DL_SCHED_GENERIC
= 0,
1322 DL_SCHED_CONSENSUS
= 1,
1323 DL_SCHED_BRIDGE
= 2,
1324 } download_schedule_t
;
1326 /** Information about our plans for retrying downloads for a downloadable
1328 typedef struct download_status_t
{
1329 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1331 uint8_t n_download_failures
; /**< Number of failures trying to download the
1332 * most recent descriptor. */
1333 download_schedule_t schedule
: 8;
1334 } download_status_t
;
1336 /** If n_download_failures is this high, the download can never happen. */
1337 #define IMPOSSIBLE_TO_DOWNLOAD 255
1339 /** The max size we expect router descriptor annotations we create to
1340 * be. We'll accept larger ones if we see them on disk, but we won't
1341 * create any that are larger than this. */
1342 #define ROUTER_ANNOTATION_BUF_LEN 256
1344 /** Information need to cache an onion router's descriptor. */
1345 typedef struct signed_descriptor_t
{
1346 /** Pointer to the raw server descriptor, preceded by annotations. Not
1347 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1348 * pointer is null. */
1349 char *signed_descriptor_body
;
1350 /** Length of the annotations preceding the server descriptor. */
1351 size_t annotations_len
;
1352 /** Length of the server descriptor. */
1353 size_t signed_descriptor_len
;
1354 /** Digest of the server descriptor, computed as specified in
1356 char signed_descriptor_digest
[DIGEST_LEN
];
1357 /** Identity digest of the router. */
1358 char identity_digest
[DIGEST_LEN
];
1359 /** Declared publication time of the descriptor. */
1360 time_t published_on
;
1361 /** For routerdescs only: digest of the corresponding extrainfo. */
1362 char extra_info_digest
[DIGEST_LEN
];
1363 /** For routerdescs only: Status of downloading the corresponding
1365 download_status_t ei_dl_status
;
1366 /** Where is the descriptor saved? */
1367 saved_location_t saved_location
;
1368 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1369 * this descriptor in the corresponding file. */
1371 /** What position is this descriptor within routerlist->routers or
1372 * routerlist->old_routers? -1 for none. */
1373 int routerlist_index
;
1374 /** The valid-until time of the most recent consensus that listed this
1375 * descriptor, or a bit after the publication time of the most recent v2
1376 * networkstatus that listed it. 0 for "never listed in a consensus or
1377 * status, so far as we know." */
1378 time_t last_listed_as_valid_until
;
1379 #ifdef TRACK_SERVED_TIME
1380 /** The last time we served anybody this descriptor. Used for internal
1381 * testing to see whether we're holding on to descriptors too long. */
1382 time_t last_served_at
; /*XXXX remove if not useful. */
1384 /* If true, we do not ever try to save this object in the cache. */
1385 unsigned int do_not_cache
: 1;
1386 /* If true, this item is meant to represent an extrainfo. */
1387 unsigned int is_extrainfo
: 1;
1388 /* If true, we got an extrainfo for this item, and the digest was right,
1389 * but it was incompatible. */
1390 unsigned int extrainfo_is_bogus
: 1;
1391 /* If true, we are willing to transmit this item unencrypted. */
1392 unsigned int send_unencrypted
: 1;
1393 } signed_descriptor_t
;
1395 /** A signed integer representing a country code. */
1396 typedef int16_t country_t
;
1398 /** Information about another onion router in the network. */
1400 signed_descriptor_t cache_info
;
1401 char *address
; /**< Location of OR: either a hostname or an IP address. */
1402 char *nickname
; /**< Human-readable OR name. */
1404 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1405 uint16_t or_port
; /**< Port for TLS connections. */
1406 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1408 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1409 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1411 char *platform
; /**< What software/operating system is this OR using? */
1414 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1415 * bucket per second? */
1416 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1417 /** How many bytes/s is this router known to handle? */
1418 uint32_t bandwidthcapacity
;
1419 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1420 * to exit? NULL for 'reject *:*'. */
1421 long uptime
; /**< How many seconds the router claims to have been up */
1422 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1423 * claims are its family. */
1424 char *contact_info
; /**< Declared contact info for this router. */
1425 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1427 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1428 * dnsworker code. */
1429 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1430 * extrainfo documents. */
1431 unsigned int allow_single_hop_exits
:1; /**< Whether the router allows
1432 * single hop exits. */
1435 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1437 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1438 * (For Authdir: Have we validated this OR?)
1440 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1442 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1443 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1444 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1445 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1446 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1447 * or otherwise nasty? */
1448 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1449 * underpowered, or otherwise useless? */
1450 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1451 * a hidden service directory. */
1452 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1453 * directory according to the authorities. */
1454 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1455 * router rejects everything. */
1457 /** Tor can use this router for general positions in circuits. */
1458 #define ROUTER_PURPOSE_GENERAL 0
1459 /** Tor should avoid using this router for circuit-building. */
1460 #define ROUTER_PURPOSE_CONTROLLER 1
1461 /** Tor should use this router only for bridge positions in circuits. */
1462 #define ROUTER_PURPOSE_BRIDGE 2
1463 /** Tor should not use this router; it was marked in cached-descriptors with
1464 * a purpose we didn't recognize. */
1465 #define ROUTER_PURPOSE_UNKNOWN 255
1467 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1469 /* The below items are used only by authdirservers for
1470 * reachability testing. */
1471 /** When was the last time we could reach this OR? */
1472 time_t last_reachable
;
1473 /** When did we start testing reachability for this OR? */
1474 time_t testing_since
;
1475 /** According to the geoip db what country is this router in? */
1479 /** Information needed to keep and cache a signed extra-info document. */
1480 typedef struct extrainfo_t
{
1481 signed_descriptor_t cache_info
;
1482 /** The router's nickname. */
1483 char nickname
[MAX_NICKNAME_LEN
+1];
1484 /** True iff we found the right key for this extra-info, verified the
1485 * signature, and found it to be bad. */
1486 unsigned int bad_sig
: 1;
1487 /** If present, we didn't have the right key to verify this extra-info,
1488 * so this is a copy of the signature in the document. */
1490 /** Length of pending_sig. */
1491 size_t pending_sig_len
;
1494 /** Contents of a single router entry in a network status object.
1496 typedef struct routerstatus_t
{
1497 time_t published_on
; /**< When was this router published? */
1498 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1500 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1502 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1504 uint32_t addr
; /**< IPv4 address for this router. */
1505 uint16_t or_port
; /**< OR port for this router. */
1506 uint16_t dir_port
; /**< Directory port for this router. */
1507 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1508 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1509 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1510 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1511 unsigned int is_running
:1; /**< True iff this router is up. */
1512 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1513 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1515 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1516 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1517 * information with v2 of the directory
1518 * protocol. (All directory caches cache v1
1520 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1521 * choice as an entry guard. */
1522 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1524 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1525 * underpowered, or otherwise useless? */
1526 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1527 * service directory. */
1528 /** True iff we know version info for this router. (i.e., a "v" entry was
1529 * included.) We'll replace all these with a big tor_version_t or a char[]
1530 * if the number of traits we care about ever becomes incredibly big. */
1531 unsigned int version_known
:1;
1532 /** True iff this router is a version that supports BEGIN_DIR cells. */
1533 unsigned int version_supports_begindir
:1;
1534 /** True iff this router is a version that supports conditional consensus
1535 * downloads (signed by list of authorities). */
1536 unsigned int version_supports_conditional_consensus
:1;
1537 /** True iff this router is a version that we can post extrainfo docs to. */
1538 unsigned int version_supports_extrainfo_upload
:1;
1539 /** True iff this router is a version that, if it caches directory info,
1540 * we can get v3 downloads from. */
1541 unsigned int version_supports_v3_dir
:1;
1543 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1544 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1545 unsigned int has_measured_bw
:1; /**< The vote/consensus had a measured bw */
1547 uint32_t measured_bw
; /**< Measured bandwidth (capacity) of the router */
1549 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1550 * the vote/consensus, in kilobytes/sec. */
1551 char *exitsummary
; /**< exit policy summary -
1552 * XXX weasel: this probably should not stay a string. */
1554 /* ---- The fields below aren't derived from the networkstatus; they
1555 * hold local information only. */
1557 /** True if we, as a directory mirror, want to download the corresponding
1558 * routerinfo from the authority who gave us this routerstatus. (That is,
1559 * if we don't have the routerinfo, and if we haven't already tried to get it
1560 * from this authority.) Applies in v2 networkstatus document only.
1562 unsigned int need_to_mirror
:1;
1563 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1564 * to this (unnamed) router by nickname?
1566 time_t last_dir_503_at
; /**< When did this router last tell us that it
1567 * was too busy to serve directory info? */
1568 download_status_t dl_status
;
1572 /** A microdescriptor is the smallest amount of information needed to build a
1573 * circuit through a router. They are generated by the directory authorities,
1574 * using information from the uploaded routerinfo documents. They are not
1575 * self-signed, but are rather authenticated by having their hash in a signed
1576 * networkstatus document. */
1577 typedef struct microdesc_t
{
1578 /** Hashtable node, used to look up the microdesc by its digest. */
1579 HT_ENTRY(microdesc_t
) node
;
1581 /* Cache information */
1583 /** When was this microdescriptor last listed in a consensus document?
1584 * Once a microdesc has been unlisted long enough, we can drop it.
1587 /** Where is this microdescriptor currently stored? */
1588 saved_location_t saved_location
: 3;
1589 /** If true, do not attempt to cache this microdescriptor on disk. */
1590 unsigned int no_save
: 1;
1591 /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
1592 * microdescriptor in the cache. */
1595 /* The string containing the microdesc. */
1597 /** A pointer to the encoded body of the microdescriptor. If the
1598 * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
1599 * mmap'd region. Otherwise, it is a malloc'd string. The string might not
1600 * be NUL-terminated; take the length from <b>bodylen</b>. */
1602 /** The length of the microdescriptor in <b>body</b>. */
1604 /** A SHA256-digest of the microdescriptor. */
1605 char digest
[DIGEST256_LEN
];
1607 /* Fields in the microdescriptor. */
1609 /** As routerinfo_t.onion_pkey */
1610 crypto_pk_env_t
*onion_pkey
;
1611 /** As routerinfo_t.family */
1612 smartlist_t
*family
;
1613 /** Encoded exit policy summary */
1614 char *exitsummary
; /**< exit policy summary -
1615 * XXX this probably should not stay a string. */
1618 /** How many times will we try to download a router's descriptor before giving
1620 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1622 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1623 typedef struct networkstatus_v2_t
{
1624 /** When did we receive the network-status document? */
1627 /** What was the digest of the document? */
1628 char networkstatus_digest
[DIGEST_LEN
];
1630 /* These fields come from the actual network-status document.*/
1631 time_t published_on
; /**< Declared publication date. */
1633 char *source_address
; /**< Canonical directory server hostname. */
1634 uint32_t source_addr
; /**< Canonical directory server IP. */
1635 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1637 unsigned int binds_names
:1; /**< True iff this directory server binds
1639 unsigned int recommends_versions
:1; /**< True iff this directory server
1640 * recommends client and server software
1642 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1643 * malfunctioning exits as bad. */
1644 /** True iff this directory server marks malfunctioning directories as
1646 unsigned int lists_bad_directories
:1;
1648 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1649 char *contact
; /**< How to contact directory admin? (may be NULL). */
1650 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1651 char *client_versions
; /**< comma-separated list of recommended client
1653 char *server_versions
; /**< comma-separated list of recommended server
1656 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1657 * sorted by identity_digest. */
1658 } networkstatus_v2_t
;
1660 typedef struct vote_microdesc_hash_t
{
1661 struct vote_microdesc_hash_t
*next
;
1662 char *microdesc_hash_line
;
1663 } vote_microdesc_hash_t
;
1665 /** The claim about a single router, made in a vote. */
1666 typedef struct vote_routerstatus_t
{
1667 routerstatus_t status
; /**< Underlying 'status' object for this router.
1668 * Flags are redundant. */
1669 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1670 * networkstatus_t.known_flags. */
1671 char *version
; /**< The version that the authority says this router is
1673 vote_microdesc_hash_t
*microdesc
;
1674 } vote_routerstatus_t
;
1676 /** A signature of some document by an authority. */
1677 typedef struct document_signature_t
{
1678 /** Declared SHA-1 digest of this voter's identity key */
1679 char identity_digest
[DIGEST_LEN
];
1680 /** Declared SHA-1 digest of signing key used by this voter. */
1681 char signing_key_digest
[DIGEST_LEN
];
1682 /** Algorithm used to compute the digest of the document. */
1683 digest_algorithm_t alg
;
1684 /** Signature of the signed thing. */
1686 /** Length of <b>signature</b> */
1688 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1689 * the sig, and we know it's bad. */
1690 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1692 } document_signature_t
;
1694 /** Information about a single voter in a vote or a consensus. */
1695 typedef struct networkstatus_voter_info_t
{
1696 /** Declared SHA-1 digest of this voter's identity key */
1697 char identity_digest
[DIGEST_LEN
];
1698 char *nickname
; /**< Nickname of this voter */
1699 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
1700 * consensuses, we treat legacy keys as additional signers. */
1701 char legacy_id_digest
[DIGEST_LEN
];
1702 char *address
; /**< Address of this voter, in string format. */
1703 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1704 uint16_t dir_port
; /**< Directory port of this voter */
1705 uint16_t or_port
; /**< OR port of this voter */
1706 char *contact
; /**< Contact information for this voter. */
1707 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1709 /* Nothing from here on is signed. */
1710 /** The signature of the document and the signature's status. */
1712 } networkstatus_voter_info_t
;
1714 /** Enumerates the possible seriousness values of a networkstatus document. */
1719 } networkstatus_type_t
;
1721 /** Enumerates recognized flavors of a consensus networkstatus document. All
1722 * flavors of a consensus are generated from the same set of votes, but they
1723 * present different types information to different versions of Tor. */
1727 } consensus_flavor_t
;
1729 /** Which consensus flavor do we actually want to use to build circuits? */
1730 #define USABLE_CONSENSUS_FLAVOR FLAV_NS
1732 /** How many different consensus flavors are there? */
1733 #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
1735 /** A common structure to hold a v3 network status vote, or a v3 network
1736 * status consensus. */
1737 typedef struct networkstatus_t
{
1738 networkstatus_type_t type
: 8; /**< Vote, consensus, or opinion? */
1739 consensus_flavor_t flavor
: 8; /**< If a consensus, what kind? */
1740 time_t published
; /**< Vote only: Time when vote was written. */
1741 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1742 time_t fresh_until
; /**< Time before which this is the most recent vote or
1744 time_t valid_until
; /**< Time after which this vote or consensus should not
1747 /** Consensus only: what method was used to produce this consensus? */
1748 int consensus_method
;
1749 /** Vote only: what methods is this voter willing to use? */
1750 smartlist_t
*supported_methods
;
1752 /** How long does this vote/consensus claim that authorities take to
1753 * distribute their votes to one another? */
1755 /** How long does this vote/consensus claim that authorities take to
1756 * distribute their consensus signatures to one another? */
1759 /** Comma-separated list of recommended client software, or NULL if this
1760 * voter has no opinion. */
1761 char *client_versions
;
1762 char *server_versions
;
1763 /** List of flags that this vote/consensus applies to routers. If a flag is
1764 * not listed here, the voter has no opinion on what its value should be. */
1765 smartlist_t
*known_flags
;
1767 /** List of key=value strings for the parameters in this vote or
1768 * consensus, sorted by key. */
1769 smartlist_t
*net_params
;
1771 /** List of key=value strings for the bw weight parameters in the
1773 smartlist_t
*weight_params
;
1775 /** List of networkstatus_voter_info_t. For a vote, only one element
1776 * is included. For a consensus, one element is included for every voter
1777 * whose vote contributed to the consensus. */
1778 smartlist_t
*voters
;
1780 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1782 /** Digests of this document, as signed. */
1785 /** List of router statuses, sorted by identity digest. For a vote,
1786 * the elements are vote_routerstatus_t; for a consensus, the elements
1787 * are routerstatus_t. */
1788 smartlist_t
*routerstatus_list
;
1790 /** If present, a map from descriptor digest to elements of
1791 * routerstatus_list. */
1792 digestmap_t
*desc_digest_map
;
1795 /** A set of signatures for a networkstatus consensus. Unless otherwise
1796 * noted, all fields are as for networkstatus_t. */
1797 typedef struct ns_detached_signatures_t
{
1801 strmap_t
*digests
; /**< Map from flavor name to digestset_t */
1802 strmap_t
*signatures
; /**< Map from flavor name to list of
1803 * document_signature_t */
1804 } ns_detached_signatures_t
;
1806 /** Allowable types of desc_store_t. */
1807 typedef enum store_type_t
{
1812 /** A 'store' is a set of descriptors saved on disk, with accompanying
1813 * journal, mmaped as needed, rebuilt as needed. */
1814 typedef struct desc_store_t
{
1815 /** Filename (within DataDir) for the store. We append .tmp to this
1816 * filename for a temporary file when rebuilding the store, and .new to this
1817 * filename for the journal. */
1818 const char *fname_base
;
1819 /** Alternative (obsolete) value for fname_base: if the file named by
1820 * fname_base isn't present, we read from here instead, but we never write
1822 const char *fname_alt_base
;
1823 /** Human-readable description of what this store contains. */
1824 const char *description
;
1826 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1828 store_type_t type
; /**< What's stored in this store? */
1830 /** The size of the router log, in bytes. */
1832 /** The size of the router store, in bytes. */
1834 /** Total bytes dropped since last rebuild: this is space currently
1835 * used in the cache and the journal that could be freed by a rebuild. */
1836 size_t bytes_dropped
;
1839 /** Contents of a directory of onion routers. */
1841 /** Map from server identity digest to a member of routers. */
1842 struct digest_ri_map_t
*identity_map
;
1843 /** Map from server descriptor digest to a signed_descriptor_t from
1844 * routers or old_routers. */
1845 struct digest_sd_map_t
*desc_digest_map
;
1846 /** Map from extra-info digest to an extrainfo_t. Only exists for
1847 * routers in routers or old_routers. */
1848 struct digest_ei_map_t
*extra_info_map
;
1849 /** Map from extra-info digests to a signed_descriptor_t for a router
1850 * descriptor having that extra-info digest. Only exists for
1851 * routers in routers or old_routers. */
1852 struct digest_sd_map_t
*desc_by_eid_map
;
1853 /** List of routerinfo_t for all currently live routers we know. */
1854 smartlist_t
*routers
;
1855 /** List of signed_descriptor_t for older router descriptors we're
1857 smartlist_t
*old_routers
;
1858 /** Store holding server descriptors. If present, any router whose
1859 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1860 * starting at cache_info.saved_offset */
1861 desc_store_t desc_store
;
1862 /** Store holding extra-info documents. */
1863 desc_store_t extrainfo_store
;
1866 /** Information on router used when extending a circuit. We don't need a
1867 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1868 * connection, and onion_key to create the onionskin. Note that for onehop
1869 * general-purpose tunnels, the onion_key is NULL. */
1870 typedef struct extend_info_t
{
1871 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1873 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1874 uint16_t port
; /**< OR port. */
1875 tor_addr_t addr
; /**< IP address. */
1876 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1879 /** Certificate for v3 directory protocol: binds long-term authority identity
1880 * keys to medium-term authority signing keys. */
1881 typedef struct authority_cert_t
{
1882 /** Information relating to caching this cert on disk and looking it up. */
1883 signed_descriptor_t cache_info
;
1884 /** This authority's long-term authority identity key. */
1885 crypto_pk_env_t
*identity_key
;
1886 /** This authority's medium-term signing key. */
1887 crypto_pk_env_t
*signing_key
;
1888 /** The digest of <b>signing_key</b> */
1889 char signing_key_digest
[DIGEST_LEN
];
1890 /** The listed expiration time of this certificate. */
1892 /** This authority's IPv4 address, in host order. */
1894 /** This authority's directory port. */
1896 /** True iff this certificate was cross-certified by signing the identity
1897 * key with the signing key. */
1898 uint8_t is_cross_certified
;
1901 /** Bitfield enum type listing types of directory authority/directory
1905 /** Serves/signs v1 directory information: Big lists of routers, and short
1906 * routerstatus documents. */
1907 V1_AUTHORITY
= 1 << 0,
1908 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
1909 V2_AUTHORITY
= 1 << 1,
1910 /** Serves/signs v3 directory information: votes, consensuses, certs */
1911 V3_AUTHORITY
= 1 << 2,
1912 /** Serves hidden service descriptors. */
1913 HIDSERV_AUTHORITY
= 1 << 3,
1914 /** Serves bridge descriptors. */
1915 BRIDGE_AUTHORITY
= 1 << 4,
1916 /** Serves extrainfo documents. (XXX Not precisely an authority type)*/
1917 EXTRAINFO_CACHE
= 1 << 5,
1920 #define CRYPT_PATH_MAGIC 0x70127012u
1922 /** Holds accounting information for a single step in the layered encryption
1923 * performed by a circuit. Used only at the client edge of a circuit. */
1924 typedef struct crypt_path_t
{
1927 /* crypto environments */
1928 /** Encryption key and counter for cells heading towards the OR at this
1930 crypto_cipher_env_t
*f_crypto
;
1931 /** Encryption key and counter for cells heading back from the OR at this
1933 crypto_cipher_env_t
*b_crypto
;
1935 /** Digest state for cells heading towards the OR at this step. */
1936 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1937 /** Digest state for cells heading away from the OR at this step. */
1938 crypto_digest_env_t
*b_digest
;
1940 /** Current state of Diffie-Hellman key negotiation with the OR at this
1942 crypto_dh_env_t
*dh_handshake_state
;
1943 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1944 * step. Used to save CPU when TLS is already providing all the
1945 * authentication, secrecy, and integrity we need, and we're already
1946 * distinguishable from an OR.
1948 char fast_handshake_state
[DIGEST_LEN
];
1949 /** Negotiated key material shared with the OR at this step. */
1950 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1952 /** Information to extend to the OR at this step. */
1953 extend_info_t
*extend_info
;
1955 /** Is the circuit built to this step? Must be one of:
1956 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1957 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1958 * and not received an EXTENDED/CREATED)
1959 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1961 #define CPATH_STATE_CLOSED 0
1962 #define CPATH_STATE_AWAITING_KEYS 1
1963 #define CPATH_STATE_OPEN 2
1964 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1965 * (The list is circular, so the last node
1966 * links to the first.) */
1967 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1970 int package_window
; /**< How many cells are we allowed to originate ending
1972 int deliver_window
; /**< How many cells are we willing to deliver originating
1976 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1978 #define DH_KEY_LEN DH_BYTES
1979 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1982 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1984 /** Information used to build a circuit. */
1986 /** Intended length of the final circuit. */
1987 int desired_path_len
;
1988 /** How to extend to the planned exit node. */
1989 extend_info_t
*chosen_exit
;
1990 /** Whether every node in the circ must have adequate uptime. */
1992 /** Whether every node in the circ must have adequate capacity. */
1994 /** Whether the last hop was picked with exiting in mind. */
1996 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1997 * These are for encrypted connections that exit to this router, not
1998 * for arbitrary exits from the circuit. */
2000 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
2001 crypt_path_t
*pending_final_cpath
;
2002 /** How many times has building a circuit for this task failed? */
2004 /** At what time should we give up on this task? */
2006 } cpath_build_state_t
;
2009 * The cell_ewma_t structure keeps track of how many cells a circuit has
2010 * transferred recently. It keeps an EWMA (exponentially weighted moving
2011 * average) of the number of cells flushed from the circuit queue onto a
2012 * connection in connection_or_flush_from_first_active_circuit().
2015 /** The last 'tick' at which we recalibrated cell_count.
2017 * A cell sent at exactly the start of this tick has weight 1.0. Cells sent
2018 * since the start of this tick have weight greater than 1.0; ones sent
2019 * earlier have less weight. */
2020 unsigned last_adjusted_tick
;
2021 /** The EWMA of the cell count. */
2023 /** True iff this is the cell count for a circuit's previous
2025 unsigned int is_for_p_conn
: 1;
2026 /** The position of the circuit within the OR connection's priority
2031 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
2032 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
2035 * A circuit is a path over the onion routing
2036 * network. Applications can connect to one end of the circuit, and can
2037 * create exit connections at the other end of the circuit. AP and exit
2038 * connections have only one circuit associated with them (and thus these
2039 * connection types are closed when the circuit is closed), whereas
2040 * OR connections multiplex many circuits at once, and stay standing even
2041 * when there are no circuits running over them.
2043 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
2044 * links two connections together: either an edge connection and an OR
2045 * connection, or two OR connections. (When joined to an OR connection, a
2046 * circuit_t affects only cells sent to a particular circID on that
2047 * connection. When joined to an edge connection, a circuit_t affects all
2050 * Second, an origin_circuit_t holds the cipher keys and state for sending data
2051 * along a given circuit. At the OP, it has a sequence of ciphers, each
2052 * of which is shared with a single OR along the circuit. Separate
2053 * ciphers are used for data going "forward" (away from the OP) and
2054 * "backward" (towards the OP). At the OR, a circuit has only two stream
2055 * ciphers: one for data going forward, and one for data going backward.
2057 typedef struct circuit_t
{
2058 uint32_t magic
; /**< For memory and type debugging: must equal
2059 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
2061 /** Queue of cells waiting to be transmitted on n_conn. */
2062 cell_queue_t n_conn_cells
;
2063 /** The OR connection that is next in this circuit. */
2064 or_connection_t
*n_conn
;
2065 /** The circuit_id used in the next (forward) hop of this circuit. */
2068 /** The hop to which we want to extend this circuit. Should be NULL if
2069 * the circuit has attached to a connection. */
2070 extend_info_t
*n_hop
;
2072 /** True iff we are waiting for n_conn_cells to become less full before
2073 * allowing p_streams to add any more cells. (Origin circuit only.) */
2074 unsigned int streams_blocked_on_n_conn
: 1;
2075 /** True iff we are waiting for p_conn_cells to become less full before
2076 * allowing n_streams to add any more cells. (OR circuit only.) */
2077 unsigned int streams_blocked_on_p_conn
: 1;
2079 uint8_t state
; /**< Current status of this circuit. */
2080 uint8_t purpose
; /**< Why are we creating this circuit? */
2082 /** How many relay data cells can we package (read from edge streams)
2083 * on this circuit before we receive a circuit-level sendme cell asking
2086 /** How many relay data cells will we deliver (write to edge streams)
2087 * on this circuit? When deliver_window gets low, we send some
2088 * circuit-level sendme cells to indicate that we're willing to accept
2092 /** For storage while n_conn is pending
2093 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
2094 * length ONIONSKIN_CHALLENGE_LEN. */
2095 char *n_conn_onionskin
;
2097 time_t timestamp_created
; /**< When was this circuit created? */
2098 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
2099 * circuit is clean. */
2100 struct timeval highres_created
; /**< When exactly was the circuit created? */
2102 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
2103 * the main loop? (If true, holds the line number
2104 * where this circuit was marked.) */
2105 const char *marked_for_close_file
; /**< For debugging: in which file was this
2106 * circuit marked for close? */
2108 /** Next circuit in the doubly-linked ring of circuits waiting to add
2109 * cells to n_conn. NULL if we have no cells pending, or if we're not
2110 * linked to an OR connection. */
2111 struct circuit_t
*next_active_on_n_conn
;
2112 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2113 * cells to n_conn. NULL if we have no cells pending, or if we're not
2114 * linked to an OR connection. */
2115 struct circuit_t
*prev_active_on_n_conn
;
2116 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
2118 /** Unique ID for measuring tunneled network status requests. */
2121 /** The EWMA count for the number of cells flushed from the
2122 * n_conn_cells queue. Used to determine which circuit to flush from next.
2124 cell_ewma_t n_cell_ewma
;
2127 /** Largest number of relay_early cells that we can send on a given
2129 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
2131 /** An origin_circuit_t holds data necessary to build and use a circuit.
2133 typedef struct origin_circuit_t
{
2136 /** Linked list of AP streams (or EXIT streams if hidden service)
2137 * associated with this circuit. */
2138 edge_connection_t
*p_streams
;
2139 /** Build state for this circuit. It includes the intended path
2140 * length, the chosen exit router, rendezvous information, etc.
2142 cpath_build_state_t
*build_state
;
2143 /** The doubly-linked list of crypt_path_t entries, one per hop,
2144 * for this circuit. This includes ciphers for each hop,
2145 * integrity-checking digests for each hop, and package/delivery
2146 * windows for each hop.
2148 crypt_path_t
*cpath
;
2150 /** Holds all rendezvous data on either client or service side. */
2151 rend_data_t
*rend_data
;
2153 /** How many more relay_early cells can we send on this circuit, according
2154 * to the specification? */
2155 unsigned int remaining_relay_early_cells
: 4;
2157 /** Set if this circuit insanely old and if we already informed the user */
2158 unsigned int is_ancient
: 1;
2160 /** What commands were sent over this circuit that decremented the
2161 * RELAY_EARLY counter? This is for debugging task 878. */
2162 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
2164 /** How many RELAY_EARLY cells have been sent over this circuit? This is
2165 * for debugging task 878, too. */
2166 int relay_early_cells_sent
;
2168 /** The next stream_id that will be tried when we're attempting to
2169 * construct a new AP stream originating at this circuit. */
2170 streamid_t next_stream_id
;
2172 /* The intro key replaces the hidden service's public key if purpose is
2173 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2174 * descriptor is used. */
2175 crypto_pk_env_t
*intro_key
;
2177 /** Quasi-global identifier for this circuit; used for control.c */
2178 /* XXXX NM This can get re-used after 2**32 circuits. */
2179 uint32_t global_identifier
;
2183 /** An or_circuit_t holds information needed to implement a circuit at an
2185 typedef struct or_circuit_t
{
2188 /** Next circuit in the doubly-linked ring of circuits waiting to add
2189 * cells to p_conn. NULL if we have no cells pending, or if we're not
2190 * linked to an OR connection. */
2191 struct circuit_t
*next_active_on_p_conn
;
2192 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2193 * cells to p_conn. NULL if we have no cells pending, or if we're not
2194 * linked to an OR connection. */
2195 struct circuit_t
*prev_active_on_p_conn
;
2197 /** The circuit_id used in the previous (backward) hop of this circuit. */
2199 /** Queue of cells waiting to be transmitted on p_conn. */
2200 cell_queue_t p_conn_cells
;
2201 /** The OR connection that is previous in this circuit. */
2202 or_connection_t
*p_conn
;
2203 /** Linked list of Exit streams associated with this circuit. */
2204 edge_connection_t
*n_streams
;
2205 /** Linked list of Exit streams associated with this circuit that are
2206 * still being resolved. */
2207 edge_connection_t
*resolving_streams
;
2208 /** The cipher used by intermediate hops for cells heading toward the
2210 crypto_cipher_env_t
*p_crypto
;
2211 /** The cipher used by intermediate hops for cells heading away from
2213 crypto_cipher_env_t
*n_crypto
;
2215 /** The integrity-checking digest used by intermediate hops, for
2216 * cells packaged here and heading towards the OP.
2218 crypto_digest_env_t
*p_digest
;
2219 /** The integrity-checking digest used by intermediate hops, for
2220 * cells packaged at the OP and arriving here.
2222 crypto_digest_env_t
*n_digest
;
2224 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2225 * is not marked for close. */
2226 struct or_circuit_t
*rend_splice
;
2228 #if REND_COOKIE_LEN >= DIGEST_LEN
2229 #define REND_TOKEN_LEN REND_COOKIE_LEN
2231 #define REND_TOKEN_LEN DIGEST_LEN
2234 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2235 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2237 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2239 char rend_token
[REND_TOKEN_LEN
];
2241 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2242 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2244 /** How many more relay_early cells can we send on this circuit, according
2245 * to the specification? */
2246 unsigned int remaining_relay_early_cells
: 4;
2248 /** True iff this circuit was made with a CREATE_FAST cell. */
2249 unsigned int is_first_hop
: 1;
2251 /** Number of cells that were removed from circuit queue; reset every
2252 * time when writing buffer stats to disk. */
2253 uint32_t processed_cells
;
2255 /** Total time in milliseconds that cells spent in both app-ward and
2256 * exit-ward queues of this circuit; reset every time when writing
2257 * buffer stats to disk. */
2258 uint64_t total_cell_waiting_time
;
2260 /** The EWMA count for the number of cells flushed from the
2261 * p_conn_cells queue. */
2262 cell_ewma_t p_cell_ewma
;
2265 /** Convert a circuit subtype to a circuit_t.*/
2266 #define TO_CIRCUIT(x) (&((x)->_base))
2268 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
2269 * if the cast is impossible. */
2270 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2271 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2272 * Asserts if the cast is impossible. */
2273 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2275 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2277 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2278 return DOWNCAST(or_circuit_t
, x
);
2280 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2282 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2283 return DOWNCAST(origin_circuit_t
, x
);
2286 /** Bitfield type: things that we're willing to use invalid routers for. */
2287 typedef enum invalid_router_usage_t
{
2288 ALLOW_INVALID_ENTRY
=1,
2289 ALLOW_INVALID_EXIT
=2,
2290 ALLOW_INVALID_MIDDLE
=4,
2291 ALLOW_INVALID_RENDEZVOUS
=8,
2292 ALLOW_INVALID_INTRODUCTION
=16,
2293 } invalid_router_usage_t
;
2295 /* limits for TCP send and recv buffer size used for constrained sockets */
2296 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2297 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2299 /** A linked list of lines in a config file. */
2300 typedef struct config_line_t
{
2303 struct config_line_t
*next
;
2306 typedef struct routerset_t routerset_t
;
2308 /** Configuration options for a Tor process. */
2312 /** What should the tor process actually do? */
2314 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2315 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2317 const char *command_arg
; /**< Argument for command-line option. */
2319 config_line_t
*Logs
; /**< New-style list of configuration lines
2322 char *DebugLogFile
; /**< Where to send verbose log messages. */
2323 char *DataDirectory
; /**< OR only: where to store long-term data. */
2324 char *Nickname
; /**< OR only: nickname of this onion router. */
2325 char *Address
; /**< OR only: configured address for this onion router. */
2326 char *PidFile
; /**< Where to store PID of Tor process. */
2328 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2329 * country codes and IP address patterns of ORs to
2330 * consider as exits. */
2331 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2332 * country codes and IP address patterns of ORs to
2333 * consider as entry points. */
2334 int StrictNodes
; /**< Boolean: When none of our EntryNodes or ExitNodes
2335 * are up, or we need to access a node in ExcludeNodes,
2336 * do we just fail instead? */
2337 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2338 * country codes and IP address patterns of ORs
2339 * not to use in circuits. But see StrictNodes
2341 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2342 * country codes and IP address patterns of
2343 * ORs not to consider as exits. */
2345 /** Union of ExcludeNodes and ExcludeExitNodes */
2346 struct routerset_t
*_ExcludeExitNodesUnion
;
2348 int DisableAllSwap
; /**< Boolean: Attempt to call mlockall() on our
2349 * process for all current and future memory. */
2351 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2352 smartlist_t
*AllowInvalidNodes
;
2353 /** Bitmask; derived from AllowInvalidNodes. */
2354 invalid_router_usage_t _AllowInvalid
;
2355 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2356 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2357 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2358 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2359 /** Addresses to bind for listening for SOCKS connections. */
2360 config_line_t
*SocksListenAddress
;
2361 /** Addresses to bind for listening for transparent pf/netfilter
2363 config_line_t
*TransListenAddress
;
2364 /** Addresses to bind for listening for transparent natd connections */
2365 config_line_t
*NatdListenAddress
;
2366 /** Addresses to bind for listening for SOCKS connections. */
2367 config_line_t
*DNSListenAddress
;
2368 /** Addresses to bind for listening for OR connections. */
2369 config_line_t
*ORListenAddress
;
2370 /** Addresses to bind for listening for directory connections. */
2371 config_line_t
*DirListenAddress
;
2372 /** Addresses to bind for listening for control connections. */
2373 config_line_t
*ControlListenAddress
;
2374 /** Local address to bind outbound sockets */
2375 char *OutboundBindAddress
;
2376 /** Directory server only: which versions of
2377 * Tor should we tell users to run? */
2378 config_line_t
*RecommendedVersions
;
2379 config_line_t
*RecommendedClientVersions
;
2380 config_line_t
*RecommendedServerVersions
;
2381 /** Whether dirservers refuse router descriptors with private IPs. */
2382 int DirAllowPrivateAddresses
;
2383 char *User
; /**< Name of user to run Tor as. */
2384 char *Group
; /**< Name of group to run Tor as. */
2385 int ORPort
; /**< Port to listen on for OR connections. */
2386 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2387 /** Port to listen on for transparent pf/netfilter connections. */
2389 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2390 int ControlPort
; /**< Port to listen on for control connections. */
2391 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2392 * for control connections. */
2393 int DirPort
; /**< Port to listen on for directory connections. */
2394 int DNSPort
; /**< Port to listen on for DNS requests. */
2395 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2396 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2397 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2398 * for version 1 directories? */
2399 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2400 * for version 2 directories? */
2401 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2402 * for version 3 directories? */
2403 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2404 * handle hidden service requests? */
2405 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2406 * that's willing to bind names? */
2407 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2408 * directory that's willing to recommend
2410 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2411 * that aggregates bridge descriptors? */
2413 /** If set on a bridge authority, it will answer requests on its dirport
2414 * for bridge statuses -- but only if the requests use this password.
2415 * If set on a bridge user, request bridge statuses, and use this password
2417 char *BridgePassword
;
2419 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2420 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2422 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2423 * this explicit so we can change how we behave in the
2426 /** Boolean: if we know the bridge's digest, should we get new
2427 * descriptors from the bridge authorities or from the bridge itself? */
2428 int UpdateBridgesFromAuthority
;
2430 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2432 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2433 /** Boolean: should we never publish a descriptor? Deprecated. */
2435 /** To what authority types do we publish our descriptor? Choices are
2436 * "v1", "v2", "v3", "bridge", or "". */
2437 smartlist_t
*PublishServerDescriptor
;
2438 /** An authority type, derived from PublishServerDescriptor. */
2439 authority_type_t _PublishServerDescriptor
;
2440 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2441 int PublishHidServDescriptors
;
2442 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2443 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2444 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2446 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2447 * service directories after what time? */
2448 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2449 int AllDirActionsPrivate
; /**< Should every directory action be sent
2450 * through a Tor circuit? */
2452 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2453 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2454 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2455 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2456 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2458 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2459 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2460 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2462 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2463 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2465 /** Whether we should drop exit streams from Tors that we don't know
2466 * are relays. XXX022 In here for 0.2.2.11 as a temporary test before
2467 * we switch over to putting it in consensusparams. -RD */
2468 int RefuseUnknownExits
;
2470 /** Application ports that require all nodes in circ to have sufficient
2472 smartlist_t
*LongLivedPorts
;
2473 /** Application ports that are likely to be unencrypted and
2474 * unauthenticated; we reject requests for them to prevent the
2475 * user from screwing up and leaking plaintext secrets to an
2476 * observer somewhere on the Internet. */
2477 smartlist_t
*RejectPlaintextPorts
;
2478 /** Related to RejectPlaintextPorts above, except this config option
2479 * controls whether we warn (in the log and via a controller status
2480 * event) every time a risky connection is attempted. */
2481 smartlist_t
*WarnPlaintextPorts
;
2482 /** Should we try to reuse the same exit node for a given host */
2483 smartlist_t
*TrackHostExits
;
2484 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2486 config_line_t
*AddressMap
; /**< List of address map directives. */
2487 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2488 * hostname ending with one of the suffixes in
2489 * <b>AutomapHostsSuffixes</b>, map it to a
2490 * virtual address. */
2491 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2492 * <b>AutomapHostsOnResolve</b>. */
2493 int RendPostPeriod
; /**< How often do we post each rendezvous service
2494 * descriptor? Remember to publish them independently. */
2495 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2496 * connections alive? */
2497 int SocksTimeout
; /**< How long do we let a socks connection wait
2498 * unattached before we fail it? */
2499 int LearnCircuitBuildTimeout
; /**< If non-zero, we attempt to learn a value
2500 * for CircuitBuildTimeout based on timeout
2502 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born at
2503 * least this many seconds ago. Used until
2504 * adaptive algorithm learns a new value. */
2505 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2506 * at least this many seconds ago. */
2507 int CircuitStreamTimeout
; /**< If non-zero, detach streams from circuits
2508 * and try a new circuit if the stream has been
2509 * waiting for this many seconds. If zero, use
2510 * our default internal timeout schedule. */
2511 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2512 * to wait simultaneously before we start dropping
2514 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2516 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2517 this interval ago. */
2518 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2519 * to use in a second? */
2520 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2521 * to use in a second? */
2522 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2523 * tell people we have? */
2524 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2525 * willing to use for all relayed conns? */
2526 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2527 * use in a second for all relayed conns? */
2528 uint64_t PerConnBWRate
; /**< Long-term bw on a single TLS conn, if set. */
2529 uint64_t PerConnBWBurst
; /**< Allowed burst on a single TLS conn, if set. */
2530 int NumCpus
; /**< How many CPUs should we try to use? */
2531 int RunTesting
; /**< If true, create testing circuits to measure how well the
2532 * other ORs are running. */
2533 config_line_t
*RendConfigLines
; /**< List of configuration lines
2534 * for rendezvous services. */
2535 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
2536 * authorizations for hidden services */
2537 char *ContactInfo
; /**< Contact info to be published in the directory. */
2539 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2540 tor_addr_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2541 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2542 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2544 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2545 tor_addr_t HttpsProxyAddr
; /**< Parsed addr for https proxy, if any. */
2546 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2547 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2549 char *Socks4Proxy
; /**< hostname:port to use as a SOCKS4 proxy, if any. */
2550 tor_addr_t Socks4ProxyAddr
; /**< Derived from Socks4Proxy. */
2551 uint16_t Socks4ProxyPort
; /**< Derived from Socks4Proxy. */
2553 char *Socks5Proxy
; /**< hostname:port to use as a SOCKS5 proxy, if any. */
2554 tor_addr_t Socks5ProxyAddr
; /**< Derived from Sock5Proxy. */
2555 uint16_t Socks5ProxyPort
; /**< Derived from Socks5Proxy. */
2556 char *Socks5ProxyUsername
; /**< Username for SOCKS5 authentication, if any */
2557 char *Socks5ProxyPassword
; /**< Password for SOCKS5 authentication, if any */
2559 /** List of configuration lines for replacement directory authorities.
2560 * If you just want to replace one class of authority at a time,
2561 * use the "Alternate*Authority" options below instead. */
2562 config_line_t
*DirServers
;
2564 /** If set, use these main (currently v3) directory authorities and
2565 * not the default ones. */
2566 config_line_t
*AlternateDirAuthority
;
2568 /** If set, use these bridge authorities and not the default one. */
2569 config_line_t
*AlternateBridgeAuthority
;
2571 /** If set, use these HS authorities and not the default ones. */
2572 config_line_t
*AlternateHSAuthority
;
2574 char *MyFamily
; /**< Declared family for this OR. */
2575 config_line_t
*NodeFamilies
; /**< List of config lines for
2577 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2578 * mark as bad dir mirrors. */
2579 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2580 * mark as bad exits. */
2581 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2583 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2584 * never mark as valid. */
2585 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2586 * and vote for all other dir mirrors as good. */
2587 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2588 * and vote for all other exits as good. */
2589 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2590 * aren't named in our fingerprint file? */
2591 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2592 * number of servers per IP address. */
2593 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2594 * number of servers per IP address shared
2595 * with an authority. */
2597 char *AccountingStart
; /**< How long is the accounting interval, and when
2599 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2600 * interval before hibernation? 0 for "never
2603 /** Base64-encoded hash of accepted passwords for the control system. */
2604 config_line_t
*HashedControlPassword
;
2605 /** As HashedControlPassword, but not saved. */
2606 config_line_t
*HashedControlSessionPassword
;
2608 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2609 * the control system? */
2610 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2611 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2612 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2613 * circuits itself (0), or does it expect a controller
2615 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2616 * make circuits in the background (0),
2618 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2619 * long do we wait before exiting? */
2620 char *SafeLogging
; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
2622 /* Derived from SafeLogging */
2624 SAFELOG_SCRUB_ALL
, SAFELOG_SCRUB_RELAY
, SAFELOG_SCRUB_NONE
2627 int SafeSocks
; /**< Boolean: should we outright refuse application
2628 * connections that use socks4 or socks5-with-local-dns? */
2629 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2630 LOG_WARN : LOG_INFO)
2631 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2632 * protocol, is it a warn or an info in our logs? */
2633 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2634 * log whether it was DNS-leaking or not? */
2635 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2636 * acceleration where available? */
2637 char *AccelName
; /**< Optional hardware acceleration engine name. */
2638 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
2639 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2640 * of fixed nodes? */
2641 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2642 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2643 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2644 * of our PK time by sending CREATE_FAST cells? */
2645 /** Should we always fetch our dir info on the mirror schedule (which
2646 * means directly from the authorities) no matter our other config? */
2647 int FetchDirInfoEarly
;
2649 /** Should we fetch our dir info at the start of the consensus period? */
2650 int FetchDirInfoExtraEarly
;
2652 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2653 * MAPADDRESS requests. */
2654 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2655 * addresses to be FQDNs, but rather search for them in
2656 * the local domains. */
2657 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2659 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
2660 * DNS poisoning attacks. */
2661 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2662 * resolver from the file here rather than from
2663 * /etc/resolv.conf (Unix) or the registry (Windows). */
2664 char *DirPortFrontPage
; /**< This is a full path to a file with an html
2665 disclaimer. This allows a server administrator to show
2666 that they're running Tor and anyone visiting their server
2667 will know this without any specialized knowledge. */
2668 /** Boolean: if set, we start even if our resolv.conf file is missing
2670 int ServerDNSAllowBrokenConfig
;
2672 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2673 * should be resolvable. Used for
2674 * testing our DNS server. */
2675 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2676 * same network zone in the same circuit. */
2677 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2679 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2680 * support BEGIN_DIR, when possible. */
2681 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2682 * with weird characters. */
2683 /** If true, we try resolving hostnames with weird characters. */
2684 int ServerDNSAllowNonRFC953Hostnames
;
2686 /** If true, we try to download extra-info documents (and we serve them,
2687 * if we are a cache). For authorities, this is always true. */
2688 int DownloadExtraInfo
;
2690 /** If true, and we are acting as a relay, allow exit circuits even when
2691 * we are the first hop of a circuit. */
2692 int AllowSingleHopExits
;
2693 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
2694 * circuits that we build. */
2695 int ExcludeSingleHopRelays
;
2696 /** If true, and the controller tells us to use a one-hop circuit, and the
2697 * exit allows it, we use it. */
2698 int AllowSingleHopCircuits
;
2700 /** If true, we convert "www.google.com.foo.exit" addresses on the
2701 * socks/trans/natd ports into "www.google.com" addresses that
2702 * exit from the node "foo". Disabled by default since attacking
2703 * websites and exit relays can use it to manipulate your path
2707 /** If true, we will warn if a user gives us only an IP address
2708 * instead of a hostname. */
2709 int WarnUnsafeSocks
;
2711 /** If true, the user wants us to collect statistics on clients
2712 * requesting network statuses from us as directory. */
2713 int DirReqStatistics
;
2715 /** If true, the user wants us to collect statistics on port usage. */
2716 int ExitPortStatistics
;
2718 /** If true, the user wants us to collect cell statistics. */
2721 /** If true, the user wants us to collect statistics as entry node. */
2722 int EntryStatistics
;
2724 /** If true, include statistics file contents in extra-info documents. */
2725 int ExtraInfoStatistics
;
2727 /** If true, do not believe anybody who tells us that a domain resolves
2728 * to an internal address, or that an internal address has a PTR mapping.
2729 * Helps avoid some cross-site attacks. */
2730 int ClientDNSRejectInternalAddresses
;
2732 /** The length of time that we think a consensus should be fresh. */
2733 int V3AuthVotingInterval
;
2734 /** The length of time we think it will take to distribute votes. */
2735 int V3AuthVoteDelay
;
2736 /** The length of time we think it will take to distribute signatures. */
2737 int V3AuthDistDelay
;
2738 /** The number of intervals we think a consensus should be valid. */
2739 int V3AuthNIntervalsValid
;
2741 /** Should advertise and sign consensuses with a legacy key, for key
2742 * migration purposes? */
2743 int V3AuthUseLegacyKey
;
2745 /** Location of bandwidth measurement file */
2746 char *V3BandwidthsFile
;
2748 /** Authority only: key=value pairs that we add to our networkstatus
2749 * consensus vote on the 'params' line. */
2750 char *ConsensusParams
;
2752 /** The length of time that we think an initial consensus should be fresh.
2753 * Only altered on testing networks. */
2754 int TestingV3AuthInitialVotingInterval
;
2756 /** The length of time we think it will take to distribute initial votes.
2757 * Only altered on testing networks. */
2758 int TestingV3AuthInitialVoteDelay
;
2760 /** The length of time we think it will take to distribute initial
2761 * signatures. Only altered on testing networks.*/
2762 int TestingV3AuthInitialDistDelay
;
2764 /** If an authority has been around for less than this amount of time, it
2765 * does not believe its reachability information is accurate. Only
2766 * altered on testing networks. */
2767 int TestingAuthDirTimeToLearnReachability
;
2769 /** Clients don't download any descriptor this recent, since it will
2770 * probably not have propagated to enough caches. Only altered on testing
2772 int TestingEstimatedDescriptorPropagationTime
;
2774 /** If true, we take part in a testing network. Change the defaults of a
2775 * couple of other configuration options and allow to change the values
2776 * of certain configuration options. */
2777 int TestingTorNetwork
;
2779 /** File to check for a consensus networkstatus, if we don't have one
2781 char *FallbackNetworkstatusFile
;
2783 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2784 * count of how many client addresses have contacted us so that we can help
2785 * the bridge authority guess which countries have blocked access to us. */
2786 int BridgeRecordUsageByCountry
;
2788 /** Optionally, a file with GeoIP data. */
2791 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
2792 * to make this false. */
2793 int ReloadTorrcOnSIGHUP
;
2795 /* The main parameter for picking circuits within a connection.
2797 * If this value is positive, when picking a cell to relay on a connection,
2798 * we always relay from the circuit whose weighted cell count is lowest.
2799 * Cells are weighted exponentially such that if one cell is sent
2800 * 'CircuitPriorityHalflife' seconds before another, it counts for half as
2803 * If this value is zero, we're disabling the cell-EWMA algorithm.
2805 * If this value is negative, we're using the default approach
2806 * according to either Tor or a parameter set in the consensus.
2808 double CircuitPriorityHalflife
;
2812 /** Persistent state for an onion router, as saved to disk. */
2815 /** The time at which we next plan to write the state to the disk. Equal to
2816 * TIME_MAX if there are no savable changes, 0 if there are changes that
2817 * should be saved right away. */
2820 /** When was the state last written to disk? */
2823 /** Fields for accounting bandwidth use. */
2824 time_t AccountingIntervalStart
;
2825 uint64_t AccountingBytesReadInInterval
;
2826 uint64_t AccountingBytesWrittenInInterval
;
2827 int AccountingSecondsActive
;
2828 uint64_t AccountingExpectedUsage
;
2830 /** A list of Entry Guard-related configuration lines. */
2831 config_line_t
*EntryGuards
;
2833 /** These fields hold information on the history of bandwidth usage for
2834 * servers. The "Ends" fields hold the time when we last updated the
2835 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2836 * of the entries of Values. The "Values" lists hold decimal string
2837 * representations of the number of bytes read or written in each
2839 time_t BWHistoryReadEnds
;
2840 int BWHistoryReadInterval
;
2841 smartlist_t
*BWHistoryReadValues
;
2842 time_t BWHistoryWriteEnds
;
2843 int BWHistoryWriteInterval
;
2844 smartlist_t
*BWHistoryWriteValues
;
2845 time_t BWHistoryDirReadEnds
;
2846 int BWHistoryDirReadInterval
;
2847 smartlist_t
*BWHistoryDirReadValues
;
2848 time_t BWHistoryDirWriteEnds
;
2849 int BWHistoryDirWriteInterval
;
2850 smartlist_t
*BWHistoryDirWriteValues
;
2852 /** Build time histogram */
2853 config_line_t
* BuildtimeHistogram
;
2854 unsigned int TotalBuildTimes
;
2855 unsigned int CircuitBuildAbandonedCount
;
2857 /** What version of Tor wrote this state file? */
2860 /** Holds any unrecognized values we found in the state file, in the order
2861 * in which we found them. */
2862 config_line_t
*ExtraLines
;
2864 /** When did we last rotate our onion key? "0" for 'no idea'. */
2865 time_t LastRotatedOnionKey
;
2868 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2869 * state is already scheduled to be written to disk earlier than <b>when</b>.
2871 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2873 if (state
->next_write
> when
)
2874 state
->next_write
= when
;
2877 #define MAX_SOCKS_REPLY_LEN 1024
2878 #define MAX_SOCKS_ADDR_LEN 256
2880 /** Please open a TCP connection to this addr:port. */
2881 #define SOCKS_COMMAND_CONNECT 0x01
2882 /** Please turn this FQDN into an IP address, privately. */
2883 #define SOCKS_COMMAND_RESOLVE 0xF0
2884 /** Please turn this IP address into an FQDN, privately. */
2885 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2887 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2888 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2889 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2891 /** State of a SOCKS request from a user to an OP. Also used to encode other
2892 * information for non-socks user request (such as those on TransPort and
2894 struct socks_request_t
{
2895 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2896 * 0 means that no socks handshake ever took place, and this is just a
2897 * stub connection (e.g. see connection_ap_make_link()). */
2899 int command
; /**< What is this stream's goal? One from the above list. */
2900 size_t replylen
; /**< Length of <b>reply</b>. */
2901 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2902 * we want to specify our own socks reply,
2903 * rather than using the default socks4 or
2904 * socks5 socks reply. We use this for the
2905 * two-stage socks5 handshake.
2907 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2908 connect to/resolve? */
2909 uint16_t port
; /**< What port did the client ask to connect to? */
2910 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2911 * make sure we send back a socks reply for
2912 * every connection. */
2915 /* all the function prototypes go here */
2917 /********************************* circuitbuild.c **********************/
2919 /** How many hops does a general-purpose circuit have by default? */
2920 #define DEFAULT_ROUTE_LEN 3
2922 /* Circuit Build Timeout "public" structures. */
2924 /** Total size of the circuit timeout history to accumulate.
2925 * 1000 is approx 2.5 days worth of continual-use circuits. */
2926 #define CBT_NCIRCUITS_TO_OBSERVE 1000
2928 /** Width of the histogram bins in milliseconds */
2929 #define CBT_BIN_WIDTH ((build_time_t)50)
2931 /** Number of modes to use in the weighted-avg computation of Xm */
2932 #define CBT_DEFAULT_NUM_XM_MODES 3
2934 /** A build_time_t is milliseconds */
2935 typedef uint32_t build_time_t
;
2938 * CBT_BUILD_ABANDONED is our flag value to represent a force-closed
2939 * circuit (Aka a 'right-censored' pareto value).
2941 #define CBT_BUILD_ABANDONED ((build_time_t)(INT32_MAX-1))
2942 #define CBT_BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
2944 /** Save state every 10 circuits */
2945 #define CBT_SAVE_STATE_EVERY 10
2947 /* Circuit Build Timeout network liveness constants */
2950 * Have we received a cell in the last N circ attempts?
2952 * This tells us when to temporarily switch back to
2953 * BUILD_TIMEOUT_INITIAL_VALUE until we start getting cells,
2954 * at which point we switch back to computing the timeout from
2955 * our saved history.
2957 #define CBT_NETWORK_NONLIVE_TIMEOUT_COUNT 3
2960 * This tells us when to toss out the last streak of N timeouts.
2962 * If instead we start getting cells, we switch back to computing the timeout
2963 * from our saved history.
2965 #define CBT_NETWORK_NONLIVE_DISCARD_COUNT (CBT_NETWORK_NONLIVE_TIMEOUT_COUNT*2)
2967 /* Circuit build times consensus parameters */
2970 * How long to wait before actually closing circuits that take too long to
2971 * build in terms of CDF quantile.
2973 #define CBT_DEFAULT_CLOSE_QUANTILE 95
2976 * How many circuits count as recent when considering if the
2977 * connection has gone gimpy or changed.
2979 #define CBT_DEFAULT_RECENT_CIRCUITS 20
2982 * Maximum count of timeouts that finish the first hop in the past
2983 * RECENT_CIRCUITS before calculating a new timeout.
2985 * This tells us to abandon timeout history and set
2986 * the timeout back to BUILD_TIMEOUT_INITIAL_VALUE.
2988 #define CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT (CBT_DEFAULT_RECENT_CIRCUITS*9/10)
2990 /** Minimum circuits before estimating a timeout */
2991 #define CBT_DEFAULT_MIN_CIRCUITS_TO_OBSERVE 100
2993 /** Cutoff percentile on the CDF for our timeout estimation. */
2994 #define CBT_DEFAULT_QUANTILE_CUTOFF 80
2995 double circuit_build_times_quantile_cutoff(void);
2997 /** How often in seconds should we build a test circuit */
2998 #define CBT_DEFAULT_TEST_FREQUENCY 60
3000 /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
3001 #define CBT_DEFAULT_TIMEOUT_MIN_VALUE (2*1000)
3003 /** Initial circuit build timeout in milliseconds */
3004 #define CBT_DEFAULT_TIMEOUT_INITIAL_VALUE (60*1000)
3005 int32_t circuit_build_times_initial_timeout(void);
3007 #if CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT < 1 || \
3008 CBT_NETWORK_NONLIVE_DISCARD_COUNT < 1 || \
3009 CBT_NETWORK_NONLIVE_TIMEOUT_COUNT < 1
3010 #error "RECENT_CIRCUITS is set too low."
3013 /** Information about the state of our local network connection */
3015 /** The timestamp we last completed a TLS handshake or received a cell */
3016 time_t network_last_live
;
3017 /** If the network is not live, how many timeouts has this caused? */
3018 int nonlive_timeouts
;
3019 /** If the network is not live, have we yet discarded our history? */
3020 int nonlive_discarded
;
3021 /** Circular array of circuits that have made it to the first hop. Slot is
3022 * 1 if circuit timed out, 0 if circuit succeeded */
3023 int8_t *timeouts_after_firsthop
;
3024 /** Number of elements allocated for the above array */
3025 int num_recent_circs
;
3026 /** Index into circular array. */
3027 int after_firsthop_idx
;
3028 /** Timeout gathering is suspended if non-zero. The old timeout value
3029 * is stored here in that case. */
3030 double suspended_timeout
;
3031 /** Timeout gathering is suspended if non-zero. The old close value
3032 * is stored here in that case. */
3033 double suspended_close_timeout
;
3034 } network_liveness_t
;
3036 /** Structure for circuit build times history */
3038 /** The circular array of recorded build times in milliseconds */
3039 build_time_t circuit_build_times
[CBT_NCIRCUITS_TO_OBSERVE
];
3040 /** Current index in the circuit_build_times circular array */
3041 int build_times_idx
;
3042 /** Total number of build times accumulated. Max CBT_NCIRCUITS_TO_OBSERVE */
3043 int total_build_times
;
3044 /** Information about the state of our local network connection */
3045 network_liveness_t liveness
;
3046 /** Last time we built a circuit. Used to decide to build new test circs */
3047 time_t last_circ_at
;
3048 /** "Minimum" value of our pareto distribution (actually mode) */
3050 /** alpha exponent for pareto dist. */
3052 /** Have we computed a timeout? */
3053 int have_computed_timeout
;
3054 /** The exact value for that timeout in milliseconds. Stored as a double
3055 * to maintain precision from calculations to and from quantile value. */
3057 /** How long we wait before actually closing the circuit. */
3059 } circuit_build_times_t
;
3061 /********************************* config.c ***************************/
3063 /** An error from options_trial_assign() or options_init_from_string(). */
3064 typedef enum setopt_err_t
{
3066 SETOPT_ERR_MISC
= -1,
3067 SETOPT_ERR_PARSE
= -2,
3068 SETOPT_ERR_TRANSITION
= -3,
3069 SETOPT_ERR_SETTING
= -4,
3072 /********************************* connection_edge.c *************************/
3074 /** Enumerates possible origins of a client-side address mapping. */
3076 /** We're remapping this address because the controller told us to. */
3077 ADDRMAPSRC_CONTROLLER
,
3078 /** We're remapping this address because our configuration (via torrc, the
3079 * command line, or a SETCONF command) told us to. */
3081 /** We're remapping this address because we have TrackHostExit configured,
3082 * and we want to remember to use the same exit next time. */
3083 ADDRMAPSRC_TRACKEXIT
,
3084 /** We're remapping this address because we got a DNS resolution from a
3085 * Tor server that told us what its value was. */
3087 } addressmap_entry_source_t
;
3089 /********************************* control.c ***************************/
3091 /** Used to indicate the type of a circuit event passed to the controller.
3092 * The various types are defined in control-spec.txt */
3093 typedef enum circuit_status_event_t
{
3094 CIRC_EVENT_LAUNCHED
= 0,
3095 CIRC_EVENT_BUILT
= 1,
3096 CIRC_EVENT_EXTENDED
= 2,
3097 CIRC_EVENT_FAILED
= 3,
3098 CIRC_EVENT_CLOSED
= 4,
3099 } circuit_status_event_t
;
3101 /** Used to indicate the type of a stream event passed to the controller.
3102 * The various types are defined in control-spec.txt */
3103 typedef enum stream_status_event_t
{
3104 STREAM_EVENT_SENT_CONNECT
= 0,
3105 STREAM_EVENT_SENT_RESOLVE
= 1,
3106 STREAM_EVENT_SUCCEEDED
= 2,
3107 STREAM_EVENT_FAILED
= 3,
3108 STREAM_EVENT_CLOSED
= 4,
3109 STREAM_EVENT_NEW
= 5,
3110 STREAM_EVENT_NEW_RESOLVE
= 6,
3111 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3112 STREAM_EVENT_REMAP
= 8
3113 } stream_status_event_t
;
3115 /** Used to indicate the type of an OR connection event passed to the
3116 * controller. The various types are defined in control-spec.txt */
3117 typedef enum or_conn_status_event_t
{
3118 OR_CONN_EVENT_LAUNCHED
= 0,
3119 OR_CONN_EVENT_CONNECTED
= 1,
3120 OR_CONN_EVENT_FAILED
= 2,
3121 OR_CONN_EVENT_CLOSED
= 3,
3122 OR_CONN_EVENT_NEW
= 4,
3123 } or_conn_status_event_t
;
3125 /** Used to indicate the type of a buildtime event */
3126 typedef enum buildtimeout_set_event_t
{
3127 BUILDTIMEOUT_SET_EVENT_COMPUTED
= 0,
3128 BUILDTIMEOUT_SET_EVENT_RESET
= 1,
3129 BUILDTIMEOUT_SET_EVENT_SUSPENDED
= 2,
3130 BUILDTIMEOUT_SET_EVENT_DISCARD
= 3,
3131 BUILDTIMEOUT_SET_EVENT_RESUME
= 4
3132 } buildtimeout_set_event_t
;
3134 /** Execute the statement <b>stmt</b>, which may log events concerning the
3135 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3136 * being sent to controllers if <b>conn</b> is a control connection.
3138 * Stmt must not contain any return or goto statements.
3140 #define CONN_LOG_PROTECT(conn, stmt) \
3142 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3143 if (_log_conn_is_control) \
3144 disable_control_logging(); \
3145 STMT_BEGIN stmt; STMT_END; \
3146 if (_log_conn_is_control) \
3147 enable_control_logging(); \
3150 /** Enum describing various stages of bootstrapping, for use with controller
3151 * bootstrap status events. The values range from 0 to 100. */
3153 BOOTSTRAP_STATUS_UNDEF
=-1,
3154 BOOTSTRAP_STATUS_STARTING
=0,
3155 BOOTSTRAP_STATUS_CONN_DIR
=5,
3156 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3157 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3158 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3159 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3160 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3161 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3162 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3163 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3164 BOOTSTRAP_STATUS_CONN_OR
=80,
3165 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3166 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3167 BOOTSTRAP_STATUS_DONE
=100
3168 } bootstrap_status_t
;
3170 /********************************* directory.c ***************************/
3172 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
3174 char first
[DIGEST_LEN
];
3175 char second
[DIGEST_LEN
];
3178 /********************************* dirserv.c ***************************/
3180 NS_V2
, NS_V3_CONSENSUS
, NS_V3_VOTE
, NS_CONTROL_PORT
,
3181 NS_V3_CONSENSUS_MICRODESC
3182 } routerstatus_format_type_t
;
3184 #ifdef DIRSERV_PRIVATE
3185 typedef struct measured_bw_line_t
{
3186 char node_id
[DIGEST_LEN
];
3187 char node_hex
[MAX_HEX_NICKNAME_LEN
+1];
3189 } measured_bw_line_t
;
3193 /********************************* dirvote.c ************************/
3195 /** Describes the schedule by which votes should be generated. */
3196 typedef struct vote_timing_t
{
3198 int n_intervals_valid
;
3203 /********************************* geoip.c **************************/
3205 /** Round all GeoIP results to the next multiple of this value, to avoid
3206 * leaking information. */
3207 #define DIR_RECORD_USAGE_GRANULARITY 8
3208 /** Time interval: Flush geoip data to disk this often. */
3209 #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
3210 /** How long do we have to have observed per-country request history before
3211 * we are willing to talk about it? */
3212 #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
3214 /** Indicates an action that we might be noting geoip statistics on.
3215 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3216 * the others, we're not.
3219 /** We've noticed a connection as a bridge relay or entry guard. */
3220 GEOIP_CLIENT_CONNECT
= 0,
3221 /** We've served a networkstatus consensus as a directory server. */
3222 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3223 /** We've served a v2 networkstatus consensus as a directory server. */
3224 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3225 } geoip_client_action_t
;
3226 /** Indicates either a positive reply or a reason for rejectng a network
3227 * status request that will be included in geoip statistics. */
3229 /** Request is answered successfully. */
3231 /** V3 network status is not signed by a sufficient number of requested
3233 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
3234 /** Requested network status object is unavailable. */
3235 GEOIP_REJECT_UNAVAILABLE
= 2,
3236 /** Requested network status not found. */
3237 GEOIP_REJECT_NOT_FOUND
= 3,
3238 /** Network status has not been modified since If-Modified-Since time. */
3239 GEOIP_REJECT_NOT_MODIFIED
= 4,
3240 /** Directory is busy. */
3241 GEOIP_REJECT_BUSY
= 5,
3242 } geoip_ns_response_t
;
3243 #define GEOIP_NS_RESPONSE_NUM 6
3245 /** Directory requests that we are measuring can be either direct or
3249 DIRREQ_TUNNELED
= 1,
3252 /** Possible states for either direct or tunneled directory requests that
3253 * are relevant for determining network status download times. */
3255 /** Found that the client requests a network status; applies to both
3256 * direct and tunneled requests; initial state of a request that we are
3258 DIRREQ_IS_FOR_NETWORK_STATUS
= 0,
3259 /** Finished writing a network status to the directory connection;
3260 * applies to both direct and tunneled requests; completes a direct
3262 DIRREQ_FLUSHING_DIR_CONN_FINISHED
= 1,
3263 /** END cell sent to circuit that initiated a tunneled request. */
3264 DIRREQ_END_CELL_SENT
= 2,
3265 /** Flushed last cell from queue of the circuit that initiated a
3266 * tunneled request to the outbuf of the OR connection. */
3267 DIRREQ_CIRC_QUEUE_FLUSHED
= 3,
3268 /** Flushed last byte from buffer of the OR connection belonging to the
3269 * circuit that initiated a tunneled request; completes a tunneled
3271 DIRREQ_OR_CONN_BUFFER_FLUSHED
= 4
3274 #define WRITE_STATS_INTERVAL (24*60*60)
3276 /********************************* microdesc.c *************************/
3278 typedef struct microdesc_cache_t microdesc_cache_t
;
3280 /********************************* networkstatus.c *********************/
3282 /** Location where we found a v2 networkstatus. */
3284 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3285 } v2_networkstatus_source_t
;
3287 /** Possible statuses of a version of Tor, given opinions from the directory
3289 typedef enum version_status_t
{
3290 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3291 VS_OLD
=1, /**< This version is older than any recommended version. */
3292 VS_NEW
=2, /**< This version is newer than any recommended version. */
3293 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3294 * in its series, but later recommended versions exist.
3296 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
3297 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
3298 VS_UNKNOWN
, /**< We have no idea. */
3301 /********************************* policies.c ************************/
3303 /** Outcome of applying an address policy to an address. */
3305 /** The address was accepted */
3306 ADDR_POLICY_ACCEPTED
=0,
3307 /** The address was rejected */
3308 ADDR_POLICY_REJECTED
=-1,
3309 /** Part of the address was unknown, but as far as we can tell, it was
3311 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3312 /** Part of the address was unknown, but as far as we can tell, it was
3314 ADDR_POLICY_PROBABLY_REJECTED
=2
3315 } addr_policy_result_t
;
3317 /********************************* rephist.c ***************************/
3319 /** Possible public/private key operations in Tor: used to keep track of where
3320 * we're spending our time. */
3323 VERIFY_DIR
, VERIFY_RTR
,
3324 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
3325 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
3326 REND_CLIENT
, REND_MID
, REND_SERVER
,
3329 /********************************* rendcommon.c ***************************/
3331 /** Hidden-service side configuration of client authorization. */
3332 typedef struct rend_authorized_client_t
{
3334 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
3335 crypto_pk_env_t
*client_key
;
3336 } rend_authorized_client_t
;
3338 /** ASCII-encoded v2 hidden service descriptor. */
3339 typedef struct rend_encoded_v2_service_descriptor_t
{
3340 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
3341 char *desc_str
; /**< Descriptor string. */
3342 } rend_encoded_v2_service_descriptor_t
;
3344 /** Introduction point information. */
3345 typedef struct rend_intro_point_t
{
3346 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
3347 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
3348 * key, if this descriptor is V2. */
3349 } rend_intro_point_t
;
3351 /** Information used to connect to a hidden service. */
3352 typedef struct rend_service_descriptor_t
{
3353 crypto_pk_env_t
*pk
; /**< This service's public key. */
3354 int version
; /**< Version of the descriptor format: 0 or 2. */
3355 time_t timestamp
; /**< Time when the descriptor was generated. */
3356 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
3357 * (We allow bits '0', '1', and '2' to be set.) */
3358 /** List of the service's introduction points. Elements are removed if
3359 * introduction attempts fail. */
3360 smartlist_t
*intro_nodes
;
3361 /** Has descriptor been uploaded to all hidden service directories? */
3362 int all_uploads_performed
;
3363 /** List of hidden service directories to which an upload request for
3364 * this descriptor could be sent. Smartlist exists only when at least one
3365 * of the previous upload requests failed (otherwise it's not important
3366 * to know which uploads succeeded and which not). */
3367 smartlist_t
*successful_uploads
;
3368 } rend_service_descriptor_t
;
3370 /** A cached rendezvous descriptor. */
3371 typedef struct rend_cache_entry_t
{
3372 size_t len
; /**< Length of <b>desc</b> */
3373 time_t received
; /**< When was the descriptor received? */
3374 char *desc
; /**< Service descriptor */
3375 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
3376 } rend_cache_entry_t
;
3378 /********************************* routerlist.c ***************************/
3380 /** Represents information about a single trusted directory server. */
3381 typedef struct trusted_dir_server_t
{
3384 char *address
; /**< Hostname. */
3385 uint32_t addr
; /**< IPv4 address. */
3386 uint16_t dir_port
; /**< Directory port. */
3387 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
3388 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
3389 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
3390 * high-security) identity key. */
3392 unsigned int is_running
:1; /**< True iff we think this server is running. */
3394 /** True iff this server has accepted the most recent server descriptor
3395 * we tried to upload to it. */
3396 unsigned int has_accepted_serverdesc
:1;
3398 /** What kind of authority is this? (Bitfield.) */
3399 authority_type_t type
;
3401 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
3402 * v2 network status. */
3403 time_t addr_current_at
; /**< When was the document that we derived the
3404 * address information from published? */
3406 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
3407 * dir_server_t to directory_initiate_command_*
3408 * as a routerstatus_t. Not updated by the
3409 * router-status management code!
3411 } trusted_dir_server_t
;
3413 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
3415 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
3417 /* Flags for pick_directory_server and pick_trusteddirserver. */
3418 /** Flag to indicate that we should not automatically be willing to use
3419 * ourself to answer a directory request.
3420 * Passed to router_pick_directory_server (et al).*/
3421 #define PDS_ALLOW_SELF (1<<0)
3422 /** Flag to indicate that if no servers seem to be up, we should mark all
3423 * directory servers as up and try again.
3424 * Passed to router_pick_directory_server (et al).*/
3425 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
3426 /** Flag to indicate that we should not exclude directory servers that
3427 * our ReachableAddress settings would exclude. This usually means that
3428 * we're going to connect to the server over Tor, and so we don't need to
3429 * worry about our firewall telling us we can't.
3430 * Passed to router_pick_directory_server (et al).*/
3431 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
3432 /** Flag to indicate that we should not use any directory authority to which
3433 * we have an existing directory connection for downloading server descriptors
3434 * or extrainfo documents.
3436 * Passed to router_pick_directory_server (et al)
3438 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
3439 * not pick_directory_server. If we make it work on pick_directory_server
3440 * too, we could conservatively make it only prevent multiple fetches to
3441 * the same authority, or we could aggressively make it prevent multiple
3442 * fetches to _any_ single directory server.]
3444 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
3445 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
3447 /** Possible ways to weight routers when choosing one randomly. See
3448 * routerlist_sl_choose_by_bandwidth() for more information.*/
3449 typedef enum bandwidth_weight_rule_t
{
3450 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_MID
, WEIGHT_FOR_GUARD
,
3452 } bandwidth_weight_rule_t
;
3454 /** Flags to be passed to control router_choose_random_node() to indicate what
3455 * kind of nodes to pick according to what algorithm. */
3457 CRN_NEED_UPTIME
= 1<<0,
3458 CRN_NEED_CAPACITY
= 1<<1,
3459 CRN_NEED_GUARD
= 1<<2,
3460 CRN_ALLOW_INVALID
= 1<<3,
3461 /* XXXX not used, apparently. */
3462 CRN_WEIGHT_AS_EXIT
= 1<<5
3463 } router_crn_flags_t
;
3465 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
3466 typedef enum was_router_added_t
{
3467 ROUTER_ADDED_SUCCESSFULLY
= 1,
3468 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
3470 ROUTER_WAS_NOT_NEW
= -2,
3471 ROUTER_NOT_IN_CONSENSUS
= -3,
3472 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
3473 ROUTER_AUTHDIR_REJECTS
= -5,
3474 } was_router_added_t
;
3476 /********************************* routerparse.c ************************/
3478 #define MAX_STATUS_TAG_LEN 32
3479 /** Structure to hold parsed Tor versions. This is a little messier
3480 * than we would like it to be, because we changed version schemes with 0.1.0.
3482 * See version-spec.txt for the whole business.
3484 typedef struct tor_version_t
{
3488 /** Release status. For version in the post-0.1 format, this is always
3490 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
3492 char status_tag
[MAX_STATUS_TAG_LEN
];
3496 char git_tag
[DIGEST_LEN
];