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-2015, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Master header file for Tor-specific functionality.
17 #if defined(__clang_analyzer__) || defined(__COVERITY__)
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
34 #ifdef HAVE_SYS_PARAM_H
35 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
38 #ifdef HAVE_SYS_FCNTL_H
39 #include <sys/fcntl.h>
44 #ifdef HAVE_SYS_IOCTL_H
45 #include <sys/ioctl.h>
50 #ifdef HAVE_SYS_STAT_H
53 #ifdef HAVE_NETINET_IN_H
54 #include <netinet/in.h>
56 #ifdef HAVE_ARPA_INET_H
57 #include <arpa/inet.h>
77 #ifdef USE_BUFFEREVENTS
78 #include <event2/bufferevent.h>
79 #include <event2/buffer.h>
80 #include <event2/util.h>
84 #include "crypto_format.h"
87 #include "container.h"
90 #include "compat_libevent.h"
92 #include "replaycache.h"
93 #include "crypto_curve25519.h"
94 #include "crypto_ed25519.h"
95 #include "tor_queue.h"
96 #include "util_format.h"
98 /* These signals are defined to help handle_control_signal work.
115 /* Controller signals start at a high number so we don't
116 * conflict with system-defined signals. */
117 #define SIGNEWNYM 129
118 #define SIGCLEARDNSCACHE 130
119 #define SIGHEARTBEAT 131
121 #if (SIZEOF_CELL_T != 0)
122 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
123 * that our stuff always calls cell_t something different. */
124 #define cell_t tor_cell_t
127 #ifdef ENABLE_TOR2WEB_MODE
128 #define NON_ANONYMOUS_MODE_ENABLED 1
131 /** Length of longest allowable configured nickname. */
132 #define MAX_NICKNAME_LEN 19
133 /** Length of a router identity encoded as a hexadecimal digest, plus
134 * possible dollar sign. */
135 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
136 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
137 * equal sign or tilde, nickname. */
138 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
140 /** Maximum size, in bytes, for resized buffers. */
141 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
142 /** Maximum size, in bytes, for any directory object that we've downloaded. */
143 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
145 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
146 * of an HTTP request or response. */
147 #define MAX_HEADERS_SIZE 50000
148 /** Maximum size, in bytes, for any directory object that we're accepting
150 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
152 /** Maximum size, in bytes, of a single router descriptor uploaded to us
153 * as a directory authority. Caches and clients fetch whatever descriptors
154 * the authorities tell them to fetch, and don't care about size. */
155 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
157 /** Maximum size of a single extrainfo document, as above. */
158 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
160 /** How long do we keep DNS cache entries before purging them (regardless of
162 #define MAX_DNS_ENTRY_AGE (30*60)
163 /** How long do we cache/tell clients to cache DNS records when no TTL is
165 #define DEFAULT_DNS_TTL (30*60)
166 /** How long can a TTL be before we stop believing it? */
167 #define MAX_DNS_TTL (3*60*60)
168 /** How small can a TTL be before we stop believing it? Provides rudimentary
170 #define MIN_DNS_TTL 60
172 /** How often do we rotate onion keys? */
173 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
174 /** How often do we rotate TLS contexts? */
175 #define MAX_SSL_KEY_LIFETIME_INTERNAL (2*60*60)
177 /** How old do we allow a router to get before removing it
178 * from the router list? In seconds. */
179 #define ROUTER_MAX_AGE (60*60*48)
180 /** How old can a router get before we (as a server) will no longer
181 * consider it live? In seconds. */
182 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*24)
183 /** How old do we let a saved descriptor get before force-removing it? */
184 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
186 /** Possible rules for generating circuit IDs on an OR connection. */
188 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
189 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
190 /** The other side of a connection is an OP: never create circuits to it,
191 * and let it use any circuit ID it wants. */
192 CIRC_ID_TYPE_NEITHER
=2
194 #define circ_id_type_bitfield_t ENUM_BF(circ_id_type_t)
196 #define CONN_TYPE_MIN_ 3
197 /** Type for sockets listening for OR connections. */
198 #define CONN_TYPE_OR_LISTENER 3
199 /** A bidirectional TLS connection transmitting a sequence of cells.
200 * May be from an OR to an OR, or from an OP to an OR. */
201 #define CONN_TYPE_OR 4
202 /** A TCP connection from an onion router to a stream's destination. */
203 #define CONN_TYPE_EXIT 5
204 /** Type for sockets listening for SOCKS connections. */
205 #define CONN_TYPE_AP_LISTENER 6
206 /** A SOCKS proxy connection from the user application to the onion
208 #define CONN_TYPE_AP 7
209 /** Type for sockets listening for HTTP connections to the directory server. */
210 #define CONN_TYPE_DIR_LISTENER 8
211 /** Type for HTTP connections to the directory server. */
212 #define CONN_TYPE_DIR 9
213 /* Type 10 is unused. */
214 /** Type for listening for connections from user interface process. */
215 #define CONN_TYPE_CONTROL_LISTENER 11
216 /** Type for connections from user interface process. */
217 #define CONN_TYPE_CONTROL 12
218 /** Type for sockets listening for transparent connections redirected by pf or
220 #define CONN_TYPE_AP_TRANS_LISTENER 13
221 /** Type for sockets listening for transparent connections redirected by
223 #define CONN_TYPE_AP_NATD_LISTENER 14
224 /** Type for sockets listening for DNS requests. */
225 #define CONN_TYPE_AP_DNS_LISTENER 15
227 /** Type for connections from the Extended ORPort. */
228 #define CONN_TYPE_EXT_OR 16
229 /** Type for sockets listening for Extended ORPort connections. */
230 #define CONN_TYPE_EXT_OR_LISTENER 17
232 #define CONN_TYPE_MAX_ 17
233 /* !!!! If _CONN_TYPE_MAX is ever over 31, we must grow the type field in
236 /* Proxy client types */
238 #define PROXY_CONNECT 1
239 #define PROXY_SOCKS4 2
240 #define PROXY_SOCKS5 3
241 /* !!!! If there is ever a PROXY_* type over 3, we must grow the proxy_type
242 * field in or_connection_t */
244 /* Pluggable transport proxy type. Don't use this in or_connection_t,
245 * instead use the actual underlying proxy type (see above). */
246 #define PROXY_PLUGGABLE 4
248 /* Proxy client handshake states */
249 /* We use a proxy but we haven't even connected to it yet. */
250 #define PROXY_INFANT 1
251 /* We use an HTTP proxy and we've sent the CONNECT command. */
252 #define PROXY_HTTPS_WANT_CONNECT_OK 2
253 /* We use a SOCKS4 proxy and we've sent the CONNECT command. */
254 #define PROXY_SOCKS4_WANT_CONNECT_OK 3
255 /* We use a SOCKS5 proxy and we try to negotiate without
256 any authentication . */
257 #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 4
258 /* We use a SOCKS5 proxy and we try to negotiate with
259 Username/Password authentication . */
260 #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 5
261 /* We use a SOCKS5 proxy and we just sent our credentials. */
262 #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 6
263 /* We use a SOCKS5 proxy and we just sent our CONNECT command. */
264 #define PROXY_SOCKS5_WANT_CONNECT_OK 7
265 /* We use a proxy and we CONNECTed successfully!. */
266 #define PROXY_CONNECTED 8
268 /** True iff <b>x</b> is an edge connection. */
269 #define CONN_IS_EDGE(x) \
270 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
272 /** State for any listener connection. */
273 #define LISTENER_STATE_READY 0
275 #define OR_CONN_STATE_MIN_ 1
276 /** State for a connection to an OR: waiting for connect() to finish. */
277 #define OR_CONN_STATE_CONNECTING 1
278 /** State for a connection to an OR: waiting for proxy handshake to complete */
279 #define OR_CONN_STATE_PROXY_HANDSHAKING 2
280 /** State for an OR connection client: SSL is handshaking, not done
282 #define OR_CONN_STATE_TLS_HANDSHAKING 3
283 /** State for a connection to an OR: We're doing a second SSL handshake for
284 * renegotiation purposes. (V2 handshake only.) */
285 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
286 /** State for a connection at an OR: We're waiting for the client to
287 * renegotiate (to indicate a v2 handshake) or send a versions cell (to
288 * indicate a v3 handshake) */
289 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
290 /** State for an OR connection: We're done with our SSL handshake, we've done
291 * renegotiation, but we haven't yet negotiated link protocol versions and
292 * sent a netinfo cell. */
293 #define OR_CONN_STATE_OR_HANDSHAKING_V2 6
294 /** State for an OR connection: We're done with our SSL handshake, but we
295 * haven't yet negotiated link protocol versions, done a V3 handshake, and
296 * sent a netinfo cell. */
297 #define OR_CONN_STATE_OR_HANDSHAKING_V3 7
298 /** State for an OR connection: Ready to send/receive cells. */
299 #define OR_CONN_STATE_OPEN 8
300 #define OR_CONN_STATE_MAX_ 8
302 /** States of the Extended ORPort protocol. Be careful before changing
303 * the numbers: they matter. */
304 #define EXT_OR_CONN_STATE_MIN_ 1
305 /** Extended ORPort authentication is waiting for the authentication
306 * type selected by the client. */
307 #define EXT_OR_CONN_STATE_AUTH_WAIT_AUTH_TYPE 1
308 /** Extended ORPort authentication is waiting for the client nonce. */
309 #define EXT_OR_CONN_STATE_AUTH_WAIT_CLIENT_NONCE 2
310 /** Extended ORPort authentication is waiting for the client hash. */
311 #define EXT_OR_CONN_STATE_AUTH_WAIT_CLIENT_HASH 3
312 #define EXT_OR_CONN_STATE_AUTH_MAX 3
313 /** Authentication finished and the Extended ORPort is now accepting
315 #define EXT_OR_CONN_STATE_OPEN 4
316 /** Extended ORPort is flushing its last messages and preparing to
317 * start accepting OR connections. */
318 #define EXT_OR_CONN_STATE_FLUSHING 5
319 #define EXT_OR_CONN_STATE_MAX_ 5
321 #define EXIT_CONN_STATE_MIN_ 1
322 /** State for an exit connection: waiting for response from DNS farm. */
323 #define EXIT_CONN_STATE_RESOLVING 1
324 /** State for an exit connection: waiting for connect() to finish. */
325 #define EXIT_CONN_STATE_CONNECTING 2
326 /** State for an exit connection: open and ready to transmit data. */
327 #define EXIT_CONN_STATE_OPEN 3
328 /** State for an exit connection: waiting to be removed. */
329 #define EXIT_CONN_STATE_RESOLVEFAILED 4
330 #define EXIT_CONN_STATE_MAX_ 4
332 /* The AP state values must be disjoint from the EXIT state values. */
333 #define AP_CONN_STATE_MIN_ 5
334 /** State for a SOCKS connection: waiting for SOCKS request. */
335 #define AP_CONN_STATE_SOCKS_WAIT 5
336 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
337 * rendezvous descriptor. */
338 #define AP_CONN_STATE_RENDDESC_WAIT 6
339 /** The controller will attach this connection to a circuit; it isn't our
341 #define AP_CONN_STATE_CONTROLLER_WAIT 7
342 /** State for a SOCKS connection: waiting for a completed circuit. */
343 #define AP_CONN_STATE_CIRCUIT_WAIT 8
344 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
345 #define AP_CONN_STATE_CONNECT_WAIT 9
346 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
347 #define AP_CONN_STATE_RESOLVE_WAIT 10
348 /** State for a SOCKS connection: ready to send and receive. */
349 #define AP_CONN_STATE_OPEN 11
350 /** State for a transparent natd connection: waiting for original
352 #define AP_CONN_STATE_NATD_WAIT 12
353 #define AP_CONN_STATE_MAX_ 12
355 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
356 * edge connection is not attached to any circuit. */
357 #define AP_CONN_STATE_IS_UNATTACHED(s) \
358 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
360 #define DIR_CONN_STATE_MIN_ 1
361 /** State for connection to directory server: waiting for connect(). */
362 #define DIR_CONN_STATE_CONNECTING 1
363 /** State for connection to directory server: sending HTTP request. */
364 #define DIR_CONN_STATE_CLIENT_SENDING 2
365 /** State for connection to directory server: reading HTTP response. */
366 #define DIR_CONN_STATE_CLIENT_READING 3
367 /** State for connection to directory server: happy and finished. */
368 #define DIR_CONN_STATE_CLIENT_FINISHED 4
369 /** State for connection at directory server: waiting for HTTP request. */
370 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
371 /** State for connection at directory server: sending HTTP response. */
372 #define DIR_CONN_STATE_SERVER_WRITING 6
373 #define DIR_CONN_STATE_MAX_ 6
375 /** True iff the purpose of <b>conn</b> means that it's a server-side
376 * directory connection. */
377 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
379 #define CONTROL_CONN_STATE_MIN_ 1
380 /** State for a control connection: Authenticated and accepting v1 commands. */
381 #define CONTROL_CONN_STATE_OPEN 1
382 /** State for a control connection: Waiting for authentication; speaking
384 #define CONTROL_CONN_STATE_NEEDAUTH 2
385 #define CONTROL_CONN_STATE_MAX_ 2
387 #define DIR_PURPOSE_MIN_ 4
388 /** A connection to a directory server: set after a v2 rendezvous
389 * descriptor is downloaded. */
390 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC_V2 4
391 /** A connection to a directory server: download one or more server
393 #define DIR_PURPOSE_FETCH_SERVERDESC 6
394 /** A connection to a directory server: download one or more extra-info
396 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
397 /** A connection to a directory server: upload a server descriptor. */
398 #define DIR_PURPOSE_UPLOAD_DIR 8
399 /** A connection to a directory server: upload a v3 networkstatus vote. */
400 #define DIR_PURPOSE_UPLOAD_VOTE 10
401 /** A connection to a directory server: upload a v3 consensus signature */
402 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
403 /** A connection to a directory server: download one or more v3 networkstatus
405 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
406 /** A connection to a directory server: download a v3 detached signatures
407 * object for a consensus. */
408 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
409 /** A connection to a directory server: download a v3 networkstatus
411 #define DIR_PURPOSE_FETCH_CONSENSUS 14
412 /** A connection to a directory server: download one or more directory
413 * authority certificates. */
414 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
416 /** Purpose for connection at a directory server. */
417 #define DIR_PURPOSE_SERVER 16
418 /** A connection to a hidden service directory server: upload a v2 rendezvous
420 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
421 /** A connection to a hidden service directory server: download a v2 rendezvous
423 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
424 /** A connection to a directory server: download a microdescriptor. */
425 #define DIR_PURPOSE_FETCH_MICRODESC 19
426 #define DIR_PURPOSE_MAX_ 19
428 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
429 * directory server. */
430 #define DIR_PURPOSE_IS_UPLOAD(p) \
431 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
432 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
433 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
435 #define EXIT_PURPOSE_MIN_ 1
436 /** This exit stream wants to do an ordinary connect. */
437 #define EXIT_PURPOSE_CONNECT 1
438 /** This exit stream wants to do a resolve (either normal or reverse). */
439 #define EXIT_PURPOSE_RESOLVE 2
440 #define EXIT_PURPOSE_MAX_ 2
442 /* !!!! If any connection purpose is ever over 31, we must grow the type
443 * field in connection_t. */
445 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
446 #define CIRCUIT_STATE_BUILDING 0
447 /** Circuit state: Waiting to process the onionskin. */
448 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
449 /** Circuit state: I'd like to deliver a create, but my n_chan is still
451 #define CIRCUIT_STATE_CHAN_WAIT 2
452 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
453 #define CIRCUIT_STATE_OPEN 3
455 #define CIRCUIT_PURPOSE_MIN_ 1
457 /* these circuits were initiated elsewhere */
458 #define CIRCUIT_PURPOSE_OR_MIN_ 1
459 /** OR-side circuit purpose: normal circuit, at OR. */
460 #define CIRCUIT_PURPOSE_OR 1
461 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
462 #define CIRCUIT_PURPOSE_INTRO_POINT 2
463 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
464 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
465 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
466 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
467 #define CIRCUIT_PURPOSE_OR_MAX_ 4
469 /* these circuits originate at this node */
471 /* here's how circ client-side purposes work:
472 * normal circuits are C_GENERAL.
473 * circuits that are c_introducing are either on their way to
474 * becoming open, or they are open and waiting for a
475 * suitable rendcirc before they send the intro.
476 * circuits that are c_introduce_ack_wait have sent the intro,
477 * but haven't gotten a response yet.
478 * circuits that are c_establish_rend are either on their way
479 * to becoming open, or they are open and have sent the
480 * establish_rendezvous cell but haven't received an ack.
481 * circuits that are c_rend_ready are open and have received a
482 * rend ack, but haven't heard from bob yet. if they have a
483 * buildstate->pending_final_cpath then they're expecting a
484 * cell from bob, else they're not.
485 * circuits that are c_rend_ready_intro_acked are open, and
486 * some intro circ has sent its intro and received an ack.
487 * circuits that are c_rend_joined are open, have heard from
488 * bob, and are talking to him.
490 /** Client-side circuit purpose: Normal circuit, with cpath. */
491 #define CIRCUIT_PURPOSE_C_GENERAL 5
492 /** Client-side circuit purpose: at Alice, connecting to intro point. */
493 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
494 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
495 * waiting for ACK/NAK. */
496 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
497 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
498 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
499 /** Client-side circuit purpose: at Alice, waiting for ack. */
500 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
501 /** Client-side circuit purpose: at Alice, waiting for Bob. */
502 #define CIRCUIT_PURPOSE_C_REND_READY 10
503 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
504 * has been acknowledged. */
505 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
506 /** Client-side circuit purpose: at Alice, rendezvous established. */
507 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
508 /** This circuit is used for build time measurement only */
509 #define CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT 13
510 #define CIRCUIT_PURPOSE_C_MAX_ 13
511 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
512 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 14
513 /** Hidden-service-side circuit purpose: at Bob, successfully established
515 #define CIRCUIT_PURPOSE_S_INTRO 15
516 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
517 #define CIRCUIT_PURPOSE_S_CONNECT_REND 16
518 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
519 #define CIRCUIT_PURPOSE_S_REND_JOINED 17
520 /** A testing circuit; not meant to be used for actual traffic. */
521 #define CIRCUIT_PURPOSE_TESTING 18
522 /** A controller made this circuit and Tor should not use it. */
523 #define CIRCUIT_PURPOSE_CONTROLLER 19
524 /** This circuit is used for path bias probing only */
525 #define CIRCUIT_PURPOSE_PATH_BIAS_TESTING 20
526 #define CIRCUIT_PURPOSE_MAX_ 20
527 /** A catch-all for unrecognized purposes. Currently we don't expect
528 * to make or see any circuits with this purpose. */
529 #define CIRCUIT_PURPOSE_UNKNOWN 255
531 /** True iff the circuit purpose <b>p</b> is for a circuit that
532 * originated at this node. */
533 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>CIRCUIT_PURPOSE_OR_MAX_)
534 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
535 * here to serve as a client. (Hidden services don't count here.) */
536 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
537 ((p)> CIRCUIT_PURPOSE_OR_MAX_ && \
538 (p)<=CIRCUIT_PURPOSE_C_MAX_)
539 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
540 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
541 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
543 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
544 ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
545 (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
546 /** True iff the circuit_t c is actually an or_circuit_t */
547 #define CIRCUIT_IS_ORCIRC(c) (((circuit_t *)(c))->magic == OR_CIRCUIT_MAGIC)
549 /** How many circuits do we want simultaneously in-progress to handle
551 #define MIN_CIRCUITS_HANDLING_STREAM 2
553 /* These RELAY_COMMAND constants define values for relay cell commands, and
554 * must match those defined in tor-spec.txt. */
555 #define RELAY_COMMAND_BEGIN 1
556 #define RELAY_COMMAND_DATA 2
557 #define RELAY_COMMAND_END 3
558 #define RELAY_COMMAND_CONNECTED 4
559 #define RELAY_COMMAND_SENDME 5
560 #define RELAY_COMMAND_EXTEND 6
561 #define RELAY_COMMAND_EXTENDED 7
562 #define RELAY_COMMAND_TRUNCATE 8
563 #define RELAY_COMMAND_TRUNCATED 9
564 #define RELAY_COMMAND_DROP 10
565 #define RELAY_COMMAND_RESOLVE 11
566 #define RELAY_COMMAND_RESOLVED 12
567 #define RELAY_COMMAND_BEGIN_DIR 13
568 #define RELAY_COMMAND_EXTEND2 14
569 #define RELAY_COMMAND_EXTENDED2 15
571 #define RELAY_COMMAND_ESTABLISH_INTRO 32
572 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
573 #define RELAY_COMMAND_INTRODUCE1 34
574 #define RELAY_COMMAND_INTRODUCE2 35
575 #define RELAY_COMMAND_RENDEZVOUS1 36
576 #define RELAY_COMMAND_RENDEZVOUS2 37
577 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
578 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
579 #define RELAY_COMMAND_INTRODUCE_ACK 40
581 /* Reasons why an OR connection is closed. */
582 #define END_OR_CONN_REASON_DONE 1
583 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
584 #define END_OR_CONN_REASON_OR_IDENTITY 3
585 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
586 #define END_OR_CONN_REASON_TIMEOUT 5
587 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
588 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
589 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
590 #define END_OR_CONN_REASON_PT_MISSING 9 /* PT failed or not available */
591 #define END_OR_CONN_REASON_MISC 10
593 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
594 * documentation of these. The values must match. */
595 #define END_STREAM_REASON_MISC 1
596 #define END_STREAM_REASON_RESOLVEFAILED 2
597 #define END_STREAM_REASON_CONNECTREFUSED 3
598 #define END_STREAM_REASON_EXITPOLICY 4
599 #define END_STREAM_REASON_DESTROY 5
600 #define END_STREAM_REASON_DONE 6
601 #define END_STREAM_REASON_TIMEOUT 7
602 #define END_STREAM_REASON_NOROUTE 8
603 #define END_STREAM_REASON_HIBERNATING 9
604 #define END_STREAM_REASON_INTERNAL 10
605 #define END_STREAM_REASON_RESOURCELIMIT 11
606 #define END_STREAM_REASON_CONNRESET 12
607 #define END_STREAM_REASON_TORPROTOCOL 13
608 #define END_STREAM_REASON_NOTDIRECTORY 14
609 #define END_STREAM_REASON_ENTRYPOLICY 15
611 /* These high-numbered end reasons are not part of the official spec,
612 * and are not intended to be put in relay end cells. They are here
613 * to be more informative when sending back socks replies to the
615 /* XXXX 256 is no longer used; feel free to reuse it. */
616 /** We were unable to attach the connection to any circuit at all. */
617 /* XXXX the ways we use this one don't make a lot of sense. */
618 #define END_STREAM_REASON_CANT_ATTACH 257
619 /** We can't connect to any directories at all, so we killed our streams
620 * before they can time out. */
621 #define END_STREAM_REASON_NET_UNREACHABLE 258
622 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
623 * protocol in a way we couldn't handle. */
624 #define END_STREAM_REASON_SOCKSPROTOCOL 259
625 /** This is a transparent proxy connection, but we can't extract the original
626 * target address:port. */
627 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
628 /** This is a connection on the NATD port, and the destination IP:Port was
629 * either ill-formed or out-of-range. */
630 #define END_STREAM_REASON_INVALID_NATD_DEST 261
631 /** The target address is in a private network (like 127.0.0.1 or 10.0.0.1);
632 * you don't want to do that over a randomly chosen exit */
633 #define END_STREAM_REASON_PRIVATE_ADDR 262
635 /** Bitwise-and this value with endreason to mask out all flags. */
636 #define END_STREAM_REASON_MASK 511
638 /** Bitwise-or this with the argument to control_event_stream_status
639 * to indicate that the reason came from an END cell. */
640 #define END_STREAM_REASON_FLAG_REMOTE 512
641 /** Bitwise-or this with the argument to control_event_stream_status
642 * to indicate that we already sent a CLOSED stream event. */
643 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
644 /** Bitwise-or this with endreason to indicate that we already sent
645 * a socks reply, and no further reply needs to be sent from
646 * connection_mark_unattached_ap(). */
647 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
649 /** Reason for remapping an AP connection's address: we have a cached
651 #define REMAP_STREAM_SOURCE_CACHE 1
652 /** Reason for remapping an AP connection's address: the exit node told us an
654 #define REMAP_STREAM_SOURCE_EXIT 2
656 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
657 #define RESOLVED_TYPE_HOSTNAME 0
658 #define RESOLVED_TYPE_IPV4 4
659 #define RESOLVED_TYPE_IPV6 6
660 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
661 #define RESOLVED_TYPE_ERROR 0xF1
663 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
664 * call; they only go to the controller for tracking */
666 /* Closing introduction point that were opened in parallel. */
667 #define END_CIRC_REASON_IP_NOW_REDUNDANT -4
669 /** Our post-timeout circuit time measurement period expired.
670 * We must give up now */
671 #define END_CIRC_REASON_MEASUREMENT_EXPIRED -3
673 /** We couldn't build a path for this circuit. */
674 #define END_CIRC_REASON_NOPATH -2
675 /** Catch-all "other" reason for closing origin circuits. */
676 #define END_CIRC_AT_ORIGIN -1
678 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
679 * documentation of these. */
680 #define END_CIRC_REASON_MIN_ 0
681 #define END_CIRC_REASON_NONE 0
682 #define END_CIRC_REASON_TORPROTOCOL 1
683 #define END_CIRC_REASON_INTERNAL 2
684 #define END_CIRC_REASON_REQUESTED 3
685 #define END_CIRC_REASON_HIBERNATING 4
686 #define END_CIRC_REASON_RESOURCELIMIT 5
687 #define END_CIRC_REASON_CONNECTFAILED 6
688 #define END_CIRC_REASON_OR_IDENTITY 7
689 #define END_CIRC_REASON_CHANNEL_CLOSED 8
690 #define END_CIRC_REASON_FINISHED 9
691 #define END_CIRC_REASON_TIMEOUT 10
692 #define END_CIRC_REASON_DESTROYED 11
693 #define END_CIRC_REASON_NOSUCHSERVICE 12
694 #define END_CIRC_REASON_MAX_ 12
696 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
697 * control_event_circuit_status() to indicate that the reason was
698 * passed through from a destroy or truncate cell. */
699 #define END_CIRC_REASON_FLAG_REMOTE 512
701 /** Length of 'y' portion of 'y.onion' URL. */
702 #define REND_SERVICE_ID_LEN_BASE32 16
704 /** Length of 'y.onion' including '.onion' URL. */
705 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
707 /** Length of a binary-encoded rendezvous service ID. */
708 #define REND_SERVICE_ID_LEN 10
710 /** Time period for which a v2 descriptor will be valid. */
711 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
713 /** Time period within which two sets of v2 descriptors will be uploaded in
715 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
717 /** Number of non-consecutive replicas (i.e. distributed somewhere
718 * in the ring) for a descriptor. */
719 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
721 /** Number of consecutive replicas for a descriptor. */
722 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
724 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
725 #define REND_DESC_ID_V2_LEN_BASE32 32
727 /** Length of the base32-encoded secret ID part of versioned hidden service
729 #define REND_SECRET_ID_PART_LEN_BASE32 32
731 /** Length of the base32-encoded hash of an introduction point's
733 #define REND_INTRO_POINT_ID_LEN_BASE32 32
735 /** Length of the descriptor cookie that is used for client authorization
736 * to hidden services. */
737 #define REND_DESC_COOKIE_LEN 16
739 /** Length of the base64-encoded descriptor cookie that is used for
740 * exchanging client authorization between hidden service and client. */
741 #define REND_DESC_COOKIE_LEN_BASE64 22
743 /** Length of client identifier in encrypted introduction points for hidden
744 * service authorization type 'basic'. */
745 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
747 /** Multiple of the number of clients to which the real number of clients
748 * is padded with fake clients for hidden service authorization type
750 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
752 /** Length of client entry consisting of client identifier and encrypted
753 * session key for hidden service authorization type 'basic'. */
754 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
757 /** Maximum size of v2 hidden service descriptors. */
758 #define REND_DESC_MAX_SIZE (20 * 1024)
760 /** Legal characters for use in authorized client names for a hidden
762 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
763 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
765 /** Maximum length of authorized client names for a hidden service. */
766 #define REND_CLIENTNAME_MAX_LEN 16
768 /** Length of the rendezvous cookie that is used to connect circuits at the
769 * rendezvous point. */
770 #define REND_COOKIE_LEN DIGEST_LEN
772 /** Client authorization type that a hidden service performs. */
773 typedef enum rend_auth_type_t
{
776 REND_STEALTH_AUTH
= 2,
779 /** Client-side configuration of authorization for a hidden service. */
780 typedef struct rend_service_authorization_t
{
781 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
782 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
783 rend_auth_type_t auth_type
;
784 } rend_service_authorization_t
;
786 /** Client- and server-side data that is used for hidden service connection
787 * establishment. Not all fields contain data depending on where this struct
789 typedef struct rend_data_t
{
790 /** Onion address (without the .onion part) that a client requests. */
791 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
793 /** Descriptor ID for each replicas computed from the onion address. If
794 * the onion address is empty, this array MUST be empty. We keep them so
795 * we know when to purge our entry in the last hsdir request table. */
796 char descriptor_id
[REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS
][DIGEST_LEN
];
798 /** (Optional) descriptor cookie that is used by a client. */
799 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
801 /** Authorization type for accessing a service used by a client. */
802 rend_auth_type_t auth_type
;
804 /** Descriptor ID for a client request. The control port command HSFETCH
805 * uses this. It's set if the descriptor query should only use this
807 char desc_id_fetch
[DIGEST_LEN
];
809 /** Hash of the hidden service's PK used by a service. */
810 char rend_pk_digest
[DIGEST_LEN
];
812 /** Rendezvous cookie used by both, client and service. */
813 char rend_cookie
[REND_COOKIE_LEN
];
815 /** List of HSDir fingerprints on which this request has been sent to.
816 * This contains binary identity digest of the directory. */
817 smartlist_t
*hsdirs_fp
;
819 /** Number of streams associated with this rendezvous circuit. */
823 /** Time interval for tracking replays of DH public keys received in
824 * INTRODUCE2 cells. Used only to avoid launching multiple
825 * simultaneous attempts to connect to the same rendezvous point. */
826 #define REND_REPLAY_TIME_INTERVAL (5 * 60)
828 /** Used to indicate which way a cell is going on a circuit. */
830 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
831 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
834 /** Initial value for both sides of a circuit transmission window when the
835 * circuit is initialized. Measured in cells. */
836 #define CIRCWINDOW_START 1000
837 #define CIRCWINDOW_START_MIN 100
838 #define CIRCWINDOW_START_MAX 1000
839 /** Amount to increment a circuit window when we get a circuit SENDME. */
840 #define CIRCWINDOW_INCREMENT 100
841 /** Initial value on both sides of a stream transmission window when the
842 * stream is initialized. Measured in cells. */
843 #define STREAMWINDOW_START 500
844 /** Amount to increment a stream window when we get a stream SENDME. */
845 #define STREAMWINDOW_INCREMENT 50
847 /** Maximum number of queued cells on a circuit for which we are the
848 * midpoint before we give up and kill it. This must be >= circwindow
849 * to avoid killing innocent circuits, and >= circwindow*2 to give
850 * leaky-pipe a chance of working someday. The ORCIRC_MAX_MIDDLE_KILL_THRESH
851 * ratio controls the margin of error between emitting a warning and
852 * killing the circuit.
854 #define ORCIRC_MAX_MIDDLE_CELLS (CIRCWINDOW_START_MAX*2)
855 /** Ratio of hard (circuit kill) to soft (warning) thresholds for the
856 * ORCIRC_MAX_MIDDLE_CELLS tests.
858 #define ORCIRC_MAX_MIDDLE_KILL_THRESH (1.1f)
860 /* Cell commands. These values are defined in tor-spec.txt. */
861 #define CELL_PADDING 0
862 #define CELL_CREATE 1
863 #define CELL_CREATED 2
865 #define CELL_DESTROY 4
866 #define CELL_CREATE_FAST 5
867 #define CELL_CREATED_FAST 6
868 #define CELL_VERSIONS 7
869 #define CELL_NETINFO 8
870 #define CELL_RELAY_EARLY 9
871 #define CELL_CREATE2 10
872 #define CELL_CREATED2 11
874 #define CELL_VPADDING 128
875 #define CELL_CERTS 129
876 #define CELL_AUTH_CHALLENGE 130
877 #define CELL_AUTHENTICATE 131
878 #define CELL_AUTHORIZE 132
879 #define CELL_COMMAND_MAX_ 132
881 /** How long to test reachability before complaining to the user. */
882 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
884 /** Legal characters in a nickname. */
885 #define LEGAL_NICKNAME_CHARACTERS \
886 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
888 /** Name to use in client TLS certificates if no nickname is given. Once
889 * Tor 0.1.2.x is obsolete, we can remove this. */
890 #define DEFAULT_CLIENT_NICKNAME "client"
892 /** Name chosen by routers that don't configure nicknames */
893 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
895 /** Number of bytes in a SOCKS4 header. */
896 #define SOCKS4_NETWORK_LEN 8
900 * Relay command [1 byte]
901 * Recognized [2 bytes]
902 * Stream ID [2 bytes]
903 * Partial SHA-1 [4 bytes]
905 * Relay payload [498 bytes]
908 /** Number of bytes in a cell, minus cell header. */
909 #define CELL_PAYLOAD_SIZE 509
910 /** Number of bytes in a cell transmitted over the network, in the longest
912 #define CELL_MAX_NETWORK_SIZE 514
914 /** Maximum length of a header on a variable-length cell. */
915 #define VAR_CELL_MAX_HEADER_SIZE 7
917 static int get_cell_network_size(int wide_circ_ids
);
918 static INLINE
int get_cell_network_size(int wide_circ_ids
)
920 return wide_circ_ids
? CELL_MAX_NETWORK_SIZE
: CELL_MAX_NETWORK_SIZE
- 2;
922 static int get_var_cell_header_size(int wide_circ_ids
);
923 static INLINE
int get_var_cell_header_size(int wide_circ_ids
)
925 return wide_circ_ids
? VAR_CELL_MAX_HEADER_SIZE
:
926 VAR_CELL_MAX_HEADER_SIZE
- 2;
928 static int get_circ_id_size(int wide_circ_ids
);
929 static INLINE
int get_circ_id_size(int wide_circ_ids
)
931 return wide_circ_ids
? 4 : 2;
934 /** Number of bytes in a relay cell's header (not including general cell
936 #define RELAY_HEADER_SIZE (1+2+2+4+2)
937 /** Largest number of bytes that can fit in a relay cell payload. */
938 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
940 /** Identifies a circuit on an or_connection */
941 typedef uint32_t circid_t
;
942 /** Identifies a stream on a circuit */
943 typedef uint16_t streamid_t
;
945 /* channel_t typedef; struct channel_s is in channel.h */
947 typedef struct channel_s channel_t
;
949 /* channel_listener_t typedef; struct channel_listener_s is in channel.h */
951 typedef struct channel_listener_s channel_listener_t
;
953 /* channel states for channel_t */
957 * Closed state - channel is inactive
959 * Permitted transitions from:
960 * - CHANNEL_STATE_CLOSING
961 * Permitted transitions to:
962 * - CHANNEL_STATE_OPENING
964 CHANNEL_STATE_CLOSED
= 0,
966 * Opening state - channel is trying to connect
968 * Permitted transitions from:
969 * - CHANNEL_STATE_CLOSED
970 * Permitted transitions to:
971 * - CHANNEL_STATE_CLOSING
972 * - CHANNEL_STATE_ERROR
973 * - CHANNEL_STATE_OPEN
975 CHANNEL_STATE_OPENING
,
977 * Open state - channel is active and ready for use
979 * Permitted transitions from:
980 * - CHANNEL_STATE_MAINT
981 * - CHANNEL_STATE_OPENING
982 * Permitted transitions to:
983 * - CHANNEL_STATE_CLOSING
984 * - CHANNEL_STATE_ERROR
985 * - CHANNEL_STATE_MAINT
989 * Maintenance state - channel is temporarily offline for subclass specific
990 * maintenance activities such as TLS renegotiation.
992 * Permitted transitions from:
993 * - CHANNEL_STATE_OPEN
994 * Permitted transitions to:
995 * - CHANNEL_STATE_CLOSING
996 * - CHANNEL_STATE_ERROR
997 * - CHANNEL_STATE_OPEN
1001 * Closing state - channel is shutting down
1003 * Permitted transitions from:
1004 * - CHANNEL_STATE_MAINT
1005 * - CHANNEL_STATE_OPEN
1006 * Permitted transitions to:
1007 * - CHANNEL_STATE_CLOSED,
1008 * - CHANNEL_STATE_ERROR
1010 CHANNEL_STATE_CLOSING
,
1012 * Error state - channel has experienced a permanent error
1014 * Permitted transitions from:
1015 * - CHANNEL_STATE_CLOSING
1016 * - CHANNEL_STATE_MAINT
1017 * - CHANNEL_STATE_OPENING
1018 * - CHANNEL_STATE_OPEN
1019 * Permitted transitions to:
1022 CHANNEL_STATE_ERROR
,
1024 * Placeholder for maximum state value
1029 /* channel listener states for channel_listener_t */
1033 * Closed state - channel listener is inactive
1035 * Permitted transitions from:
1036 * - CHANNEL_LISTENER_STATE_CLOSING
1037 * Permitted transitions to:
1038 * - CHANNEL_LISTENER_STATE_LISTENING
1040 CHANNEL_LISTENER_STATE_CLOSED
= 0,
1042 * Listening state - channel listener is listening for incoming
1045 * Permitted transitions from:
1046 * - CHANNEL_LISTENER_STATE_CLOSED
1047 * Permitted transitions to:
1048 * - CHANNEL_LISTENER_STATE_CLOSING
1049 * - CHANNEL_LISTENER_STATE_ERROR
1051 CHANNEL_LISTENER_STATE_LISTENING
,
1053 * Closing state - channel listener is shutting down
1055 * Permitted transitions from:
1056 * - CHANNEL_LISTENER_STATE_LISTENING
1057 * Permitted transitions to:
1058 * - CHANNEL_LISTENER_STATE_CLOSED,
1059 * - CHANNEL_LISTENER_STATE_ERROR
1061 CHANNEL_LISTENER_STATE_CLOSING
,
1063 * Error state - channel listener has experienced a permanent error
1065 * Permitted transitions from:
1066 * - CHANNEL_STATE_CLOSING
1067 * - CHANNEL_STATE_LISTENING
1068 * Permitted transitions to:
1071 CHANNEL_LISTENER_STATE_ERROR
,
1073 * Placeholder for maximum state value
1075 CHANNEL_LISTENER_STATE_LAST
1076 } channel_listener_state_t
;
1078 /* TLS channel stuff */
1080 typedef struct channel_tls_s channel_tls_t
;
1082 /* circuitmux_t typedef; struct circuitmux_s is in circuitmux.h */
1084 typedef struct circuitmux_s circuitmux_t
;
1086 /** Parsed onion routing cell. All communication between nodes
1088 typedef struct cell_t
{
1089 circid_t circ_id
; /**< Circuit which received the cell. */
1090 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
1091 * CELL_DESTROY, etc */
1092 uint8_t payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
1095 /** Parsed variable-length onion routing cell. */
1096 typedef struct var_cell_t
{
1097 /** Type of the cell: CELL_VERSIONS, etc. */
1099 /** Circuit thich received the cell */
1101 /** Number of bytes actually stored in <b>payload</b> */
1102 uint16_t payload_len
;
1103 /** Payload of this cell */
1104 uint8_t payload
[FLEXIBLE_ARRAY_MEMBER
];
1107 /** A parsed Extended ORPort message. */
1108 typedef struct ext_or_cmd_t
{
1109 uint16_t cmd
; /** Command type */
1110 uint16_t len
; /** Body length */
1111 char body
[FLEXIBLE_ARRAY_MEMBER
]; /** Message body */
1114 /** A cell as packed for writing to the network. */
1115 typedef struct packed_cell_t
{
1116 /** Next cell queued on this circuit. */
1117 TOR_SIMPLEQ_ENTRY(packed_cell_t
) next
;
1118 char body
[CELL_MAX_NETWORK_SIZE
]; /**< Cell as packed for network. */
1119 uint32_t inserted_time
; /**< Time (in milliseconds since epoch, with high
1120 * bits truncated) when this cell was inserted. */
1123 /** A queue of cells on a circuit, waiting to be added to the
1124 * or_connection_t's outbuf. */
1125 typedef struct cell_queue_t
{
1126 /** Linked list of packed_cell_t*/
1127 TOR_SIMPLEQ_HEAD(cell_simpleq
, packed_cell_t
) head
;
1128 int n
; /**< The number of cells in the queue. */
1131 /** Beginning of a RELAY cell payload. */
1133 uint8_t command
; /**< The end-to-end relay command. */
1134 uint16_t recognized
; /**< Used to tell whether cell is for us. */
1135 streamid_t stream_id
; /**< Which stream is this cell associated with? */
1136 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
1137 uint16_t length
; /**< How long is the payload body? */
1140 typedef struct buf_t buf_t
;
1141 typedef struct socks_request_t socks_request_t
;
1142 #ifdef USE_BUFFEREVENTS
1143 #define generic_buffer_t struct evbuffer
1145 #define generic_buffer_t buf_t
1148 typedef struct entry_port_cfg_t
{
1149 /* Client port types (socks, dns, trans, natd) only: */
1150 uint8_t isolation_flags
; /**< Zero or more isolation flags */
1151 int session_group
; /**< A session group, or -1 if this port is not in a
1155 /** When both no-auth and user/pass are advertised by a SOCKS client, select
1157 unsigned int socks_prefer_no_auth
: 1;
1158 /** When ISO_SOCKSAUTH is in use, Keep-Alive circuits indefinitely. */
1159 unsigned int socks_iso_keep_alive
: 1;
1161 /* Client port types only: */
1162 unsigned int ipv4_traffic
: 1;
1163 unsigned int ipv6_traffic
: 1;
1164 unsigned int prefer_ipv6
: 1;
1166 /** For a socks listener: should we cache IPv4/IPv6 DNS information that
1167 * exit nodes tell us?
1170 unsigned int cache_ipv4_answers
: 1;
1171 unsigned int cache_ipv6_answers
: 1;
1173 /** For a socks listeners: if we find an answer in our client-side DNS cache,
1177 unsigned int use_cached_ipv4_answers
: 1;
1178 unsigned int use_cached_ipv6_answers
: 1;
1180 /** For socks listeners: When we can automap an address to IPv4 or IPv6,
1181 * do we prefer IPv6? */
1182 unsigned int prefer_ipv6_virtaddr
: 1;
1186 typedef struct server_port_cfg_t
{
1187 /* Server port types (or, dir) only: */
1188 unsigned int no_advertise
: 1;
1189 unsigned int no_listen
: 1;
1190 unsigned int all_addrs
: 1;
1191 unsigned int bind_ipv4_only
: 1;
1192 unsigned int bind_ipv6_only
: 1;
1193 } server_port_cfg_t
;
1195 /* Values for connection_t.magic: used to make sure that downcasts (casts from
1196 * connection_t to foo_connection_t) are safe. */
1197 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
1198 #define OR_CONNECTION_MAGIC 0x7D31FF03u
1199 #define EDGE_CONNECTION_MAGIC 0xF0374013u
1200 #define ENTRY_CONNECTION_MAGIC 0xbb4a5703
1201 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
1202 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
1203 #define LISTENER_CONNECTION_MAGIC 0x1a1ac741u
1205 /** Description of a connection to another host or process, and associated
1208 * A connection is named based on what it's connected to -- an "OR
1209 * connection" has a Tor node on the other end, an "exit
1210 * connection" has a website or other server on the other end, and an
1211 * "AP connection" has an application proxy (and thus a user) on the
1214 * Every connection has a type and a state. Connections never change
1215 * their type, but can go through many state changes in their lifetime.
1217 * Every connection has two associated input and output buffers.
1218 * Listeners don't use them. For non-listener connections, incoming
1219 * data is appended to conn->inbuf, and outgoing data is taken from
1220 * conn->outbuf. Connections differ primarily in the functions called
1221 * to fill and drain these buffers.
1223 typedef struct connection_t
{
1224 uint32_t magic
; /**< For memory debugging: must equal one of
1225 * *_CONNECTION_MAGIC. */
1227 uint8_t state
; /**< Current state of this connection. */
1228 unsigned int type
:5; /**< What kind of connection is this? */
1229 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
1231 /* The next fields are all one-bit booleans. Some are only applicable to
1232 * connection subtypes, but we hold them here anyway, to save space.
1234 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
1235 * again once the bandwidth throttler allows it? */
1236 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
1237 * again once the bandwidth throttler allows
1239 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
1240 * marked for close, do we flush it
1241 * before closing it? */
1242 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
1244 /** Set to 1 when we're inside connection_flushed_some to keep us from
1245 * calling connection_handle_write() recursively. */
1246 unsigned int in_flushed_some
:1;
1247 /** True if connection_handle_write is currently running on this connection.
1249 unsigned int in_connection_handle_write
:1;
1251 /* For linked connections:
1253 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
1254 /** True iff we'd like to be notified about read events from the
1256 unsigned int reading_from_linked_conn
:1;
1257 /** True iff we're willing to write to the linked conn. */
1258 unsigned int writing_to_linked_conn
:1;
1259 /** True iff we're currently able to read on the linked conn, and our
1260 * read_event should be made active with libevent. */
1261 unsigned int active_on_link
:1;
1262 /** True iff we've called connection_close_immediate() on this linked
1264 unsigned int linked_conn_is_closed
:1;
1266 /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
1267 unsigned int proxy_state
:4;
1269 /** Our socket; set to TOR_INVALID_SOCKET if this connection is closed,
1270 * or has no socket. */
1272 int conn_array_index
; /**< Index into the global connection array. */
1274 struct event
*read_event
; /**< Libevent event structure. */
1275 struct event
*write_event
; /**< Libevent event structure. */
1276 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
1277 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
1278 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
1280 time_t timestamp_lastread
; /**< When was the last time libevent said we could
1282 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
1285 #ifdef USE_BUFFEREVENTS
1286 struct bufferevent
*bufev
; /**< A Libevent buffered IO structure. */
1289 time_t timestamp_created
; /**< When was this connection_t created? */
1291 /* XXXX_IP6 make this IPv6-capable */
1292 int socket_family
; /**< Address family of this connection's socket. Usually
1293 * AF_INET, but it can also be AF_UNIX, or in the future
1295 tor_addr_t addr
; /**< IP of the other side of the connection; used to
1296 * identify routers, along with port. */
1297 uint16_t port
; /**< If non-zero, port on the other end
1298 * of the connection. */
1299 uint16_t marked_for_close
; /**< Should we close this conn on the next
1300 * iteration of the main loop? (If true, holds
1301 * the line number where this connection was
1303 const char *marked_for_close_file
; /**< For debugging: in which file were
1304 * we marked for close? */
1305 char *address
; /**< FQDN (or IP) of the guy on the other end.
1306 * strdup into this, because free_connection() frees it. */
1307 /** Another connection that's connected to this one in lieu of a socket. */
1308 struct connection_t
*linked_conn
;
1310 /** Unique identifier for this connection on this Tor instance. */
1311 uint64_t global_identifier
;
1313 /** Bytes read since last call to control_event_conn_bandwidth_used().
1314 * Only used if we're configured to emit CONN_BW events. */
1315 uint32_t n_read_conn_bw
;
1317 /** Bytes written since last call to control_event_conn_bandwidth_used().
1318 * Only used if we're configured to emit CONN_BW events. */
1319 uint32_t n_written_conn_bw
;
1322 /** Subtype of connection_t; used for a listener socket. */
1323 typedef struct listener_connection_t
{
1326 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
1327 * to the evdns_server_port it uses to listen to and answer connections. */
1328 struct evdns_server_port
*dns_server_port
;
1330 entry_port_cfg_t entry_cfg
;
1332 } listener_connection_t
;
1334 /** Minimum length of the random part of an AUTH_CHALLENGE cell. */
1335 #define OR_AUTH_CHALLENGE_LEN 32
1338 * @name Certificate types for CERTS cells.
1340 * These values are defined by the protocol, and affect how an X509
1341 * certificate in a CERTS cell is interpreted and used.
1344 /** A certificate that authenticates a TLS link key. The subject key
1345 * must match the key used in the TLS handshake; it must be signed by
1346 * the identity key. */
1347 #define OR_CERT_TYPE_TLS_LINK 1
1348 /** A self-signed identity certificate. The subject key must be a
1349 * 1024-bit RSA key. */
1350 #define OR_CERT_TYPE_ID_1024 2
1351 /** A certificate that authenticates a key used in an AUTHENTICATE cell
1352 * in the v3 handshake. The subject key must be a 1024-bit RSA key; it
1353 * must be signed by the identity key */
1354 #define OR_CERT_TYPE_AUTH_1024 3
1356 #define OR_CERT_TYPE_RSA_ED_CROSSCERT 7
1359 /** The one currently supported type of AUTHENTICATE cell. It contains
1360 * a bunch of structures signed with an RSA1024 key. The signed
1361 * structures include a HMAC using negotiated TLS secrets, and a digest
1362 * of all cells sent or received before the AUTHENTICATE cell (including
1363 * the random server-generated AUTH_CHALLENGE cell).
1365 #define AUTHTYPE_RSA_SHA256_TLSSECRET 1
1367 /** The length of the part of the AUTHENTICATE cell body that the client and
1368 * server can generate independently (when using RSA_SHA256_TLSSECRET). It
1369 * contains everything except the client's timestamp, the client's randomly
1370 * generated nonce, and the signature. */
1371 #define V3_AUTH_FIXED_PART_LEN (8+(32*6))
1372 /** The length of the part of the AUTHENTICATE cell body that the client
1374 #define V3_AUTH_BODY_LEN (V3_AUTH_FIXED_PART_LEN + 8 + 16)
1376 /** Stores flags and information related to the portion of a v2/v3 Tor OR
1377 * connection handshake that happens after the TLS handshake is finished.
1379 typedef struct or_handshake_state_t
{
1380 /** When was the VERSIONS cell sent on this connection? Used to get
1381 * an estimate of the skew in the returning NETINFO reply. */
1382 time_t sent_versions_at
;
1383 /** True iff we originated this connection */
1384 unsigned int started_here
: 1;
1385 /** True iff we have received and processed a VERSIONS cell. */
1386 unsigned int received_versions
: 1;
1387 /** True iff we have received and processed an AUTH_CHALLENGE cell */
1388 unsigned int received_auth_challenge
: 1;
1389 /** True iff we have received and processed a CERTS cell. */
1390 unsigned int received_certs_cell
: 1;
1391 /** True iff we have received and processed an AUTHENTICATE cell */
1392 unsigned int received_authenticate
: 1;
1394 /* True iff we've received valid authentication to some identity. */
1395 unsigned int authenticated
: 1;
1397 /* True iff we have sent a netinfo cell */
1398 unsigned int sent_netinfo
: 1;
1400 /** True iff we should feed outgoing cells into digest_sent and
1401 * digest_received respectively.
1403 * From the server's side of the v3 handshake, we want to capture everything
1404 * from the VERSIONS cell through and including the AUTH_CHALLENGE cell.
1405 * From the client's, we want to capture everything from the VERSIONS cell
1406 * through but *not* including the AUTHENTICATE cell.
1409 unsigned int digest_sent_data
: 1;
1410 unsigned int digest_received_data
: 1;
1413 /** Identity digest that we have received and authenticated for our peer
1414 * on this connection. */
1415 uint8_t authenticated_peer_id
[DIGEST_LEN
];
1417 /** Digests of the cells that we have sent or received as part of a V3
1418 * handshake. Used for making and checking AUTHENTICATE cells.
1422 crypto_digest_t
*digest_sent
;
1423 crypto_digest_t
*digest_received
;
1426 /** Certificates that a connection initiator sent us in a CERTS cell; we're
1427 * holding on to them until we get an AUTHENTICATE cell.
1431 /** The cert for the key that's supposed to sign the AUTHENTICATE cell */
1432 tor_x509_cert_t
*auth_cert
;
1433 /** A self-signed identity certificate */
1434 tor_x509_cert_t
*id_cert
;
1436 } or_handshake_state_t
;
1438 /** Length of Extended ORPort connection identifier. */
1439 #define EXT_OR_CONN_ID_LEN DIGEST_LEN /* 20 */
1441 * OR_CONN_HIGHWATER and OR_CONN_LOWWATER moved from connection_or.c so
1442 * channeltls.c can see them too.
1445 /** When adding cells to an OR connection's outbuf, keep adding until the
1446 * outbuf is at least this long, or we run out of cells. */
1447 #define OR_CONN_HIGHWATER (32*1024)
1449 /** Add cells to an OR connection's outbuf whenever the outbuf's data length
1450 * drops below this size. */
1451 #define OR_CONN_LOWWATER (16*1024)
1453 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
1454 * cells over TLS. */
1455 typedef struct or_connection_t
{
1458 /** Hash of the public RSA key for the other side's identity key, or zeroes
1459 * if the other side hasn't shown us a valid identity key. */
1460 char identity_digest
[DIGEST_LEN
];
1462 /** Extended ORPort connection identifier. */
1463 char *ext_or_conn_id
;
1464 /** This is the ClientHash value we expect to receive from the
1465 * client during the Extended ORPort authentication protocol. We
1466 * compute it upon receiving the ClientNoce from the client, and we
1467 * compare it with the acual ClientHash value sent by the
1469 char *ext_or_auth_correct_client_hash
;
1470 /** String carrying the name of the pluggable transport
1471 * (e.g. "obfs2") that is obfuscating this connection. If no
1472 * pluggable transports are used, it's NULL. */
1473 char *ext_or_transport
;
1475 char *nickname
; /**< Nickname of OR on other side (if any). */
1477 tor_tls_t
*tls
; /**< TLS connection state. */
1478 int tls_error
; /**< Last tor_tls error code. */
1479 /** When we last used this conn for any client traffic. If not
1480 * recent, we can rate limit it further. */
1482 /* Channel using this connection */
1483 channel_tls_t
*chan
;
1485 tor_addr_t real_addr
; /**< The actual address that this connection came from
1486 * or went to. The <b>addr</b> field is prone to
1487 * getting overridden by the address from the router
1488 * descriptor matching <b>identity_digest</b>. */
1490 /** Should this connection be used for extending circuits to the server
1491 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1492 * sure we aren't getting MITMed, either because we're connected to an
1493 * address listed in a server descriptor, or because an authenticated
1494 * NETINFO cell listed the address we're connected to as recognized. */
1495 unsigned int is_canonical
:1;
1497 /** True iff we have decided that the other end of this connection
1498 * is a client. Connections with this flag set should never be used
1499 * to satisfy an EXTEND request. */
1500 unsigned int is_connection_with_client
:1;
1501 /** True iff this is an outgoing connection. */
1502 unsigned int is_outgoing
:1;
1503 unsigned int proxy_type
:2; /**< One of PROXY_NONE...PROXY_SOCKS5 */
1504 unsigned int wide_circ_ids
:1;
1505 /** True iff this connection has had its bootstrap failure logged with
1506 * control_event_bootstrap_problem. */
1507 unsigned int have_noted_bootstrap_problem
:1;
1509 uint16_t link_proto
; /**< What protocol version are we using? 0 for
1510 * "none negotiated yet." */
1511 uint16_t idle_timeout
; /**< How long can this connection sit with no
1512 * circuits on it before we close it? Based on
1513 * IDLE_CIRCUIT_TIMEOUT_{NON,}CANONICAL and
1514 * on is_canonical, randomized. */
1515 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1516 * up, state information to do so. */
1518 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1520 /* bandwidth* and *_bucket only used by ORs in OPEN state: */
1521 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1522 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1523 #ifndef USE_BUFFEREVENTS
1524 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1525 * add 'bandwidthrate' to this, capping it at
1526 * bandwidthburst. (OPEN ORs only) */
1527 int write_bucket
; /**< When this hits 0, stop writing. Like read_bucket. */
1529 /** A rate-limiting configuration object to determine how this connection
1530 * set its read- and write- limits. */
1531 /* XXXX we could share this among all connections. */
1532 struct ev_token_bucket_cfg
*bucket_cfg
;
1535 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1536 * identity digest as this one. */
1537 /** Last emptied read token bucket in msec since midnight; only used if
1538 * TB_EMPTY events are enabled. */
1539 uint32_t read_emptied_time
;
1540 /** Last emptied write token bucket in msec since midnight; only used if
1541 * TB_EMPTY events are enabled. */
1542 uint32_t write_emptied_time
;
1545 * Count the number of bytes flushed out on this orconn, and the number of
1546 * bytes TLS actually sent - used for overhead estimation for scheduling.
1548 uint64_t bytes_xmitted
, bytes_xmitted_by_tls
;
1551 /** Subtype of connection_t for an "edge connection" -- that is, an entry (ap)
1552 * connection, or an exit. */
1553 typedef struct edge_connection_t
{
1556 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1558 int package_window
; /**< How many more relay cells can I send into the
1560 int deliver_window
; /**< How many more relay cells can end at me? */
1562 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1563 * connection is using. */
1565 /** A pointer to which node in the circ this conn exits at. Set for AP
1566 * connections and for hidden service exit connections. */
1567 struct crypt_path_t
*cpath_layer
;
1568 /** What rendezvous service are we querying for (if an AP) or providing (if
1570 rend_data_t
*rend_data
;
1572 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1573 * connection. Exit connections only. */
1574 uint32_t begincell_flags
; /** Flags sent or received in the BEGIN cell
1575 * for this connection */
1577 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1580 /** The reason why this connection is closing; passed to the controller. */
1581 uint16_t end_reason
;
1583 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1586 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1589 /** True iff this connection is for a DNS request only. */
1590 unsigned int is_dns_request
:1;
1591 /** True iff this connection is for a PTR DNS request. (exit only) */
1592 unsigned int is_reverse_dns_lookup
:1;
1594 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1595 * connections. Set once we've set the stream end,
1596 * and check in connection_about_to_close_connection().
1598 /** True iff we've blocked reading until the circuit has fewer queued
1600 unsigned int edge_blocked_on_circ
:1;
1602 /** Unique ID for directory requests; this used to be in connection_t, but
1603 * that's going away and being used on channels instead. We still tag
1604 * edge connections with dirreq_id from circuits, so it's copied here. */
1606 } edge_connection_t
;
1608 /** Subtype of edge_connection_t for an "entry connection" -- that is, a SOCKS
1609 * connection, a DNS request, a TransPort connection or a NATD connection */
1610 typedef struct entry_connection_t
{
1611 edge_connection_t edge_
;
1613 /** Nickname of planned exit node -- used with .exit support. */
1614 char *chosen_exit_name
;
1616 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1619 /* === Isolation related, AP only. === */
1620 entry_port_cfg_t entry_cfg
;
1621 /** AP only: The newnym epoch in which we created this connection. */
1624 /** AP only: The original requested address before we rewrote it. */
1625 char *original_dest_address
;
1626 /* Other fields to isolate on already exist. The ClientAddr is addr. The
1627 ClientProtocol is a combination of type and socks_request->
1628 socks_version. SocksAuth is socks_request->username/password.
1629 DestAddr is in socks_request->address. */
1631 /** Number of times we've reassigned this application connection to
1632 * a new circuit. We keep track because the timeout is longer if we've
1633 * already retried several times. */
1634 uint8_t num_socks_retries
;
1636 /** For AP connections only: buffer for data that we have sent
1637 * optimistically, which we might need to re-send if we have to
1638 * retry this connection. */
1639 generic_buffer_t
*pending_optimistic_data
;
1640 /* For AP connections only: buffer for data that we previously sent
1641 * optimistically which we are currently re-sending as we retry this
1643 generic_buffer_t
*sending_optimistic_data
;
1645 /** If this is a DNSPort connection, this field holds the pending DNS
1646 * request that we're going to try to answer. */
1647 struct evdns_server_request
*dns_server_request
;
1649 #define NUM_CIRCUITS_LAUNCHED_THRESHOLD 10
1650 /** Number of times we've launched a circuit to handle this stream. If
1651 * it gets too high, that could indicate an inconsistency between our
1652 * "launch a circuit to handle this stream" logic and our "attach our
1653 * stream to one of the available circuits" logic. */
1654 unsigned int num_circuits_launched
:4;
1656 /** True iff this stream must attach to a one-hop circuit (e.g. for
1658 unsigned int want_onehop
:1;
1659 /** True iff this stream should use a BEGIN_DIR relay command to establish
1660 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1661 unsigned int use_begindir
:1;
1663 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1664 * stop requiring it. */
1665 unsigned int chosen_exit_optional
:1;
1666 /** For AP connections only. If non-zero, this exit node was picked as
1667 * a result of the TrackHostExit, and the value decrements every time
1668 * we fail to complete a circuit to our chosen exit -- if it reaches
1669 * zero, abandon the associated mapaddress. */
1670 unsigned int chosen_exit_retries
:3;
1672 /** True iff this is an AP connection that came from a transparent or
1673 * NATd connection */
1674 unsigned int is_transparent_ap
:1;
1676 /** For AP connections only: Set if this connection's target exit node
1677 * allows optimistic data (that is, data sent on this stream before
1678 * the exit has sent a CONNECTED cell) and we have chosen to use it.
1680 unsigned int may_use_optimistic_data
: 1;
1682 /** Are we a socks SocksSocket listener? */
1683 unsigned int is_socks_socket
:1;
1684 } entry_connection_t
;
1687 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1688 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1689 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
,
1690 DIR_SPOOL_MICRODESC
, /* NOTE: if we add another entry, add another bit. */
1691 } dir_spool_source_t
;
1692 #define dir_spool_source_bitfield_t ENUM_BF(dir_spool_source_t)
1694 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1695 * connection to retrieve or serve directory material. */
1696 typedef struct dir_connection_t
{
1699 /** Which 'resource' did we ask the directory for? This is typically the part
1700 * of the URL string that defines, relative to the directory conn purpose,
1701 * what thing we want. For example, in router descriptor downloads by
1702 * descriptor digest, it contains "d/", then one ore more +-separated
1705 char *requested_resource
;
1706 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1708 /* Used only for server sides of some dir connections, to implement
1709 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1710 * to append everything to the outbuf in one enormous chunk. */
1711 /** What exactly are we spooling right now? */
1712 dir_spool_source_bitfield_t dir_spool_src
: 3;
1714 /** If we're fetching descriptors, what router purpose shall we assign
1716 uint8_t router_purpose
;
1717 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1718 smartlist_t
*fingerprint_stack
;
1719 /** A cached_dir_t object that we're currently spooling out */
1720 struct cached_dir_t
*cached_dir
;
1721 /** The current offset into cached_dir. */
1722 off_t cached_dir_offset
;
1723 /** The zlib object doing on-the-fly compression for spooled data. */
1724 tor_zlib_state_t
*zlib_state
;
1726 /** What rendezvous service are we querying for? */
1727 rend_data_t
*rend_data
;
1729 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1730 * the directory server's signing key. */
1732 /** Unique ID for directory requests; this used to be in connection_t, but
1733 * that's going away and being used on channels instead. The dirserver still
1734 * needs this for the incoming side, so it's moved here. */
1738 /** Subtype of connection_t for an connection to a controller. */
1739 typedef struct control_connection_t
{
1742 uint64_t event_mask
; /**< Bitfield: which events does this controller
1744 * EVENT_MAX_ is >31, so we need a 64 bit mask */
1746 /** True if we have sent a protocolinfo reply on this connection. */
1747 unsigned int have_sent_protocolinfo
:1;
1748 /** True if we have received a takeownership command on this
1750 unsigned int is_owning_control_connection
:1;
1752 /** List of ephemeral onion services belonging to this connection. */
1753 smartlist_t
*ephemeral_onion_services
;
1755 /** If we have sent an AUTHCHALLENGE reply on this connection and
1756 * have not received a successful AUTHENTICATE command, points to
1757 * the value which the client must send to authenticate itself;
1758 * otherwise, NULL. */
1759 char *safecookie_client_hash
;
1761 /** Amount of space allocated in incoming_cmd. */
1762 uint32_t incoming_cmd_len
;
1763 /** Number of bytes currently stored in incoming_cmd. */
1764 uint32_t incoming_cmd_cur_len
;
1765 /** A control command that we're reading from the inbuf, but which has not
1766 * yet arrived completely. */
1768 } control_connection_t
;
1770 /** Cast a connection_t subtype pointer to a connection_t **/
1771 #define TO_CONN(c) (&(((c)->base_)))
1772 /** Helper macro: Given a pointer to to.base_, of type from*, return &to. */
1773 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, base_))
1775 /** Cast a entry_connection_t subtype pointer to a edge_connection_t **/
1776 #define ENTRY_TO_EDGE_CONN(c) (&(((c))->edge_))
1777 /** Cast a entry_connection_t subtype pointer to a connection_t **/
1778 #define ENTRY_TO_CONN(c) (TO_CONN(ENTRY_TO_EDGE_CONN(c)))
1780 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1782 static or_connection_t
*TO_OR_CONN(connection_t
*);
1783 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1785 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1786 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1788 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1789 /** Convert a connection_t* to an entry_connection_t*; assert if the cast is
1791 static entry_connection_t
*TO_ENTRY_CONN(connection_t
*);
1792 /** Convert a edge_connection_t* to an entry_connection_t*; assert if the cast
1794 static entry_connection_t
*EDGE_TO_ENTRY_CONN(edge_connection_t
*);
1795 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1797 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1798 /** Convert a connection_t* to an listener_connection_t*; assert if the cast is
1800 static listener_connection_t
*TO_LISTENER_CONN(connection_t
*);
1802 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1804 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1805 return DOWNCAST(or_connection_t
, c
);
1807 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1809 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1810 return DOWNCAST(dir_connection_t
, c
);
1812 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1814 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
||
1815 c
->magic
== ENTRY_CONNECTION_MAGIC
);
1816 return DOWNCAST(edge_connection_t
, c
);
1818 static INLINE entry_connection_t
*TO_ENTRY_CONN(connection_t
*c
)
1820 tor_assert(c
->magic
== ENTRY_CONNECTION_MAGIC
);
1821 return (entry_connection_t
*) SUBTYPE_P(c
, entry_connection_t
, edge_
.base_
);
1823 static INLINE entry_connection_t
*EDGE_TO_ENTRY_CONN(edge_connection_t
*c
)
1825 tor_assert(c
->base_
.magic
== ENTRY_CONNECTION_MAGIC
);
1826 return (entry_connection_t
*) SUBTYPE_P(c
, entry_connection_t
, edge_
);
1828 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1830 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1831 return DOWNCAST(control_connection_t
, c
);
1833 static INLINE listener_connection_t
*TO_LISTENER_CONN(connection_t
*c
)
1835 tor_assert(c
->magic
== LISTENER_CONNECTION_MAGIC
);
1836 return DOWNCAST(listener_connection_t
, c
);
1839 /* Conditional macros to help write code that works whether bufferevents are
1842 We can't just write:
1844 do bufferevent stuff;
1848 because the bufferevent stuff won't even compile unless we have a fairly
1849 new version of Libevent. Instead, we say:
1850 IF_HAS_BUFFEREVENT(conn, { do_bufferevent_stuff } );
1852 IF_HAS_BUFFEREVENT(conn, {
1853 do bufferevent stuff;
1854 }) ELSE_IF_NO_BUFFEREVENT {
1855 do non-bufferevent stuff;
1857 If we're compiling with bufferevent support, then the macros expand more or
1860 do_bufferevent_stuff;
1862 do non-bufferevent stuff;
1864 and if we aren't using bufferevents, they expand more or less to:
1865 { do non-bufferevent stuff; }
1867 #ifdef USE_BUFFEREVENTS
1868 #define HAS_BUFFEREVENT(c) (((c)->bufev) != NULL)
1869 #define IF_HAS_BUFFEREVENT(c, stmt) \
1870 if ((c)->bufev) do { \
1873 #define ELSE_IF_NO_BUFFEREVENT ; else
1874 #define IF_HAS_NO_BUFFEREVENT(c) \
1875 if (NULL == (c)->bufev)
1877 #define HAS_BUFFEREVENT(c) (0)
1878 #define IF_HAS_BUFFEREVENT(c, stmt) (void)0
1879 #define ELSE_IF_NO_BUFFEREVENT ;
1880 #define IF_HAS_NO_BUFFEREVENT(c) \
1884 /** What action type does an address policy indicate: accept or reject? */
1886 ADDR_POLICY_ACCEPT
=1,
1887 ADDR_POLICY_REJECT
=2,
1888 } addr_policy_action_t
;
1889 #define addr_policy_action_bitfield_t ENUM_BF(addr_policy_action_t)
1891 /** A reference-counted address policy rule. */
1892 typedef struct addr_policy_t
{
1893 int refcnt
; /**< Reference count */
1894 /** What to do when the policy matches.*/
1895 addr_policy_action_bitfield_t policy_type
:2;
1896 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1898 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1899 * copy (stored in a hash table to avoid
1900 * duplication of common policies) */
1901 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1902 * first <b>maskbits</b> bits of <b>a</b> match
1904 /** Base address to accept or reject.
1906 * Note that wildcards are treated
1907 * differntly depending on address family. An AF_UNSPEC address means
1908 * "All addresses, IPv4 or IPv6." An AF_INET address with maskbits==0 means
1909 * "All IPv4 addresses" and an AF_INET6 address with maskbits == 0 means
1910 * "All IPv6 addresses".
1913 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1914 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1917 /** A cached_dir_t represents a cacheable directory object, along with its
1918 * compressed form. */
1919 typedef struct cached_dir_t
{
1920 char *dir
; /**< Contents of this object, NUL-terminated. */
1921 char *dir_z
; /**< Compressed contents of this object. */
1922 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1923 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1924 time_t published
; /**< When was this object published. */
1925 digests_t digests
; /**< Digests of this object (networkstatus only) */
1926 int refcnt
; /**< Reference count for this cached_dir_t. */
1929 /** Enum used to remember where a signed_descriptor_t is stored and how to
1930 * manage the memory for signed_descriptor_body. */
1932 /** The descriptor isn't stored on disk at all: the copy in memory is
1933 * canonical; the saved_offset field is meaningless. */
1935 /** The descriptor is stored in the cached_routers file: the
1936 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1937 * saved_offset are used to index into the mmaped cache file. */
1939 /** The descriptor is stored in the cached_routers.new file: the
1940 * signed_descriptor_body and saved_offset fields are both set. */
1941 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1942 * lazy-load the descriptor text by using seek and read. We don't, for
1947 #define saved_location_bitfield_t ENUM_BF(saved_location_t)
1949 /** Enumeration: what kind of download schedule are we using for a given
1952 DL_SCHED_GENERIC
= 0,
1953 DL_SCHED_CONSENSUS
= 1,
1954 DL_SCHED_BRIDGE
= 2,
1955 } download_schedule_t
;
1956 #define download_schedule_bitfield_t ENUM_BF(download_schedule_t)
1958 /** Information about our plans for retrying downloads for a downloadable
1960 typedef struct download_status_t
{
1961 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1963 uint8_t n_download_failures
; /**< Number of failures trying to download the
1964 * most recent descriptor. */
1965 download_schedule_bitfield_t schedule
: 8;
1967 } download_status_t
;
1969 /** If n_download_failures is this high, the download can never happen. */
1970 #define IMPOSSIBLE_TO_DOWNLOAD 255
1972 /** The max size we expect router descriptor annotations we create to
1973 * be. We'll accept larger ones if we see them on disk, but we won't
1974 * create any that are larger than this. */
1975 #define ROUTER_ANNOTATION_BUF_LEN 256
1977 /** Information need to cache an onion router's descriptor. */
1978 typedef struct signed_descriptor_t
{
1979 /** Pointer to the raw server descriptor, preceded by annotations. Not
1980 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1981 * pointer is null. */
1982 char *signed_descriptor_body
;
1983 /** Length of the annotations preceding the server descriptor. */
1984 size_t annotations_len
;
1985 /** Length of the server descriptor. */
1986 size_t signed_descriptor_len
;
1987 /** Digest of the server descriptor, computed as specified in
1989 char signed_descriptor_digest
[DIGEST_LEN
];
1990 /** Identity digest of the router. */
1991 char identity_digest
[DIGEST_LEN
];
1992 /** Declared publication time of the descriptor. */
1993 time_t published_on
;
1994 /** For routerdescs only: digest of the corresponding extrainfo. */
1995 char extra_info_digest
[DIGEST_LEN
];
1996 /** For routerdescs only: Status of downloading the corresponding
1998 download_status_t ei_dl_status
;
1999 /** Where is the descriptor saved? */
2000 saved_location_t saved_location
;
2001 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
2002 * this descriptor in the corresponding file. */
2004 /** What position is this descriptor within routerlist->routers or
2005 * routerlist->old_routers? -1 for none. */
2006 int routerlist_index
;
2007 /** The valid-until time of the most recent consensus that listed this
2008 * descriptor. 0 for "never listed in a consensus, so far as we know." */
2009 time_t last_listed_as_valid_until
;
2010 /* If true, we do not ever try to save this object in the cache. */
2011 unsigned int do_not_cache
: 1;
2012 /* If true, this item is meant to represent an extrainfo. */
2013 unsigned int is_extrainfo
: 1;
2014 /* If true, we got an extrainfo for this item, and the digest was right,
2015 * but it was incompatible. */
2016 unsigned int extrainfo_is_bogus
: 1;
2017 /* If true, we are willing to transmit this item unencrypted. */
2018 unsigned int send_unencrypted
: 1;
2019 } signed_descriptor_t
;
2021 /** A signed integer representing a country code. */
2022 typedef int16_t country_t
;
2024 /** Information about another onion router in the network. */
2026 signed_descriptor_t cache_info
;
2027 /** A SHA256-digest of the extrainfo (if any) */
2028 char extra_info_digest256
[DIGEST256_LEN
];
2029 char *nickname
; /**< Human-readable OR name. */
2031 uint32_t addr
; /**< IPv4 address of OR, in host order. */
2032 uint16_t or_port
; /**< Port for TLS connections. */
2033 uint16_t dir_port
; /**< Port for HTTP directory connections. */
2035 /** A router's IPv6 address, if it has one. */
2036 /* XXXXX187 Actually these should probably be part of a list of addresses,
2037 * not just a special case. Use abstractions to access these; don't do it
2039 tor_addr_t ipv6_addr
;
2040 uint16_t ipv6_orport
;
2042 crypto_pk_t
*onion_pkey
; /**< Public RSA key for onions. */
2043 crypto_pk_t
*identity_pkey
; /**< Public RSA key for signing. */
2044 /** Public curve25519 key for onions */
2045 curve25519_public_key_t
*onion_curve25519_pkey
;
2046 /** Certificate for ed25519 signing key */
2047 struct tor_cert_st
*signing_key_cert
;
2048 /** What's the earliest expiration time on all the certs in this
2050 time_t cert_expiration_time
;
2052 char *platform
; /**< What software/operating system is this OR using? */
2055 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
2056 * bucket per second? */
2057 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
2058 /** How many bytes/s is this router known to handle? */
2059 uint32_t bandwidthcapacity
;
2060 smartlist_t
*exit_policy
; /**< What streams will this OR permit
2061 * to exit on IPv4? NULL for 'reject *:*'. */
2062 /** What streams will this OR permit to exit on IPv6?
2063 * NULL for 'reject *:*' */
2064 struct short_policy_t
*ipv6_exit_policy
;
2065 long uptime
; /**< How many seconds the router claims to have been up */
2066 smartlist_t
*declared_family
; /**< Nicknames of router which this router
2067 * claims are its family. */
2068 char *contact_info
; /**< Declared contact info for this router. */
2069 unsigned int is_hibernating
:1; /**< Whether the router claims to be
2071 unsigned int caches_extra_info
:1; /**< Whether the router says it caches and
2072 * serves extrainfo documents. */
2073 unsigned int allow_single_hop_exits
:1; /**< Whether the router says
2074 * it allows single hop exits. */
2076 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
2077 * a hidden service directory. */
2078 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
2079 * router rejects everything. */
2080 /** True if, after we have added this router, we should re-launch
2082 unsigned int needs_retest_if_added
:1;
2084 /** Tor can use this router for general positions in circuits; we got it
2085 * from a directory server as usual, or we're an authority and a server
2087 #define ROUTER_PURPOSE_GENERAL 0
2088 /** Tor should avoid using this router for circuit-building: we got it
2089 * from a crontroller. If the controller wants to use it, it'll have to
2090 * ask for it by identity. */
2091 #define ROUTER_PURPOSE_CONTROLLER 1
2092 /** Tor should use this router only for bridge positions in circuits: we got
2093 * it via a directory request from the bridge itself, or a bridge
2095 #define ROUTER_PURPOSE_BRIDGE 2
2096 /** Tor should not use this router; it was marked in cached-descriptors with
2097 * a purpose we didn't recognize. */
2098 #define ROUTER_PURPOSE_UNKNOWN 255
2100 /* In what way did we find out about this router? One of ROUTER_PURPOSE_*.
2101 * Routers of different purposes are kept segregated and used for different
2102 * things; see notes on ROUTER_PURPOSE_* macros above.
2107 /** Information needed to keep and cache a signed extra-info document. */
2108 typedef struct extrainfo_t
{
2109 signed_descriptor_t cache_info
;
2110 /** SHA256 digest of this document */
2111 uint8_t digest256
[DIGEST256_LEN
];
2112 /** The router's nickname. */
2113 char nickname
[MAX_NICKNAME_LEN
+1];
2114 /** Certificate for ed25519 signing key */
2115 struct tor_cert_st
*signing_key_cert
;
2116 /** True iff we found the right key for this extra-info, verified the
2117 * signature, and found it to be bad. */
2118 unsigned int bad_sig
: 1;
2119 /** If present, we didn't have the right key to verify this extra-info,
2120 * so this is a copy of the signature in the document. */
2122 /** Length of pending_sig. */
2123 size_t pending_sig_len
;
2126 /** Contents of a single router entry in a network status object.
2128 typedef struct routerstatus_t
{
2129 time_t published_on
; /**< When was this router published? */
2130 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
2132 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
2134 /** Digest of the router's most recent descriptor or microdescriptor.
2135 * If it's a descriptor, we only use the first DIGEST_LEN bytes. */
2136 char descriptor_digest
[DIGEST256_LEN
];
2137 uint32_t addr
; /**< IPv4 address for this router. */
2138 uint16_t or_port
; /**< OR port for this router. */
2139 uint16_t dir_port
; /**< Directory port for this router. */
2140 tor_addr_t ipv6_addr
; /**< IPv6 address for this router. */
2141 uint16_t ipv6_orport
; /**<IPV6 OR port for this router. */
2142 unsigned int is_authority
:1; /**< True iff this router is an authority. */
2143 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
2144 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
2145 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
2146 /** True iff this router is called 'running' in the consensus. We give it
2147 * this funny name so that we don't accidentally use this bit as a view of
2148 * whether we think the router is *currently* running. If that's what you
2149 * want to know, look at is_running in node_t. */
2150 unsigned int is_flagged_running
:1;
2151 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
2152 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
2154 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
2155 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
2156 * choice as an entry guard. */
2157 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
2159 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
2160 * service directory. */
2161 /** True iff we know version info for this router. (i.e., a "v" entry was
2162 * included.) We'll replace all these with a big tor_version_t or a char[]
2163 * if the number of traits we care about ever becomes incredibly big. */
2164 unsigned int version_known
:1;
2166 /** True iff this router has a version that allows it to accept EXTEND2
2168 unsigned int version_supports_extend2_cells
:1;
2170 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
2171 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
2172 unsigned int bw_is_unmeasured
:1; /**< This is a consensus entry, with
2173 * the Unmeasured flag set. */
2175 uint32_t bandwidth_kb
; /**< Bandwidth (capacity) of the router as reported in
2176 * the vote/consensus, in kilobytes/sec. */
2178 /** The consensus has guardfraction information for this router. */
2179 unsigned int has_guardfraction
:1;
2180 /** The guardfraction value of this router. */
2181 uint32_t guardfraction_percentage
;
2183 char *exitsummary
; /**< exit policy summary -
2184 * XXX weasel: this probably should not stay a string. */
2186 /* ---- The fields below aren't derived from the networkstatus; they
2187 * hold local information only. */
2189 time_t last_dir_503_at
; /**< When did this router last tell us that it
2190 * was too busy to serve directory info? */
2191 download_status_t dl_status
;
2195 /** A single entry in a parsed policy summary, describing a range of ports. */
2196 typedef struct short_policy_entry_t
{
2197 uint16_t min_port
, max_port
;
2198 } short_policy_entry_t
;
2200 /** A short_poliy_t is the parsed version of a policy summary. */
2201 typedef struct short_policy_t
{
2202 /** True if the members of 'entries' are port ranges to accept; false if
2203 * they are port ranges to reject */
2204 unsigned int is_accept
: 1;
2205 /** The actual number of values in 'entries'. */
2206 unsigned int n_entries
: 31;
2207 /** An array of 0 or more short_policy_entry_t values, each describing a
2208 * range of ports that this policy accepts or rejects (depending on the
2209 * value of is_accept).
2211 short_policy_entry_t entries
[FLEXIBLE_ARRAY_MEMBER
];
2214 /** A microdescriptor is the smallest amount of information needed to build a
2215 * circuit through a router. They are generated by the directory authorities,
2216 * using information from the uploaded routerinfo documents. They are not
2217 * self-signed, but are rather authenticated by having their hash in a signed
2218 * networkstatus document. */
2219 typedef struct microdesc_t
{
2220 /** Hashtable node, used to look up the microdesc by its digest. */
2221 HT_ENTRY(microdesc_t
) node
;
2223 /* Cache information */
2225 /** When was this microdescriptor last listed in a consensus document?
2226 * Once a microdesc has been unlisted long enough, we can drop it.
2229 /** Where is this microdescriptor currently stored? */
2230 saved_location_bitfield_t saved_location
: 3;
2231 /** If true, do not attempt to cache this microdescriptor on disk. */
2232 unsigned int no_save
: 1;
2233 /** If true, this microdesc has an entry in the microdesc_map */
2234 unsigned int held_in_map
: 1;
2235 /** Reference count: how many node_ts have a reference to this microdesc? */
2236 unsigned int held_by_nodes
;
2238 /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
2239 * microdescriptor in the cache. */
2242 /* The string containing the microdesc. */
2244 /** A pointer to the encoded body of the microdescriptor. If the
2245 * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
2246 * mmap'd region. Otherwise, it is a malloc'd string. The string might not
2247 * be NUL-terminated; take the length from <b>bodylen</b>. */
2249 /** The length of the microdescriptor in <b>body</b>. */
2251 /** A SHA256-digest of the microdescriptor. */
2252 char digest
[DIGEST256_LEN
];
2254 /* Fields in the microdescriptor. */
2256 /** As routerinfo_t.onion_pkey */
2257 crypto_pk_t
*onion_pkey
;
2258 /** As routerinfo_t.onion_curve25519_pkey */
2259 curve25519_public_key_t
*onion_curve25519_pkey
;
2260 /** Ed25519 identity key, if included. */
2261 ed25519_public_key_t
*ed25519_identity_pkey
;
2262 /** As routerinfo_t.ipv6_add */
2263 tor_addr_t ipv6_addr
;
2264 /** As routerinfo_t.ipv6_orport */
2265 uint16_t ipv6_orport
;
2266 /** As routerinfo_t.family */
2267 smartlist_t
*family
;
2268 /** IPv4 exit policy summary */
2269 short_policy_t
*exit_policy
;
2270 /** IPv6 exit policy summary */
2271 short_policy_t
*ipv6_exit_policy
;
2275 /** A node_t represents a Tor router.
2277 * Specifically, a node_t is a Tor router as we are using it: a router that
2278 * we are considering for circuits, connections, and so on. A node_t is a
2279 * thin wrapper around the routerstatus, routerinfo, and microdesc for a
2280 * single wrapper, and provides a consistent interface for all of them.
2282 * Also, a node_t has mutable state. While a routerinfo, a routerstatus,
2283 * and a microdesc have[*] only the information read from a router
2284 * descriptor, a consensus entry, and a microdescriptor (respectively)...
2285 * a node_t has flags based on *our own current opinion* of the node.
2287 * [*] Actually, there is some leftover information in each that is mutable.
2288 * We should try to excise that.
2290 typedef struct node_t
{
2291 /* Indexing information */
2293 /** Used to look up the node_t by its identity digest. */
2294 HT_ENTRY(node_t
) ht_ent
;
2295 /** Position of the node within the list of nodes */
2298 /** The identity digest of this node_t. No more than one node_t per
2299 * identity may exist at a time. */
2300 char identity
[DIGEST_LEN
];
2306 /* local info: copied from routerstatus, then possibly frobbed based
2307 * on experience. Authorities set this stuff directly. Note that
2308 * these reflect knowledge of the primary (IPv4) OR port only. */
2310 unsigned int is_running
:1; /**< As far as we know, is this OR currently
2312 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
2313 * (For Authdir: Have we validated this OR?) */
2314 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
2315 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
2316 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
2317 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
2318 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
2319 * or otherwise nasty? */
2320 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
2321 * directory according to the authorities. */
2323 /* Local info: warning state. */
2325 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
2326 * to this (unnamed) router by nickname?
2329 /** Local info: we treat this node as if it rejects everything */
2330 unsigned int rejects_all
:1;
2332 /** Local info: this node is in our list of guards */
2333 unsigned int using_as_guard
:1;
2335 /* Local info: derived. */
2337 /** True if the IPv6 OR port is preferred over the IPv4 OR port. */
2338 unsigned int ipv6_preferred
:1;
2340 /** According to the geoip db what country is this router in? */
2341 /* XXXprop186 what is this suppose to mean with multiple OR ports? */
2344 /* The below items are used only by authdirservers for
2345 * reachability testing. */
2347 /** When was the last time we could reach this OR? */
2348 time_t last_reachable
; /* IPv4. */
2349 time_t last_reachable6
; /* IPv6. */
2353 /** Linked list of microdesc hash lines for a single router in a directory
2356 typedef struct vote_microdesc_hash_t
{
2357 /** Next element in the list, or NULL. */
2358 struct vote_microdesc_hash_t
*next
;
2359 /** The raw contents of the microdesc hash line, from the "m" through the
2361 char *microdesc_hash_line
;
2362 } vote_microdesc_hash_t
;
2364 /** The claim about a single router, made in a vote. */
2365 typedef struct vote_routerstatus_t
{
2366 routerstatus_t status
; /**< Underlying 'status' object for this router.
2367 * Flags are redundant. */
2368 /** How many known-flags are allowed in a vote? This is the width of
2369 * the flags field of vote_routerstatus_t */
2370 #define MAX_KNOWN_FLAGS_IN_VOTE 64
2371 uint64_t flags
; /**< Bit-field for all recognized flags; index into
2372 * networkstatus_t.known_flags. */
2373 char *version
; /**< The version that the authority says this router is
2375 unsigned int has_measured_bw
:1; /**< The vote had a measured bw */
2376 unsigned int has_ed25519_listing
:1; /** DOCDOC */
2377 unsigned int ed25519_reflects_consensus
:1; /** DOCDOC */
2378 uint32_t measured_bw_kb
; /**< Measured bandwidth (capacity) of the router */
2379 /** The hash or hashes that the authority claims this microdesc has. */
2380 vote_microdesc_hash_t
*microdesc
;
2381 /** Ed25519 identity for this router, or zero if it has none. */
2382 uint8_t ed25519_id
[ED25519_PUBKEY_LEN
];
2383 } vote_routerstatus_t
;
2385 /** A signature of some document by an authority. */
2386 typedef struct document_signature_t
{
2387 /** Declared SHA-1 digest of this voter's identity key */
2388 char identity_digest
[DIGEST_LEN
];
2389 /** Declared SHA-1 digest of signing key used by this voter. */
2390 char signing_key_digest
[DIGEST_LEN
];
2391 /** Algorithm used to compute the digest of the document. */
2392 digest_algorithm_t alg
;
2393 /** Signature of the signed thing. */
2395 /** Length of <b>signature</b> */
2397 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
2398 * the sig, and we know it's bad. */
2399 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
2401 } document_signature_t
;
2403 /** Information about a single voter in a vote or a consensus. */
2404 typedef struct networkstatus_voter_info_t
{
2405 /** Declared SHA-1 digest of this voter's identity key */
2406 char identity_digest
[DIGEST_LEN
];
2407 char *nickname
; /**< Nickname of this voter */
2408 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
2409 * consensuses, we treat legacy keys as additional signers. */
2410 char legacy_id_digest
[DIGEST_LEN
];
2411 char *address
; /**< Address of this voter, in string format. */
2412 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
2413 uint16_t dir_port
; /**< Directory port of this voter */
2414 uint16_t or_port
; /**< OR port of this voter */
2415 char *contact
; /**< Contact information for this voter. */
2416 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
2418 /* Nothing from here on is signed. */
2419 /** The signature of the document and the signature's status. */
2421 } networkstatus_voter_info_t
;
2423 /** Enumerates the possible seriousness values of a networkstatus document. */
2428 } networkstatus_type_t
;
2430 /** Enumerates recognized flavors of a consensus networkstatus document. All
2431 * flavors of a consensus are generated from the same set of votes, but they
2432 * present different types information to different versions of Tor. */
2436 } consensus_flavor_t
;
2438 /** How many different consensus flavors are there? */
2439 #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
2441 /** A common structure to hold a v3 network status vote, or a v3 network
2442 * status consensus. */
2443 typedef struct networkstatus_t
{
2444 networkstatus_type_t type
; /**< Vote, consensus, or opinion? */
2445 consensus_flavor_t flavor
; /**< If a consensus, what kind? */
2446 unsigned int has_measured_bws
: 1;/**< True iff this networkstatus contains
2447 * measured= bandwidth values. */
2449 time_t published
; /**< Vote only: Time when vote was written. */
2450 time_t valid_after
; /**< Time after which this vote or consensus applies. */
2451 time_t fresh_until
; /**< Time before which this is the most recent vote or
2453 time_t valid_until
; /**< Time after which this vote or consensus should not
2456 /** Consensus only: what method was used to produce this consensus? */
2457 int consensus_method
;
2458 /** Vote only: what methods is this voter willing to use? */
2459 smartlist_t
*supported_methods
;
2461 /** List of 'package' lines describing hashes of downloadable packages */
2462 smartlist_t
*package_lines
;
2464 /** How long does this vote/consensus claim that authorities take to
2465 * distribute their votes to one another? */
2467 /** How long does this vote/consensus claim that authorities take to
2468 * distribute their consensus signatures to one another? */
2471 /** Comma-separated list of recommended client software, or NULL if this
2472 * voter has no opinion. */
2473 char *client_versions
;
2474 char *server_versions
;
2475 /** List of flags that this vote/consensus applies to routers. If a flag is
2476 * not listed here, the voter has no opinion on what its value should be. */
2477 smartlist_t
*known_flags
;
2479 /** List of key=value strings for the parameters in this vote or
2480 * consensus, sorted by key. */
2481 smartlist_t
*net_params
;
2483 /** List of key=value strings for the bw weight parameters in the
2485 smartlist_t
*weight_params
;
2487 /** List of networkstatus_voter_info_t. For a vote, only one element
2488 * is included. For a consensus, one element is included for every voter
2489 * whose vote contributed to the consensus. */
2490 smartlist_t
*voters
;
2492 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
2494 /** Digests of this document, as signed. */
2497 /** List of router statuses, sorted by identity digest. For a vote,
2498 * the elements are vote_routerstatus_t; for a consensus, the elements
2499 * are routerstatus_t. */
2500 smartlist_t
*routerstatus_list
;
2502 /** If present, a map from descriptor digest to elements of
2503 * routerstatus_list. */
2504 digestmap_t
*desc_digest_map
;
2507 /** A set of signatures for a networkstatus consensus. Unless otherwise
2508 * noted, all fields are as for networkstatus_t. */
2509 typedef struct ns_detached_signatures_t
{
2513 strmap_t
*digests
; /**< Map from flavor name to digestset_t */
2514 strmap_t
*signatures
; /**< Map from flavor name to list of
2515 * document_signature_t */
2516 } ns_detached_signatures_t
;
2518 /** Allowable types of desc_store_t. */
2519 typedef enum store_type_t
{
2524 /** A 'store' is a set of descriptors saved on disk, with accompanying
2525 * journal, mmaped as needed, rebuilt as needed. */
2526 typedef struct desc_store_t
{
2527 /** Filename (within DataDir) for the store. We append .tmp to this
2528 * filename for a temporary file when rebuilding the store, and .new to this
2529 * filename for the journal. */
2530 const char *fname_base
;
2531 /** Human-readable description of what this store contains. */
2532 const char *description
;
2534 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
2536 store_type_t type
; /**< What's stored in this store? */
2538 /** The size of the router log, in bytes. */
2540 /** The size of the router store, in bytes. */
2542 /** Total bytes dropped since last rebuild: this is space currently
2543 * used in the cache and the journal that could be freed by a rebuild. */
2544 size_t bytes_dropped
;
2547 /** Contents of a directory of onion routers. */
2549 /** Map from server identity digest to a member of routers. */
2550 struct digest_ri_map_t
*identity_map
;
2551 /** Map from server descriptor digest to a signed_descriptor_t from
2552 * routers or old_routers. */
2553 struct digest_sd_map_t
*desc_digest_map
;
2554 /** Map from extra-info digest to an extrainfo_t. Only exists for
2555 * routers in routers or old_routers. */
2556 struct digest_ei_map_t
*extra_info_map
;
2557 /** Map from extra-info digests to a signed_descriptor_t for a router
2558 * descriptor having that extra-info digest. Only exists for
2559 * routers in routers or old_routers. */
2560 struct digest_sd_map_t
*desc_by_eid_map
;
2561 /** List of routerinfo_t for all currently live routers we know. */
2562 smartlist_t
*routers
;
2563 /** List of signed_descriptor_t for older router descriptors we're
2565 smartlist_t
*old_routers
;
2566 /** Store holding server descriptors. If present, any router whose
2567 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
2568 * starting at cache_info.saved_offset */
2569 desc_store_t desc_store
;
2570 /** Store holding extra-info documents. */
2571 desc_store_t extrainfo_store
;
2574 /** Information on router used when extending a circuit. We don't need a
2575 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
2576 * connection, and onion_key to create the onionskin. Note that for onehop
2577 * general-purpose tunnels, the onion_key is NULL. */
2578 typedef struct extend_info_t
{
2579 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
2581 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
2582 uint16_t port
; /**< OR port. */
2583 tor_addr_t addr
; /**< IP address. */
2584 crypto_pk_t
*onion_key
; /**< Current onionskin key. */
2585 curve25519_public_key_t curve25519_onion_key
;
2588 /** Certificate for v3 directory protocol: binds long-term authority identity
2589 * keys to medium-term authority signing keys. */
2590 typedef struct authority_cert_t
{
2591 /** Information relating to caching this cert on disk and looking it up. */
2592 signed_descriptor_t cache_info
;
2593 /** This authority's long-term authority identity key. */
2594 crypto_pk_t
*identity_key
;
2595 /** This authority's medium-term signing key. */
2596 crypto_pk_t
*signing_key
;
2597 /** The digest of <b>signing_key</b> */
2598 char signing_key_digest
[DIGEST_LEN
];
2599 /** The listed expiration time of this certificate. */
2601 /** This authority's IPv4 address, in host order. */
2603 /** This authority's directory port. */
2607 /** Bitfield enum type listing types of information that directory authorities
2608 * can be authoritative about, and that directory caches may or may not cache.
2610 * Note that the granularity here is based on authority granularity and on
2611 * cache capabilities. Thus, one particular bit may correspond in practice to
2612 * a few types of directory info, so long as every authority that pronounces
2613 * officially about one of the types prounounces officially about all of them,
2614 * and so long as every cache that caches one of them caches all of them.
2618 /** Serves/signs v3 directory information: votes, consensuses, certs */
2619 V3_DIRINFO
= 1 << 2,
2620 /** Serves bridge descriptors. */
2621 BRIDGE_DIRINFO
= 1 << 4,
2622 /** Serves extrainfo documents. */
2623 EXTRAINFO_DIRINFO
=1 << 5,
2624 /** Serves microdescriptors. */
2625 MICRODESC_DIRINFO
=1 << 6,
2628 #define ALL_DIRINFO ((dirinfo_type_t)((1<<7)-1))
2630 #define CRYPT_PATH_MAGIC 0x70127012u
2632 struct fast_handshake_state_t
;
2633 struct ntor_handshake_state_t
;
2634 #define ONION_HANDSHAKE_TYPE_TAP 0x0000
2635 #define ONION_HANDSHAKE_TYPE_FAST 0x0001
2636 #define ONION_HANDSHAKE_TYPE_NTOR 0x0002
2637 #define MAX_ONION_HANDSHAKE_TYPE 0x0002
2641 struct fast_handshake_state_t
*fast
;
2643 struct ntor_handshake_state_t
*ntor
;
2645 } onion_handshake_state_t
;
2647 /** Holds accounting information for a single step in the layered encryption
2648 * performed by a circuit. Used only at the client edge of a circuit. */
2649 typedef struct crypt_path_t
{
2652 /* crypto environments */
2653 /** Encryption key and counter for cells heading towards the OR at this
2655 crypto_cipher_t
*f_crypto
;
2656 /** Encryption key and counter for cells heading back from the OR at this
2658 crypto_cipher_t
*b_crypto
;
2660 /** Digest state for cells heading towards the OR at this step. */
2661 crypto_digest_t
*f_digest
; /* for integrity checking */
2662 /** Digest state for cells heading away from the OR at this step. */
2663 crypto_digest_t
*b_digest
;
2665 /** Current state of the handshake as performed with the OR at this
2667 onion_handshake_state_t handshake_state
;
2668 /** Diffie-hellman handshake state for performing an introduction
2670 crypto_dh_t
*rend_dh_handshake_state
;
2672 /** Negotiated key material shared with the OR at this step. */
2673 char rend_circ_nonce
[DIGEST_LEN
];/* KH in tor-spec.txt */
2675 /** Information to extend to the OR at this step. */
2676 extend_info_t
*extend_info
;
2678 /** Is the circuit built to this step? Must be one of:
2679 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
2680 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
2681 * and not received an EXTENDED/CREATED)
2682 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
2684 #define CPATH_STATE_CLOSED 0
2685 #define CPATH_STATE_AWAITING_KEYS 1
2686 #define CPATH_STATE_OPEN 2
2687 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
2688 * (The list is circular, so the last node
2689 * links to the first.) */
2690 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
2693 int package_window
; /**< How many cells are we allowed to originate ending
2695 int deliver_window
; /**< How many cells are we willing to deliver originating
2699 /** A reference-counted pointer to a crypt_path_t, used only to share
2700 * the final rendezvous cpath to be used on a service-side rendezvous
2701 * circuit among multiple circuits built in parallel to the same
2702 * destination rendezvous point. */
2704 /** The reference count. */
2705 unsigned int refcount
;
2706 /** The pointer. Set to NULL when the crypt_path_t is put into use
2707 * on an opened rendezvous circuit. */
2708 crypt_path_t
*cpath
;
2709 } crypt_path_reference_t
;
2711 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
2713 #define DH_KEY_LEN DH_BYTES
2715 /** Information used to build a circuit. */
2717 /** Intended length of the final circuit. */
2718 int desired_path_len
;
2719 /** How to extend to the planned exit node. */
2720 extend_info_t
*chosen_exit
;
2721 /** Whether every node in the circ must have adequate uptime. */
2722 unsigned int need_uptime
: 1;
2723 /** Whether every node in the circ must have adequate capacity. */
2724 unsigned int need_capacity
: 1;
2725 /** Whether the last hop was picked with exiting in mind. */
2726 unsigned int is_internal
: 1;
2727 /** Did we pick this as a one-hop tunnel (not safe for other streams)?
2728 * These are for encrypted dir conns that exit to this router, not
2729 * for arbitrary exits from the circuit. */
2730 unsigned int onehop_tunnel
: 1;
2731 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
2732 crypt_path_t
*pending_final_cpath
;
2733 /** A ref-counted reference to the crypt_path_t to append after
2734 * rendezvous; used on the service side. */
2735 crypt_path_reference_t
*service_pending_final_cpath_ref
;
2736 /** How many times has building a circuit for this task failed? */
2738 /** At what time should we give up on this task? */
2740 } cpath_build_state_t
;
2742 /** "magic" value for an origin_circuit_t */
2743 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
2744 /** "magic" value for an or_circuit_t */
2745 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
2746 /** "magic" value for a circuit that would have been freed by circuit_free,
2747 * but which we're keeping around until a cpuworker reply arrives. See
2748 * circuit_free() for more documentation. */
2749 #define DEAD_CIRCUIT_MAGIC 0xdeadc14c
2751 struct create_cell_t
;
2753 /** Entry in the cell stats list of a circuit; used only if CELL_STATS
2754 * events are enabled. */
2755 typedef struct testing_cell_stats_entry_t
{
2756 uint8_t command
; /**< cell command number. */
2757 /** Waiting time in centiseconds if this event is for a removed cell,
2758 * or 0 if this event is for adding a cell to the queue. 22 bits can
2759 * store more than 11 hours, enough to assume that a circuit with this
2760 * delay would long have been closed. */
2761 unsigned int waiting_time
:22;
2762 unsigned int removed
:1; /**< 0 for added to, 1 for removed from queue. */
2763 unsigned int exitward
:1; /**< 0 for app-ward, 1 for exit-ward. */
2764 } testing_cell_stats_entry_t
;
2767 * A circuit is a path over the onion routing
2768 * network. Applications can connect to one end of the circuit, and can
2769 * create exit connections at the other end of the circuit. AP and exit
2770 * connections have only one circuit associated with them (and thus these
2771 * connection types are closed when the circuit is closed), whereas
2772 * OR connections multiplex many circuits at once, and stay standing even
2773 * when there are no circuits running over them.
2775 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
2776 * links two connections together: either an edge connection and an OR
2777 * connection, or two OR connections. (When joined to an OR connection, a
2778 * circuit_t affects only cells sent to a particular circID on that
2779 * connection. When joined to an edge connection, a circuit_t affects all
2782 * Second, an origin_circuit_t holds the cipher keys and state for sending data
2783 * along a given circuit. At the OP, it has a sequence of ciphers, each
2784 * of which is shared with a single OR along the circuit. Separate
2785 * ciphers are used for data going "forward" (away from the OP) and
2786 * "backward" (towards the OP). At the OR, a circuit has only two stream
2787 * ciphers: one for data going forward, and one for data going backward.
2789 typedef struct circuit_t
{
2790 uint32_t magic
; /**< For memory and type debugging: must equal
2791 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
2793 /** The channel that is next in this circuit. */
2797 * The circuit_id used in the next (forward) hop of this circuit;
2798 * this is unique to n_chan, but this ordered pair is globally
2801 * (n_chan->global_identifier, n_circ_id)
2806 * Circuit mux associated with n_chan to which this circuit is attached;
2807 * NULL if we have no n_chan.
2809 circuitmux_t
*n_mux
;
2811 /** Queue of cells waiting to be transmitted on n_chan */
2812 cell_queue_t n_chan_cells
;
2815 * The hop to which we want to extend this circuit. Should be NULL if
2816 * the circuit has attached to a channel.
2818 extend_info_t
*n_hop
;
2820 /** True iff we are waiting for n_chan_cells to become less full before
2821 * allowing p_streams to add any more cells. (Origin circuit only.) */
2822 unsigned int streams_blocked_on_n_chan
: 1;
2823 /** True iff we are waiting for p_chan_cells to become less full before
2824 * allowing n_streams to add any more cells. (OR circuit only.) */
2825 unsigned int streams_blocked_on_p_chan
: 1;
2827 /** True iff we have queued a delete backwards on this circuit, but not put
2828 * it on the output buffer. */
2829 unsigned int p_delete_pending
: 1;
2830 /** True iff we have queued a delete forwards on this circuit, but not put
2831 * it on the output buffer. */
2832 unsigned int n_delete_pending
: 1;
2834 /** True iff this circuit has received a DESTROY cell in either direction */
2835 unsigned int received_destroy
: 1;
2837 uint8_t state
; /**< Current status of this circuit. */
2838 uint8_t purpose
; /**< Why are we creating this circuit? */
2840 /** How many relay data cells can we package (read from edge streams)
2841 * on this circuit before we receive a circuit-level sendme cell asking
2844 /** How many relay data cells will we deliver (write to edge streams)
2845 * on this circuit? When deliver_window gets low, we send some
2846 * circuit-level sendme cells to indicate that we're willing to accept
2850 /** Temporary field used during circuits_handle_oom. */
2853 /** For storage while n_chan is pending (state CIRCUIT_STATE_CHAN_WAIT). */
2854 struct create_cell_t
*n_chan_create_cell
;
2856 /** When did circuit construction actually begin (ie send the
2857 * CREATE cell or begin cannibalization).
2859 * Note: This timer will get reset if we decide to cannibalize
2860 * a circuit. It may also get reset during certain phases of hidden
2861 * service circuit use.
2863 * We keep this timestamp with a higher resolution than most so that the
2864 * circuit-build-time tracking code can get millisecond resolution.
2866 struct timeval timestamp_began
;
2868 /** This timestamp marks when the init_circuit_base constructor ran. */
2869 struct timeval timestamp_created
;
2871 /** When the circuit was first used, or 0 if the circuit is clean.
2873 * XXXX023 Note that some code will artifically adjust this value backward
2874 * in time in order to indicate that a circuit shouldn't be used for new
2875 * streams, but that it can stay alive as long as it has streams on it.
2876 * That's a kludge we should fix.
2878 * XXX023 The CBT code uses this field to record when HS-related
2879 * circuits entered certain states. This usage probably won't
2880 * interfere with this field's primary purpose, but we should
2881 * document it more thoroughly to make sure of that.
2883 * XXX027 The SocksPort option KeepaliveIsolateSOCKSAuth will artificially
2884 * adjust this value forward each time a suitable stream is attached to an
2885 * already constructed circuit, potentially keeping the circuit alive
2888 time_t timestamp_dirty
;
2890 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
2891 * the main loop? (If true, holds the line number
2892 * where this circuit was marked.) */
2893 const char *marked_for_close_file
; /**< For debugging: in which file was this
2894 * circuit marked for close? */
2896 /** Unique ID for measuring tunneled network status requests. */
2899 /** Index in smartlist of all circuits (global_circuitlist). */
2900 int global_circuitlist_idx
;
2902 /** Next circuit in the doubly-linked ring of circuits waiting to add
2903 * cells to n_conn. NULL if we have no cells pending, or if we're not
2904 * linked to an OR connection. */
2905 struct circuit_t
*next_active_on_n_chan
;
2906 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2907 * cells to n_conn. NULL if we have no cells pending, or if we're not
2908 * linked to an OR connection. */
2909 struct circuit_t
*prev_active_on_n_chan
;
2911 /** Various statistics about cells being added to or removed from this
2912 * circuit's queues; used only if CELL_STATS events are enabled and
2913 * cleared after being sent to control port. */
2914 smartlist_t
*testing_cell_stats
;
2917 /** Largest number of relay_early cells that we can send on a given
2919 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
2922 * Describes the circuit building process in simplified terms based
2923 * on the path bias accounting state for a circuit.
2925 * NOTE: These state values are enumerated in the order for which we
2926 * expect circuits to transition through them. If you add states,
2927 * you need to preserve this overall ordering. The various pathbias
2928 * state transition and accounting functions (pathbias_mark_* and
2929 * pathbias_count_*) contain ordinal comparisons to enforce proper
2930 * state transitions for corrections.
2932 * This state machine and the associated logic was created to prevent
2933 * miscounting due to unknown cases of circuit reuse. See also tickets
2937 /** This circuit is "new". It has not yet completed a first hop
2938 * or been counted by the path bias code. */
2939 PATH_STATE_NEW_CIRC
= 0,
2940 /** This circuit has completed one/two hops, and has been counted by
2941 * the path bias logic. */
2942 PATH_STATE_BUILD_ATTEMPTED
= 1,
2943 /** This circuit has been completely built */
2944 PATH_STATE_BUILD_SUCCEEDED
= 2,
2945 /** Did we try to attach any SOCKS streams or hidserv introductions to
2948 * Note: If we ever implement end-to-end stream timing through test
2949 * stream probes (#5707), we must *not* set this for those probes
2950 * (or any other automatic streams) because the adversary could
2951 * just tag at a later point.
2953 PATH_STATE_USE_ATTEMPTED
= 3,
2954 /** Did any SOCKS streams or hidserv introductions actually succeed on
2957 * If any streams detatch/fail from this circuit, the code transitions
2958 * the circuit back to PATH_STATE_USE_ATTEMPTED to ensure we probe. See
2959 * pathbias_mark_use_rollback() for that.
2961 PATH_STATE_USE_SUCCEEDED
= 4,
2964 * This is a special state to indicate that we got a corrupted
2965 * relay cell on a circuit and we don't intend to probe it.
2967 PATH_STATE_USE_FAILED
= 5,
2970 * This is a special state to indicate that we already counted
2971 * the circuit. Used to guard against potential state machine
2974 PATH_STATE_ALREADY_COUNTED
= 6,
2976 #define path_state_bitfield_t ENUM_BF(path_state_t)
2978 /** An origin_circuit_t holds data necessary to build and use a circuit.
2980 typedef struct origin_circuit_t
{
2983 /** Linked list of AP streams (or EXIT streams if hidden service)
2984 * associated with this circuit. */
2985 edge_connection_t
*p_streams
;
2987 /** Bytes read from any attached stream since last call to
2988 * control_event_circ_bandwidth_used(). Only used if we're configured
2989 * to emit CIRC_BW events. */
2990 uint32_t n_read_circ_bw
;
2992 /** Bytes written to any attached stream since last call to
2993 * control_event_circ_bandwidth_used(). Only used if we're configured
2994 * to emit CIRC_BW events. */
2995 uint32_t n_written_circ_bw
;
2997 /** Build state for this circuit. It includes the intended path
2998 * length, the chosen exit router, rendezvous information, etc.
3000 cpath_build_state_t
*build_state
;
3001 /** The doubly-linked list of crypt_path_t entries, one per hop,
3002 * for this circuit. This includes ciphers for each hop,
3003 * integrity-checking digests for each hop, and package/delivery
3004 * windows for each hop.
3006 crypt_path_t
*cpath
;
3008 /** Holds all rendezvous data on either client or service side. */
3009 rend_data_t
*rend_data
;
3011 /** How many more relay_early cells can we send on this circuit, according
3012 * to the specification? */
3013 unsigned int remaining_relay_early_cells
: 4;
3015 /** Set if this circuit is insanely old and we already informed the user */
3016 unsigned int is_ancient
: 1;
3018 /** Set if this circuit has already been opened. Used to detect
3019 * cannibalized circuits. */
3020 unsigned int has_opened
: 1;
3023 * Path bias state machine. Used to ensure integrity of our
3024 * circuit building and usage accounting. See path_state_t
3027 path_state_bitfield_t path_state
: 3;
3029 /* If this flag is set, we should not consider attaching any more
3030 * connections to this circuit. */
3031 unsigned int unusable_for_new_conns
: 1;
3034 * Tristate variable to guard against pathbias miscounting
3035 * due to circuit purpose transitions changing the decision
3036 * of pathbias_should_count(). This variable is informational
3037 * only. The current results of pathbias_should_count() are
3038 * the official decision for pathbias accounting.
3040 uint8_t pathbias_shouldcount
;
3041 #define PATHBIAS_SHOULDCOUNT_UNDECIDED 0
3042 #define PATHBIAS_SHOULDCOUNT_IGNORED 1
3043 #define PATHBIAS_SHOULDCOUNT_COUNTED 2
3045 /** For path probing. Store the temporary probe stream ID
3046 * for response comparison */
3047 streamid_t pathbias_probe_id
;
3049 /** For path probing. Store the temporary probe address nonce
3050 * (in host byte order) for response comparison. */
3051 uint32_t pathbias_probe_nonce
;
3053 /** Set iff this is a hidden-service circuit which has timed out
3054 * according to our current circuit-build timeout, but which has
3055 * been kept around because it might still succeed in connecting to
3056 * its destination, and which is not a fully-connected rendezvous
3059 * (We clear this flag for client-side rendezvous circuits when they
3060 * are 'joined' to the other side's rendezvous circuit, so that
3061 * connection_ap_handshake_attach_circuit can put client streams on
3062 * the circuit. We also clear this flag for service-side rendezvous
3063 * circuits when they are 'joined' to a client's rend circ, but only
3064 * for symmetry with the client case. Client-side introduction
3065 * circuits are closed when we get a joined rend circ, and
3066 * service-side introduction circuits never have this flag set.) */
3067 unsigned int hs_circ_has_timed_out
: 1;
3069 /** Set iff this circuit has been given a relaxed timeout because
3070 * no circuits have opened. Used to prevent spamming logs. */
3071 unsigned int relaxed_timeout
: 1;
3073 /** Set iff this is a service-side rendezvous circuit for which a
3074 * new connection attempt has been launched. We consider launching
3075 * a new service-side rend circ to a client when the previous one
3076 * fails; now that we don't necessarily close a service-side rend
3077 * circ when we launch a new one to the same client, this flag keeps
3078 * us from launching two retries for the same failed rend circ. */
3079 unsigned int hs_service_side_rend_circ_has_been_relaunched
: 1;
3081 /** What commands were sent over this circuit that decremented the
3082 * RELAY_EARLY counter? This is for debugging task 878. */
3083 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
3085 /** How many RELAY_EARLY cells have been sent over this circuit? This is
3086 * for debugging task 878, too. */
3087 int relay_early_cells_sent
;
3089 /** The next stream_id that will be tried when we're attempting to
3090 * construct a new AP stream originating at this circuit. */
3091 streamid_t next_stream_id
;
3093 /* The intro key replaces the hidden service's public key if purpose is
3094 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
3095 * descriptor is used. */
3096 crypto_pk_t
*intro_key
;
3098 /** Quasi-global identifier for this circuit; used for control.c */
3099 /* XXXX NM This can get re-used after 2**32 circuits. */
3100 uint32_t global_identifier
;
3102 /** True if we have associated one stream to this circuit, thereby setting
3103 * the isolation paramaters for this circuit. Note that this doesn't
3104 * necessarily mean that we've <em>attached</em> any streams to the circuit:
3105 * we may only have marked up this circuit during the launch process.
3107 unsigned int isolation_values_set
: 1;
3108 /** True iff any stream has <em>ever</em> been attached to this circuit.
3110 * In a better world we could use timestamp_dirty for this, but
3111 * timestamp_dirty is far too overloaded at the moment.
3113 unsigned int isolation_any_streams_attached
: 1;
3115 /** A bitfield of ISO_* flags for every isolation field such that this
3116 * circuit has had streams with more than one value for that field
3117 * attached to it. */
3118 uint8_t isolation_flags_mixed
;
3120 /** @name Isolation parameters
3122 * If any streams have been associated with this circ (isolation_values_set
3123 * == 1), and all streams associated with the circuit have had the same
3124 * value for some field ((isolation_flags_mixed & ISO_FOO) == 0), then these
3125 * elements hold the value for that field.
3127 * Note again that "associated" is not the same as "attached": we
3128 * preliminarily associate streams with a circuit while the circuit is being
3129 * launched, so that we can tell whether we need to launch more circuits.
3133 uint8_t client_proto_type
;
3134 uint8_t client_proto_socksver
;
3136 tor_addr_t client_addr
;
3140 size_t socks_username_len
;
3141 uint8_t socks_password_len
;
3142 /* Note that the next two values are NOT NUL-terminated; see
3143 socks_username_len and socks_password_len for their lengths. */
3144 char *socks_username
;
3145 char *socks_password
;
3146 /** Global identifier for the first stream attached here; used by
3148 uint64_t associated_isolated_stream_global_id
;
3150 /** A list of addr_policy_t for this circuit in particular. Used by
3151 * adjust_exit_policy_from_exitpolicy_failure.
3153 smartlist_t
*prepend_policy
;
3156 struct onion_queue_t
;
3158 /** An or_circuit_t holds information needed to implement a circuit at an
3160 typedef struct or_circuit_t
{
3163 /** Next circuit in the doubly-linked ring of circuits waiting to add
3164 * cells to p_chan. NULL if we have no cells pending, or if we're not
3165 * linked to an OR connection. */
3166 struct circuit_t
*next_active_on_p_chan
;
3167 /** Previous circuit in the doubly-linked ring of circuits waiting to add
3168 * cells to p_chan. NULL if we have no cells pending, or if we're not
3169 * linked to an OR connection. */
3170 struct circuit_t
*prev_active_on_p_chan
;
3171 /** Pointer to an entry on the onion queue, if this circuit is waiting for a
3172 * chance to give an onionskin to a cpuworker. Used only in onion.c */
3173 struct onion_queue_t
*onionqueue_entry
;
3174 /** Pointer to a workqueue entry, if this circuit has given an onionskin to
3175 * a cpuworker and is waiting for a response. Used to decide whether it is
3176 * safe to free a circuit or if it is still in use by a cpuworker. */
3177 struct workqueue_entry_s
*workqueue_entry
;
3179 /** The circuit_id used in the previous (backward) hop of this circuit. */
3181 /** Queue of cells waiting to be transmitted on p_conn. */
3182 cell_queue_t p_chan_cells
;
3183 /** The channel that is previous in this circuit. */
3186 * Circuit mux associated with p_chan to which this circuit is attached;
3187 * NULL if we have no p_chan.
3189 circuitmux_t
*p_mux
;
3190 /** Linked list of Exit streams associated with this circuit. */
3191 edge_connection_t
*n_streams
;
3192 /** Linked list of Exit streams associated with this circuit that are
3193 * still being resolved. */
3194 edge_connection_t
*resolving_streams
;
3195 /** The cipher used by intermediate hops for cells heading toward the
3197 crypto_cipher_t
*p_crypto
;
3198 /** The cipher used by intermediate hops for cells heading away from
3200 crypto_cipher_t
*n_crypto
;
3202 /** The integrity-checking digest used by intermediate hops, for
3203 * cells packaged here and heading towards the OP.
3205 crypto_digest_t
*p_digest
;
3206 /** The integrity-checking digest used by intermediate hops, for
3207 * cells packaged at the OP and arriving here.
3209 crypto_digest_t
*n_digest
;
3211 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
3212 * is not marked for close. */
3213 struct or_circuit_t
*rend_splice
;
3215 struct or_circuit_rendinfo_s
*rendinfo
;
3217 /** Stores KH for the handshake. */
3218 char rend_circ_nonce
[DIGEST_LEN
];/* KH in tor-spec.txt */
3220 /** How many more relay_early cells can we send on this circuit, according
3221 * to the specification? */
3222 unsigned int remaining_relay_early_cells
: 4;
3224 /* We have already received an INTRODUCE1 cell on this circuit. */
3225 unsigned int already_received_introduce1
: 1;
3227 /** True iff this circuit was made with a CREATE_FAST cell. */
3228 unsigned int is_first_hop
: 1;
3230 /** If set, this circuit carries HS traffic. Consider it in any HS
3232 unsigned int circuit_carries_hs_traffic_stats
: 1;
3234 /** Number of cells that were removed from circuit queue; reset every
3235 * time when writing buffer stats to disk. */
3236 uint32_t processed_cells
;
3238 /** Total time in milliseconds that cells spent in both app-ward and
3239 * exit-ward queues of this circuit; reset every time when writing
3240 * buffer stats to disk. */
3241 uint64_t total_cell_waiting_time
;
3243 /** Maximum cell queue size for a middle relay; this is stored per circuit
3244 * so append_cell_to_circuit_queue() can adjust it if it changes. If set
3245 * to zero, it is initialized to the default value.
3247 uint32_t max_middle_cells
;
3250 typedef struct or_circuit_rendinfo_s
{
3252 #if REND_COOKIE_LEN != DIGEST_LEN
3253 #error "The REND_TOKEN_LEN macro assumes REND_COOKIE_LEN == DIGEST_LEN"
3255 #define REND_TOKEN_LEN DIGEST_LEN
3257 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
3258 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
3261 char rend_token
[REND_TOKEN_LEN
];
3263 /** True if this is a rendezvous point circuit; false if this is an
3264 * introduction point. */
3265 unsigned is_rend_circ
;
3267 } or_circuit_rendinfo_t
;
3269 /** Convert a circuit subtype to a circuit_t. */
3270 #define TO_CIRCUIT(x) (&((x)->base_))
3272 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Assert
3273 * if the cast is impossible. */
3274 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
3275 static const or_circuit_t
*CONST_TO_OR_CIRCUIT(const circuit_t
*);
3276 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
3277 * Assert if the cast is impossible. */
3278 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
3279 static const origin_circuit_t
*CONST_TO_ORIGIN_CIRCUIT(const circuit_t
*);
3281 /** Return 1 iff <b>node</b> has Exit flag and no BadExit flag.
3282 * Otherwise, return 0.
3284 static INLINE
int node_is_good_exit(const node_t
*node
)
3286 return node
->is_exit
&& ! node
->is_bad_exit
;
3289 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
3291 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
3292 return DOWNCAST(or_circuit_t
, x
);
3294 static INLINE
const or_circuit_t
*CONST_TO_OR_CIRCUIT(const circuit_t
*x
)
3296 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
3297 return DOWNCAST(or_circuit_t
, x
);
3299 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
3301 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
3302 return DOWNCAST(origin_circuit_t
, x
);
3304 static INLINE
const origin_circuit_t
*CONST_TO_ORIGIN_CIRCUIT(
3307 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
3308 return DOWNCAST(origin_circuit_t
, x
);
3311 /** Bitfield type: things that we're willing to use invalid routers for. */
3312 typedef enum invalid_router_usage_t
{
3313 ALLOW_INVALID_ENTRY
=1,
3314 ALLOW_INVALID_EXIT
=2,
3315 ALLOW_INVALID_MIDDLE
=4,
3316 ALLOW_INVALID_RENDEZVOUS
=8,
3317 ALLOW_INVALID_INTRODUCTION
=16,
3318 } invalid_router_usage_t
;
3320 /* limits for TCP send and recv buffer size used for constrained sockets */
3321 #define MIN_CONSTRAINED_TCP_BUFFER 2048
3322 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
3324 /** @name Isolation flags
3326 Ways to isolate client streams
3330 /** Isolate based on destination port */
3331 #define ISO_DESTPORT (1u<<0)
3332 /** Isolate based on destination address */
3333 #define ISO_DESTADDR (1u<<1)
3334 /** Isolate based on SOCKS authentication */
3335 #define ISO_SOCKSAUTH (1u<<2)
3336 /** Isolate based on client protocol choice */
3337 #define ISO_CLIENTPROTO (1u<<3)
3338 /** Isolate based on client address */
3339 #define ISO_CLIENTADDR (1u<<4)
3340 /** Isolate based on session group (always on). */
3341 #define ISO_SESSIONGRP (1u<<5)
3342 /** Isolate based on newnym epoch (always on). */
3343 #define ISO_NYM_EPOCH (1u<<6)
3344 /** Isolate all streams (Internal only). */
3345 #define ISO_STREAM (1u<<7)
3348 /** Default isolation level for ports. */
3349 #define ISO_DEFAULT (ISO_CLIENTADDR|ISO_SOCKSAUTH|ISO_SESSIONGRP|ISO_NYM_EPOCH)
3351 /** Indicates that we haven't yet set a session group on a port_cfg_t. */
3352 #define SESSION_GROUP_UNSET -1
3353 /** Session group reserved for directory connections */
3354 #define SESSION_GROUP_DIRCONN -2
3355 /** Session group reserved for resolve requests launched by a controller */
3356 #define SESSION_GROUP_CONTROL_RESOLVE -3
3357 /** First automatically allocated session group number */
3358 #define SESSION_GROUP_FIRST_AUTO -4
3360 /** Configuration for a single port that we're listening on. */
3361 typedef struct port_cfg_t
{
3362 tor_addr_t addr
; /**< The actual IP to listen on, if !is_unix_addr. */
3363 int port
; /**< The configured port, or CFG_AUTO_PORT to tell Tor to pick its
3365 uint8_t type
; /**< One of CONN_TYPE_*_LISTENER */
3366 unsigned is_unix_addr
: 1; /**< True iff this is an AF_UNIX address. */
3368 unsigned is_group_writable
: 1;
3369 unsigned is_world_writable
: 1;
3371 entry_port_cfg_t entry_cfg
;
3373 server_port_cfg_t server_cfg
;
3375 /* Unix sockets only: */
3376 /** Path for an AF_UNIX address */
3377 char unix_addr
[FLEXIBLE_ARRAY_MEMBER
];
3380 /** Ordinary configuration line. */
3381 #define CONFIG_LINE_NORMAL 0
3382 /** Appends to previous configuration for the same option, even if we
3383 * would ordinary replace it. */
3384 #define CONFIG_LINE_APPEND 1
3385 /* Removes all previous configuration for an option. */
3386 #define CONFIG_LINE_CLEAR 2
3388 /** A linked list of lines in a config file. */
3389 typedef struct config_line_t
{
3392 struct config_line_t
*next
;
3393 /** What special treatment (if any) does this line require? */
3394 unsigned int command
:2;
3395 /** If true, subsequent assignments to this linelist should replace
3396 * it, not extend it. Set only on the first item in a linelist in an
3398 unsigned int fragile
:1;
3401 typedef struct routerset_t routerset_t
;
3403 /** A magic value for the (Socks|OR|...)Port options below, telling Tor
3404 * to pick its own port. */
3405 #define CFG_AUTO_PORT 0xc4005e
3407 /** Configuration options for a Tor process. */
3411 /** What should the tor process actually do? */
3413 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
3414 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
, CMD_DUMP_CONFIG
,
3417 char *command_arg
; /**< Argument for command-line option. */
3419 config_line_t
*Logs
; /**< New-style list of configuration lines
3421 int LogTimeGranularity
; /**< Log resolution in milliseconds. */
3423 int LogMessageDomains
; /**< Boolean: Should we log the domain(s) in which
3424 * each log message occurs? */
3425 int TruncateLogFile
; /**< Boolean: Should we truncate the log file
3426 before we start writing? */
3428 char *DebugLogFile
; /**< Where to send verbose log messages. */
3429 char *DataDirectory
; /**< OR only: where to store long-term data. */
3430 char *Nickname
; /**< OR only: nickname of this onion router. */
3431 char *Address
; /**< OR only: configured address for this onion router. */
3432 char *PidFile
; /**< Where to store PID of Tor process. */
3434 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
3435 * country codes and IP address patterns of ORs to
3436 * consider as exits. */
3437 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
3438 * country codes and IP address patterns of ORs to
3439 * consider as entry points. */
3440 int StrictNodes
; /**< Boolean: When none of our EntryNodes or ExitNodes
3441 * are up, or we need to access a node in ExcludeNodes,
3442 * do we just fail instead? */
3443 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
3444 * country codes and IP address patterns of ORs
3445 * not to use in circuits. But see StrictNodes
3447 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
3448 * country codes and IP address patterns of
3449 * ORs not to consider as exits. */
3451 /** Union of ExcludeNodes and ExcludeExitNodes */
3452 routerset_t
*ExcludeExitNodesUnion_
;
3454 int DisableAllSwap
; /**< Boolean: Attempt to call mlockall() on our
3455 * process for all current and future memory. */
3457 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
3458 smartlist_t
*AllowInvalidNodes
;
3459 /** Bitmask; derived from AllowInvalidNodes. */
3460 invalid_router_usage_t AllowInvalid_
;
3461 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
3462 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
3463 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
3464 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
3465 /** Addresses to bind for listening for SOCKS connections. */
3466 config_line_t
*SocksListenAddress
;
3467 /** Addresses to bind for listening for transparent pf/netfilter
3469 config_line_t
*TransListenAddress
;
3470 /** Addresses to bind for listening for transparent natd connections */
3471 config_line_t
*NATDListenAddress
;
3472 /** Addresses to bind for listening for SOCKS connections. */
3473 config_line_t
*DNSListenAddress
;
3474 /** Addresses to bind for listening for OR connections. */
3475 config_line_t
*ORListenAddress
;
3476 /** Addresses to bind for listening for directory connections. */
3477 config_line_t
*DirListenAddress
;
3478 /** Addresses to bind for listening for control connections. */
3479 config_line_t
*ControlListenAddress
;
3480 /** Local address to bind outbound sockets */
3481 config_line_t
*OutboundBindAddress
;
3482 /** IPv4 address derived from OutboundBindAddress. */
3483 tor_addr_t OutboundBindAddressIPv4_
;
3484 /** IPv6 address derived from OutboundBindAddress. */
3485 tor_addr_t OutboundBindAddressIPv6_
;
3486 /** Directory server only: which versions of
3487 * Tor should we tell users to run? */
3488 config_line_t
*RecommendedVersions
;
3489 config_line_t
*RecommendedClientVersions
;
3490 config_line_t
*RecommendedServerVersions
;
3491 config_line_t
*RecommendedPackages
;
3492 /** Whether dirservers allow router descriptors with private IPs. */
3493 int DirAllowPrivateAddresses
;
3494 /** Whether routers accept EXTEND cells to routers with private IPs. */
3495 int ExtendAllowPrivateAddresses
;
3496 char *User
; /**< Name of user to run Tor as. */
3497 char *Group
; /**< Name of group to run Tor as. */
3498 config_line_t
*ORPort_lines
; /**< Ports to listen on for OR connections. */
3499 /** Ports to listen on for extended OR connections. */
3500 config_line_t
*ExtORPort_lines
;
3501 /** Ports to listen on for SOCKS connections. */
3502 config_line_t
*SocksPort_lines
;
3503 /** Ports to listen on for transparent pf/netfilter connections. */
3504 config_line_t
*TransPort_lines
;
3505 const char *TransProxyType
; /**< What kind of transparent proxy
3506 * implementation are we using? */
3507 /** Parsed value of TransProxyType. */
3513 } TransProxyType_parsed
;
3514 config_line_t
*NATDPort_lines
; /**< Ports to listen on for transparent natd
3516 config_line_t
*ControlPort_lines
; /**< Ports to listen on for control
3518 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
3519 * for control connections. */
3521 int ControlSocketsGroupWritable
; /**< Boolean: Are control sockets g+rw? */
3522 int SocksSocketsGroupWritable
; /**< Boolean: Are SOCKS sockets g+rw? */
3523 /** Ports to listen on for directory connections. */
3524 config_line_t
*DirPort_lines
;
3525 config_line_t
*DNSPort_lines
; /**< Ports to listen on for DNS requests. */
3527 /* MaxMemInQueues value as input by the user. We clean this up to be
3528 * MaxMemInQueues. */
3529 uint64_t MaxMemInQueues_raw
;
3530 uint64_t MaxMemInQueues
;/**< If we have more memory than this allocated
3531 * for queues and buffers, run the OOM handler */
3532 /** Above this value, consider ourselves low on RAM. */
3533 uint64_t MaxMemInQueues_low_threshold
;
3535 /** @name port booleans
3537 * Derived booleans: True iff there is a non-listener port on an AF_INET or
3538 * AF_INET6 address of the given type configured in one of the _lines
3543 unsigned int ORPort_set
: 1;
3544 unsigned int SocksPort_set
: 1;
3545 unsigned int TransPort_set
: 1;
3546 unsigned int NATDPort_set
: 1;
3547 unsigned int ControlPort_set
: 1;
3548 unsigned int DirPort_set
: 1;
3549 unsigned int DNSPort_set
: 1;
3550 unsigned int ExtORPort_set
: 1;
3553 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
3554 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
3555 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
3556 * for version 3 directories? */
3557 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
3558 * directory that's willing to recommend
3560 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
3561 * that aggregates bridge descriptors? */
3563 /** If set on a bridge authority, it will answer requests on its dirport
3564 * for bridge statuses -- but only if the requests use this password. */
3565 char *BridgePassword
;
3566 /** If BridgePassword is set, this is a SHA256 digest of the basic http
3567 * authenticator for it. Used so we can do a time-independent comparison. */
3568 char *BridgePassword_AuthDigest_
;
3570 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
3571 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
3573 config_line_t
*ClientTransportPlugin
; /**< List of client
3574 transport plugins. */
3576 config_line_t
*ServerTransportPlugin
; /**< List of client
3577 transport plugins. */
3579 /** List of TCP/IP addresses that transports should listen at. */
3580 config_line_t
*ServerTransportListenAddr
;
3582 /** List of options that must be passed to pluggable transports. */
3583 config_line_t
*ServerTransportOptions
;
3585 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
3586 * this explicit so we can change how we behave in the
3589 /** Boolean: if we know the bridge's digest, should we get new
3590 * descriptors from the bridge authorities or from the bridge itself? */
3591 int UpdateBridgesFromAuthority
;
3593 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
3595 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
3596 /** To what authority types do we publish our descriptor? Choices are
3597 * "v1", "v2", "v3", "bridge", or "". */
3598 smartlist_t
*PublishServerDescriptor
;
3599 /** A bitfield of authority types, derived from PublishServerDescriptor. */
3600 dirinfo_type_t PublishServerDescriptor_
;
3601 /** Boolean: do we publish hidden service descriptors to the HS auths? */
3602 int PublishHidServDescriptors
;
3603 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
3604 int FetchHidServDescriptors
; /**< and hidden service descriptors? */
3606 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
3607 * service directories after what time? */
3609 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
3610 int AllDirActionsPrivate
; /**< Should every directory action be sent
3611 * through a Tor circuit? */
3613 /** Run in 'tor2web mode'? (I.e. only make client connections to hidden
3614 * services, and use a single hop for all hidden-service-related
3618 /** A routerset that should be used when picking RPs for HS circuits. */
3619 routerset_t
*Tor2webRendezvousPoints
;
3621 /** Close hidden service client circuits immediately when they reach
3622 * the normal circuit-build timeout, even if they have already sent
3623 * an INTRODUCE1 cell on its way to the service. */
3624 int CloseHSClientCircuitsImmediatelyOnTimeout
;
3626 /** Close hidden-service-side rendezvous circuits immediately when
3627 * they reach the normal circuit-build timeout. */
3628 int CloseHSServiceRendCircuitsImmediatelyOnTimeout
;
3630 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
3631 int ConnLimit_
; /**< Maximum allowed number of simultaneous connections. */
3632 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
3633 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
3634 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
3636 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
3637 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
3638 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
3640 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
3641 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
3643 /** Whether we should drop exit streams from Tors that we don't know are
3644 * relays. One of "0" (never refuse), "1" (always refuse), or "-1" (do
3645 * what the consensus says, defaulting to 'refuse' if the consensus says
3647 int RefuseUnknownExits
;
3649 /** Application ports that require all nodes in circ to have sufficient
3651 smartlist_t
*LongLivedPorts
;
3652 /** Application ports that are likely to be unencrypted and
3653 * unauthenticated; we reject requests for them to prevent the
3654 * user from screwing up and leaking plaintext secrets to an
3655 * observer somewhere on the Internet. */
3656 smartlist_t
*RejectPlaintextPorts
;
3657 /** Related to RejectPlaintextPorts above, except this config option
3658 * controls whether we warn (in the log and via a controller status
3659 * event) every time a risky connection is attempted. */
3660 smartlist_t
*WarnPlaintextPorts
;
3661 /** Should we try to reuse the same exit node for a given host */
3662 smartlist_t
*TrackHostExits
;
3663 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
3665 config_line_t
*AddressMap
; /**< List of address map directives. */
3666 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
3667 * hostname ending with one of the suffixes in
3668 * <b>AutomapHostsSuffixes</b>, map it to a
3669 * virtual address. */
3670 /** List of suffixes for <b>AutomapHostsOnResolve</b>. The special value
3671 * "." means "match everything." */
3672 smartlist_t
*AutomapHostsSuffixes
;
3673 int RendPostPeriod
; /**< How often do we post each rendezvous service
3674 * descriptor? Remember to publish them independently. */
3675 int KeepalivePeriod
; /**< How often do we send padding cells to keep
3676 * connections alive? */
3677 int SocksTimeout
; /**< How long do we let a socks connection wait
3678 * unattached before we fail it? */
3679 int LearnCircuitBuildTimeout
; /**< If non-zero, we attempt to learn a value
3680 * for CircuitBuildTimeout based on timeout
3682 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born at
3683 * least this many seconds ago. Used until
3684 * adaptive algorithm learns a new value. */
3685 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
3686 * at least this many seconds ago. */
3687 int CircuitStreamTimeout
; /**< If non-zero, detach streams from circuits
3688 * and try a new circuit if the stream has been
3689 * waiting for this many seconds. If zero, use
3690 * our default internal timeout schedule. */
3691 int MaxOnionQueueDelay
; /**<DOCDOC*/
3692 int NewCircuitPeriod
; /**< How long do we use a circuit before building
3694 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
3695 this interval ago. */
3696 int PredictedPortsRelevanceTime
; /** How long after we've requested a
3697 * connection for a given port, do we want
3698 * to continue to pick exits that support
3700 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
3701 * to use in a second? */
3702 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
3703 * to use in a second? */
3704 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
3705 * tell people we have? */
3706 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
3707 * willing to use for all relayed conns? */
3708 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
3709 * use in a second for all relayed conns? */
3710 uint64_t PerConnBWRate
; /**< Long-term bw on a single TLS conn, if set. */
3711 uint64_t PerConnBWBurst
; /**< Allowed burst on a single TLS conn, if set. */
3712 int NumCPUs
; /**< How many CPUs should we try to use? */
3713 //int RunTesting; /**< If true, create testing circuits to measure how well the
3714 // * other ORs are running. */
3715 config_line_t
*RendConfigLines
; /**< List of configuration lines
3716 * for rendezvous services. */
3717 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
3718 * authorizations for hidden services */
3719 char *ContactInfo
; /**< Contact info to be published in the directory. */
3721 int HeartbeatPeriod
; /**< Log heartbeat messages after this many seconds
3724 char *HTTPProxy
; /**< hostname[:port] to use as http proxy, if any. */
3725 tor_addr_t HTTPProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
3726 uint16_t HTTPProxyPort
; /**< Parsed port for http proxy, if any. */
3727 char *HTTPProxyAuthenticator
; /**< username:password string, if any. */
3729 char *HTTPSProxy
; /**< hostname[:port] to use as https proxy, if any. */
3730 tor_addr_t HTTPSProxyAddr
; /**< Parsed addr for https proxy, if any. */
3731 uint16_t HTTPSProxyPort
; /**< Parsed port for https proxy, if any. */
3732 char *HTTPSProxyAuthenticator
; /**< username:password string, if any. */
3734 char *Socks4Proxy
; /**< hostname:port to use as a SOCKS4 proxy, if any. */
3735 tor_addr_t Socks4ProxyAddr
; /**< Derived from Socks4Proxy. */
3736 uint16_t Socks4ProxyPort
; /**< Derived from Socks4Proxy. */
3738 char *Socks5Proxy
; /**< hostname:port to use as a SOCKS5 proxy, if any. */
3739 tor_addr_t Socks5ProxyAddr
; /**< Derived from Sock5Proxy. */
3740 uint16_t Socks5ProxyPort
; /**< Derived from Socks5Proxy. */
3741 char *Socks5ProxyUsername
; /**< Username for SOCKS5 authentication, if any */
3742 char *Socks5ProxyPassword
; /**< Password for SOCKS5 authentication, if any */
3744 /** List of configuration lines for replacement directory authorities.
3745 * If you just want to replace one class of authority at a time,
3746 * use the "Alternate*Authority" options below instead. */
3747 config_line_t
*DirAuthorities
;
3749 /** List of fallback directory servers */
3750 config_line_t
*FallbackDir
;
3752 /** Weight to apply to all directory authority rates if considering them
3753 * along with fallbackdirs */
3754 double DirAuthorityFallbackRate
;
3756 /** If set, use these main (currently v3) directory authorities and
3757 * not the default ones. */
3758 config_line_t
*AlternateDirAuthority
;
3760 /** If set, use these bridge authorities and not the default one. */
3761 config_line_t
*AlternateBridgeAuthority
;
3763 char *MyFamily
; /**< Declared family for this OR. */
3764 config_line_t
*NodeFamilies
; /**< List of config lines for
3766 smartlist_t
*NodeFamilySets
; /**< List of parsed NodeFamilies values. */
3767 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
3768 * mark as bad exits. */
3769 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
3771 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
3772 * never mark as valid. */
3773 /** @name AuthDir...CC
3775 * Lists of country codes to mark as BadExit, or Invalid, or to
3780 smartlist_t
*AuthDirBadExitCCs
;
3781 smartlist_t
*AuthDirInvalidCCs
;
3782 smartlist_t
*AuthDirRejectCCs
;
3785 int AuthDirListBadExits
; /**< True iff we should list bad exits,
3786 * and vote for all other exits as good. */
3787 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
3788 * number of servers per IP address. */
3789 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
3790 * number of servers per IP address shared
3791 * with an authority. */
3792 int AuthDirHasIPv6Connectivity
; /**< Boolean: are we on IPv6? */
3794 /** If non-zero, always vote the Fast flag for any relay advertising
3795 * this amount of capacity or more. */
3796 uint64_t AuthDirFastGuarantee
;
3798 /** If non-zero, this advertised capacity or more is always sufficient
3799 * to satisfy the bandwidth requirement for the Guard flag. */
3800 uint64_t AuthDirGuardBWGuarantee
;
3802 char *AccountingStart
; /**< How long is the accounting interval, and when
3804 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
3805 * interval before hibernation? 0 for "never
3807 /** How do we determine when our AccountingMax has been reached?
3808 * "max" for when in or out reaches AccountingMax
3809 * "sum for when in plus out reaches AccountingMax */
3810 char *AccountingRule_option
;
3811 enum { ACCT_MAX
, ACCT_SUM
} AccountingRule
;
3813 /** Base64-encoded hash of accepted passwords for the control system. */
3814 config_line_t
*HashedControlPassword
;
3815 /** As HashedControlPassword, but not saved. */
3816 config_line_t
*HashedControlSessionPassword
;
3818 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
3819 * the control system? */
3820 char *CookieAuthFile
; /**< Filesystem location of a ControlPort
3821 * authentication cookie. */
3822 char *ExtORPortCookieAuthFile
; /**< Filesystem location of Extended
3823 * ORPort authentication cookie. */
3824 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
3825 int ExtORPortCookieAuthFileGroupReadable
; /**< Boolean: Is the
3826 * ExtORPortCookieAuthFile g+r? */
3827 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
3828 * circuits itself (0), or does it expect a controller
3830 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
3831 * make circuits in the background (0),
3834 /** Process specifier for a controller that ‘owns’ this Tor
3835 * instance. Tor will terminate if its owning controller does. */
3836 char *OwningControllerProcess
;
3838 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
3839 * long do we wait before exiting? */
3840 char *SafeLogging
; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
3842 /* Derived from SafeLogging */
3844 SAFELOG_SCRUB_ALL
, SAFELOG_SCRUB_RELAY
, SAFELOG_SCRUB_NONE
3847 int Sandbox
; /**< Boolean: should sandboxing be enabled? */
3848 int SafeSocks
; /**< Boolean: should we outright refuse application
3849 * connections that use socks4 or socks5-with-local-dns? */
3850 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
3851 LOG_WARN : LOG_INFO)
3852 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
3853 * protocol, is it a warn or an info in our logs? */
3854 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
3855 * log whether it was DNS-leaking or not? */
3856 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
3857 * acceleration where available? */
3858 /** Token Bucket Refill resolution in milliseconds. */
3859 int TokenBucketRefillInterval
;
3860 char *AccelName
; /**< Optional hardware acceleration engine name. */
3861 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
3862 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
3863 * of fixed nodes? */
3864 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
3865 int UseEntryGuardsAsDirGuards
; /** Boolean: Do we try to get directory info
3866 * from a smallish number of fixed nodes? */
3868 /** If 1, we use any guardfraction information we see in the
3869 * consensus. If 0, we don't. If -1, let the consensus parameter
3871 int UseGuardFraction
;
3873 int NumDirectoryGuards
; /**< How many dir guards do we try to establish?
3874 * If 0, use value from NumEntryGuards. */
3875 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
3876 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
3877 * of our PK time by sending CREATE_FAST cells? */
3878 /** Should we always fetch our dir info on the mirror schedule (which
3879 * means directly from the authorities) no matter our other config? */
3880 int FetchDirInfoEarly
;
3882 /** Should we fetch our dir info at the start of the consensus period? */
3883 int FetchDirInfoExtraEarly
;
3885 char *VirtualAddrNetworkIPv4
; /**< Address and mask to hand out for virtual
3886 * MAPADDRESS requests for IPv4 addresses */
3887 char *VirtualAddrNetworkIPv6
; /**< Address and mask to hand out for virtual
3888 * MAPADDRESS requests for IPv6 addresses */
3889 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
3890 * addresses to be FQDNs, but rather search for them in
3891 * the local domains. */
3892 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
3894 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
3895 * DNS poisoning attacks. */
3896 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
3897 * resolver from the file here rather than from
3898 * /etc/resolv.conf (Unix) or the registry (Windows). */
3899 char *DirPortFrontPage
; /**< This is a full path to a file with an html
3900 disclaimer. This allows a server administrator to show
3901 that they're running Tor and anyone visiting their server
3902 will know this without any specialized knowledge. */
3903 int DisableDebuggerAttachment
; /**< Currently Linux only specific attempt to
3904 disable ptrace; needs BSD testing. */
3905 /** Boolean: if set, we start even if our resolv.conf file is missing
3907 int ServerDNSAllowBrokenConfig
;
3908 /** Boolean: if set, then even connections to private addresses will get
3910 int CountPrivateBandwidth
;
3911 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
3912 * should be resolvable. Used for
3913 * testing our DNS server. */
3914 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
3915 * same network zone in the same circuit. */
3916 int PortForwarding
; /**< If true, use NAT-PMP or UPnP to automatically
3917 * forward the DirPort and ORPort on the NAT device */
3918 char *PortForwardingHelper
; /** < Filename or full path of the port
3919 forwarding helper executable */
3920 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
3921 * with weird characters. */
3922 /** If true, we try resolving hostnames with weird characters. */
3923 int ServerDNSAllowNonRFC953Hostnames
;
3925 /** If true, we try to download extra-info documents (and we serve them,
3926 * if we are a cache). For authorities, this is always true. */
3927 int DownloadExtraInfo
;
3929 /** If true, and we are acting as a relay, allow exit circuits even when
3930 * we are the first hop of a circuit. */
3931 int AllowSingleHopExits
;
3932 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
3933 * circuits that we build. */
3934 int ExcludeSingleHopRelays
;
3935 /** If true, and the controller tells us to use a one-hop circuit, and the
3936 * exit allows it, we use it. */
3937 int AllowSingleHopCircuits
;
3939 /** If true, we convert "www.google.com.foo.exit" addresses on the
3940 * socks/trans/natd ports into "www.google.com" addresses that
3941 * exit from the node "foo". Disabled by default since attacking
3942 * websites and exit relays can use it to manipulate your path
3946 /** If true, we will warn if a user gives us only an IP address
3947 * instead of a hostname. */
3948 int WarnUnsafeSocks
;
3950 /** If true, we're configured to collect statistics on clients
3951 * requesting network statuses from us as directory. */
3952 int DirReqStatistics_option
;
3953 /** Internal variable to remember whether we're actually acting on
3954 * DirReqStatistics_option -- yes if it's set and we're a server, else no. */
3955 int DirReqStatistics
;
3957 /** If true, the user wants us to collect statistics on port usage. */
3958 int ExitPortStatistics
;
3960 /** If true, the user wants us to collect connection statistics. */
3961 int ConnDirectionStatistics
;
3963 /** If true, the user wants us to collect cell statistics. */
3966 /** If true, the user wants us to collect statistics as entry node. */
3967 int EntryStatistics
;
3969 /** If true, the user wants us to collect statistics as hidden service
3970 * directory, introduction point, or rendezvous point. */
3971 int HiddenServiceStatistics
;
3973 /** If true, include statistics file contents in extra-info documents. */
3974 int ExtraInfoStatistics
;
3976 /** If true, do not believe anybody who tells us that a domain resolves
3977 * to an internal address, or that an internal address has a PTR mapping.
3978 * Helps avoid some cross-site attacks. */
3979 int ClientDNSRejectInternalAddresses
;
3981 /** If true, do not accept any requests to connect to internal addresses
3982 * over randomly chosen exits. */
3983 int ClientRejectInternalAddresses
;
3985 /** If true, clients may connect over IPv6. XXX we don't really
3986 enforce this -- clients _may_ set up outgoing IPv6 connections
3987 even when this option is not set. */
3989 /** If true, prefer an IPv6 OR port over an IPv4 one. */
3990 int ClientPreferIPv6ORPort
;
3992 /** The length of time that we think a consensus should be fresh. */
3993 int V3AuthVotingInterval
;
3994 /** The length of time we think it will take to distribute votes. */
3995 int V3AuthVoteDelay
;
3996 /** The length of time we think it will take to distribute signatures. */
3997 int V3AuthDistDelay
;
3998 /** The number of intervals we think a consensus should be valid. */
3999 int V3AuthNIntervalsValid
;
4001 /** Should advertise and sign consensuses with a legacy key, for key
4002 * migration purposes? */
4003 int V3AuthUseLegacyKey
;
4005 /** Location of bandwidth measurement file */
4006 char *V3BandwidthsFile
;
4008 /** Location of guardfraction file */
4009 char *GuardfractionFile
;
4011 /** Authority only: key=value pairs that we add to our networkstatus
4012 * consensus vote on the 'params' line. */
4013 char *ConsensusParams
;
4015 /** Authority only: minimum number of measured bandwidths we must see
4016 * before we only beliee measured bandwidths to assign flags. */
4017 int MinMeasuredBWsForAuthToIgnoreAdvertised
;
4019 /** The length of time that we think an initial consensus should be fresh.
4020 * Only altered on testing networks. */
4021 int TestingV3AuthInitialVotingInterval
;
4023 /** The length of time we think it will take to distribute initial votes.
4024 * Only altered on testing networks. */
4025 int TestingV3AuthInitialVoteDelay
;
4027 /** The length of time we think it will take to distribute initial
4028 * signatures. Only altered on testing networks.*/
4029 int TestingV3AuthInitialDistDelay
;
4031 /** Offset in seconds added to the starting time for consensus
4032 voting. Only altered on testing networks. */
4033 int TestingV3AuthVotingStartOffset
;
4035 /** If an authority has been around for less than this amount of time, it
4036 * does not believe its reachability information is accurate. Only
4037 * altered on testing networks. */
4038 int TestingAuthDirTimeToLearnReachability
;
4040 /** Clients don't download any descriptor this recent, since it will
4041 * probably not have propagated to enough caches. Only altered on testing
4043 int TestingEstimatedDescriptorPropagationTime
;
4045 /** Schedule for when servers should download things in general. Only
4046 * altered on testing networks. */
4047 smartlist_t
*TestingServerDownloadSchedule
;
4049 /** Schedule for when clients should download things in general. Only
4050 * altered on testing networks. */
4051 smartlist_t
*TestingClientDownloadSchedule
;
4053 /** Schedule for when servers should download consensuses. Only altered
4054 * on testing networks. */
4055 smartlist_t
*TestingServerConsensusDownloadSchedule
;
4057 /** Schedule for when clients should download consensuses. Only altered
4058 * on testing networks. */
4059 smartlist_t
*TestingClientConsensusDownloadSchedule
;
4061 /** Schedule for when clients should download bridge descriptors. Only
4062 * altered on testing networks. */
4063 smartlist_t
*TestingBridgeDownloadSchedule
;
4065 /** When directory clients have only a few descriptors to request, they
4066 * batch them until they have more, or until this amount of time has
4067 * passed. Only altered on testing networks. */
4068 int TestingClientMaxIntervalWithoutRequest
;
4070 /** How long do we let a directory connection stall before expiring
4071 * it? Only altered on testing networks. */
4072 int TestingDirConnectionMaxStall
;
4074 /** How many times will we try to fetch a consensus before we give
4075 * up? Only altered on testing networks. */
4076 int TestingConsensusMaxDownloadTries
;
4078 /** How many times will we try to download a router's descriptor before
4079 * giving up? Only altered on testing networks. */
4080 int TestingDescriptorMaxDownloadTries
;
4082 /** How many times will we try to download a microdescriptor before
4083 * giving up? Only altered on testing networks. */
4084 int TestingMicrodescMaxDownloadTries
;
4086 /** How many times will we try to fetch a certificate before giving
4087 * up? Only altered on testing networks. */
4088 int TestingCertMaxDownloadTries
;
4090 /** If true, we take part in a testing network. Change the defaults of a
4091 * couple of other configuration options and allow to change the values
4092 * of certain configuration options. */
4093 int TestingTorNetwork
;
4095 /** Minimum value for the Exit flag threshold on testing networks. */
4096 uint64_t TestingMinExitFlagThreshold
;
4098 /** Minimum value for the Fast flag threshold on testing networks. */
4099 uint64_t TestingMinFastFlagThreshold
;
4101 /** Relays in a testing network which should be voted Exit
4102 * regardless of exit policy. */
4103 routerset_t
*TestingDirAuthVoteExit
;
4104 int TestingDirAuthVoteExitIsStrict
;
4106 /** Relays in a testing network which should be voted Guard
4107 * regardless of uptime and bandwidth. */
4108 routerset_t
*TestingDirAuthVoteGuard
;
4109 int TestingDirAuthVoteGuardIsStrict
;
4111 /** Relays in a testing network which should be voted HSDir
4112 * regardless of uptime and DirPort.
4113 * Respects VoteOnHidServDirectoriesV2. */
4114 routerset_t
*TestingDirAuthVoteHSDir
;
4115 int TestingDirAuthVoteHSDirIsStrict
;
4117 /** Enable CONN_BW events. Only altered on testing networks. */
4118 int TestingEnableConnBwEvent
;
4120 /** Enable CELL_STATS events. Only altered on testing networks. */
4121 int TestingEnableCellStatsEvent
;
4123 /** Enable TB_EMPTY events. Only altered on testing networks. */
4124 int TestingEnableTbEmptyEvent
;
4126 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
4127 * count of how many client addresses have contacted us so that we can help
4128 * the bridge authority guess which countries have blocked access to us. */
4129 int BridgeRecordUsageByCountry
;
4131 /** Optionally, IPv4 and IPv6 GeoIP data. */
4135 /** Autobool: if auto, then any attempt to Exclude{Exit,}Nodes a particular
4136 * country code will exclude all nodes in ?? and A1. If true, all nodes in
4137 * ?? and A1 are excluded. Has no effect if we don't know any GeoIP data. */
4138 int GeoIPExcludeUnknown
;
4140 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
4141 * to make this false. */
4142 int ReloadTorrcOnSIGHUP
;
4144 /* The main parameter for picking circuits within a connection.
4146 * If this value is positive, when picking a cell to relay on a connection,
4147 * we always relay from the circuit whose weighted cell count is lowest.
4148 * Cells are weighted exponentially such that if one cell is sent
4149 * 'CircuitPriorityHalflife' seconds before another, it counts for half as
4152 * If this value is zero, we're disabling the cell-EWMA algorithm.
4154 * If this value is negative, we're using the default approach
4155 * according to either Tor or a parameter set in the consensus.
4157 double CircuitPriorityHalflife
;
4159 /** If true, do not enable IOCP on windows with bufferevents, even if
4160 * we think we could. */
4162 /** For testing only: will go away eventually. */
4163 int UseFilteringSSLBufferevents
;
4165 /** Set to true if the TestingTorNetwork configuration option is set.
4166 * This is used so that options_validate() has a chance to realize that
4167 * the defaults have changed. */
4168 int UsingTestNetworkDefaults_
;
4170 /** If 1, we try to use microdescriptors to build circuits. If 0, we don't.
4171 * If -1, Tor decides. */
4172 int UseMicrodescriptors
;
4174 /** File where we should write the ControlPort. */
4175 char *ControlPortWriteToFile
;
4176 /** Should that file be group-readable? */
4177 int ControlPortFileGroupReadable
;
4179 #define MAX_MAX_CLIENT_CIRCUITS_PENDING 1024
4180 /** Maximum number of non-open general-purpose origin circuits to allow at
4182 int MaxClientCircuitsPending
;
4184 /** If 1, we always send optimistic data when it's supported. If 0, we
4185 * never use it. If -1, we do what the consensus says. */
4188 /** If 1, and we are using IOCP, we set the kernel socket SNDBUF and RCVBUF
4189 * to 0 to try to save kernel memory and avoid the dread "Out of buffers"
4191 int UserspaceIOCPBuffers
;
4193 /** If 1, we accept and launch no external network connections, except on
4198 * Parameters for path-bias detection.
4200 * These options override the default behavior of Tor's (**currently
4201 * experimental**) path bias detection algorithm. To try to find broken or
4202 * misbehaving guard nodes, Tor looks for nodes where more than a certain
4203 * fraction of circuits through that guard fail to get built.
4205 * The PathBiasCircThreshold option controls how many circuits we need to
4206 * build through a guard before we make these checks. The
4207 * PathBiasNoticeRate, PathBiasWarnRate and PathBiasExtremeRate options
4208 * control what fraction of circuits must succeed through a guard so we
4209 * won't write log messages. If less than PathBiasExtremeRate circuits
4210 * succeed *and* PathBiasDropGuards is set to 1, we disable use of that
4213 * When we have seen more than PathBiasScaleThreshold circuits through a
4214 * guard, we scale our observations by 0.5 (governed by the consensus) so
4215 * that new observations don't get swamped by old ones.
4217 * By default, or if a negative value is provided for one of these options,
4218 * Tor uses reasonable defaults from the networkstatus consensus document.
4219 * If no defaults are available there, these options default to 150, .70,
4220 * .50, .30, 0, and 300 respectively.
4222 int PathBiasCircThreshold
;
4223 double PathBiasNoticeRate
;
4224 double PathBiasWarnRate
;
4225 double PathBiasExtremeRate
;
4226 int PathBiasDropGuards
;
4227 int PathBiasScaleThreshold
;
4231 * Parameters for path-bias use detection
4233 * Similar to the above options, these options override the default behavior
4234 * of Tor's (**currently experimental**) path use bias detection algorithm.
4236 * Where as the path bias parameters govern thresholds for successfully
4237 * building circuits, these four path use bias parameters govern thresholds
4238 * only for circuit usage. Circuits which receive no stream usage are not
4239 * counted by this detection algorithm. A used circuit is considered
4240 * successful if it is capable of carrying streams or otherwise receiving
4241 * well-formed responses to RELAY cells.
4243 * By default, or if a negative value is provided for one of these options,
4244 * Tor uses reasonable defaults from the networkstatus consensus document.
4245 * If no defaults are available there, these options default to 20, .80,
4246 * .60, and 100, respectively.
4248 int PathBiasUseThreshold
;
4249 double PathBiasNoticeUseRate
;
4250 double PathBiasExtremeUseRate
;
4251 int PathBiasScaleUseThreshold
;
4254 int IPv6Exit
; /**< Do we support exiting to IPv6 addresses? */
4256 char *TLSECGroup
; /**< One of "P256", "P224", or nil for auto */
4258 /** Autobool: should we use the ntor handshake if we can? */
4259 int UseNTorHandshake
;
4262 double PathsNeededToBuildCircuits
;
4264 /** What expiry time shall we place on our SSL certs? "0" means we
4265 * should guess a suitable value. */
4268 /** How long (seconds) do we keep a guard before picking a new one? */
4271 /** Low-water mark for global scheduler - start sending when estimated
4272 * queued size falls below this threshold.
4274 uint64_t SchedulerLowWaterMark__
;
4275 /** High-water mark for global scheduler - stop sending when estimated
4276 * queued size exceeds this threshold.
4278 uint64_t SchedulerHighWaterMark__
;
4279 /** Flush size for global scheduler - flush this many cells at a time
4282 int SchedulerMaxFlushCells__
;
4284 /** Is this an exit node? This is a tristate, where "1" means "yes, and use
4285 * the default exit policy if none is given" and "0" means "no; exit policy
4286 * is 'reject *'" and "auto" (-1) means "same as 1, but warn the user."
4288 * XXXX Eventually, the default will be 0. */
4291 /** For how long (seconds) do we declare our singning keys to be valid? */
4292 int SigningKeyLifetime
;
4293 /** For how long (seconds) do we declare our link keys to be valid? */
4294 int TestingLinkCertLifetime
;
4295 /** For how long (seconds) do we declare our auth keys to be valid? */
4296 int TestingAuthKeyLifetime
;
4298 /** How long before signing keys expire will we try to make a new one? */
4299 int TestingSigningKeySlop
;
4300 /** How long before link keys expire will we try to make a new one? */
4301 int TestingLinkKeySlop
;
4302 /** How long before auth keys expire will we try to make a new one? */
4303 int TestingAuthKeySlop
;
4306 FORCE_PASSPHRASE_AUTO
=0,
4307 FORCE_PASSPHRASE_ON
,
4308 FORCE_PASSPHRASE_OFF
4309 } keygen_force_passphrase
;
4310 int use_keygen_passphrase_fd
;
4311 int keygen_passphrase_fd
;
4314 /** Persistent state for an onion router, as saved to disk. */
4317 /** The time at which we next plan to write the state to the disk. Equal to
4318 * TIME_MAX if there are no savable changes, 0 if there are changes that
4319 * should be saved right away. */
4322 /** When was the state last written to disk? */
4325 /** Fields for accounting bandwidth use. */
4326 time_t AccountingIntervalStart
;
4327 uint64_t AccountingBytesReadInInterval
;
4328 uint64_t AccountingBytesWrittenInInterval
;
4329 int AccountingSecondsActive
;
4330 int AccountingSecondsToReachSoftLimit
;
4331 time_t AccountingSoftLimitHitAt
;
4332 uint64_t AccountingBytesAtSoftLimit
;
4333 uint64_t AccountingExpectedUsage
;
4335 /** A list of Entry Guard-related configuration lines. */
4336 config_line_t
*EntryGuards
;
4338 config_line_t
*TransportProxies
;
4340 /** These fields hold information on the history of bandwidth usage for
4341 * servers. The "Ends" fields hold the time when we last updated the
4342 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
4343 * of the entries of Values. The "Values" lists hold decimal string
4344 * representations of the number of bytes read or written in each
4345 * interval. The "Maxima" list holds decimal strings describing the highest
4346 * rate achieved during the interval.
4348 time_t BWHistoryReadEnds
;
4349 int BWHistoryReadInterval
;
4350 smartlist_t
*BWHistoryReadValues
;
4351 smartlist_t
*BWHistoryReadMaxima
;
4352 time_t BWHistoryWriteEnds
;
4353 int BWHistoryWriteInterval
;
4354 smartlist_t
*BWHistoryWriteValues
;
4355 smartlist_t
*BWHistoryWriteMaxima
;
4356 time_t BWHistoryDirReadEnds
;
4357 int BWHistoryDirReadInterval
;
4358 smartlist_t
*BWHistoryDirReadValues
;
4359 smartlist_t
*BWHistoryDirReadMaxima
;
4360 time_t BWHistoryDirWriteEnds
;
4361 int BWHistoryDirWriteInterval
;
4362 smartlist_t
*BWHistoryDirWriteValues
;
4363 smartlist_t
*BWHistoryDirWriteMaxima
;
4365 /** Build time histogram */
4366 config_line_t
* BuildtimeHistogram
;
4367 unsigned int TotalBuildTimes
;
4368 unsigned int CircuitBuildAbandonedCount
;
4370 /** What version of Tor wrote this state file? */
4373 /** Holds any unrecognized values we found in the state file, in the order
4374 * in which we found them. */
4375 config_line_t
*ExtraLines
;
4377 /** When did we last rotate our onion key? "0" for 'no idea'. */
4378 time_t LastRotatedOnionKey
;
4381 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
4382 * state is already scheduled to be written to disk earlier than <b>when</b>.
4384 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
4386 if (state
->next_write
> when
)
4387 state
->next_write
= when
;
4390 #define MAX_SOCKS_REPLY_LEN 1024
4391 #define MAX_SOCKS_ADDR_LEN 256
4392 #define SOCKS_NO_AUTH 0x00
4393 #define SOCKS_USER_PASS 0x02
4395 /** Please open a TCP connection to this addr:port. */
4396 #define SOCKS_COMMAND_CONNECT 0x01
4397 /** Please turn this FQDN into an IP address, privately. */
4398 #define SOCKS_COMMAND_RESOLVE 0xF0
4399 /** Please turn this IP address into an FQDN, privately. */
4400 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
4402 /* || 0 is for -Wparentheses-equality (-Wall?) appeasement under clang */
4403 #define SOCKS_COMMAND_IS_CONNECT(c) (((c)==SOCKS_COMMAND_CONNECT) || 0)
4404 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
4405 (c)==SOCKS_COMMAND_RESOLVE_PTR)
4407 /** State of a SOCKS request from a user to an OP. Also used to encode other
4408 * information for non-socks user request (such as those on TransPort and
4410 struct socks_request_t
{
4411 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
4412 * 0 means that no socks handshake ever took place, and this is just a
4413 * stub connection (e.g. see connection_ap_make_link()). */
4414 uint8_t socks_version
;
4415 /** If using socks5 authentication, which authentication type did we
4416 * negotiate? currently we support 0 (no authentication) and 2
4417 * (username/password). */
4419 /** What is this stream's goal? One of the SOCKS_COMMAND_* values */
4421 /** Which kind of listener created this stream? */
4422 uint8_t listener_type
;
4423 size_t replylen
; /**< Length of <b>reply</b>. */
4424 uint8_t reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
4425 * we want to specify our own socks reply,
4426 * rather than using the default socks4 or
4427 * socks5 socks reply. We use this for the
4428 * two-stage socks5 handshake.
4430 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
4431 connect to/resolve? */
4432 uint16_t port
; /**< What port did the client ask to connect to? */
4433 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
4434 * make sure we send back a socks reply for
4435 * every connection. */
4436 unsigned int got_auth
: 1; /**< Have we received any authentication data? */
4437 /** If this is set, we will choose "no authentication" instead of
4438 * "username/password" authentication if both are offered. Used as input to
4440 unsigned int socks_prefer_no_auth
: 1;
4442 /** Number of bytes in username; 0 if username is NULL */
4444 /** Number of bytes in password; 0 if password is NULL */
4445 uint8_t passwordlen
;
4446 /** The negotiated username value if any (for socks5), or the entire
4447 * authentication string (for socks4). This value is NOT nul-terminated;
4448 * see usernamelen for its length. */
4450 /** The negotiated password value if any (for socks5). This value is NOT
4451 * nul-terminated; see passwordlen for its length. */
4455 /********************************* circuitbuild.c **********************/
4457 /** How many hops does a general-purpose circuit have by default? */
4458 #define DEFAULT_ROUTE_LEN 3
4460 /* Circuit Build Timeout "public" structures. */
4462 /** Precision multiplier for the Bw weights */
4463 #define BW_WEIGHT_SCALE 10000
4464 #define BW_MIN_WEIGHT_SCALE 1
4465 #define BW_MAX_WEIGHT_SCALE INT32_MAX
4467 /** Total size of the circuit timeout history to accumulate.
4468 * 1000 is approx 2.5 days worth of continual-use circuits. */
4469 #define CBT_NCIRCUITS_TO_OBSERVE 1000
4471 /** Width of the histogram bins in milliseconds */
4472 #define CBT_BIN_WIDTH ((build_time_t)50)
4474 /** Number of modes to use in the weighted-avg computation of Xm */
4475 #define CBT_DEFAULT_NUM_XM_MODES 3
4476 #define CBT_MIN_NUM_XM_MODES 1
4477 #define CBT_MAX_NUM_XM_MODES 20
4479 /** A build_time_t is milliseconds */
4480 typedef uint32_t build_time_t
;
4483 * CBT_BUILD_ABANDONED is our flag value to represent a force-closed
4484 * circuit (Aka a 'right-censored' pareto value).
4486 #define CBT_BUILD_ABANDONED ((build_time_t)(INT32_MAX-1))
4487 #define CBT_BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
4489 /** Save state every 10 circuits */
4490 #define CBT_SAVE_STATE_EVERY 10
4492 /* Circuit build times consensus parameters */
4495 * How long to wait before actually closing circuits that take too long to
4496 * build in terms of CDF quantile.
4498 #define CBT_DEFAULT_CLOSE_QUANTILE 95
4499 #define CBT_MIN_CLOSE_QUANTILE CBT_MIN_QUANTILE_CUTOFF
4500 #define CBT_MAX_CLOSE_QUANTILE CBT_MAX_QUANTILE_CUTOFF
4503 * How many circuits count as recent when considering if the
4504 * connection has gone gimpy or changed.
4506 #define CBT_DEFAULT_RECENT_CIRCUITS 20
4507 #define CBT_MIN_RECENT_CIRCUITS 3
4508 #define CBT_MAX_RECENT_CIRCUITS 1000
4511 * Maximum count of timeouts that finish the first hop in the past
4512 * RECENT_CIRCUITS before calculating a new timeout.
4514 * This tells us whether to abandon timeout history and set
4515 * the timeout back to whatever circuit_build_times_get_initial_timeout()
4518 #define CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT (CBT_DEFAULT_RECENT_CIRCUITS*9/10)
4519 #define CBT_MIN_MAX_RECENT_TIMEOUT_COUNT 3
4520 #define CBT_MAX_MAX_RECENT_TIMEOUT_COUNT 10000
4522 /** Minimum circuits before estimating a timeout */
4523 #define CBT_DEFAULT_MIN_CIRCUITS_TO_OBSERVE 100
4524 #define CBT_MIN_MIN_CIRCUITS_TO_OBSERVE 1
4525 #define CBT_MAX_MIN_CIRCUITS_TO_OBSERVE 10000
4527 /** Cutoff percentile on the CDF for our timeout estimation. */
4528 #define CBT_DEFAULT_QUANTILE_CUTOFF 80
4529 #define CBT_MIN_QUANTILE_CUTOFF 10
4530 #define CBT_MAX_QUANTILE_CUTOFF 99
4531 double circuit_build_times_quantile_cutoff(void);
4533 /** How often in seconds should we build a test circuit */
4534 #define CBT_DEFAULT_TEST_FREQUENCY 60
4535 #define CBT_MIN_TEST_FREQUENCY 1
4536 #define CBT_MAX_TEST_FREQUENCY INT32_MAX
4538 /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
4539 #define CBT_DEFAULT_TIMEOUT_MIN_VALUE (1500)
4540 #define CBT_MIN_TIMEOUT_MIN_VALUE 500
4541 #define CBT_MAX_TIMEOUT_MIN_VALUE INT32_MAX
4543 /** Initial circuit build timeout in milliseconds */
4544 #define CBT_DEFAULT_TIMEOUT_INITIAL_VALUE (60*1000)
4545 #define CBT_MIN_TIMEOUT_INITIAL_VALUE CBT_MIN_TIMEOUT_MIN_VALUE
4546 #define CBT_MAX_TIMEOUT_INITIAL_VALUE INT32_MAX
4547 int32_t circuit_build_times_initial_timeout(void);
4549 #if CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT < CBT_MIN_MAX_RECENT_TIMEOUT_COUNT
4550 #error "RECENT_CIRCUITS is set too low."
4553 /** Information about the state of our local network connection */
4555 /** The timestamp we last completed a TLS handshake or received a cell */
4556 time_t network_last_live
;
4557 /** If the network is not live, how many timeouts has this caused? */
4558 int nonlive_timeouts
;
4559 /** Circular array of circuits that have made it to the first hop. Slot is
4560 * 1 if circuit timed out, 0 if circuit succeeded */
4561 int8_t *timeouts_after_firsthop
;
4562 /** Number of elements allocated for the above array */
4563 int num_recent_circs
;
4564 /** Index into circular array. */
4565 int after_firsthop_idx
;
4566 } network_liveness_t
;
4568 typedef struct circuit_build_times_s circuit_build_times_t
;
4570 /********************************* config.c ***************************/
4572 /** An error from options_trial_assign() or options_init_from_string(). */
4573 typedef enum setopt_err_t
{
4575 SETOPT_ERR_MISC
= -1,
4576 SETOPT_ERR_PARSE
= -2,
4577 SETOPT_ERR_TRANSITION
= -3,
4578 SETOPT_ERR_SETTING
= -4,
4581 /********************************* connection_edge.c *************************/
4583 /** Enumerates possible origins of a client-side address mapping. */
4585 /** We're remapping this address because the controller told us to. */
4586 ADDRMAPSRC_CONTROLLER
,
4587 /** We're remapping this address because of an AutomapHostsOnResolve
4590 /** We're remapping this address because our configuration (via torrc, the
4591 * command line, or a SETCONF command) told us to. */
4593 /** We're remapping this address because we have TrackHostExit configured,
4594 * and we want to remember to use the same exit next time. */
4595 ADDRMAPSRC_TRACKEXIT
,
4596 /** We're remapping this address because we got a DNS resolution from a
4597 * Tor server that told us what its value was. */
4600 /** No remapping has occurred. This isn't a possible value for an
4601 * addrmap_entry_t; it's used as a null value when we need to answer "Why
4602 * did this remapping happen." */
4604 } addressmap_entry_source_t
;
4605 #define addressmap_entry_source_bitfield_t ENUM_BF(addressmap_entry_source_t)
4607 /********************************* control.c ***************************/
4609 /** Used to indicate the type of a circuit event passed to the controller.
4610 * The various types are defined in control-spec.txt */
4611 typedef enum circuit_status_event_t
{
4612 CIRC_EVENT_LAUNCHED
= 0,
4613 CIRC_EVENT_BUILT
= 1,
4614 CIRC_EVENT_EXTENDED
= 2,
4615 CIRC_EVENT_FAILED
= 3,
4616 CIRC_EVENT_CLOSED
= 4,
4617 } circuit_status_event_t
;
4619 /** Used to indicate the type of a CIRC_MINOR event passed to the controller.
4620 * The various types are defined in control-spec.txt . */
4621 typedef enum circuit_status_minor_event_t
{
4622 CIRC_MINOR_EVENT_PURPOSE_CHANGED
,
4623 CIRC_MINOR_EVENT_CANNIBALIZED
,
4624 } circuit_status_minor_event_t
;
4626 /** Used to indicate the type of a stream event passed to the controller.
4627 * The various types are defined in control-spec.txt */
4628 typedef enum stream_status_event_t
{
4629 STREAM_EVENT_SENT_CONNECT
= 0,
4630 STREAM_EVENT_SENT_RESOLVE
= 1,
4631 STREAM_EVENT_SUCCEEDED
= 2,
4632 STREAM_EVENT_FAILED
= 3,
4633 STREAM_EVENT_CLOSED
= 4,
4634 STREAM_EVENT_NEW
= 5,
4635 STREAM_EVENT_NEW_RESOLVE
= 6,
4636 STREAM_EVENT_FAILED_RETRIABLE
= 7,
4637 STREAM_EVENT_REMAP
= 8
4638 } stream_status_event_t
;
4640 /** Used to indicate the type of an OR connection event passed to the
4641 * controller. The various types are defined in control-spec.txt */
4642 typedef enum or_conn_status_event_t
{
4643 OR_CONN_EVENT_LAUNCHED
= 0,
4644 OR_CONN_EVENT_CONNECTED
= 1,
4645 OR_CONN_EVENT_FAILED
= 2,
4646 OR_CONN_EVENT_CLOSED
= 3,
4647 OR_CONN_EVENT_NEW
= 4,
4648 } or_conn_status_event_t
;
4650 /** Used to indicate the type of a buildtime event */
4651 typedef enum buildtimeout_set_event_t
{
4652 BUILDTIMEOUT_SET_EVENT_COMPUTED
= 0,
4653 BUILDTIMEOUT_SET_EVENT_RESET
= 1,
4654 BUILDTIMEOUT_SET_EVENT_SUSPENDED
= 2,
4655 BUILDTIMEOUT_SET_EVENT_DISCARD
= 3,
4656 BUILDTIMEOUT_SET_EVENT_RESUME
= 4
4657 } buildtimeout_set_event_t
;
4659 /** Execute the statement <b>stmt</b>, which may log events concerning the
4660 * connection <b>conn</b>. To prevent infinite loops, disable log messages
4661 * being sent to controllers if <b>conn</b> is a control connection.
4663 * Stmt must not contain any return or goto statements.
4665 #define CONN_LOG_PROTECT(conn, stmt) \
4667 int _log_conn_is_control; \
4669 _log_conn_is_control = (conn->type == CONN_TYPE_CONTROL); \
4670 if (_log_conn_is_control) \
4671 disable_control_logging(); \
4672 STMT_BEGIN stmt; STMT_END; \
4673 if (_log_conn_is_control) \
4674 enable_control_logging(); \
4677 /** Enum describing various stages of bootstrapping, for use with controller
4678 * bootstrap status events. The values range from 0 to 100. */
4680 BOOTSTRAP_STATUS_UNDEF
=-1,
4681 BOOTSTRAP_STATUS_STARTING
=0,
4682 BOOTSTRAP_STATUS_CONN_DIR
=5,
4683 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
4684 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
4685 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
4686 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
4687 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
4688 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
4689 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
4690 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
4691 BOOTSTRAP_STATUS_CONN_OR
=80,
4692 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
4693 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
4694 BOOTSTRAP_STATUS_DONE
=100
4695 } bootstrap_status_t
;
4697 /********************************* directory.c ***************************/
4699 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
4701 char first
[DIGEST_LEN
];
4702 char second
[DIGEST_LEN
];
4705 /********************************* dirserv.c ***************************/
4707 /** An enum to describe what format we're generating a routerstatus line in.
4710 /** For use in a v2 opinion */
4712 /** For use in a consensus networkstatus document (ns flavor) */
4714 /** For use in a vote networkstatus document */
4716 /** For passing to the controlport in response to a GETINFO request */
4718 /** For use in a consensus networkstatus document (microdesc flavor) */
4719 NS_V3_CONSENSUS_MICRODESC
4720 } routerstatus_format_type_t
;
4722 #ifdef DIRSERV_PRIVATE
4723 typedef struct measured_bw_line_t
{
4724 char node_id
[DIGEST_LEN
];
4725 char node_hex
[MAX_HEX_NICKNAME_LEN
+1];
4727 } measured_bw_line_t
;
4731 /********************************* dirvote.c ************************/
4733 /** Describes the schedule by which votes should be generated. */
4734 typedef struct vote_timing_t
{
4735 /** Length in seconds between one consensus becoming valid and the next
4736 * becoming valid. */
4738 /** For how many intervals is a consensus valid? */
4739 int n_intervals_valid
;
4740 /** Time in seconds allowed to propagate votes */
4742 /** Time in seconds allowed to propagate signatures */
4746 /********************************* geoip.c **************************/
4748 /** Indicates an action that we might be noting geoip statistics on.
4749 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
4750 * the others, we're not.
4753 /** We've noticed a connection as a bridge relay or entry guard. */
4754 GEOIP_CLIENT_CONNECT
= 0,
4755 /** We've served a networkstatus consensus as a directory server. */
4756 GEOIP_CLIENT_NETWORKSTATUS
= 1,
4757 } geoip_client_action_t
;
4758 /** Indicates either a positive reply or a reason for rejectng a network
4759 * status request that will be included in geoip statistics. */
4761 /** Request is answered successfully. */
4763 /** V3 network status is not signed by a sufficient number of requested
4765 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
4766 /** Requested network status object is unavailable. */
4767 GEOIP_REJECT_UNAVAILABLE
= 2,
4768 /** Requested network status not found. */
4769 GEOIP_REJECT_NOT_FOUND
= 3,
4770 /** Network status has not been modified since If-Modified-Since time. */
4771 GEOIP_REJECT_NOT_MODIFIED
= 4,
4772 /** Directory is busy. */
4773 GEOIP_REJECT_BUSY
= 5,
4774 } geoip_ns_response_t
;
4775 #define GEOIP_NS_RESPONSE_NUM 6
4777 /** Directory requests that we are measuring can be either direct or
4781 DIRREQ_TUNNELED
= 1,
4784 /** Possible states for either direct or tunneled directory requests that
4785 * are relevant for determining network status download times. */
4787 /** Found that the client requests a network status; applies to both
4788 * direct and tunneled requests; initial state of a request that we are
4790 DIRREQ_IS_FOR_NETWORK_STATUS
= 0,
4791 /** Finished writing a network status to the directory connection;
4792 * applies to both direct and tunneled requests; completes a direct
4794 DIRREQ_FLUSHING_DIR_CONN_FINISHED
= 1,
4795 /** END cell sent to circuit that initiated a tunneled request. */
4796 DIRREQ_END_CELL_SENT
= 2,
4797 /** Flushed last cell from queue of the circuit that initiated a
4798 * tunneled request to the outbuf of the OR connection. */
4799 DIRREQ_CIRC_QUEUE_FLUSHED
= 3,
4800 /** Flushed last byte from buffer of the channel belonging to the
4801 * circuit that initiated a tunneled request; completes a tunneled
4803 DIRREQ_CHANNEL_BUFFER_FLUSHED
= 4
4806 #define WRITE_STATS_INTERVAL (24*60*60)
4808 /********************************* microdesc.c *************************/
4810 typedef struct microdesc_cache_t microdesc_cache_t
;
4812 /********************************* networkstatus.c *********************/
4814 /** Possible statuses of a version of Tor, given opinions from the directory
4816 typedef enum version_status_t
{
4817 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
4818 VS_OLD
=1, /**< This version is older than any recommended version. */
4819 VS_NEW
=2, /**< This version is newer than any recommended version. */
4820 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
4821 * in its series, but later recommended versions exist.
4823 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
4824 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
4825 VS_UNKNOWN
, /**< We have no idea. */
4828 /********************************* policies.c ************************/
4830 /** Outcome of applying an address policy to an address. */
4832 /** The address was accepted */
4833 ADDR_POLICY_ACCEPTED
=0,
4834 /** The address was rejected */
4835 ADDR_POLICY_REJECTED
=-1,
4836 /** Part of the address was unknown, but as far as we can tell, it was
4838 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
4839 /** Part of the address was unknown, but as far as we can tell, it was
4841 ADDR_POLICY_PROBABLY_REJECTED
=2,
4842 } addr_policy_result_t
;
4844 /********************************* rephist.c ***************************/
4846 /** Possible public/private key operations in Tor: used to keep track of where
4847 * we're spending our time. */
4850 VERIFY_DIR
, VERIFY_RTR
,
4851 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4852 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4853 REND_CLIENT
, REND_MID
, REND_SERVER
,
4856 /********************************* rendcommon.c ***************************/
4858 /** Hidden-service side configuration of client authorization. */
4859 typedef struct rend_authorized_client_t
{
4861 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4862 crypto_pk_t
*client_key
;
4863 } rend_authorized_client_t
;
4865 /** ASCII-encoded v2 hidden service descriptor. */
4866 typedef struct rend_encoded_v2_service_descriptor_t
{
4867 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4868 char *desc_str
; /**< Descriptor string. */
4869 } rend_encoded_v2_service_descriptor_t
;
4871 /** The maximum number of non-circuit-build-timeout failures a hidden
4872 * service client will tolerate while trying to build a circuit to an
4873 * introduction point. See also rend_intro_point_t.unreachable_count. */
4874 #define MAX_INTRO_POINT_REACHABILITY_FAILURES 5
4876 /** The minimum and maximum number of distinct INTRODUCE2 cells which a
4877 * hidden service's introduction point will receive before it begins to
4879 #define INTRO_POINT_MIN_LIFETIME_INTRODUCTIONS 16384
4880 /* Double the minimum value so the interval is [min, min * 2]. */
4881 #define INTRO_POINT_MAX_LIFETIME_INTRODUCTIONS \
4882 (INTRO_POINT_MIN_LIFETIME_INTRODUCTIONS * 2)
4884 /** The minimum number of seconds that an introduction point will last
4885 * before expiring due to old age. (If it receives
4886 * INTRO_POINT_LIFETIME_INTRODUCTIONS INTRODUCE2 cells, it may expire
4889 * XXX023 Should this be configurable? */
4890 #define INTRO_POINT_LIFETIME_MIN_SECONDS (18*60*60)
4891 /** The maximum number of seconds that an introduction point will last
4892 * before expiring due to old age.
4894 * XXX023 Should this be configurable? */
4895 #define INTRO_POINT_LIFETIME_MAX_SECONDS (24*60*60)
4897 /** The maximum number of circuit creation retry we do to an intro point
4898 * before giving up. We try to reuse intro point that fails during their
4899 * lifetime so this is a hard limit on the amount of time we do that. */
4900 #define MAX_INTRO_POINT_CIRCUIT_RETRIES 3
4902 /** Introduction point information. Used both in rend_service_t (on
4903 * the service side) and in rend_service_descriptor_t (on both the
4904 * client and service side). */
4905 typedef struct rend_intro_point_t
{
4906 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4907 crypto_pk_t
*intro_key
; /**< Introduction key that replaces the service
4908 * key, if this descriptor is V2. */
4910 /** (Client side only) Flag indicating that a timeout has occurred
4911 * after sending an INTRODUCE cell to this intro point. After a
4912 * timeout, an intro point should not be tried again during the same
4913 * hidden service connection attempt, but it may be tried again
4914 * during a future connection attempt. */
4915 unsigned int timed_out
: 1;
4917 /** (Client side only) The number of times we have failed to build a
4918 * circuit to this intro point for some reason other than our
4919 * circuit-build timeout. See also MAX_INTRO_POINT_REACHABILITY_FAILURES. */
4920 unsigned int unreachable_count
: 3;
4922 /** (Service side only) Flag indicating that this intro point was
4923 * included in the last HS descriptor we generated. */
4924 unsigned int listed_in_last_desc
: 1;
4926 /** (Service side only) A replay cache recording the RSA-encrypted parts
4927 * of INTRODUCE2 cells this intro point's circuit has received. This is
4928 * used to prevent replay attacks. */
4929 replaycache_t
*accepted_intro_rsa_parts
;
4931 /** (Service side only) Count of INTRODUCE2 cells accepted from this
4934 int accepted_introduce2_count
;
4936 /** (Service side only) Number of maximum INTRODUCE2 cells that this IP
4937 * will accept. This is a random value between
4938 * INTRO_POINT_MIN_LIFETIME_INTRODUCTIONS and
4939 * INTRO_POINT_MAX_LIFETIME_INTRODUCTIONS. */
4940 int max_introductions
;
4942 /** (Service side only) The time at which this intro point was first
4943 * published, or -1 if this intro point has not yet been
4945 time_t time_published
;
4947 /** (Service side only) The time at which this intro point should
4948 * (start to) expire, or -1 if we haven't decided when this intro
4949 * point should expire. */
4950 time_t time_to_expire
;
4952 /** (Service side only) The amount of circuit creation we've made to this
4953 * intro point. This is incremented every time we do a circuit relaunch on
4954 * this object which is triggered when the circuit dies but the node is
4955 * still in the consensus. After MAX_INTRO_POINT_CIRCUIT_RETRIES, we give
4957 unsigned int circuit_retries
;
4959 /** (Service side only) Set if this intro point has an established circuit
4960 * and unset if it doesn't. */
4961 unsigned int circuit_established
:1;
4962 } rend_intro_point_t
;
4964 #define REND_PROTOCOL_VERSION_BITMASK_WIDTH 16
4966 /** Information used to connect to a hidden service. Used on both the
4967 * service side and the client side. */
4968 typedef struct rend_service_descriptor_t
{
4969 crypto_pk_t
*pk
; /**< This service's public key. */
4970 int version
; /**< Version of the descriptor format: 0 or 2. */
4971 time_t timestamp
; /**< Time when the descriptor was generated. */
4972 /** Bitmask: which introduce/rendezvous protocols are supported?
4973 * (We allow bits '0', '1', '2' and '3' to be set.) */
4974 unsigned protocols
: REND_PROTOCOL_VERSION_BITMASK_WIDTH
;
4975 /** List of the service's introduction points. Elements are removed if
4976 * introduction attempts fail. */
4977 smartlist_t
*intro_nodes
;
4978 /** Has descriptor been uploaded to all hidden service directories? */
4979 int all_uploads_performed
;
4980 /** List of hidden service directories to which an upload request for
4981 * this descriptor could be sent. Smartlist exists only when at least one
4982 * of the previous upload requests failed (otherwise it's not important
4983 * to know which uploads succeeded and which not). */
4984 smartlist_t
*successful_uploads
;
4985 } rend_service_descriptor_t
;
4987 /********************************* routerlist.c ***************************/
4989 /** Represents information about a single trusted or fallback directory
4991 typedef struct dir_server_t
{
4994 char *address
; /**< Hostname. */
4995 uint32_t addr
; /**< IPv4 address. */
4996 uint16_t dir_port
; /**< Directory port. */
4997 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4998 double weight
; /** Weight used when selecting this node at random */
4999 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
5000 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
5001 * high-security) identity key. */
5003 unsigned int is_running
:1; /**< True iff we think this server is running. */
5004 unsigned int is_authority
:1; /**< True iff this is a directory authority
5007 /** True iff this server has accepted the most recent server descriptor
5008 * we tried to upload to it. */
5009 unsigned int has_accepted_serverdesc
:1;
5011 /** What kind of authority is this? (Bitfield.) */
5012 dirinfo_type_t type
;
5014 time_t addr_current_at
; /**< When was the document that we derived the
5015 * address information from published? */
5017 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
5018 * dir_server_t to directory_initiate_command_*
5019 * as a routerstatus_t. Not updated by the
5020 * router-status management code!
5024 #define RELAY_REQUIRED_MIN_BANDWIDTH (75*1024)
5025 #define BRIDGE_REQUIRED_MIN_BANDWIDTH (50*1024)
5027 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
5029 /* Flags for pick_directory_server() and pick_trusteddirserver(). */
5030 /** Flag to indicate that we should not automatically be willing to use
5031 * ourself to answer a directory request.
5032 * Passed to router_pick_directory_server (et al).*/
5033 #define PDS_ALLOW_SELF (1<<0)
5034 /** Flag to indicate that if no servers seem to be up, we should mark all
5035 * directory servers as up and try again.
5036 * Passed to router_pick_directory_server (et al).*/
5037 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
5038 /** Flag to indicate that we should not exclude directory servers that
5039 * our ReachableAddress settings would exclude. This usually means that
5040 * we're going to connect to the server over Tor, and so we don't need to
5041 * worry about our firewall telling us we can't.
5042 * Passed to router_pick_directory_server (et al).*/
5043 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
5044 /** Flag to indicate that we should not use any directory authority to which
5045 * we have an existing directory connection for downloading server descriptors
5046 * or extrainfo documents.
5048 * Passed to router_pick_directory_server (et al)
5050 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
5051 /** Flag to indicate that we should not use any directory authority to which
5052 * we have an existing directory connection for downloading microdescs.
5054 * Passed to router_pick_directory_server (et al)
5056 #define PDS_NO_EXISTING_MICRODESC_FETCH (1<<4)
5058 /** This node is to be chosen as a directory guard, so don't choose any
5059 * node that's currently a guard. */
5060 #define PDS_FOR_GUARD (1<<5)
5062 /** Possible ways to weight routers when choosing one randomly. See
5063 * routerlist_sl_choose_by_bandwidth() for more information.*/
5064 typedef enum bandwidth_weight_rule_t
{
5065 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_MID
, WEIGHT_FOR_GUARD
,
5067 } bandwidth_weight_rule_t
;
5069 /** Flags to be passed to control router_choose_random_node() to indicate what
5070 * kind of nodes to pick according to what algorithm. */
5072 CRN_NEED_UPTIME
= 1<<0,
5073 CRN_NEED_CAPACITY
= 1<<1,
5074 CRN_NEED_GUARD
= 1<<2,
5075 CRN_ALLOW_INVALID
= 1<<3,
5076 /* XXXX not used, apparently. */
5077 CRN_WEIGHT_AS_EXIT
= 1<<5,
5078 CRN_NEED_DESC
= 1<<6
5079 } router_crn_flags_t
;
5081 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
5082 typedef enum was_router_added_t
{
5083 /* Router was added successfully. */
5084 ROUTER_ADDED_SUCCESSFULLY
= 1,
5085 /* Router descriptor was added with warnings to submitter. */
5086 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
5087 /* Extrainfo document was rejected because no corresponding router
5088 * descriptor was found OR router descriptor was rejected because
5089 * it was incompatible with its extrainfo document. */
5091 /* Router descriptor was rejected because it is already known. */
5092 ROUTER_IS_ALREADY_KNOWN
= -2,
5093 /* General purpose router was rejected, because it was not listed
5095 ROUTER_NOT_IN_CONSENSUS
= -3,
5096 /* Router was neither in directory consensus nor in any of
5097 * networkstatus documents. Caching it to access later.
5098 * (Applies to fetched descriptors only.) */
5099 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
5100 /* Router was rejected by directory authority. */
5101 ROUTER_AUTHDIR_REJECTS
= -5,
5102 /* Bridge descriptor was rejected because such bridge was not one
5103 * of the bridges we have listed in our configuration. */
5104 ROUTER_WAS_NOT_WANTED
= -6,
5105 /* Router descriptor was rejected because it was older than
5106 * OLD_ROUTER_DESC_MAX_AGE. */
5107 ROUTER_WAS_TOO_OLD
= -7, /* note contrast with 'NOT_NEW' */
5109 ROUTER_CERTS_EXPIRED
= -8
5110 } was_router_added_t
;
5112 /********************************* routerparse.c ************************/
5114 #define MAX_STATUS_TAG_LEN 32
5115 /** Structure to hold parsed Tor versions. This is a little messier
5116 * than we would like it to be, because we changed version schemes with 0.1.0.
5118 * See version-spec.txt for the whole business.
5120 typedef struct tor_version_t
{
5124 /** Release status. For version in the post-0.1 format, this is always
5126 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
5128 char status_tag
[MAX_STATUS_TAG_LEN
];
5132 char git_tag
[DIGEST_LEN
];