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-2012, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
9 * \brief Master header file for Tor-specific functionality.
18 /* If we're building for a static analysis, turn on all the off-by-default
20 #ifndef INSTRUMENT_DOWNLOADS
21 #define INSTRUMENT_DOWNLOADS 1
27 #define _WIN32_WINNT 0x0501
29 #define WIN32_LEAN_AND_MEAN
41 #ifdef HAVE_SYS_PARAM_H
42 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
45 #ifdef HAVE_SYS_WAIT_H
48 #ifdef HAVE_SYS_FCNTL_H
49 #include <sys/fcntl.h>
54 #ifdef HAVE_SYS_IOCTL_H
55 #include <sys/ioctl.h>
60 #ifdef HAVE_SYS_STAT_H
63 #ifdef HAVE_NETINET_IN_H
64 #include <netinet/in.h>
66 #ifdef HAVE_ARPA_INET_H
67 #include <arpa/inet.h>
84 #define snprintf _snprintf
87 #ifdef USE_BUFFEREVENTS
88 #include <event2/bufferevent.h>
89 #include <event2/buffer.h>
90 #include <event2/util.h>
95 #include "../common/torlog.h"
96 #include "container.h"
99 #include "compat_libevent.h"
102 /* These signals are defined to help handle_control_signal work.
119 /* Controller signals start at a high number so we don't
120 * conflict with system-defined signals. */
121 #define SIGNEWNYM 129
122 #define SIGCLEARDNSCACHE 130
124 #if (SIZEOF_CELL_T != 0)
125 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
126 * that our stuff always calls cell_t something different. */
127 #define cell_t tor_cell_t
130 #ifdef ENABLE_TOR2WEB_MODE
131 #define NON_ANONYMOUS_MODE_ENABLED 1
134 /** Length of longest allowable configured nickname. */
135 #define MAX_NICKNAME_LEN 19
136 /** Length of a router identity encoded as a hexadecimal digest, plus
137 * possible dollar sign. */
138 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
139 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
140 * equal sign or tilde, nickname. */
141 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
143 /** Maximum size, in bytes, for resized buffers. */
144 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
145 /** Maximum size, in bytes, for any directory object that we've downloaded. */
146 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
148 /** For HTTP parsing: Maximum number of bytes we'll accept in the headers
149 * of an HTTP request or response. */
150 #define MAX_HEADERS_SIZE 50000
151 /** Maximum size, in bytes, for any directory object that we're accepting
153 #define MAX_DIR_UL_SIZE MAX_BUF_SIZE
155 /** Maximum size, in bytes, of a single router descriptor uploaded to us
156 * as a directory authority. Caches and clients fetch whatever descriptors
157 * the authorities tell them to fetch, and don't care about size. */
158 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
160 /** Maximum size of a single extrainfo document, as above. */
161 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
163 /** How long do we keep DNS cache entries before purging them (regardless of
165 #define MAX_DNS_ENTRY_AGE (30*60)
166 /** How long do we cache/tell clients to cache DNS records when no TTL is
168 #define DEFAULT_DNS_TTL (30*60)
169 /** How long can a TTL be before we stop believing it? */
170 #define MAX_DNS_TTL (3*60*60)
171 /** How small can a TTL be before we stop believing it? Provides rudimentary
173 #define MIN_DNS_TTL 60
175 /** How often do we rotate onion keys? */
176 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
177 /** How often do we rotate TLS contexts? */
178 #define MAX_SSL_KEY_LIFETIME_INTERNAL (2*60*60)
179 /** What expiry time shall we place on our SSL certs? */
180 #define MAX_SSL_KEY_LIFETIME_ADVERTISED (365*24*60*60)
182 /** How old do we allow a router to get before removing it
183 * from the router list? In seconds. */
184 #define ROUTER_MAX_AGE (60*60*48)
185 /** How old can a router get before we (as a server) will no longer
186 * consider it live? In seconds. */
187 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*24)
188 /** How old do we let a saved descriptor get before force-removing it? */
189 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
191 /** Possible rules for generating circuit IDs on an OR connection. */
193 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
194 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
195 /** The other side of a connection is an OP: never create circuits to it,
196 * and let it use any circuit ID it wants. */
197 CIRC_ID_TYPE_NEITHER
=2
200 #define _CONN_TYPE_MIN 3
201 /** Type for sockets listening for OR connections. */
202 #define CONN_TYPE_OR_LISTENER 3
203 /** A bidirectional TLS connection transmitting a sequence of cells.
204 * May be from an OR to an OR, or from an OP to an OR. */
205 #define CONN_TYPE_OR 4
206 /** A TCP connection from an onion router to a stream's destination. */
207 #define CONN_TYPE_EXIT 5
208 /** Type for sockets listening for SOCKS connections. */
209 #define CONN_TYPE_AP_LISTENER 6
210 /** A SOCKS proxy connection from the user application to the onion
212 #define CONN_TYPE_AP 7
213 /** Type for sockets listening for HTTP connections to the directory server. */
214 #define CONN_TYPE_DIR_LISTENER 8
215 /** Type for HTTP connections to the directory server. */
216 #define CONN_TYPE_DIR 9
217 /** Connection from the main process to a CPU worker process. */
218 #define CONN_TYPE_CPUWORKER 10
219 /** Type for listening for connections from user interface process. */
220 #define CONN_TYPE_CONTROL_LISTENER 11
221 /** Type for connections from user interface process. */
222 #define CONN_TYPE_CONTROL 12
223 /** Type for sockets listening for transparent connections redirected by pf or
225 #define CONN_TYPE_AP_TRANS_LISTENER 13
226 /** Type for sockets listening for transparent connections redirected by
228 #define CONN_TYPE_AP_NATD_LISTENER 14
229 /** Type for sockets listening for DNS requests. */
230 #define CONN_TYPE_AP_DNS_LISTENER 15
231 #define _CONN_TYPE_MAX 15
232 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
235 /* Proxy client types */
237 #define PROXY_CONNECT 1
238 #define PROXY_SOCKS4 2
239 #define PROXY_SOCKS5 3
240 /* !!!! If there is ever a PROXY_* type over 2, we must grow the proxy_type
241 * field in or_connection_t */
242 /* pluggable transports proxy type */
243 #define PROXY_PLUGGABLE 4
245 /* Proxy client handshake states */
246 /* We use a proxy but we haven't even connected to it yet. */
247 #define PROXY_INFANT 1
248 /* We use an HTTP proxy and we've sent the CONNECT command. */
249 #define PROXY_HTTPS_WANT_CONNECT_OK 2
250 /* We use a SOCKS4 proxy and we've sent the CONNECT command. */
251 #define PROXY_SOCKS4_WANT_CONNECT_OK 3
252 /* We use a SOCKS5 proxy and we try to negotiate without
253 any authentication . */
254 #define PROXY_SOCKS5_WANT_AUTH_METHOD_NONE 4
255 /* We use a SOCKS5 proxy and we try to negotiate with
256 Username/Password authentication . */
257 #define PROXY_SOCKS5_WANT_AUTH_METHOD_RFC1929 5
258 /* We use a SOCKS5 proxy and we just sent our credentials. */
259 #define PROXY_SOCKS5_WANT_AUTH_RFC1929_OK 6
260 /* We use a SOCKS5 proxy and we just sent our CONNECT command. */
261 #define PROXY_SOCKS5_WANT_CONNECT_OK 7
262 /* We use a proxy and we CONNECTed successfully!. */
263 #define PROXY_CONNECTED 8
265 /** True iff <b>x</b> is an edge connection. */
266 #define CONN_IS_EDGE(x) \
267 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
269 /** State for any listener connection. */
270 #define LISTENER_STATE_READY 0
272 #define _CPUWORKER_STATE_MIN 1
273 /** State for a connection to a cpuworker process that's idle. */
274 #define CPUWORKER_STATE_IDLE 1
275 /** State for a connection to a cpuworker process that's processing a
277 #define CPUWORKER_STATE_BUSY_ONION 2
278 #define _CPUWORKER_STATE_MAX 2
280 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
282 #define _OR_CONN_STATE_MIN 1
283 /** State for a connection to an OR: waiting for connect() to finish. */
284 #define OR_CONN_STATE_CONNECTING 1
285 /** State for a connection to an OR: waiting for proxy handshake to complete */
286 #define OR_CONN_STATE_PROXY_HANDSHAKING 2
287 /** State for an OR connection client: SSL is handshaking, not done
289 #define OR_CONN_STATE_TLS_HANDSHAKING 3
290 /** State for a connection to an OR: We're doing a second SSL handshake for
291 * renegotiation purposes. (V2 handshake only.) */
292 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 4
293 /** State for a connection at an OR: We're waiting for the client to
294 * renegotiate (to indicate a v2 handshake) or send a versions cell (to
295 * indicate a v3 handshake) */
296 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 5
297 /** State for an OR connection: We're done with our SSL handshake, we've done
298 * renegotiation, but we haven't yet negotiated link protocol versions and
299 * sent a netinfo cell. */
300 #define OR_CONN_STATE_OR_HANDSHAKING_V2 6
301 /** State for an OR connection: We're done with our SSL handshake, but we
302 * haven't yet negotiated link protocol versions, done a V3 handshake, and
303 * sent a netinfo cell. */
304 #define OR_CONN_STATE_OR_HANDSHAKING_V3 7
305 /** State for an OR connection: Ready to send/receive cells. */
306 #define OR_CONN_STATE_OPEN 8
307 #define _OR_CONN_STATE_MAX 8
309 #define _EXIT_CONN_STATE_MIN 1
310 /** State for an exit connection: waiting for response from DNS farm. */
311 #define EXIT_CONN_STATE_RESOLVING 1
312 /** State for an exit connection: waiting for connect() to finish. */
313 #define EXIT_CONN_STATE_CONNECTING 2
314 /** State for an exit connection: open and ready to transmit data. */
315 #define EXIT_CONN_STATE_OPEN 3
316 /** State for an exit connection: waiting to be removed. */
317 #define EXIT_CONN_STATE_RESOLVEFAILED 4
318 #define _EXIT_CONN_STATE_MAX 4
320 /* The AP state values must be disjoint from the EXIT state values. */
321 #define _AP_CONN_STATE_MIN 5
322 /** State for a SOCKS connection: waiting for SOCKS request. */
323 #define AP_CONN_STATE_SOCKS_WAIT 5
324 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
325 * rendezvous descriptor. */
326 #define AP_CONN_STATE_RENDDESC_WAIT 6
327 /** The controller will attach this connection to a circuit; it isn't our
329 #define AP_CONN_STATE_CONTROLLER_WAIT 7
330 /** State for a SOCKS connection: waiting for a completed circuit. */
331 #define AP_CONN_STATE_CIRCUIT_WAIT 8
332 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
333 #define AP_CONN_STATE_CONNECT_WAIT 9
334 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
335 #define AP_CONN_STATE_RESOLVE_WAIT 10
336 /** State for a SOCKS connection: ready to send and receive. */
337 #define AP_CONN_STATE_OPEN 11
338 /** State for a transparent natd connection: waiting for original
340 #define AP_CONN_STATE_NATD_WAIT 12
341 #define _AP_CONN_STATE_MAX 12
343 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
344 * edge connection is not attached to any circuit. */
345 #define AP_CONN_STATE_IS_UNATTACHED(s) \
346 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
348 #define _DIR_CONN_STATE_MIN 1
349 /** State for connection to directory server: waiting for connect(). */
350 #define DIR_CONN_STATE_CONNECTING 1
351 /** State for connection to directory server: sending HTTP request. */
352 #define DIR_CONN_STATE_CLIENT_SENDING 2
353 /** State for connection to directory server: reading HTTP response. */
354 #define DIR_CONN_STATE_CLIENT_READING 3
355 /** State for connection to directory server: happy and finished. */
356 #define DIR_CONN_STATE_CLIENT_FINISHED 4
357 /** State for connection at directory server: waiting for HTTP request. */
358 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
359 /** State for connection at directory server: sending HTTP response. */
360 #define DIR_CONN_STATE_SERVER_WRITING 6
361 #define _DIR_CONN_STATE_MAX 6
363 /** True iff the purpose of <b>conn</b> means that it's a server-side
364 * directory connection. */
365 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
367 #define _CONTROL_CONN_STATE_MIN 1
368 /** State for a control connection: Authenticated and accepting v1 commands. */
369 #define CONTROL_CONN_STATE_OPEN 1
370 /** State for a control connection: Waiting for authentication; speaking
372 #define CONTROL_CONN_STATE_NEEDAUTH 2
373 #define _CONTROL_CONN_STATE_MAX 2
375 #define _DIR_PURPOSE_MIN 3
376 /** A connection to a directory server: download a rendezvous
378 #define DIR_PURPOSE_FETCH_RENDDESC 3
379 /** A connection to a directory server: set after a rendezvous
380 * descriptor is downloaded. */
381 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
382 /** A connection to a directory server: download one or more v2
383 * network-status objects */
384 #define DIR_PURPOSE_FETCH_V2_NETWORKSTATUS 5
385 /** A connection to a directory server: download one or more server
387 #define DIR_PURPOSE_FETCH_SERVERDESC 6
388 /** A connection to a directory server: download one or more extra-info
390 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
391 /** A connection to a directory server: upload a server descriptor. */
392 #define DIR_PURPOSE_UPLOAD_DIR 8
393 /** A connection to a directory server: upload a rendezvous
395 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
396 /** A connection to a directory server: upload a v3 networkstatus vote. */
397 #define DIR_PURPOSE_UPLOAD_VOTE 10
398 /** A connection to a directory server: upload a v3 consensus signature */
399 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
400 /** A connection to a directory server: download one or more v3 networkstatus
402 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
403 /** A connection to a directory server: download a v3 detached signatures
404 * object for a consensus. */
405 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
406 /** A connection to a directory server: download a v3 networkstatus
408 #define DIR_PURPOSE_FETCH_CONSENSUS 14
409 /** A connection to a directory server: download one or more directory
410 * authority certificates. */
411 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
413 /** Purpose for connection at a directory server. */
414 #define DIR_PURPOSE_SERVER 16
415 /** A connection to a hidden service directory server: upload a v2 rendezvous
417 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
418 /** A connection to a hidden service directory server: download a v2 rendezvous
420 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
421 /** A connection to a directory server: download a microdescriptor. */
422 #define DIR_PURPOSE_FETCH_MICRODESC 19
423 #define _DIR_PURPOSE_MAX 19
425 /** True iff <b>p</b> is a purpose corresponding to uploading data to a
426 * directory server. */
427 #define DIR_PURPOSE_IS_UPLOAD(p) \
428 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
429 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
430 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
431 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
433 #define _EXIT_PURPOSE_MIN 1
434 /** This exit stream wants to do an ordinary connect. */
435 #define EXIT_PURPOSE_CONNECT 1
436 /** This exit stream wants to do a resolve (either normal or reverse). */
437 #define EXIT_PURPOSE_RESOLVE 2
438 #define _EXIT_PURPOSE_MAX 2
440 /* !!!! If any connection purpose is ever over 31, we must grow the type
441 * field in connection_t. */
443 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
444 #define CIRCUIT_STATE_BUILDING 0
445 /** Circuit state: Waiting to process the onionskin. */
446 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
447 /** Circuit state: I'd like to deliver a create, but my n_conn is still
449 #define CIRCUIT_STATE_OR_WAIT 2
450 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
451 #define CIRCUIT_STATE_OPEN 3
453 #define _CIRCUIT_PURPOSE_MIN 1
455 /* these circuits were initiated elsewhere */
456 #define _CIRCUIT_PURPOSE_OR_MIN 1
457 /** OR-side circuit purpose: normal circuit, at OR. */
458 #define CIRCUIT_PURPOSE_OR 1
459 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
460 #define CIRCUIT_PURPOSE_INTRO_POINT 2
461 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
462 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
463 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
464 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
465 #define _CIRCUIT_PURPOSE_OR_MAX 4
467 /* these circuits originate at this node */
469 /* here's how circ client-side purposes work:
470 * normal circuits are C_GENERAL.
471 * circuits that are c_introducing are either on their way to
472 * becoming open, or they are open and waiting for a
473 * suitable rendcirc before they send the intro.
474 * circuits that are c_introduce_ack_wait have sent the intro,
475 * but haven't gotten a response yet.
476 * circuits that are c_establish_rend are either on their way
477 * to becoming open, or they are open and have sent the
478 * establish_rendezvous cell but haven't received an ack.
479 * circuits that are c_rend_ready are open and have received a
480 * rend ack, but haven't heard from bob yet. if they have a
481 * buildstate->pending_final_cpath then they're expecting a
482 * cell from bob, else they're not.
483 * circuits that are c_rend_ready_intro_acked are open, and
484 * some intro circ has sent its intro and received an ack.
485 * circuits that are c_rend_joined are open, have heard from
486 * bob, and are talking to him.
488 /** Client-side circuit purpose: Normal circuit, with cpath. */
489 #define CIRCUIT_PURPOSE_C_GENERAL 5
490 /** Client-side circuit purpose: at Alice, connecting to intro point. */
491 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
492 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
493 * waiting for ACK/NAK. */
494 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
495 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
496 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
497 /** Client-side circuit purpose: at Alice, waiting for ack. */
498 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
499 /** Client-side circuit purpose: at Alice, waiting for Bob. */
500 #define CIRCUIT_PURPOSE_C_REND_READY 10
501 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
502 * has been acknowledged. */
503 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
504 /** Client-side circuit purpose: at Alice, rendezvous established. */
505 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
506 /** This circuit is used for build time measurement only */
507 #define CIRCUIT_PURPOSE_C_MEASURE_TIMEOUT 13
508 #define _CIRCUIT_PURPOSE_C_MAX 13
509 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
510 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 14
511 /** Hidden-service-side circuit purpose: at Bob, successfully established
513 #define CIRCUIT_PURPOSE_S_INTRO 15
514 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
515 #define CIRCUIT_PURPOSE_S_CONNECT_REND 16
516 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
517 #define CIRCUIT_PURPOSE_S_REND_JOINED 17
518 /** A testing circuit; not meant to be used for actual traffic. */
519 #define CIRCUIT_PURPOSE_TESTING 18
520 /** A controller made this circuit and Tor should not use it. */
521 #define CIRCUIT_PURPOSE_CONTROLLER 19
522 #define _CIRCUIT_PURPOSE_MAX 19
523 /** A catch-all for unrecognized purposes. Currently we don't expect
524 * to make or see any circuits with this purpose. */
525 #define CIRCUIT_PURPOSE_UNKNOWN 255
527 /** True iff the circuit purpose <b>p</b> is for a circuit that
528 * originated at this node. */
529 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
530 /** True iff the circuit purpose <b>p</b> is for a circuit that originated
531 * here to serve as a client. (Hidden services don't count here.) */
532 #define CIRCUIT_PURPOSE_IS_CLIENT(p) \
533 ((p)> _CIRCUIT_PURPOSE_OR_MAX && \
534 (p)<=_CIRCUIT_PURPOSE_C_MAX)
535 /** True iff the circuit_t <b>c</b> is actually an origin_circuit_t. */
536 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
537 /** True iff the circuit purpose <b>p</b> is for an established rendezvous
539 #define CIRCUIT_PURPOSE_IS_ESTABLISHED_REND(p) \
540 ((p) == CIRCUIT_PURPOSE_C_REND_JOINED || \
541 (p) == CIRCUIT_PURPOSE_S_REND_JOINED)
543 /** How many circuits do we want simultaneously in-progress to handle
545 #define MIN_CIRCUITS_HANDLING_STREAM 2
547 /* These RELAY_COMMAND constants define values for relay cell commands, and
548 * must match those defined in tor-spec.txt. */
549 #define RELAY_COMMAND_BEGIN 1
550 #define RELAY_COMMAND_DATA 2
551 #define RELAY_COMMAND_END 3
552 #define RELAY_COMMAND_CONNECTED 4
553 #define RELAY_COMMAND_SENDME 5
554 #define RELAY_COMMAND_EXTEND 6
555 #define RELAY_COMMAND_EXTENDED 7
556 #define RELAY_COMMAND_TRUNCATE 8
557 #define RELAY_COMMAND_TRUNCATED 9
558 #define RELAY_COMMAND_DROP 10
559 #define RELAY_COMMAND_RESOLVE 11
560 #define RELAY_COMMAND_RESOLVED 12
561 #define RELAY_COMMAND_BEGIN_DIR 13
563 #define RELAY_COMMAND_ESTABLISH_INTRO 32
564 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
565 #define RELAY_COMMAND_INTRODUCE1 34
566 #define RELAY_COMMAND_INTRODUCE2 35
567 #define RELAY_COMMAND_RENDEZVOUS1 36
568 #define RELAY_COMMAND_RENDEZVOUS2 37
569 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
570 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
571 #define RELAY_COMMAND_INTRODUCE_ACK 40
573 /* Reasons why an OR connection is closed. */
574 #define END_OR_CONN_REASON_DONE 1
575 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
576 #define END_OR_CONN_REASON_OR_IDENTITY 3
577 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
578 #define END_OR_CONN_REASON_TIMEOUT 5
579 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
580 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
581 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
582 #define END_OR_CONN_REASON_MISC 9
584 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
585 * documentation of these. The values must match. */
586 #define END_STREAM_REASON_MISC 1
587 #define END_STREAM_REASON_RESOLVEFAILED 2
588 #define END_STREAM_REASON_CONNECTREFUSED 3
589 #define END_STREAM_REASON_EXITPOLICY 4
590 #define END_STREAM_REASON_DESTROY 5
591 #define END_STREAM_REASON_DONE 6
592 #define END_STREAM_REASON_TIMEOUT 7
593 #define END_STREAM_REASON_NOROUTE 8
594 #define END_STREAM_REASON_HIBERNATING 9
595 #define END_STREAM_REASON_INTERNAL 10
596 #define END_STREAM_REASON_RESOURCELIMIT 11
597 #define END_STREAM_REASON_CONNRESET 12
598 #define END_STREAM_REASON_TORPROTOCOL 13
599 #define END_STREAM_REASON_NOTDIRECTORY 14
600 #define END_STREAM_REASON_ENTRYPOLICY 15
602 /* These high-numbered end reasons are not part of the official spec,
603 * and are not intended to be put in relay end cells. They are here
604 * to be more informative when sending back socks replies to the
606 /* XXXX 256 is no longer used; feel free to reuse it. */
607 /** We were unable to attach the connection to any circuit at all. */
608 /* XXXX the ways we use this one don't make a lot of sense. */
609 #define END_STREAM_REASON_CANT_ATTACH 257
610 /** We can't connect to any directories at all, so we killed our streams
611 * before they can time out. */
612 #define END_STREAM_REASON_NET_UNREACHABLE 258
613 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
614 * protocol in a way we couldn't handle. */
615 #define END_STREAM_REASON_SOCKSPROTOCOL 259
616 /** This is a transparent proxy connection, but we can't extract the original
617 * target address:port. */
618 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
619 /** This is a connection on the NATD port, and the destination IP:Port was
620 * either ill-formed or out-of-range. */
621 #define END_STREAM_REASON_INVALID_NATD_DEST 261
622 /** The target address is in a private network (like 127.0.0.1 or 10.0.0.1);
623 * you don't want to do that over a randomly chosen exit */
624 #define END_STREAM_REASON_PRIVATE_ADDR 262
626 /** Bitwise-and this value with endreason to mask out all flags. */
627 #define END_STREAM_REASON_MASK 511
629 /** Bitwise-or this with the argument to control_event_stream_status
630 * to indicate that the reason came from an END cell. */
631 #define END_STREAM_REASON_FLAG_REMOTE 512
632 /** Bitwise-or this with the argument to control_event_stream_status
633 * to indicate that we already sent a CLOSED stream event. */
634 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
635 /** Bitwise-or this with endreason to indicate that we already sent
636 * a socks reply, and no further reply needs to be sent from
637 * connection_mark_unattached_ap(). */
638 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
640 /** Reason for remapping an AP connection's address: we have a cached
642 #define REMAP_STREAM_SOURCE_CACHE 1
643 /** Reason for remapping an AP connection's address: the exit node told us an
645 #define REMAP_STREAM_SOURCE_EXIT 2
647 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
648 #define RESOLVED_TYPE_HOSTNAME 0
649 #define RESOLVED_TYPE_IPV4 4
650 #define RESOLVED_TYPE_IPV6 6
651 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
652 #define RESOLVED_TYPE_ERROR 0xF1
654 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
655 * call; they only go to the controller for tracking */
656 /** Our post-timeout circuit time measurement period expired.
657 * We must give up now */
658 #define END_CIRC_REASON_MEASUREMENT_EXPIRED -3
660 /** We couldn't build a path for this circuit. */
661 #define END_CIRC_REASON_NOPATH -2
662 /** Catch-all "other" reason for closing origin circuits. */
663 #define END_CIRC_AT_ORIGIN -1
665 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
666 * documentation of these. */
667 #define _END_CIRC_REASON_MIN 0
668 #define END_CIRC_REASON_NONE 0
669 #define END_CIRC_REASON_TORPROTOCOL 1
670 #define END_CIRC_REASON_INTERNAL 2
671 #define END_CIRC_REASON_REQUESTED 3
672 #define END_CIRC_REASON_HIBERNATING 4
673 #define END_CIRC_REASON_RESOURCELIMIT 5
674 #define END_CIRC_REASON_CONNECTFAILED 6
675 #define END_CIRC_REASON_OR_IDENTITY 7
676 #define END_CIRC_REASON_OR_CONN_CLOSED 8
677 #define END_CIRC_REASON_FINISHED 9
678 #define END_CIRC_REASON_TIMEOUT 10
679 #define END_CIRC_REASON_DESTROYED 11
680 #define END_CIRC_REASON_NOSUCHSERVICE 12
681 #define _END_CIRC_REASON_MAX 12
683 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
684 * control_event_circuit_status() to indicate that the reason was
685 * passed through from a destroy or truncate cell. */
686 #define END_CIRC_REASON_FLAG_REMOTE 512
688 /** Length of 'y' portion of 'y.onion' URL. */
689 #define REND_SERVICE_ID_LEN_BASE32 16
691 /** Length of 'y.onion' including '.onion' URL. */
692 #define REND_SERVICE_ADDRESS_LEN (16+1+5)
694 /** Length of a binary-encoded rendezvous service ID. */
695 #define REND_SERVICE_ID_LEN 10
697 /** Time period for which a v2 descriptor will be valid. */
698 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
700 /** Time period within which two sets of v2 descriptors will be uploaded in
702 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
704 /** Number of non-consecutive replicas (i.e. distributed somewhere
705 * in the ring) for a descriptor. */
706 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
708 /** Number of consecutive replicas for a descriptor. */
709 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
711 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
712 #define REND_DESC_ID_V2_LEN_BASE32 32
714 /** Length of the base32-encoded secret ID part of versioned hidden service
716 #define REND_SECRET_ID_PART_LEN_BASE32 32
718 /** Length of the base32-encoded hash of an introduction point's
720 #define REND_INTRO_POINT_ID_LEN_BASE32 32
722 /** Length of the descriptor cookie that is used for client authorization
723 * to hidden services. */
724 #define REND_DESC_COOKIE_LEN 16
726 /** Length of the base64-encoded descriptor cookie that is used for
727 * exchanging client authorization between hidden service and client. */
728 #define REND_DESC_COOKIE_LEN_BASE64 22
730 /** Length of client identifier in encrypted introduction points for hidden
731 * service authorization type 'basic'. */
732 #define REND_BASIC_AUTH_CLIENT_ID_LEN 4
734 /** Multiple of the number of clients to which the real number of clients
735 * is padded with fake clients for hidden service authorization type
737 #define REND_BASIC_AUTH_CLIENT_MULTIPLE 16
739 /** Length of client entry consisting of client identifier and encrypted
740 * session key for hidden service authorization type 'basic'. */
741 #define REND_BASIC_AUTH_CLIENT_ENTRY_LEN (REND_BASIC_AUTH_CLIENT_ID_LEN \
744 /** Maximum size of v2 hidden service descriptors. */
745 #define REND_DESC_MAX_SIZE (20 * 1024)
747 /** Legal characters for use in authorized client names for a hidden
749 #define REND_LEGAL_CLIENTNAME_CHARACTERS \
750 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789+-_"
752 /** Maximum length of authorized client names for a hidden service. */
753 #define REND_CLIENTNAME_MAX_LEN 16
755 /** Length of the rendezvous cookie that is used to connect circuits at the
756 * rendezvous point. */
757 #define REND_COOKIE_LEN DIGEST_LEN
759 /** Client authorization type that a hidden service performs. */
760 typedef enum rend_auth_type_t
{
763 REND_STEALTH_AUTH
= 2,
766 /** Client-side configuration of authorization for a hidden service. */
767 typedef struct rend_service_authorization_t
{
768 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
769 char onion_address
[REND_SERVICE_ADDRESS_LEN
+1];
770 rend_auth_type_t auth_type
;
771 } rend_service_authorization_t
;
773 /** Client- and server-side data that is used for hidden service connection
774 * establishment. Not all fields contain data depending on where this struct
776 typedef struct rend_data_t
{
777 /** Onion address (without the .onion part) that a client requests. */
778 char onion_address
[REND_SERVICE_ID_LEN_BASE32
+1];
780 /** (Optional) descriptor cookie that is used by a client. */
781 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
783 /** Authorization type for accessing a service used by a client. */
784 rend_auth_type_t auth_type
;
786 /** Hash of the hidden service's PK used by a service. */
787 char rend_pk_digest
[DIGEST_LEN
];
789 /** Rendezvous cookie used by both, client and service. */
790 char rend_cookie
[REND_COOKIE_LEN
];
793 /** Time interval for tracking replays of DH public keys received in
794 * INTRODUCE2 cells. Used only to avoid launching multiple
795 * simultaneous attempts to connect to the same rendezvous point. */
796 #define REND_REPLAY_TIME_INTERVAL (5 * 60)
798 /** Used to indicate which way a cell is going on a circuit. */
800 CELL_DIRECTION_IN
=1, /**< The cell is moving towards the origin. */
801 CELL_DIRECTION_OUT
=2, /**< The cell is moving away from the origin. */
804 /** Initial value for both sides of a circuit transmission window when the
805 * circuit is initialized. Measured in cells. */
806 #define CIRCWINDOW_START 1000
807 #define CIRCWINDOW_START_MIN 100
808 #define CIRCWINDOW_START_MAX 1000
809 /** Amount to increment a circuit window when we get a circuit SENDME. */
810 #define CIRCWINDOW_INCREMENT 100
811 /** Initial value on both sides of a stream transmission window when the
812 * stream is initialized. Measured in cells. */
813 #define STREAMWINDOW_START 500
814 /** Amount to increment a stream window when we get a stream SENDME. */
815 #define STREAMWINDOW_INCREMENT 50
817 /* Cell commands. These values are defined in tor-spec.txt. */
818 #define CELL_PADDING 0
819 #define CELL_CREATE 1
820 #define CELL_CREATED 2
822 #define CELL_DESTROY 4
823 #define CELL_CREATE_FAST 5
824 #define CELL_CREATED_FAST 6
825 #define CELL_VERSIONS 7
826 #define CELL_NETINFO 8
827 #define CELL_RELAY_EARLY 9
829 #define CELL_VPADDING 128
830 #define CELL_CERTS 129
831 #define CELL_AUTH_CHALLENGE 130
832 #define CELL_AUTHENTICATE 131
833 #define CELL_AUTHORIZE 132
835 /** How long to test reachability before complaining to the user. */
836 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
838 /** Legal characters in a nickname. */
839 #define LEGAL_NICKNAME_CHARACTERS \
840 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
842 /** Name to use in client TLS certificates if no nickname is given. Once
843 * Tor 0.1.2.x is obsolete, we can remove this. */
844 #define DEFAULT_CLIENT_NICKNAME "client"
846 /** Name chosen by routers that don't configure nicknames */
847 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
849 /** Number of bytes in a SOCKS4 header. */
850 #define SOCKS4_NETWORK_LEN 8
854 * Relay command [1 byte]
855 * Recognized [2 bytes]
856 * Stream ID [2 bytes]
857 * Partial SHA-1 [4 bytes]
859 * Relay payload [498 bytes]
862 /** Number of bytes in a cell, minus cell header. */
863 #define CELL_PAYLOAD_SIZE 509
864 /** Number of bytes in a cell transmitted over the network. */
865 #define CELL_NETWORK_SIZE 512
867 /** Length of a header on a variable-length cell. */
868 #define VAR_CELL_HEADER_SIZE 5
870 /** Number of bytes in a relay cell's header (not including general cell
872 #define RELAY_HEADER_SIZE (1+2+2+4+2)
873 /** Largest number of bytes that can fit in a relay cell payload. */
874 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
876 /** Identifies a circuit on an or_connection */
877 typedef uint16_t circid_t
;
878 /** Identifies a stream on a circuit */
879 typedef uint16_t streamid_t
;
881 /** Parsed onion routing cell. All communication between nodes
883 typedef struct cell_t
{
884 circid_t circ_id
; /**< Circuit which received the cell. */
885 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
886 * CELL_DESTROY, etc */
887 uint8_t payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
890 /** Parsed variable-length onion routing cell. */
891 typedef struct var_cell_t
{
892 /** Type of the cell: CELL_VERSIONS, etc. */
894 /** Circuit thich received the cell */
896 /** Number of bytes actually stored in <b>payload</b> */
897 uint16_t payload_len
;
898 /** Payload of this cell */
899 uint8_t payload
[FLEXIBLE_ARRAY_MEMBER
];
902 /** A cell as packed for writing to the network. */
903 typedef struct packed_cell_t
{
904 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
905 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
908 /** Number of cells added to a circuit queue including their insertion
909 * time on 10 millisecond detail; used for buffer statistics. */
910 typedef struct insertion_time_elem_t
{
911 struct insertion_time_elem_t
*next
; /**< Next element in queue. */
912 uint32_t insertion_time
; /**< When were cells inserted (in 10 ms steps
913 * starting at 0:00 of the current day)? */
914 unsigned counter
; /**< How many cells were inserted? */
915 } insertion_time_elem_t
;
917 /** Queue of insertion times. */
918 typedef struct insertion_time_queue_t
{
919 struct insertion_time_elem_t
*first
; /**< First element in queue. */
920 struct insertion_time_elem_t
*last
; /**< Last element in queue. */
921 } insertion_time_queue_t
;
923 /** A queue of cells on a circuit, waiting to be added to the
924 * or_connection_t's outbuf. */
925 typedef struct cell_queue_t
{
926 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
927 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
928 int n
; /**< The number of cells in the queue. */
929 insertion_time_queue_t
*insertion_times
; /**< Insertion times of cells. */
932 /** Beginning of a RELAY cell payload. */
934 uint8_t command
; /**< The end-to-end relay command. */
935 uint16_t recognized
; /**< Used to tell whether cell is for us. */
936 streamid_t stream_id
; /**< Which stream is this cell associated with? */
937 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
938 uint16_t length
; /**< How long is the payload body? */
941 typedef struct buf_t buf_t
;
942 typedef struct socks_request_t socks_request_t
;
943 #ifdef USE_BUFFEREVENTS
944 #define generic_buffer_t struct evbuffer
946 #define generic_buffer_t buf_t
949 /* Values for connection_t.magic: used to make sure that downcasts (casts from
950 * connection_t to foo_connection_t) are safe. */
951 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
952 #define OR_CONNECTION_MAGIC 0x7D31FF03u
953 #define EDGE_CONNECTION_MAGIC 0xF0374013u
954 #define ENTRY_CONNECTION_MAGIC 0xbb4a5703
955 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
956 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
957 #define LISTENER_CONNECTION_MAGIC 0x1a1ac741u
959 /** Description of a connection to another host or process, and associated
962 * A connection is named based on what it's connected to -- an "OR
963 * connection" has a Tor node on the other end, an "exit
964 * connection" has a website or other server on the other end, and an
965 * "AP connection" has an application proxy (and thus a user) on the
968 * Every connection has a type and a state. Connections never change
969 * their type, but can go through many state changes in their lifetime.
971 * Every connection has two associated input and output buffers.
972 * Listeners don't use them. For non-listener connections, incoming
973 * data is appended to conn->inbuf, and outgoing data is taken from
974 * conn->outbuf. Connections differ primarily in the functions called
975 * to fill and drain these buffers.
977 typedef struct connection_t
{
978 uint32_t magic
; /**< For memory debugging: must equal one of
979 * *_CONNECTION_MAGIC. */
981 uint8_t state
; /**< Current state of this connection. */
982 unsigned int type
:4; /**< What kind of connection is this? */
983 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
985 /* The next fields are all one-bit booleans. Some are only applicable to
986 * connection subtypes, but we hold them here anyway, to save space.
988 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
989 * again once the bandwidth throttler allows it? */
990 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
991 * again once the bandwidth throttler allows
993 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
994 * marked for close, do we flush it
995 * before closing it? */
996 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
998 /** Set to 1 when we're inside connection_flushed_some to keep us from
999 * calling connection_handle_write() recursively. */
1000 unsigned int in_flushed_some
:1;
1002 /* For linked connections:
1004 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
1005 /** True iff we'd like to be notified about read events from the
1007 unsigned int reading_from_linked_conn
:1;
1008 /** True iff we're willing to write to the linked conn. */
1009 unsigned int writing_to_linked_conn
:1;
1010 /** True iff we're currently able to read on the linked conn, and our
1011 * read_event should be made active with libevent. */
1012 unsigned int active_on_link
:1;
1013 /** True iff we've called connection_close_immediate() on this linked
1015 unsigned int linked_conn_is_closed
:1;
1017 /** CONNECT/SOCKS proxy client handshake state (for outgoing connections). */
1018 unsigned int proxy_state
:4;
1020 /** Our socket; set to TOR_INVALID_SOCKET if this connection is closed,
1021 * or has no socket. */
1023 int conn_array_index
; /**< Index into the global connection array. */
1025 struct event
*read_event
; /**< Libevent event structure. */
1026 struct event
*write_event
; /**< Libevent event structure. */
1027 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
1028 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
1029 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
1031 time_t timestamp_lastread
; /**< When was the last time libevent said we could
1033 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
1036 #ifdef USE_BUFFEREVENTS
1037 struct bufferevent
*bufev
; /**< A Libevent buffered IO structure. */
1040 time_t timestamp_created
; /**< When was this connection_t created? */
1042 /* XXXX_IP6 make this IPv6-capable */
1043 int socket_family
; /**< Address family of this connection's socket. Usually
1044 * AF_INET, but it can also be AF_UNIX, or in the future
1046 tor_addr_t addr
; /**< IP of the other side of the connection; used to
1047 * identify routers, along with port. */
1048 uint16_t port
; /**< If non-zero, port on the other end
1049 * of the connection. */
1050 uint16_t marked_for_close
; /**< Should we close this conn on the next
1051 * iteration of the main loop? (If true, holds
1052 * the line number where this connection was
1054 const char *marked_for_close_file
; /**< For debugging: in which file were
1055 * we marked for close? */
1056 char *address
; /**< FQDN (or IP) of the guy on the other end.
1057 * strdup into this, because free_connection() frees it. */
1058 /** Another connection that's connected to this one in lieu of a socket. */
1059 struct connection_t
*linked_conn
;
1061 /** Unique identifier for this connection on this Tor instance. */
1062 uint64_t global_identifier
;
1064 /** Unique ID for measuring tunneled network status requests. */
1068 /** Subtype of connection_t; used for a listener socket. */
1069 typedef struct listener_connection_t
{
1072 /** If the connection is a CONN_TYPE_AP_DNS_LISTENER, this field points
1073 * to the evdns_server_port it uses to listen to and answer connections. */
1074 struct evdns_server_port
*dns_server_port
;
1076 /** @name Isolation parameters
1078 * For an AP listener, these fields describe how to isolate streams that
1079 * arrive on the listener.
1083 /** The session group for this listener. */
1085 /** One or more ISO_ flags to describe how to isolate streams. */
1086 uint8_t isolation_flags
;
1089 } listener_connection_t
;
1091 /** Minimum length of the random part of an AUTH_CHALLENGE cell. */
1092 #define OR_AUTH_CHALLENGE_LEN 32
1095 * @name Certificate types for CERTS cells.
1097 * These values are defined by the protocol, and affect how an X509
1098 * certificate in a CERTS cell is interpreted and used.
1101 /** A certificate that authenticates a TLS link key. The subject key
1102 * must match the key used in the TLS handshake; it must be signed by
1103 * the identity key. */
1104 #define OR_CERT_TYPE_TLS_LINK 1
1105 /** A self-signed identity certificate. The subject key must be a
1106 * 1024-bit RSA key. */
1107 #define OR_CERT_TYPE_ID_1024 2
1108 /** A certificate that authenticates a key used in an AUTHENTICATE cell
1109 * in the v3 handshake. The subject key must be a 1024-bit RSA key; it
1110 * must be signed by the identity key */
1111 #define OR_CERT_TYPE_AUTH_1024 3
1114 /** The one currently supported type of AUTHENTICATE cell. It contains
1115 * a bunch of structures signed with an RSA1024 key. The signed
1116 * structures include a HMAC using negotiated TLS secrets, and a digest
1117 * of all cells sent or received before the AUTHENTICATE cell (including
1118 * the random server-generated AUTH_CHALLENGE cell).
1120 #define AUTHTYPE_RSA_SHA256_TLSSECRET 1
1122 /** The length of the part of the AUTHENTICATE cell body that the client and
1123 * server can generate independently (when using RSA_SHA256_TLSSECRET). It
1124 * contains everything except the client's timestamp, the client's randomly
1125 * generated nonce, and the signature. */
1126 #define V3_AUTH_FIXED_PART_LEN (8+(32*6))
1127 /** The length of the part of the AUTHENTICATE cell body that the client
1129 #define V3_AUTH_BODY_LEN (V3_AUTH_FIXED_PART_LEN + 8 + 16)
1131 /** Stores flags and information related to the portion of a v2/v3 Tor OR
1132 * connection handshake that happens after the TLS handshake is finished.
1134 typedef struct or_handshake_state_t
{
1135 /** When was the VERSIONS cell sent on this connection? Used to get
1136 * an estimate of the skew in the returning NETINFO reply. */
1137 time_t sent_versions_at
;
1138 /** True iff we originated this connection */
1139 unsigned int started_here
: 1;
1140 /** True iff we have received and processed a VERSIONS cell. */
1141 unsigned int received_versions
: 1;
1142 /** True iff we have received and processed an AUTH_CHALLENGE cell */
1143 unsigned int received_auth_challenge
: 1;
1144 /** True iff we have received and processed a CERTS cell. */
1145 unsigned int received_certs_cell
: 1;
1146 /** True iff we have received and processed an AUTHENTICATE cell */
1147 unsigned int received_authenticate
: 1;
1149 /* True iff we've received valid authentication to some identity. */
1150 unsigned int authenticated
: 1;
1152 /** True iff we should feed outgoing cells into digest_sent and
1153 * digest_received respectively.
1155 * From the server's side of the v3 handshake, we want to capture everything
1156 * from the VERSIONS cell through and including the AUTH_CHALLENGE cell.
1157 * From the client's, we want to capture everything from the VERSIONS cell
1158 * through but *not* including the AUTHENTICATE cell.
1161 unsigned int digest_sent_data
: 1;
1162 unsigned int digest_received_data
: 1;
1165 /** Identity digest that we have received and authenticated for our peer
1166 * on this connection. */
1167 uint8_t authenticated_peer_id
[DIGEST_LEN
];
1169 /** Digests of the cells that we have sent or received as part of a V3
1170 * handshake. Used for making and checking AUTHENTICATE cells.
1174 crypto_digest_t
*digest_sent
;
1175 crypto_digest_t
*digest_received
;
1178 /** Certificates that a connection initiator sent us in a CERTS cell; we're
1179 * holding on to them until we get an AUTHENTICATE cell.
1183 /** The cert for the key that's supposed to sign the AUTHENTICATE cell */
1184 tor_cert_t
*auth_cert
;
1185 /** A self-signed identity certificate */
1186 tor_cert_t
*id_cert
;
1188 } or_handshake_state_t
;
1190 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
1191 * cells over TLS. */
1192 typedef struct or_connection_t
{
1195 /** Hash of the public RSA key for the other side's identity key, or zeroes
1196 * if the other side hasn't shown us a valid identity key. */
1197 char identity_digest
[DIGEST_LEN
];
1198 char *nickname
; /**< Nickname of OR on other side (if any). */
1200 tor_tls_t
*tls
; /**< TLS connection state. */
1201 int tls_error
; /**< Last tor_tls error code. */
1202 /** When we last used this conn for any client traffic. If not
1203 * recent, we can rate limit it further. */
1206 tor_addr_t real_addr
; /**< The actual address that this connection came from
1207 * or went to. The <b>addr</b> field is prone to
1208 * getting overridden by the address from the router
1209 * descriptor matching <b>identity_digest</b>. */
1211 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
1212 * connection, which half of the space should
1214 /** Should this connection be used for extending circuits to the server
1215 * matching the <b>identity_digest</b> field? Set to true if we're pretty
1216 * sure we aren't getting MITMed, either because we're connected to an
1217 * address listed in a server descriptor, or because an authenticated
1218 * NETINFO cell listed the address we're connected to as recognized. */
1219 unsigned int is_canonical
:1;
1220 /** True iff this connection shouldn't get any new circs attached to it,
1221 * because the connection is too old, or because there's a better one.
1222 * More generally, this flag is used to note an unhealthy connection;
1223 * for example, if a bad connection fails we shouldn't assume that the
1224 * router itself has a problem.
1226 unsigned int is_bad_for_new_circs
:1;
1227 /** True iff we have decided that the other end of this connection
1228 * is a client. Connections with this flag set should never be used
1229 * to satisfy an EXTEND request. */
1230 unsigned int is_connection_with_client
:1;
1231 /** True iff this is an outgoing connection. */
1232 unsigned int is_outgoing
:1;
1233 unsigned int proxy_type
:2; /**< One of PROXY_NONE...PROXY_SOCKS5 */
1234 uint8_t link_proto
; /**< What protocol version are we using? 0 for
1235 * "none negotiated yet." */
1236 circid_t next_circ_id
; /**< Which circ_id do we try to use next on
1237 * this connection? This is always in the
1238 * range 0..1<<15-1. */
1240 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
1241 * up, state information to do so. */
1242 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
1243 time_t timestamp_last_added_nonpadding
; /** When did we last add a
1244 * non-padding cell to the outbuf? */
1246 /* bandwidth* and *_bucket only used by ORs in OPEN state: */
1247 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
1248 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
1249 #ifndef USE_BUFFEREVENTS
1250 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
1251 * add 'bandwidthrate' to this, capping it at
1252 * bandwidthburst. (OPEN ORs only) */
1253 int write_bucket
; /**< When this hits 0, stop writing. Like read_bucket. */
1255 /** A rate-limiting configuration object to determine how this connection
1256 * set its read- and write- limits. */
1257 /* XXXX we could share this among all connections. */
1258 struct ev_token_bucket_cfg
*bucket_cfg
;
1260 int n_circuits
; /**< How many circuits use this connection as p_conn or
1263 /** Double-linked ring of circuits with queued cells waiting for room to
1264 * free up on this connection's outbuf. Every time we pull cells from a
1265 * circuit, we advance this pointer to the next circuit in the ring. */
1266 struct circuit_t
*active_circuits
;
1267 /** Priority queue of cell_ewma_t for circuits with queued cells waiting for
1268 * room to free up on this connection's outbuf. Kept in heap order
1269 * according to EWMA.
1271 * This is redundant with active_circuits; if we ever decide only to use the
1272 * cell_ewma algorithm for choosing circuits, we can remove active_circuits.
1274 smartlist_t
*active_circuit_pqueue
;
1275 /** The tick on which the cell_ewma_ts in active_circuit_pqueue last had
1276 * their ewma values rescaled. */
1277 unsigned active_circuit_pqueue_last_recalibrated
;
1278 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
1279 * identity digest as this one. */
1282 /** Subtype of connection_t for an "edge connection" -- that is, an entry (ap)
1283 * connection, or an exit. */
1284 typedef struct edge_connection_t
{
1287 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
1289 int package_window
; /**< How many more relay cells can I send into the
1291 int deliver_window
; /**< How many more relay cells can end at me? */
1293 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
1294 * connection is using. */
1296 /** A pointer to which node in the circ this conn exits at. Set for AP
1297 * connections and for hidden service exit connections. */
1298 struct crypt_path_t
*cpath_layer
;
1299 /** What rendezvous service are we querying for (if an AP) or providing (if
1301 rend_data_t
*rend_data
;
1303 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
1304 * connection. Exit connections only. */
1306 streamid_t stream_id
; /**< The stream ID used for this edge connection on its
1309 /** The reason why this connection is closing; passed to the controller. */
1310 uint16_t end_reason
;
1312 /** Bytes read since last call to control_event_stream_bandwidth_used() */
1315 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1318 /** True iff this connection is for a DNS request only. */
1319 unsigned int is_dns_request
:1;
1321 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
1322 * connections. Set once we've set the stream end,
1323 * and check in connection_about_to_close_connection().
1325 /** True iff we've blocked reading until the circuit has fewer queued
1327 unsigned int edge_blocked_on_circ
:1;
1329 } edge_connection_t
;
1331 /** Subtype of edge_connection_t for an "entry connection" -- that is, a SOCKS
1332 * connection, a DNS request, a TransPort connection or a NATD connection */
1333 typedef struct entry_connection_t
{
1334 edge_connection_t _edge
;
1336 /** Nickname of planned exit node -- used with .exit support. */
1337 char *chosen_exit_name
;
1339 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
1342 /* === Isolation related, AP only. === */
1343 /** AP only: based on which factors do we isolate this stream? */
1344 uint8_t isolation_flags
;
1345 /** AP only: what session group is this stream in? */
1347 /** AP only: The newnym epoch in which we created this connection. */
1349 /** AP only: The original requested address before we rewrote it. */
1350 char *original_dest_address
;
1351 /* Other fields to isolate on already exist. The ClientAddr is addr. The
1352 ClientProtocol is a combination of type and socks_request->
1353 socks_version. SocksAuth is socks_request->username/password.
1354 DestAddr is in socks_request->address. */
1356 /** Number of times we've reassigned this application connection to
1357 * a new circuit. We keep track because the timeout is longer if we've
1358 * already retried several times. */
1359 uint8_t num_socks_retries
;
1361 /** For AP connections only: buffer for data that we have sent
1362 * optimistically, which we might need to re-send if we have to
1363 * retry this connection. */
1364 generic_buffer_t
*pending_optimistic_data
;
1365 /* For AP connections only: buffer for data that we previously sent
1366 * optimistically which we are currently re-sending as we retry this
1368 generic_buffer_t
*sending_optimistic_data
;
1370 /** If this is a DNSPort connection, this field holds the pending DNS
1371 * request that we're going to try to answer. */
1372 struct evdns_server_request
*dns_server_request
;
1374 #define NUM_CIRCUITS_LAUNCHED_THRESHOLD 10
1375 /** Number of times we've launched a circuit to handle this stream. If
1376 * it gets too high, that could indicate an inconsistency between our
1377 * "launch a circuit to handle this stream" logic and our "attach our
1378 * stream to one of the available circuits" logic. */
1379 unsigned int num_circuits_launched
:4;
1381 /** True iff this stream must attach to a one-hop circuit (e.g. for
1383 unsigned int want_onehop
:1;
1384 /** True iff this stream should use a BEGIN_DIR relay command to establish
1385 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1386 unsigned int use_begindir
:1;
1388 /** For AP connections only. If 1, and we fail to reach the chosen exit,
1389 * stop requiring it. */
1390 unsigned int chosen_exit_optional
:1;
1391 /** For AP connections only. If non-zero, this exit node was picked as
1392 * a result of the TrackHostExit, and the value decrements every time
1393 * we fail to complete a circuit to our chosen exit -- if it reaches
1394 * zero, abandon the associated mapaddress. */
1395 unsigned int chosen_exit_retries
:3;
1397 /** True iff this is an AP connection that came from a transparent or
1398 * NATd connection */
1399 unsigned int is_transparent_ap
:1;
1401 /** For AP connections only: Set if this connection's target exit node
1402 * allows optimistic data (that is, data sent on this stream before
1403 * the exit has sent a CONNECTED cell) and we have chosen to use it.
1405 unsigned int may_use_optimistic_data
: 1;
1407 } entry_connection_t
;
1409 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1410 * connection to retrieve or serve directory material. */
1411 typedef struct dir_connection_t
{
1414 /** Which 'resource' did we ask the directory for? This is typically the part
1415 * of the URL string that defines, relative to the directory conn purpose,
1416 * what thing we want. For example, in router descriptor downloads by
1417 * descriptor digest, it contains "d/", then one ore more +-separated
1420 char *requested_resource
;
1421 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1423 /* Used only for server sides of some dir connections, to implement
1424 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1425 * to append everything to the outbuf in one enormous chunk. */
1426 /** What exactly are we spooling right now? */
1428 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1429 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1430 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
,
1431 DIR_SPOOL_MICRODESC
, /* NOTE: if we add another entry, add another bit. */
1432 } dir_spool_src
: 3;
1433 /** If we're fetching descriptors, what router purpose shall we assign
1435 uint8_t router_purpose
;
1436 /** List of fingerprints for networkstatuses or descriptors to be spooled. */
1437 smartlist_t
*fingerprint_stack
;
1438 /** A cached_dir_t object that we're currently spooling out */
1439 struct cached_dir_t
*cached_dir
;
1440 /** The current offset into cached_dir. */
1441 off_t cached_dir_offset
;
1442 /** The zlib object doing on-the-fly compression for spooled data. */
1443 tor_zlib_state_t
*zlib_state
;
1445 /** What rendezvous service are we querying for? */
1446 rend_data_t
*rend_data
;
1448 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1449 * the directory server's signing key. */
1453 /** Subtype of connection_t for an connection to a controller. */
1454 typedef struct control_connection_t
{
1457 uint32_t event_mask
; /**< Bitfield: which events does this controller
1460 /** True if we have sent a protocolinfo reply on this connection. */
1461 unsigned int have_sent_protocolinfo
:1;
1462 /** True if we have received a takeownership command on this
1464 unsigned int is_owning_control_connection
:1;
1466 /** If we have sent an AUTHCHALLENGE reply on this connection and
1467 * have not received a successful AUTHENTICATE command, points to
1468 * the value which the client must send to authenticate itself;
1469 * otherwise, NULL. */
1470 char *safecookie_client_hash
;
1472 /** Amount of space allocated in incoming_cmd. */
1473 uint32_t incoming_cmd_len
;
1474 /** Number of bytes currently stored in incoming_cmd. */
1475 uint32_t incoming_cmd_cur_len
;
1476 /** A control command that we're reading from the inbuf, but which has not
1477 * yet arrived completely. */
1479 } control_connection_t
;
1481 /** Cast a connection_t subtype pointer to a connection_t **/
1482 #define TO_CONN(c) (&(((c)->_base)))
1483 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1484 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1486 /** Cast a entry_connection_t subtype pointer to a edge_connection_t **/
1487 #define ENTRY_TO_EDGE_CONN(c) (&(((c))->_edge))
1488 /** Cast a entry_connection_t subtype pointer to a connection_t **/
1489 #define ENTRY_TO_CONN(c) (TO_CONN(ENTRY_TO_EDGE_CONN(c)))
1491 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1493 static or_connection_t
*TO_OR_CONN(connection_t
*);
1494 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1496 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1497 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1499 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1500 /** Convert a connection_t* to an entry_connection_t*; assert if the cast is
1502 static entry_connection_t
*TO_ENTRY_CONN(connection_t
*);
1503 /** Convert a edge_connection_t* to an entry_connection_t*; assert if the cast
1505 static entry_connection_t
*EDGE_TO_ENTRY_CONN(edge_connection_t
*);
1506 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1508 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1509 /** Convert a connection_t* to an listener_connection_t*; assert if the cast is
1511 static listener_connection_t
*TO_LISTENER_CONN(connection_t
*);
1513 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1515 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1516 return DOWNCAST(or_connection_t
, c
);
1518 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1520 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1521 return DOWNCAST(dir_connection_t
, c
);
1523 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1525 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
||
1526 c
->magic
== ENTRY_CONNECTION_MAGIC
);
1527 return DOWNCAST(edge_connection_t
, c
);
1529 static INLINE entry_connection_t
*TO_ENTRY_CONN(connection_t
*c
)
1531 tor_assert(c
->magic
== ENTRY_CONNECTION_MAGIC
);
1532 return (entry_connection_t
*) SUBTYPE_P(c
, entry_connection_t
, _edge
._base
);
1534 static INLINE entry_connection_t
*EDGE_TO_ENTRY_CONN(edge_connection_t
*c
)
1536 tor_assert(c
->_base
.magic
== ENTRY_CONNECTION_MAGIC
);
1537 return (entry_connection_t
*) SUBTYPE_P(c
, entry_connection_t
, _edge
);
1539 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1541 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1542 return DOWNCAST(control_connection_t
, c
);
1544 static INLINE listener_connection_t
*TO_LISTENER_CONN(connection_t
*c
)
1546 tor_assert(c
->magic
== LISTENER_CONNECTION_MAGIC
);
1547 return DOWNCAST(listener_connection_t
, c
);
1550 /* Conditional macros to help write code that works whether bufferevents are
1553 We can't just write:
1555 do bufferevent stuff;
1559 because the bufferevent stuff won't even compile unless we have a fairly
1560 new version of Libevent. Instead, we say:
1561 IF_HAS_BUFFEREVENT(conn, { do_bufferevent_stuff } );
1563 IF_HAS_BUFFEREVENT(conn, {
1564 do bufferevent stuff;
1565 }) ELSE_IF_NO_BUFFEREVENT {
1566 do non-bufferevent stuff;
1568 If we're compiling with bufferevent support, then the macros expand more or
1571 do_bufferevent_stuff;
1573 do non-bufferevent stuff;
1575 and if we aren't using bufferevents, they expand more or less to:
1576 { do non-bufferevent stuff; }
1578 #ifdef USE_BUFFEREVENTS
1579 #define HAS_BUFFEREVENT(c) (((c)->bufev) != NULL)
1580 #define IF_HAS_BUFFEREVENT(c, stmt) \
1581 if ((c)->bufev) do { \
1584 #define ELSE_IF_NO_BUFFEREVENT ; else
1585 #define IF_HAS_NO_BUFFEREVENT(c) \
1586 if (NULL == (c)->bufev)
1588 #define HAS_BUFFEREVENT(c) (0)
1589 #define IF_HAS_BUFFEREVENT(c, stmt) (void)0
1590 #define ELSE_IF_NO_BUFFEREVENT ;
1591 #define IF_HAS_NO_BUFFEREVENT(c) \
1595 /** What action type does an address policy indicate: accept or reject? */
1597 ADDR_POLICY_ACCEPT
=1,
1598 ADDR_POLICY_REJECT
=2,
1599 } addr_policy_action_t
;
1601 /** A reference-counted address policy rule. */
1602 typedef struct addr_policy_t
{
1603 int refcnt
; /**< Reference count */
1604 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1605 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1607 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1608 * copy (stored in a hash table to avoid
1609 * duplication of common policies) */
1610 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1611 * first <b>maskbits</b> bits of <b>a</b> match
1613 tor_addr_t addr
; /**< Base address to accept or reject. */
1614 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1615 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1618 /** A cached_dir_t represents a cacheable directory object, along with its
1619 * compressed form. */
1620 typedef struct cached_dir_t
{
1621 char *dir
; /**< Contents of this object, NUL-terminated. */
1622 char *dir_z
; /**< Compressed contents of this object. */
1623 size_t dir_len
; /**< Length of <b>dir</b> (not counting its NUL). */
1624 size_t dir_z_len
; /**< Length of <b>dir_z</b>. */
1625 time_t published
; /**< When was this object published. */
1626 digests_t digests
; /**< Digests of this object (networkstatus only) */
1627 int refcnt
; /**< Reference count for this cached_dir_t. */
1630 /** Enum used to remember where a signed_descriptor_t is stored and how to
1631 * manage the memory for signed_descriptor_body. */
1633 /** The descriptor isn't stored on disk at all: the copy in memory is
1634 * canonical; the saved_offset field is meaningless. */
1636 /** The descriptor is stored in the cached_routers file: the
1637 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1638 * saved_offset are used to index into the mmaped cache file. */
1640 /** The descriptor is stored in the cached_routers.new file: the
1641 * signed_descriptor_body and saved_offset fields are both set. */
1642 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1643 * lazy-load the descriptor text by using seek and read. We don't, for
1649 /** Enumeration: what kind of download schedule are we using for a given
1652 DL_SCHED_GENERIC
= 0,
1653 DL_SCHED_CONSENSUS
= 1,
1654 DL_SCHED_BRIDGE
= 2,
1655 } download_schedule_t
;
1657 /** Information about our plans for retrying downloads for a downloadable
1659 typedef struct download_status_t
{
1660 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1662 uint8_t n_download_failures
; /**< Number of failures trying to download the
1663 * most recent descriptor. */
1664 download_schedule_t schedule
: 8;
1665 } download_status_t
;
1667 /** If n_download_failures is this high, the download can never happen. */
1668 #define IMPOSSIBLE_TO_DOWNLOAD 255
1670 /** The max size we expect router descriptor annotations we create to
1671 * be. We'll accept larger ones if we see them on disk, but we won't
1672 * create any that are larger than this. */
1673 #define ROUTER_ANNOTATION_BUF_LEN 256
1675 /** Information need to cache an onion router's descriptor. */
1676 typedef struct signed_descriptor_t
{
1677 /** Pointer to the raw server descriptor, preceded by annotations. Not
1678 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1679 * pointer is null. */
1680 char *signed_descriptor_body
;
1681 /** Length of the annotations preceding the server descriptor. */
1682 size_t annotations_len
;
1683 /** Length of the server descriptor. */
1684 size_t signed_descriptor_len
;
1685 /** Digest of the server descriptor, computed as specified in
1687 char signed_descriptor_digest
[DIGEST_LEN
];
1688 /** Identity digest of the router. */
1689 char identity_digest
[DIGEST_LEN
];
1690 /** Declared publication time of the descriptor. */
1691 time_t published_on
;
1692 /** For routerdescs only: digest of the corresponding extrainfo. */
1693 char extra_info_digest
[DIGEST_LEN
];
1694 /** For routerdescs only: Status of downloading the corresponding
1696 download_status_t ei_dl_status
;
1697 /** Where is the descriptor saved? */
1698 saved_location_t saved_location
;
1699 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1700 * this descriptor in the corresponding file. */
1702 /** What position is this descriptor within routerlist->routers or
1703 * routerlist->old_routers? -1 for none. */
1704 int routerlist_index
;
1705 /** The valid-until time of the most recent consensus that listed this
1706 * descriptor, or a bit after the publication time of the most recent v2
1707 * networkstatus that listed it. 0 for "never listed in a consensus or
1708 * status, so far as we know." */
1709 time_t last_listed_as_valid_until
;
1710 /* If true, we do not ever try to save this object in the cache. */
1711 unsigned int do_not_cache
: 1;
1712 /* If true, this item is meant to represent an extrainfo. */
1713 unsigned int is_extrainfo
: 1;
1714 /* If true, we got an extrainfo for this item, and the digest was right,
1715 * but it was incompatible. */
1716 unsigned int extrainfo_is_bogus
: 1;
1717 /* If true, we are willing to transmit this item unencrypted. */
1718 unsigned int send_unencrypted
: 1;
1719 } signed_descriptor_t
;
1721 /** A signed integer representing a country code. */
1722 typedef int16_t country_t
;
1724 /** Information about another onion router in the network. */
1726 signed_descriptor_t cache_info
;
1727 char *address
; /**< Location of OR: either a hostname or an IP address. */
1728 char *nickname
; /**< Human-readable OR name. */
1730 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1731 uint16_t or_port
; /**< Port for TLS connections. */
1732 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1734 /** A router's IPv6 address, if it has one. */
1735 /* XXXXX187 Actually these should probably be part of a list of addresses,
1736 * not just a special case. Use abstractions to access these; don't do it
1738 tor_addr_t ipv6_addr
;
1739 uint16_t ipv6_orport
;
1741 crypto_pk_t
*onion_pkey
; /**< Public RSA key for onions. */
1742 crypto_pk_t
*identity_pkey
; /**< Public RSA key for signing. */
1744 char *platform
; /**< What software/operating system is this OR using? */
1747 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1748 * bucket per second? */
1749 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1750 /** How many bytes/s is this router known to handle? */
1751 uint32_t bandwidthcapacity
;
1752 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1753 * to exit? NULL for 'reject *:*'. */
1754 long uptime
; /**< How many seconds the router claims to have been up */
1755 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1756 * claims are its family. */
1757 char *contact_info
; /**< Declared contact info for this router. */
1758 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1760 unsigned int caches_extra_info
:1; /**< Whether the router says it caches and
1761 * serves extrainfo documents. */
1762 unsigned int allow_single_hop_exits
:1; /**< Whether the router says
1763 * it allows single hop exits. */
1765 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1766 * a hidden service directory. */
1767 unsigned int policy_is_reject_star
:1; /**< True iff the exit policy for this
1768 * router rejects everything. */
1769 /** True if, after we have added this router, we should re-launch
1771 unsigned int needs_retest_if_added
:1;
1772 /** True if ipv6_addr:ipv6_orport is preferred. */
1773 unsigned int ipv6_preferred
:1;
1775 /** Tor can use this router for general positions in circuits; we got it
1776 * from a directory server as usual, or we're an authority and a server
1778 #define ROUTER_PURPOSE_GENERAL 0
1779 /** Tor should avoid using this router for circuit-building: we got it
1780 * from a crontroller. If the controller wants to use it, it'll have to
1781 * ask for it by identity. */
1782 #define ROUTER_PURPOSE_CONTROLLER 1
1783 /** Tor should use this router only for bridge positions in circuits: we got
1784 * it via a directory request from the bridge itself, or a bridge
1786 #define ROUTER_PURPOSE_BRIDGE 2
1787 /** Tor should not use this router; it was marked in cached-descriptors with
1788 * a purpose we didn't recognize. */
1789 #define ROUTER_PURPOSE_UNKNOWN 255
1791 /* In what way did we find out about this router? One of ROUTER_PURPOSE_*.
1792 * Routers of different purposes are kept segregated and used for different
1793 * things; see notes on ROUTER_PURPOSE_* macros above.
1797 /* The below items are used only by authdirservers for
1798 * reachability testing. */
1800 /** When was the last time we could reach this OR? */
1801 time_t last_reachable
;
1802 /** When did we start testing reachability for this OR? */
1803 time_t testing_since
;
1807 /** Information needed to keep and cache a signed extra-info document. */
1808 typedef struct extrainfo_t
{
1809 signed_descriptor_t cache_info
;
1810 /** The router's nickname. */
1811 char nickname
[MAX_NICKNAME_LEN
+1];
1812 /** True iff we found the right key for this extra-info, verified the
1813 * signature, and found it to be bad. */
1814 unsigned int bad_sig
: 1;
1815 /** If present, we didn't have the right key to verify this extra-info,
1816 * so this is a copy of the signature in the document. */
1818 /** Length of pending_sig. */
1819 size_t pending_sig_len
;
1822 /** Contents of a single router entry in a network status object.
1824 typedef struct routerstatus_t
{
1825 time_t published_on
; /**< When was this router published? */
1826 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1828 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1830 /** Digest of the router's most recent descriptor or microdescriptor.
1831 * If it's a descriptor, we only use the first DIGEST_LEN bytes. */
1832 char descriptor_digest
[DIGEST256_LEN
];
1833 uint32_t addr
; /**< IPv4 address for this router. */
1834 uint16_t or_port
; /**< OR port for this router. */
1835 uint16_t dir_port
; /**< Directory port for this router. */
1836 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1837 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1838 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1839 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1840 /** True iff this router is called 'running' in the consensus. We give it
1841 * this funny name so that we don't accidentally use this bit as a view of
1842 * whether we think the router is *currently* running. If that's what you
1843 * want to know, look at is_running in node_t. */
1844 unsigned int is_flagged_running
:1;
1845 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1846 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1848 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1849 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1850 * information with v2 of the directory
1851 * protocol. (All directory caches cache v1
1853 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1854 * choice as an entry guard. */
1855 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1857 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1858 * underpowered, or otherwise useless? */
1859 unsigned int is_hs_dir
:1; /**< True iff this router is a v2-or-later hidden
1860 * service directory. */
1861 /** True iff we know version info for this router. (i.e., a "v" entry was
1862 * included.) We'll replace all these with a big tor_version_t or a char[]
1863 * if the number of traits we care about ever becomes incredibly big. */
1864 unsigned int version_known
:1;
1865 /** True iff this router is a version that supports BEGIN_DIR cells. */
1866 unsigned int version_supports_begindir
:1;
1867 /** True iff this router is a version that supports conditional consensus
1868 * downloads (signed by list of authorities). */
1869 unsigned int version_supports_conditional_consensus
:1;
1870 /** True iff this router is a version that we can post extrainfo docs to. */
1871 unsigned int version_supports_extrainfo_upload
:1;
1872 /** True iff this router is a version that, if it caches directory info,
1873 * we can get v3 downloads from. */
1874 unsigned int version_supports_v3_dir
:1;
1875 /** True iff this router is a version that, if it caches directory info,
1876 * we can get microdescriptors from. */
1877 unsigned int version_supports_microdesc_cache
:1;
1878 /** True iff this router is a version that allows DATA cells to arrive on
1879 * a stream before it has sent a CONNECTED cell. */
1880 unsigned int version_supports_optimistic_data
:1;
1882 unsigned int has_bandwidth
:1; /**< The vote/consensus had bw info */
1883 unsigned int has_exitsummary
:1; /**< The vote/consensus had exit summaries */
1884 unsigned int has_measured_bw
:1; /**< The vote/consensus had a measured bw */
1886 uint32_t measured_bw
; /**< Measured bandwidth (capacity) of the router */
1888 uint32_t bandwidth
; /**< Bandwidth (capacity) of the router as reported in
1889 * the vote/consensus, in kilobytes/sec. */
1890 char *exitsummary
; /**< exit policy summary -
1891 * XXX weasel: this probably should not stay a string. */
1893 /* ---- The fields below aren't derived from the networkstatus; they
1894 * hold local information only. */
1896 /** True if we, as a directory mirror, want to download the corresponding
1897 * routerinfo from the authority who gave us this routerstatus. (That is,
1898 * if we don't have the routerinfo, and if we haven't already tried to get it
1899 * from this authority.) Applies in v2 networkstatus document only.
1901 unsigned int need_to_mirror
:1;
1902 time_t last_dir_503_at
; /**< When did this router last tell us that it
1903 * was too busy to serve directory info? */
1904 download_status_t dl_status
;
1908 /** A single entry in a parsed policy summary, describing a range of ports. */
1909 typedef struct short_policy_entry_t
{
1910 uint16_t min_port
, max_port
;
1911 } short_policy_entry_t
;
1913 /** A short_poliy_t is the parsed version of a policy summary. */
1914 typedef struct short_policy_t
{
1915 /** True if the members of 'entries' are port ranges to accept; false if
1916 * they are port ranges to reject */
1917 unsigned int is_accept
: 1;
1918 /** The actual number of values in 'entries'. */
1919 unsigned int n_entries
: 31;
1920 /** An array of 0 or more short_policy_entry_t values, each describing a
1921 * range of ports that this policy accepts or rejects (depending on the
1922 * value of is_accept).
1924 short_policy_entry_t entries
[FLEXIBLE_ARRAY_MEMBER
];
1927 /** A microdescriptor is the smallest amount of information needed to build a
1928 * circuit through a router. They are generated by the directory authorities,
1929 * using information from the uploaded routerinfo documents. They are not
1930 * self-signed, but are rather authenticated by having their hash in a signed
1931 * networkstatus document. */
1932 typedef struct microdesc_t
{
1933 /** Hashtable node, used to look up the microdesc by its digest. */
1934 HT_ENTRY(microdesc_t
) node
;
1936 /* Cache information */
1938 /** When was this microdescriptor last listed in a consensus document?
1939 * Once a microdesc has been unlisted long enough, we can drop it.
1942 /** Where is this microdescriptor currently stored? */
1943 saved_location_t saved_location
: 3;
1944 /** If true, do not attempt to cache this microdescriptor on disk. */
1945 unsigned int no_save
: 1;
1946 /** If true, this microdesc has an entry in the microdesc_map */
1947 unsigned int held_in_map
: 1;
1948 /** Reference count: how many node_ts have a reference to this microdesc? */
1949 unsigned int held_by_nodes
;
1951 /** If saved_location == SAVED_IN_CACHE, this field holds the offset of the
1952 * microdescriptor in the cache. */
1955 /* The string containing the microdesc. */
1957 /** A pointer to the encoded body of the microdescriptor. If the
1958 * saved_location is SAVED_IN_CACHE, then the body is a pointer into an
1959 * mmap'd region. Otherwise, it is a malloc'd string. The string might not
1960 * be NUL-terminated; take the length from <b>bodylen</b>. */
1962 /** The length of the microdescriptor in <b>body</b>. */
1964 /** A SHA256-digest of the microdescriptor. */
1965 char digest
[DIGEST256_LEN
];
1967 /* Fields in the microdescriptor. */
1969 /** As routerinfo_t.onion_pkey */
1970 crypto_pk_t
*onion_pkey
;
1971 /** As routerinfo_t.family */
1972 smartlist_t
*family
;
1973 /** Exit policy summary */
1974 short_policy_t
*exit_policy
;
1977 /** A node_t represents a Tor router.
1979 * Specifically, a node_t is a Tor router as we are using it: a router that
1980 * we are considering for circuits, connections, and so on. A node_t is a
1981 * thin wrapper around the routerstatus, routerinfo, and microdesc for a
1982 * single wrapper, and provides a consistent interface for all of them.
1984 * Also, a node_t has mutable state. While a routerinfo, a routerstatus,
1985 * and a microdesc have[*] only the information read from a router
1986 * descriptor, a consensus entry, and a microdescriptor (respectively)...
1987 * a node_t has flags based on *our own current opinion* of the node.
1989 * [*] Actually, there is some leftover information in each that is mutable.
1990 * We should try to excise that.
1992 typedef struct node_t
{
1993 /* Indexing information */
1995 /** Used to look up the node_t by its identity digest. */
1996 HT_ENTRY(node_t
) ht_ent
;
1997 /** Position of the node within the list of nodes */
2000 /** The identity digest of this node_t. No more than one node_t per
2001 * identity may exist at a time. */
2002 char identity
[DIGEST_LEN
];
2008 /* local info: copied from routerstatus, then possibly frobbed based
2009 * on experience. Authorities set this stuff directly. */
2011 unsigned int is_running
:1; /**< As far as we know, is this OR currently
2013 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
2014 * (For Authdir: Have we validated this OR?)
2016 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
2017 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
2018 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
2019 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
2020 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
2021 * or otherwise nasty? */
2022 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
2023 * underpowered, or otherwise useless? */
2024 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
2025 * directory according to the authorities. */
2027 /* Local info: warning state. */
2029 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
2030 * to this (unnamed) router by nickname?
2033 /** Local info: we treat this node as if it rejects everything */
2034 unsigned int rejects_all
:1;
2036 /* Local info: derived. */
2038 /** According to the geoip db what country is this router in? */
2042 /** How many times will we try to download a router's descriptor before giving
2044 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
2046 /** How many times will we try to download a microdescriptor before giving
2048 #define MAX_MICRODESC_DOWNLOAD_FAILURES 8
2050 /** Contents of a v2 (non-consensus, non-vote) network status object. */
2051 typedef struct networkstatus_v2_t
{
2052 /** When did we receive the network-status document? */
2055 /** What was the digest of the document? */
2056 char networkstatus_digest
[DIGEST_LEN
];
2058 /* These fields come from the actual network-status document.*/
2059 time_t published_on
; /**< Declared publication date. */
2061 char *source_address
; /**< Canonical directory server hostname. */
2062 uint32_t source_addr
; /**< Canonical directory server IP. */
2063 uint16_t source_dirport
; /**< Canonical directory server dirport. */
2065 unsigned int binds_names
:1; /**< True iff this directory server binds
2067 unsigned int recommends_versions
:1; /**< True iff this directory server
2068 * recommends client and server software
2070 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
2071 * malfunctioning exits as bad. */
2072 /** True iff this directory server marks malfunctioning directories as
2074 unsigned int lists_bad_directories
:1;
2076 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
2077 char *contact
; /**< How to contact directory admin? (may be NULL). */
2078 crypto_pk_t
*signing_key
; /**< Key used to sign this directory. */
2079 char *client_versions
; /**< comma-separated list of recommended client
2081 char *server_versions
; /**< comma-separated list of recommended server
2084 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
2085 * sorted by identity_digest. */
2086 } networkstatus_v2_t
;
2088 /** Linked list of microdesc hash lines for a single router in a directory
2091 typedef struct vote_microdesc_hash_t
{
2092 /** Next element in the list, or NULL. */
2093 struct vote_microdesc_hash_t
*next
;
2094 /** The raw contents of the microdesc hash line, excluding the "m". */
2095 char *microdesc_hash_line
;
2096 } vote_microdesc_hash_t
;
2098 /** The claim about a single router, made in a vote. */
2099 typedef struct vote_routerstatus_t
{
2100 routerstatus_t status
; /**< Underlying 'status' object for this router.
2101 * Flags are redundant. */
2102 uint64_t flags
; /**< Bit-field for all recognized flags; index into
2103 * networkstatus_t.known_flags. */
2104 char *version
; /**< The version that the authority says this router is
2106 /** The hash or hashes that the authority claims this microdesc has. */
2107 vote_microdesc_hash_t
*microdesc
;
2108 } vote_routerstatus_t
;
2110 /** A signature of some document by an authority. */
2111 typedef struct document_signature_t
{
2112 /** Declared SHA-1 digest of this voter's identity key */
2113 char identity_digest
[DIGEST_LEN
];
2114 /** Declared SHA-1 digest of signing key used by this voter. */
2115 char signing_key_digest
[DIGEST_LEN
];
2116 /** Algorithm used to compute the digest of the document. */
2117 digest_algorithm_t alg
;
2118 /** Signature of the signed thing. */
2120 /** Length of <b>signature</b> */
2122 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
2123 * the sig, and we know it's bad. */
2124 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
2126 } document_signature_t
;
2128 /** Information about a single voter in a vote or a consensus. */
2129 typedef struct networkstatus_voter_info_t
{
2130 /** Declared SHA-1 digest of this voter's identity key */
2131 char identity_digest
[DIGEST_LEN
];
2132 char *nickname
; /**< Nickname of this voter */
2133 /** Digest of this voter's "legacy" identity key, if any. In vote only; for
2134 * consensuses, we treat legacy keys as additional signers. */
2135 char legacy_id_digest
[DIGEST_LEN
];
2136 char *address
; /**< Address of this voter, in string format. */
2137 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
2138 uint16_t dir_port
; /**< Directory port of this voter */
2139 uint16_t or_port
; /**< OR port of this voter */
2140 char *contact
; /**< Contact information for this voter. */
2141 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
2143 /* Nothing from here on is signed. */
2144 /** The signature of the document and the signature's status. */
2146 } networkstatus_voter_info_t
;
2148 /** Enumerates the possible seriousness values of a networkstatus document. */
2153 } networkstatus_type_t
;
2155 /** Enumerates recognized flavors of a consensus networkstatus document. All
2156 * flavors of a consensus are generated from the same set of votes, but they
2157 * present different types information to different versions of Tor. */
2161 } consensus_flavor_t
;
2163 /** How many different consensus flavors are there? */
2164 #define N_CONSENSUS_FLAVORS ((int)(FLAV_MICRODESC)+1)
2166 /** A common structure to hold a v3 network status vote, or a v3 network
2167 * status consensus. */
2168 typedef struct networkstatus_t
{
2169 networkstatus_type_t type
: 8; /**< Vote, consensus, or opinion? */
2170 consensus_flavor_t flavor
: 8; /**< If a consensus, what kind? */
2171 time_t published
; /**< Vote only: Time when vote was written. */
2172 time_t valid_after
; /**< Time after which this vote or consensus applies. */
2173 time_t fresh_until
; /**< Time before which this is the most recent vote or
2175 time_t valid_until
; /**< Time after which this vote or consensus should not
2178 /** Consensus only: what method was used to produce this consensus? */
2179 int consensus_method
;
2180 /** Vote only: what methods is this voter willing to use? */
2181 smartlist_t
*supported_methods
;
2183 /** How long does this vote/consensus claim that authorities take to
2184 * distribute their votes to one another? */
2186 /** How long does this vote/consensus claim that authorities take to
2187 * distribute their consensus signatures to one another? */
2190 /** Comma-separated list of recommended client software, or NULL if this
2191 * voter has no opinion. */
2192 char *client_versions
;
2193 char *server_versions
;
2194 /** List of flags that this vote/consensus applies to routers. If a flag is
2195 * not listed here, the voter has no opinion on what its value should be. */
2196 smartlist_t
*known_flags
;
2198 /** List of key=value strings for the parameters in this vote or
2199 * consensus, sorted by key. */
2200 smartlist_t
*net_params
;
2202 /** List of key=value strings for the bw weight parameters in the
2204 smartlist_t
*weight_params
;
2206 /** List of networkstatus_voter_info_t. For a vote, only one element
2207 * is included. For a consensus, one element is included for every voter
2208 * whose vote contributed to the consensus. */
2209 smartlist_t
*voters
;
2211 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
2213 /** Digests of this document, as signed. */
2216 /** List of router statuses, sorted by identity digest. For a vote,
2217 * the elements are vote_routerstatus_t; for a consensus, the elements
2218 * are routerstatus_t. */
2219 smartlist_t
*routerstatus_list
;
2221 /** If present, a map from descriptor digest to elements of
2222 * routerstatus_list. */
2223 digestmap_t
*desc_digest_map
;
2226 /** A set of signatures for a networkstatus consensus. Unless otherwise
2227 * noted, all fields are as for networkstatus_t. */
2228 typedef struct ns_detached_signatures_t
{
2232 strmap_t
*digests
; /**< Map from flavor name to digestset_t */
2233 strmap_t
*signatures
; /**< Map from flavor name to list of
2234 * document_signature_t */
2235 } ns_detached_signatures_t
;
2237 /** Allowable types of desc_store_t. */
2238 typedef enum store_type_t
{
2243 /** A 'store' is a set of descriptors saved on disk, with accompanying
2244 * journal, mmaped as needed, rebuilt as needed. */
2245 typedef struct desc_store_t
{
2246 /** Filename (within DataDir) for the store. We append .tmp to this
2247 * filename for a temporary file when rebuilding the store, and .new to this
2248 * filename for the journal. */
2249 const char *fname_base
;
2250 /** Alternative (obsolete) value for fname_base: if the file named by
2251 * fname_base isn't present, we read from here instead, but we never write
2253 const char *fname_alt_base
;
2254 /** Human-readable description of what this store contains. */
2255 const char *description
;
2257 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
2259 store_type_t type
; /**< What's stored in this store? */
2261 /** The size of the router log, in bytes. */
2263 /** The size of the router store, in bytes. */
2265 /** Total bytes dropped since last rebuild: this is space currently
2266 * used in the cache and the journal that could be freed by a rebuild. */
2267 size_t bytes_dropped
;
2270 /** Contents of a directory of onion routers. */
2272 /** Map from server identity digest to a member of routers. */
2273 struct digest_ri_map_t
*identity_map
;
2274 /** Map from server descriptor digest to a signed_descriptor_t from
2275 * routers or old_routers. */
2276 struct digest_sd_map_t
*desc_digest_map
;
2277 /** Map from extra-info digest to an extrainfo_t. Only exists for
2278 * routers in routers or old_routers. */
2279 struct digest_ei_map_t
*extra_info_map
;
2280 /** Map from extra-info digests to a signed_descriptor_t for a router
2281 * descriptor having that extra-info digest. Only exists for
2282 * routers in routers or old_routers. */
2283 struct digest_sd_map_t
*desc_by_eid_map
;
2284 /** List of routerinfo_t for all currently live routers we know. */
2285 smartlist_t
*routers
;
2286 /** List of signed_descriptor_t for older router descriptors we're
2288 smartlist_t
*old_routers
;
2289 /** Store holding server descriptors. If present, any router whose
2290 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
2291 * starting at cache_info.saved_offset */
2292 desc_store_t desc_store
;
2293 /** Store holding extra-info documents. */
2294 desc_store_t extrainfo_store
;
2297 /** Information on router used when extending a circuit. We don't need a
2298 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
2299 * connection, and onion_key to create the onionskin. Note that for onehop
2300 * general-purpose tunnels, the onion_key is NULL. */
2301 typedef struct extend_info_t
{
2302 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
2304 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
2305 uint16_t port
; /**< OR port. */
2306 tor_addr_t addr
; /**< IP address. */
2307 crypto_pk_t
*onion_key
; /**< Current onionskin key. */
2310 /** Certificate for v3 directory protocol: binds long-term authority identity
2311 * keys to medium-term authority signing keys. */
2312 typedef struct authority_cert_t
{
2313 /** Information relating to caching this cert on disk and looking it up. */
2314 signed_descriptor_t cache_info
;
2315 /** This authority's long-term authority identity key. */
2316 crypto_pk_t
*identity_key
;
2317 /** This authority's medium-term signing key. */
2318 crypto_pk_t
*signing_key
;
2319 /** The digest of <b>signing_key</b> */
2320 char signing_key_digest
[DIGEST_LEN
];
2321 /** The listed expiration time of this certificate. */
2323 /** This authority's IPv4 address, in host order. */
2325 /** This authority's directory port. */
2327 /** True iff this certificate was cross-certified by signing the identity
2328 * key with the signing key. */
2329 uint8_t is_cross_certified
;
2332 /** Bitfield enum type listing types of information that directory authorities
2333 * can be authoritative about, and that directory caches may or may not cache.
2335 * Note that the granularity here is based on authority granularity and on
2336 * cache capabilities. Thus, one particular bit may correspond in practice to
2337 * a few types of directory info, so long as every authority that pronounces
2338 * officially about one of the types prounounces officially about all of them,
2339 * and so long as every cache that caches one of them caches all of them.
2343 /** Serves/signs v1 directory information: Big lists of routers, and short
2344 * routerstatus documents. */
2345 V1_DIRINFO
= 1 << 0,
2346 /** Serves/signs v2 directory information: i.e. v2 networkstatus documents */
2347 V2_DIRINFO
= 1 << 1,
2348 /** Serves/signs v3 directory information: votes, consensuses, certs */
2349 V3_DIRINFO
= 1 << 2,
2350 /** Serves hidden service descriptors. */
2351 HIDSERV_DIRINFO
= 1 << 3,
2352 /** Serves bridge descriptors. */
2353 BRIDGE_DIRINFO
= 1 << 4,
2354 /** Serves extrainfo documents. */
2355 EXTRAINFO_DIRINFO
=1 << 5,
2356 /** Serves microdescriptors. */
2357 MICRODESC_DIRINFO
=1 << 6,
2360 #define CRYPT_PATH_MAGIC 0x70127012u
2362 /** Holds accounting information for a single step in the layered encryption
2363 * performed by a circuit. Used only at the client edge of a circuit. */
2364 typedef struct crypt_path_t
{
2367 /* crypto environments */
2368 /** Encryption key and counter for cells heading towards the OR at this
2370 crypto_cipher_t
*f_crypto
;
2371 /** Encryption key and counter for cells heading back from the OR at this
2373 crypto_cipher_t
*b_crypto
;
2375 /** Digest state for cells heading towards the OR at this step. */
2376 crypto_digest_t
*f_digest
; /* for integrity checking */
2377 /** Digest state for cells heading away from the OR at this step. */
2378 crypto_digest_t
*b_digest
;
2380 /** Current state of Diffie-Hellman key negotiation with the OR at this
2382 crypto_dh_t
*dh_handshake_state
;
2383 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
2384 * step. Used to save CPU when TLS is already providing all the
2385 * authentication, secrecy, and integrity we need, and we're already
2386 * distinguishable from an OR.
2388 uint8_t fast_handshake_state
[DIGEST_LEN
];
2389 /** Negotiated key material shared with the OR at this step. */
2390 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
2392 /** Information to extend to the OR at this step. */
2393 extend_info_t
*extend_info
;
2395 /** Is the circuit built to this step? Must be one of:
2396 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
2397 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
2398 * and not received an EXTENDED/CREATED)
2399 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
2401 #define CPATH_STATE_CLOSED 0
2402 #define CPATH_STATE_AWAITING_KEYS 1
2403 #define CPATH_STATE_OPEN 2
2404 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
2405 * (The list is circular, so the last node
2406 * links to the first.) */
2407 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
2410 int package_window
; /**< How many cells are we allowed to originate ending
2412 int deliver_window
; /**< How many cells are we willing to deliver originating
2416 /** A reference-counted pointer to a crypt_path_t, used only to share
2417 * the final rendezvous cpath to be used on a service-side rendezvous
2418 * circuit among multiple circuits built in parallel to the same
2419 * destination rendezvous point. */
2421 /** The reference count. */
2422 unsigned int refcount
;
2423 /** The pointer. Set to NULL when the crypt_path_t is put into use
2424 * on an opened rendezvous circuit. */
2425 crypt_path_t
*cpath
;
2426 } crypt_path_reference_t
;
2428 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
2430 #define DH_KEY_LEN DH_BYTES
2431 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
2434 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
2436 /** Information used to build a circuit. */
2438 /** Intended length of the final circuit. */
2439 int desired_path_len
;
2440 /** How to extend to the planned exit node. */
2441 extend_info_t
*chosen_exit
;
2442 /** Whether every node in the circ must have adequate uptime. */
2443 unsigned int need_uptime
: 1;
2444 /** Whether every node in the circ must have adequate capacity. */
2445 unsigned int need_capacity
: 1;
2446 /** Whether the last hop was picked with exiting in mind. */
2447 unsigned int is_internal
: 1;
2448 /** Did we pick this as a one-hop tunnel (not safe for other streams)?
2449 * These are for encrypted dir conns that exit to this router, not
2450 * for arbitrary exits from the circuit. */
2451 unsigned int onehop_tunnel
: 1;
2452 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
2453 crypt_path_t
*pending_final_cpath
;
2454 /** A ref-counted reference to the crypt_path_t to append after
2455 * rendezvous; used on the service side. */
2456 crypt_path_reference_t
*service_pending_final_cpath_ref
;
2457 /** How many times has building a circuit for this task failed? */
2459 /** At what time should we give up on this task? */
2461 } cpath_build_state_t
;
2464 * The cell_ewma_t structure keeps track of how many cells a circuit has
2465 * transferred recently. It keeps an EWMA (exponentially weighted moving
2466 * average) of the number of cells flushed from the circuit queue onto a
2467 * connection in connection_or_flush_from_first_active_circuit().
2470 /** The last 'tick' at which we recalibrated cell_count.
2472 * A cell sent at exactly the start of this tick has weight 1.0. Cells sent
2473 * since the start of this tick have weight greater than 1.0; ones sent
2474 * earlier have less weight. */
2475 unsigned last_adjusted_tick
;
2476 /** The EWMA of the cell count. */
2478 /** True iff this is the cell count for a circuit's previous
2480 unsigned int is_for_p_conn
: 1;
2481 /** The position of the circuit within the OR connection's priority
2486 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
2487 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
2490 * A circuit is a path over the onion routing
2491 * network. Applications can connect to one end of the circuit, and can
2492 * create exit connections at the other end of the circuit. AP and exit
2493 * connections have only one circuit associated with them (and thus these
2494 * connection types are closed when the circuit is closed), whereas
2495 * OR connections multiplex many circuits at once, and stay standing even
2496 * when there are no circuits running over them.
2498 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
2499 * links two connections together: either an edge connection and an OR
2500 * connection, or two OR connections. (When joined to an OR connection, a
2501 * circuit_t affects only cells sent to a particular circID on that
2502 * connection. When joined to an edge connection, a circuit_t affects all
2505 * Second, an origin_circuit_t holds the cipher keys and state for sending data
2506 * along a given circuit. At the OP, it has a sequence of ciphers, each
2507 * of which is shared with a single OR along the circuit. Separate
2508 * ciphers are used for data going "forward" (away from the OP) and
2509 * "backward" (towards the OP). At the OR, a circuit has only two stream
2510 * ciphers: one for data going forward, and one for data going backward.
2512 typedef struct circuit_t
{
2513 uint32_t magic
; /**< For memory and type debugging: must equal
2514 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
2516 /** Queue of cells waiting to be transmitted on n_conn. */
2517 cell_queue_t n_conn_cells
;
2518 /** The OR connection that is next in this circuit. */
2519 or_connection_t
*n_conn
;
2520 /** The circuit_id used in the next (forward) hop of this circuit. */
2523 /** The hop to which we want to extend this circuit. Should be NULL if
2524 * the circuit has attached to a connection. */
2525 extend_info_t
*n_hop
;
2527 /** True iff we are waiting for n_conn_cells to become less full before
2528 * allowing p_streams to add any more cells. (Origin circuit only.) */
2529 unsigned int streams_blocked_on_n_conn
: 1;
2530 /** True iff we are waiting for p_conn_cells to become less full before
2531 * allowing n_streams to add any more cells. (OR circuit only.) */
2532 unsigned int streams_blocked_on_p_conn
: 1;
2534 uint8_t state
; /**< Current status of this circuit. */
2535 uint8_t purpose
; /**< Why are we creating this circuit? */
2537 /** How many relay data cells can we package (read from edge streams)
2538 * on this circuit before we receive a circuit-level sendme cell asking
2541 /** How many relay data cells will we deliver (write to edge streams)
2542 * on this circuit? When deliver_window gets low, we send some
2543 * circuit-level sendme cells to indicate that we're willing to accept
2547 /** For storage while n_conn is pending
2548 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
2549 * length ONIONSKIN_CHALLENGE_LEN. */
2550 char *n_conn_onionskin
;
2552 /** When was this circuit created? We keep this timestamp with a higher
2553 * resolution than most so that the circuit-build-time tracking code can
2554 * get millisecond resolution. */
2555 struct timeval timestamp_created
;
2556 /** When the circuit was first used, or 0 if the circuit is clean.
2558 * XXXX023 Note that some code will artifically adjust this value backward
2559 * in time in order to indicate that a circuit shouldn't be used for new
2560 * streams, but that it can stay alive as long as it has streams on it.
2561 * That's a kludge we should fix.
2563 * XXX023 The CBT code uses this field to record when HS-related
2564 * circuits entered certain states. This usage probably won't
2565 * interfere with this field's primary purpose, but we should
2566 * document it more thoroughly to make sure of that.
2568 time_t timestamp_dirty
;
2570 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
2571 * the main loop? (If true, holds the line number
2572 * where this circuit was marked.) */
2573 const char *marked_for_close_file
; /**< For debugging: in which file was this
2574 * circuit marked for close? */
2576 /** Next circuit in the doubly-linked ring of circuits waiting to add
2577 * cells to n_conn. NULL if we have no cells pending, or if we're not
2578 * linked to an OR connection. */
2579 struct circuit_t
*next_active_on_n_conn
;
2580 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2581 * cells to n_conn. NULL if we have no cells pending, or if we're not
2582 * linked to an OR connection. */
2583 struct circuit_t
*prev_active_on_n_conn
;
2584 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
2586 /** Unique ID for measuring tunneled network status requests. */
2589 /** The EWMA count for the number of cells flushed from the
2590 * n_conn_cells queue. Used to determine which circuit to flush from next.
2592 cell_ewma_t n_cell_ewma
;
2595 /** Largest number of relay_early cells that we can send on a given
2597 #define MAX_RELAY_EARLY_CELLS_PER_CIRCUIT 8
2600 * Describes the circuit building process in simplified terms based
2601 * on the path bias accounting state for a circuit. Created to prevent
2602 * overcounting due to unknown cases of circuit reuse. See Bug #6475.
2605 /** This circuit is "new". It has not yet completed a first hop
2606 * or been counted by the path bias code. */
2607 PATH_STATE_NEW_CIRC
= 0,
2608 /** This circuit has completed a first hop, and has been counted by
2609 * the path bias logic. */
2610 PATH_STATE_DID_FIRST_HOP
= 1,
2611 /** This circuit has been completely built, and has been counted as
2612 * successful by the path bias logic. */
2613 PATH_STATE_SUCCEEDED
= 2,
2616 /** An origin_circuit_t holds data necessary to build and use a circuit.
2618 typedef struct origin_circuit_t
{
2621 /** Linked list of AP streams (or EXIT streams if hidden service)
2622 * associated with this circuit. */
2623 edge_connection_t
*p_streams
;
2624 /** Build state for this circuit. It includes the intended path
2625 * length, the chosen exit router, rendezvous information, etc.
2627 cpath_build_state_t
*build_state
;
2628 /** The doubly-linked list of crypt_path_t entries, one per hop,
2629 * for this circuit. This includes ciphers for each hop,
2630 * integrity-checking digests for each hop, and package/delivery
2631 * windows for each hop.
2633 crypt_path_t
*cpath
;
2635 /** Holds all rendezvous data on either client or service side. */
2636 rend_data_t
*rend_data
;
2638 /** How many more relay_early cells can we send on this circuit, according
2639 * to the specification? */
2640 unsigned int remaining_relay_early_cells
: 4;
2642 /** Set if this circuit is insanely old and we already informed the user */
2643 unsigned int is_ancient
: 1;
2645 /** Set if this circuit has already been opened. Used to detect
2646 * cannibalized circuits. */
2647 unsigned int has_opened
: 1;
2649 /** Kludge to help us prevent the warn in bug #6475 and eventually
2650 * debug why we are not seeing first hops in some cases. */
2651 path_state_t path_state
: 2;
2653 /** Set iff this is a hidden-service circuit which has timed out
2654 * according to our current circuit-build timeout, but which has
2655 * been kept around because it might still succeed in connecting to
2656 * its destination, and which is not a fully-connected rendezvous
2659 * (We clear this flag for client-side rendezvous circuits when they
2660 * are 'joined' to the other side's rendezvous circuit, so that
2661 * connection_ap_handshake_attach_circuit can put client streams on
2662 * the circuit. We also clear this flag for service-side rendezvous
2663 * circuits when they are 'joined' to a client's rend circ, but only
2664 * for symmetry with the client case. Client-side introduction
2665 * circuits are closed when we get a joined rend circ, and
2666 * service-side introduction circuits never have this flag set.) */
2667 unsigned int hs_circ_has_timed_out
: 1;
2669 /** Set iff this is a service-side rendezvous circuit for which a
2670 * new connection attempt has been launched. We consider launching
2671 * a new service-side rend circ to a client when the previous one
2672 * fails; now that we don't necessarily close a service-side rend
2673 * circ when we launch a new one to the same client, this flag keeps
2674 * us from launching two retries for the same failed rend circ. */
2675 unsigned int hs_service_side_rend_circ_has_been_relaunched
: 1;
2677 /** What commands were sent over this circuit that decremented the
2678 * RELAY_EARLY counter? This is for debugging task 878. */
2679 uint8_t relay_early_commands
[MAX_RELAY_EARLY_CELLS_PER_CIRCUIT
];
2681 /** How many RELAY_EARLY cells have been sent over this circuit? This is
2682 * for debugging task 878, too. */
2683 int relay_early_cells_sent
;
2685 /** The next stream_id that will be tried when we're attempting to
2686 * construct a new AP stream originating at this circuit. */
2687 streamid_t next_stream_id
;
2689 /* The intro key replaces the hidden service's public key if purpose is
2690 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
2691 * descriptor is used. */
2692 crypto_pk_t
*intro_key
;
2694 /** Quasi-global identifier for this circuit; used for control.c */
2695 /* XXXX NM This can get re-used after 2**32 circuits. */
2696 uint32_t global_identifier
;
2698 /** True if we have associated one stream to this circuit, thereby setting
2699 * the isolation paramaters for this circuit. Note that this doesn't
2700 * necessarily mean that we've <em>attached</em> any streams to the circuit:
2701 * we may only have marked up this circuit during the launch process.
2703 unsigned int isolation_values_set
: 1;
2704 /** True iff any stream has <em>ever</em> been attached to this circuit.
2706 * In a better world we could use timestamp_dirty for this, but
2707 * timestamp_dirty is far too overloaded at the moment.
2709 unsigned int isolation_any_streams_attached
: 1;
2711 /** A bitfield of ISO_* flags for every isolation field such that this
2712 * circuit has had streams with more than one value for that field
2713 * attached to it. */
2714 uint8_t isolation_flags_mixed
;
2716 /** @name Isolation parameters
2718 * If any streams have been associated with this circ (isolation_values_set
2719 * == 1), and all streams associated with the circuit have had the same
2720 * value for some field ((isolation_flags_mixed & ISO_FOO) == 0), then these
2721 * elements hold the value for that field.
2723 * Note again that "associated" is not the same as "attached": we
2724 * preliminarily associate streams with a circuit while the circuit is being
2725 * launched, so that we can tell whether we need to launch more circuits.
2729 uint8_t client_proto_type
;
2730 uint8_t client_proto_socksver
;
2732 tor_addr_t client_addr
;
2736 size_t socks_username_len
;
2737 uint8_t socks_password_len
;
2738 /* Note that the next two values are NOT NUL-terminated; see
2739 socks_username_len and socks_password_len for their lengths. */
2740 char *socks_username
;
2741 char *socks_password
;
2742 /** Global identifier for the first stream attached here; used by
2744 uint64_t associated_isolated_stream_global_id
;
2749 /** An or_circuit_t holds information needed to implement a circuit at an
2751 typedef struct or_circuit_t
{
2754 /** Next circuit in the doubly-linked ring of circuits waiting to add
2755 * cells to p_conn. NULL if we have no cells pending, or if we're not
2756 * linked to an OR connection. */
2757 struct circuit_t
*next_active_on_p_conn
;
2758 /** Previous circuit in the doubly-linked ring of circuits waiting to add
2759 * cells to p_conn. NULL if we have no cells pending, or if we're not
2760 * linked to an OR connection. */
2761 struct circuit_t
*prev_active_on_p_conn
;
2763 /** The circuit_id used in the previous (backward) hop of this circuit. */
2765 /** Queue of cells waiting to be transmitted on p_conn. */
2766 cell_queue_t p_conn_cells
;
2767 /** The OR connection that is previous in this circuit. */
2768 or_connection_t
*p_conn
;
2769 /** Linked list of Exit streams associated with this circuit. */
2770 edge_connection_t
*n_streams
;
2771 /** Linked list of Exit streams associated with this circuit that are
2772 * still being resolved. */
2773 edge_connection_t
*resolving_streams
;
2774 /** The cipher used by intermediate hops for cells heading toward the
2776 crypto_cipher_t
*p_crypto
;
2777 /** The cipher used by intermediate hops for cells heading away from
2779 crypto_cipher_t
*n_crypto
;
2781 /** The integrity-checking digest used by intermediate hops, for
2782 * cells packaged here and heading towards the OP.
2784 crypto_digest_t
*p_digest
;
2785 /** The integrity-checking digest used by intermediate hops, for
2786 * cells packaged at the OP and arriving here.
2788 crypto_digest_t
*n_digest
;
2790 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
2791 * is not marked for close. */
2792 struct or_circuit_t
*rend_splice
;
2794 #if REND_COOKIE_LEN >= DIGEST_LEN
2795 #define REND_TOKEN_LEN REND_COOKIE_LEN
2797 #define REND_TOKEN_LEN DIGEST_LEN
2800 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
2801 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
2803 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
2805 char rend_token
[REND_TOKEN_LEN
];
2807 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
2808 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
2810 /** How many more relay_early cells can we send on this circuit, according
2811 * to the specification? */
2812 unsigned int remaining_relay_early_cells
: 4;
2814 /** True iff this circuit was made with a CREATE_FAST cell. */
2815 unsigned int is_first_hop
: 1;
2817 /** Number of cells that were removed from circuit queue; reset every
2818 * time when writing buffer stats to disk. */
2819 uint32_t processed_cells
;
2821 /** Total time in milliseconds that cells spent in both app-ward and
2822 * exit-ward queues of this circuit; reset every time when writing
2823 * buffer stats to disk. */
2824 uint64_t total_cell_waiting_time
;
2826 /** The EWMA count for the number of cells flushed from the
2827 * p_conn_cells queue. */
2828 cell_ewma_t p_cell_ewma
;
2831 /** Convert a circuit subtype to a circuit_t. */
2832 #define TO_CIRCUIT(x) (&((x)->_base))
2834 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Assert
2835 * if the cast is impossible. */
2836 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
2837 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
2838 * Assert if the cast is impossible. */
2839 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
2841 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
2843 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
2844 return DOWNCAST(or_circuit_t
, x
);
2846 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
2848 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
2849 return DOWNCAST(origin_circuit_t
, x
);
2852 /** Bitfield type: things that we're willing to use invalid routers for. */
2853 typedef enum invalid_router_usage_t
{
2854 ALLOW_INVALID_ENTRY
=1,
2855 ALLOW_INVALID_EXIT
=2,
2856 ALLOW_INVALID_MIDDLE
=4,
2857 ALLOW_INVALID_RENDEZVOUS
=8,
2858 ALLOW_INVALID_INTRODUCTION
=16,
2859 } invalid_router_usage_t
;
2861 /* limits for TCP send and recv buffer size used for constrained sockets */
2862 #define MIN_CONSTRAINED_TCP_BUFFER 2048
2863 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
2865 /** @name Isolation flags
2867 Ways to isolate client streams
2871 /** Isolate based on destination port */
2872 #define ISO_DESTPORT (1u<<0)
2873 /** Isolate based on destination address */
2874 #define ISO_DESTADDR (1u<<1)
2875 /** Isolate based on SOCKS authentication */
2876 #define ISO_SOCKSAUTH (1u<<2)
2877 /** Isolate based on client protocol choice */
2878 #define ISO_CLIENTPROTO (1u<<3)
2879 /** Isolate based on client address */
2880 #define ISO_CLIENTADDR (1u<<4)
2881 /** Isolate based on session group (always on). */
2882 #define ISO_SESSIONGRP (1u<<5)
2883 /** Isolate based on newnym epoch (always on). */
2884 #define ISO_NYM_EPOCH (1u<<6)
2885 /** Isolate all streams (Internal only). */
2886 #define ISO_STREAM (1u<<7)
2889 /** Default isolation level for ports. */
2890 #define ISO_DEFAULT (ISO_CLIENTADDR|ISO_SOCKSAUTH|ISO_SESSIONGRP|ISO_NYM_EPOCH)
2892 /** Indicates that we haven't yet set a session group on a port_cfg_t. */
2893 #define SESSION_GROUP_UNSET -1
2894 /** Session group reserved for directory connections */
2895 #define SESSION_GROUP_DIRCONN -2
2896 /** Session group reserved for resolve requests launched by a controller */
2897 #define SESSION_GROUP_CONTROL_RESOLVE -3
2898 /** First automatically allocated session group number */
2899 #define SESSION_GROUP_FIRST_AUTO -4
2901 /** Configuration for a single port that we're listening on. */
2902 typedef struct port_cfg_t
{
2903 tor_addr_t addr
; /**< The actual IP to listen on, if !is_unix_addr. */
2904 int port
; /**< The configured port, or CFG_AUTO_PORT to tell Tor to pick its
2906 uint8_t type
; /**< One of CONN_TYPE_*_LISTENER */
2907 unsigned is_unix_addr
: 1; /**< True iff this is an AF_UNIX address. */
2909 /* Client port types (socks, dns, trans, natd) only: */
2910 uint8_t isolation_flags
; /**< Zero or more isolation flags */
2911 int session_group
; /**< A session group, or -1 if this port is not in a
2914 /* Server port types (or, dir) only: */
2915 unsigned int no_advertise
: 1;
2916 unsigned int no_listen
: 1;
2917 unsigned int all_addrs
: 1;
2918 unsigned int ipv4_only
: 1;
2919 unsigned int ipv6_only
: 1;
2921 /* Unix sockets only: */
2922 /** Path for an AF_UNIX address */
2923 char unix_addr
[FLEXIBLE_ARRAY_MEMBER
];
2926 /** Ordinary configuration line. */
2927 #define CONFIG_LINE_NORMAL 0
2928 /** Appends to previous configuration for the same option, even if we
2929 * would ordinary replace it. */
2930 #define CONFIG_LINE_APPEND 1
2931 /* Removes all previous configuration for an option. */
2932 #define CONFIG_LINE_CLEAR 2
2934 /** A linked list of lines in a config file. */
2935 typedef struct config_line_t
{
2938 struct config_line_t
*next
;
2939 /** What special treatment (if any) does this line require? */
2940 unsigned int command
:2;
2941 /** If true, subsequent assignments to this linelist should replace
2942 * it, not extend it. Set only on the first item in a linelist in an
2944 unsigned int fragile
:1;
2947 typedef struct routerset_t routerset_t
;
2949 /** A magic value for the (Socks|OR|...)Port options below, telling Tor
2950 * to pick its own port. */
2951 #define CFG_AUTO_PORT 0xc4005e
2953 /** Configuration options for a Tor process. */
2957 /** What should the tor process actually do? */
2959 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2960 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2962 const char *command_arg
; /**< Argument for command-line option. */
2964 config_line_t
*Logs
; /**< New-style list of configuration lines
2966 int LogTimeGranularity
; /**< Log resolution in milliseconds. */
2968 int LogMessageDomains
; /**< Boolean: Should we log the domain(s) in which
2969 * each log message occurs? */
2971 char *DebugLogFile
; /**< Where to send verbose log messages. */
2972 char *DataDirectory
; /**< OR only: where to store long-term data. */
2973 char *Nickname
; /**< OR only: nickname of this onion router. */
2974 char *Address
; /**< OR only: configured address for this onion router. */
2975 char *PidFile
; /**< Where to store PID of Tor process. */
2977 int DynamicDHGroups
; /**< Dynamic generation of prime moduli for use in DH.*/
2979 routerset_t
*ExitNodes
; /**< Structure containing nicknames, digests,
2980 * country codes and IP address patterns of ORs to
2981 * consider as exits. */
2982 routerset_t
*EntryNodes
;/**< Structure containing nicknames, digests,
2983 * country codes and IP address patterns of ORs to
2984 * consider as entry points. */
2985 int StrictNodes
; /**< Boolean: When none of our EntryNodes or ExitNodes
2986 * are up, or we need to access a node in ExcludeNodes,
2987 * do we just fail instead? */
2988 routerset_t
*ExcludeNodes
;/**< Structure containing nicknames, digests,
2989 * country codes and IP address patterns of ORs
2990 * not to use in circuits. But see StrictNodes
2992 routerset_t
*ExcludeExitNodes
;/**< Structure containing nicknames, digests,
2993 * country codes and IP address patterns of
2994 * ORs not to consider as exits. */
2996 /** Union of ExcludeNodes and ExcludeExitNodes */
2997 routerset_t
*_ExcludeExitNodesUnion
;
2999 int DisableAllSwap
; /**< Boolean: Attempt to call mlockall() on our
3000 * process for all current and future memory. */
3002 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
3003 smartlist_t
*AllowInvalidNodes
;
3004 /** Bitmask; derived from AllowInvalidNodes. */
3005 invalid_router_usage_t _AllowInvalid
;
3006 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
3007 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
3008 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
3009 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
3010 /** Addresses to bind for listening for SOCKS connections. */
3011 config_line_t
*SocksListenAddress
;
3012 /** Addresses to bind for listening for transparent pf/netfilter
3014 config_line_t
*TransListenAddress
;
3015 /** Addresses to bind for listening for transparent natd connections */
3016 config_line_t
*NATDListenAddress
;
3017 /** Addresses to bind for listening for SOCKS connections. */
3018 config_line_t
*DNSListenAddress
;
3019 /** Addresses to bind for listening for OR connections. */
3020 config_line_t
*ORListenAddress
;
3021 /** Addresses to bind for listening for directory connections. */
3022 config_line_t
*DirListenAddress
;
3023 /** Addresses to bind for listening for control connections. */
3024 config_line_t
*ControlListenAddress
;
3025 /** Local address to bind outbound sockets */
3026 char *OutboundBindAddress
;
3027 /** Directory server only: which versions of
3028 * Tor should we tell users to run? */
3029 config_line_t
*RecommendedVersions
;
3030 config_line_t
*RecommendedClientVersions
;
3031 config_line_t
*RecommendedServerVersions
;
3032 /** Whether dirservers allow router descriptors with private IPs. */
3033 int DirAllowPrivateAddresses
;
3034 /** Whether routers accept EXTEND cells to routers with private IPs. */
3035 int ExtendAllowPrivateAddresses
;
3036 char *User
; /**< Name of user to run Tor as. */
3037 char *Group
; /**< Name of group to run Tor as. */
3038 config_line_t
*ORPort_lines
; /**< Ports to listen on for OR connections. */
3039 /** Ports to listen on for SOCKS connections. */
3040 config_line_t
*SocksPort_lines
;
3041 /** Ports to listen on for transparent pf/netfilter connections. */
3042 config_line_t
*TransPort_lines
;
3043 config_line_t
*NATDPort_lines
; /**< Ports to listen on for transparent natd
3045 config_line_t
*ControlPort_lines
; /**< Ports to listen on for control
3047 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
3048 * for control connections. */
3050 int ControlSocketsGroupWritable
; /**< Boolean: Are control sockets g+rw? */
3051 /** Ports to listen on for directory connections. */
3052 config_line_t
*DirPort_lines
;
3053 config_line_t
*DNSPort_lines
; /**< Ports to listen on for DNS requests. */
3055 /** @name port booleans
3057 * Derived booleans: True iff there is a non-listener port on an AF_INET or
3058 * AF_INET6 address of the given type configured in one of the _lines
3063 unsigned int ORPort_set
: 1;
3064 unsigned int SocksPort_set
: 1;
3065 unsigned int TransPort_set
: 1;
3066 unsigned int NATDPort_set
: 1;
3067 unsigned int ControlPort_set
: 1;
3068 unsigned int DirPort_set
: 1;
3069 unsigned int DNSPort_set
: 1;
3072 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
3073 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
3074 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
3075 * for version 1 directories? */
3076 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
3077 * for version 2 directories? */
3078 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
3079 * for version 3 directories? */
3080 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
3081 * handle hidden service requests? */
3082 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
3083 * that's willing to bind names? */
3084 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
3085 * directory that's willing to recommend
3087 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
3088 * that aggregates bridge descriptors? */
3090 /** If set on a bridge authority, it will answer requests on its dirport
3091 * for bridge statuses -- but only if the requests use this password. */
3092 char *BridgePassword
;
3093 /** If BridgePassword is set, this is a SHA256 digest of the basic http
3094 * authenticator for it. Used so we can do a time-independent comparison. */
3095 char *_BridgePassword_AuthDigest
;
3097 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
3098 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
3100 config_line_t
*ClientTransportPlugin
; /**< List of client
3101 transport plugins. */
3103 config_line_t
*ServerTransportPlugin
; /**< List of client
3104 transport plugins. */
3106 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
3107 * this explicit so we can change how we behave in the
3110 /** Boolean: if we know the bridge's digest, should we get new
3111 * descriptors from the bridge authorities or from the bridge itself? */
3112 int UpdateBridgesFromAuthority
;
3114 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
3116 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
3117 /** To what authority types do we publish our descriptor? Choices are
3118 * "v1", "v2", "v3", "bridge", or "". */
3119 smartlist_t
*PublishServerDescriptor
;
3120 /** A bitfield of authority types, derived from PublishServerDescriptor. */
3121 dirinfo_type_t _PublishServerDescriptor
;
3122 /** Boolean: do we publish hidden service descriptors to the HS auths? */
3123 int PublishHidServDescriptors
;
3124 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
3125 int FetchHidServDescriptors
; /**< and hidden service descriptors? */
3126 int FetchV2Networkstatus
; /**< Do we fetch v2 networkstatus documents when
3127 * we don't need to? */
3128 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
3130 int VoteOnHidServDirectoriesV2
; /**< As a directory authority, vote on
3131 * assignment of the HSDir flag? */
3132 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
3133 * service directories after what time? */
3135 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
3136 int AllDirActionsPrivate
; /**< Should every directory action be sent
3137 * through a Tor circuit? */
3139 /** Run in 'tor2web mode'? (I.e. only make client connections to hidden
3140 * services, and use a single hop for all hidden-service-related
3144 /** Close hidden service client circuits immediately when they reach
3145 * the normal circuit-build timeout, even if they have already sent
3146 * an INTRODUCE1 cell on its way to the service. */
3147 int CloseHSClientCircuitsImmediatelyOnTimeout
;
3149 /** Close hidden-service-side rendezvous circuits immediately when
3150 * they reach the normal circuit-build timeout. */
3151 int CloseHSServiceRendCircuitsImmediatelyOnTimeout
;
3153 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
3154 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
3155 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
3156 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
3157 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
3159 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
3160 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
3161 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
3163 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
3164 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
3166 /** Whether we should drop exit streams from Tors that we don't know are
3167 * relays. One of "0" (never refuse), "1" (always refuse), or "-1" (do
3168 * what the consensus says, defaulting to 'refuse' if the consensus says
3170 int RefuseUnknownExits
;
3172 /** Application ports that require all nodes in circ to have sufficient
3174 smartlist_t
*LongLivedPorts
;
3175 /** Application ports that are likely to be unencrypted and
3176 * unauthenticated; we reject requests for them to prevent the
3177 * user from screwing up and leaking plaintext secrets to an
3178 * observer somewhere on the Internet. */
3179 smartlist_t
*RejectPlaintextPorts
;
3180 /** Related to RejectPlaintextPorts above, except this config option
3181 * controls whether we warn (in the log and via a controller status
3182 * event) every time a risky connection is attempted. */
3183 smartlist_t
*WarnPlaintextPorts
;
3184 /** Should we try to reuse the same exit node for a given host */
3185 smartlist_t
*TrackHostExits
;
3186 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
3188 config_line_t
*AddressMap
; /**< List of address map directives. */
3189 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
3190 * hostname ending with one of the suffixes in
3191 * <b>AutomapHostsSuffixes</b>, map it to a
3192 * virtual address. */
3193 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
3194 * <b>AutomapHostsOnResolve</b>. */
3195 int RendPostPeriod
; /**< How often do we post each rendezvous service
3196 * descriptor? Remember to publish them independently. */
3197 int KeepalivePeriod
; /**< How often do we send padding cells to keep
3198 * connections alive? */
3199 int SocksTimeout
; /**< How long do we let a socks connection wait
3200 * unattached before we fail it? */
3201 int LearnCircuitBuildTimeout
; /**< If non-zero, we attempt to learn a value
3202 * for CircuitBuildTimeout based on timeout
3204 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born at
3205 * least this many seconds ago. Used until
3206 * adaptive algorithm learns a new value. */
3207 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
3208 * at least this many seconds ago. */
3209 int CircuitStreamTimeout
; /**< If non-zero, detach streams from circuits
3210 * and try a new circuit if the stream has been
3211 * waiting for this many seconds. If zero, use
3212 * our default internal timeout schedule. */
3213 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
3214 * to wait simultaneously before we start dropping
3216 int NewCircuitPeriod
; /**< How long do we use a circuit before building
3218 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
3219 this interval ago. */
3220 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
3221 * to use in a second? */
3222 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
3223 * to use in a second? */
3224 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
3225 * tell people we have? */
3226 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
3227 * willing to use for all relayed conns? */
3228 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
3229 * use in a second for all relayed conns? */
3230 uint64_t PerConnBWRate
; /**< Long-term bw on a single TLS conn, if set. */
3231 uint64_t PerConnBWBurst
; /**< Allowed burst on a single TLS conn, if set. */
3232 int NumCPUs
; /**< How many CPUs should we try to use? */
3233 //int RunTesting; /**< If true, create testing circuits to measure how well the
3234 // * other ORs are running. */
3235 config_line_t
*RendConfigLines
; /**< List of configuration lines
3236 * for rendezvous services. */
3237 config_line_t
*HidServAuth
; /**< List of configuration lines for client-side
3238 * authorizations for hidden services */
3239 char *ContactInfo
; /**< Contact info to be published in the directory. */
3241 int HeartbeatPeriod
; /**< Log heartbeat messages after this many seconds
3244 char *HTTPProxy
; /**< hostname[:port] to use as http proxy, if any. */
3245 tor_addr_t HTTPProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
3246 uint16_t HTTPProxyPort
; /**< Parsed port for http proxy, if any. */
3247 char *HTTPProxyAuthenticator
; /**< username:password string, if any. */
3249 char *HTTPSProxy
; /**< hostname[:port] to use as https proxy, if any. */
3250 tor_addr_t HTTPSProxyAddr
; /**< Parsed addr for https proxy, if any. */
3251 uint16_t HTTPSProxyPort
; /**< Parsed port for https proxy, if any. */
3252 char *HTTPSProxyAuthenticator
; /**< username:password string, if any. */
3254 char *Socks4Proxy
; /**< hostname:port to use as a SOCKS4 proxy, if any. */
3255 tor_addr_t Socks4ProxyAddr
; /**< Derived from Socks4Proxy. */
3256 uint16_t Socks4ProxyPort
; /**< Derived from Socks4Proxy. */
3258 char *Socks5Proxy
; /**< hostname:port to use as a SOCKS5 proxy, if any. */
3259 tor_addr_t Socks5ProxyAddr
; /**< Derived from Sock5Proxy. */
3260 uint16_t Socks5ProxyPort
; /**< Derived from Socks5Proxy. */
3261 char *Socks5ProxyUsername
; /**< Username for SOCKS5 authentication, if any */
3262 char *Socks5ProxyPassword
; /**< Password for SOCKS5 authentication, if any */
3264 /** List of configuration lines for replacement directory authorities.
3265 * If you just want to replace one class of authority at a time,
3266 * use the "Alternate*Authority" options below instead. */
3267 config_line_t
*DirServers
;
3269 /** If set, use these main (currently v3) directory authorities and
3270 * not the default ones. */
3271 config_line_t
*AlternateDirAuthority
;
3273 /** If set, use these bridge authorities and not the default one. */
3274 config_line_t
*AlternateBridgeAuthority
;
3276 /** If set, use these HS authorities and not the default ones. */
3277 config_line_t
*AlternateHSAuthority
;
3279 char *MyFamily
; /**< Declared family for this OR. */
3280 config_line_t
*NodeFamilies
; /**< List of config lines for
3282 smartlist_t
*NodeFamilySets
; /**< List of parsed NodeFamilies values. */
3283 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
3284 * mark as bad dir mirrors. */
3285 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
3286 * mark as bad exits. */
3287 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
3289 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
3290 * never mark as valid. */
3291 /** @name AuthDir...CC
3293 * Lists of country codes to mark as BadDir, BadExit, or Invalid, or to
3298 smartlist_t
*AuthDirBadDirCCs
;
3299 smartlist_t
*AuthDirBadExitCCs
;
3300 smartlist_t
*AuthDirInvalidCCs
;
3301 smartlist_t
*AuthDirRejectCCs
;
3304 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
3305 * and vote for all other dir mirrors as good. */
3306 int AuthDirListBadExits
; /**< True iff we should list bad exits,
3307 * and vote for all other exits as good. */
3308 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
3309 * aren't named in our fingerprint file? */
3310 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
3311 * number of servers per IP address. */
3312 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
3313 * number of servers per IP address shared
3314 * with an authority. */
3316 /** If non-zero, always vote the Fast flag for any relay advertising
3317 * this amount of capacity or more. */
3318 uint64_t AuthDirFastGuarantee
;
3320 /** If non-zero, this advertised capacity or more is always sufficient
3321 * to satisfy the bandwidth requirement for the Guard flag. */
3322 uint64_t AuthDirGuardBWGuarantee
;
3324 char *AccountingStart
; /**< How long is the accounting interval, and when
3326 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
3327 * interval before hibernation? 0 for "never
3330 /** Base64-encoded hash of accepted passwords for the control system. */
3331 config_line_t
*HashedControlPassword
;
3332 /** As HashedControlPassword, but not saved. */
3333 config_line_t
*HashedControlSessionPassword
;
3335 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
3336 * the control system? */
3337 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
3338 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
3339 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
3340 * circuits itself (0), or does it expect a controller
3342 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
3343 * make circuits in the background (0),
3346 /** Process specifier for a controller that ‘owns’ this Tor
3347 * instance. Tor will terminate if its owning controller does. */
3348 char *OwningControllerProcess
;
3350 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
3351 * long do we wait before exiting? */
3352 char *SafeLogging
; /**< Contains "relay", "1", "0" (meaning no scrubbing). */
3354 /* Derived from SafeLogging */
3356 SAFELOG_SCRUB_ALL
, SAFELOG_SCRUB_RELAY
, SAFELOG_SCRUB_NONE
3359 int SafeSocks
; /**< Boolean: should we outright refuse application
3360 * connections that use socks4 or socks5-with-local-dns? */
3361 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
3362 LOG_WARN : LOG_INFO)
3363 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
3364 * protocol, is it a warn or an info in our logs? */
3365 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
3366 * log whether it was DNS-leaking or not? */
3367 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
3368 * acceleration where available? */
3369 /** Token Bucket Refill resolution in milliseconds. */
3370 int TokenBucketRefillInterval
;
3371 char *AccelName
; /**< Optional hardware acceleration engine name. */
3372 char *AccelDir
; /**< Optional hardware acceleration engine search dir. */
3373 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
3374 * of fixed nodes? */
3375 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
3376 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
3377 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
3378 * of our PK time by sending CREATE_FAST cells? */
3379 /** Should we always fetch our dir info on the mirror schedule (which
3380 * means directly from the authorities) no matter our other config? */
3381 int FetchDirInfoEarly
;
3383 /** Should we fetch our dir info at the start of the consensus period? */
3384 int FetchDirInfoExtraEarly
;
3386 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
3387 * MAPADDRESS requests. */
3388 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
3389 * addresses to be FQDNs, but rather search for them in
3390 * the local domains. */
3391 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
3393 int ServerDNSRandomizeCase
; /**< Boolean: Use the 0x20-hack to prevent
3394 * DNS poisoning attacks. */
3395 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
3396 * resolver from the file here rather than from
3397 * /etc/resolv.conf (Unix) or the registry (Windows). */
3398 char *DirPortFrontPage
; /**< This is a full path to a file with an html
3399 disclaimer. This allows a server administrator to show
3400 that they're running Tor and anyone visiting their server
3401 will know this without any specialized knowledge. */
3402 int DisableDebuggerAttachment
; /**< Currently Linux only specific attempt to
3403 disable ptrace; needs BSD testing. */
3404 /** Boolean: if set, we start even if our resolv.conf file is missing
3406 int ServerDNSAllowBrokenConfig
;
3407 /** Boolean: if set, then even connections to private addresses will get
3409 int CountPrivateBandwidth
;
3410 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
3411 * should be resolvable. Used for
3412 * testing our DNS server. */
3413 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
3414 * same network zone in the same circuit. */
3415 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
3417 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
3418 * support BEGIN_DIR, when possible. */
3419 int PortForwarding
; /**< If true, use NAT-PMP or UPnP to automatically
3420 * forward the DirPort and ORPort on the NAT device */
3421 char *PortForwardingHelper
; /** < Filename or full path of the port
3422 forwarding helper executable */
3423 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
3424 * with weird characters. */
3425 /** If true, we try resolving hostnames with weird characters. */
3426 int ServerDNSAllowNonRFC953Hostnames
;
3428 /** If true, we try to download extra-info documents (and we serve them,
3429 * if we are a cache). For authorities, this is always true. */
3430 int DownloadExtraInfo
;
3432 /** If true, and we are acting as a relay, allow exit circuits even when
3433 * we are the first hop of a circuit. */
3434 int AllowSingleHopExits
;
3435 /** If true, don't allow relays with AllowSingleHopExits=1 to be used in
3436 * circuits that we build. */
3437 int ExcludeSingleHopRelays
;
3438 /** If true, and the controller tells us to use a one-hop circuit, and the
3439 * exit allows it, we use it. */
3440 int AllowSingleHopCircuits
;
3442 /** If true, we convert "www.google.com.foo.exit" addresses on the
3443 * socks/trans/natd ports into "www.google.com" addresses that
3444 * exit from the node "foo". Disabled by default since attacking
3445 * websites and exit relays can use it to manipulate your path
3449 /** If true, we will warn if a user gives us only an IP address
3450 * instead of a hostname. */
3451 int WarnUnsafeSocks
;
3453 /** If true, the user wants us to collect statistics on clients
3454 * requesting network statuses from us as directory. */
3455 int DirReqStatistics
;
3457 /** If true, the user wants us to collect statistics on port usage. */
3458 int ExitPortStatistics
;
3460 /** If true, the user wants us to collect connection statistics. */
3461 int ConnDirectionStatistics
;
3463 /** If true, the user wants us to collect cell statistics. */
3466 /** If true, the user wants us to collect statistics as entry node. */
3467 int EntryStatistics
;
3469 /** If true, include statistics file contents in extra-info documents. */
3470 int ExtraInfoStatistics
;
3472 /** If true, do not believe anybody who tells us that a domain resolves
3473 * to an internal address, or that an internal address has a PTR mapping.
3474 * Helps avoid some cross-site attacks. */
3475 int ClientDNSRejectInternalAddresses
;
3477 /** If true, do not accept any requests to connect to internal addresses
3478 * over randomly chosen exits. */
3479 int ClientRejectInternalAddresses
;
3481 /** The length of time that we think a consensus should be fresh. */
3482 int V3AuthVotingInterval
;
3483 /** The length of time we think it will take to distribute votes. */
3484 int V3AuthVoteDelay
;
3485 /** The length of time we think it will take to distribute signatures. */
3486 int V3AuthDistDelay
;
3487 /** The number of intervals we think a consensus should be valid. */
3488 int V3AuthNIntervalsValid
;
3490 /** Should advertise and sign consensuses with a legacy key, for key
3491 * migration purposes? */
3492 int V3AuthUseLegacyKey
;
3494 /** Location of bandwidth measurement file */
3495 char *V3BandwidthsFile
;
3497 /** Authority only: key=value pairs that we add to our networkstatus
3498 * consensus vote on the 'params' line. */
3499 char *ConsensusParams
;
3501 /** The length of time that we think an initial consensus should be fresh.
3502 * Only altered on testing networks. */
3503 int TestingV3AuthInitialVotingInterval
;
3505 /** The length of time we think it will take to distribute initial votes.
3506 * Only altered on testing networks. */
3507 int TestingV3AuthInitialVoteDelay
;
3509 /** The length of time we think it will take to distribute initial
3510 * signatures. Only altered on testing networks.*/
3511 int TestingV3AuthInitialDistDelay
;
3513 /** If an authority has been around for less than this amount of time, it
3514 * does not believe its reachability information is accurate. Only
3515 * altered on testing networks. */
3516 int TestingAuthDirTimeToLearnReachability
;
3518 /** Clients don't download any descriptor this recent, since it will
3519 * probably not have propagated to enough caches. Only altered on testing
3521 int TestingEstimatedDescriptorPropagationTime
;
3523 /** If true, we take part in a testing network. Change the defaults of a
3524 * couple of other configuration options and allow to change the values
3525 * of certain configuration options. */
3526 int TestingTorNetwork
;
3528 /** File to check for a consensus networkstatus, if we don't have one
3530 char *FallbackNetworkstatusFile
;
3532 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
3533 * count of how many client addresses have contacted us so that we can help
3534 * the bridge authority guess which countries have blocked access to us. */
3535 int BridgeRecordUsageByCountry
;
3537 /** Optionally, a file with GeoIP data. */
3540 /** If true, SIGHUP should reload the torrc. Sometimes controllers want
3541 * to make this false. */
3542 int ReloadTorrcOnSIGHUP
;
3544 /* The main parameter for picking circuits within a connection.
3546 * If this value is positive, when picking a cell to relay on a connection,
3547 * we always relay from the circuit whose weighted cell count is lowest.
3548 * Cells are weighted exponentially such that if one cell is sent
3549 * 'CircuitPriorityHalflife' seconds before another, it counts for half as
3552 * If this value is zero, we're disabling the cell-EWMA algorithm.
3554 * If this value is negative, we're using the default approach
3555 * according to either Tor or a parameter set in the consensus.
3557 double CircuitPriorityHalflife
;
3559 /** If true, do not enable IOCP on windows with bufferevents, even if
3560 * we think we could. */
3562 /** For testing only: will go away in 0.2.3.x. */
3563 int _UseFilteringSSLBufferevents
;
3565 /** Set to true if the TestingTorNetwork configuration option is set.
3566 * This is used so that options_validate() has a chance to realize that
3567 * the defaults have changed. */
3568 int _UsingTestNetworkDefaults
;
3570 /** If 1, we try to use microdescriptors to build circuits. If 0, we don't.
3571 * If -1, Tor decides. */
3572 int UseMicrodescriptors
;
3574 /** File where we should write the ControlPort. */
3575 char *ControlPortWriteToFile
;
3576 /** Should that file be group-readable? */
3577 int ControlPortFileGroupReadable
;
3579 #define MAX_MAX_CLIENT_CIRCUITS_PENDING 1024
3580 /** Maximum number of non-open general-purpose origin circuits to allow at
3582 int MaxClientCircuitsPending
;
3584 /** If 1, we always send optimistic data when it's supported. If 0, we
3585 * never use it. If -1, we do what the consensus says. */
3588 /** If 1, and we are using IOCP, we set the kernel socket SNDBUF and RCVBUF
3589 * to 0 to try to save kernel memory and avoid the dread "Out of buffers"
3591 int UserspaceIOCPBuffers
;
3593 /** If 1, we accept and launch no external network connections, except on
3598 * Parameters for path-bias detection.
3601 int PathBiasCircThreshold
;
3602 double PathBiasNoticeRate
;
3603 double PathBiasDisableRate
;
3604 int PathBiasScaleThreshold
;
3605 int PathBiasScaleFactor
;
3608 /** How long (seconds) do we keep a guard before picking a new one? */
3613 /** Persistent state for an onion router, as saved to disk. */
3616 /** The time at which we next plan to write the state to the disk. Equal to
3617 * TIME_MAX if there are no savable changes, 0 if there are changes that
3618 * should be saved right away. */
3621 /** When was the state last written to disk? */
3624 /** Fields for accounting bandwidth use. */
3625 time_t AccountingIntervalStart
;
3626 uint64_t AccountingBytesReadInInterval
;
3627 uint64_t AccountingBytesWrittenInInterval
;
3628 int AccountingSecondsActive
;
3629 int AccountingSecondsToReachSoftLimit
;
3630 time_t AccountingSoftLimitHitAt
;
3631 uint64_t AccountingBytesAtSoftLimit
;
3632 uint64_t AccountingExpectedUsage
;
3634 /** A list of Entry Guard-related configuration lines. */
3635 config_line_t
*EntryGuards
;
3637 config_line_t
*TransportProxies
;
3639 /** These fields hold information on the history of bandwidth usage for
3640 * servers. The "Ends" fields hold the time when we last updated the
3641 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
3642 * of the entries of Values. The "Values" lists hold decimal string
3643 * representations of the number of bytes read or written in each
3644 * interval. The "Maxima" list holds decimal strings describing the highest
3645 * rate achieved during the interval.
3647 time_t BWHistoryReadEnds
;
3648 int BWHistoryReadInterval
;
3649 smartlist_t
*BWHistoryReadValues
;
3650 smartlist_t
*BWHistoryReadMaxima
;
3651 time_t BWHistoryWriteEnds
;
3652 int BWHistoryWriteInterval
;
3653 smartlist_t
*BWHistoryWriteValues
;
3654 smartlist_t
*BWHistoryWriteMaxima
;
3655 time_t BWHistoryDirReadEnds
;
3656 int BWHistoryDirReadInterval
;
3657 smartlist_t
*BWHistoryDirReadValues
;
3658 smartlist_t
*BWHistoryDirReadMaxima
;
3659 time_t BWHistoryDirWriteEnds
;
3660 int BWHistoryDirWriteInterval
;
3661 smartlist_t
*BWHistoryDirWriteValues
;
3662 smartlist_t
*BWHistoryDirWriteMaxima
;
3664 /** Build time histogram */
3665 config_line_t
* BuildtimeHistogram
;
3666 unsigned int TotalBuildTimes
;
3667 unsigned int CircuitBuildAbandonedCount
;
3669 /** What version of Tor wrote this state file? */
3672 /** Holds any unrecognized values we found in the state file, in the order
3673 * in which we found them. */
3674 config_line_t
*ExtraLines
;
3676 /** When did we last rotate our onion key? "0" for 'no idea'. */
3677 time_t LastRotatedOnionKey
;
3680 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
3681 * state is already scheduled to be written to disk earlier than <b>when</b>.
3683 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
3685 if (state
->next_write
> when
)
3686 state
->next_write
= when
;
3689 #define MAX_SOCKS_REPLY_LEN 1024
3690 #define MAX_SOCKS_ADDR_LEN 256
3691 #define SOCKS_NO_AUTH 0x00
3692 #define SOCKS_USER_PASS 0x02
3694 /** Please open a TCP connection to this addr:port. */
3695 #define SOCKS_COMMAND_CONNECT 0x01
3696 /** Please turn this FQDN into an IP address, privately. */
3697 #define SOCKS_COMMAND_RESOLVE 0xF0
3698 /** Please turn this IP address into an FQDN, privately. */
3699 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
3701 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
3702 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
3703 (c)==SOCKS_COMMAND_RESOLVE_PTR)
3705 /** State of a SOCKS request from a user to an OP. Also used to encode other
3706 * information for non-socks user request (such as those on TransPort and
3708 struct socks_request_t
{
3709 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
3710 * 0 means that no socks handshake ever took place, and this is just a
3711 * stub connection (e.g. see connection_ap_make_link()). */
3712 uint8_t socks_version
;
3713 /** If using socks5 authentication, which authentication type did we
3714 * negotiate? currently we support 0 (no authentication) and 2
3715 * (username/password). */
3717 /** What is this stream's goal? One of the SOCKS_COMMAND_* values */
3719 /** Which kind of listener created this stream? */
3720 uint8_t listener_type
;
3721 size_t replylen
; /**< Length of <b>reply</b>. */
3722 uint8_t reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
3723 * we want to specify our own socks reply,
3724 * rather than using the default socks4 or
3725 * socks5 socks reply. We use this for the
3726 * two-stage socks5 handshake.
3728 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
3729 connect to/resolve? */
3730 uint16_t port
; /**< What port did the client ask to connect to? */
3731 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
3732 * make sure we send back a socks reply for
3733 * every connection. */
3734 unsigned int got_auth
: 1; /**< Have we received any authentication data? */
3736 /** Number of bytes in username; 0 if username is NULL */
3738 /** Number of bytes in password; 0 if password is NULL */
3739 uint8_t passwordlen
;
3740 /** The negotiated username value if any (for socks5), or the entire
3741 * authentication string (for socks4). This value is NOT nul-terminated;
3742 * see usernamelen for its length. */
3744 /** The negotiated password value if any (for socks5). This value is NOT
3745 * nul-terminated; see passwordlen for its length. */
3749 /********************************* circuitbuild.c **********************/
3751 /** How many hops does a general-purpose circuit have by default? */
3752 #define DEFAULT_ROUTE_LEN 3
3754 /* Circuit Build Timeout "public" structures. */
3756 /** Precision multiplier for the Bw weights */
3757 #define BW_WEIGHT_SCALE 10000
3758 #define BW_MIN_WEIGHT_SCALE 1
3759 #define BW_MAX_WEIGHT_SCALE INT32_MAX
3761 /** Total size of the circuit timeout history to accumulate.
3762 * 1000 is approx 2.5 days worth of continual-use circuits. */
3763 #define CBT_NCIRCUITS_TO_OBSERVE 1000
3765 /** Width of the histogram bins in milliseconds */
3766 #define CBT_BIN_WIDTH ((build_time_t)50)
3768 /** Number of modes to use in the weighted-avg computation of Xm */
3769 #define CBT_DEFAULT_NUM_XM_MODES 3
3770 #define CBT_MIN_NUM_XM_MODES 1
3771 #define CBT_MAX_NUM_XM_MODES 20
3773 /** A build_time_t is milliseconds */
3774 typedef uint32_t build_time_t
;
3777 * CBT_BUILD_ABANDONED is our flag value to represent a force-closed
3778 * circuit (Aka a 'right-censored' pareto value).
3780 #define CBT_BUILD_ABANDONED ((build_time_t)(INT32_MAX-1))
3781 #define CBT_BUILD_TIME_MAX ((build_time_t)(INT32_MAX))
3783 /** Save state every 10 circuits */
3784 #define CBT_SAVE_STATE_EVERY 10
3786 /* Circuit build times consensus parameters */
3789 * How long to wait before actually closing circuits that take too long to
3790 * build in terms of CDF quantile.
3792 #define CBT_DEFAULT_CLOSE_QUANTILE 95
3793 #define CBT_MIN_CLOSE_QUANTILE CBT_MIN_QUANTILE_CUTOFF
3794 #define CBT_MAX_CLOSE_QUANTILE CBT_MAX_QUANTILE_CUTOFF
3797 * How many circuits count as recent when considering if the
3798 * connection has gone gimpy or changed.
3800 #define CBT_DEFAULT_RECENT_CIRCUITS 20
3801 #define CBT_MIN_RECENT_CIRCUITS 3
3802 #define CBT_MAX_RECENT_CIRCUITS 1000
3805 * Maximum count of timeouts that finish the first hop in the past
3806 * RECENT_CIRCUITS before calculating a new timeout.
3808 * This tells us whether to abandon timeout history and set
3809 * the timeout back to whatever circuit_build_times_get_initial_timeout()
3812 #define CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT (CBT_DEFAULT_RECENT_CIRCUITS*9/10)
3813 #define CBT_MIN_MAX_RECENT_TIMEOUT_COUNT 3
3814 #define CBT_MAX_MAX_RECENT_TIMEOUT_COUNT 10000
3816 /** Minimum circuits before estimating a timeout */
3817 #define CBT_DEFAULT_MIN_CIRCUITS_TO_OBSERVE 100
3818 #define CBT_MIN_MIN_CIRCUITS_TO_OBSERVE 1
3819 #define CBT_MAX_MIN_CIRCUITS_TO_OBSERVE 10000
3821 /** Cutoff percentile on the CDF for our timeout estimation. */
3822 #define CBT_DEFAULT_QUANTILE_CUTOFF 80
3823 #define CBT_MIN_QUANTILE_CUTOFF 10
3824 #define CBT_MAX_QUANTILE_CUTOFF 99
3825 double circuit_build_times_quantile_cutoff(void);
3827 /** How often in seconds should we build a test circuit */
3828 #define CBT_DEFAULT_TEST_FREQUENCY 60
3829 #define CBT_MIN_TEST_FREQUENCY 1
3830 #define CBT_MAX_TEST_FREQUENCY INT32_MAX
3832 /** Lowest allowable value for CircuitBuildTimeout in milliseconds */
3833 #define CBT_DEFAULT_TIMEOUT_MIN_VALUE (1500)
3834 #define CBT_MIN_TIMEOUT_MIN_VALUE 500
3835 #define CBT_MAX_TIMEOUT_MIN_VALUE INT32_MAX
3837 /** Initial circuit build timeout in milliseconds */
3838 #define CBT_DEFAULT_TIMEOUT_INITIAL_VALUE (60*1000)
3839 #define CBT_MIN_TIMEOUT_INITIAL_VALUE CBT_MIN_TIMEOUT_MIN_VALUE
3840 #define CBT_MAX_TIMEOUT_INITIAL_VALUE INT32_MAX
3841 int32_t circuit_build_times_initial_timeout(void);
3843 #if CBT_DEFAULT_MAX_RECENT_TIMEOUT_COUNT < CBT_MIN_MAX_RECENT_TIMEOUT_COUNT
3844 #error "RECENT_CIRCUITS is set too low."
3847 /** Information about the state of our local network connection */
3849 /** The timestamp we last completed a TLS handshake or received a cell */
3850 time_t network_last_live
;
3851 /** If the network is not live, how many timeouts has this caused? */
3852 int nonlive_timeouts
;
3853 /** Circular array of circuits that have made it to the first hop. Slot is
3854 * 1 if circuit timed out, 0 if circuit succeeded */
3855 int8_t *timeouts_after_firsthop
;
3856 /** Number of elements allocated for the above array */
3857 int num_recent_circs
;
3858 /** Index into circular array. */
3859 int after_firsthop_idx
;
3860 } network_liveness_t
;
3862 /** Structure for circuit build times history */
3864 /** The circular array of recorded build times in milliseconds */
3865 build_time_t circuit_build_times
[CBT_NCIRCUITS_TO_OBSERVE
];
3866 /** Current index in the circuit_build_times circular array */
3867 int build_times_idx
;
3868 /** Total number of build times accumulated. Max CBT_NCIRCUITS_TO_OBSERVE */
3869 int total_build_times
;
3870 /** Information about the state of our local network connection */
3871 network_liveness_t liveness
;
3872 /** Last time we built a circuit. Used to decide to build new test circs */
3873 time_t last_circ_at
;
3874 /** "Minimum" value of our pareto distribution (actually mode) */
3876 /** alpha exponent for pareto dist. */
3878 /** Have we computed a timeout? */
3879 int have_computed_timeout
;
3880 /** The exact value for that timeout in milliseconds. Stored as a double
3881 * to maintain precision from calculations to and from quantile value. */
3883 /** How long we wait before actually closing the circuit. */
3885 } circuit_build_times_t
;
3887 /********************************* config.c ***************************/
3889 /** An error from options_trial_assign() or options_init_from_string(). */
3890 typedef enum setopt_err_t
{
3892 SETOPT_ERR_MISC
= -1,
3893 SETOPT_ERR_PARSE
= -2,
3894 SETOPT_ERR_TRANSITION
= -3,
3895 SETOPT_ERR_SETTING
= -4,
3898 /********************************* connection_edge.c *************************/
3900 /** Enumerates possible origins of a client-side address mapping. */
3902 /** We're remapping this address because the controller told us to. */
3903 ADDRMAPSRC_CONTROLLER
,
3904 /** We're remapping this address because of an AutomapHostsOnResolve
3907 /** We're remapping this address because our configuration (via torrc, the
3908 * command line, or a SETCONF command) told us to. */
3910 /** We're remapping this address because we have TrackHostExit configured,
3911 * and we want to remember to use the same exit next time. */
3912 ADDRMAPSRC_TRACKEXIT
,
3913 /** We're remapping this address because we got a DNS resolution from a
3914 * Tor server that told us what its value was. */
3917 /** No remapping has occurred. This isn't a possible value for an
3918 * addrmap_entry_t; it's used as a null value when we need to answer "Why
3919 * did this remapping happen." */
3921 } addressmap_entry_source_t
;
3923 /********************************* control.c ***************************/
3925 /** Used to indicate the type of a circuit event passed to the controller.
3926 * The various types are defined in control-spec.txt */
3927 typedef enum circuit_status_event_t
{
3928 CIRC_EVENT_LAUNCHED
= 0,
3929 CIRC_EVENT_BUILT
= 1,
3930 CIRC_EVENT_EXTENDED
= 2,
3931 CIRC_EVENT_FAILED
= 3,
3932 CIRC_EVENT_CLOSED
= 4,
3933 } circuit_status_event_t
;
3935 /** Used to indicate the type of a CIRC_MINOR event passed to the controller.
3936 * The various types are defined in control-spec.txt . */
3937 typedef enum circuit_status_minor_event_t
{
3938 CIRC_MINOR_EVENT_PURPOSE_CHANGED
,
3939 CIRC_MINOR_EVENT_CANNIBALIZED
,
3940 } circuit_status_minor_event_t
;
3942 /** Used to indicate the type of a stream event passed to the controller.
3943 * The various types are defined in control-spec.txt */
3944 typedef enum stream_status_event_t
{
3945 STREAM_EVENT_SENT_CONNECT
= 0,
3946 STREAM_EVENT_SENT_RESOLVE
= 1,
3947 STREAM_EVENT_SUCCEEDED
= 2,
3948 STREAM_EVENT_FAILED
= 3,
3949 STREAM_EVENT_CLOSED
= 4,
3950 STREAM_EVENT_NEW
= 5,
3951 STREAM_EVENT_NEW_RESOLVE
= 6,
3952 STREAM_EVENT_FAILED_RETRIABLE
= 7,
3953 STREAM_EVENT_REMAP
= 8
3954 } stream_status_event_t
;
3956 /** Used to indicate the type of an OR connection event passed to the
3957 * controller. The various types are defined in control-spec.txt */
3958 typedef enum or_conn_status_event_t
{
3959 OR_CONN_EVENT_LAUNCHED
= 0,
3960 OR_CONN_EVENT_CONNECTED
= 1,
3961 OR_CONN_EVENT_FAILED
= 2,
3962 OR_CONN_EVENT_CLOSED
= 3,
3963 OR_CONN_EVENT_NEW
= 4,
3964 } or_conn_status_event_t
;
3966 /** Used to indicate the type of a buildtime event */
3967 typedef enum buildtimeout_set_event_t
{
3968 BUILDTIMEOUT_SET_EVENT_COMPUTED
= 0,
3969 BUILDTIMEOUT_SET_EVENT_RESET
= 1,
3970 BUILDTIMEOUT_SET_EVENT_SUSPENDED
= 2,
3971 BUILDTIMEOUT_SET_EVENT_DISCARD
= 3,
3972 BUILDTIMEOUT_SET_EVENT_RESUME
= 4
3973 } buildtimeout_set_event_t
;
3975 /** Execute the statement <b>stmt</b>, which may log events concerning the
3976 * connection <b>conn</b>. To prevent infinite loops, disable log messages
3977 * being sent to controllers if <b>conn</b> is a control connection.
3979 * Stmt must not contain any return or goto statements.
3981 #define CONN_LOG_PROTECT(conn, stmt) \
3983 int _log_conn_is_control; \
3985 _log_conn_is_control = (conn->type == CONN_TYPE_CONTROL); \
3986 if (_log_conn_is_control) \
3987 disable_control_logging(); \
3988 STMT_BEGIN stmt; STMT_END; \
3989 if (_log_conn_is_control) \
3990 enable_control_logging(); \
3993 /** Enum describing various stages of bootstrapping, for use with controller
3994 * bootstrap status events. The values range from 0 to 100. */
3996 BOOTSTRAP_STATUS_UNDEF
=-1,
3997 BOOTSTRAP_STATUS_STARTING
=0,
3998 BOOTSTRAP_STATUS_CONN_DIR
=5,
3999 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
4000 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
4001 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
4002 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
4003 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
4004 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
4005 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
4006 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
4007 BOOTSTRAP_STATUS_CONN_OR
=80,
4008 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
4009 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
4010 BOOTSTRAP_STATUS_DONE
=100
4011 } bootstrap_status_t
;
4013 /********************************* directory.c ***************************/
4015 /** A pair of digests created by dir_split_resource_info_fingerprint_pairs() */
4017 char first
[DIGEST_LEN
];
4018 char second
[DIGEST_LEN
];
4021 /********************************* dirserv.c ***************************/
4023 /** An enum to describe what format we're generating a routerstatus line in.
4026 /** For use in a v2 opinion */
4028 /** For use in a consensus networkstatus document (ns flavor) */
4030 /** For use in a vote networkstatus document */
4032 /** For passing to the controlport in response to a GETINFO request */
4034 /** For use in a consensus networkstatus document (microdesc flavor) */
4035 NS_V3_CONSENSUS_MICRODESC
4036 } routerstatus_format_type_t
;
4038 #ifdef DIRSERV_PRIVATE
4039 typedef struct measured_bw_line_t
{
4040 char node_id
[DIGEST_LEN
];
4041 char node_hex
[MAX_HEX_NICKNAME_LEN
+1];
4043 } measured_bw_line_t
;
4047 /********************************* dirvote.c ************************/
4049 /** Describes the schedule by which votes should be generated. */
4050 typedef struct vote_timing_t
{
4051 /** Length in seconds between one consensus becoming valid and the next
4052 * becoming valid. */
4054 /** For how many intervals is a consensus valid? */
4055 int n_intervals_valid
;
4056 /** Time in seconds allowed to propagate votes */
4058 /** Time in seconds allowed to propagate signatures */
4062 /********************************* geoip.c **************************/
4064 /** Round all GeoIP results to the next multiple of this value, to avoid
4065 * leaking information. */
4066 #define DIR_RECORD_USAGE_GRANULARITY 8
4067 /** Time interval: Flush geoip data to disk this often. */
4068 #define DIR_ENTRY_RECORD_USAGE_RETAIN_IPS (24*60*60)
4069 /** How long do we have to have observed per-country request history before
4070 * we are willing to talk about it? */
4071 #define DIR_RECORD_USAGE_MIN_OBSERVATION_TIME (12*60*60)
4073 /** Indicates an action that we might be noting geoip statistics on.
4074 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
4075 * the others, we're not.
4078 /** We've noticed a connection as a bridge relay or entry guard. */
4079 GEOIP_CLIENT_CONNECT
= 0,
4080 /** We've served a networkstatus consensus as a directory server. */
4081 GEOIP_CLIENT_NETWORKSTATUS
= 1,
4082 /** We've served a v2 networkstatus consensus as a directory server. */
4083 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
4084 } geoip_client_action_t
;
4085 /** Indicates either a positive reply or a reason for rejectng a network
4086 * status request that will be included in geoip statistics. */
4088 /** Request is answered successfully. */
4090 /** V3 network status is not signed by a sufficient number of requested
4092 GEOIP_REJECT_NOT_ENOUGH_SIGS
= 1,
4093 /** Requested network status object is unavailable. */
4094 GEOIP_REJECT_UNAVAILABLE
= 2,
4095 /** Requested network status not found. */
4096 GEOIP_REJECT_NOT_FOUND
= 3,
4097 /** Network status has not been modified since If-Modified-Since time. */
4098 GEOIP_REJECT_NOT_MODIFIED
= 4,
4099 /** Directory is busy. */
4100 GEOIP_REJECT_BUSY
= 5,
4101 } geoip_ns_response_t
;
4102 #define GEOIP_NS_RESPONSE_NUM 6
4104 /** Directory requests that we are measuring can be either direct or
4108 DIRREQ_TUNNELED
= 1,
4111 /** Possible states for either direct or tunneled directory requests that
4112 * are relevant for determining network status download times. */
4114 /** Found that the client requests a network status; applies to both
4115 * direct and tunneled requests; initial state of a request that we are
4117 DIRREQ_IS_FOR_NETWORK_STATUS
= 0,
4118 /** Finished writing a network status to the directory connection;
4119 * applies to both direct and tunneled requests; completes a direct
4121 DIRREQ_FLUSHING_DIR_CONN_FINISHED
= 1,
4122 /** END cell sent to circuit that initiated a tunneled request. */
4123 DIRREQ_END_CELL_SENT
= 2,
4124 /** Flushed last cell from queue of the circuit that initiated a
4125 * tunneled request to the outbuf of the OR connection. */
4126 DIRREQ_CIRC_QUEUE_FLUSHED
= 3,
4127 /** Flushed last byte from buffer of the OR connection belonging to the
4128 * circuit that initiated a tunneled request; completes a tunneled
4130 DIRREQ_OR_CONN_BUFFER_FLUSHED
= 4
4133 #define WRITE_STATS_INTERVAL (24*60*60)
4135 /********************************* microdesc.c *************************/
4137 typedef struct microdesc_cache_t microdesc_cache_t
;
4139 /********************************* networkstatus.c *********************/
4141 /** Location where we found a v2 networkstatus. */
4143 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
4144 } v2_networkstatus_source_t
;
4146 /** Possible statuses of a version of Tor, given opinions from the directory
4148 typedef enum version_status_t
{
4149 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
4150 VS_OLD
=1, /**< This version is older than any recommended version. */
4151 VS_NEW
=2, /**< This version is newer than any recommended version. */
4152 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
4153 * in its series, but later recommended versions exist.
4155 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
4156 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
4157 VS_UNKNOWN
, /**< We have no idea. */
4160 /********************************* policies.c ************************/
4162 /** Outcome of applying an address policy to an address. */
4164 /** The address was accepted */
4165 ADDR_POLICY_ACCEPTED
=0,
4166 /** The address was rejected */
4167 ADDR_POLICY_REJECTED
=-1,
4168 /** Part of the address was unknown, but as far as we can tell, it was
4170 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
4171 /** Part of the address was unknown, but as far as we can tell, it was
4173 ADDR_POLICY_PROBABLY_REJECTED
=2,
4174 } addr_policy_result_t
;
4176 /********************************* rephist.c ***************************/
4178 /** Possible public/private key operations in Tor: used to keep track of where
4179 * we're spending our time. */
4182 VERIFY_DIR
, VERIFY_RTR
,
4183 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
4184 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
4185 REND_CLIENT
, REND_MID
, REND_SERVER
,
4188 /********************************* rendcommon.c ***************************/
4190 /** Hidden-service side configuration of client authorization. */
4191 typedef struct rend_authorized_client_t
{
4193 char descriptor_cookie
[REND_DESC_COOKIE_LEN
];
4194 crypto_pk_t
*client_key
;
4195 } rend_authorized_client_t
;
4197 /** ASCII-encoded v2 hidden service descriptor. */
4198 typedef struct rend_encoded_v2_service_descriptor_t
{
4199 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
4200 char *desc_str
; /**< Descriptor string. */
4201 } rend_encoded_v2_service_descriptor_t
;
4203 /** The maximum number of non-circuit-build-timeout failures a hidden
4204 * service client will tolerate while trying to build a circuit to an
4205 * introduction point. See also rend_intro_point_t.unreachable_count. */
4206 #define MAX_INTRO_POINT_REACHABILITY_FAILURES 5
4208 /** The maximum number of distinct INTRODUCE2 cells which a hidden
4209 * service's introduction point will receive before it begins to
4212 * XXX023 Is this number at all sane? */
4213 #define INTRO_POINT_LIFETIME_INTRODUCTIONS 16384
4215 /** The minimum number of seconds that an introduction point will last
4216 * before expiring due to old age. (If it receives
4217 * INTRO_POINT_LIFETIME_INTRODUCTIONS INTRODUCE2 cells, it may expire
4220 * XXX023 Should this be configurable? */
4221 #define INTRO_POINT_LIFETIME_MIN_SECONDS 18*60*60
4222 /** The maximum number of seconds that an introduction point will last
4223 * before expiring due to old age.
4225 * XXX023 Should this be configurable? */
4226 #define INTRO_POINT_LIFETIME_MAX_SECONDS 24*60*60
4228 /** Introduction point information. Used both in rend_service_t (on
4229 * the service side) and in rend_service_descriptor_t (on both the
4230 * client and service side). */
4231 typedef struct rend_intro_point_t
{
4232 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
4233 crypto_pk_t
*intro_key
; /**< Introduction key that replaces the service
4234 * key, if this descriptor is V2. */
4236 /** (Client side only) Flag indicating that a timeout has occurred
4237 * after sending an INTRODUCE cell to this intro point. After a
4238 * timeout, an intro point should not be tried again during the same
4239 * hidden service connection attempt, but it may be tried again
4240 * during a future connection attempt. */
4241 unsigned int timed_out
: 1;
4243 /** (Client side only) The number of times we have failed to build a
4244 * circuit to this intro point for some reason other than our
4245 * circuit-build timeout. See also MAX_INTRO_POINT_REACHABILITY_FAILURES. */
4246 unsigned int unreachable_count
: 3;
4248 /** (Service side only) Flag indicating that this intro point was
4249 * included in the last HS descriptor we generated. */
4250 unsigned int listed_in_last_desc
: 1;
4252 /** (Service side only) Flag indicating that
4253 * rend_service_note_removing_intro_point has been called for this
4255 unsigned int rend_service_note_removing_intro_point_called
: 1;
4257 /** (Service side only) A digestmap recording the INTRODUCE2 cells
4258 * this intro point's circuit has received. Each key is the digest
4259 * of the RSA-encrypted part of a received INTRODUCE2 cell; each
4260 * value is a pointer to the time_t at which the cell was received.
4261 * This digestmap is used to prevent replay attacks. */
4262 digestmap_t
*accepted_intro_rsa_parts
;
4264 /** (Service side only) The time at which this intro point was first
4265 * published, or -1 if this intro point has not yet been
4267 time_t time_published
;
4269 /** (Service side only) The time at which this intro point should
4270 * (start to) expire, or -1 if we haven't decided when this intro
4271 * point should expire. */
4272 time_t time_to_expire
;
4274 /** (Service side only) The time at which we decided that this intro
4275 * point should start expiring, or -1 if this intro point is not yet
4278 * This field also serves as a flag to indicate that we have decided
4279 * to expire this intro point, in case intro_point_should_expire_now
4280 * flaps (perhaps due to a clock jump; perhaps due to other
4281 * weirdness, or even a (present or future) bug). */
4282 time_t time_expiring
;
4283 } rend_intro_point_t
;
4285 #define REND_PROTOCOL_VERSION_BITMASK_WIDTH 16
4287 /** Information used to connect to a hidden service. Used on both the
4288 * service side and the client side. */
4289 typedef struct rend_service_descriptor_t
{
4290 crypto_pk_t
*pk
; /**< This service's public key. */
4291 int version
; /**< Version of the descriptor format: 0 or 2. */
4292 time_t timestamp
; /**< Time when the descriptor was generated. */
4293 /** Bitmask: which rendezvous protocols are supported?
4294 * (We allow bits '0', '1', and '2' to be set.) */
4295 int protocols
: REND_PROTOCOL_VERSION_BITMASK_WIDTH
;
4296 /** List of the service's introduction points. Elements are removed if
4297 * introduction attempts fail. */
4298 smartlist_t
*intro_nodes
;
4299 /** Has descriptor been uploaded to all hidden service directories? */
4300 int all_uploads_performed
;
4301 /** List of hidden service directories to which an upload request for
4302 * this descriptor could be sent. Smartlist exists only when at least one
4303 * of the previous upload requests failed (otherwise it's not important
4304 * to know which uploads succeeded and which not). */
4305 smartlist_t
*successful_uploads
;
4306 } rend_service_descriptor_t
;
4308 /** A cached rendezvous descriptor. */
4309 typedef struct rend_cache_entry_t
{
4310 size_t len
; /**< Length of <b>desc</b> */
4311 time_t received
; /**< When was the descriptor received? */
4312 char *desc
; /**< Service descriptor */
4313 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
4314 } rend_cache_entry_t
;
4316 /********************************* routerlist.c ***************************/
4318 /** Represents information about a single trusted directory server. */
4319 typedef struct trusted_dir_server_t
{
4322 char *address
; /**< Hostname. */
4323 uint32_t addr
; /**< IPv4 address. */
4324 uint16_t dir_port
; /**< Directory port. */
4325 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
4326 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
4327 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
4328 * high-security) identity key. */
4330 unsigned int is_running
:1; /**< True iff we think this server is running. */
4332 /** True iff this server has accepted the most recent server descriptor
4333 * we tried to upload to it. */
4334 unsigned int has_accepted_serverdesc
:1;
4336 /** What kind of authority is this? (Bitfield.) */
4337 dirinfo_type_t type
;
4339 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
4340 * v2 network status. */
4341 time_t addr_current_at
; /**< When was the document that we derived the
4342 * address information from published? */
4344 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
4345 * dir_server_t to directory_initiate_command_*
4346 * as a routerstatus_t. Not updated by the
4347 * router-status management code!
4349 } trusted_dir_server_t
;
4351 #define ROUTER_REQUIRED_MIN_BANDWIDTH (20*1024)
4353 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
4355 /* Flags for pick_directory_server() and pick_trusteddirserver(). */
4356 /** Flag to indicate that we should not automatically be willing to use
4357 * ourself to answer a directory request.
4358 * Passed to router_pick_directory_server (et al).*/
4359 #define PDS_ALLOW_SELF (1<<0)
4360 /** Flag to indicate that if no servers seem to be up, we should mark all
4361 * directory servers as up and try again.
4362 * Passed to router_pick_directory_server (et al).*/
4363 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4364 /** Flag to indicate that we should not exclude directory servers that
4365 * our ReachableAddress settings would exclude. This usually means that
4366 * we're going to connect to the server over Tor, and so we don't need to
4367 * worry about our firewall telling us we can't.
4368 * Passed to router_pick_directory_server (et al).*/
4369 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4370 /** Flag to indicate that we should not use any directory authority to which
4371 * we have an existing directory connection for downloading server descriptors
4372 * or extrainfo documents.
4374 * Passed to router_pick_directory_server (et al)
4376 * [XXXX NOTE: This option is only implemented for pick_trusteddirserver,
4377 * not pick_directory_server. If we make it work on pick_directory_server
4378 * too, we could conservatively make it only prevent multiple fetches to
4379 * the same authority, or we could aggressively make it prevent multiple
4380 * fetches to _any_ single directory server.]
4382 #define PDS_NO_EXISTING_SERVERDESC_FETCH (1<<3)
4383 #define PDS_NO_EXISTING_MICRODESC_FETCH (1<<4)
4385 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4387 /** Possible ways to weight routers when choosing one randomly. See
4388 * routerlist_sl_choose_by_bandwidth() for more information.*/
4389 typedef enum bandwidth_weight_rule_t
{
4390 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_MID
, WEIGHT_FOR_GUARD
,
4392 } bandwidth_weight_rule_t
;
4394 /** Flags to be passed to control router_choose_random_node() to indicate what
4395 * kind of nodes to pick according to what algorithm. */
4397 CRN_NEED_UPTIME
= 1<<0,
4398 CRN_NEED_CAPACITY
= 1<<1,
4399 CRN_NEED_GUARD
= 1<<2,
4400 CRN_ALLOW_INVALID
= 1<<3,
4401 /* XXXX not used, apparently. */
4402 CRN_WEIGHT_AS_EXIT
= 1<<5,
4403 CRN_NEED_DESC
= 1<<6
4404 } router_crn_flags_t
;
4406 /** Return value for router_add_to_routerlist() and dirserv_add_descriptor() */
4407 typedef enum was_router_added_t
{
4408 ROUTER_ADDED_SUCCESSFULLY
= 1,
4409 ROUTER_ADDED_NOTIFY_GENERATOR
= 0,
4411 ROUTER_WAS_NOT_NEW
= -2,
4412 ROUTER_NOT_IN_CONSENSUS
= -3,
4413 ROUTER_NOT_IN_CONSENSUS_OR_NETWORKSTATUS
= -4,
4414 ROUTER_AUTHDIR_REJECTS
= -5,
4415 ROUTER_WAS_NOT_WANTED
= -6
4416 } was_router_added_t
;
4418 /********************************* routerparse.c ************************/
4420 #define MAX_STATUS_TAG_LEN 32
4421 /** Structure to hold parsed Tor versions. This is a little messier
4422 * than we would like it to be, because we changed version schemes with 0.1.0.
4424 * See version-spec.txt for the whole business.
4426 typedef struct tor_version_t
{
4430 /** Release status. For version in the post-0.1 format, this is always
4432 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4434 char status_tag
[MAX_STATUS_TAG_LEN
];
4438 char git_tag
[DIGEST_LEN
];