1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2007, Roger Dingledine, Nick Mathewson. */
4 /* See LICENSE for licensing information */
9 * \brief Master header file for Tor-specific functionality.
14 #define OR_H_ID "$Id$"
18 #define WIN32_WINNT 0x400
19 #define _WIN32_WINNT 0x400
20 #define WIN32_LEAN_AND_MEAN
32 #ifdef HAVE_SYS_PARAM_H
33 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
36 #ifdef HAVE_SYS_WAIT_H
39 #ifdef HAVE_SYS_FCNTL_H
40 #include <sys/fcntl.h>
45 #ifdef HAVE_SYS_IOCTL_H
46 #include <sys/ioctl.h>
51 #ifdef HAVE_SYS_STAT_H
54 #ifdef HAVE_ARPA_INET_H
55 #include <arpa/inet.h>
67 /** Upper bound on maximum simultaneous connections; can be lowered by
69 #if defined(CYGWIN) || defined(__CYGWIN__)
70 /* http://archives.seul.org/or/talk/Aug-2006/msg00210.html */
71 #define MAXCONNECTIONS 3200
73 /* very high by default. "nobody should need more than this..." */
74 #define MAXCONNECTIONS 15000
82 #define snprintf _snprintf
89 #include "container.h"
95 /* These signals are defined to help control_signal_act work.
112 /* Controller signals start at a high number so we don't
113 * conflict with system-defined signals. */
114 #define SIGNEWNYM 129
115 #define SIGCLEARDNSCACHE 130
117 #if (SIZEOF_CELL_T != 0)
118 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
119 * that our stuff always calls cell_t something different. */
120 #define cell_t tor_cell_t
123 /** Undefine this when it's time to stop generating v1 directories. */
124 // #define FULL_V1_DIRECTORIES
125 /** Undefine this when it's time to stop includeing bandwidth info in router
127 #define INCLUDE_BW_INFO_IN_ROUTERDESCS
129 /** Length of longest allowable configured nickname. */
130 #define MAX_NICKNAME_LEN 19
131 /** Length of a router identity encoded as a hexadecimal digest, plus
132 * possible dollar sign. */
133 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
134 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
135 * equal sign or tilde, nickname. */
136 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
138 /** Maximum size, in bytes, for resized buffers. */
139 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
140 /** Maximum size, in bytes, for any directory object that we've downloaded. */
141 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
143 /** For http parsing: Maximum number of bytes we'll accept in the headers
144 * of an HTTP request or response. */
145 #define MAX_HEADERS_SIZE 50000
146 /** Maximum size, in bytes, for any directory object that we're accepting
148 #define MAX_DIR_UL_SIZE 500000
150 /** How long do we keep DNS cache entries before purging them (regardless of
152 #define MAX_DNS_ENTRY_AGE (30*60)
153 /** How long do we cache/tell clients to cache DNS records when no TTL is
155 #define DEFAULT_DNS_TTL (30*60)
156 /** How long can a TTL be before we stop believing it? */
157 #define MAX_DNS_TTL (3*60*60)
158 /** How small can a TTL be before we stop believing it? Provides rudimentary
160 #define MIN_DNS_TTL (60)
162 /** How often do we rotate onion keys? */
163 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
164 /** How often do we rotate TLS contexts? */
165 #define MAX_SSL_KEY_LIFETIME (2*60*60)
167 /** How old do we allow a router to get before removing it
168 * from the router list? In seconds. */
169 #define ROUTER_MAX_AGE (60*60*48)
170 /** How old can a router get before we (as a server) will no longer
171 * consider it live? In seconds. */
172 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
173 /** How old do we let a saved descriptor get before force-removing it? */
174 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
175 /** How old do we let a networkstatus get before ignoring it? */
176 #define NETWORKSTATUS_MAX_AGE (60*60*24)
178 /** Possible rules for generating circuit IDs on an OR connection. */
180 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
181 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
182 /** The other side of a connection is an OP: never create circuits to it,
183 * and let it use any circuit ID it wants. */
184 CIRC_ID_TYPE_NEITHER
=2
187 #define _CONN_TYPE_MIN 3
188 /** Type for sockets listening for OR connections. */
189 #define CONN_TYPE_OR_LISTENER 3
190 /** A bidirectional TLS connection transmitting a sequence of cells.
191 * May be from an OR to an OR, or from an OP to an OR. */
192 #define CONN_TYPE_OR 4
193 /** A TCP connection from an onion router to a stream's destination. */
194 #define CONN_TYPE_EXIT 5
195 /** Type for sockets listening for SOCKS connections. */
196 #define CONN_TYPE_AP_LISTENER 6
197 /** A SOCKS proxy connection from the user application to the onion
199 #define CONN_TYPE_AP 7
200 /** Type for sockets listening for HTTP connections to the directory server. */
201 #define CONN_TYPE_DIR_LISTENER 8
202 /** Type for HTTP connections to the directory server. */
203 #define CONN_TYPE_DIR 9
204 /** Connection from the main process to a CPU worker process. */
205 #define CONN_TYPE_CPUWORKER 10
206 /** Type for listening for connections from user interface process. */
207 #define CONN_TYPE_CONTROL_LISTENER 11
208 /** Type for connections from user interface process. */
209 #define CONN_TYPE_CONTROL 12
210 /** Type for sockets listening for transparent connections redirected by pf or
212 #define CONN_TYPE_AP_TRANS_LISTENER 13
213 /** Type for sockets listening for transparent connections redirected by
215 #define CONN_TYPE_AP_NATD_LISTENER 14
216 /** Type for sockets listening for DNS requests. */
217 #define CONN_TYPE_AP_DNS_LISTENER 15
218 #define _CONN_TYPE_MAX 15
219 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
222 #define CONN_IS_EDGE(x) \
223 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
225 /** State for any listener connection. */
226 #define LISTENER_STATE_READY 0
228 #define _CPUWORKER_STATE_MIN 1
229 /** State for a connection to a cpuworker process that's idle. */
230 #define CPUWORKER_STATE_IDLE 1
231 /** State for a connection to a cpuworker process that's processing a
233 #define CPUWORKER_STATE_BUSY_ONION 2
234 #define _CPUWORKER_STATE_MAX 2
236 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
238 #define _OR_CONN_STATE_MIN 1
239 /** State for a connection to an OR: waiting for connect() to finish. */
240 #define OR_CONN_STATE_CONNECTING 1
241 /** State for a connection to an OR: waiting for proxy command to flush. */
242 #define OR_CONN_STATE_PROXY_FLUSHING 2
243 /** State for a connection to an OR: waiting for proxy response. */
244 #define OR_CONN_STATE_PROXY_READING 3
245 /** State for a connection to an OR: SSL is handshaking, not done yet. */
246 #define OR_CONN_STATE_HANDSHAKING 4
247 /** State for a connection to an OR: Ready to send/receive cells. */
248 #define OR_CONN_STATE_OPEN 5
249 #define _OR_CONN_STATE_MAX 5
251 #define _EXIT_CONN_STATE_MIN 1
252 /** State for an exit connection: waiting for response from dns farm. */
253 #define EXIT_CONN_STATE_RESOLVING 1
254 /** State for an exit connection: waiting for connect() to finish. */
255 #define EXIT_CONN_STATE_CONNECTING 2
256 /** State for an exit connection: open and ready to transmit data. */
257 #define EXIT_CONN_STATE_OPEN 3
258 /** State for an exit connection: waiting to be removed. */
259 #define EXIT_CONN_STATE_RESOLVEFAILED 4
260 #define _EXIT_CONN_STATE_MAX 4
262 /* The AP state values must be disjoint from the EXIT state values. */
263 #define _AP_CONN_STATE_MIN 5
264 /** State for a SOCKS connection: waiting for SOCKS request. */
265 #define AP_CONN_STATE_SOCKS_WAIT 5
266 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
267 * rendezvous descriptor. */
268 #define AP_CONN_STATE_RENDDESC_WAIT 6
269 /** The controller will attach this connection to a circuit; it isn't our
271 #define AP_CONN_STATE_CONTROLLER_WAIT 7
272 /** State for a SOCKS connection: waiting for a completed circuit. */
273 #define AP_CONN_STATE_CIRCUIT_WAIT 8
274 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
275 #define AP_CONN_STATE_CONNECT_WAIT 9
276 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
277 #define AP_CONN_STATE_RESOLVE_WAIT 10
278 /** State for a SOCKS connection: ready to send and receive. */
279 #define AP_CONN_STATE_OPEN 11
280 /** State for a transparent natd connection: waiting for original
282 #define AP_CONN_STATE_NATD_WAIT 12
283 #define _AP_CONN_STATE_MAX 12
285 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
286 * edge connection is not attached to any circuit. */
287 #define AP_CONN_STATE_IS_UNATTACHED(s) \
288 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
290 #define _DIR_CONN_STATE_MIN 1
291 /** State for connection to directory server: waiting for connect(). */
292 #define DIR_CONN_STATE_CONNECTING 1
293 /** State for connection to directory server: sending HTTP request. */
294 #define DIR_CONN_STATE_CLIENT_SENDING 2
295 /** State for connection to directory server: reading HTTP response. */
296 #define DIR_CONN_STATE_CLIENT_READING 3
297 /** State for connection to directory server: happy and finished. */
298 #define DIR_CONN_STATE_CLIENT_FINISHED 4
299 /** State for connection at directory server: waiting for HTTP request. */
300 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
301 /** State for connection at directory server: sending HTTP response. */
302 #define DIR_CONN_STATE_SERVER_WRITING 6
303 #define _DIR_CONN_STATE_MAX 6
305 /** True iff the purpose of <b>conn</b> means that it's a server-side
306 * directory connection. */
307 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
309 #define _CONTROL_CONN_STATE_MIN 1
310 /** State for a control connection: Authenticated and accepting v1 commands. */
311 #define CONTROL_CONN_STATE_OPEN 1
312 /** State for a control connection: Waiting for authentication; speaking
314 #define CONTROL_CONN_STATE_NEEDAUTH 2
315 #define _CONTROL_CONN_STATE_MAX 2
317 #define _DIR_PURPOSE_MIN 1
318 /** A connection to a directory server: download a directory. */
319 #define DIR_PURPOSE_FETCH_DIR 1
320 /** A connection to a directory server: download just the list
321 * of running routers. */
322 #define DIR_PURPOSE_FETCH_RUNNING_LIST 2
323 /** A connection to a directory server: download a rendezvous
325 #define DIR_PURPOSE_FETCH_RENDDESC 3
326 /** A connection to a directory server: set after a rendezvous
327 * descriptor is downloaded. */
328 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
329 /** A connection to a directory server: download one or more network-status
331 #define DIR_PURPOSE_FETCH_NETWORKSTATUS 5
332 /** A connection to a directory server: download one or more server
334 #define DIR_PURPOSE_FETCH_SERVERDESC 6
335 /** A connection to a directory server: download one or more extra-info
337 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
338 /** A connection to a directory server: upload a server descriptor. */
339 #define DIR_PURPOSE_UPLOAD_DIR 8
340 /** A connection to a directory server: upload a rendezvous
342 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
343 /** A connection to a directory server: upload a v3 networkstatus vote. */
344 #define DIR_PURPOSE_UPLOAD_VOTE 10
345 /** A connection to a directory server: fetch a v3 networkstatus vote. */
346 #define DIR_PURPOSE_FETCH_VOTE 11
347 /** A connection to a directory server: upload a v3 consensus signature */
348 #define DIR_PURPOSE_UPLOAD_SIGNATURES 12
349 /** A connection to a directory server: download one or more network-status
351 #define DIR_PURPOSE_FETCH_STATUS_VOTE 13
352 /** A connection to a directory server: download one or more network-status
354 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 14
355 /** A connection to a directory server: download one or more network-status
357 #define DIR_PURPOSE_FETCH_CONSENSUS 15
358 /** A connection to a directory server: download one or more network-status
360 #define DIR_PURPOSE_FETCH_CERTIFICATE 16
362 /** Purpose for connection at a directory server. */
363 #define DIR_PURPOSE_SERVER 17
364 #define _DIR_PURPOSE_MAX 17
366 #define _EXIT_PURPOSE_MIN 1
367 /** This exit stream wants to do an ordinary connect. */
368 #define EXIT_PURPOSE_CONNECT 1
369 /** This exit stream wants to do a resolve (either normal or reverse). */
370 #define EXIT_PURPOSE_RESOLVE 2
371 #define _EXIT_PURPOSE_MAX 2
373 /* !!!! If any connection purpose is ever over over 31, we must grow the type
374 * field in connection_t. */
376 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
377 #define CIRCUIT_STATE_BUILDING 0
378 /** Circuit state: Waiting to process the onionskin. */
379 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
380 /** Circuit state: I'd like to deliver a create, but my n_conn is still
382 #define CIRCUIT_STATE_OR_WAIT 2
383 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
384 #define CIRCUIT_STATE_OPEN 3
386 #define _CIRCUIT_PURPOSE_MIN 1
388 /* these circuits were initiated elsewhere */
389 #define _CIRCUIT_PURPOSE_OR_MIN 1
390 /** OR-side circuit purpose: normal circuit, at OR. */
391 #define CIRCUIT_PURPOSE_OR 1
392 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
393 #define CIRCUIT_PURPOSE_INTRO_POINT 2
394 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
395 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
396 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
397 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
398 #define _CIRCUIT_PURPOSE_OR_MAX 4
400 /* these circuits originate at this node */
402 /* here's how circ client-side purposes work:
403 * normal circuits are C_GENERAL.
404 * circuits that are c_introducing are either on their way to
405 * becoming open, or they are open and waiting for a
406 * suitable rendcirc before they send the intro.
407 * circuits that are c_introduce_ack_wait have sent the intro,
408 * but haven't gotten a response yet.
409 * circuits that are c_establish_rend are either on their way
410 * to becoming open, or they are open and have sent the
411 * establish_rendezvous cell but haven't received an ack.
412 * circuits that are c_rend_ready are open and have received a
413 * rend ack, but haven't heard from bob yet. if they have a
414 * buildstate->pending_final_cpath then they're expecting a
415 * cell from bob, else they're not.
416 * circuits that are c_rend_ready_intro_acked are open, and
417 * some intro circ has sent its intro and received an ack.
418 * circuits that are c_rend_joined are open, have heard from
419 * bob, and are talking to him.
421 /** Client-side circuit purpose: Normal circuit, with cpath. */
422 #define CIRCUIT_PURPOSE_C_GENERAL 5
423 /** Client-side circuit purpose: at Alice, connecting to intro point. */
424 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
425 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
426 * waiting for ACK/NAK. */
427 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
428 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
429 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
430 /** Client-side circuit purpose: at Alice, waiting for ack. */
431 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
432 /** Client-side circuit purpose: at Alice, waiting for Bob. */
433 #define CIRCUIT_PURPOSE_C_REND_READY 10
434 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
435 * has been acknowledged. */
436 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
437 /** Client-side circuit purpose: at Alice, rendezvous established. */
438 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
440 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
441 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
442 /** Hidden-service-side circuit purpose: at Bob, successfully established
444 #define CIRCUIT_PURPOSE_S_INTRO 14
445 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
446 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
447 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
448 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
449 /** A testing circuit; not meant to be used for actual traffic. */
450 #define CIRCUIT_PURPOSE_TESTING 17
451 /** A controller made this circuit and Tor should not use it. */
452 #define CIRCUIT_PURPOSE_CONTROLLER 18
453 #define _CIRCUIT_PURPOSE_MAX 18
455 /** True iff the circuit purpose <b>p</b> is for a circuit that
456 * originated at this node. */
457 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
458 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
460 /** How many circuits do we want simultaneously in-progress to handle
462 #define MIN_CIRCUITS_HANDLING_STREAM 2
464 #define RELAY_COMMAND_BEGIN 1
465 #define RELAY_COMMAND_DATA 2
466 #define RELAY_COMMAND_END 3
467 #define RELAY_COMMAND_CONNECTED 4
468 #define RELAY_COMMAND_SENDME 5
469 #define RELAY_COMMAND_EXTEND 6
470 #define RELAY_COMMAND_EXTENDED 7
471 #define RELAY_COMMAND_TRUNCATE 8
472 #define RELAY_COMMAND_TRUNCATED 9
473 #define RELAY_COMMAND_DROP 10
474 #define RELAY_COMMAND_RESOLVE 11
475 #define RELAY_COMMAND_RESOLVED 12
476 #define RELAY_COMMAND_BEGIN_DIR 13
478 #define RELAY_COMMAND_ESTABLISH_INTRO 32
479 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
480 #define RELAY_COMMAND_INTRODUCE1 34
481 #define RELAY_COMMAND_INTRODUCE2 35
482 #define RELAY_COMMAND_RENDEZVOUS1 36
483 #define RELAY_COMMAND_RENDEZVOUS2 37
484 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
485 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
486 #define RELAY_COMMAND_INTRODUCE_ACK 40
488 /* Reasons why an OR connection is closed */
489 #define END_OR_CONN_REASON_DONE 1
490 #define END_OR_CONN_REASON_TCP_REFUSED 2
491 #define END_OR_CONN_REASON_OR_IDENTITY 3
492 #define END_OR_CONN_REASON_TLS_CONNRESET 4 /* tls connection reset by peer */
493 #define END_OR_CONN_REASON_TLS_TIMEOUT 5
494 #define END_OR_CONN_REASON_TLS_NO_ROUTE 6 /* no route to host/net */
495 #define END_OR_CONN_REASON_TLS_IO_ERROR 7 /* tls read/write error */
496 #define END_OR_CONN_REASON_TLS_MISC 8
498 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
499 * documentation of these. */
500 #define END_STREAM_REASON_MISC 1
501 #define END_STREAM_REASON_RESOLVEFAILED 2
502 #define END_STREAM_REASON_CONNECTREFUSED 3
503 #define END_STREAM_REASON_EXITPOLICY 4
504 #define END_STREAM_REASON_DESTROY 5
505 #define END_STREAM_REASON_DONE 6
506 #define END_STREAM_REASON_TIMEOUT 7
507 /* 8 is unallocated for historical reasons. */
508 #define END_STREAM_REASON_HIBERNATING 9
509 #define END_STREAM_REASON_INTERNAL 10
510 #define END_STREAM_REASON_RESOURCELIMIT 11
511 #define END_STREAM_REASON_CONNRESET 12
512 #define END_STREAM_REASON_TORPROTOCOL 13
513 #define END_STREAM_REASON_NOTDIRECTORY 14
515 /* These high-numbered end reasons are not part of the official spec,
516 * and are not intended to be put in relay end cells. They are here
517 * to be more informative when sending back socks replies to the
519 /* XXXX 256 is no longer used; feel free to reuse it. */
520 /** We were unable to attach the connection to any circuit at all. */
521 /* XXXX the ways we use this one don't make a lot of sense. */
522 #define END_STREAM_REASON_CANT_ATTACH 257
523 /** We can't connect to any directories at all, so we killed our streams
524 * before they can time out. */
525 #define END_STREAM_REASON_NET_UNREACHABLE 258
526 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
527 * protocol in a way we couldn't handle. */
528 #define END_STREAM_REASON_SOCKSPROTOCOL 259
529 /** This is a transparent proxy connection, but we can't extract the original
530 * target address:port. */
531 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
532 /** This is a connection on the NATD port, and the destination IP:Port was
533 * either ill-formed or out-of-range. */
534 #define END_STREAM_REASON_INVALID_NATD_DEST 261
536 /** Bitwise-and this value with endreason to mask out all flags. */
537 #define END_STREAM_REASON_MASK 511
539 /** Bitwise-or this with the argument to control_event_stream_status
540 * to indicate that the reason came from an END cell. */
541 #define END_STREAM_REASON_FLAG_REMOTE 512
542 /** Bitwise-or this with the argument to control_event_stream_status
543 * to indicate that we already sent a CLOSED stream event. */
544 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
545 /** Bitwise-or this with endreason to indicate that we already sent
546 * a socks reply, and no further reply needs to be sent from
547 * connection_mark_unattached_ap(). */
548 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
550 /** Reason for remapping an AP connection's address: we have a cached
552 #define REMAP_STREAM_SOURCE_CACHE 1
553 /** Reason for remapping an AP connection's address: the exit node told us an
555 #define REMAP_STREAM_SOURCE_EXIT 2
557 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
558 #define RESOLVED_TYPE_HOSTNAME 0
559 #define RESOLVED_TYPE_IPV4 4
560 #define RESOLVED_TYPE_IPV6 6
561 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
562 #define RESOLVED_TYPE_ERROR 0xF1
564 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
565 * call; they only go to the controller for tracking */
566 /** We couldn't build a path for this circuit. */
567 #define END_CIRC_REASON_NOPATH -2
568 /** Catch-all "other" reason for closing origin circuits. */
569 #define END_CIRC_AT_ORIGIN -1
571 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
572 * documentation of these. */
573 #define _END_CIRC_REASON_MIN 0
574 #define END_CIRC_REASON_NONE 0
575 #define END_CIRC_REASON_TORPROTOCOL 1
576 #define END_CIRC_REASON_INTERNAL 2
577 #define END_CIRC_REASON_REQUESTED 3
578 #define END_CIRC_REASON_HIBERNATING 4
579 #define END_CIRC_REASON_RESOURCELIMIT 5
580 #define END_CIRC_REASON_CONNECTFAILED 6
581 #define END_CIRC_REASON_OR_IDENTITY 7
582 #define END_CIRC_REASON_OR_CONN_CLOSED 8
583 #define END_CIRC_REASON_FINISHED 9
584 #define END_CIRC_REASON_TIMEOUT 10
585 #define END_CIRC_REASON_DESTROYED 11
586 #define END_CIRC_REASON_NOSUCHSERVICE 12
587 #define _END_CIRC_REASON_MAX 12
589 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
590 * control_event_circuit_status() to indicate that the reason was
591 * passed through from a destroy or truncate cell. */
592 #define END_CIRC_REASON_FLAG_REMOTE 512
594 /** Length of 'y' portion of 'y.onion' URL. */
595 #define REND_SERVICE_ID_LEN 16
597 #define CELL_DIRECTION_IN 1
598 #define CELL_DIRECTION_OUT 2
601 #define CIRCWINDOW_START 10000
602 #define CIRCWINDOW_INCREMENT 1000
603 #define STREAMWINDOW_START 5000
604 #define STREAMWINDOW_INCREMENT 500
606 /** Initial value for both sides of a circuit transmission window when the
607 * circuit is initialized. Measured in cells. */
608 #define CIRCWINDOW_START 1000
609 /** Amount to increment a circuit window when we get a circuit SENDME. */
610 #define CIRCWINDOW_INCREMENT 100
611 /** Initial value on both sides of a stream transmission window when the
612 * stream is initialized. Measured in cells. */
613 #define STREAMWINDOW_START 500
614 /** Amount to increment a stream window when we get a stream SENDME. */
615 #define STREAMWINDOW_INCREMENT 50
619 #define CELL_PADDING 0
620 #define CELL_CREATE 1
621 #define CELL_CREATED 2
623 #define CELL_DESTROY 4
624 #define CELL_CREATE_FAST 5
625 #define CELL_CREATED_FAST 6
627 /** How long to test reachability before complaining to the user. */
628 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
630 /** Legal characters in a nickname. */
631 #define LEGAL_NICKNAME_CHARACTERS \
632 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
634 /** Name to use in client TLS certificates if no nickname is given. */
635 #define DEFAULT_CLIENT_NICKNAME "client"
637 /** Number of bytes in a SOCKS4 header. */
638 #define SOCKS4_NETWORK_LEN 8
640 /** Specified SOCKS5 status codes. */
642 SOCKS5_SUCCEEDED
= 0x00,
643 SOCKS5_GENERAL_ERROR
= 0x01,
644 SOCKS5_NOT_ALLOWED
= 0x02,
645 SOCKS5_NET_UNREACHABLE
= 0x03,
646 SOCKS5_HOST_UNREACHABLE
= 0x04,
647 SOCKS5_CONNECTION_REFUSED
= 0x05,
648 SOCKS5_TTL_EXPIRED
= 0x06,
649 SOCKS5_COMMAND_NOT_SUPPORTED
= 0x07,
650 SOCKS5_ADDRESS_TYPE_NOT_SUPPORTED
= 0x08,
651 } socks5_reply_status_t
;
655 * Relay command [1 byte]
656 * Recognized [2 bytes]
657 * Stream ID [2 bytes]
658 * Partial SHA-1 [4 bytes]
660 * Relay payload [498 bytes]
663 /** Number of bytes in a cell, minus cell header. */
664 #define CELL_PAYLOAD_SIZE 509
665 /** Number of bytes in a cell transmitted over the network. */
666 #define CELL_NETWORK_SIZE 512
668 /** Number of bytes in a relay cell's header (not including general cell
670 #define RELAY_HEADER_SIZE (1+2+2+4+2)
671 /** Largest number of bytes that can fit in a relay cell payload. */
672 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
674 typedef struct cell_t cell_t
;
675 /** Parsed onion routing cell. All communication between nodes
678 uint16_t circ_id
; /**< Circuit which received the cell. */
679 uint8_t command
; /**< Type of the cell: one of PADDING, CREATE, RELAY,
681 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
684 typedef struct packed_cell_t packed_cell_t
;
685 /** A cell as packed for writing to the network. */
686 struct packed_cell_t
{
687 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
688 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
691 /** A queue of cells on a circuit, waiting to be added to the
692 * or_connection_t's outbuf. */
693 typedef struct cell_queue_t
{
694 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
695 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
696 int n
; /**< The number of cells in the queue. */
699 /** Beginning of a RELAY cell payload. */
701 uint8_t command
; /**< The end-to-end relay command. */
702 uint16_t recognized
; /**< Used to tell whether cell is for us. */
703 uint16_t stream_id
; /**< Which stream is this cell associated with? */
704 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
705 uint16_t length
; /**< How long is the payload body? */
708 typedef struct buf_t buf_t
;
709 typedef struct socks_request_t socks_request_t
;
711 /* Values for connection_t.magic: used to make sure that downcasts (casts from
712 * connection_t to foo_connection_t) are safe. */
713 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
714 #define OR_CONNECTION_MAGIC 0x7D31FF03u
715 #define EDGE_CONNECTION_MAGIC 0xF0374013u
716 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
717 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
719 /** Description of a connection to another host or process, and associated
722 * A connection is named based on what it's connected to -- an "OR
723 * connection" has a Tor node on the other end, an "exit
724 * connection" has a website or other server on the other end, and an
725 * "AP connection" has an application proxy (and thus a user) on the
728 * Every connection has a type and a state. Connections never change
729 * their type, but can go through many state changes in their lifetime.
731 * Every connection has two associated input and output buffers.
732 * Listeners don't use them. For non-listener connections, incoming
733 * data is appended to conn->inbuf, and outgoing data is taken from
734 * conn->outbuf. Connections differ primarily in the functions called
735 * to fill and drain these buffers.
737 typedef struct connection_t
{
738 uint32_t magic
; /**< For memory debugging: must equal one of
739 * *_CONNECTION_MAGIC. */
741 uint8_t state
; /**< Current state of this connection. */
742 uint8_t type
:4; /**< What kind of connection is this? */
743 uint8_t purpose
:5; /**< Only used for DIR and EXIT types currently. */
745 /* The next fields are all one-bit booleans. Some are only applicable to
746 * connection subtypes, but we hold them here anyway, to save space.
747 * (Currently, they all fit into a single byte. If they ever need more than
748 * one byte, we can shave some bits off type, state, and purpose above, none
749 * of which is ever over 31.)
751 unsigned read_blocked_on_bw
:1; /**< Boolean: should we start reading again
752 * once the bandwidth throttler allows it? */
753 unsigned write_blocked_on_bw
:1; /**< Boolean: should we start writing again
754 * once the bandwidth throttler allows reads? */
755 unsigned hold_open_until_flushed
:1; /**< Despite this connection's being
756 * marked for close, do we flush it
757 * before closing it? */
758 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
760 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
761 * connections. Set once we've set the stream end,
762 * and check in connection_about_to_close_connection().
764 /** Edge connections only: true if we've blocked writing until the
765 * circuit has fewer queued cells. */
766 unsigned int edge_blocked_on_circ
:1;
767 /** Used for OR conns that shouldn't get any new circs attached to them. */
768 unsigned int or_is_obsolete
:1;
769 /** For AP connections only. If 1, and we fail to reach the chosen exit,
770 * stop requiring it. */
771 unsigned int chosen_exit_optional
:1;
773 /* For linked connections:
775 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
776 /** True iff we'd like to be notified about read events from the
778 unsigned int reading_from_linked_conn
:1;
779 /** True iff we're willing to write to the linked conn. */
780 unsigned int writing_to_linked_conn
:1;
781 /** True iff we're currently able to read on the linked conn, and our
782 * read_event should be made active with libevent. */
783 unsigned int active_on_link
:1;
785 int s
; /**< Our socket; -1 if this connection is closed, or has no
787 int conn_array_index
; /**< Index into the global connection array. */
788 struct event
*read_event
; /**< Libevent event structure. */
789 struct event
*write_event
; /**< Libevent event structure. */
790 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
791 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
792 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
794 time_t timestamp_lastread
; /**< When was the last time libevent said we could
796 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
798 time_t timestamp_created
; /**< When was this connection_t created? */
800 /* XXXX020 make this ipv6-capable */
801 int socket_family
; /**< Address family of this connection's socket. Usually
802 * AF_INET, but it can also be AF_UNIX, or in the future
804 uint32_t addr
; /**< IP of the other side of the connection; used to identify
805 * routers, along with port. */
806 uint16_t port
; /**< If non-zero, port on the other end
807 * of the connection. */
808 uint16_t marked_for_close
; /**< Should we close this conn on the next
809 * iteration of the main loop? (If true, holds
810 * the line number where this connection was
812 const char *marked_for_close_file
; /**< For debugging: in which file were
813 * we marked for close? */
814 char *address
; /**< FQDN (or IP) of the guy on the other end.
815 * strdup into this, because free_connection frees it. */
816 /** Annother connection that's connected to this one in lieu of a socket. */
817 struct connection_t
*linked_conn
;
819 /* XXXX020 move this into a subtype!!! */
820 struct evdns_server_port
*dns_server_port
;
824 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
826 typedef struct or_connection_t
{
829 /** Hash of the public RSA key for the other side's identity key, or zeroes
830 * if the other side hasn't shown us a valid identity key. */
831 char identity_digest
[DIGEST_LEN
];
832 char *nickname
; /**< Nickname of OR on other side (if any). */
834 tor_tls_t
*tls
; /**< TLS connection state. */
835 int tls_error
; /**< Last tor_tls error code. */
836 /** When we last used this conn for any client traffic. If not
837 * recent, we can rate limit it further. */
840 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
841 * connection, which half of the space should
843 uint16_t next_circ_id
; /**< Which circ_id do we try to use next on
844 * this connection? This is always in the
845 * range 0..1<<15-1. */
847 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
849 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
850 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
851 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
852 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
853 * add 'bandwidthrate' to this, capping it at
854 * bandwidthburst. (OPEN ORs only) */
855 int n_circuits
; /**< How many circuits use this connection as p_conn or
858 /** Double-linked ring of circuits with queued cells waiting for room to
859 * free up on this connection's outbuf. Every time we pull cells from a
860 * circuit, we advance this pointer to the next circuit in the ring. */
861 struct circuit_t
*active_circuits
;
862 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
863 * identity digest as this one. */
866 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
867 * connection, or an exit. */
868 typedef struct edge_connection_t
{
871 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
873 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
874 * this conn exits at. */
875 int package_window
; /**< How many more relay cells can I send into the
877 int deliver_window
; /**< How many more relay cells can end at me? */
879 /** Nickname of planned exit node -- used with .exit support. */
880 char *chosen_exit_name
;
882 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
884 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
885 * connection is using. */
887 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
888 * connection. Exit connections only. */
890 uint16_t stream_id
; /**< The stream ID used for this edge connection on its
893 /** The reason why this connection is closing; passed to the controller. */
896 /** Quasi-global identifier for this connection; used for control.c */
897 /* XXXX NM This can get re-used after 2**32 streams */
898 uint32_t global_identifier
;
900 /** Bytes read since last call to control_event_stream_bandwidth_used() */
903 /** Bytes written since last call to control_event_stream_bandwidth_used() */
906 char rend_query
[REND_SERVICE_ID_LEN
+1]; /**< What rendezvous service are we
907 * querying for? (AP only) */
909 /** Number of times we've reassigned this application connection to
910 * a new circuit. We keep track because the timeout is longer if we've
911 * already retried several times. */
912 uint8_t num_socks_retries
;
914 /** True iff this connection is for a dns request only. */
915 unsigned int is_dns_request
: 1;
917 /** If this is a DNSPort connection, this field holds the pending DNS
918 * request that we're going to try to answer. */
919 struct evdns_server_request
*dns_server_request
;
923 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
924 * connection to retrieve or serve directory material. */
925 typedef struct dir_connection_t
{
928 char *requested_resource
; /**< Which 'resource' did we ask the directory
930 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
932 /* Used only for server sides of some dir connections, to implement
933 * "spooling" of directory material to the outbuf. Otherwise, we'd have
934 * to append everything to the outbuf in one enormous chunk. */
935 /** What exactly are we spooling right now? */
937 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
938 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
939 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
941 /** If we're fetching descriptors, what router purpose shall we assign
943 uint8_t router_purpose
;
944 /** List of fingerprints for networkstatuses or desriptors to be spooled. */
945 smartlist_t
*fingerprint_stack
;
946 /** A cached_dir_t object that we're currently spooling out */
947 struct cached_dir_t
*cached_dir
;
948 /** The current offset into cached_dir. */
949 off_t cached_dir_offset
;
950 /** The zlib object doing on-the-fly compression for spooled data. */
951 tor_zlib_state_t
*zlib_state
;
953 char rend_query
[REND_SERVICE_ID_LEN
+1]; /**< What rendezvous service are we
956 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
957 * the directory server's signing key. */
961 /** Subtype of connection_t for an connection to a controller. */
962 typedef struct control_connection_t
{
965 uint32_t event_mask
; /**< Bitfield: which events does this controller
967 unsigned int use_long_names
:1; /**< True if we should use long nicknames
968 * on this (v1) connection. Only settable
969 * via v1 controllers. */
970 /** For control connections only. If set, we send extended info with control
971 * events as appropriate. */
972 unsigned int use_extended_events
:1;
974 /** True if we have sent a protocolinfo reply on this connection. */
975 unsigned int have_sent_protocolinfo
:1;
977 uint32_t incoming_cmd_len
;
978 uint32_t incoming_cmd_cur_len
;
980 /* Used only by control v0 connections */
981 uint16_t incoming_cmd_type
;
982 } control_connection_t
;
984 /** Cast a connection_t subtype pointer to a connection_t **/
985 #define TO_CONN(c) (&(((c)->_base)))
986 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
987 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
989 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
991 static or_connection_t
*TO_OR_CONN(connection_t
*);
992 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
994 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
995 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
997 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
998 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1000 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1002 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1004 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1005 return DOWNCAST(or_connection_t
, c
);
1007 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1009 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1010 return DOWNCAST(dir_connection_t
, c
);
1012 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1014 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1015 return DOWNCAST(edge_connection_t
, c
);
1017 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1019 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1020 return DOWNCAST(control_connection_t
, c
);
1024 ADDR_POLICY_ACCEPT
=1,
1025 ADDR_POLICY_REJECT
=2,
1026 } addr_policy_action_t
;
1028 /** A linked list of policy rules */
1029 typedef struct addr_policy_t
{
1030 addr_policy_action_t policy_type
; /**< What to do when the policy matches.*/
1031 char *string
; /**< String representation of this rule. */
1033 /* XXXX020 make this ipv6-capable */
1034 uint32_t addr
; /**< Base address to accept or reject. */
1035 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1036 * first <b>maskbits</b> bits of <b>a</b> match
1038 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1039 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1041 struct addr_policy_t
*next
; /**< Next rule in list. */
1044 /** A cached_dir_t represents a cacheable directory object, along with its
1045 * compressed form. */
1046 typedef struct cached_dir_t
{
1047 char *dir
; /**< Contents of this object */
1048 char *dir_z
; /**< Compressed contents of this object. */
1049 size_t dir_len
; /**< Length of <b>dir</b> */
1050 size_t dir_z_len
; /**< Length of <b>dir_z</b> */
1051 time_t published
; /**< When was this object published */
1052 int refcnt
; /**< Reference count for this cached_dir_t. */
1055 /** Enum used to remember where a signed_descriptor_t is stored and how to
1056 * manage the memory for signed_descriptor_body. */
1058 /** The descriptor isn't stored on disk at all: the copy in memory is
1059 * canonical; the saved_offset field is meaningless. */
1061 /** The descriptor is stored in the cached_routers file: the
1062 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1063 * saved_offset are used to index into the mmaped cache file. */
1065 /** The descriptor is stored in the cached_routers.new file: the
1066 * signed_descriptor_body and saved_offset fields are both set. */
1067 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1068 * lazy-load the descriptor text by using seek and read. We don't, for
1074 /** Information about our plans for retrying downloads for a downloadable
1076 typedef struct download_status_t
{
1077 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1079 uint8_t n_download_failures
; /**< Number of failures trying to download the
1080 * most recent descriptor. */
1081 } download_status_t
;
1083 /** Information need to cache an onion router's descriptor. */
1084 typedef struct signed_descriptor_t
{
1085 /** Pointer to the raw server descriptor, preceeded by annotatinos. Not
1086 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1087 * pointer is null. */
1088 char *signed_descriptor_body
;
1089 /** Length of the annotations preceeding the server descriptor. */
1090 size_t annotations_len
;
1091 /** Length of the server descriptor. */
1092 size_t signed_descriptor_len
;
1093 /** Digest of the server descriptor, computed as specified in dir-spec.txt */
1094 char signed_descriptor_digest
[DIGEST_LEN
];
1095 /** Identity digest of the router. */
1096 char identity_digest
[DIGEST_LEN
];
1097 /** Declared publication time of the descriptor */
1098 time_t published_on
;
1099 /** For routerdescs only: digest of the corresponding extrainfo. */
1100 char extra_info_digest
[DIGEST_LEN
];
1101 /** For routerdescs only: Status of downloading the corresponding
1103 download_status_t ei_dl_status
;
1104 /** Where is the descriptor saved? */
1105 saved_location_t saved_location
;
1106 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1107 * this descriptor in the corresponding file. */
1109 /* If true, we do not ever try to save this object in the cache. */
1110 unsigned int do_not_cache
: 1;
1111 /* If true, this item is meant to represent an extrainfo. */
1112 unsigned int is_extrainfo
: 1;
1113 } signed_descriptor_t
;
1115 /** Information about another onion router in the network. */
1117 signed_descriptor_t cache_info
;
1118 char *address
; /**< Location of OR: either a hostname or an IP address. */
1119 char *nickname
; /**< Human-readable OR name. */
1121 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1122 uint16_t or_port
; /**< Port for TLS connections. */
1123 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1125 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1126 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1128 char *platform
; /**< What software/operating system is this OR using? */
1131 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1132 * bucket per second? */
1133 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1134 /** How many bytes/s is this router known to handle? */
1135 uint32_t bandwidthcapacity
;
1136 addr_policy_t
*exit_policy
; /**< What streams will this OR permit
1138 long uptime
; /**< How many seconds the router claims to have been up */
1139 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1140 * claims are its family. */
1141 char *contact_info
; /**< Declared contact info for this router. */
1142 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1144 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1145 * dnsworker code. */
1146 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1147 * extrainfo documents. */
1150 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1152 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1153 * (For Authdir: Have we validated this OR?)
1155 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1157 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1158 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1159 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1160 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1161 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1162 * or otherwise nasty? */
1164 /** Tor can use this router for general positions in circuits. */
1165 #define ROUTER_PURPOSE_GENERAL 0
1166 /** Tor should avoid using this router for circuit-building. */
1167 #define ROUTER_PURPOSE_CONTROLLER 1
1168 /** Tor should use this router only for bridge positions in circuits. */
1169 #define ROUTER_PURPOSE_BRIDGE 2
1170 /** Tor should not use this router; it was marked in cached-descriptors with
1171 * a purpose we didn't recognize. */
1172 #define ROUTER_PURPOSE_UNKNOWN 255
1174 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1176 /* The below items are used only by authdirservers for
1177 * reachability testing. */
1178 /** When was the last time we could reach this OR? */
1179 time_t last_reachable
;
1180 /** When did we start testing reachability for this OR? */
1181 time_t testing_since
;
1182 /** How many times has a descriptor been posted and we believed
1183 * this router to be unreachable? We only actually warn on the third. */
1184 int num_unreachable_notifications
;
1186 /** What position is this descriptor within routerlist->routers? -1 for
1188 int routerlist_index
;
1192 * XXXX020 remove this; purpose should have the same value for router
1195 #define EXTRAINFO_PURPOSE_GENERAL 0
1197 /** Information needed to keep and cache a signed extra-info document. */
1198 typedef struct extrainfo_t
{
1199 signed_descriptor_t cache_info
;
1200 /** The router's nickname. */
1201 char nickname
[MAX_NICKNAME_LEN
+1];
1202 /** True iff we found the right key for this extra-info, verified the
1203 * signature, and found it to be bad. */
1204 unsigned int bad_sig
: 1;
1205 /** If present, we didn't have the right key to verify this extra-info,
1206 * so this is a copy of the signature in the document. */
1208 /** Length of pending_sig. */
1209 size_t pending_sig_len
;
1212 /** Contents of a single router entry in a network status object.
1214 typedef struct routerstatus_t
{
1215 time_t published_on
; /**< When was this router published? */
1216 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1218 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1220 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1222 uint32_t addr
; /**< IPv4 address for this router. */
1223 uint16_t or_port
; /**< OR port for this router. */
1224 uint16_t dir_port
; /**< Directory port for this router. */
1225 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1226 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1227 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1228 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1229 unsigned int is_running
:1; /**< True iff this router is up. */
1230 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1231 unsigned int is_valid
:1; /**< True iff this router is validated. */
1232 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1233 * information with v2 of the directory
1234 * protocol. (All directory caches cache v1
1236 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1237 * choice as an entry guard. */
1238 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1240 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1241 * underpowered, or otherwise useless? */
1242 /** True iff we know version info for this router. (i.e., a "v" entry was
1243 * included.) We'll replace all these with a big tor_version_t or a char[]
1244 * if the number of traits we care about ever becomes incredibly big. */
1245 unsigned int version_known
:1;
1246 /** True iff this router is a version that supports BEGIN_DIR cells. */
1247 unsigned int version_supports_begindir
:1;
1248 /** True iff this router is a version that we can post extrainfo docs to. */
1249 unsigned int version_supports_extrainfo_upload
:1;
1250 /** True iff this router is a version that, if it caches directory info,
1251 * we can get v3 downloads from. */
1252 unsigned int version_supports_v3_dir
:1;
1254 /** True if we, as a directory mirror, want to download the corresponding
1255 * routerinfo from the authority who gave us this routerstatus. (That is,
1256 * if we don't have the routerinfo, and if we haven't already tried to get it
1257 * from this authority.)
1259 unsigned int need_to_mirror
:1;
1262 /** Our "local" or combined view of the info from all networkstatus objects
1263 * about a single router. */
1264 typedef struct local_routerstatus_t
{
1265 /** What do we believe to be the case about this router? In this field,
1266 * descriptor_digest represents the descriptor we would most like to use for
1268 routerstatus_t status
;
1269 time_t last_dir_503_at
; /**< When did this router last tell us that it
1270 * was too busy to serve directory info? */
1271 download_status_t dl_status
;
1272 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1273 * to this (unnamed) router by nickname?
1275 } local_routerstatus_t
;
1277 /** How many times will we try to download a router's descriptor before giving
1279 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1281 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1282 typedef struct networkstatus_t
{
1283 /** When did we receive the network-status document? */
1286 /** What was the digest of the document? */
1287 char networkstatus_digest
[DIGEST_LEN
];
1289 unsigned int is_recent
; /**< Is this recent enough to influence running
1292 /* These fields come from the actual network-status document.*/
1293 time_t published_on
; /**< Declared publication date. */
1295 char *source_address
; /**< Canonical directory server hostname. */
1296 uint32_t source_addr
; /**< Canonical directory server IP. */
1297 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1299 unsigned int binds_names
:1; /**< True iff this directory server binds
1301 unsigned int recommends_versions
:1; /**< True iff this directory server
1302 * recommends client and server software
1304 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1305 * malfunctioning exits as bad. */
1306 /** True iff this directory server marks malfunctioning directories as
1308 unsigned int lists_bad_directories
:1;
1310 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1311 char *contact
; /**< How to contact directory admin? (may be NULL). */
1312 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1313 char *client_versions
; /**< comma-separated list of recommended client
1315 char *server_versions
; /**< comma-separated list of recommended server
1318 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1319 * sorted by identity_digest. */
1322 /** The claim about a single router, make in a vote. */
1323 typedef struct vote_routerstatus_t
{
1324 routerstatus_t status
; /**< Underlying 'status' object for this router.
1325 * Flags are redundant. */
1326 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1327 * networkstatus_vote_t.known_flags. */
1328 char *version
; /**< The version that the authority says this router is
1330 } vote_routerstatus_t
;
1332 /* Information about a single voter in a vote or a consensus. */
1333 typedef struct networkstatus_voter_info_t
{
1334 char *nickname
; /**< Nickname of this voter */
1335 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1336 char *address
; /**< Address of this voter, in string format. */
1337 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1338 uint16_t dir_port
; /**< Directory port of this voter */
1339 uint16_t or_port
; /**< OR port of this voter */
1340 char *contact
; /**< Contact information for this voter. */
1341 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1344 char signing_key_digest
[DIGEST_LEN
]; /* This part is _not_ signed. */
1347 unsigned int bad_signature
: 1;
1348 unsigned int good_signature
: 1;
1349 } networkstatus_voter_info_t
;
1351 /** A common structure to hold a v2 network status vote, or a v2 network
1352 * status consensus. */
1353 /* XXXX020 rename to networkstatus_t once it replaces networkstatus_t in
1355 typedef struct networkstatus_vote_t
{
1356 int is_vote
; /**< True if this is a vote; false if it is a consensus. */
1357 time_t published
; /**< Vote only: Tiem when vote was written. */
1358 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1359 time_t fresh_until
; /**< Time before which this is the most recent vote or
1361 time_t valid_until
; /**< Time after which this vote or consensus should not
1364 /** How long does this vote/consensus claim that authorities take to
1365 * distribute their votes to one another? */
1367 /** How long does this vote/consensus claim that authorites take to
1368 * distribute their consensus signatures to one another? */
1371 /** Comma-separated list of recommended client software, or NULL if this
1372 * voter has no opinion. */
1373 char *client_versions
;
1374 char *server_versions
;
1375 /** List of flags that this vote/consensus applies to routers. If a flag is
1376 * not listed here, the voter has no opinion on what its value should be. */
1377 smartlist_t
*known_flags
;
1379 /** List of networkstatus_voter_info_t. For a vote, only one element
1380 * is included. For a consensus, one element is included for every voter
1381 * whose vote contributed to the consensus. */
1382 smartlist_t
*voters
;
1384 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1386 /** Digest of this document, as signed. */
1387 char networkstatus_digest
[DIGEST_LEN
];
1389 /** List of router statuses, sorted by identity digest. For a vote,
1390 * the elements are vote_routerstatus_t; for a consensus, the elements
1391 * are routerstatus_t. */
1392 smartlist_t
*routerstatus_list
;
1393 } networkstatus_vote_t
;
1395 /** A set of signatures for a networkstatus consensus. All fields are as for
1396 * networkstatus_vote_t. */
1397 typedef struct ns_detached_signatures_t
{
1401 char networkstatus_digest
[DIGEST_LEN
];
1402 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1403 } ns_detached_signatures_t
;
1405 /** Allowable types of desc_store_t. */
1406 typedef enum store_type_t
{
1411 /** A 'store' is a set of descriptors saved on disk, with accompanying
1412 * journal, mmaped as needed, rebuilt as needed. */
1413 typedef struct desc_store_t
{
1414 /** Filename (within DataDir) for the store. We append .tmp to this
1415 * filename for a temporary file when rebuilding the store, and .new to this
1416 * filename for the journal. */
1417 const char *fname_base
;
1418 /** Alternative (obsolete) value for fname_base: if the file named by
1419 * fname_base isn't present, we read from here instead, but we never write
1421 const char *fname_alt_base
;
1422 /** Human-readable description of what this store contains. */
1423 const char *description
;
1425 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1427 store_type_t type
; /**< What's stored in this store? */
1429 /** The size of the router log, in bytes. */
1431 /** The size of the router store, in bytes. */
1433 /** Total bytes dropped since last rebuild: this is space currently
1434 * used in the cache and the journal that could be freed by a rebuild. */
1435 size_t bytes_dropped
;
1438 /** Contents of a directory of onion routers. */
1440 /** Map from server identity digest to a member of routers. */
1441 struct digest_ri_map_t
*identity_map
;
1442 /** Map from server descriptor digest to a signed_descriptor_t from
1443 * routers or old_routers. */
1444 struct digest_sd_map_t
*desc_digest_map
;
1445 /** Map from extra-info digest to an extrainfo_t. Only exists for
1446 * routers in routers or old_routers. */
1447 struct digest_ei_map_t
*extra_info_map
;
1448 /** Map from extra-info digests to a signed_descriptor_t for a router
1449 * descriptor having that extra-info digest. Only exists for
1450 * routers in routers or old_routers. */
1451 struct digest_sd_map_t
*desc_by_eid_map
;
1452 /** List of routerinfo_t for all currently live routers we know. */
1453 smartlist_t
*routers
;
1454 /** List of signed_descriptor_t for older router descriptors we're
1456 smartlist_t
*old_routers
;
1457 /** Store holding server descriptors. If present, any router whose
1458 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1459 * starting at cache_info.saved_offset */
1460 desc_store_t desc_store
;
1461 /** Store holding extra-info documents. */
1462 desc_store_t extrainfo_store
;
1465 /** Information on router used when extending a circuit. We don't need a
1466 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1467 * connection, and onion_key to create the onionskin. Note that for onehop
1468 * general-purpose tunnels, the onion_key is NULL. */
1469 typedef struct extend_info_t
{
1470 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1472 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1473 uint16_t port
; /**< OR port. */
1474 // uint8_t router_purpose; /**< General, controller, or bridge. */
1475 uint32_t addr
; /**< IP address in host order. */
1476 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1479 /** Certificate for v3 directory protocol: binds long-term authority identity
1480 * keys to medium-term authority signing keys. */
1481 typedef struct authority_cert_t
{
1482 signed_descriptor_t cache_info
;
1483 crypto_pk_env_t
*identity_key
;
1484 crypto_pk_env_t
*signing_key
;
1485 char signing_key_digest
[DIGEST_LEN
];
1489 /** Bitfield enum type listing types of directory authority/directory
1493 V1_AUTHORITY
= 1 << 0,
1494 V2_AUTHORITY
= 1 << 1,
1495 V3_AUTHORITY
= 1 << 2,
1496 HIDSERV_AUTHORITY
= 1 << 3,
1497 BRIDGE_AUTHORITY
= 1 << 4,
1498 EXTRAINFO_CACHE
= 1 << 5, /* not precisely an authority type. */
1501 #define CRYPT_PATH_MAGIC 0x70127012u
1503 /** Holds accounting information for a single step in the layered encryption
1504 * performed by a circuit. Used only at the client edge of a circuit. */
1505 typedef struct crypt_path_t
{
1508 /* crypto environments */
1509 /** Encryption key and counter for cells heading towards the OR at this
1511 crypto_cipher_env_t
*f_crypto
;
1512 /** Encryption key and counter for cells heading back from the OR at this
1514 crypto_cipher_env_t
*b_crypto
;
1516 /** Digest state for cells heading towards the OR at this step. */
1517 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1518 /** Digest state for cells heading away from the OR at this step. */
1519 crypto_digest_env_t
*b_digest
;
1521 /** Current state of Diffie-Hellman key negotiation with the OR at this
1523 crypto_dh_env_t
*dh_handshake_state
;
1524 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1525 * step. Used to save CPU when TLS is already providing all the
1526 * authentication, secrecy, and integrity we need, and we're already
1527 * distinguishable from an OR.
1529 char fast_handshake_state
[DIGEST_LEN
];
1530 /** Negotiated key material shared with the OR at this step. */
1531 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1533 /** Information to extend to the OR at this step. */
1534 extend_info_t
*extend_info
;
1536 /** Is the circuit built to this step? Must be one of:
1537 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1538 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1539 * and not received an EXTENDED/CREATED)
1540 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1542 #define CPATH_STATE_CLOSED 0
1543 #define CPATH_STATE_AWAITING_KEYS 1
1544 #define CPATH_STATE_OPEN 2
1545 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1546 * (The list is circular, so the last node
1547 * links to the first.) */
1548 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1551 int package_window
; /**< How many bytes are we allowed to originate ending
1553 int deliver_window
; /**< How many bytes are we willing to deliver originating
1557 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1559 #define DH_KEY_LEN DH_BYTES
1560 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1563 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1564 #define REND_COOKIE_LEN DIGEST_LEN
1566 /** Information used to build a circuit. */
1568 /** Intended length of the final circuit. */
1569 int desired_path_len
;
1570 /** How to extend to the planned exit node. */
1571 extend_info_t
*chosen_exit
;
1572 /** Whether every node in the circ must have adequate uptime. */
1574 /** Whether every node in the circ must have adequate capacity. */
1576 /** Whether the last hop was picked with exiting in mind. */
1578 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1579 * These are for encrypted connections that exit to this router, not
1580 * for arbitrary exits from the circuit. */
1582 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1583 crypt_path_t
*pending_final_cpath
;
1584 /** How many times has building a circuit for this task failed? */
1586 /** At what time should we give up on this task? */
1588 } cpath_build_state_t
;
1590 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1591 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1593 typedef uint16_t circid_t
;
1596 * A circuit is a path over the onion routing
1597 * network. Applications can connect to one end of the circuit, and can
1598 * create exit connections at the other end of the circuit. AP and exit
1599 * connections have only one circuit associated with them (and thus these
1600 * connection types are closed when the circuit is closed), whereas
1601 * OR connections multiplex many circuits at once, and stay standing even
1602 * when there are no circuits running over them.
1604 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1605 * links two connections together: either an edge connection and an OR
1606 * connection, or two OR connections. (When joined to an OR connection, a
1607 * circuit_t affects only cells sent to a particular circID on that
1608 * connection. When joined to an edge connection, a circuit_t affects all
1611 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1612 * along a given circuit. At the OP, it has a sequence of ciphers, each
1613 * of which is shared with a single OR along the circuit. Separate
1614 * ciphers are used for data going "forward" (away from the OP) and
1615 * "backward" (towards the OP). At the OR, a circuit has only two stream
1616 * ciphers: one for data going forward, and one for data going backward.
1618 typedef struct circuit_t
{
1619 uint32_t magic
; /**< For memory and type debugging: must equal
1620 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1622 /** Queue of cells waiting to be transmitted on n_conn. */
1623 cell_queue_t n_conn_cells
;
1624 /** The OR connection that is next in this circuit. */
1625 or_connection_t
*n_conn
;
1626 /** The identity hash of n_conn. */
1627 char n_conn_id_digest
[DIGEST_LEN
];
1628 /** The circuit_id used in the next (forward) hop of this circuit. */
1630 /** The port for the OR that is next in this circuit. */
1632 /** The IPv4 address of the OR that is next in this circuit. */
1635 /** True iff we are waiting for n_conn_cells to become less full before
1636 * allowing p_streams to add any more cells. (Origin circuit only.) */
1637 unsigned int streams_blocked_on_n_conn
: 1;
1638 /** True iff we are waiting for p_conn_cells to become less full before
1639 * allowing n_streams to add any more cells. (OR circuit only.) */
1640 unsigned int streams_blocked_on_p_conn
: 1;
1642 uint8_t state
; /**< Current status of this circuit. */
1643 uint8_t purpose
; /**< Why are we creating this circuit? */
1645 /** How many relay data cells can we package (read from edge streams)
1646 * on this circuit before we receive a circuit-level sendme cell asking
1649 /** How many relay data cells will we deliver (write to edge streams)
1650 * on this circuit? When deliver_window gets low, we send some
1651 * circuit-level sendme cells to indicate that we're willing to accept
1655 /** For storage while passing to cpuworker (state
1656 * CIRCUIT_STATE_ONIONSKIN_PENDING), or while n_conn is pending
1657 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1658 * length ONIONSKIN_CHALLENGE_LEN. */
1661 time_t timestamp_created
; /**< When was this circuit created? */
1662 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1663 * circuit is clean. */
1665 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1666 * the main loop? (If true, holds the line number
1667 * where this circuit was marked.) */
1668 const char *marked_for_close_file
; /**< For debugging: in which file was this
1669 * circuit marked for close? */
1671 /** Next circuit in the doubly-linked ring of circuits waiting to add
1672 * cells to n_conn. NULL if we have no cells pending, or if we're not
1673 * linked to an OR connection. */
1674 struct circuit_t
*next_active_on_n_conn
;
1675 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1676 * cells to n_conn. NULL if we have no cells pending, or if we're not
1677 * linked to an OR connection. */
1678 struct circuit_t
*prev_active_on_n_conn
;
1679 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1682 /** An origin_circuit_t holds data necessary to build and use a circuit.
1684 typedef struct origin_circuit_t
{
1687 /** Linked list of AP streams (or EXIT streams if hidden service)
1688 * associated with this circuit. */
1689 edge_connection_t
*p_streams
;
1690 /** Build state for this circuit. It includes the intended path
1691 * length, the chosen exit router, rendezvous information, etc.
1693 cpath_build_state_t
*build_state
;
1694 /** The doubly-linked list of crypt_path_t entries, one per hop,
1695 * for this circuit. This includes ciphers for each hop,
1696 * integrity-checking digests for each hop, and package/delivery
1697 * windows for each hop.
1699 crypt_path_t
*cpath
;
1701 /** The rend_pk_digest field holds a hash of location-hidden service's
1702 * PK if purpose is S_ESTABLISH_INTRO or S_RENDEZVOUSING.
1704 char rend_pk_digest
[DIGEST_LEN
];
1706 /** Holds rendezvous cookie if purpose is C_ESTABLISH_REND. Filled with
1709 char rend_cookie
[REND_COOKIE_LEN
];
1712 * The rend_query field holds the y portion of y.onion (nul-terminated)
1713 * if purpose is C_INTRODUCING or C_ESTABLISH_REND, or is a C_GENERAL
1714 * for a hidden service, or is S_*.
1716 char rend_query
[REND_SERVICE_ID_LEN
+1];
1718 /** The next stream_id that will be tried when we're attempting to
1719 * construct a new AP stream originating at this circuit. */
1720 uint16_t next_stream_id
;
1722 /** Quasi-global identifier for this circuit; used for control.c */
1723 /* XXXX NM This can get re-used after 2**32 circuits. */
1724 uint32_t global_identifier
;
1728 /** An or_circuit_t holds information needed to implement a circuit at an
1730 typedef struct or_circuit_t
{
1733 /** Next circuit in the doubly-linked ring of circuits waiting to add
1734 * cells to p_conn. NULL if we have no cells pending, or if we're not
1735 * linked to an OR connection. */
1736 struct circuit_t
*next_active_on_p_conn
;
1737 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1738 * cells to p_conn. NULL if we have no cells pending, or if we're not
1739 * linked to an OR connection. */
1740 struct circuit_t
*prev_active_on_p_conn
;
1742 /** The circuit_id used in the previous (backward) hop of this circuit. */
1744 /** Queue of cells waiting to be transmitted on p_conn. */
1745 cell_queue_t p_conn_cells
;
1746 /** The OR connection that is previous in this circuit. */
1747 or_connection_t
*p_conn
;
1748 /** Linked list of Exit streams associated with this circuit. */
1749 edge_connection_t
*n_streams
;
1750 /** Linked list of Exit streams associated with this circuit that are
1751 * still being resolved. */
1752 edge_connection_t
*resolving_streams
;
1753 /** The cipher used by intermediate hops for cells heading toward the
1755 crypto_cipher_env_t
*p_crypto
;
1756 /** The cipher used by intermediate hops for cells heading away from
1758 crypto_cipher_env_t
*n_crypto
;
1760 /** The integrity-checking digest used by intermediate hops, for
1761 * cells packaged here and heading towards the OP.
1763 crypto_digest_env_t
*p_digest
;
1764 /** The integrity-checking digest used by intermediate hops, for
1765 * cells packaged at the OP and arriving here.
1767 crypto_digest_env_t
*n_digest
;
1769 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
1770 * is not marked for close. */
1771 struct or_circuit_t
*rend_splice
;
1773 #if REND_COOKIE_LEN >= DIGEST_LEN
1774 #define REND_TOKEN_LEN REND_COOKIE_LEN
1776 #define REND_TOKEN_LEN DIGEST_LEN
1779 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
1780 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
1782 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
1784 char rend_token
[REND_TOKEN_LEN
];
1786 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
1787 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
1789 /** True iff this circuit was made with a CREATE_FAST cell. */
1790 unsigned int is_first_hop
: 1;
1793 /** Convert a circuit subtype to a circuit_t.*/
1794 #define TO_CIRCUIT(x) (&((x)->_base))
1796 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
1797 * if the cast is impossible. */
1798 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
1799 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
1800 * Asserts if the cast is impossible. */
1801 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
1803 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
1805 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
1806 return DOWNCAST(or_circuit_t
, x
);
1808 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
1810 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
1811 return DOWNCAST(origin_circuit_t
, x
);
1814 #define ALLOW_INVALID_ENTRY 1
1815 #define ALLOW_INVALID_EXIT 2
1816 #define ALLOW_INVALID_MIDDLE 4
1817 #define ALLOW_INVALID_RENDEZVOUS 8
1818 #define ALLOW_INVALID_INTRODUCTION 16
1820 /** An entry specifying a set of addresses and ports that should be remapped
1821 * to another address and port before exiting this exit node. */
1822 typedef struct exit_redirect_t
{
1823 /* XXXX020 make this whole mess ipv6-capable. (Does anybody use it? */
1828 maskbits_t maskbits
;
1832 unsigned is_redirect
:1;
1835 /* limits for TCP send and recv buffer size used for constrained sockets */
1836 #define MIN_CONSTRAINED_TCP_BUFFER 2048
1837 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
1839 /** A linked list of lines in a config file. */
1840 typedef struct config_line_t
{
1843 struct config_line_t
*next
;
1846 /** Configuration options for a Tor process. */
1850 /** What should the tor process actually do? */
1852 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
1853 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
1855 const char *command_arg
; /**< Argument for command-line option. */
1857 config_line_t
*Logs
; /**< New-style list of configuration lines
1860 char *DebugLogFile
; /**< Where to send verbose log messages. */
1861 char *DataDirectory
; /**< OR only: where to store long-term data. */
1862 char *Nickname
; /**< OR only: nickname of this onion router. */
1863 char *Address
; /**< OR only: configured address for this onion router. */
1864 char *PidFile
; /**< Where to store PID of Tor process. */
1866 char *ExitNodes
; /**< Comma-separated list of nicknames of ORs to consider
1868 char *EntryNodes
; /**< Comma-separated list of nicknames of ORs to consider
1869 * as entry points. */
1870 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
1871 * stop building circuits? */
1872 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
1873 * stop building circuits? */
1874 char *ExcludeNodes
; /**< Comma-separated list of nicknames of ORs not to
1875 * use in circuits. */
1877 char *RendNodes
; /**< Comma-separated list of nicknames used as introduction
1879 char *RendExcludeNodes
; /**< Comma-separated list of nicknames not to use
1880 * as introduction points. */
1882 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
1883 smartlist_t
*AllowInvalidNodes
;
1884 int _AllowInvalid
; /**< Bitmask; derived from AllowInvalidNodes. */
1885 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
1886 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
1887 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
1888 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
1889 /** Addresses to bind for listening for SOCKS connections. */
1890 config_line_t
*SocksListenAddress
;
1891 /** Addresses to bind for listening for transparent pf/nefilter
1893 config_line_t
*TransListenAddress
;
1894 /** Addresses to bind for listening for transparent natd connections */
1895 config_line_t
*NatdListenAddress
;
1896 /** Addresses to bind for listening for SOCKS connections. */
1897 config_line_t
*DNSListenAddress
;
1898 /** Addresses to bind for listening for OR connections. */
1899 config_line_t
*ORListenAddress
;
1900 /** Addresses to bind for listening for directory connections. */
1901 config_line_t
*DirListenAddress
;
1902 /** Addresses to bind for listening for control connections. */
1903 config_line_t
*ControlListenAddress
;
1904 /** Local address to bind outbound sockets */
1905 char *OutboundBindAddress
;
1906 /** Directory server only: which versions of
1907 * Tor should we tell users to run? */
1908 config_line_t
*RecommendedVersions
;
1909 config_line_t
*RecommendedClientVersions
;
1910 config_line_t
*RecommendedServerVersions
;
1911 /** Whether dirservers refuse router descriptors with private IPs. */
1912 int DirAllowPrivateAddresses
;
1913 char *User
; /**< Name of user to run Tor as. */
1914 char *Group
; /**< Name of group to run Tor as. */
1915 int ORPort
; /**< Port to listen on for OR connections. */
1916 int SocksPort
; /**< Port to listen on for SOCKS connections. */
1917 /** Port to listen on for transparent pf/netfilter connections. */
1919 int NatdPort
; /**< Port to listen on for transparent natd connections. */
1920 int ControlPort
; /**< Port to listen on for control connections. */
1921 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
1922 * for control connections. */
1923 int DirPort
; /**< Port to listen on for directory connections. */
1924 int DNSPort
; /**< Port to listen on for DNS requests. */
1925 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
1926 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
1927 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
1928 * for version 1 directories? */
1929 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
1930 * for version 2 directories? */
1931 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
1932 * for version 3 directories? */
1933 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
1934 * handle hidden service requests? */
1935 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
1936 * directory record statistics? */
1937 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
1938 * that's willing to bind names? */
1939 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
1940 * directory that's willing to recommend
1942 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
1943 * that aggregates bridge descriptors? */
1945 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
1946 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
1948 /** Boolean: if we know the bridge's digest, should we get new
1949 * descriptors from the bridge authorities or from the bridge itself? */
1950 int UpdateBridgesFromAuthority
;
1952 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
1954 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
1955 /** Boolean: should we never publish a descriptor? Deprecated. */
1957 /** To what authority types do we publish our descriptor? Choices are
1958 * "v1", "v2", "bridge", or "". */
1959 smartlist_t
*PublishServerDescriptor
;
1960 /** An authority type, derived from PublishServerDescriptor. */
1961 authority_type_t _PublishServerDescriptor
;
1962 /** Boolean: do we publish hidden service descriptors to the HS auths? */
1963 int PublishHidServDescriptors
;
1964 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
1965 int FetchHidServDescriptors
; /** and hidden service descriptors? */
1966 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
1967 int AllDirActionsPrivate
; /**< Should every directory action be sent
1968 * through a Tor circuit? */
1970 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
1971 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
1972 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
1973 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
1974 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
1976 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
1977 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
1978 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
1980 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
1981 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
1983 /** Application ports that require all nodes in circ to have sufficient
1985 smartlist_t
*LongLivedPorts
;
1986 /** Should we try to reuse the same exit node for a given host */
1987 smartlist_t
*TrackHostExits
;
1988 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
1990 config_line_t
*AddressMap
; /**< List of address map directives. */
1991 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
1992 * hostname ending with one of the suffixes in
1993 * <b>AutomapHostsSuffixes</b>, map it to a
1994 * virtual address. */
1995 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
1996 * <b>AutomapHostsOnResolve</b>. */
1997 int RendPostPeriod
; /**< How often do we post each rendezvous service
1998 * descriptor? Remember to publish them independently. */
1999 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2000 * connections alive? */
2001 int SocksTimeout
; /**< How long do we let a socks connection wait
2002 * unattached before we fail it? */
2003 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2004 * at least this many seconds ago. */
2005 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2006 * at least this many seconds ago. */
2007 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2008 * to wait simultaneously before we start dropping
2010 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2012 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2013 this interval ago. */
2014 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2015 * to use in a second? */
2016 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2017 * to use in a second? */
2018 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2019 * tell people we have? */
2020 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2021 * willing to use for all relayed conns? */
2022 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2023 * use in a second for all relayed conns? */
2024 int NumCpus
; /**< How many CPUs should we try to use? */
2025 int RunTesting
; /**< If true, create testing circuits to measure how well the
2026 * other ORs are running. */
2027 char *TestVia
; /**< When reachability testing, use these as middle hop. */
2028 config_line_t
*RendConfigLines
; /**< List of configuration lines
2029 * for rendezvous services. */
2030 char *ContactInfo
; /**< Contact info to be published in the directory */
2032 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any */
2033 uint32_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any */
2034 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any */
2035 char *HttpProxyAuthenticator
; /**< username:password string, if any */
2037 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any */
2038 uint32_t HttpsProxyAddr
; /**< Parsed IPv4 addr for https proxy, if any */
2039 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any */
2040 char *HttpsProxyAuthenticator
; /**< username:password string, if any */
2042 config_line_t
*DirServers
; /**< List of configuration lines
2043 * for directory servers. */
2044 char *MyFamily
; /**< Declared family for this OR. */
2045 config_line_t
*NodeFamilies
; /**< List of config lines for
2047 config_line_t
*RedirectExit
; /**< List of config lines for simple
2048 * addr/port redirection */
2049 smartlist_t
*RedirectExitList
; /**< List of exit_redirect_t */
2050 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2051 * mark as bad exits. */
2052 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2054 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2055 * never mark as valid. */
2056 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2057 * and vote for all other exits as good. */
2058 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2059 * aren't named in our fingerprint file? */
2060 char *AccountingStart
; /**< How long is the accounting interval, and when
2062 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2063 * interval before hibernation? 0 for "never
2066 char *HashedControlPassword
; /**< Base64-encoded hash of a password for
2067 * the control system. */
2068 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2069 * the control system? */
2070 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2071 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2072 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2073 * circuits itself (0), or does it expect a controller
2075 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2076 * make circuits in the background (0),
2078 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2079 * long do we wait before exiting? */
2080 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2081 * such as addresses (0), or do we scrub them first (1)? */
2082 int SafeSocks
; /**< Boolean: should we outright refuse application
2083 * connections that use socks4 or socks5-with-local-dns? */
2084 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2085 LOG_WARN : LOG_INFO)
2086 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2087 * protocol, is it a warn or an info in our logs? */
2088 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2089 * log whether it was DNS-leaking or not? */
2090 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2091 * acceleration where available? */
2092 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2093 * of fixed nodes? */
2094 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2095 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2096 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2097 * of our PK time by sending CREATE_FAST cells? */
2099 addr_policy_t
*reachable_addr_policy
; /**< Parsed from ReachableAddresses */
2101 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2102 * MAPADDRESS requests. */
2103 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2104 * addresses to be FQDNs, but rather search for them in
2105 * the local domains. */
2106 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2108 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2109 * resolver from the file here rather than from
2110 * /etc/resolv.conf (Unix) or the registry (Windows). */
2111 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2112 * should be resolveable. Used for
2113 * testing our DNS server. */
2114 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2115 * same network zone in the same circuit. */
2116 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2118 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2119 * support BEGIN_DIR, when possible. */
2120 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2121 * with weird characters. */
2122 /** If true, we try resolving hostnames with weird characters. */
2123 int ServerDNSAllowNonRFC953Hostnames
;
2125 /** If true, we try to download extra-info documents (and we serve them,
2126 * if we are a cache). For authorities, this is always true. */
2127 int DownloadExtraInfo
;
2129 /** If true, do not believe anybody who tells us that a domain resolves
2130 * to an internal address, or that an internal address has a PTR mapping.
2131 * Helps avoid some cross-site attacks. */
2132 int ClientDNSRejectInternalAddresses
;
2134 /** The length of time that we think a consensus should be fresh. */
2135 int V3AuthVotingInterval
;
2136 /** The length of time we think it will take to distribute votes */
2137 int V3AuthVoteDelay
;
2138 /** The length of time we think it will take to distribute signatures */
2139 int V3AuthDistDelay
;
2140 /** The number of intervals we think a consensus should be valid. */
2141 int V3AuthNIntervalsValid
;
2144 /** Persistent state for an onion router, as saved to disk. */
2147 /** The time at which we next plan to write the state to the disk. Equal to
2148 * TIME_MAX if there are no saveable changes, 0 if there are changes that
2149 * should be saved right away. */
2152 /** When was the state last written to disk? */
2155 /** Fields for accounting bandwidth use. */
2156 time_t AccountingIntervalStart
;
2157 uint64_t AccountingBytesReadInInterval
;
2158 uint64_t AccountingBytesWrittenInInterval
;
2159 int AccountingSecondsActive
;
2160 uint64_t AccountingExpectedUsage
;
2162 /** A list of Entry Guard-related configuration lines. */
2163 config_line_t
*EntryGuards
;
2165 /** These fields hold information on the history of bandwidth usage for
2166 * servers. The "Ends" fields hold the time when we last updated the
2167 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2168 * of the entries of Values. The "Values" lists hold decimal string
2169 * representations of the number of bytes read or written in each
2171 time_t BWHistoryReadEnds
;
2172 int BWHistoryReadInterval
;
2173 smartlist_t
*BWHistoryReadValues
;
2174 time_t BWHistoryWriteEnds
;
2175 int BWHistoryWriteInterval
;
2176 smartlist_t
*BWHistoryWriteValues
;
2178 /** What version of Tor wrote this state file? */
2181 /** Holds any unrecognized values we found in the state file, in the order
2182 * in which we found them. */
2183 config_line_t
*ExtraLines
;
2185 /** When did we last rotate our onion key? "0" for 'no idea'. */
2186 time_t LastRotatedOnionKey
;
2189 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2190 * state is already scheduled to be written to disk earlier than <b>when</b>.
2192 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2194 if (state
->next_write
> when
)
2195 state
->next_write
= when
;
2198 #define MAX_SOCKS_REPLY_LEN 1024
2199 #define MAX_SOCKS_ADDR_LEN 256
2201 /** Please open a TCP connection to this addr:port. */
2202 #define SOCKS_COMMAND_CONNECT 0x01
2203 /** Please turn this FQDN into an IP address, privately. */
2204 #define SOCKS_COMMAND_RESOLVE 0xF0
2205 /** Please turn this IP address into an FQDN, privately. */
2206 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2208 /** Please open an encrypted direct TCP connection to the directory port
2209 * of the Tor server specified by address:port. (In this case address:port
2210 * specifies the ORPort of the server.) */
2211 #define SOCKS_COMMAND_CONNECT_DIR 0xF2
2213 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT || \
2214 (c)==SOCKS_COMMAND_CONNECT_DIR)
2215 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2216 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2218 /** State of a SOCKS request from a user to an OP. Also used to encode other
2219 * information for non-socks user request (such as those on TransPort and
2221 struct socks_request_t
{
2222 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2223 * 0 means that no socks handshake ever took place, and this is just a
2224 * stub connection (e.g. see connection_ap_make_link()). */
2226 int command
; /**< What is this stream's goal? One from the above list. */
2227 size_t replylen
; /**< Length of <b>reply</b>. */
2228 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2229 * we want to specify our own socks reply,
2230 * rather than using the default socks4 or
2231 * socks5 socks reply. We use this for the
2232 * two-stage socks5 handshake.
2234 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2235 connect to/resolve? */
2236 uint16_t port
; /**< What port did the client ask to connect to? */
2237 unsigned has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2238 * make sure we send back a socks reply for
2239 * every connection. */
2242 /* all the function prototypes go here */
2244 /********************************* buffers.c ***************************/
2246 buf_t
*buf_new(void);
2247 buf_t
*buf_new_with_capacity(size_t size
);
2248 void buf_free(buf_t
*buf
);
2249 void buf_clear(buf_t
*buf
);
2250 void buf_shrink(buf_t
*buf
);
2251 void buf_shrink_freelists(int free_all
);
2252 void buf_dump_freelist_sizes(int severity
);
2254 size_t buf_datalen(const buf_t
*buf
);
2255 size_t buf_capacity(const buf_t
*buf
);
2256 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2258 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
);
2259 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2261 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2262 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2264 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2265 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2266 const char *data
, size_t data_len
, int done
);
2267 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2268 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2269 int fetch_from_buf_http(buf_t
*buf
,
2270 char **headers_out
, size_t max_headerlen
,
2271 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2272 int force_complete
);
2273 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2274 int log_sockstype
, int safe_socks
);
2275 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2277 int peek_buf_has_control0_command(buf_t
*buf
);
2279 void assert_buf_ok(buf_t
*buf
);
2281 /********************************* circuitbuild.c **********************/
2283 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2284 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2285 void circuit_log_path(int severity
, unsigned int domain
,
2286 origin_circuit_t
*circ
);
2287 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2288 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int onehop_tunnel
,
2290 int need_capacity
, int internal
);
2291 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2292 int onehop_tunnel
, extend_info_t
*exit
,
2293 int need_uptime
, int need_capacity
,
2295 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2296 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2297 int inform_testing_reachability(void);
2298 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2299 void circuit_note_clock_jumped(int seconds_elapsed
);
2300 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2301 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2303 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2305 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2306 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2307 const char *payload
, const char *keys
);
2308 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2309 int *need_capacity
);
2311 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2312 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2313 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2314 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2315 crypto_pk_env_t
*onion_key
,
2316 uint32_t addr
, uint16_t port
);
2317 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2318 //extend_info_t *extend_info_from_routerstatus(routerstatus_t *s);
2319 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2320 void extend_info_free(extend_info_t
*info
);
2321 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2322 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2324 void entry_guards_compute_status(void);
2325 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2327 void entry_nodes_should_be_added(void);
2328 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2329 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2330 void entry_guards_update_state(or_state_t
*state
);
2331 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2332 const char *question
, char **answer
);
2334 void clear_bridge_list(void);
2335 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2336 void bridge_add_from_config(uint32_t addr
, uint16_t port
, char *digest
);
2337 void fetch_bridge_descriptors(time_t now
);
2338 void learned_bridge_descriptor(routerinfo_t
*ri
);
2339 int any_bridge_descriptors_known(void);
2340 int bridges_should_be_retried(void);
2341 void bridges_retry_all(void);
2343 void entry_guards_free_all(void);
2345 /********************************* circuitlist.c ***********************/
2347 circuit_t
* _circuit_get_global_list(void);
2348 const char *circuit_state_to_string(int state
);
2349 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
2350 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, uint16_t id
,
2351 or_connection_t
*conn
);
2352 void circuit_set_n_circid_orconn(circuit_t
*circ
, uint16_t id
,
2353 or_connection_t
*conn
);
2354 void circuit_set_state(circuit_t
*circ
, int state
);
2355 void circuit_close_all_marked(void);
2356 origin_circuit_t
*origin_circuit_new(void);
2357 or_circuit_t
*or_circuit_new(uint16_t p_circ_id
, or_connection_t
*p_conn
);
2358 circuit_t
*circuit_get_by_circid_orconn(uint16_t circ_id
,
2359 or_connection_t
*conn
);
2360 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
2361 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
2362 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
2363 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
2365 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
2366 const char *digest
, uint8_t purpose
);
2367 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
2368 or_circuit_t
*circuit_get_intro_point(const char *digest
);
2369 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
2370 extend_info_t
*info
,
2372 int need_capacity
, int internal
);
2373 void circuit_mark_all_unused_circs(void);
2374 void circuit_expire_all_dirty_circs(void);
2375 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
2376 int line
, const char *file
);
2377 int circuit_get_cpath_len(origin_circuit_t
*circ
);
2378 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
2379 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
2380 or_connection_t
*or_conn
);
2381 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
2383 #define circuit_mark_for_close(c, reason) \
2384 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
2386 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
2387 void assert_circuit_ok(const circuit_t
*c
);
2388 void circuit_free_all(void);
2390 /********************************* circuituse.c ************************/
2392 void circuit_expire_building(time_t now
);
2393 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
2394 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
2396 void circuit_build_needed_circs(time_t now
);
2397 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
2399 void reset_bandwidth_test(void);
2400 int circuit_enough_testing_circs(void);
2402 void circuit_has_opened(origin_circuit_t
*circ
);
2403 void circuit_build_failed(origin_circuit_t
*circ
);
2404 origin_circuit_t
*circuit_launch_by_nickname(uint8_t purpose
,
2406 const char *exit_nickname
,
2407 int need_uptime
, int need_capacity
,
2409 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
2411 extend_info_t
*info
,
2412 int need_uptime
, int need_capacity
,
2414 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
2417 int need_uptime
, int need_capacity
,
2419 void circuit_reset_failure_count(int timeout
);
2420 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
2421 origin_circuit_t
*circ
,
2422 crypt_path_t
*cpath
);
2423 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
2425 /********************************* command.c ***************************/
2427 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
2429 extern uint64_t stats_n_padding_cells_processed
;
2430 extern uint64_t stats_n_create_cells_processed
;
2431 extern uint64_t stats_n_created_cells_processed
;
2432 extern uint64_t stats_n_relay_cells_processed
;
2433 extern uint64_t stats_n_destroy_cells_processed
;
2435 /********************************* config.c ***************************/
2437 or_options_t
*get_options(void);
2438 int set_options(or_options_t
*new_val
, char **msg
);
2439 void config_free_all(void);
2440 const char *safe_str(const char *address
);
2441 const char *escaped_safe_str(const char *address
);
2442 const char *get_version(void);
2444 int config_get_lines(char *string
, config_line_t
**result
);
2445 void config_free_lines(config_line_t
*front
);
2446 int options_trial_assign(config_line_t
*list
, int use_defaults
,
2447 int clear_first
, char **msg
);
2448 int resolve_my_address(int warn_severity
, or_options_t
*options
,
2449 uint32_t *addr
, char **hostname_out
);
2450 int is_local_IP(uint32_t ip
) ATTR_PURE
;
2451 void options_init(or_options_t
*options
);
2452 int options_init_from_torrc(int argc
, char **argv
);
2453 int option_is_recognized(const char *key
);
2454 const char *option_get_canonical_name(const char *key
);
2455 config_line_t
*option_get_assignment(or_options_t
*options
,
2457 int options_save_current(void);
2458 const char *get_torrc_fname(void);
2460 or_state_t
*get_or_state(void);
2461 int or_state_save(time_t now
);
2463 int getinfo_helper_config(control_connection_t
*conn
,
2464 const char *question
, char **answer
);
2466 #ifdef CONFIG_PRIVATE
2467 /* Used only by config.c and test.c */
2468 or_options_t
*options_new(void);
2471 /********************************* connection.c ***************************/
2473 const char *conn_type_to_string(int type
);
2474 const char *conn_state_to_string(int type
, int state
);
2476 connection_t
*connection_new(int type
, int socket_family
);
2477 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
2478 void connection_unregister_events(connection_t
*conn
);
2479 void connection_free(connection_t
*conn
);
2480 void connection_free_all(void);
2481 void connection_about_to_close_connection(connection_t
*conn
);
2482 void connection_close_immediate(connection_t
*conn
);
2483 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
2485 #define connection_mark_for_close(c) \
2486 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
2488 void connection_expire_held_open(void);
2490 int connection_connect(connection_t
*conn
, const char *address
, uint32_t addr
,
2492 int retry_all_listeners(smartlist_t
*replaced_conns
,
2493 smartlist_t
*new_conns
);
2495 int connection_bucket_write_limit(connection_t
*conn
, time_t now
);
2496 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
2497 void connection_bucket_init(void);
2498 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
2500 int connection_handle_read(connection_t
*conn
);
2502 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
2504 int connection_wants_to_flush(connection_t
*conn
);
2505 int connection_outbuf_too_full(connection_t
*conn
);
2506 int connection_handle_write(connection_t
*conn
, int force
);
2507 void _connection_write_to_buf_impl(const char *string
, size_t len
,
2508 connection_t
*conn
, int zlib
);
2509 static void connection_write_to_buf(const char *string
, size_t len
,
2510 connection_t
*conn
);
2511 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
2512 dir_connection_t
*conn
, int done
);
2514 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
2516 _connection_write_to_buf_impl(string
, len
, conn
, 0);
2519 connection_write_to_buf_zlib(const char *string
, size_t len
,
2520 dir_connection_t
*conn
, int done
)
2522 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
2525 or_connection_t
*connection_or_exact_get_by_addr_port(uint32_t addr
,
2527 edge_connection_t
*connection_get_by_global_id(uint32_t id
);
2529 connection_t
*connection_get_by_type(int type
);
2530 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
2531 connection_t
*connection_get_by_type_addr_port_purpose(int type
, uint32_t addr
,
2532 uint16_t port
, int purpose
);
2533 connection_t
*connection_get_by_type_state(int type
, int state
);
2535 connection_t
*connection_get_by_type_state_lastwritten(int type
, int state
);
2537 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
2538 const char *rendquery
);
2540 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
2541 int connection_is_listener(connection_t
*conn
);
2542 int connection_state_is_open(connection_t
*conn
);
2543 int connection_state_is_connecting(connection_t
*conn
);
2545 char *alloc_http_authenticator(const char *authenticator
);
2547 void assert_connection_ok(connection_t
*conn
, time_t now
);
2548 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
2549 void connection_dump_buffer_mem_stats(int severity
);
2551 /********************************* connection_edge.c *************************/
2553 #define connection_mark_unattached_ap(conn, endreason) \
2554 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
2556 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
2557 int line
, const char *file
);
2558 int connection_edge_reached_eof(edge_connection_t
*conn
);
2559 int connection_edge_process_inbuf(edge_connection_t
*conn
,
2560 int package_partial
);
2561 int connection_edge_destroy(uint16_t circ_id
, edge_connection_t
*conn
);
2562 int connection_edge_end(edge_connection_t
*conn
, char reason
);
2563 int connection_edge_end_errno(edge_connection_t
*conn
);
2564 int connection_edge_finished_flushing(edge_connection_t
*conn
);
2565 int connection_edge_finished_connecting(edge_connection_t
*conn
);
2567 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
2568 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
2570 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
2571 const char *digest
, int command
);
2572 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
2575 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
2582 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
2583 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
2584 void connection_exit_connect(edge_connection_t
*conn
);
2585 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
2586 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
2587 void connection_ap_expire_beginning(void);
2588 void connection_ap_attach_pending(void);
2589 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
2590 int connection_ap_detach_retriable(edge_connection_t
*conn
,
2591 origin_circuit_t
*circ
,
2593 int connection_ap_process_transparent(edge_connection_t
*conn
);
2595 int address_is_invalid_destination(const char *address
, int client
);
2597 void addressmap_init(void);
2598 void addressmap_clean(time_t now
);
2599 void addressmap_clear_configured(void);
2600 void addressmap_clear_transient(void);
2601 void addressmap_free_all(void);
2602 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
2603 int addressmap_have_mapping(const char *address
);
2604 void addressmap_register(const char *address
, char *new_address
,
2606 int parse_virtual_addr_network(const char *val
, int validate_only
,
2608 int client_dns_incr_failures(const char *address
);
2609 void client_dns_clear_failures(const char *address
);
2610 void client_dns_set_addressmap(const char *address
, uint32_t val
,
2611 const char *exitname
, int ttl
);
2612 const char *addressmap_register_virtual_address(int type
, char *new_address
);
2613 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
2614 time_t max_expires
, int want_expiry
);
2615 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
2616 origin_circuit_t
*circ
,
2617 crypt_path_t
*cpath
);
2618 int hostname_is_noconnect_address(const char *address
);
2620 void set_exit_redirects(smartlist_t
*lst
);
2621 typedef enum hostname_type_t
{
2622 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
2624 hostname_type_t
parse_extended_hostname(char *address
);
2626 /********************************* connection_or.c ***************************/
2628 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
2629 void connection_or_clear_identity_map(void);
2630 or_connection_t
*connection_or_get_by_identity_digest(const char *digest
);
2632 int connection_or_reached_eof(or_connection_t
*conn
);
2633 int connection_or_process_inbuf(or_connection_t
*conn
);
2634 int connection_or_flushed_some(or_connection_t
*conn
);
2635 int connection_or_finished_flushing(or_connection_t
*conn
);
2636 int connection_or_finished_connecting(or_connection_t
*conn
);
2638 or_connection_t
*connection_or_connect(uint32_t addr
, uint16_t port
,
2639 const char *id_digest
);
2641 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
2642 int connection_tls_continue_handshake(or_connection_t
*conn
);
2644 void connection_or_write_cell_to_buf(const cell_t
*cell
,
2645 or_connection_t
*conn
);
2646 int connection_or_send_destroy(uint16_t circ_id
, or_connection_t
*conn
,
2649 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
2651 /********************************* control.c ***************************/
2653 typedef enum circuit_status_event_t
{
2654 CIRC_EVENT_LAUNCHED
= 0,
2655 CIRC_EVENT_BUILT
= 1,
2656 CIRC_EVENT_EXTENDED
= 2,
2657 CIRC_EVENT_FAILED
= 3,
2658 CIRC_EVENT_CLOSED
= 4,
2659 } circuit_status_event_t
;
2661 typedef enum stream_status_event_t
{
2662 STREAM_EVENT_SENT_CONNECT
= 0,
2663 STREAM_EVENT_SENT_RESOLVE
= 1,
2664 STREAM_EVENT_SUCCEEDED
= 2,
2665 STREAM_EVENT_FAILED
= 3,
2666 STREAM_EVENT_CLOSED
= 4,
2667 STREAM_EVENT_NEW
= 5,
2668 STREAM_EVENT_NEW_RESOLVE
= 6,
2669 STREAM_EVENT_FAILED_RETRIABLE
= 7,
2670 STREAM_EVENT_REMAP
= 8
2671 } stream_status_event_t
;
2673 typedef enum or_conn_status_event_t
{
2674 OR_CONN_EVENT_LAUNCHED
= 0,
2675 OR_CONN_EVENT_CONNECTED
= 1,
2676 OR_CONN_EVENT_FAILED
= 2,
2677 OR_CONN_EVENT_CLOSED
= 3,
2678 OR_CONN_EVENT_NEW
= 4,
2679 } or_conn_status_event_t
;
2681 void control_update_global_event_mask(void);
2682 void control_adjust_event_log_severity(void);
2684 /** Execute the statement <b>stmt</b>, which may log events concerning the
2685 * connection <b>conn</b>. To prevent infinite loops, disable log messages
2686 * being sent to controllers if <b>conn</b> is a control connection.
2688 * Stmt must not contain any return or goto statements.
2690 #define CONN_LOG_PROTECT(conn, stmt) \
2692 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
2693 if (_log_conn_is_control) \
2694 disable_control_logging(); \
2695 STMT_BEGIN stmt; STMT_END; \
2696 if (_log_conn_is_control) \
2697 enable_control_logging(); \
2700 /** Log information about the connection <b>conn</b>, protecting it as with
2701 * CONN_LOG_PROTECT. Example:
2703 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
2705 #define LOG_FN_CONN(conn, args) \
2706 CONN_LOG_PROTECT(conn, log_fn args)
2708 int connection_control_finished_flushing(control_connection_t
*conn
);
2709 int connection_control_reached_eof(control_connection_t
*conn
);
2710 int connection_control_process_inbuf(control_connection_t
*conn
);
2712 #define EVENT_AUTHDIR_NEWDESCS 0x000D
2713 int control_event_is_interesting(int event
);
2715 int control_event_circuit_status(origin_circuit_t
*circ
,
2716 circuit_status_event_t e
, int reason
);
2717 int control_event_stream_status(edge_connection_t
*conn
,
2718 stream_status_event_t e
,
2720 int control_tls_error_to_reason(int e
);
2721 int control_event_or_conn_status(or_connection_t
*conn
,
2722 or_conn_status_event_t e
, int reason
);
2723 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
2724 int control_event_stream_bandwidth_used(void);
2725 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
2726 int control_event_descriptors_changed(smartlist_t
*routers
);
2727 int control_event_address_mapped(const char *from
, const char *to
,
2728 time_t expires
, const char *error
);
2729 int control_event_or_authdir_new_descriptor(const char *action
,
2733 int control_event_my_descriptor_changed(void);
2734 int control_event_networkstatus_changed(smartlist_t
*statuses
);
2735 int control_event_networkstatus_changed_single(local_routerstatus_t
*rs
);
2736 int control_event_general_status(int severity
, const char *format
, ...)
2738 int control_event_client_status(int severity
, const char *format
, ...)
2740 int control_event_server_status(int severity
, const char *format
, ...)
2742 int control_event_guard(const char *nickname
, const char *digest
,
2743 const char *status
);
2745 int init_cookie_authentication(int enabled
);
2746 int decode_hashed_password(char *buf
, const char *hashed
);
2747 void disable_control_logging(void);
2748 void enable_control_logging(void);
2750 #ifdef CONTROL_PRIVATE
2751 /* Used only by control.c and test.c */
2752 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
2753 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
2756 /********************************* cpuworker.c *****************************/
2758 void cpu_init(void);
2759 void cpuworkers_rotate(void);
2760 int connection_cpu_finished_flushing(connection_t
*conn
);
2761 int connection_cpu_reached_eof(connection_t
*conn
);
2762 int connection_cpu_process_inbuf(connection_t
*conn
);
2763 int assign_to_cpuworker(connection_t
*cpuworker
, uint8_t question_type
,
2766 /********************************* directory.c ***************************/
2768 int directories_have_accepted_server_descriptor(void);
2769 char *authority_type_to_string(authority_type_t auth
);
2770 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
2771 authority_type_t type
, const char *payload
,
2772 size_t payload_len
, size_t extrainfo_len
);
2773 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
2774 const char *resource
,
2775 int retry_if_no_servers
);
2776 void directory_get_from_all_authorities(uint8_t dir_purpose
,
2777 uint8_t router_purpose
,
2778 const char *resource
);
2779 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
2780 uint8_t dir_purpose
,
2781 uint8_t router_purpose
,
2782 int anonymized_connection
,
2783 const char *resource
,
2784 const char *payload
,
2785 size_t payload_len
);
2787 int parse_http_response(const char *headers
, int *code
, time_t *date
,
2788 compress_method_t
*compression
, char **response
);
2790 int connection_dir_reached_eof(dir_connection_t
*conn
);
2791 int connection_dir_process_inbuf(dir_connection_t
*conn
);
2792 int connection_dir_finished_flushing(dir_connection_t
*conn
);
2793 int connection_dir_finished_connecting(dir_connection_t
*conn
);
2794 void connection_dir_request_failed(dir_connection_t
*conn
);
2795 void directory_initiate_command(const char *address
, uint32_t addr
,
2796 uint16_t or_port
, uint16_t dir_port
,
2797 int supports_begindir
, const char *digest
,
2798 uint8_t dir_purpose
, uint8_t router_purpose
,
2799 int anonymized_connection
,
2800 const char *resource
,
2801 const char *payload
, size_t payload_len
);
2803 int dir_split_resource_into_fingerprints(const char *resource
,
2804 smartlist_t
*fp_out
, int *compresseed_out
,
2805 int decode_hex
, int sort_uniq
);
2806 char *directory_dump_request_log(void);
2807 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
2809 /********************************* dirserv.c ***************************/
2811 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
2813 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
2815 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
2816 int dirserv_load_fingerprint_file(void);
2817 void dirserv_free_fingerprint_list(void);
2818 const char *dirserv_get_nickname_by_digest(const char *digest
);
2819 int dirserv_add_multiple_descriptors(const char *desc
, uint8_t purpose
,
2822 int dirserv_add_descriptor(routerinfo_t
*ri
, const char **msg
);
2823 int getinfo_helper_dirserv_unregistered(control_connection_t
*conn
,
2824 const char *question
, char **answer
);
2825 void dirserv_free_descriptors(void);
2826 int dirserv_thinks_router_is_blatantly_unreachable(routerinfo_t
*router
,
2828 int list_server_status(smartlist_t
*routers
, char **router_status_out
,
2829 int for_controller
);
2830 int dirserv_dump_directory_to_string(char **dir_out
,
2831 crypto_pk_env_t
*private_key
,
2833 void directory_set_dirty(void);
2834 cached_dir_t
*dirserv_get_directory(void);
2835 cached_dir_t
*dirserv_get_runningrouters(void);
2836 cached_dir_t
*dirserv_get_consensus(void);
2837 void dirserv_set_cached_directory(const char *directory
, time_t when
,
2838 int is_running_routers
);
2839 void dirserv_set_cached_networkstatus_v2(const char *directory
,
2840 const char *identity
,
2842 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
2844 void dirserv_clear_old_networkstatuses(time_t cutoff
);
2845 void dirserv_clear_old_v1_info(time_t now
);
2846 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
2847 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
2849 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
2851 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
2853 void dirserv_orconn_tls_done(const char *address
,
2855 const char *digest_rcvd
,
2857 void dirserv_test_reachability(time_t now
, int try_all
);
2858 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
2860 int dirserv_would_reject_router(routerstatus_t
*rs
);
2861 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
2862 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
2863 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
2865 int routerstatus_format_entry(char *buf
, size_t buf_len
,
2866 routerstatus_t
*rs
, const char *platform
,
2867 int first_line_only
);
2868 void dirserv_free_all(void);
2869 void cached_dir_decref(cached_dir_t
*d
);
2870 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
2872 cached_dir_t
*generate_v3_networkstatus(void);
2874 #ifdef DIRSERV_PRIVATE
2876 format_networkstatus_vote(crypto_pk_env_t
*private_key
,
2877 networkstatus_vote_t
*v3_ns
);
2880 /********************************* dirvote.c ************************/
2882 /* XXXX020 enforce */
2883 /* XXXX020 document in dir-spec.txt */
2885 #define MIN_VOTE_SECONDS 20
2886 #define MIN_DIST_SECONDS 20
2887 #define MIN_VOTE_INTERVAL 300
2889 void dirvote_free_all(void);
2891 /* vote manipulation */
2892 void networkstatus_vote_free(networkstatus_vote_t
*ns
);
2893 char *networkstatus_compute_consensus(smartlist_t
*votes
,
2894 int total_authorities
,
2895 crypto_pk_env_t
*identity_key
,
2896 crypto_pk_env_t
*signing_key
);
2897 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
2898 networkstatus_vote_t
*vote
,
2899 const char *identity
);
2900 int networkstatus_check_consensus_signature(networkstatus_vote_t
*consensus
,
2902 int networkstatus_add_detached_signatures(networkstatus_vote_t
*target
,
2903 ns_detached_signatures_t
*sigs
);
2904 char *networkstatus_get_detached_signatures(networkstatus_vote_t
*consensus
);
2905 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
2907 /* cert manipulation */
2908 void authority_cert_free(authority_cert_t
*cert
);
2909 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
2911 /** Describes the schedule by which votes should be generated. */
2912 typedef struct vote_timing_t
{
2914 int n_intervals_valid
;
2918 /* vote scheduling */
2919 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
2920 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
2921 void dirvote_recalculate_timing(time_t now
);
2922 void dirvote_act(time_t now
);
2924 /* invoked on timers and by outside triggers. */
2925 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
2926 const char **msg_out
,
2928 int dirvote_add_signatures(const char *detached_signatures_body
);
2931 const char *dirvote_get_pending_consensus(void);
2932 const char *dirvote_get_pending_detached_signatures(void);
2933 const cached_dir_t
*dirvote_get_vote(const char *fp
, int by_id
,
2934 int include_pending
,
2935 int include_previous
);
2937 #ifdef DIRVOTE_PRIVATE
2938 int networkstatus_check_voter_signature(networkstatus_vote_t
*consensus
,
2939 networkstatus_voter_info_t
*voter
,
2940 authority_cert_t
*cert
);
2943 /********************************* dns.c ***************************/
2946 void dns_free_all(void);
2947 uint32_t dns_clip_ttl(uint32_t ttl
);
2948 int dns_reset(void);
2949 void connection_dns_remove(edge_connection_t
*conn
);
2950 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
2951 void assert_all_pending_dns_resolves_ok(void);
2952 void dns_cancel_pending_resolve(const char *question
);
2953 int dns_resolve(edge_connection_t
*exitconn
);
2954 void dns_launch_correctness_checks(void);
2955 int dns_seems_to_be_broken(void);
2956 void dns_reset_correctness_checks(void);
2958 /********************************* dnsserv.c ************************/
2960 void dnsserv_configure_listener(connection_t
*conn
);
2961 void dnsserv_close_listener(connection_t
*conn
);
2962 void dnsserv_resolved(edge_connection_t
*conn
,
2967 void dnsserv_reject_request(edge_connection_t
*conn
);
2968 void dnsserv_launch_request(const char *name
, int is_reverse
);
2970 /********************************* hibernate.c **********************/
2972 int accounting_parse_options(or_options_t
*options
, int validate_only
);
2973 int accounting_is_enabled(or_options_t
*options
);
2974 void configure_accounting(time_t now
);
2975 void accounting_run_housekeeping(time_t now
);
2976 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
2977 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
2978 void hibernate_begin_shutdown(void);
2979 int we_are_hibernating(void);
2980 void consider_hibernation(time_t now
);
2981 int getinfo_helper_accounting(control_connection_t
*conn
,
2982 const char *question
, char **answer
);
2983 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
2985 /********************************* main.c ***************************/
2987 extern int has_completed_circuit
;
2989 int connection_add(connection_t
*conn
);
2990 int connection_remove(connection_t
*conn
);
2991 int connection_in_array(connection_t
*conn
);
2992 void add_connection_to_closeable_list(connection_t
*conn
);
2993 int connection_is_on_closeable_list(connection_t
*conn
);
2995 smartlist_t
*get_connection_array(void);
2997 void connection_watch_events(connection_t
*conn
, short events
);
2998 int connection_is_reading(connection_t
*conn
);
2999 void connection_stop_reading(connection_t
*conn
);
3000 void connection_start_reading(connection_t
*conn
);
3002 int connection_is_writing(connection_t
*conn
);
3003 void connection_stop_writing(connection_t
*conn
);
3004 void connection_start_writing(connection_t
*conn
);
3006 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
3008 void directory_all_unreachable(time_t now
);
3009 void directory_info_has_arrived(time_t now
, int from_cache
);
3011 void ip_address_changed(int at_interface
);
3012 void dns_servers_relaunch_checks(void);
3014 void control_signal_act(int the_signal
);
3015 void handle_signals(int is_parent
);
3016 void tor_cleanup(void);
3017 void tor_free_all(int postfork
);
3019 int tor_main(int argc
, char *argv
[]);
3022 int do_main_loop(void);
3023 int do_list_fingerprint(void);
3024 void do_hash_password(void);
3025 int tor_init(int argc
, char **argv
);
3028 /********************************* networkstatus.c *********************/
3030 /** How old do we allow a network-status to get before removing it
3032 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
3034 void networkstatus_reset_warnings(void);
3035 int router_reload_networkstatus(void);
3036 /* for consensuses. */
3037 int router_reload_consensus_networkstatus(void);
3038 networkstatus_vote_t
*networkstatus_get_latest_consensus(void);
3039 networkstatus_vote_t
*networkstatus_get_live_consensus(time_t now
);
3040 int networkstatus_set_current_consensus(const char *consensus
, int from_cache
,
3041 int was_waiting_for_certs
);
3042 char *networkstatus_get_cache_filename(const char *identity_digest
);
3044 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3045 } networkstatus_source_t
;
3046 int router_set_networkstatus(const char *s
, time_t arrived_at
,
3047 networkstatus_source_t source
,
3048 smartlist_t
*requested_fingerprints
);
3049 void networkstatus_list_clean(time_t now
);
3050 routerstatus_t
*networkstatus_find_entry(networkstatus_t
*ns
,
3051 const char *digest
);
3052 /* XXXX020 move remaining functions in networkstatus.c into this section. */
3053 const smartlist_t
*networkstatus_get_v2_list(void);
3054 const smartlist_t
*networkstatus_get_all_statuses(void);
3055 void networkstatus_note_certs_arrived(void);
3056 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
3057 void routerstatus_list_update_from_networkstatus(time_t now
);
3059 void networkstatus_free_all(void);
3060 local_routerstatus_t
*router_get_combined_status_by_nickname(
3061 const char *nickname
,
3062 int warn_if_unnamed
);
3063 void routerstatus_free(routerstatus_t
*routerstatus
);
3064 void networkstatus_free(networkstatus_t
*networkstatus
);
3066 /********************************* ntmain.c ***************************/
3072 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
3073 int nt_service_is_stopping(void);
3074 void nt_service_set_state(DWORD state
);
3076 #define nt_service_is_stopping() (0)
3079 /********************************* onion.c ***************************/
3081 int onion_pending_add(or_circuit_t
*circ
);
3082 or_circuit_t
*onion_next_task(void);
3083 void onion_pending_remove(or_circuit_t
*circ
);
3085 int onion_skin_create(crypto_pk_env_t
*router_key
,
3086 crypto_dh_env_t
**handshake_state_out
,
3087 char *onion_skin_out
);
3089 int onion_skin_server_handshake(const char *onion_skin
,
3090 crypto_pk_env_t
*private_key
,
3091 crypto_pk_env_t
*prev_private_key
,
3092 char *handshake_reply_out
,
3094 size_t key_out_len
);
3096 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
3097 const char *handshake_reply
,
3099 size_t key_out_len
);
3101 int fast_server_handshake(const char *key_in
,
3102 char *handshake_reply_out
,
3104 size_t key_out_len
);
3106 int fast_client_handshake(const char *handshake_state
,
3107 const char *handshake_reply_out
,
3109 size_t key_out_len
);
3111 void clear_pending_onions(void);
3113 /********************************* policies.c ************************/
3115 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
3118 #define POLICY_BUF_LEN 52
3121 ADDR_POLICY_ACCEPTED
=0,
3122 ADDR_POLICY_REJECTED
=-1,
3123 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3124 ADDR_POLICY_PROBABLY_REJECTED
=2
3125 } addr_policy_result_t
;
3127 int firewall_is_fascist_or(void);
3128 int fascist_firewall_allows_address_or(uint32_t addr
, uint16_t port
);
3129 int fascist_firewall_allows_address_dir(uint32_t addr
, uint16_t port
);
3130 int dir_policy_permits_address(uint32_t addr
);
3131 int socks_policy_permits_address(uint32_t addr
);
3132 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
3133 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
3134 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
3136 int validate_addr_policies(or_options_t
*options
, char **msg
);
3137 void policies_parse_from_options(or_options_t
*options
);
3139 int cmp_addr_policies(addr_policy_t
*a
, addr_policy_t
*b
);
3140 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
3141 uint16_t port
, addr_policy_t
*policy
);
3142 int policies_parse_exit_policy(config_line_t
*cfg
,
3143 addr_policy_t
**dest
,
3145 int exit_policy_is_general_exit(addr_policy_t
*policy
);
3146 int policy_is_reject_star(addr_policy_t
*policy
);
3147 int getinfo_helper_policies(control_connection_t
*conn
,
3148 const char *question
, char **answer
);
3149 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*policy
);
3151 void addr_policy_free(addr_policy_t
*p
);
3152 void policies_free_all(void);
3154 /********************************* relay.c ***************************/
3156 extern uint64_t stats_n_relay_cells_relayed
;
3157 extern uint64_t stats_n_relay_cells_delivered
;
3159 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
3160 int cell_direction
);
3162 void relay_header_pack(char *dest
, const relay_header_t
*src
);
3163 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
3164 int relay_send_command_from_edge(uint16_t stream_id
, circuit_t
*circ
,
3165 int relay_command
, const char *payload
,
3166 size_t payload_len
, crypt_path_t
*cpath_layer
);
3167 int connection_edge_send_command(edge_connection_t
*fromconn
,
3168 int relay_command
, const char *payload
,
3169 size_t payload_len
);
3170 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
3171 int package_partial
);
3172 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
3173 socks5_reply_status_t
connection_edge_end_reason_socks5_response(int reason
);
3174 int errno_to_end_reason(int e
);
3176 extern uint64_t stats_n_data_cells_packaged
;
3177 extern uint64_t stats_n_data_bytes_packaged
;
3178 extern uint64_t stats_n_data_cells_received
;
3179 extern uint64_t stats_n_data_bytes_received
;
3181 void init_cell_pool(void);
3182 void free_cell_pool(void);
3183 void clean_cell_pool(void);
3184 void dump_cell_pool_usage(int severity
);
3186 void cell_queue_clear(cell_queue_t
*queue
);
3187 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
3188 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
3190 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
3191 cell_t
*cell
, int direction
);
3192 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
3193 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
3195 void assert_active_circuits_ok(or_connection_t
*orconn
);
3196 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3197 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3198 void circuit_clear_cell_queue(circuit_t
*circ
, or_connection_t
*orconn
);
3200 /********************************* rephist.c ***************************/
3202 void rep_hist_init(void);
3203 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
3204 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
3205 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
3206 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
3207 void rep_hist_note_extend_succeeded(const char *from_name
,
3208 const char *to_name
);
3209 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
3210 void rep_hist_dump_stats(time_t now
, int severity
);
3211 void rep_hist_note_bytes_read(int num_bytes
, time_t when
);
3212 void rep_hist_note_bytes_written(int num_bytes
, time_t when
);
3213 int rep_hist_bandwidth_assess(void);
3214 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
3215 void rep_hist_update_state(or_state_t
*state
);
3216 int rep_hist_load_state(or_state_t
*state
, char **err
);
3217 void rep_history_clean(time_t before
);
3219 void rep_hist_note_router_reachable(const char *id
, time_t when
);
3220 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
3221 int rep_hist_record_mtbf_data(void);
3222 int rep_hist_load_mtbf_data(time_t now
);
3224 time_t rep_hist_downrate_old_runs(time_t now
);
3225 double rep_hist_get_stability(const char *id
, time_t when
);
3226 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
3227 int rep_hist_have_measured_enough_stability(void);
3229 void rep_hist_note_used_port(uint16_t port
, time_t now
);
3230 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
3231 void rep_hist_note_used_resolve(time_t now
);
3232 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
3234 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
3235 int *need_capacity
);
3237 int any_predicted_circuits(time_t now
);
3238 int rep_hist_circbuilding_dormant(time_t now
);
3240 /** Possible public/private key operations in Tor: used to keep track of where
3241 * we're spending our time. */
3244 VERIFY_DIR
, VERIFY_RTR
,
3245 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
3246 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
3247 REND_CLIENT
, REND_MID
, REND_SERVER
,
3249 void note_crypto_pk_op(pk_op_t operation
);
3250 void dump_pk_ops(int severity
);
3252 void rep_hist_free_all(void);
3254 /* for hidden service usage statistics */
3255 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
3256 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
3257 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
3258 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
3259 void hs_usage_write_statistics_to_file(time_t now
);
3260 void hs_usage_free_all(void);
3262 /********************************* rendclient.c ***************************/
3264 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
3265 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
3266 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
3267 size_t request_len
);
3268 void rend_client_refetch_renddesc(const char *query
);
3269 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
3271 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
3272 size_t request_len
);
3273 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
3274 size_t request_len
);
3275 void rend_client_desc_here(const char *query
);
3277 extend_info_t
*rend_client_get_random_intro(const char *query
);
3279 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
3280 origin_circuit_t
*rendcirc
);
3282 /********************************* rendcommon.c ***************************/
3284 /** Information used to connect to a hidden service. */
3285 typedef struct rend_service_descriptor_t
{
3286 crypto_pk_env_t
*pk
; /**< This service's public key. */
3287 int version
; /**< 0. */
3288 time_t timestamp
; /**< Time when the descriptor was generated. */
3289 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
3290 * (We allow bits '0', '1', and '2' to be set.) */
3291 int n_intro_points
; /**< Number of introduction points. */
3292 /** Array of n_intro_points elements for this service's introduction points'
3293 * nicknames. Elements are removed from this array if introduction attempts
3295 char **intro_points
;
3296 /** Array of n_intro_points elements for this service's introduction points'
3297 * extend_infos, or NULL if this descriptor is V0. Elements are removed
3298 * from this array if introduction attempts fail. If this array is present,
3299 * its elements correspond to the elements of intro_points. */
3300 extend_info_t
**intro_point_extend_info
;
3301 } rend_service_descriptor_t
;
3303 int rend_cmp_service_ids(const char *one
, const char *two
);
3305 void rend_process_relay_cell(circuit_t
*circ
, int command
, size_t length
,
3306 const char *payload
);
3308 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
3309 int rend_encode_service_descriptor(rend_service_descriptor_t
*desc
,
3310 crypto_pk_env_t
*key
,
3313 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
3315 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
3317 /** A cached rendezvous descriptor. */
3318 typedef struct rend_cache_entry_t
{
3319 size_t len
; /**< Length of <b>desc</b> */
3320 time_t received
; /**< When was the descriptor received? */
3321 char *desc
; /**< Service descriptor */
3322 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
3323 } rend_cache_entry_t
;
3325 void rend_cache_init(void);
3326 void rend_cache_clean(void);
3327 void rend_cache_free_all(void);
3328 int rend_valid_service_id(const char *query
);
3329 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
3331 int rend_cache_lookup_entry(const char *query
, int version
,
3332 rend_cache_entry_t
**entry_out
);
3333 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
3334 int rend_cache_size(void);
3336 /********************************* rendservice.c ***************************/
3338 int num_rend_services(void);
3339 int rend_config_services(or_options_t
*options
, int validate_only
);
3340 int rend_service_load_keys(void);
3341 void rend_services_init(void);
3342 void rend_services_introduce(void);
3343 void rend_consider_services_upload(time_t now
);
3345 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
3346 int rend_service_intro_established(origin_circuit_t
*circuit
,
3347 const char *request
,
3348 size_t request_len
);
3349 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
3350 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
3351 size_t request_len
);
3352 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
3353 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
3354 origin_circuit_t
*circ
);
3355 void rend_service_dump_stats(int severity
);
3356 void rend_service_free_all(void);
3358 /********************************* rendmid.c *******************************/
3359 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
3360 size_t request_len
);
3361 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
3362 size_t request_len
);
3363 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
3364 size_t request_len
);
3365 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
3366 size_t request_len
);
3368 /********************************* router.c ***************************/
3370 crypto_pk_env_t
*get_onion_key(void);
3371 time_t get_onion_key_set_at(void);
3372 void set_identity_key(crypto_pk_env_t
*k
);
3373 crypto_pk_env_t
*get_identity_key(void);
3374 int identity_key_is_set(void);
3375 authority_cert_t
*get_my_v3_authority_cert(void);
3376 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
3377 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
3378 void rotate_onion_key(void);
3379 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
3381 void v3_authority_check_key_expiry(void);
3383 int init_keys(void);
3385 int check_whether_orport_reachable(void);
3386 int check_whether_dirport_reachable(void);
3387 void consider_testing_reachability(int test_or
, int test_dir
);
3388 void router_orport_found_reachable(void);
3389 void router_dirport_found_reachable(void);
3390 void router_perform_bandwidth_test(int num_circs
, time_t now
);
3392 int authdir_mode(or_options_t
*options
);
3393 int authdir_mode_v1(or_options_t
*options
);
3394 int authdir_mode_v2(or_options_t
*options
);
3395 int authdir_mode_v3(or_options_t
*options
);
3396 int authdir_mode_handles_descs(or_options_t
*options
);
3397 int authdir_mode_publishes_statuses(or_options_t
*options
);
3398 int authdir_mode_tests_reachability(or_options_t
*options
);
3399 int authdir_mode_bridge(or_options_t
*options
);
3400 int authdir_mode_any_nonbridge(or_options_t
*options
);
3401 int clique_mode(or_options_t
*options
);
3402 int server_mode(or_options_t
*options
);
3403 int advertised_server_mode(void);
3404 int proxy_mode(or_options_t
*options
);
3405 void consider_publishable_server(int force
);
3407 int router_is_clique_mode(routerinfo_t
*router
);
3408 void router_upload_dir_desc_to_dirservers(int force
);
3409 void mark_my_descriptor_dirty_if_older_than(time_t when
);
3410 void mark_my_descriptor_dirty(void);
3411 void check_descriptor_bandwidth_changed(time_t now
);
3412 void check_descriptor_ipaddress_changed(time_t now
);
3413 void router_new_address_suggestion(const char *suggestion
);
3414 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
3415 routerinfo_t
*router_get_my_routerinfo(void);
3416 extrainfo_t
*router_get_my_extrainfo(void);
3417 const char *router_get_my_descriptor(void);
3418 int router_digest_is_me(const char *digest
);
3419 int router_is_me(routerinfo_t
*router
);
3420 int router_fingerprint_is_me(const char *fp
);
3421 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
3422 int router_rebuild_descriptor(int force
);
3423 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
3424 crypto_pk_env_t
*ident_key
);
3425 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
3426 crypto_pk_env_t
*ident_key
);
3427 int is_legal_nickname(const char *s
);
3428 int is_legal_nickname_or_hexdigest(const char *s
);
3429 int is_legal_hexdigest(const char *s
);
3430 void router_get_verbose_nickname(char *buf
, routerinfo_t
*router
);
3431 void router_reset_warnings(void);
3432 void router_reset_reachability(void);
3433 void router_free_all(void);
3435 const char *router_purpose_to_string(uint8_t p
);
3436 uint8_t router_purpose_from_string(const char *s
);
3438 #ifdef ROUTER_PRIVATE
3439 /* Used only by router.c and test.c */
3440 void get_platform_str(char *platform
, size_t len
);
3443 /********************************* routerlist.c ***************************/
3445 /** Represents information about a single trusted directory server. */
3446 typedef struct trusted_dir_server_t
{
3449 char *address
; /**< Hostname. */
3450 uint32_t addr
; /**< IPv4 address. */
3451 uint16_t dir_port
; /**< Directory port. */
3452 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
3453 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
3454 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
3455 * high-security) identity key. */
3457 unsigned int is_running
:1; /**< True iff we think this server is running. */
3459 /** True iff this server has accepted the most recent server descriptor
3460 * we tried to upload to it. */
3461 unsigned int has_accepted_serverdesc
:1;
3463 /** What kind of authority is this? (Bitfield.) */
3464 authority_type_t type
;
3466 smartlist_t
*v3_certs
; /**< V3 key certificates for this authority */
3468 int n_networkstatus_failures
; /**< How many times have we asked for this
3469 * server's network-status unsuccessfully? */
3470 local_routerstatus_t fake_status
; /**< Used when we need to pass this trusted
3471 * dir_server_t to directory_initiate_command_*
3472 * as a routerstatus_t. Not updated by the
3473 * router-status management code!
3475 } trusted_dir_server_t
;
3477 int router_reload_router_list(void);
3478 int get_n_authorities(authority_type_t type
);
3479 smartlist_t
*router_get_trusted_dir_servers(void);
3480 routerstatus_t
*router_pick_directory_server(int requireother
,
3481 int fascistfirewall
,
3482 authority_type_t type
,
3483 int retry_if_no_servers
);
3484 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
,
3486 int fascistfirewall
,
3487 int retry_if_no_servers
);
3488 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(
3489 const char *digest
);
3490 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(
3491 const char *digest
);
3492 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
3493 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
3494 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
3495 const char *sk_digest
);
3496 void authority_certs_fetch_missing(networkstatus_vote_t
*status
);
3497 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
3498 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
3499 int must_be_running
);
3500 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
3501 routerinfo_t
*routerlist_find_my_routerinfo(void);
3502 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
3505 #define ROUTER_REQUIRED_MIN_BANDWIDTH 10000
3507 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
3508 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
3509 int need_capacity
, int need_guard
);
3510 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
3512 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
3513 } bandwidth_weight_rule_t
;
3514 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
3515 bandwidth_weight_rule_t rule
);
3516 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
3518 routerinfo_t
*router_choose_random_node(const char *preferred
,
3519 const char *excluded
,
3520 smartlist_t
*excludedsmartlist
,
3521 int need_uptime
, int need_bandwidth
,
3523 int allow_invalid
, int strict
,
3524 int weight_for_exit
);
3525 routerinfo_t
*router_get_by_nickname(const char *nickname
,
3526 int warn_if_unnamed
);
3527 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
3528 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
3529 routerinfo_t
*router_get_by_digest(const char *digest
);
3530 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
3531 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
3532 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
3533 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
3534 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
3535 int router_digest_is_trusted_dir_type(const char *digest
,
3536 authority_type_t type
);
3537 #define router_digest_is_trusted_dir(d) \
3538 router_digest_is_trusted_dir_type((d), 0)
3539 routerlist_t
*router_get_routerlist(void);
3540 void routerlist_reset_warnings(void);
3541 void routerlist_free(routerlist_t
*routerlist
);
3542 void dump_routerlist_mem_usage(int severity
);
3543 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
);
3544 void routerinfo_free(routerinfo_t
*router
);
3545 void extrainfo_free(extrainfo_t
*extrainfo
);
3546 void routerlist_free_all(void);
3547 void router_set_status(const char *digest
, int up
);
3548 void routerlist_remove_old_routers(void);
3549 int router_add_to_routerlist(routerinfo_t
*router
, const char **msg
,
3550 int from_cache
, int from_fetch
);
3551 void router_add_extrainfo_to_routerlist(extrainfo_t
*ei
, const char **msg
,
3552 int from_cache
, int from_fetch
);
3553 int router_load_single_router(const char *s
, uint8_t purpose
,
3555 void router_load_routers_from_string(const char *s
, const char *eos
,
3556 saved_location_t saved_location
,
3557 smartlist_t
*requested_fingerprints
,
3558 int descriptor_digests
,
3559 const char *prepend_annotations
);
3560 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
3561 saved_location_t saved_location
,
3562 smartlist_t
*requested_fps
,
3563 int descriptor_digests
);
3565 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
3567 int router_exit_policy_rejects_all(routerinfo_t
*router
);
3569 void add_trusted_dir_server(const char *nickname
, const char *address
,
3570 uint16_t dir_port
, uint16_t or_port
,
3572 const char *v3_auth_digest
,
3573 authority_type_t type
);
3574 void clear_trusted_dir_servers(void);
3575 int any_trusted_dir_is_v1_authority(void);
3576 networkstatus_t
*networkstatus_get_by_digest(const char *digest
);
3577 local_routerstatus_t
*router_get_combined_status_by_digest(const char *digest
);
3578 local_routerstatus_t
*router_get_combined_status_by_descriptor_digest(
3579 const char *digest
);
3581 //routerstatus_t *routerstatus_get_by_hexdigest(const char *hexdigest);
3582 int should_delay_dir_fetches(or_options_t
*options
);
3583 void update_networkstatus_downloads(time_t now
);
3584 void routerlist_retry_directory_downloads(time_t now
);
3585 void update_router_descriptor_downloads(time_t now
);
3586 void update_extrainfo_downloads(time_t now
);
3587 void routers_update_all_from_networkstatus(time_t now
);
3588 void routers_update_status_from_networkstatus(smartlist_t
*routers
,
3589 int reset_failures
);
3590 smartlist_t
*router_list_superseded(void);
3591 int router_have_minimum_dir_info(void);
3592 void router_dir_info_changed(void);
3593 void networkstatus_list_update_recent(time_t now
);
3594 void router_reset_descriptor_download_failures(void);
3595 void router_reset_status_download_failures(void);
3596 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
3597 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
3599 const char *esc_router_info(routerinfo_t
*router
);
3601 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
3602 int getinfo_helper_networkstatus(control_connection_t
*conn
,
3603 const char *question
, char **answer
);
3605 void routerlist_assert_ok(routerlist_t
*rl
);
3606 void routerlist_check_bug_417(void);
3608 int trusted_dirs_reload_certs(void);
3609 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
);
3610 void trusted_dirs_flush_certs_to_disk(void);
3612 /********************************* routerparse.c ************************/
3614 #define MAX_STATUS_TAG_LEN 32
3615 /** Structure to hold parsed Tor versions. This is a little messier
3616 * than we would like it to be, because we changed version schemes with 0.1.0.
3618 * See version-spec.txt for the whole business.
3620 typedef struct tor_version_t
{
3624 /** Release status. For version in the post-0.1 format, this is always
3626 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
3628 char status_tag
[MAX_STATUS_TAG_LEN
];
3632 typedef enum version_status_t
{
3633 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3634 VS_OLD
=1, /**< This version is older than any recommended version. */
3635 VS_NEW
=2, /**< This version is newer than any recommended version. */
3636 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3637 * in its series, but later recommended versions exist.
3639 VS_UNRECOMMENDED
=4 /**< This version is not recommended (general case). */
3642 typedef struct combined_version_status_t
{
3643 /** How many networkstatuses claim to know about versions? */
3645 /** What do the majority of networkstatuses believe about this version? */
3646 version_status_t consensus
;
3647 /** How many networkstatuses constitute the majority? */
3649 } combined_version_status_t
;
3650 char *compute_recommended_versions(time_t now
, int client
,
3651 const char *my_version
,
3652 combined_version_status_t
*status_out
);
3654 int router_get_router_hash(const char *s
, char *digest
);
3655 int router_get_dir_hash(const char *s
, char *digest
);
3656 int router_get_runningrouters_hash(const char *s
, char *digest
);
3657 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
3658 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
3659 int router_get_extrainfo_hash(const char *s
, char *digest
);
3660 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
3662 crypto_pk_env_t
*private_key
);
3663 int router_parse_list_from_string(const char **s
, const char *eos
,
3665 saved_location_t saved_location
,
3667 int allow_annotations
,
3668 const char *prepend_annotations
);
3669 int router_parse_routerlist_from_directory(const char *s
,
3670 routerlist_t
**dest
,
3671 crypto_pk_env_t
*pkey
,
3673 int write_to_cache
);
3674 int router_parse_runningrouters(const char *str
);
3675 int router_parse_directory(const char *str
);
3676 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
3678 int allow_annotations
,
3679 const char *prepend_annotations
);
3680 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
3681 int cache_copy
, struct digest_ri_map_t
*routermap
);
3682 addr_policy_t
*router_parse_addr_policy_from_string(const char *s
,
3684 version_status_t
tor_version_is_obsolete(const char *myversion
,
3685 const char *versionlist
);
3686 version_status_t
version_status_join(version_status_t a
, version_status_t b
);
3687 int tor_version_parse(const char *s
, tor_version_t
*out
);
3688 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
3689 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
3690 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
3691 void assert_addr_policy_ok(addr_policy_t
*t
);
3692 void dump_distinct_digest_count(int severity
);
3694 networkstatus_t
*networkstatus_parse_from_string(const char *s
);
3695 networkstatus_vote_t
*networkstatus_parse_vote_from_string(const char *s
,
3696 const char **eos_out
,
3698 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
3699 const char *s
, const char *eos
);
3701 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
3702 const char **end_of_string
);