1 /* Copyright (c) 2001 Matej Pfajfar.
2 * Copyright (c) 2001-2004, Roger Dingledine.
3 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4 * Copyright (c) 2007-2008, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
10 * \brief Master header file for Tor-specific functionality.
15 #define OR_H_ID "$Id$"
19 #define WIN32_WINNT 0x400
20 #define _WIN32_WINNT 0x400
21 #define WIN32_LEAN_AND_MEAN
33 #ifdef HAVE_SYS_PARAM_H
34 #include <sys/param.h> /* FreeBSD needs this to know what version it is */
37 #ifdef HAVE_SYS_WAIT_H
40 #ifdef HAVE_SYS_FCNTL_H
41 #include <sys/fcntl.h>
46 #ifdef HAVE_SYS_IOCTL_H
47 #include <sys/ioctl.h>
52 #ifdef HAVE_SYS_STAT_H
55 #ifdef HAVE_ARPA_INET_H
56 #include <arpa/inet.h>
73 #define snprintf _snprintf
80 #include "container.h"
86 /* These signals are defined to help control_signal_act work.
103 /* Controller signals start at a high number so we don't
104 * conflict with system-defined signals. */
105 #define SIGNEWNYM 129
106 #define SIGCLEARDNSCACHE 130
108 #if (SIZEOF_CELL_T != 0)
109 /* On Irix, stdlib.h defines a cell_t type, so we need to make sure
110 * that our stuff always calls cell_t something different. */
111 #define cell_t tor_cell_t
114 /** Length of longest allowable configured nickname. */
115 #define MAX_NICKNAME_LEN 19
116 /** Length of a router identity encoded as a hexadecimal digest, plus
117 * possible dollar sign. */
118 #define MAX_HEX_NICKNAME_LEN (HEX_DIGEST_LEN+1)
119 /** Maximum length of verbose router identifier: dollar sign, hex ID digest,
120 * equal sign or tilde, nickname. */
121 #define MAX_VERBOSE_NICKNAME_LEN (1+HEX_DIGEST_LEN+1+MAX_NICKNAME_LEN)
123 /** Maximum size, in bytes, for resized buffers. */
124 #define MAX_BUF_SIZE ((1<<24)-1) /* 16MB-1 */
125 /** Maximum size, in bytes, for any directory object that we've downloaded. */
126 #define MAX_DIR_DL_SIZE MAX_BUF_SIZE
128 /** For http parsing: Maximum number of bytes we'll accept in the headers
129 * of an HTTP request or response. */
130 #define MAX_HEADERS_SIZE 50000
131 /** Maximum size, in bytes, for any directory object that we're accepting
133 #define MAX_DIR_UL_SIZE 500000
135 /** Maximum size, in bytes, of a single router descriptor uploaded to us
136 * as a directory authority. Caches and clients fetch whatever descriptors
137 * the authorities tell them to fetch, and don't care about size. */
138 #define MAX_DESCRIPTOR_UPLOAD_SIZE 20000
140 /** Maximum size of a single extrainfo document, as above. */
141 #define MAX_EXTRAINFO_UPLOAD_SIZE 50000
143 /** How long do we keep DNS cache entries before purging them (regardless of
145 #define MAX_DNS_ENTRY_AGE (30*60)
146 /** How long do we cache/tell clients to cache DNS records when no TTL is
148 #define DEFAULT_DNS_TTL (30*60)
149 /** How long can a TTL be before we stop believing it? */
150 #define MAX_DNS_TTL (3*60*60)
151 /** How small can a TTL be before we stop believing it? Provides rudimentary
153 #define MIN_DNS_TTL (60)
155 /** How often do we rotate onion keys? */
156 #define MIN_ONION_KEY_LIFETIME (7*24*60*60)
157 /** How often do we rotate TLS contexts? */
158 #define MAX_SSL_KEY_LIFETIME (2*60*60)
160 /** How old do we allow a router to get before removing it
161 * from the router list? In seconds. */
162 #define ROUTER_MAX_AGE (60*60*48)
163 /** How old can a router get before we (as a server) will no longer
164 * consider it live? In seconds. */
165 #define ROUTER_MAX_AGE_TO_PUBLISH (60*60*20)
166 /** How old do we let a saved descriptor get before force-removing it? */
167 #define OLD_ROUTER_DESC_MAX_AGE (60*60*24*5)
169 /** Possible rules for generating circuit IDs on an OR connection. */
171 CIRC_ID_TYPE_LOWER
=0, /**< Pick from 0..1<<15-1. */
172 CIRC_ID_TYPE_HIGHER
=1, /**< Pick from 1<<15..1<<16-1. */
173 /** The other side of a connection is an OP: never create circuits to it,
174 * and let it use any circuit ID it wants. */
175 CIRC_ID_TYPE_NEITHER
=2
178 #define _CONN_TYPE_MIN 3
179 /** Type for sockets listening for OR connections. */
180 #define CONN_TYPE_OR_LISTENER 3
181 /** A bidirectional TLS connection transmitting a sequence of cells.
182 * May be from an OR to an OR, or from an OP to an OR. */
183 #define CONN_TYPE_OR 4
184 /** A TCP connection from an onion router to a stream's destination. */
185 #define CONN_TYPE_EXIT 5
186 /** Type for sockets listening for SOCKS connections. */
187 #define CONN_TYPE_AP_LISTENER 6
188 /** A SOCKS proxy connection from the user application to the onion
190 #define CONN_TYPE_AP 7
191 /** Type for sockets listening for HTTP connections to the directory server. */
192 #define CONN_TYPE_DIR_LISTENER 8
193 /** Type for HTTP connections to the directory server. */
194 #define CONN_TYPE_DIR 9
195 /** Connection from the main process to a CPU worker process. */
196 #define CONN_TYPE_CPUWORKER 10
197 /** Type for listening for connections from user interface process. */
198 #define CONN_TYPE_CONTROL_LISTENER 11
199 /** Type for connections from user interface process. */
200 #define CONN_TYPE_CONTROL 12
201 /** Type for sockets listening for transparent connections redirected by pf or
203 #define CONN_TYPE_AP_TRANS_LISTENER 13
204 /** Type for sockets listening for transparent connections redirected by
206 #define CONN_TYPE_AP_NATD_LISTENER 14
207 /** Type for sockets listening for DNS requests. */
208 #define CONN_TYPE_AP_DNS_LISTENER 15
209 #define _CONN_TYPE_MAX 15
210 /* !!!! If _CONN_TYPE_MAX is ever over 15, we must grow the type field in
213 #define CONN_IS_EDGE(x) \
214 ((x)->type == CONN_TYPE_EXIT || (x)->type == CONN_TYPE_AP)
216 /** State for any listener connection. */
217 #define LISTENER_STATE_READY 0
219 #define _CPUWORKER_STATE_MIN 1
220 /** State for a connection to a cpuworker process that's idle. */
221 #define CPUWORKER_STATE_IDLE 1
222 /** State for a connection to a cpuworker process that's processing a
224 #define CPUWORKER_STATE_BUSY_ONION 2
225 #define _CPUWORKER_STATE_MAX 2
227 #define CPUWORKER_TASK_ONION CPUWORKER_STATE_BUSY_ONION
229 #define _OR_CONN_STATE_MIN 1
230 /** State for a connection to an OR: waiting for connect() to finish. */
231 #define OR_CONN_STATE_CONNECTING 1
232 /** State for a connection to an OR: waiting for proxy command to flush. */
233 #define OR_CONN_STATE_PROXY_FLUSHING 2
234 /** State for a connection to an OR: waiting for proxy response. */
235 #define OR_CONN_STATE_PROXY_READING 3
236 /** State for a connection to an OR or client: SSL is handshaking, not done
238 #define OR_CONN_STATE_TLS_HANDSHAKING 4
239 /** State for a connection to an OR: We're doing a second SSL handshake for
240 * renegotiation purposes. */
241 #define OR_CONN_STATE_TLS_CLIENT_RENEGOTIATING 5
242 /** State for a connection at an OR: We're waiting for the client to
244 #define OR_CONN_STATE_TLS_SERVER_RENEGOTIATING 6
245 /** State for a connection to an OR: We're done with our SSL handshake, but we
246 * haven't yet negotiated link protocol versions and sent a netinfo cell.
248 #define OR_CONN_STATE_OR_HANDSHAKING 7
249 /** State for a connection to an OR: Ready to send/receive cells. */
250 #define OR_CONN_STATE_OPEN 8
251 #define _OR_CONN_STATE_MAX 8
253 #define _EXIT_CONN_STATE_MIN 1
254 /** State for an exit connection: waiting for response from dns farm. */
255 #define EXIT_CONN_STATE_RESOLVING 1
256 /** State for an exit connection: waiting for connect() to finish. */
257 #define EXIT_CONN_STATE_CONNECTING 2
258 /** State for an exit connection: open and ready to transmit data. */
259 #define EXIT_CONN_STATE_OPEN 3
260 /** State for an exit connection: waiting to be removed. */
261 #define EXIT_CONN_STATE_RESOLVEFAILED 4
262 #define _EXIT_CONN_STATE_MAX 4
264 /* The AP state values must be disjoint from the EXIT state values. */
265 #define _AP_CONN_STATE_MIN 5
266 /** State for a SOCKS connection: waiting for SOCKS request. */
267 #define AP_CONN_STATE_SOCKS_WAIT 5
268 /** State for a SOCKS connection: got a y.onion URL; waiting to receive
269 * rendezvous descriptor. */
270 #define AP_CONN_STATE_RENDDESC_WAIT 6
271 /** The controller will attach this connection to a circuit; it isn't our
273 #define AP_CONN_STATE_CONTROLLER_WAIT 7
274 /** State for a SOCKS connection: waiting for a completed circuit. */
275 #define AP_CONN_STATE_CIRCUIT_WAIT 8
276 /** State for a SOCKS connection: sent BEGIN, waiting for CONNECTED. */
277 #define AP_CONN_STATE_CONNECT_WAIT 9
278 /** State for a SOCKS connection: sent RESOLVE, waiting for RESOLVED. */
279 #define AP_CONN_STATE_RESOLVE_WAIT 10
280 /** State for a SOCKS connection: ready to send and receive. */
281 #define AP_CONN_STATE_OPEN 11
282 /** State for a transparent natd connection: waiting for original
284 #define AP_CONN_STATE_NATD_WAIT 12
285 #define _AP_CONN_STATE_MAX 12
287 /** True iff the AP_CONN_STATE_* value <b>s</b> means that the corresponding
288 * edge connection is not attached to any circuit. */
289 #define AP_CONN_STATE_IS_UNATTACHED(s) \
290 ((s) <= AP_CONN_STATE_CIRCUIT_WAIT || (s) == AP_CONN_STATE_NATD_WAIT)
292 #define _DIR_CONN_STATE_MIN 1
293 /** State for connection to directory server: waiting for connect(). */
294 #define DIR_CONN_STATE_CONNECTING 1
295 /** State for connection to directory server: sending HTTP request. */
296 #define DIR_CONN_STATE_CLIENT_SENDING 2
297 /** State for connection to directory server: reading HTTP response. */
298 #define DIR_CONN_STATE_CLIENT_READING 3
299 /** State for connection to directory server: happy and finished. */
300 #define DIR_CONN_STATE_CLIENT_FINISHED 4
301 /** State for connection at directory server: waiting for HTTP request. */
302 #define DIR_CONN_STATE_SERVER_COMMAND_WAIT 5
303 /** State for connection at directory server: sending HTTP response. */
304 #define DIR_CONN_STATE_SERVER_WRITING 6
305 #define _DIR_CONN_STATE_MAX 6
307 /** True iff the purpose of <b>conn</b> means that it's a server-side
308 * directory connection. */
309 #define DIR_CONN_IS_SERVER(conn) ((conn)->purpose == DIR_PURPOSE_SERVER)
311 #define _CONTROL_CONN_STATE_MIN 1
312 /** State for a control connection: Authenticated and accepting v1 commands. */
313 #define CONTROL_CONN_STATE_OPEN 1
314 /** State for a control connection: Waiting for authentication; speaking
316 #define CONTROL_CONN_STATE_NEEDAUTH 2
317 #define _CONTROL_CONN_STATE_MAX 2
319 #define _DIR_PURPOSE_MIN 1
320 /** A connection to a directory server: download a directory. */
321 #define DIR_PURPOSE_FETCH_DIR 1
322 /** A connection to a directory server: download just the list
323 * of running routers. */
324 #define DIR_PURPOSE_FETCH_RUNNING_LIST 2
325 /** A connection to a directory server: download a rendezvous
327 #define DIR_PURPOSE_FETCH_RENDDESC 3
328 /** A connection to a directory server: set after a rendezvous
329 * descriptor is downloaded. */
330 #define DIR_PURPOSE_HAS_FETCHED_RENDDESC 4
331 /** A connection to a directory server: download one or more v2
332 * network-status objects */
333 #define DIR_PURPOSE_FETCH_NETWORKSTATUS 5
334 /** A connection to a directory server: download one or more server
336 #define DIR_PURPOSE_FETCH_SERVERDESC 6
337 /** A connection to a directory server: download one or more extra-info
339 #define DIR_PURPOSE_FETCH_EXTRAINFO 7
340 /** A connection to a directory server: upload a server descriptor. */
341 #define DIR_PURPOSE_UPLOAD_DIR 8
342 /** A connection to a directory server: upload a rendezvous
344 #define DIR_PURPOSE_UPLOAD_RENDDESC 9
345 /** A connection to a directory server: upload a v3 networkstatus vote. */
346 #define DIR_PURPOSE_UPLOAD_VOTE 10
347 /** A connection to a directory server: upload a v3 consensus signature */
348 #define DIR_PURPOSE_UPLOAD_SIGNATURES 11
349 /** A connection to a directory server: download one or more network-status
350 * objects [XXX wtf, these are all the same comment] */
351 #define DIR_PURPOSE_FETCH_STATUS_VOTE 12
352 /** A connection to a directory server: download one or more network-status
354 #define DIR_PURPOSE_FETCH_DETACHED_SIGNATURES 13
355 /** A connection to a directory server: download one or more network-status
357 #define DIR_PURPOSE_FETCH_CONSENSUS 14
358 /** A connection to a directory server: download one or more network-status
360 #define DIR_PURPOSE_FETCH_CERTIFICATE 15
362 /** Purpose for connection at a directory server. */
363 #define DIR_PURPOSE_SERVER 16
364 /** A connection to a hidden service directory server: upload a v2 rendezvous
366 #define DIR_PURPOSE_UPLOAD_RENDDESC_V2 17
367 /** A connection to a hidden service directory server: download a v2 rendezvous
369 #define DIR_PURPOSE_FETCH_RENDDESC_V2 18
370 #define _DIR_PURPOSE_MAX 18
372 #define DIR_PURPOSE_IS_UPLOAD(p) \
373 ((p)==DIR_PURPOSE_UPLOAD_DIR || \
374 (p)==DIR_PURPOSE_UPLOAD_RENDDESC || \
375 (p)==DIR_PURPOSE_UPLOAD_VOTE || \
376 (p)==DIR_PURPOSE_UPLOAD_SIGNATURES)
378 #define _EXIT_PURPOSE_MIN 1
379 /** This exit stream wants to do an ordinary connect. */
380 #define EXIT_PURPOSE_CONNECT 1
381 /** This exit stream wants to do a resolve (either normal or reverse). */
382 #define EXIT_PURPOSE_RESOLVE 2
383 #define _EXIT_PURPOSE_MAX 2
385 /* !!!! If any connection purpose is ever over over 31, we must grow the type
386 * field in connection_t. */
388 /** Circuit state: I'm the origin, still haven't done all my handshakes. */
389 #define CIRCUIT_STATE_BUILDING 0
390 /** Circuit state: Waiting to process the onionskin. */
391 #define CIRCUIT_STATE_ONIONSKIN_PENDING 1
392 /** Circuit state: I'd like to deliver a create, but my n_conn is still
394 #define CIRCUIT_STATE_OR_WAIT 2
395 /** Circuit state: onionskin(s) processed, ready to send/receive cells. */
396 #define CIRCUIT_STATE_OPEN 3
398 #define _CIRCUIT_PURPOSE_MIN 1
400 /* these circuits were initiated elsewhere */
401 #define _CIRCUIT_PURPOSE_OR_MIN 1
402 /** OR-side circuit purpose: normal circuit, at OR. */
403 #define CIRCUIT_PURPOSE_OR 1
404 /** OR-side circuit purpose: At OR, from Bob, waiting for intro from Alices. */
405 #define CIRCUIT_PURPOSE_INTRO_POINT 2
406 /** OR-side circuit purpose: At OR, from Alice, waiting for Bob. */
407 #define CIRCUIT_PURPOSE_REND_POINT_WAITING 3
408 /** OR-side circuit purpose: At OR, both circuits have this purpose. */
409 #define CIRCUIT_PURPOSE_REND_ESTABLISHED 4
410 #define _CIRCUIT_PURPOSE_OR_MAX 4
412 /* these circuits originate at this node */
414 /* here's how circ client-side purposes work:
415 * normal circuits are C_GENERAL.
416 * circuits that are c_introducing are either on their way to
417 * becoming open, or they are open and waiting for a
418 * suitable rendcirc before they send the intro.
419 * circuits that are c_introduce_ack_wait have sent the intro,
420 * but haven't gotten a response yet.
421 * circuits that are c_establish_rend are either on their way
422 * to becoming open, or they are open and have sent the
423 * establish_rendezvous cell but haven't received an ack.
424 * circuits that are c_rend_ready are open and have received a
425 * rend ack, but haven't heard from bob yet. if they have a
426 * buildstate->pending_final_cpath then they're expecting a
427 * cell from bob, else they're not.
428 * circuits that are c_rend_ready_intro_acked are open, and
429 * some intro circ has sent its intro and received an ack.
430 * circuits that are c_rend_joined are open, have heard from
431 * bob, and are talking to him.
433 /** Client-side circuit purpose: Normal circuit, with cpath. */
434 #define CIRCUIT_PURPOSE_C_GENERAL 5
435 /** Client-side circuit purpose: at Alice, connecting to intro point. */
436 #define CIRCUIT_PURPOSE_C_INTRODUCING 6
437 /** Client-side circuit purpose: at Alice, sent INTRODUCE1 to intro point,
438 * waiting for ACK/NAK. */
439 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACK_WAIT 7
440 /** Client-side circuit purpose: at Alice, introduced and acked, closing. */
441 #define CIRCUIT_PURPOSE_C_INTRODUCE_ACKED 8
442 /** Client-side circuit purpose: at Alice, waiting for ack. */
443 #define CIRCUIT_PURPOSE_C_ESTABLISH_REND 9
444 /** Client-side circuit purpose: at Alice, waiting for Bob. */
445 #define CIRCUIT_PURPOSE_C_REND_READY 10
446 /** Client-side circuit purpose: at Alice, waiting for Bob, INTRODUCE
447 * has been acknowledged. */
448 #define CIRCUIT_PURPOSE_C_REND_READY_INTRO_ACKED 11
449 /** Client-side circuit purpose: at Alice, rendezvous established. */
450 #define CIRCUIT_PURPOSE_C_REND_JOINED 12
452 /** Hidden-service-side circuit purpose: at Bob, waiting for introductions. */
453 #define CIRCUIT_PURPOSE_S_ESTABLISH_INTRO 13
454 /** Hidden-service-side circuit purpose: at Bob, successfully established
456 #define CIRCUIT_PURPOSE_S_INTRO 14
457 /** Hidden-service-side circuit purpose: at Bob, connecting to rend point. */
458 #define CIRCUIT_PURPOSE_S_CONNECT_REND 15
459 /** Hidden-service-side circuit purpose: at Bob, rendezvous established. */
460 #define CIRCUIT_PURPOSE_S_REND_JOINED 16
461 /** A testing circuit; not meant to be used for actual traffic. */
462 #define CIRCUIT_PURPOSE_TESTING 17
463 /** A controller made this circuit and Tor should not use it. */
464 #define CIRCUIT_PURPOSE_CONTROLLER 18
465 #define _CIRCUIT_PURPOSE_MAX 18
466 /** A catch-all for unrecognized purposes. Currently we don't expect
467 * to make or see any circuits with this purpose. */
468 #define CIRCUIT_PURPOSE_UNKNOWN 255
470 /** True iff the circuit purpose <b>p</b> is for a circuit that
471 * originated at this node. */
472 #define CIRCUIT_PURPOSE_IS_ORIGIN(p) ((p)>_CIRCUIT_PURPOSE_OR_MAX)
473 #define CIRCUIT_IS_ORIGIN(c) (CIRCUIT_PURPOSE_IS_ORIGIN((c)->purpose))
475 /** How many circuits do we want simultaneously in-progress to handle
477 #define MIN_CIRCUITS_HANDLING_STREAM 2
479 #define RELAY_COMMAND_BEGIN 1
480 #define RELAY_COMMAND_DATA 2
481 #define RELAY_COMMAND_END 3
482 #define RELAY_COMMAND_CONNECTED 4
483 #define RELAY_COMMAND_SENDME 5
484 #define RELAY_COMMAND_EXTEND 6
485 #define RELAY_COMMAND_EXTENDED 7
486 #define RELAY_COMMAND_TRUNCATE 8
487 #define RELAY_COMMAND_TRUNCATED 9
488 #define RELAY_COMMAND_DROP 10
489 #define RELAY_COMMAND_RESOLVE 11
490 #define RELAY_COMMAND_RESOLVED 12
491 #define RELAY_COMMAND_BEGIN_DIR 13
493 #define RELAY_COMMAND_ESTABLISH_INTRO 32
494 #define RELAY_COMMAND_ESTABLISH_RENDEZVOUS 33
495 #define RELAY_COMMAND_INTRODUCE1 34
496 #define RELAY_COMMAND_INTRODUCE2 35
497 #define RELAY_COMMAND_RENDEZVOUS1 36
498 #define RELAY_COMMAND_RENDEZVOUS2 37
499 #define RELAY_COMMAND_INTRO_ESTABLISHED 38
500 #define RELAY_COMMAND_RENDEZVOUS_ESTABLISHED 39
501 #define RELAY_COMMAND_INTRODUCE_ACK 40
503 /* Reasons why an OR connection is closed */
504 #define END_OR_CONN_REASON_DONE 1
505 #define END_OR_CONN_REASON_REFUSED 2 /* connection refused */
506 #define END_OR_CONN_REASON_OR_IDENTITY 3
507 #define END_OR_CONN_REASON_CONNRESET 4 /* connection reset by peer */
508 #define END_OR_CONN_REASON_TIMEOUT 5
509 #define END_OR_CONN_REASON_NO_ROUTE 6 /* no route to host/net */
510 #define END_OR_CONN_REASON_IO_ERROR 7 /* read/write error */
511 #define END_OR_CONN_REASON_RESOURCE_LIMIT 8 /* sockets, buffers, etc */
512 #define END_OR_CONN_REASON_MISC 9
514 /* Reasons why we (or a remote OR) might close a stream. See tor-spec.txt for
515 * documentation of these. */
516 #define END_STREAM_REASON_MISC 1
517 #define END_STREAM_REASON_RESOLVEFAILED 2
518 #define END_STREAM_REASON_CONNECTREFUSED 3
519 #define END_STREAM_REASON_EXITPOLICY 4
520 #define END_STREAM_REASON_DESTROY 5
521 #define END_STREAM_REASON_DONE 6
522 #define END_STREAM_REASON_TIMEOUT 7
523 /* 8 is unallocated for historical reasons. */
524 #define END_STREAM_REASON_HIBERNATING 9
525 #define END_STREAM_REASON_INTERNAL 10
526 #define END_STREAM_REASON_RESOURCELIMIT 11
527 #define END_STREAM_REASON_CONNRESET 12
528 #define END_STREAM_REASON_TORPROTOCOL 13
529 #define END_STREAM_REASON_NOTDIRECTORY 14
530 #define END_STREAM_REASON_ENTRYPOLICY 15
532 /* These high-numbered end reasons are not part of the official spec,
533 * and are not intended to be put in relay end cells. They are here
534 * to be more informative when sending back socks replies to the
536 /* XXXX 256 is no longer used; feel free to reuse it. */
537 /** We were unable to attach the connection to any circuit at all. */
538 /* XXXX the ways we use this one don't make a lot of sense. */
539 #define END_STREAM_REASON_CANT_ATTACH 257
540 /** We can't connect to any directories at all, so we killed our streams
541 * before they can time out. */
542 #define END_STREAM_REASON_NET_UNREACHABLE 258
543 /** This is a SOCKS connection, and the client used (or misused) the SOCKS
544 * protocol in a way we couldn't handle. */
545 #define END_STREAM_REASON_SOCKSPROTOCOL 259
546 /** This is a transparent proxy connection, but we can't extract the original
547 * target address:port. */
548 #define END_STREAM_REASON_CANT_FETCH_ORIG_DEST 260
549 /** This is a connection on the NATD port, and the destination IP:Port was
550 * either ill-formed or out-of-range. */
551 #define END_STREAM_REASON_INVALID_NATD_DEST 261
553 /** Bitwise-and this value with endreason to mask out all flags. */
554 #define END_STREAM_REASON_MASK 511
556 /** Bitwise-or this with the argument to control_event_stream_status
557 * to indicate that the reason came from an END cell. */
558 #define END_STREAM_REASON_FLAG_REMOTE 512
559 /** Bitwise-or this with the argument to control_event_stream_status
560 * to indicate that we already sent a CLOSED stream event. */
561 #define END_STREAM_REASON_FLAG_ALREADY_SENT_CLOSED 1024
562 /** Bitwise-or this with endreason to indicate that we already sent
563 * a socks reply, and no further reply needs to be sent from
564 * connection_mark_unattached_ap(). */
565 #define END_STREAM_REASON_FLAG_ALREADY_SOCKS_REPLIED 2048
567 /** Reason for remapping an AP connection's address: we have a cached
569 #define REMAP_STREAM_SOURCE_CACHE 1
570 /** Reason for remapping an AP connection's address: the exit node told us an
572 #define REMAP_STREAM_SOURCE_EXIT 2
574 /* 'type' values to use in RESOLVED cells. Specified in tor-spec.txt. */
575 #define RESOLVED_TYPE_HOSTNAME 0
576 #define RESOLVED_TYPE_IPV4 4
577 #define RESOLVED_TYPE_IPV6 6
578 #define RESOLVED_TYPE_ERROR_TRANSIENT 0xF0
579 #define RESOLVED_TYPE_ERROR 0xF1
581 /* Negative reasons are internal: we never send them in a DESTROY or TRUNCATE
582 * call; they only go to the controller for tracking */
583 /** We couldn't build a path for this circuit. */
584 #define END_CIRC_REASON_NOPATH -2
585 /** Catch-all "other" reason for closing origin circuits. */
586 #define END_CIRC_AT_ORIGIN -1
588 /* Reasons why we (or a remote OR) might close a circuit. See tor-spec.txt for
589 * documentation of these. */
590 #define _END_CIRC_REASON_MIN 0
591 #define END_CIRC_REASON_NONE 0
592 #define END_CIRC_REASON_TORPROTOCOL 1
593 #define END_CIRC_REASON_INTERNAL 2
594 #define END_CIRC_REASON_REQUESTED 3
595 #define END_CIRC_REASON_HIBERNATING 4
596 #define END_CIRC_REASON_RESOURCELIMIT 5
597 #define END_CIRC_REASON_CONNECTFAILED 6
598 #define END_CIRC_REASON_OR_IDENTITY 7
599 #define END_CIRC_REASON_OR_CONN_CLOSED 8
600 #define END_CIRC_REASON_FINISHED 9
601 #define END_CIRC_REASON_TIMEOUT 10
602 #define END_CIRC_REASON_DESTROYED 11
603 #define END_CIRC_REASON_NOSUCHSERVICE 12
604 #define _END_CIRC_REASON_MAX 12
606 /** Bitwise-OR this with the argument to circuit_mark_for_close() or
607 * control_event_circuit_status() to indicate that the reason was
608 * passed through from a destroy or truncate cell. */
609 #define END_CIRC_REASON_FLAG_REMOTE 512
611 /** Length of 'y' portion of 'y.onion' URL. */
612 #define REND_SERVICE_ID_LEN_BASE32 16
614 /** Length of a binary-encoded rendezvous service ID. */
615 #define REND_SERVICE_ID_LEN 10
617 /** Time period for which a v2 descriptor will be valid. */
618 #define REND_TIME_PERIOD_V2_DESC_VALIDITY (24*60*60)
620 /** Time period within which two sets of v2 descriptors will be uploaded in
622 #define REND_TIME_PERIOD_OVERLAPPING_V2_DESCS (60*60)
624 /** Number of non-consecutive replicas (i.e. distributed somewhere
625 * in the ring) for a descriptor. */
626 #define REND_NUMBER_OF_NON_CONSECUTIVE_REPLICAS 2
628 /** Number of consecutive replicas for a descriptor. */
629 #define REND_NUMBER_OF_CONSECUTIVE_REPLICAS 3
631 /** Length of v2 descriptor ID (32 base32 chars = 160 bits). */
632 #define REND_DESC_ID_V2_LEN_BASE32 32
634 /** Length of the base32-encoded secret ID part of versioned hidden service
636 #define REND_SECRET_ID_PART_LEN_BASE32 32
638 /** Length of the base32-encoded hash of an introduction point's
640 #define REND_INTRO_POINT_ID_LEN_BASE32 32
642 #define CELL_DIRECTION_IN 1
643 #define CELL_DIRECTION_OUT 2
645 /** Initial value for both sides of a circuit transmission window when the
646 * circuit is initialized. Measured in cells. */
647 #define CIRCWINDOW_START 1000
648 /** Amount to increment a circuit window when we get a circuit SENDME. */
649 #define CIRCWINDOW_INCREMENT 100
650 /** Initial value on both sides of a stream transmission window when the
651 * stream is initialized. Measured in cells. */
652 #define STREAMWINDOW_START 500
653 /** Amount to increment a stream window when we get a stream SENDME. */
654 #define STREAMWINDOW_INCREMENT 50
657 #define CELL_PADDING 0
658 #define CELL_CREATE 1
659 #define CELL_CREATED 2
661 #define CELL_DESTROY 4
662 #define CELL_CREATE_FAST 5
663 #define CELL_CREATED_FAST 6
664 #define CELL_VERSIONS 7
665 #define CELL_NETINFO 8
666 #define CELL_RELAY_EARLY 9
668 #define CELL_COMMAND_IS_VAR_LENGTH(x) ((x) == CELL_VERSIONS)
670 /** How long to test reachability before complaining to the user. */
671 #define TIMEOUT_UNTIL_UNREACHABILITY_COMPLAINT (20*60)
673 /** Legal characters in a nickname. */
674 #define LEGAL_NICKNAME_CHARACTERS \
675 "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789"
677 /** Name to use in client TLS certificates if no nickname is given. Once
678 * Tor 0.1.2.x is obsolete, we can remove this. */
679 #define DEFAULT_CLIENT_NICKNAME "client"
681 /** Number of bytes in a SOCKS4 header. */
682 #define SOCKS4_NETWORK_LEN 8
684 /** Specified SOCKS5 status codes. */
686 SOCKS5_SUCCEEDED
= 0x00,
687 SOCKS5_GENERAL_ERROR
= 0x01,
688 SOCKS5_NOT_ALLOWED
= 0x02,
689 SOCKS5_NET_UNREACHABLE
= 0x03,
690 SOCKS5_HOST_UNREACHABLE
= 0x04,
691 SOCKS5_CONNECTION_REFUSED
= 0x05,
692 SOCKS5_TTL_EXPIRED
= 0x06,
693 SOCKS5_COMMAND_NOT_SUPPORTED
= 0x07,
694 SOCKS5_ADDRESS_TYPE_NOT_SUPPORTED
= 0x08,
695 } socks5_reply_status_t
;
699 * Relay command [1 byte]
700 * Recognized [2 bytes]
701 * Stream ID [2 bytes]
702 * Partial SHA-1 [4 bytes]
704 * Relay payload [498 bytes]
707 /** Number of bytes in a cell, minus cell header. */
708 #define CELL_PAYLOAD_SIZE 509
709 /** Number of bytes in a cell transmitted over the network. */
710 #define CELL_NETWORK_SIZE 512
712 #define VAR_CELL_HEADER_SIZE 5
714 /** Number of bytes in a relay cell's header (not including general cell
716 #define RELAY_HEADER_SIZE (1+2+2+4+2)
717 /** Largest number of bytes that can fit in a relay cell payload. */
718 #define RELAY_PAYLOAD_SIZE (CELL_PAYLOAD_SIZE-RELAY_HEADER_SIZE)
720 /** Parsed onion routing cell. All communication between nodes
722 typedef struct cell_t
{
723 uint16_t circ_id
; /**< Circuit which received the cell. */
724 uint8_t command
; /**< Type of the cell: one of CELL_PADDING, CELL_CREATE,
725 * CELL_DESTROY, etc */
726 char payload
[CELL_PAYLOAD_SIZE
]; /**< Cell body. */
729 /** Parsed variable-length onion routing cell. */
730 typedef struct var_cell_t
{
733 uint16_t payload_len
;
737 /** A cell as packed for writing to the network. */
738 typedef struct packed_cell_t
{
739 struct packed_cell_t
*next
; /**< Next cell queued on this circuit. */
740 char body
[CELL_NETWORK_SIZE
]; /**< Cell as packed for network. */
743 /** A queue of cells on a circuit, waiting to be added to the
744 * or_connection_t's outbuf. */
745 typedef struct cell_queue_t
{
746 packed_cell_t
*head
; /**< The first cell, or NULL if the queue is empty. */
747 packed_cell_t
*tail
; /**< The last cell, or NULL if the queue is empty. */
748 int n
; /**< The number of cells in the queue. */
751 /** Beginning of a RELAY cell payload. */
753 uint8_t command
; /**< The end-to-end relay command. */
754 uint16_t recognized
; /**< Used to tell whether cell is for us. */
755 uint16_t stream_id
; /**< Which stream is this cell associated with? */
756 char integrity
[4]; /**< Used to tell whether cell is corrupted. */
757 uint16_t length
; /**< How long is the payload body? */
760 typedef struct buf_t buf_t
;
761 typedef struct socks_request_t socks_request_t
;
763 /* Values for connection_t.magic: used to make sure that downcasts (casts from
764 * connection_t to foo_connection_t) are safe. */
765 #define BASE_CONNECTION_MAGIC 0x7C3C304Eu
766 #define OR_CONNECTION_MAGIC 0x7D31FF03u
767 #define EDGE_CONNECTION_MAGIC 0xF0374013u
768 #define DIR_CONNECTION_MAGIC 0x9988ffeeu
769 #define CONTROL_CONNECTION_MAGIC 0x8abc765du
771 /** Description of a connection to another host or process, and associated
774 * A connection is named based on what it's connected to -- an "OR
775 * connection" has a Tor node on the other end, an "exit
776 * connection" has a website or other server on the other end, and an
777 * "AP connection" has an application proxy (and thus a user) on the
780 * Every connection has a type and a state. Connections never change
781 * their type, but can go through many state changes in their lifetime.
783 * Every connection has two associated input and output buffers.
784 * Listeners don't use them. For non-listener connections, incoming
785 * data is appended to conn->inbuf, and outgoing data is taken from
786 * conn->outbuf. Connections differ primarily in the functions called
787 * to fill and drain these buffers.
789 typedef struct connection_t
{
790 uint32_t magic
; /**< For memory debugging: must equal one of
791 * *_CONNECTION_MAGIC. */
793 uint8_t state
; /**< Current state of this connection. */
794 unsigned int type
:4; /**< What kind of connection is this? */
795 unsigned int purpose
:5; /**< Only used for DIR and EXIT types currently. */
797 /* The next fields are all one-bit booleans. Some are only applicable to
798 * connection subtypes, but we hold them here anyway, to save space.
800 unsigned int read_blocked_on_bw
:1; /**< Boolean: should we start reading
801 * again once the bandwidth throttler allows it? */
802 unsigned int write_blocked_on_bw
:1; /**< Boolean: should we start writing
803 * again once the bandwidth throttler allows
805 unsigned int hold_open_until_flushed
:1; /**< Despite this connection's being
806 * marked for close, do we flush it
807 * before closing it? */
808 unsigned int inbuf_reached_eof
:1; /**< Boolean: did read() return 0 on this
810 unsigned int edge_has_sent_end
:1; /**< For debugging; only used on edge
811 * connections. Set once we've set the stream end,
812 * and check in connection_about_to_close_connection().
814 /** Edge connections only: true if we've blocked reading until the
815 * circuit has fewer queued cells. */
816 unsigned int edge_blocked_on_circ
:1;
817 /** Used for OR conns that shouldn't get any new circs attached to them,
818 * because the connection is too old. */
819 /* XXXX "obsolete" isn't really a good name here. */
820 unsigned int or_is_obsolete
:1;
821 /** For AP connections only. If 1, and we fail to reach the chosen exit,
822 * stop requiring it. */
823 unsigned int chosen_exit_optional
:1;
824 /** For AP connections only. If non-zero, this exit node was picked as
825 * a result of the TrackHostExit, and the value decrements every time
826 * we fail to complete a circuit to our chosen exit -- if it reaches
827 * zero, abandon the associated mapaddress. */
828 unsigned int chosen_exit_retries
:3;
829 /** Set to 1 when we're inside connection_flushed_some to keep us from
830 * calling connection_handle_write() recursively. */
831 unsigned int in_flushed_some
:1;
833 /* For linked connections:
835 unsigned int linked
:1; /**< True if there is, or has been, a linked_conn. */
836 /** True iff we'd like to be notified about read events from the
838 unsigned int reading_from_linked_conn
:1;
839 /** True iff we're willing to write to the linked conn. */
840 unsigned int writing_to_linked_conn
:1;
841 /** True iff we're currently able to read on the linked conn, and our
842 * read_event should be made active with libevent. */
843 unsigned int active_on_link
:1;
844 /** True iff we've called connection_close_immediate() on this linked
846 unsigned int linked_conn_is_closed
:1;
848 int s
; /**< Our socket; -1 if this connection is closed, or has no
850 int conn_array_index
; /**< Index into the global connection array. */
851 struct event
*read_event
; /**< Libevent event structure. */
852 struct event
*write_event
; /**< Libevent event structure. */
853 buf_t
*inbuf
; /**< Buffer holding data read over this connection. */
854 buf_t
*outbuf
; /**< Buffer holding data to write over this connection. */
855 size_t outbuf_flushlen
; /**< How much data should we try to flush from the
857 time_t timestamp_lastread
; /**< When was the last time libevent said we could
859 time_t timestamp_lastwritten
; /**< When was the last time libevent said we
861 time_t timestamp_created
; /**< When was this connection_t created? */
863 /* XXXX_IP6 make this ipv6-capable */
864 int socket_family
; /**< Address family of this connection's socket. Usually
865 * AF_INET, but it can also be AF_UNIX, or in the future
867 uint32_t addr
; /**< IP of the other side of the connection; used to identify
868 * routers, along with port. */
869 uint16_t port
; /**< If non-zero, port on the other end
870 * of the connection. */
871 uint16_t marked_for_close
; /**< Should we close this conn on the next
872 * iteration of the main loop? (If true, holds
873 * the line number where this connection was
875 const char *marked_for_close_file
; /**< For debugging: in which file were
876 * we marked for close? */
877 char *address
; /**< FQDN (or IP) of the guy on the other end.
878 * strdup into this, because free_connection frees it. */
879 /** Another connection that's connected to this one in lieu of a socket. */
880 struct connection_t
*linked_conn
;
882 /* XXXX021 move this into a subtype. */
883 struct evdns_server_port
*dns_server_port
;
887 /** Stores flags and information related to the portion of a v2 Tor OR
888 * connection handshake that happens after the TLS handshake is finished.
890 typedef struct or_handshake_state_t
{
891 /** When was the VERSIONS cell sent on this connection? Used to get
892 * an estimate of the skew in the returning NETINFO reply. */
893 time_t sent_versions_at
;
894 /** True iff we originated this connection */
895 unsigned int started_here
: 1;
896 /** True iff we have received and processed a VERSIONS cell. */
897 unsigned int received_versions
: 1;
898 } or_handshake_state_t
;
900 /** Subtype of connection_t for an "OR connection" -- that is, one that speaks
902 typedef struct or_connection_t
{
905 /** Hash of the public RSA key for the other side's identity key, or zeroes
906 * if the other side hasn't shown us a valid identity key. */
907 char identity_digest
[DIGEST_LEN
];
908 char *nickname
; /**< Nickname of OR on other side (if any). */
910 tor_tls_t
*tls
; /**< TLS connection state. */
911 int tls_error
; /**< Last tor_tls error code. */
912 /* XXX either merge this with tls_error, or do all our activity right
913 * when we compute this value so we don't have to store it. */
914 int socket_error
; /**< If conn dies, remember why. */
915 /** When we last used this conn for any client traffic. If not
916 * recent, we can rate limit it further. */
919 uint32_t real_addr
; /**< The actual address that this connection came from
920 * or went to. The <b>addr</b> field is prone to
921 * getting overridden by the address from the router
922 * descriptor matching <b>identity_digest</b>. */
924 circ_id_type_t circ_id_type
:2; /**< When we send CREATE cells along this
925 * connection, which half of the space should
927 /** Should this connection be used for extending circuits to the server
928 * matching the <b>identity_digest</b> field? Set to true if we're pretty
929 * sure we aren't getting MITMed, either because we're connected to an
930 * address listed in a server descriptor, or because an authenticated
931 * NETINFO cell listed the address we're connected to as recognized. */
932 unsigned int is_canonical
:1;
933 uint8_t link_proto
; /**< What protocol version are we using? 0 for
934 * "none negotiated yet." */
935 uint16_t next_circ_id
; /**< Which circ_id do we try to use next on
936 * this connection? This is always in the
937 * range 0..1<<15-1. */
939 or_handshake_state_t
*handshake_state
; /**< If we are setting this connection
940 * up, state information to do so. */
941 time_t timestamp_lastempty
; /**< When was the outbuf last completely empty?*/
942 time_t timestamp_last_added_nonpadding
; /** When did we last add a
943 * non-padding cell to the outbuf? */
945 /* bandwidth* and read_bucket only used by ORs in OPEN state: */
946 int bandwidthrate
; /**< Bytes/s added to the bucket. (OPEN ORs only.) */
947 int bandwidthburst
; /**< Max bucket size for this conn. (OPEN ORs only.) */
948 int read_bucket
; /**< When this hits 0, stop receiving. Every second we
949 * add 'bandwidthrate' to this, capping it at
950 * bandwidthburst. (OPEN ORs only) */
951 int n_circuits
; /**< How many circuits use this connection as p_conn or
954 /** Double-linked ring of circuits with queued cells waiting for room to
955 * free up on this connection's outbuf. Every time we pull cells from a
956 * circuit, we advance this pointer to the next circuit in the ring. */
957 struct circuit_t
*active_circuits
;
958 struct or_connection_t
*next_with_same_id
; /**< Next connection with same
959 * identity digest as this one. */
962 /** Subtype of connection_t for an "edge connection" -- that is, a socks (ap)
963 * connection, or an exit. */
964 typedef struct edge_connection_t
{
967 struct edge_connection_t
*next_stream
; /**< Points to the next stream at this
969 struct crypt_path_t
*cpath_layer
; /**< A pointer to which node in the circ
970 * this conn exits at. */
971 int package_window
; /**< How many more relay cells can I send into the
973 int deliver_window
; /**< How many more relay cells can end at me? */
975 /** Nickname of planned exit node -- used with .exit support. */
976 char *chosen_exit_name
;
978 socks_request_t
*socks_request
; /**< SOCKS structure describing request (AP
980 struct circuit_t
*on_circuit
; /**< The circuit (if any) that this edge
981 * connection is using. */
983 uint32_t address_ttl
; /**< TTL for address-to-addr mapping on exit
984 * connection. Exit connections only. */
986 uint16_t stream_id
; /**< The stream ID used for this edge connection on its
989 /** The reason why this connection is closing; passed to the controller. */
992 /** Quasi-global identifier for this connection; used for control.c */
993 /* XXXX NM This can get re-used after 2**32 streams */
994 uint32_t global_identifier
;
996 /** Bytes read since last call to control_event_stream_bandwidth_used() */
999 /** Bytes written since last call to control_event_stream_bandwidth_used() */
1002 /** What rendezvous service are we querying for? (AP only) */
1003 char rend_query
[REND_SERVICE_ID_LEN_BASE32
+1];
1005 /** Number of times we've reassigned this application connection to
1006 * a new circuit. We keep track because the timeout is longer if we've
1007 * already retried several times. */
1008 uint8_t num_socks_retries
;
1010 /** True iff this connection is for a dns request only. */
1011 unsigned int is_dns_request
:1;
1013 /** True iff this stream must attach to a one-hop circuit (e.g. for
1015 unsigned int want_onehop
:1;
1016 /** True iff this stream should use a BEGIN_DIR relay command to establish
1017 * itself rather than BEGIN (either via onehop or via a whole circuit). */
1018 unsigned int use_begindir
:1;
1020 /** If this is a DNSPort connection, this field holds the pending DNS
1021 * request that we're going to try to answer. */
1022 struct evdns_server_request
*dns_server_request
;
1024 } edge_connection_t
;
1026 /** Subtype of connection_t for an "directory connection" -- that is, an HTTP
1027 * connection to retrieve or serve directory material. */
1028 typedef struct dir_connection_t
{
1031 char *requested_resource
; /**< Which 'resource' did we ask the directory
1033 unsigned int dirconn_direct
:1; /**< Is this dirconn direct, or via Tor? */
1035 /* Used only for server sides of some dir connections, to implement
1036 * "spooling" of directory material to the outbuf. Otherwise, we'd have
1037 * to append everything to the outbuf in one enormous chunk. */
1038 /** What exactly are we spooling right now? */
1040 DIR_SPOOL_NONE
=0, DIR_SPOOL_SERVER_BY_DIGEST
, DIR_SPOOL_SERVER_BY_FP
,
1041 DIR_SPOOL_EXTRA_BY_DIGEST
, DIR_SPOOL_EXTRA_BY_FP
,
1042 DIR_SPOOL_CACHED_DIR
, DIR_SPOOL_NETWORKSTATUS
1043 } dir_spool_src
: 3;
1044 /** If we're fetching descriptors, what router purpose shall we assign
1046 uint8_t router_purpose
;
1047 /** List of fingerprints for networkstatuses or desriptors to be spooled. */
1048 smartlist_t
*fingerprint_stack
;
1049 /** A cached_dir_t object that we're currently spooling out */
1050 struct cached_dir_t
*cached_dir
;
1051 /** The current offset into cached_dir. */
1052 off_t cached_dir_offset
;
1053 /** The zlib object doing on-the-fly compression for spooled data. */
1054 tor_zlib_state_t
*zlib_state
;
1056 /** What hidden service descriptor are we fetching, if any? */
1059 /** What rendezvous service are we querying for? */
1060 char rend_query
[REND_SERVICE_ID_LEN_BASE32
+1];
1062 char identity_digest
[DIGEST_LEN
]; /**< Hash of the public RSA key for
1063 * the directory server's signing key. */
1067 /** Subtype of connection_t for an connection to a controller. */
1068 typedef struct control_connection_t
{
1071 uint32_t event_mask
; /**< Bitfield: which events does this controller
1073 unsigned int use_long_names
:1; /**< True if we should use long nicknames
1074 * on this (v1) connection. Only settable
1075 * via v1 controllers. */
1076 /** For control connections only. If set, we send extended info with control
1077 * events as appropriate. */
1078 unsigned int use_extended_events
:1;
1080 /** True if we have sent a protocolinfo reply on this connection. */
1081 unsigned int have_sent_protocolinfo
:1;
1083 uint32_t incoming_cmd_len
;
1084 uint32_t incoming_cmd_cur_len
;
1086 /* Used only by control v0 connections */
1087 uint16_t incoming_cmd_type
;
1088 } control_connection_t
;
1090 /** Cast a connection_t subtype pointer to a connection_t **/
1091 #define TO_CONN(c) (&(((c)->_base)))
1092 /** Helper macro: Given a pointer to to._base, of type from*, return &to. */
1093 #define DOWNCAST(to, ptr) ((to*)SUBTYPE_P(ptr, to, _base))
1095 /** Convert a connection_t* to an or_connection_t*; assert if the cast is
1097 static or_connection_t
*TO_OR_CONN(connection_t
*);
1098 /** Convert a connection_t* to a dir_connection_t*; assert if the cast is
1100 static dir_connection_t
*TO_DIR_CONN(connection_t
*);
1101 /** Convert a connection_t* to an edge_connection_t*; assert if the cast is
1103 static edge_connection_t
*TO_EDGE_CONN(connection_t
*);
1104 /** Convert a connection_t* to an control_connection_t*; assert if the cast is
1106 static control_connection_t
*TO_CONTROL_CONN(connection_t
*);
1108 static INLINE or_connection_t
*TO_OR_CONN(connection_t
*c
)
1110 tor_assert(c
->magic
== OR_CONNECTION_MAGIC
);
1111 return DOWNCAST(or_connection_t
, c
);
1113 static INLINE dir_connection_t
*TO_DIR_CONN(connection_t
*c
)
1115 tor_assert(c
->magic
== DIR_CONNECTION_MAGIC
);
1116 return DOWNCAST(dir_connection_t
, c
);
1118 static INLINE edge_connection_t
*TO_EDGE_CONN(connection_t
*c
)
1120 tor_assert(c
->magic
== EDGE_CONNECTION_MAGIC
);
1121 return DOWNCAST(edge_connection_t
, c
);
1123 static INLINE control_connection_t
*TO_CONTROL_CONN(connection_t
*c
)
1125 tor_assert(c
->magic
== CONTROL_CONNECTION_MAGIC
);
1126 return DOWNCAST(control_connection_t
, c
);
1130 ADDR_POLICY_ACCEPT
=1,
1131 ADDR_POLICY_REJECT
=2,
1132 } addr_policy_action_t
;
1134 /** A reference-counted address policy rule. */
1135 typedef struct addr_policy_t
{
1136 int refcnt
; /**< Reference count */
1137 addr_policy_action_t policy_type
:2;/**< What to do when the policy matches.*/
1138 unsigned int is_private
:1; /**< True iff this is the pseudo-address,
1140 unsigned int is_canonical
:1; /**< True iff this policy is the canonical
1141 * copy (stored in a hash table to avoid
1142 * duplication of common policies) */
1143 maskbits_t maskbits
; /**< Accept/reject all addresses <b>a</b> such that the
1144 * first <b>maskbits</b> bits of <b>a</b> match
1146 /* XXXX_IP6 make this ipv6-capable */
1147 uint32_t addr
; /**< Base address to accept or reject. */
1148 uint16_t prt_min
; /**< Lowest port number to accept/reject. */
1149 uint16_t prt_max
; /**< Highest port number to accept/reject. */
1152 /** A cached_dir_t represents a cacheable directory object, along with its
1153 * compressed form. */
1154 typedef struct cached_dir_t
{
1155 char *dir
; /**< Contents of this object */
1156 char *dir_z
; /**< Compressed contents of this object. */
1157 size_t dir_len
; /**< Length of <b>dir</b> */
1158 size_t dir_z_len
; /**< Length of <b>dir_z</b> */
1159 time_t published
; /**< When was this object published */
1160 int refcnt
; /**< Reference count for this cached_dir_t. */
1163 /** Enum used to remember where a signed_descriptor_t is stored and how to
1164 * manage the memory for signed_descriptor_body. */
1166 /** The descriptor isn't stored on disk at all: the copy in memory is
1167 * canonical; the saved_offset field is meaningless. */
1169 /** The descriptor is stored in the cached_routers file: the
1170 * signed_descriptor_body is meaningless; the signed_descriptor_len and
1171 * saved_offset are used to index into the mmaped cache file. */
1173 /** The descriptor is stored in the cached_routers.new file: the
1174 * signed_descriptor_body and saved_offset fields are both set. */
1175 /* FFFF (We could also mmap the file and grow the mmap as needed, or
1176 * lazy-load the descriptor text by using seek and read. We don't, for
1182 /** Enumeration: what kind of downlaod schedule are we using for a given
1185 DL_SCHED_GENERIC
= 0,
1186 DL_SCHED_CONSENSUS
= 1,
1187 } download_schedule_t
;
1189 /** Information about our plans for retrying downloads for a downloadable
1191 typedef struct download_status_t
{
1192 time_t next_attempt_at
; /**< When should we try downloading this descriptor
1194 uint8_t n_download_failures
; /**< Number of failures trying to download the
1195 * most recent descriptor. */
1196 download_schedule_t schedule
: 8;
1197 } download_status_t
;
1199 /** The max size we expect router descriptor annotations we create to
1200 * be. We'll accept larger ones if we see them on disk, but we won't
1201 * create any that are larger than this. */
1202 #define ROUTER_ANNOTATION_BUF_LEN 256
1204 /** Information need to cache an onion router's descriptor. */
1205 typedef struct signed_descriptor_t
{
1206 /** Pointer to the raw server descriptor, preceded by annotations. Not
1207 * necessarily NUL-terminated. If saved_location is SAVED_IN_CACHE, this
1208 * pointer is null. */
1209 char *signed_descriptor_body
;
1210 /** Length of the annotations preceeding the server descriptor. */
1211 size_t annotations_len
;
1212 /** Length of the server descriptor. */
1213 size_t signed_descriptor_len
;
1214 /** Digest of the server descriptor, computed as specified in
1216 char signed_descriptor_digest
[DIGEST_LEN
];
1217 /** Identity digest of the router. */
1218 char identity_digest
[DIGEST_LEN
];
1219 /** Declared publication time of the descriptor. */
1220 time_t published_on
;
1221 /** For routerdescs only: digest of the corresponding extrainfo. */
1222 char extra_info_digest
[DIGEST_LEN
];
1223 /** For routerdescs only: Status of downloading the corresponding
1225 download_status_t ei_dl_status
;
1226 /** Where is the descriptor saved? */
1227 saved_location_t saved_location
;
1228 /** If saved_location is SAVED_IN_CACHE or SAVED_IN_JOURNAL, the offset of
1229 * this descriptor in the corresponding file. */
1231 /** What position is this descriptor within routerlist->routers or
1232 * routerlist->old_routers? -1 for none. */
1233 int routerlist_index
;
1234 /** The valid-until time of the most recent consensus that listed this
1235 * descriptor, or a bit after the publication time of the most recent v2
1236 * networkstatus that listed it. 0 for "never listed in a consensus or
1237 * status, so far as we know." */
1238 time_t last_listed_as_valid_until
;
1239 #ifdef TRACK_SERVED_TIME
1241 time_t last_served_at
; /*XXXX021 remove if not useful. */
1243 /* If true, we do not ever try to save this object in the cache. */
1244 unsigned int do_not_cache
: 1;
1245 /* If true, this item is meant to represent an extrainfo. */
1246 unsigned int is_extrainfo
: 1;
1247 /* If true, we got an extrainfo for this item, and the digest was right,
1248 * but it was incompatible. */
1249 unsigned int extrainfo_is_bogus
: 1;
1250 /* If true, we are willing to transmit this item unencrypted. */
1251 unsigned int send_unencrypted
: 1;
1252 } signed_descriptor_t
;
1254 /** Information about another onion router in the network. */
1256 signed_descriptor_t cache_info
;
1257 char *address
; /**< Location of OR: either a hostname or an IP address. */
1258 char *nickname
; /**< Human-readable OR name. */
1260 uint32_t addr
; /**< IPv4 address of OR, in host order. */
1261 uint16_t or_port
; /**< Port for TLS connections. */
1262 uint16_t dir_port
; /**< Port for HTTP directory connections. */
1264 crypto_pk_env_t
*onion_pkey
; /**< Public RSA key for onions. */
1265 crypto_pk_env_t
*identity_pkey
; /**< Public RSA key for signing. */
1267 char *platform
; /**< What software/operating system is this OR using? */
1270 uint32_t bandwidthrate
; /**< How many bytes does this OR add to its token
1271 * bucket per second? */
1272 uint32_t bandwidthburst
; /**< How large is this OR's token bucket? */
1273 /** How many bytes/s is this router known to handle? */
1274 uint32_t bandwidthcapacity
;
1275 smartlist_t
*exit_policy
; /**< What streams will this OR permit
1276 * to exit? NULL for 'reject *:*'. */
1277 long uptime
; /**< How many seconds the router claims to have been up */
1278 smartlist_t
*declared_family
; /**< Nicknames of router which this router
1279 * claims are its family. */
1280 char *contact_info
; /**< Declared contact info for this router. */
1281 unsigned int is_hibernating
:1; /**< Whether the router claims to be
1283 unsigned int has_old_dnsworkers
:1; /**< Whether the router is using
1284 * dnsworker code. */
1285 unsigned int caches_extra_info
:1; /**< Whether the router caches and serves
1286 * extrainfo documents. */
1289 unsigned int is_running
:1; /**< As far as we know, is this OR currently
1291 unsigned int is_valid
:1; /**< Has a trusted dirserver validated this OR?
1292 * (For Authdir: Have we validated this OR?)
1294 unsigned int is_named
:1; /**< Do we believe the nickname that this OR gives
1296 unsigned int is_fast
:1; /** Do we think this is a fast OR? */
1297 unsigned int is_stable
:1; /** Do we think this is a stable OR? */
1298 unsigned int is_possible_guard
:1; /**< Do we think this is an OK guard? */
1299 unsigned int is_exit
:1; /**< Do we think this is an OK exit? */
1300 unsigned int is_bad_exit
:1; /**< Do we think this exit is censored, borked,
1301 * or otherwise nasty? */
1302 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1303 * underpowered, or otherwise useless? */
1304 unsigned int wants_to_be_hs_dir
:1; /**< True iff this router claims to be
1305 * a hidden service directory. */
1306 unsigned int is_hs_dir
:1; /**< True iff this router is a hidden service
1307 * directory according to the authorities. */
1309 /** Tor can use this router for general positions in circuits. */
1310 #define ROUTER_PURPOSE_GENERAL 0
1311 /** Tor should avoid using this router for circuit-building. */
1312 #define ROUTER_PURPOSE_CONTROLLER 1
1313 /** Tor should use this router only for bridge positions in circuits. */
1314 #define ROUTER_PURPOSE_BRIDGE 2
1315 /** Tor should not use this router; it was marked in cached-descriptors with
1316 * a purpose we didn't recognize. */
1317 #define ROUTER_PURPOSE_UNKNOWN 255
1319 uint8_t purpose
; /** What positions in a circuit is this router good for? */
1321 /* The below items are used only by authdirservers for
1322 * reachability testing. */
1323 /** When was the last time we could reach this OR? */
1324 time_t last_reachable
;
1325 /** When did we start testing reachability for this OR? */
1326 time_t testing_since
;
1330 /** Information needed to keep and cache a signed extra-info document. */
1331 typedef struct extrainfo_t
{
1332 signed_descriptor_t cache_info
;
1333 /** The router's nickname. */
1334 char nickname
[MAX_NICKNAME_LEN
+1];
1335 /** True iff we found the right key for this extra-info, verified the
1336 * signature, and found it to be bad. */
1337 unsigned int bad_sig
: 1;
1338 /** If present, we didn't have the right key to verify this extra-info,
1339 * so this is a copy of the signature in the document. */
1341 /** Length of pending_sig. */
1342 size_t pending_sig_len
;
1345 /** Contents of a single router entry in a network status object.
1347 typedef struct routerstatus_t
{
1348 time_t published_on
; /**< When was this router published? */
1349 char nickname
[MAX_NICKNAME_LEN
+1]; /**< The nickname this router says it
1351 char identity_digest
[DIGEST_LEN
]; /**< Digest of the router's identity
1353 char descriptor_digest
[DIGEST_LEN
]; /**< Digest of the router's most recent
1355 uint32_t addr
; /**< IPv4 address for this router. */
1356 uint16_t or_port
; /**< OR port for this router. */
1357 uint16_t dir_port
; /**< Directory port for this router. */
1358 unsigned int is_authority
:1; /**< True iff this router is an authority. */
1359 unsigned int is_exit
:1; /**< True iff this router is a good exit. */
1360 unsigned int is_stable
:1; /**< True iff this router stays up a long time. */
1361 unsigned int is_fast
:1; /**< True iff this router has good bandwidth. */
1362 unsigned int is_running
:1; /**< True iff this router is up. */
1363 unsigned int is_named
:1; /**< True iff "nickname" belongs to this router. */
1364 unsigned int is_unnamed
:1; /**< True iff "nickname" belongs to another
1366 unsigned int is_valid
:1; /**< True iff this router isn't invalid. */
1367 unsigned int is_v2_dir
:1; /**< True iff this router can serve directory
1368 * information with v2 of the directory
1369 * protocol. (All directory caches cache v1
1371 unsigned int is_possible_guard
:1; /**< True iff this router would be a good
1372 * choice as an entry guard. */
1373 unsigned int is_bad_exit
:1; /**< True iff this node is a bad choice for
1375 unsigned int is_bad_directory
:1; /**< Do we think this directory is junky,
1376 * underpowered, or otherwise useless? */
1377 unsigned int is_hs_dir
:1; /** True iff this router is a v2-or-later hidden
1378 * service directory. */
1379 /** True iff we know version info for this router. (i.e., a "v" entry was
1380 * included.) We'll replace all these with a big tor_version_t or a char[]
1381 * if the number of traits we care about ever becomes incredibly big. */
1382 unsigned int version_known
:1;
1383 /** True iff this router is a version that supports BEGIN_DIR cells. */
1384 unsigned int version_supports_begindir
:1;
1385 /** True iff this router is a version that supports conditional consensus
1386 * downloads (signed by list of authorities). */
1387 unsigned int version_supports_conditional_consensus
:1;
1388 /** True iff this router is a version that we can post extrainfo docs to. */
1389 unsigned int version_supports_extrainfo_upload
:1;
1390 /** True iff this router is a version that, if it caches directory info,
1391 * we can get v3 downloads from. */
1392 unsigned int version_supports_v3_dir
:1;
1394 /* ---- The fields below aren't derived from the networkstatus; they
1395 * hold local information only. */
1397 /** True if we, as a directory mirror, want to download the corresponding
1398 * routerinfo from the authority who gave us this routerstatus. (That is,
1399 * if we don't have the routerinfo, and if we haven't already tried to get it
1400 * from this authority.) Applies in v2 networkstatus document only.
1402 unsigned int need_to_mirror
:1;
1403 unsigned int name_lookup_warned
:1; /**< Have we warned the user for referring
1404 * to this (unnamed) router by nickname?
1406 time_t last_dir_503_at
; /**< When did this router last tell us that it
1407 * was too busy to serve directory info? */
1408 download_status_t dl_status
;
1412 /** How many times will we try to download a router's descriptor before giving
1414 #define MAX_ROUTERDESC_DOWNLOAD_FAILURES 8
1416 /** Contents of a v2 (non-consensus, non-vote) network status object. */
1417 typedef struct networkstatus_v2_t
{
1418 /** When did we receive the network-status document? */
1421 /** What was the digest of the document? */
1422 char networkstatus_digest
[DIGEST_LEN
];
1424 unsigned int is_recent
; /**< Is this recent enough to influence running
1427 /* These fields come from the actual network-status document.*/
1428 time_t published_on
; /**< Declared publication date. */
1430 char *source_address
; /**< Canonical directory server hostname. */
1431 uint32_t source_addr
; /**< Canonical directory server IP. */
1432 uint16_t source_dirport
; /**< Canonical directory server dirport. */
1434 unsigned int binds_names
:1; /**< True iff this directory server binds
1436 unsigned int recommends_versions
:1; /**< True iff this directory server
1437 * recommends client and server software
1439 unsigned int lists_bad_exits
:1; /**< True iff this directory server marks
1440 * malfunctioning exits as bad. */
1441 /** True iff this directory server marks malfunctioning directories as
1443 unsigned int lists_bad_directories
:1;
1445 char identity_digest
[DIGEST_LEN
]; /**< Digest of signing key. */
1446 char *contact
; /**< How to contact directory admin? (may be NULL). */
1447 crypto_pk_env_t
*signing_key
; /**< Key used to sign this directory. */
1448 char *client_versions
; /**< comma-separated list of recommended client
1450 char *server_versions
; /**< comma-separated list of recommended server
1453 smartlist_t
*entries
; /**< List of routerstatus_t*. This list is kept
1454 * sorted by identity_digest. */
1455 } networkstatus_v2_t
;
1457 /** The claim about a single router, make in a vote. */
1458 typedef struct vote_routerstatus_t
{
1459 routerstatus_t status
; /**< Underlying 'status' object for this router.
1460 * Flags are redundant. */
1461 uint64_t flags
; /**< Bit-field for all recognized flags; index into
1462 * networkstatus_t.known_flags. */
1463 char *version
; /**< The version that the authority says this router is
1465 } vote_routerstatus_t
;
1467 /** Information about a single voter in a vote or a consensus. */
1468 typedef struct networkstatus_voter_info_t
{
1469 char *nickname
; /**< Nickname of this voter */
1470 char identity_digest
[DIGEST_LEN
]; /**< Digest of this voter's identity key */
1471 char *address
; /**< Address of this voter, in string format. */
1472 uint32_t addr
; /**< Address of this voter, in IPv4, in host order. */
1473 uint16_t dir_port
; /**< Directory port of this voter */
1474 uint16_t or_port
; /**< OR port of this voter */
1475 char *contact
; /**< Contact information for this voter. */
1476 char vote_digest
[DIGEST_LEN
]; /**< Digest of this voter's vote, as signed. */
1477 char legacy_id_digest
[DIGEST_LEN
]; /**< From vote only. DOCDOC */
1479 /* Nothing from here on is signed. */
1480 char signing_key_digest
[DIGEST_LEN
]; /**< Declared digest of signing key
1481 * used by this voter. */
1482 char *signature
; /**< Signature from this voter. */
1483 int signature_len
; /**< Length of <b>signature</b> */
1484 unsigned int bad_signature
: 1; /**< Set to true if we've tried to verify
1485 * the sig, and we know it's bad. */
1486 unsigned int good_signature
: 1; /**< Set to true if we've verified the sig
1488 } networkstatus_voter_info_t
;
1490 /** A common structure to hold a v3 network status vote, or a v3 network
1491 * status consensus. */
1492 typedef struct networkstatus_t
{
1493 int is_vote
; /**< True if this is a vote; false if it is a consensus. */
1494 time_t published
; /**< Vote only: Tiem when vote was written. */
1495 time_t valid_after
; /**< Time after which this vote or consensus applies. */
1496 time_t fresh_until
; /**< Time before which this is the most recent vote or
1498 time_t valid_until
; /**< Time after which this vote or consensus should not
1501 /** Consensus only: what method was used to produce this consensus? */
1502 int consensus_method
;
1503 /** Vote only: what methods is this voter willing to use? */
1504 smartlist_t
*supported_methods
;
1506 /** How long does this vote/consensus claim that authorities take to
1507 * distribute their votes to one another? */
1509 /** How long does this vote/consensus claim that authorites take to
1510 * distribute their consensus signatures to one another? */
1513 /** Comma-separated list of recommended client software, or NULL if this
1514 * voter has no opinion. */
1515 char *client_versions
;
1516 char *server_versions
;
1517 /** List of flags that this vote/consensus applies to routers. If a flag is
1518 * not listed here, the voter has no opinion on what its value should be. */
1519 smartlist_t
*known_flags
;
1521 /** List of networkstatus_voter_info_t. For a vote, only one element
1522 * is included. For a consensus, one element is included for every voter
1523 * whose vote contributed to the consensus. */
1524 smartlist_t
*voters
;
1526 struct authority_cert_t
*cert
; /**< Vote only: the voter's certificate. */
1528 /** Digest of this document, as signed. */
1529 char networkstatus_digest
[DIGEST_LEN
];
1531 /** List of router statuses, sorted by identity digest. For a vote,
1532 * the elements are vote_routerstatus_t; for a consensus, the elements
1533 * are routerstatus_t. */
1534 smartlist_t
*routerstatus_list
;
1536 /** If present, a map from descriptor digest to elements of
1537 * routerstatus_list. */
1538 digestmap_t
*desc_digest_map
;
1541 /** A set of signatures for a networkstatus consensus. All fields are as for
1542 * networkstatus_t. */
1543 typedef struct ns_detached_signatures_t
{
1547 char networkstatus_digest
[DIGEST_LEN
];
1548 smartlist_t
*signatures
; /* list of networkstatus_voter_info_t */
1549 } ns_detached_signatures_t
;
1551 /** Allowable types of desc_store_t. */
1552 typedef enum store_type_t
{
1557 /** A 'store' is a set of descriptors saved on disk, with accompanying
1558 * journal, mmaped as needed, rebuilt as needed. */
1559 typedef struct desc_store_t
{
1560 /** Filename (within DataDir) for the store. We append .tmp to this
1561 * filename for a temporary file when rebuilding the store, and .new to this
1562 * filename for the journal. */
1563 const char *fname_base
;
1564 /** Alternative (obsolete) value for fname_base: if the file named by
1565 * fname_base isn't present, we read from here instead, but we never write
1567 const char *fname_alt_base
;
1568 /** Human-readable description of what this store contains. */
1569 const char *description
;
1571 tor_mmap_t
*mmap
; /**< A mmap for the main file in the store. */
1573 store_type_t type
; /**< What's stored in this store? */
1575 /** The size of the router log, in bytes. */
1577 /** The size of the router store, in bytes. */
1579 /** Total bytes dropped since last rebuild: this is space currently
1580 * used in the cache and the journal that could be freed by a rebuild. */
1581 size_t bytes_dropped
;
1584 /** Contents of a directory of onion routers. */
1586 /** Map from server identity digest to a member of routers. */
1587 struct digest_ri_map_t
*identity_map
;
1588 /** Map from server descriptor digest to a signed_descriptor_t from
1589 * routers or old_routers. */
1590 struct digest_sd_map_t
*desc_digest_map
;
1591 /** Map from extra-info digest to an extrainfo_t. Only exists for
1592 * routers in routers or old_routers. */
1593 struct digest_ei_map_t
*extra_info_map
;
1594 /** Map from extra-info digests to a signed_descriptor_t for a router
1595 * descriptor having that extra-info digest. Only exists for
1596 * routers in routers or old_routers. */
1597 struct digest_sd_map_t
*desc_by_eid_map
;
1598 /** List of routerinfo_t for all currently live routers we know. */
1599 smartlist_t
*routers
;
1600 /** List of signed_descriptor_t for older router descriptors we're
1602 smartlist_t
*old_routers
;
1603 /** Store holding server descriptors. If present, any router whose
1604 * cache_info.saved_location == SAVED_IN_CACHE is stored in this file
1605 * starting at cache_info.saved_offset */
1606 desc_store_t desc_store
;
1607 /** Store holding extra-info documents. */
1608 desc_store_t extrainfo_store
;
1611 /** Information on router used when extending a circuit. We don't need a
1612 * full routerinfo_t to extend: we only need addr:port:keyid to build an OR
1613 * connection, and onion_key to create the onionskin. Note that for onehop
1614 * general-purpose tunnels, the onion_key is NULL. */
1615 typedef struct extend_info_t
{
1616 char nickname
[MAX_HEX_NICKNAME_LEN
+1]; /**< This router's nickname for
1618 char identity_digest
[DIGEST_LEN
]; /**< Hash of this router's identity key. */
1619 uint16_t port
; /**< OR port. */
1620 uint32_t addr
; /**< IP address in host order. */
1621 crypto_pk_env_t
*onion_key
; /**< Current onionskin key. */
1624 /** Certificate for v3 directory protocol: binds long-term authority identity
1625 * keys to medium-term authority signing keys. */
1626 typedef struct authority_cert_t
{
1627 signed_descriptor_t cache_info
;
1628 crypto_pk_env_t
*identity_key
;
1629 crypto_pk_env_t
*signing_key
;
1630 char signing_key_digest
[DIGEST_LEN
];
1636 /** Bitfield enum type listing types of directory authority/directory
1640 V1_AUTHORITY
= 1 << 0,
1641 V2_AUTHORITY
= 1 << 1,
1642 V3_AUTHORITY
= 1 << 2,
1643 HIDSERV_AUTHORITY
= 1 << 3,
1644 BRIDGE_AUTHORITY
= 1 << 4,
1645 EXTRAINFO_CACHE
= 1 << 5, /* not precisely an authority type. */
1648 #define CRYPT_PATH_MAGIC 0x70127012u
1650 /** Holds accounting information for a single step in the layered encryption
1651 * performed by a circuit. Used only at the client edge of a circuit. */
1652 typedef struct crypt_path_t
{
1655 /* crypto environments */
1656 /** Encryption key and counter for cells heading towards the OR at this
1658 crypto_cipher_env_t
*f_crypto
;
1659 /** Encryption key and counter for cells heading back from the OR at this
1661 crypto_cipher_env_t
*b_crypto
;
1663 /** Digest state for cells heading towards the OR at this step. */
1664 crypto_digest_env_t
*f_digest
; /* for integrity checking */
1665 /** Digest state for cells heading away from the OR at this step. */
1666 crypto_digest_env_t
*b_digest
;
1668 /** Current state of Diffie-Hellman key negotiation with the OR at this
1670 crypto_dh_env_t
*dh_handshake_state
;
1671 /** Current state of 'fast' (non-PK) key negotiation with the OR at this
1672 * step. Used to save CPU when TLS is already providing all the
1673 * authentication, secrecy, and integrity we need, and we're already
1674 * distinguishable from an OR.
1676 char fast_handshake_state
[DIGEST_LEN
];
1677 /** Negotiated key material shared with the OR at this step. */
1678 char handshake_digest
[DIGEST_LEN
];/* KH in tor-spec.txt */
1680 /** Information to extend to the OR at this step. */
1681 extend_info_t
*extend_info
;
1683 /** Is the circuit built to this step? Must be one of:
1684 * - CPATH_STATE_CLOSED (The circuit has not been extended to this step)
1685 * - CPATH_STATE_AWAITING_KEYS (We have sent an EXTEND/CREATE to this step
1686 * and not received an EXTENDED/CREATED)
1687 * - CPATH_STATE_OPEN (The circuit has been extended to this step) */
1689 #define CPATH_STATE_CLOSED 0
1690 #define CPATH_STATE_AWAITING_KEYS 1
1691 #define CPATH_STATE_OPEN 2
1692 struct crypt_path_t
*next
; /**< Link to next crypt_path_t in the circuit.
1693 * (The list is circular, so the last node
1694 * links to the first.) */
1695 struct crypt_path_t
*prev
; /**< Link to previous crypt_path_t in the
1698 int package_window
; /**< How many bytes are we allowed to originate ending
1700 int deliver_window
; /**< How many bytes are we willing to deliver originating
1704 #define CPATH_KEY_MATERIAL_LEN (20*2+16*2)
1706 #define DH_KEY_LEN DH_BYTES
1707 #define ONIONSKIN_CHALLENGE_LEN (PKCS1_OAEP_PADDING_OVERHEAD+\
1710 #define ONIONSKIN_REPLY_LEN (DH_KEY_LEN+DIGEST_LEN)
1711 #define REND_COOKIE_LEN DIGEST_LEN
1713 /** Information used to build a circuit. */
1715 /** Intended length of the final circuit. */
1716 int desired_path_len
;
1717 /** How to extend to the planned exit node. */
1718 extend_info_t
*chosen_exit
;
1719 /** Whether every node in the circ must have adequate uptime. */
1721 /** Whether every node in the circ must have adequate capacity. */
1723 /** Whether the last hop was picked with exiting in mind. */
1725 /** Did we pick this as a one-hop tunnel (not safe for other conns)?
1726 * These are for encrypted connections that exit to this router, not
1727 * for arbitrary exits from the circuit. */
1729 /** The crypt_path_t to append after rendezvous: used for rendezvous. */
1730 crypt_path_t
*pending_final_cpath
;
1731 /** How many times has building a circuit for this task failed? */
1733 /** At what time should we give up on this task? */
1735 } cpath_build_state_t
;
1737 #define ORIGIN_CIRCUIT_MAGIC 0x35315243u
1738 #define OR_CIRCUIT_MAGIC 0x98ABC04Fu
1740 typedef uint16_t circid_t
;
1743 * A circuit is a path over the onion routing
1744 * network. Applications can connect to one end of the circuit, and can
1745 * create exit connections at the other end of the circuit. AP and exit
1746 * connections have only one circuit associated with them (and thus these
1747 * connection types are closed when the circuit is closed), whereas
1748 * OR connections multiplex many circuits at once, and stay standing even
1749 * when there are no circuits running over them.
1751 * A circuit_t structure can fill one of two roles. First, a or_circuit_t
1752 * links two connections together: either an edge connection and an OR
1753 * connection, or two OR connections. (When joined to an OR connection, a
1754 * circuit_t affects only cells sent to a particular circID on that
1755 * connection. When joined to an edge connection, a circuit_t affects all
1758 * Second, an origin_circuit_t holds the cipher keys and state for sending data
1759 * along a given circuit. At the OP, it has a sequence of ciphers, each
1760 * of which is shared with a single OR along the circuit. Separate
1761 * ciphers are used for data going "forward" (away from the OP) and
1762 * "backward" (towards the OP). At the OR, a circuit has only two stream
1763 * ciphers: one for data going forward, and one for data going backward.
1765 typedef struct circuit_t
{
1766 uint32_t magic
; /**< For memory and type debugging: must equal
1767 * ORIGIN_CIRCUIT_MAGIC or OR_CIRCUIT_MAGIC. */
1769 /** Queue of cells waiting to be transmitted on n_conn. */
1770 cell_queue_t n_conn_cells
;
1771 /** The OR connection that is next in this circuit. */
1772 or_connection_t
*n_conn
;
1773 /** The identity hash of n_conn. */
1774 char n_conn_id_digest
[DIGEST_LEN
];
1775 /** The circuit_id used in the next (forward) hop of this circuit. */
1777 /** The port for the OR that is next in this circuit. */
1779 /** The IPv4 address of the OR that is next in this circuit. */
1782 /** True iff we are waiting for n_conn_cells to become less full before
1783 * allowing p_streams to add any more cells. (Origin circuit only.) */
1784 unsigned int streams_blocked_on_n_conn
: 1;
1785 /** True iff we are waiting for p_conn_cells to become less full before
1786 * allowing n_streams to add any more cells. (OR circuit only.) */
1787 unsigned int streams_blocked_on_p_conn
: 1;
1789 uint8_t state
; /**< Current status of this circuit. */
1790 uint8_t purpose
; /**< Why are we creating this circuit? */
1792 /** How many relay data cells can we package (read from edge streams)
1793 * on this circuit before we receive a circuit-level sendme cell asking
1796 /** How many relay data cells will we deliver (write to edge streams)
1797 * on this circuit? When deliver_window gets low, we send some
1798 * circuit-level sendme cells to indicate that we're willing to accept
1802 /** For storage while n_conn is pending
1803 * (state CIRCUIT_STATE_OR_WAIT). When defined, it is always
1804 * length ONIONSKIN_CHALLENGE_LEN. */
1805 char *n_conn_onionskin
;
1807 time_t timestamp_created
; /**< When was this circuit created? */
1808 time_t timestamp_dirty
; /**< When the circuit was first used, or 0 if the
1809 * circuit is clean. */
1811 uint16_t marked_for_close
; /**< Should we close this circuit at the end of
1812 * the main loop? (If true, holds the line number
1813 * where this circuit was marked.) */
1814 const char *marked_for_close_file
; /**< For debugging: in which file was this
1815 * circuit marked for close? */
1817 /** Next circuit in the doubly-linked ring of circuits waiting to add
1818 * cells to n_conn. NULL if we have no cells pending, or if we're not
1819 * linked to an OR connection. */
1820 struct circuit_t
*next_active_on_n_conn
;
1821 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1822 * cells to n_conn. NULL if we have no cells pending, or if we're not
1823 * linked to an OR connection. */
1824 struct circuit_t
*prev_active_on_n_conn
;
1825 struct circuit_t
*next
; /**< Next circuit in linked list of all circuits. */
1828 /** An origin_circuit_t holds data necessary to build and use a circuit.
1830 typedef struct origin_circuit_t
{
1833 /** Linked list of AP streams (or EXIT streams if hidden service)
1834 * associated with this circuit. */
1835 edge_connection_t
*p_streams
;
1836 /** Build state for this circuit. It includes the intended path
1837 * length, the chosen exit router, rendezvous information, etc.
1839 cpath_build_state_t
*build_state
;
1840 /** The doubly-linked list of crypt_path_t entries, one per hop,
1841 * for this circuit. This includes ciphers for each hop,
1842 * integrity-checking digests for each hop, and package/delivery
1843 * windows for each hop.
1845 crypt_path_t
*cpath
;
1847 /** The rend_pk_digest field holds a hash of location-hidden service's
1848 * PK if purpose is S_ESTABLISH_INTRO or S_RENDEZVOUSING.
1850 char rend_pk_digest
[DIGEST_LEN
];
1852 /** Holds rendezvous cookie if purpose is C_ESTABLISH_REND. Filled with
1855 char rend_cookie
[REND_COOKIE_LEN
];
1858 * The rend_query field holds the y portion of y.onion (nul-terminated)
1859 * if purpose is C_INTRODUCING or C_ESTABLISH_REND, or is a C_GENERAL
1860 * for a hidden service, or is S_*.
1862 char rend_query
[REND_SERVICE_ID_LEN_BASE32
+1];
1864 /** Stores the rendezvous descriptor version if purpose is S_*. Used to
1865 * distinguish introduction and rendezvous points belonging to the same
1866 * rendezvous service ID, but different descriptor versions.
1868 uint8_t rend_desc_version
;
1870 /* The intro key replaces the hidden service's public key if purpose is
1871 * S_ESTABLISH_INTRO or S_INTRO, provided that no unversioned rendezvous
1872 * descriptor is used. */
1873 crypto_pk_env_t
*intro_key
;
1875 /** The next stream_id that will be tried when we're attempting to
1876 * construct a new AP stream originating at this circuit. */
1877 uint16_t next_stream_id
;
1879 /** Quasi-global identifier for this circuit; used for control.c */
1880 /* XXXX NM This can get re-used after 2**32 circuits. */
1881 uint32_t global_identifier
;
1885 /** An or_circuit_t holds information needed to implement a circuit at an
1887 typedef struct or_circuit_t
{
1890 /** Next circuit in the doubly-linked ring of circuits waiting to add
1891 * cells to p_conn. NULL if we have no cells pending, or if we're not
1892 * linked to an OR connection. */
1893 struct circuit_t
*next_active_on_p_conn
;
1894 /** Previous circuit in the doubly-linked ring of circuits waiting to add
1895 * cells to p_conn. NULL if we have no cells pending, or if we're not
1896 * linked to an OR connection. */
1897 struct circuit_t
*prev_active_on_p_conn
;
1899 /** The circuit_id used in the previous (backward) hop of this circuit. */
1901 /** Queue of cells waiting to be transmitted on p_conn. */
1902 cell_queue_t p_conn_cells
;
1903 /** The OR connection that is previous in this circuit. */
1904 or_connection_t
*p_conn
;
1905 /** Linked list of Exit streams associated with this circuit. */
1906 edge_connection_t
*n_streams
;
1907 /** Linked list of Exit streams associated with this circuit that are
1908 * still being resolved. */
1909 edge_connection_t
*resolving_streams
;
1910 /** The cipher used by intermediate hops for cells heading toward the
1912 crypto_cipher_env_t
*p_crypto
;
1913 /** The cipher used by intermediate hops for cells heading away from
1915 crypto_cipher_env_t
*n_crypto
;
1917 /** The integrity-checking digest used by intermediate hops, for
1918 * cells packaged here and heading towards the OP.
1920 crypto_digest_env_t
*p_digest
;
1921 /** The integrity-checking digest used by intermediate hops, for
1922 * cells packaged at the OP and arriving here.
1924 crypto_digest_env_t
*n_digest
;
1926 /** Points to spliced circuit if purpose is REND_ESTABLISHED, and circuit
1927 * is not marked for close. */
1928 struct or_circuit_t
*rend_splice
;
1930 #if REND_COOKIE_LEN >= DIGEST_LEN
1931 #define REND_TOKEN_LEN REND_COOKIE_LEN
1933 #define REND_TOKEN_LEN DIGEST_LEN
1936 /** A hash of location-hidden service's PK if purpose is INTRO_POINT, or a
1937 * rendezvous cookie if purpose is REND_POINT_WAITING. Filled with zeroes
1939 * ???? move to a subtype or adjunct structure? Wastes 20 bytes. -NM
1941 char rend_token
[REND_TOKEN_LEN
];
1943 /* ???? move to a subtype or adjunct structure? Wastes 20 bytes -NM */
1944 char handshake_digest
[DIGEST_LEN
]; /**< Stores KH for the handshake. */
1946 /** True iff this circuit was made with a CREATE_FAST cell. */
1947 unsigned int is_first_hop
: 1;
1950 /** Convert a circuit subtype to a circuit_t.*/
1951 #define TO_CIRCUIT(x) (&((x)->_base))
1953 /** Convert a circuit_t* to a pointer to the enclosing or_circuit_t. Asserts
1954 * if the cast is impossible. */
1955 static or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*);
1956 /** Convert a circuit_t* to a pointer to the enclosing origin_circuit_t.
1957 * Asserts if the cast is impossible. */
1958 static origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*);
1960 static INLINE or_circuit_t
*TO_OR_CIRCUIT(circuit_t
*x
)
1962 tor_assert(x
->magic
== OR_CIRCUIT_MAGIC
);
1963 return DOWNCAST(or_circuit_t
, x
);
1965 static INLINE origin_circuit_t
*TO_ORIGIN_CIRCUIT(circuit_t
*x
)
1967 tor_assert(x
->magic
== ORIGIN_CIRCUIT_MAGIC
);
1968 return DOWNCAST(origin_circuit_t
, x
);
1971 #define ALLOW_INVALID_ENTRY 1
1972 #define ALLOW_INVALID_EXIT 2
1973 #define ALLOW_INVALID_MIDDLE 4
1974 #define ALLOW_INVALID_RENDEZVOUS 8
1975 #define ALLOW_INVALID_INTRODUCTION 16
1977 /** An entry specifying a set of addresses and ports that should be remapped
1978 * to another address and port before exiting this exit node. */
1979 typedef struct exit_redirect_t
{
1980 /* XXXX_IP6 make this whole mess ipv6-capable. (Does anybody use it? */
1985 maskbits_t maskbits
;
1989 unsigned int is_redirect
:1;
1992 /* limits for TCP send and recv buffer size used for constrained sockets */
1993 #define MIN_CONSTRAINED_TCP_BUFFER 2048
1994 #define MAX_CONSTRAINED_TCP_BUFFER 262144 /* 256k */
1996 /** A linked list of lines in a config file. */
1997 typedef struct config_line_t
{
2000 struct config_line_t
*next
;
2003 /** Configuration options for a Tor process. */
2007 /** What should the tor process actually do? */
2009 CMD_RUN_TOR
=0, CMD_LIST_FINGERPRINT
, CMD_HASH_PASSWORD
,
2010 CMD_VERIFY_CONFIG
, CMD_RUN_UNITTESTS
2012 const char *command_arg
; /**< Argument for command-line option. */
2014 config_line_t
*Logs
; /**< New-style list of configuration lines
2017 char *DebugLogFile
; /**< Where to send verbose log messages. */
2018 char *DataDirectory
; /**< OR only: where to store long-term data. */
2019 char *Nickname
; /**< OR only: nickname of this onion router. */
2020 char *Address
; /**< OR only: configured address for this onion router. */
2021 char *PidFile
; /**< Where to store PID of Tor process. */
2023 char *ExitNodes
; /**< Comma-separated list of nicknames of ORs to consider
2025 char *EntryNodes
; /**< Comma-separated list of nicknames of ORs to consider
2026 * as entry points. */
2027 int StrictExitNodes
; /**< Boolean: When none of our ExitNodes are up, do we
2028 * stop building circuits? */
2029 int StrictEntryNodes
; /**< Boolean: When none of our EntryNodes are up, do we
2030 * stop building circuits? */
2031 struct routerset_t
*ExcludeNodes
; /**< Comma-separated list of nicknames of
2032 * ORs not to use in circuits. */
2033 struct routerset_t
*ExcludeExitNodes
; /**<DODOC */
2035 /** Union of ExcludeNodes and ExcludeExitNodes */
2036 struct routerset_t
*_ExcludeExitNodesUnion
;
2038 /** List of "entry", "middle", "exit", "introduction", "rendezvous". */
2039 smartlist_t
*AllowInvalidNodes
;
2040 int _AllowInvalid
; /**< Bitmask; derived from AllowInvalidNodes. */
2041 config_line_t
*ExitPolicy
; /**< Lists of exit policy components. */
2042 int ExitPolicyRejectPrivate
; /**< Should we not exit to local addresses? */
2043 config_line_t
*SocksPolicy
; /**< Lists of socks policy components */
2044 config_line_t
*DirPolicy
; /**< Lists of dir policy components */
2045 /** Addresses to bind for listening for SOCKS connections. */
2046 config_line_t
*SocksListenAddress
;
2047 /** Addresses to bind for listening for transparent pf/nefilter
2049 config_line_t
*TransListenAddress
;
2050 /** Addresses to bind for listening for transparent natd connections */
2051 config_line_t
*NatdListenAddress
;
2052 /** Addresses to bind for listening for SOCKS connections. */
2053 config_line_t
*DNSListenAddress
;
2054 /** Addresses to bind for listening for OR connections. */
2055 config_line_t
*ORListenAddress
;
2056 /** Addresses to bind for listening for directory connections. */
2057 config_line_t
*DirListenAddress
;
2058 /** Addresses to bind for listening for control connections. */
2059 config_line_t
*ControlListenAddress
;
2060 /** Local address to bind outbound sockets */
2061 char *OutboundBindAddress
;
2062 /** Directory server only: which versions of
2063 * Tor should we tell users to run? */
2064 config_line_t
*RecommendedVersions
;
2065 config_line_t
*RecommendedClientVersions
;
2066 config_line_t
*RecommendedServerVersions
;
2067 /** Whether dirservers refuse router descriptors with private IPs. */
2068 int DirAllowPrivateAddresses
;
2069 char *User
; /**< Name of user to run Tor as. */
2070 char *Group
; /**< Name of group to run Tor as. */
2071 int ORPort
; /**< Port to listen on for OR connections. */
2072 int SocksPort
; /**< Port to listen on for SOCKS connections. */
2073 /** Port to listen on for transparent pf/netfilter connections. */
2075 int NatdPort
; /**< Port to listen on for transparent natd connections. */
2076 int ControlPort
; /**< Port to listen on for control connections. */
2077 config_line_t
*ControlSocket
; /**< List of Unix Domain Sockets to listen on
2078 * for control connections. */
2079 int DirPort
; /**< Port to listen on for directory connections. */
2080 int DNSPort
; /**< Port to listen on for DNS requests. */
2081 int AssumeReachable
; /**< Whether to publish our descriptor regardless. */
2082 int AuthoritativeDir
; /**< Boolean: is this an authoritative directory? */
2083 int V1AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2084 * for version 1 directories? */
2085 int V2AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2086 * for version 2 directories? */
2087 int V3AuthoritativeDir
; /**< Boolean: is this an authoritative directory
2088 * for version 3 directories? */
2089 int HSAuthoritativeDir
; /**< Boolean: does this an authoritative directory
2090 * handle hidden service requests? */
2091 int HSAuthorityRecordStats
; /**< Boolean: does this HS authoritative
2092 * directory record statistics? */
2093 int NamingAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2094 * that's willing to bind names? */
2095 int VersioningAuthoritativeDir
; /**< Boolean: is this an authoritative
2096 * directory that's willing to recommend
2098 int BridgeAuthoritativeDir
; /**< Boolean: is this an authoritative directory
2099 * that aggregates bridge descriptors? */
2101 /** If set on a bridge authority, it will answer requests on its dirport
2102 * for bridge statuses -- but only if the requests use this password.
2103 * If set on a bridge user, request bridge statuses, and use this password
2105 char *BridgePassword
;
2107 int UseBridges
; /**< Boolean: should we start all circuits with a bridge? */
2108 config_line_t
*Bridges
; /**< List of bootstrap bridge addresses. */
2110 int BridgeRelay
; /**< Boolean: are we acting as a bridge relay? We make
2111 * this explicit so we can change how we behave in the
2114 /** Boolean: if we know the bridge's digest, should we get new
2115 * descriptors from the bridge authorities or from the bridge itself? */
2116 int UpdateBridgesFromAuthority
;
2118 int AvoidDiskWrites
; /**< Boolean: should we never cache things to disk?
2120 int ClientOnly
; /**< Boolean: should we never evolve into a server role? */
2121 /** Boolean: should we never publish a descriptor? Deprecated. */
2123 /** To what authority types do we publish our descriptor? Choices are
2124 * "v1", "v2", "v3", "bridge", or "". */
2125 smartlist_t
*PublishServerDescriptor
;
2126 /** An authority type, derived from PublishServerDescriptor. */
2127 authority_type_t _PublishServerDescriptor
;
2128 /** Boolean: do we publish hidden service descriptors to the HS auths? */
2129 int PublishHidServDescriptors
;
2130 int FetchServerDescriptors
; /**< Do we fetch server descriptors as normal? */
2131 int FetchHidServDescriptors
; /** and hidden service descriptors? */
2132 int HidServDirectoryV2
; /**< Do we participate in the HS DHT? */
2134 int MinUptimeHidServDirectoryV2
; /**< As directory authority, accept hidden
2135 * service directories after what time? */
2136 int FetchUselessDescriptors
; /**< Do we fetch non-running descriptors too? */
2137 int AllDirActionsPrivate
; /**< Should every directory action be sent
2138 * through a Tor circuit? */
2140 int ConnLimit
; /**< Demanded minimum number of simultaneous connections. */
2141 int _ConnLimit
; /**< Maximum allowed number of simultaneous connections. */
2142 int RunAsDaemon
; /**< If true, run in the background. (Unix only) */
2143 int FascistFirewall
; /**< Whether to prefer ORs reachable on open ports. */
2144 smartlist_t
*FirewallPorts
; /**< Which ports our firewall allows
2146 config_line_t
*ReachableAddresses
; /**< IP:ports our firewall allows. */
2147 config_line_t
*ReachableORAddresses
; /**< IP:ports for OR conns. */
2148 config_line_t
*ReachableDirAddresses
; /**< IP:ports for Dir conns. */
2150 int ConstrainedSockets
; /**< Shrink xmit and recv socket buffers. */
2151 uint64_t ConstrainedSockSize
; /**< Size of constrained buffers. */
2153 /** Application ports that require all nodes in circ to have sufficient
2155 smartlist_t
*LongLivedPorts
;
2156 /** Application ports that are likely to be unencrypted and
2157 * unauthenticated; we reject requests for them to prevent the
2158 * user from screwing up and leaking plaintext secrets to an
2159 * observer somewhere on the Internet. */
2160 smartlist_t
*RejectPlaintextPorts
;
2161 /** Related to RejectPlaintextPorts above, except this config option
2162 * controls whether we warn (in the log and via a controller status
2163 * event) every time a risky connection is attempted. */
2164 smartlist_t
*WarnPlaintextPorts
;
2165 /** Should we try to reuse the same exit node for a given host */
2166 smartlist_t
*TrackHostExits
;
2167 int TrackHostExitsExpire
; /**< Number of seconds until we expire an
2169 config_line_t
*AddressMap
; /**< List of address map directives. */
2170 int AutomapHostsOnResolve
; /**< If true, when we get a resolve request for a
2171 * hostname ending with one of the suffixes in
2172 * <b>AutomapHostsSuffixes</b>, map it to a
2173 * virtual address. */
2174 smartlist_t
*AutomapHostsSuffixes
; /**< List of suffixes for
2175 * <b>AutomapHostsOnResolve</b>. */
2176 int RendPostPeriod
; /**< How often do we post each rendezvous service
2177 * descriptor? Remember to publish them independently. */
2178 int KeepalivePeriod
; /**< How often do we send padding cells to keep
2179 * connections alive? */
2180 int SocksTimeout
; /**< How long do we let a socks connection wait
2181 * unattached before we fail it? */
2182 int CircuitBuildTimeout
; /**< Cull non-open circuits that were born
2183 * at least this many seconds ago. */
2184 int CircuitIdleTimeout
; /**< Cull open clean circuits that were born
2185 * at least this many seconds ago. */
2186 int MaxOnionsPending
; /**< How many circuit CREATE requests do we allow
2187 * to wait simultaneously before we start dropping
2189 int NewCircuitPeriod
; /**< How long do we use a circuit before building
2191 int MaxCircuitDirtiness
; /**< Never use circs that were first used more than
2192 this interval ago. */
2193 uint64_t BandwidthRate
; /**< How much bandwidth, on average, are we willing
2194 * to use in a second? */
2195 uint64_t BandwidthBurst
; /**< How much bandwidth, at maximum, are we willing
2196 * to use in a second? */
2197 uint64_t MaxAdvertisedBandwidth
; /**< How much bandwidth are we willing to
2198 * tell people we have? */
2199 uint64_t RelayBandwidthRate
; /**< How much bandwidth, on average, are we
2200 * willing to use for all relayed conns? */
2201 uint64_t RelayBandwidthBurst
; /**< How much bandwidth, at maximum, will we
2202 * use in a second for all relayed conns? */
2203 int NumCpus
; /**< How many CPUs should we try to use? */
2204 int RunTesting
; /**< If true, create testing circuits to measure how well the
2205 * other ORs are running. */
2206 char *TestVia
; /**< When reachability testing, use these as middle hop. */
2207 config_line_t
*RendConfigLines
; /**< List of configuration lines
2208 * for rendezvous services. */
2209 char *ContactInfo
; /**< Contact info to be published in the directory. */
2211 char *HttpProxy
; /**< hostname[:port] to use as http proxy, if any. */
2212 uint32_t HttpProxyAddr
; /**< Parsed IPv4 addr for http proxy, if any. */
2213 uint16_t HttpProxyPort
; /**< Parsed port for http proxy, if any. */
2214 char *HttpProxyAuthenticator
; /**< username:password string, if any. */
2216 char *HttpsProxy
; /**< hostname[:port] to use as https proxy, if any. */
2217 uint32_t HttpsProxyAddr
; /**< Parsed IPv4 addr for https proxy, if any. */
2218 uint16_t HttpsProxyPort
; /**< Parsed port for https proxy, if any. */
2219 char *HttpsProxyAuthenticator
; /**< username:password string, if any. */
2221 /** List of configuration lines for replacement directory authorities.
2222 * If you just want to replace one class of authority at a time,
2223 * use the "Alternate*Authority" options below instead. */
2224 config_line_t
*DirServers
;
2226 /** If set, use these main (currently v3) directory authorities and
2227 * not the default ones. */
2228 config_line_t
*AlternateDirAuthority
;
2230 /** If set, use these bridge authorities and not the default one. */
2231 config_line_t
*AlternateBridgeAuthority
;
2233 /** If set, use these HS authorities and not the default ones. */
2234 config_line_t
*AlternateHSAuthority
;
2236 char *MyFamily
; /**< Declared family for this OR. */
2237 config_line_t
*NodeFamilies
; /**< List of config lines for
2239 config_line_t
*RedirectExit
; /**< List of config lines for simple
2240 * addr/port redirection */
2241 smartlist_t
*RedirectExitList
; /**< List of exit_redirect_t */
2242 config_line_t
*AuthDirBadDir
; /**< Address policy for descriptors to
2243 * mark as bad dir mirrors. */
2244 config_line_t
*AuthDirBadExit
; /**< Address policy for descriptors to
2245 * mark as bad exits. */
2246 config_line_t
*AuthDirReject
; /**< Address policy for descriptors to
2248 config_line_t
*AuthDirInvalid
; /**< Address policy for descriptors to
2249 * never mark as valid. */
2250 int AuthDirListBadDirs
; /**< True iff we should list bad dirs,
2251 * and vote for all other dir mirrors as good. */
2252 int AuthDirListBadExits
; /**< True iff we should list bad exits,
2253 * and vote for all other exits as good. */
2254 int AuthDirRejectUnlisted
; /**< Boolean: do we reject all routers that
2255 * aren't named in our fingerprint file? */
2256 int AuthDirMaxServersPerAddr
; /**< Do not permit more than this
2257 * number of servers per IP address. */
2258 int AuthDirMaxServersPerAuthAddr
; /**< Do not permit more than this
2259 * number of servers per IP address shared
2260 * with an authority. */
2262 char *AccountingStart
; /**< How long is the accounting interval, and when
2264 uint64_t AccountingMax
; /**< How many bytes do we allow per accounting
2265 * interval before hibernation? 0 for "never
2268 /** Base64-encoded hash of accepted passwords for the control system. */
2269 config_line_t
*HashedControlPassword
;
2270 /** As HashedControlPassword, but not saved. */
2271 config_line_t
*HashedControlSessionPassword
;
2273 int CookieAuthentication
; /**< Boolean: do we enable cookie-based auth for
2274 * the control system? */
2275 char *CookieAuthFile
; /**< Location of a cookie authentication file. */
2276 int CookieAuthFileGroupReadable
; /**< Boolean: Is the CookieAuthFile g+r? */
2277 int LeaveStreamsUnattached
; /**< Boolean: Does Tor attach new streams to
2278 * circuits itself (0), or does it expect a controller
2280 int DisablePredictedCircuits
; /**< Boolean: does Tor preemptively
2281 * make circuits in the background (0),
2283 int ShutdownWaitLength
; /**< When we get a SIGINT and we're a server, how
2284 * long do we wait before exiting? */
2285 int SafeLogging
; /**< Boolean: are we allowed to log sensitive strings
2286 * such as addresses (0), or do we scrub them first (1)? */
2287 int SafeSocks
; /**< Boolean: should we outright refuse application
2288 * connections that use socks4 or socks5-with-local-dns? */
2289 #define LOG_PROTOCOL_WARN (get_options()->ProtocolWarnings ? \
2290 LOG_WARN : LOG_INFO)
2291 int ProtocolWarnings
; /**< Boolean: when other parties screw up the Tor
2292 * protocol, is it a warn or an info in our logs? */
2293 int TestSocks
; /**< Boolean: when we get a socks connection, do we loudly
2294 * log whether it was DNS-leaking or not? */
2295 int HardwareAccel
; /**< Boolean: Should we enable OpenSSL hardware
2296 * acceleration where available? */
2297 int UseEntryGuards
; /**< Boolean: Do we try to enter from a smallish number
2298 * of fixed nodes? */
2299 int NumEntryGuards
; /**< How many entry guards do we try to establish? */
2300 int RephistTrackTime
; /**< How many seconds do we keep rephist info? */
2301 int FastFirstHopPK
; /**< If Tor believes it is safe, should we save a third
2302 * of our PK time by sending CREATE_FAST cells? */
2303 /** Should we always fetch our dir info on the mirror schedule (which
2304 * means directly from the authorities) no matter our other config? */
2305 int FetchDirInfoEarly
;
2307 smartlist_t
*reachable_addr_policy
; /**< Parsed from ReachableAddresses */
2309 char *VirtualAddrNetwork
; /**< Address and mask to hand out for virtual
2310 * MAPADDRESS requests. */
2311 int ServerDNSSearchDomains
; /**< Boolean: If set, we don't force exit
2312 * addresses to be FQDNs, but rather search for them in
2313 * the local domains. */
2314 int ServerDNSDetectHijacking
; /**< Boolean: If true, check for DNS failure
2316 char *ServerDNSResolvConfFile
; /**< If provided, we configure our internal
2317 * resolver from the file here rather than from
2318 * /etc/resolv.conf (Unix) or the registry (Windows). */
2319 /** Boolean: if set, we start even if our resolv.conf file is missing
2321 int ServerDNSAllowBrokenResolvConf
;
2323 smartlist_t
*ServerDNSTestAddresses
; /**< A list of addresses that definitely
2324 * should be resolveable. Used for
2325 * testing our DNS server. */
2326 int EnforceDistinctSubnets
; /**< If true, don't allow multiple routers in the
2327 * same network zone in the same circuit. */
2328 int TunnelDirConns
; /**< If true, use BEGIN_DIR rather than BEGIN when
2330 int PreferTunneledDirConns
; /**< If true, avoid dirservers that don't
2331 * support BEGIN_DIR, when possible. */
2332 int AllowNonRFC953Hostnames
; /**< If true, we allow connections to hostnames
2333 * with weird characters. */
2334 /** If true, we try resolving hostnames with weird characters. */
2335 int ServerDNSAllowNonRFC953Hostnames
;
2337 /** If true, we try to download extra-info documents (and we serve them,
2338 * if we are a cache). For authorities, this is always true. */
2339 int DownloadExtraInfo
;
2341 /** If true, do not believe anybody who tells us that a domain resolves
2342 * to an internal address, or that an internal address has a PTR mapping.
2343 * Helps avoid some cross-site attacks. */
2344 int ClientDNSRejectInternalAddresses
;
2346 /** The length of time that we think a consensus should be fresh. */
2347 int V3AuthVotingInterval
;
2348 /** The length of time we think it will take to distribute votes. */
2349 int V3AuthVoteDelay
;
2350 /** The length of time we think it will take to distribute signatures. */
2351 int V3AuthDistDelay
;
2352 /** The number of intervals we think a consensus should be valid. */
2353 int V3AuthNIntervalsValid
;
2355 /** Should advertise and sign consensuses with a legacy key, for key
2356 * migration purposes? */
2357 int V3AuthUseLegacyKey
;
2359 /** The length of time that we think an initial consensus should be fresh.
2360 * Only altered on testing networks. */
2361 int TestingV3AuthInitialVotingInterval
;
2363 /** The length of time we think it will take to distribute initial votes.
2364 * Only altered on testing networks. */
2365 int TestingV3AuthInitialVoteDelay
;
2367 /** The length of time we think it will take to distribute initial
2368 * signatures. Only altered on testing networks.*/
2369 int TestingV3AuthInitialDistDelay
;
2371 /** If an authority has been around for less than this amount of time, it
2372 * does not believe its reachability information is accurate. Only
2373 * altered on testing networks. */
2374 int TestingAuthDirTimeToLearnReachability
;
2376 /** Clients don't download any descriptor this recent, since it will
2377 * probably not have propagated to enough caches. Only altered on testing
2379 int TestingEstimatedDescriptorPropagationTime
;
2381 /** If true, we take part in a testing network. Change the defaults of a
2382 * couple of other configuration options and allow to change the values
2383 * of certain configuration options. */
2384 int TestingTorNetwork
;
2386 /** File to check for a consensus networkstatus, if we don't have one
2388 char *FallbackNetworkstatusFile
;
2390 /** If true, and we have GeoIP data, and we're a bridge, keep a per-country
2391 * count of how many client addresses have contacted us so that we can help
2392 * the bridge authority guess which countries have blocked access to us. */
2393 int BridgeRecordUsageByCountry
;
2394 #ifdef ENABLE_GEOIP_STATS
2395 int DirRecordUsageByCountry
;
2396 int DirRecordUsageGranularity
;
2397 int DirRecordUsageRetainIPs
;
2398 int DirRecordUsageSaveInterval
;
2401 /** Optionally, a file with GeoIP data. */
2406 /** Persistent state for an onion router, as saved to disk. */
2409 /** The time at which we next plan to write the state to the disk. Equal to
2410 * TIME_MAX if there are no saveable changes, 0 if there are changes that
2411 * should be saved right away. */
2414 /** When was the state last written to disk? */
2417 /** Fields for accounting bandwidth use. */
2418 time_t AccountingIntervalStart
;
2419 uint64_t AccountingBytesReadInInterval
;
2420 uint64_t AccountingBytesWrittenInInterval
;
2421 int AccountingSecondsActive
;
2422 uint64_t AccountingExpectedUsage
;
2424 /** A list of Entry Guard-related configuration lines. */
2425 config_line_t
*EntryGuards
;
2427 /** These fields hold information on the history of bandwidth usage for
2428 * servers. The "Ends" fields hold the time when we last updated the
2429 * bandwidth usage. The "Interval" fields hold the granularity, in seconds,
2430 * of the entries of Values. The "Values" lists hold decimal string
2431 * representations of the number of bytes read or written in each
2433 time_t BWHistoryReadEnds
;
2434 int BWHistoryReadInterval
;
2435 smartlist_t
*BWHistoryReadValues
;
2436 time_t BWHistoryWriteEnds
;
2437 int BWHistoryWriteInterval
;
2438 smartlist_t
*BWHistoryWriteValues
;
2440 /** What version of Tor wrote this state file? */
2443 /** Holds any unrecognized values we found in the state file, in the order
2444 * in which we found them. */
2445 config_line_t
*ExtraLines
;
2447 /** When did we last rotate our onion key? "0" for 'no idea'. */
2448 time_t LastRotatedOnionKey
;
2451 /** Change the next_write time of <b>state</b> to <b>when</b>, unless the
2452 * state is already scheduled to be written to disk earlier than <b>when</b>.
2454 static INLINE
void or_state_mark_dirty(or_state_t
*state
, time_t when
)
2456 if (state
->next_write
> when
)
2457 state
->next_write
= when
;
2460 #define MAX_SOCKS_REPLY_LEN 1024
2461 #define MAX_SOCKS_ADDR_LEN 256
2463 /** Please open a TCP connection to this addr:port. */
2464 #define SOCKS_COMMAND_CONNECT 0x01
2465 /** Please turn this FQDN into an IP address, privately. */
2466 #define SOCKS_COMMAND_RESOLVE 0xF0
2467 /** Please turn this IP address into an FQDN, privately. */
2468 #define SOCKS_COMMAND_RESOLVE_PTR 0xF1
2470 #define SOCKS_COMMAND_IS_CONNECT(c) ((c)==SOCKS_COMMAND_CONNECT)
2471 #define SOCKS_COMMAND_IS_RESOLVE(c) ((c)==SOCKS_COMMAND_RESOLVE || \
2472 (c)==SOCKS_COMMAND_RESOLVE_PTR)
2474 /** State of a SOCKS request from a user to an OP. Also used to encode other
2475 * information for non-socks user request (such as those on TransPort and
2477 struct socks_request_t
{
2478 /** Which version of SOCKS did the client use? One of "0, 4, 5" -- where
2479 * 0 means that no socks handshake ever took place, and this is just a
2480 * stub connection (e.g. see connection_ap_make_link()). */
2482 int command
; /**< What is this stream's goal? One from the above list. */
2483 size_t replylen
; /**< Length of <b>reply</b>. */
2484 char reply
[MAX_SOCKS_REPLY_LEN
]; /**< Write an entry into this string if
2485 * we want to specify our own socks reply,
2486 * rather than using the default socks4 or
2487 * socks5 socks reply. We use this for the
2488 * two-stage socks5 handshake.
2490 char address
[MAX_SOCKS_ADDR_LEN
]; /**< What address did the client ask to
2491 connect to/resolve? */
2492 uint16_t port
; /**< What port did the client ask to connect to? */
2493 unsigned int has_finished
: 1; /**< Has the SOCKS handshake finished? Used to
2494 * make sure we send back a socks reply for
2495 * every connection. */
2498 /* all the function prototypes go here */
2500 /********************************* buffers.c ***************************/
2502 buf_t
*buf_new(void);
2503 buf_t
*buf_new_with_capacity(size_t size
);
2504 void buf_free(buf_t
*buf
);
2505 void buf_clear(buf_t
*buf
);
2506 void buf_shrink(buf_t
*buf
);
2507 void buf_shrink_freelists(int free_all
);
2508 void buf_dump_freelist_sizes(int severity
);
2510 size_t buf_datalen(const buf_t
*buf
);
2511 size_t buf_allocation(const buf_t
*buf
);
2512 size_t buf_slack(const buf_t
*buf
);
2513 const char *_buf_peek_raw_buffer(const buf_t
*buf
);
2515 int read_to_buf(int s
, size_t at_most
, buf_t
*buf
, int *reached_eof
);
2516 int read_to_buf_tls(tor_tls_t
*tls
, size_t at_most
, buf_t
*buf
);
2518 int flush_buf(int s
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2519 int flush_buf_tls(tor_tls_t
*tls
, buf_t
*buf
, size_t sz
, size_t *buf_flushlen
);
2521 int write_to_buf(const char *string
, size_t string_len
, buf_t
*buf
);
2522 int write_to_buf_zlib(buf_t
*buf
, tor_zlib_state_t
*state
,
2523 const char *data
, size_t data_len
, int done
);
2524 int move_buf_to_buf(buf_t
*buf_out
, buf_t
*buf_in
, size_t *buf_flushlen
);
2525 int fetch_from_buf(char *string
, size_t string_len
, buf_t
*buf
);
2526 int fetch_var_cell_from_buf(buf_t
*buf
, var_cell_t
**out
, int linkproto
);
2527 int fetch_from_buf_http(buf_t
*buf
,
2528 char **headers_out
, size_t max_headerlen
,
2529 char **body_out
, size_t *body_used
, size_t max_bodylen
,
2530 int force_complete
);
2531 int fetch_from_buf_socks(buf_t
*buf
, socks_request_t
*req
,
2532 int log_sockstype
, int safe_socks
);
2533 int fetch_from_buf_line(buf_t
*buf
, char *data_out
, size_t *data_len
);
2535 int peek_buf_has_control0_command(buf_t
*buf
);
2537 void assert_buf_ok(buf_t
*buf
);
2539 #ifdef BUFFERS_PRIVATE
2540 int buf_find_string_offset(const buf_t
*buf
, const char *s
, size_t n
);
2543 /********************************* circuitbuild.c **********************/
2545 char *circuit_list_path(origin_circuit_t
*circ
, int verbose
);
2546 char *circuit_list_path_for_controller(origin_circuit_t
*circ
);
2547 void circuit_log_path(int severity
, unsigned int domain
,
2548 origin_circuit_t
*circ
);
2549 void circuit_rep_hist_note_result(origin_circuit_t
*circ
);
2550 origin_circuit_t
*origin_circuit_init(uint8_t purpose
, int flags
);
2551 origin_circuit_t
*circuit_establish_circuit(uint8_t purpose
,
2552 extend_info_t
*exit
,
2554 int circuit_handle_first_hop(origin_circuit_t
*circ
);
2555 void circuit_n_conn_done(or_connection_t
*or_conn
, int status
);
2556 int inform_testing_reachability(void);
2557 int circuit_send_next_onion_skin(origin_circuit_t
*circ
);
2558 void circuit_note_clock_jumped(int seconds_elapsed
);
2559 int circuit_extend(cell_t
*cell
, circuit_t
*circ
);
2560 int circuit_init_cpath_crypto(crypt_path_t
*cpath
, const char *key_data
,
2562 int circuit_finish_handshake(origin_circuit_t
*circ
, uint8_t cell_type
,
2564 int circuit_truncated(origin_circuit_t
*circ
, crypt_path_t
*layer
);
2565 int onionskin_answer(or_circuit_t
*circ
, uint8_t cell_type
,
2566 const char *payload
, const char *keys
);
2567 int circuit_all_predicted_ports_handled(time_t now
, int *need_uptime
,
2568 int *need_capacity
);
2570 int circuit_append_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2571 int circuit_extend_to_new_exit(origin_circuit_t
*circ
, extend_info_t
*info
);
2572 void onion_append_to_cpath(crypt_path_t
**head_ptr
, crypt_path_t
*new_hop
);
2573 extend_info_t
*extend_info_alloc(const char *nickname
, const char *digest
,
2574 crypto_pk_env_t
*onion_key
,
2575 uint32_t addr
, uint16_t port
);
2576 extend_info_t
*extend_info_from_router(routerinfo_t
*r
);
2577 extend_info_t
*extend_info_dup(extend_info_t
*info
);
2578 void extend_info_free(extend_info_t
*info
);
2579 routerinfo_t
*build_state_get_exit_router(cpath_build_state_t
*state
);
2580 const char *build_state_get_exit_nickname(cpath_build_state_t
*state
);
2582 void entry_guards_compute_status(void);
2583 int entry_guard_register_connect_status(const char *digest
, int succeeded
,
2585 void entry_nodes_should_be_added(void);
2586 int entry_list_can_grow(or_options_t
*options
);
2587 routerinfo_t
*choose_random_entry(cpath_build_state_t
*state
);
2588 int entry_guards_parse_state(or_state_t
*state
, int set
, char **msg
);
2589 void entry_guards_update_state(or_state_t
*state
);
2590 int getinfo_helper_entry_guards(control_connection_t
*conn
,
2591 const char *question
, char **answer
);
2593 void clear_bridge_list(void);
2594 int routerinfo_is_a_configured_bridge(routerinfo_t
*ri
);
2595 void bridge_add_from_config(uint32_t addr
, uint16_t port
, char *digest
);
2596 void retry_bridge_descriptor_fetch_directly(char *digest
);
2597 void fetch_bridge_descriptors(time_t now
);
2598 void learned_bridge_descriptor(routerinfo_t
*ri
, int from_cache
);
2599 int any_bridge_descriptors_known(void);
2600 int any_pending_bridge_descriptor_fetches(void);
2601 int bridges_known_but_down(void);
2602 void bridges_retry_all(void);
2604 void entry_guards_free_all(void);
2606 /********************************* circuitlist.c ***********************/
2608 circuit_t
* _circuit_get_global_list(void);
2609 const char *circuit_state_to_string(int state
);
2610 void circuit_dump_by_conn(connection_t
*conn
, int severity
);
2611 void circuit_set_p_circid_orconn(or_circuit_t
*circ
, uint16_t id
,
2612 or_connection_t
*conn
);
2613 void circuit_set_n_circid_orconn(circuit_t
*circ
, uint16_t id
,
2614 or_connection_t
*conn
);
2615 void circuit_set_state(circuit_t
*circ
, uint8_t state
);
2616 void circuit_close_all_marked(void);
2617 origin_circuit_t
*origin_circuit_new(void);
2618 or_circuit_t
*or_circuit_new(uint16_t p_circ_id
, or_connection_t
*p_conn
);
2619 circuit_t
*circuit_get_by_circid_orconn(uint16_t circ_id
,
2620 or_connection_t
*conn
);
2621 int circuit_id_in_use_on_orconn(uint16_t circ_id
, or_connection_t
*conn
);
2622 circuit_t
*circuit_get_by_edge_conn(edge_connection_t
*conn
);
2623 void circuit_unlink_all_from_or_conn(or_connection_t
*conn
, int reason
);
2624 origin_circuit_t
*circuit_get_by_global_id(uint32_t id
);
2625 origin_circuit_t
*circuit_get_by_rend_query_and_purpose(const char *rend_query
,
2627 origin_circuit_t
*circuit_get_next_by_pk_and_purpose(origin_circuit_t
*start
,
2628 const char *digest
, uint8_t purpose
);
2629 or_circuit_t
*circuit_get_rendezvous(const char *cookie
);
2630 or_circuit_t
*circuit_get_intro_point(const char *digest
);
2631 origin_circuit_t
*circuit_find_to_cannibalize(uint8_t purpose
,
2632 extend_info_t
*info
, int flags
);
2633 void circuit_mark_all_unused_circs(void);
2634 void circuit_expire_all_dirty_circs(void);
2635 void _circuit_mark_for_close(circuit_t
*circ
, int reason
,
2636 int line
, const char *file
);
2637 int circuit_get_cpath_len(origin_circuit_t
*circ
);
2638 crypt_path_t
*circuit_get_cpath_hop(origin_circuit_t
*circ
, int hopnum
);
2639 void circuit_get_all_pending_on_or_conn(smartlist_t
*out
,
2640 or_connection_t
*or_conn
);
2641 int circuit_count_pending_on_or_conn(or_connection_t
*or_conn
);
2643 #define circuit_mark_for_close(c, reason) \
2644 _circuit_mark_for_close((c), (reason), __LINE__, _SHORT_FILE_)
2646 void assert_cpath_layer_ok(const crypt_path_t
*cp
);
2647 void assert_circuit_ok(const circuit_t
*c
);
2648 void circuit_free_all(void);
2650 /********************************* circuituse.c ************************/
2652 void circuit_expire_building(time_t now
);
2653 void circuit_remove_handled_ports(smartlist_t
*needed_ports
);
2654 int circuit_stream_is_being_handled(edge_connection_t
*conn
, uint16_t port
,
2656 void circuit_build_needed_circs(time_t now
);
2657 void circuit_detach_stream(circuit_t
*circ
, edge_connection_t
*conn
);
2659 void reset_bandwidth_test(void);
2660 int circuit_enough_testing_circs(void);
2662 void circuit_has_opened(origin_circuit_t
*circ
);
2663 void circuit_build_failed(origin_circuit_t
*circ
);
2665 /** Flag to set when a circuit should have only a single hop. */
2666 #define CIRCLAUNCH_ONEHOP_TUNNEL (1<<0)
2667 /** Flag to set when a circuit needs to be built of high-uptime nodes */
2668 #define CIRCLAUNCH_NEED_UPTIME (1<<1)
2669 /** Flag to set when a circuit needs to be build of high-capcity nodes */
2670 #define CIRCLAUNCH_NEED_CAPACITY (1<<2)
2671 /** Flag to set when the last hop of a circuit doesn't need to be an
2673 #define CIRCLAUNCH_IS_INTERNAL (1<<3)
2674 origin_circuit_t
*circuit_launch_by_nickname(uint8_t purpose
,
2675 const char *exit_nickname
,
2677 origin_circuit_t
*circuit_launch_by_extend_info(uint8_t purpose
,
2678 extend_info_t
*info
,
2680 origin_circuit_t
*circuit_launch_by_router(uint8_t purpose
,
2681 routerinfo_t
*exit
, int flags
);
2682 void circuit_reset_failure_count(int timeout
);
2683 int connection_ap_handshake_attach_chosen_circuit(edge_connection_t
*conn
,
2684 origin_circuit_t
*circ
,
2685 crypt_path_t
*cpath
);
2686 int connection_ap_handshake_attach_circuit(edge_connection_t
*conn
);
2688 /********************************* command.c ***************************/
2690 void command_process_cell(cell_t
*cell
, or_connection_t
*conn
);
2691 void command_process_var_cell(var_cell_t
*cell
, or_connection_t
*conn
);
2693 extern uint64_t stats_n_padding_cells_processed
;
2694 extern uint64_t stats_n_create_cells_processed
;
2695 extern uint64_t stats_n_created_cells_processed
;
2696 extern uint64_t stats_n_relay_cells_processed
;
2697 extern uint64_t stats_n_destroy_cells_processed
;
2699 /********************************* config.c ***************************/
2701 /** An error from options_trial_assign() or options_init_from_string(). */
2702 typedef enum setopt_err_t
{
2704 SETOPT_ERR_MISC
= -1,
2705 SETOPT_ERR_PARSE
= -2,
2706 SETOPT_ERR_TRANSITION
= -3,
2707 SETOPT_ERR_SETTING
= -4,
2710 or_options_t
*get_options(void);
2711 int set_options(or_options_t
*new_val
, char **msg
);
2712 void config_free_all(void);
2713 const char *safe_str(const char *address
);
2714 const char *escaped_safe_str(const char *address
);
2715 const char *get_version(void);
2717 int config_get_lines(const char *string
, config_line_t
**result
);
2718 void config_free_lines(config_line_t
*front
);
2719 int options_trial_assign(config_line_t
*list
, int use_defaults
,
2720 int clear_first
, char **msg
);
2721 int resolve_my_address(int warn_severity
, or_options_t
*options
,
2722 uint32_t *addr
, char **hostname_out
);
2723 int is_local_IP(uint32_t ip
) ATTR_PURE
;
2724 void options_init(or_options_t
*options
);
2725 int options_init_from_torrc(int argc
, char **argv
);
2726 setopt_err_t
options_init_from_string(const char *cf
,
2727 int command
, const char *command_arg
, char **msg
);
2728 int option_is_recognized(const char *key
);
2729 const char *option_get_canonical_name(const char *key
);
2730 config_line_t
*option_get_assignment(or_options_t
*options
,
2732 int options_save_current(void);
2733 const char *get_torrc_fname(void);
2734 char *get_datadir_fname2_suffix(const char *sub1
, const char *sub2
,
2735 const char *suffix
);
2736 /** Return a newly allocated string containing datadir/sub1. See
2737 * get_datadir_fname2_suffix. */
2738 #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
2739 /** Return a newly allocated string containing datadir/sub1/sub2. See
2740 * get_datadir_fname2_suffix. */
2741 #define get_datadir_fname2(sub1,sub2) \
2742 get_datadir_fname2_suffix((sub1), (sub2), NULL)
2743 /** Return a newly allocated string containing datadir/sub1suffix. See
2744 * get_datadir_fname2_suffix. */
2745 #define get_datadir_fname_suffix(sub1, suffix) \
2746 get_datadir_fname2_suffix((sub1), NULL, (suffix))
2748 or_state_t
*get_or_state(void);
2749 int or_state_save(time_t now
);
2751 int getinfo_helper_config(control_connection_t
*conn
,
2752 const char *question
, char **answer
);
2754 #ifdef CONFIG_PRIVATE
2755 /* Used only by config.c and test.c */
2756 or_options_t
*options_new(void);
2759 /********************************* connection.c ***************************/
2761 const char *conn_type_to_string(int type
);
2762 const char *conn_state_to_string(int type
, int state
);
2764 connection_t
*connection_new(int type
, int socket_family
);
2765 void connection_link_connections(connection_t
*conn_a
, connection_t
*conn_b
);
2766 void connection_unregister_events(connection_t
*conn
);
2767 void connection_free(connection_t
*conn
);
2768 void connection_free_all(void);
2769 void connection_about_to_close_connection(connection_t
*conn
);
2770 void connection_close_immediate(connection_t
*conn
);
2771 void _connection_mark_for_close(connection_t
*conn
,int line
, const char *file
);
2773 #define connection_mark_for_close(c) \
2774 _connection_mark_for_close((c), __LINE__, _SHORT_FILE_)
2776 void connection_expire_held_open(void);
2778 int connection_connect(connection_t
*conn
, const char *address
, uint32_t addr
,
2779 uint16_t port
, int *socket_error
);
2780 int retry_all_listeners(smartlist_t
*replaced_conns
,
2781 smartlist_t
*new_conns
);
2783 ssize_t
connection_bucket_write_limit(connection_t
*conn
, time_t now
);
2784 int global_write_bucket_low(connection_t
*conn
, size_t attempt
, int priority
);
2785 void connection_bucket_init(void);
2786 void connection_bucket_refill(int seconds_elapsed
, time_t now
);
2788 int connection_handle_read(connection_t
*conn
);
2790 int connection_fetch_from_buf(char *string
, size_t len
, connection_t
*conn
);
2792 int connection_wants_to_flush(connection_t
*conn
);
2793 int connection_outbuf_too_full(connection_t
*conn
);
2794 int connection_handle_write(connection_t
*conn
, int force
);
2795 void _connection_write_to_buf_impl(const char *string
, size_t len
,
2796 connection_t
*conn
, int zlib
);
2797 static void connection_write_to_buf(const char *string
, size_t len
,
2798 connection_t
*conn
);
2799 static void connection_write_to_buf_zlib(const char *string
, size_t len
,
2800 dir_connection_t
*conn
, int done
);
2802 connection_write_to_buf(const char *string
, size_t len
, connection_t
*conn
)
2804 _connection_write_to_buf_impl(string
, len
, conn
, 0);
2807 connection_write_to_buf_zlib(const char *string
, size_t len
,
2808 dir_connection_t
*conn
, int done
)
2810 _connection_write_to_buf_impl(string
, len
, TO_CONN(conn
), done
? -1 : 1);
2813 or_connection_t
*connection_or_exact_get_by_addr_port(uint32_t addr
,
2815 edge_connection_t
*connection_get_by_global_id(uint32_t id
);
2817 connection_t
*connection_get_by_type(int type
);
2818 connection_t
*connection_get_by_type_purpose(int type
, int purpose
);
2819 connection_t
*connection_get_by_type_addr_port_purpose(int type
, uint32_t addr
,
2820 uint16_t port
, int purpose
);
2821 connection_t
*connection_get_by_type_state(int type
, int state
);
2822 connection_t
*connection_get_by_type_state_rendquery(int type
, int state
,
2823 const char *rendquery
,
2826 #define connection_speaks_cells(conn) ((conn)->type == CONN_TYPE_OR)
2827 int connection_is_listener(connection_t
*conn
);
2828 int connection_state_is_open(connection_t
*conn
);
2829 int connection_state_is_connecting(connection_t
*conn
);
2831 char *alloc_http_authenticator(const char *authenticator
);
2833 void assert_connection_ok(connection_t
*conn
, time_t now
);
2834 int connection_or_nonopen_was_started_here(or_connection_t
*conn
);
2835 void connection_dump_buffer_mem_stats(int severity
);
2836 void remove_file_if_very_old(const char *fname
, time_t now
);
2838 /********************************* connection_edge.c *************************/
2840 #define connection_mark_unattached_ap(conn, endreason) \
2841 _connection_mark_unattached_ap((conn), (endreason), __LINE__, _SHORT_FILE_)
2843 void _connection_mark_unattached_ap(edge_connection_t
*conn
, int endreason
,
2844 int line
, const char *file
);
2845 int connection_edge_reached_eof(edge_connection_t
*conn
);
2846 int connection_edge_process_inbuf(edge_connection_t
*conn
,
2847 int package_partial
);
2848 int connection_edge_destroy(uint16_t circ_id
, edge_connection_t
*conn
);
2849 int connection_edge_end(edge_connection_t
*conn
, char reason
);
2850 int connection_edge_end_errno(edge_connection_t
*conn
);
2851 int connection_edge_finished_flushing(edge_connection_t
*conn
);
2852 int connection_edge_finished_connecting(edge_connection_t
*conn
);
2854 int connection_ap_handshake_send_begin(edge_connection_t
*ap_conn
);
2855 int connection_ap_handshake_send_resolve(edge_connection_t
*ap_conn
);
2857 edge_connection_t
*connection_ap_make_link(char *address
, uint16_t port
,
2859 int use_begindir
, int want_onehop
);
2860 void connection_ap_handshake_socks_reply(edge_connection_t
*conn
, char *reply
,
2863 void connection_ap_handshake_socks_resolved(edge_connection_t
*conn
,
2870 int connection_exit_begin_conn(cell_t
*cell
, circuit_t
*circ
);
2871 int connection_exit_begin_resolve(cell_t
*cell
, or_circuit_t
*circ
);
2872 void connection_exit_connect(edge_connection_t
*conn
);
2873 int connection_edge_is_rendezvous_stream(edge_connection_t
*conn
);
2874 int connection_ap_can_use_exit(edge_connection_t
*conn
, routerinfo_t
*exit
);
2875 void connection_ap_expire_beginning(void);
2876 void connection_ap_attach_pending(void);
2877 void connection_ap_fail_onehop(const char *failed_digest
,
2878 cpath_build_state_t
*build_state
);
2879 void circuit_discard_optional_exit_enclaves(extend_info_t
*info
);
2880 int connection_ap_detach_retriable(edge_connection_t
*conn
,
2881 origin_circuit_t
*circ
,
2883 int connection_ap_process_transparent(edge_connection_t
*conn
);
2885 int address_is_invalid_destination(const char *address
, int client
);
2887 void addressmap_init(void);
2888 void addressmap_clean(time_t now
);
2889 void addressmap_clear_configured(void);
2890 void addressmap_clear_transient(void);
2891 void addressmap_free_all(void);
2892 int addressmap_rewrite(char *address
, size_t maxlen
, time_t *expires_out
);
2893 int addressmap_have_mapping(const char *address
);
2895 ADDRMAPSRC_CONTROLLER
, ADDRMAPSRC_TORRC
, ADDRMAPSRC_TRACKEXIT
,
2897 } addressmap_entry_source_t
;
2898 void addressmap_register(const char *address
, char *new_address
,
2899 time_t expires
, addressmap_entry_source_t source
);
2900 int parse_virtual_addr_network(const char *val
, int validate_only
,
2902 int client_dns_incr_failures(const char *address
);
2903 void client_dns_clear_failures(const char *address
);
2904 void client_dns_set_addressmap(const char *address
, uint32_t val
,
2905 const char *exitname
, int ttl
);
2906 const char *addressmap_register_virtual_address(int type
, char *new_address
);
2907 void addressmap_get_mappings(smartlist_t
*sl
, time_t min_expires
,
2908 time_t max_expires
, int want_expiry
);
2909 int connection_ap_handshake_rewrite_and_attach(edge_connection_t
*conn
,
2910 origin_circuit_t
*circ
,
2911 crypt_path_t
*cpath
);
2912 int hostname_is_noconnect_address(const char *address
);
2914 void set_exit_redirects(smartlist_t
*lst
);
2915 typedef enum hostname_type_t
{
2916 NORMAL_HOSTNAME
, ONION_HOSTNAME
, EXIT_HOSTNAME
, BAD_HOSTNAME
2918 hostname_type_t
parse_extended_hostname(char *address
);
2920 /********************************* connection_or.c ***************************/
2922 void connection_or_remove_from_identity_map(or_connection_t
*conn
);
2923 void connection_or_clear_identity_map(void);
2924 or_connection_t
*connection_or_get_by_identity_digest(const char *digest
);
2926 int connection_or_reached_eof(or_connection_t
*conn
);
2927 int connection_or_process_inbuf(or_connection_t
*conn
);
2928 int connection_or_flushed_some(or_connection_t
*conn
);
2929 int connection_or_finished_flushing(or_connection_t
*conn
);
2930 int connection_or_finished_connecting(or_connection_t
*conn
);
2932 or_connection_t
*connection_or_connect(uint32_t addr
, uint16_t port
,
2933 const char *id_digest
);
2935 int connection_tls_start_handshake(or_connection_t
*conn
, int receiving
);
2936 int connection_tls_continue_handshake(or_connection_t
*conn
);
2938 void or_handshake_state_free(or_handshake_state_t
*state
);
2939 int connection_or_set_state_open(or_connection_t
*conn
);
2940 void connection_or_write_cell_to_buf(const cell_t
*cell
,
2941 or_connection_t
*conn
);
2942 void connection_or_write_var_cell_to_buf(const var_cell_t
*cell
,
2943 or_connection_t
*conn
);
2944 int connection_or_send_destroy(uint16_t circ_id
, or_connection_t
*conn
,
2946 int connection_or_send_netinfo(or_connection_t
*conn
);
2947 int connection_or_send_cert(or_connection_t
*conn
);
2948 int connection_or_send_link_auth(or_connection_t
*conn
);
2949 int connection_or_compute_link_auth_hmac(or_connection_t
*conn
,
2951 int is_or_protocol_version_known(uint16_t version
);
2953 void cell_pack(packed_cell_t
*dest
, const cell_t
*src
);
2954 void var_cell_pack_header(const var_cell_t
*cell
, char *hdr_out
);
2955 var_cell_t
*var_cell_new(uint16_t payload_len
);
2956 void var_cell_free(var_cell_t
*cell
);
2958 /********************************* control.c ***************************/
2960 typedef enum circuit_status_event_t
{
2961 CIRC_EVENT_LAUNCHED
= 0,
2962 CIRC_EVENT_BUILT
= 1,
2963 CIRC_EVENT_EXTENDED
= 2,
2964 CIRC_EVENT_FAILED
= 3,
2965 CIRC_EVENT_CLOSED
= 4,
2966 } circuit_status_event_t
;
2968 typedef enum stream_status_event_t
{
2969 STREAM_EVENT_SENT_CONNECT
= 0,
2970 STREAM_EVENT_SENT_RESOLVE
= 1,
2971 STREAM_EVENT_SUCCEEDED
= 2,
2972 STREAM_EVENT_FAILED
= 3,
2973 STREAM_EVENT_CLOSED
= 4,
2974 STREAM_EVENT_NEW
= 5,
2975 STREAM_EVENT_NEW_RESOLVE
= 6,
2976 STREAM_EVENT_FAILED_RETRIABLE
= 7,
2977 STREAM_EVENT_REMAP
= 8
2978 } stream_status_event_t
;
2980 typedef enum or_conn_status_event_t
{
2981 OR_CONN_EVENT_LAUNCHED
= 0,
2982 OR_CONN_EVENT_CONNECTED
= 1,
2983 OR_CONN_EVENT_FAILED
= 2,
2984 OR_CONN_EVENT_CLOSED
= 3,
2985 OR_CONN_EVENT_NEW
= 4,
2986 } or_conn_status_event_t
;
2988 void control_update_global_event_mask(void);
2989 void control_adjust_event_log_severity(void);
2991 /** Execute the statement <b>stmt</b>, which may log events concerning the
2992 * connection <b>conn</b>. To prevent infinite loops, disable log messages
2993 * being sent to controllers if <b>conn</b> is a control connection.
2995 * Stmt must not contain any return or goto statements.
2997 #define CONN_LOG_PROTECT(conn, stmt) \
2999 int _log_conn_is_control = (conn && conn->type == CONN_TYPE_CONTROL); \
3000 if (_log_conn_is_control) \
3001 disable_control_logging(); \
3002 STMT_BEGIN stmt; STMT_END; \
3003 if (_log_conn_is_control) \
3004 enable_control_logging(); \
3007 /** Log information about the connection <b>conn</b>, protecting it as with
3008 * CONN_LOG_PROTECT. Example:
3010 * LOG_FN_CONN(conn, (LOG_DEBUG, "Socket %d wants to write", conn->s));
3012 #define LOG_FN_CONN(conn, args) \
3013 CONN_LOG_PROTECT(conn, log_fn args)
3015 int connection_control_finished_flushing(control_connection_t
*conn
);
3016 int connection_control_reached_eof(control_connection_t
*conn
);
3017 int connection_control_process_inbuf(control_connection_t
*conn
);
3019 #define EVENT_AUTHDIR_NEWDESCS 0x000D
3020 #define EVENT_NS 0x000F
3021 int control_event_is_interesting(int event
);
3023 int control_event_circuit_status(origin_circuit_t
*circ
,
3024 circuit_status_event_t e
, int reason
);
3025 int control_event_stream_status(edge_connection_t
*conn
,
3026 stream_status_event_t e
,
3028 int control_event_or_conn_status(or_connection_t
*conn
,
3029 or_conn_status_event_t e
, int reason
);
3030 int control_event_bandwidth_used(uint32_t n_read
, uint32_t n_written
);
3031 int control_event_stream_bandwidth_used(void);
3032 void control_event_logmsg(int severity
, unsigned int domain
, const char *msg
);
3033 int control_event_descriptors_changed(smartlist_t
*routers
);
3034 int control_event_address_mapped(const char *from
, const char *to
,
3035 time_t expires
, const char *error
);
3036 int control_event_or_authdir_new_descriptor(const char *action
,
3040 int control_event_my_descriptor_changed(void);
3041 int control_event_networkstatus_changed(smartlist_t
*statuses
);
3042 int control_event_networkstatus_changed_single(routerstatus_t
*rs
);
3043 int control_event_general_status(int severity
, const char *format
, ...)
3045 int control_event_client_status(int severity
, const char *format
, ...)
3047 int control_event_server_status(int severity
, const char *format
, ...)
3049 int control_event_guard(const char *nickname
, const char *digest
,
3050 const char *status
);
3052 int init_cookie_authentication(int enabled
);
3053 smartlist_t
*decode_hashed_passwords(config_line_t
*passwords
);
3054 void disable_control_logging(void);
3055 void enable_control_logging(void);
3057 /** Enum describing various stages of bootstrapping, for use with controller
3058 * bootstrap status events. The values range from 0 to 100. */
3060 BOOTSTRAP_STATUS_UNDEF
=-1,
3061 BOOTSTRAP_STATUS_STARTING
=0,
3062 BOOTSTRAP_STATUS_CONN_DIR
=5,
3063 BOOTSTRAP_STATUS_HANDSHAKE
=-2,
3064 BOOTSTRAP_STATUS_HANDSHAKE_DIR
=10,
3065 BOOTSTRAP_STATUS_ONEHOP_CREATE
=15,
3066 BOOTSTRAP_STATUS_REQUESTING_STATUS
=20,
3067 BOOTSTRAP_STATUS_LOADING_STATUS
=25,
3068 BOOTSTRAP_STATUS_LOADING_KEYS
=40,
3069 BOOTSTRAP_STATUS_REQUESTING_DESCRIPTORS
=45,
3070 BOOTSTRAP_STATUS_LOADING_DESCRIPTORS
=50,
3071 BOOTSTRAP_STATUS_CONN_OR
=80,
3072 BOOTSTRAP_STATUS_HANDSHAKE_OR
=85,
3073 BOOTSTRAP_STATUS_CIRCUIT_CREATE
=90,
3074 BOOTSTRAP_STATUS_DONE
=100
3075 } bootstrap_status_t
;
3077 void control_event_bootstrap(bootstrap_status_t status
, int progress
);
3078 void control_event_bootstrap_problem(const char *warn
, int reason
);
3080 #ifdef CONTROL_PRIVATE
3081 /* Used only by control.c and test.c */
3082 size_t write_escaped_data(const char *data
, size_t len
, char **out
);
3083 size_t read_escaped_data(const char *data
, size_t len
, char **out
);
3086 /********************************* cpuworker.c *****************************/
3088 void cpu_init(void);
3089 void cpuworkers_rotate(void);
3090 int connection_cpu_finished_flushing(connection_t
*conn
);
3091 int connection_cpu_reached_eof(connection_t
*conn
);
3092 int connection_cpu_process_inbuf(connection_t
*conn
);
3093 int assign_onionskin_to_cpuworker(connection_t
*cpuworker
,
3097 /********************************* directory.c ***************************/
3099 int directories_have_accepted_server_descriptor(void);
3100 char *authority_type_to_string(authority_type_t auth
);
3101 void directory_post_to_dirservers(uint8_t dir_purpose
, uint8_t router_purpose
,
3102 authority_type_t type
, const char *payload
,
3103 size_t payload_len
, size_t extrainfo_len
);
3104 void directory_get_from_dirserver(uint8_t dir_purpose
, uint8_t router_purpose
,
3105 const char *resource
,
3106 int retry_if_no_servers
);
3107 void directory_get_from_all_authorities(uint8_t dir_purpose
,
3108 uint8_t router_purpose
,
3109 const char *resource
);
3110 void directory_initiate_command_routerstatus(routerstatus_t
*status
,
3111 uint8_t dir_purpose
,
3112 uint8_t router_purpose
,
3113 int anonymized_connection
,
3114 const char *resource
,
3115 const char *payload
,
3117 time_t if_modified_since
);
3119 int parse_http_response(const char *headers
, int *code
, time_t *date
,
3120 compress_method_t
*compression
, char **response
);
3122 int connection_dir_is_encrypted(dir_connection_t
*conn
);
3123 int connection_dir_reached_eof(dir_connection_t
*conn
);
3124 int connection_dir_process_inbuf(dir_connection_t
*conn
);
3125 int connection_dir_finished_flushing(dir_connection_t
*conn
);
3126 int connection_dir_finished_connecting(dir_connection_t
*conn
);
3127 void connection_dir_request_failed(dir_connection_t
*conn
);
3128 void directory_initiate_command(const char *address
, uint32_t addr
,
3129 uint16_t or_port
, uint16_t dir_port
,
3130 int supports_conditional_consensus
,
3131 int supports_begindir
, const char *digest
,
3132 uint8_t dir_purpose
, uint8_t router_purpose
,
3133 int anonymized_connection
,
3134 const char *resource
,
3135 const char *payload
, size_t payload_len
,
3136 time_t if_modified_since
);
3138 int dir_split_resource_into_fingerprints(const char *resource
,
3139 smartlist_t
*fp_out
, int *compresseed_out
,
3140 int decode_hex
, int sort_uniq
);
3141 char *directory_dump_request_log(void);
3142 void note_request(const char *key
, size_t bytes
);
3143 int router_supports_extrainfo(const char *identity_digest
, int is_authority
);
3145 time_t download_status_increment_failure(download_status_t
*dls
,
3146 int status_code
, const char *item
,
3147 int server
, time_t now
);
3148 #define download_status_failed(dls, sc) \
3149 download_status_increment_failure((dls), (sc), NULL, \
3150 get_options()->DirPort, time(NULL))
3152 void download_status_reset(download_status_t
*dls
);
3153 static int download_status_is_ready(download_status_t
*dls
, time_t now
,
3155 /** Return true iff, as of <b>now</b>, the resource tracked by <b>dls</b> is
3156 * ready to get its download reattempted. */
3158 download_status_is_ready(download_status_t
*dls
, time_t now
,
3161 return (dls
->n_download_failures
<= max_failures
3162 && dls
->next_attempt_at
<= now
);
3165 /********************************* dirserv.c ***************************/
3166 /** Maximum allowable length of a version line in a networkstatus. */
3167 #define MAX_V_LINE_LEN 128
3168 /** Length of "r Authority BadDirectory BadExit Exit Fast Guard HSDir Named
3169 * Running Stable Unnamed V2Dir Valid\n". */
3170 #define MAX_FLAG_LINE_LEN 96
3171 /** Amount of space to allocate for each entry: r, s, and v lines. */
3172 #define RS_ENTRY_LEN \
3173 ( /* first line */ \
3174 MAX_NICKNAME_LEN+BASE64_DIGEST_LEN*2+ISO_TIME_LEN+INET_NTOA_BUF_LEN+ \
3175 5*2 /* ports */ + 10 /* punctuation */ + \
3177 MAX_FLAG_LINE_LEN + \
3181 #define UNNAMED_ROUTER_NICKNAME "Unnamed"
3183 int connection_dirserv_flushed_some(dir_connection_t
*conn
);
3185 int dirserv_add_own_fingerprint(const char *nickname
, crypto_pk_env_t
*pk
);
3186 int dirserv_load_fingerprint_file(void);
3187 void dirserv_free_fingerprint_list(void);
3188 const char *dirserv_get_nickname_by_digest(const char *digest
);
3189 int dirserv_add_multiple_descriptors(const char *desc
, uint8_t purpose
,
3192 int dirserv_add_descriptor(routerinfo_t
*ri
, const char **msg
);
3193 int getinfo_helper_dirserv_unregistered(control_connection_t
*conn
,
3194 const char *question
, char **answer
);
3195 void dirserv_free_descriptors(void);
3196 void dirserv_set_router_is_running(routerinfo_t
*router
, time_t now
);
3197 int list_server_status_v1(smartlist_t
*routers
, char **router_status_out
,
3198 int for_controller
);
3199 int dirserv_dump_directory_to_string(char **dir_out
,
3200 crypto_pk_env_t
*private_key
);
3202 int directory_fetches_from_authorities(or_options_t
*options
);
3203 int directory_fetches_dir_info_early(or_options_t
*options
);
3204 int directory_fetches_dir_info_later(or_options_t
*options
);
3205 int directory_caches_v2_dir_info(or_options_t
*options
);
3206 #define directory_caches_v1_dir_info(o) directory_caches_v2_dir_info(o)
3207 int directory_caches_dir_info(or_options_t
*options
);
3208 int directory_permits_begindir_requests(or_options_t
*options
);
3209 int directory_permits_controller_requests(or_options_t
*options
);
3210 int directory_too_idle_to_fetch_descriptors(or_options_t
*options
, time_t now
);
3212 void directory_set_dirty(void);
3213 cached_dir_t
*dirserv_get_directory(void);
3214 cached_dir_t
*dirserv_get_runningrouters(void);
3215 cached_dir_t
*dirserv_get_consensus(void);
3216 void dirserv_set_cached_directory(const char *directory
, time_t when
,
3217 int is_running_routers
);
3218 void dirserv_set_cached_networkstatus_v2(const char *directory
,
3219 const char *identity
,
3221 void dirserv_set_cached_networkstatus_v3(const char *consensus
,
3223 void dirserv_clear_old_networkstatuses(time_t cutoff
);
3224 void dirserv_clear_old_v1_info(time_t now
);
3225 void dirserv_get_networkstatus_v2(smartlist_t
*result
, const char *key
);
3226 void dirserv_get_networkstatus_v2_fingerprints(smartlist_t
*result
,
3228 int dirserv_get_routerdesc_fingerprints(smartlist_t
*fps_out
, const char *key
,
3230 int for_unencrypted_conn
);
3231 int dirserv_get_routerdescs(smartlist_t
*descs_out
, const char *key
,
3233 void dirserv_orconn_tls_done(const char *address
,
3235 const char *digest_rcvd
,
3237 void dirserv_test_reachability(time_t now
, int try_all
);
3238 int authdir_wants_to_reject_router(routerinfo_t
*ri
, const char **msg
,
3240 int dirserv_would_reject_router(routerstatus_t
*rs
);
3241 int dirserv_remove_old_statuses(smartlist_t
*fps
, time_t cutoff
);
3242 int dirserv_have_any_serverdesc(smartlist_t
*fps
, int spool_src
);
3243 size_t dirserv_estimate_data_size(smartlist_t
*fps
, int is_serverdescs
,
3245 int routerstatus_format_entry(char *buf
, size_t buf_len
,
3246 routerstatus_t
*rs
, const char *platform
,
3247 int first_line_only
);
3248 void dirserv_free_all(void);
3249 void cached_dir_decref(cached_dir_t
*d
);
3250 cached_dir_t
*new_cached_dir(char *s
, time_t published
);
3252 /********************************* dirvote.c ************************/
3254 /** Lowest allowable value for VoteSeconds. */
3255 #define MIN_VOTE_SECONDS 20
3256 /** Lowest allowable value for DistSeconds. */
3257 #define MIN_DIST_SECONDS 20
3258 /** Smallest allowable voting interval. */
3259 #define MIN_VOTE_INTERVAL 300
3261 void dirvote_free_all(void);
3263 /* vote manipulation */
3264 char *networkstatus_compute_consensus(smartlist_t
*votes
,
3265 int total_authorities
,
3266 crypto_pk_env_t
*identity_key
,
3267 crypto_pk_env_t
*signing_key
,
3268 const char *legacy_identity_key_digest
,
3269 crypto_pk_env_t
*legacy_signing_key
);
3270 int networkstatus_add_detached_signatures(networkstatus_t
*target
,
3271 ns_detached_signatures_t
*sigs
,
3272 const char **msg_out
);
3273 char *networkstatus_get_detached_signatures(networkstatus_t
*consensus
);
3274 void ns_detached_signatures_free(ns_detached_signatures_t
*s
);
3276 /* cert manipulation */
3277 authority_cert_t
*authority_cert_dup(authority_cert_t
*cert
);
3279 /** Describes the schedule by which votes should be generated. */
3280 typedef struct vote_timing_t
{
3282 int n_intervals_valid
;
3286 /* vote scheduling */
3287 void dirvote_get_preferred_voting_intervals(vote_timing_t
*timing_out
);
3288 time_t dirvote_get_start_of_next_interval(time_t now
, int interval
);
3289 void dirvote_recalculate_timing(or_options_t
*options
, time_t now
);
3290 void dirvote_act(or_options_t
*options
, time_t now
);
3292 /* invoked on timers and by outside triggers. */
3293 struct pending_vote_t
* dirvote_add_vote(const char *vote_body
,
3294 const char **msg_out
,
3296 int dirvote_add_signatures(const char *detached_signatures_body
,
3298 const char **msg_out
);
3301 const char *dirvote_get_pending_consensus(void);
3302 const char *dirvote_get_pending_detached_signatures(void);
3304 #define DGV_INCLUDE_PENDING 2
3305 #define DGV_INCLUDE_PREVIOUS 4
3306 const cached_dir_t
*dirvote_get_vote(const char *fp
, int flags
);
3307 void set_routerstatus_from_routerinfo(routerstatus_t
*rs
,
3308 routerinfo_t
*ri
, time_t now
,
3309 int naming
, int exits_can_be_guards
,
3310 int listbadexits
, int listbaddirs
);
3311 void router_clear_status_flags(routerinfo_t
*ri
);
3313 dirserv_generate_networkstatus_vote_obj(crypto_pk_env_t
*private_key
,
3314 authority_cert_t
*cert
);
3316 #ifdef DIRVOTE_PRIVATE
3318 format_networkstatus_vote(crypto_pk_env_t
*private_key
,
3319 networkstatus_t
*v3_ns
);
3322 /********************************* dns.c ***************************/
3325 void dns_free_all(void);
3326 uint32_t dns_clip_ttl(uint32_t ttl
);
3327 int dns_reset(void);
3328 void connection_dns_remove(edge_connection_t
*conn
);
3329 void assert_connection_edge_not_dns_pending(edge_connection_t
*conn
);
3330 void assert_all_pending_dns_resolves_ok(void);
3331 void dns_cancel_pending_resolve(const char *question
);
3332 int dns_resolve(edge_connection_t
*exitconn
);
3333 void dns_launch_correctness_checks(void);
3334 int dns_seems_to_be_broken(void);
3335 void dns_reset_correctness_checks(void);
3336 int parse_inaddr_arpa_address(const char *address
, struct in_addr
*in
);
3338 /********************************* dnsserv.c ************************/
3340 void dnsserv_configure_listener(connection_t
*conn
);
3341 void dnsserv_close_listener(connection_t
*conn
);
3342 void dnsserv_resolved(edge_connection_t
*conn
,
3347 void dnsserv_reject_request(edge_connection_t
*conn
);
3348 int dnsserv_launch_request(const char *name
, int is_reverse
);
3350 /********************************* geoip.c **************************/
3352 #ifdef GEOIP_PRIVATE
3353 int geoip_parse_entry(const char *line
);
3355 int should_record_bridge_info(or_options_t
*options
);
3356 int geoip_load_file(const char *filename
, or_options_t
*options
);
3357 int geoip_get_country_by_ip(uint32_t ipaddr
);
3358 int geoip_get_n_countries(void);
3359 const char *geoip_get_country_name(int num
);
3360 int geoip_is_loaded(void);
3361 /** Indicates an action that we might be noting geoip statistics on.
3362 * Note that if we're noticing CONNECT, we're a bridge, and if we're noticing
3363 * the others, we're not.
3366 /** We've noticed a connection as a bridge relay. */
3367 GEOIP_CLIENT_CONNECT
= 0,
3368 /** We've served a networkstatus consensus as a directory server. */
3369 GEOIP_CLIENT_NETWORKSTATUS
= 1,
3370 /** We've served a v2 networkstatus consensus as a directory server. */
3371 GEOIP_CLIENT_NETWORKSTATUS_V2
= 2,
3372 } geoip_client_action_t
;
3373 void geoip_note_client_seen(geoip_client_action_t action
,
3374 uint32_t addr
, time_t now
);
3375 void geoip_remove_old_clients(time_t cutoff
);
3376 time_t geoip_get_history_start(void);
3377 char *geoip_get_client_history(time_t now
, geoip_client_action_t action
);
3378 char *geoip_get_request_history(time_t now
, geoip_client_action_t action
);
3379 int getinfo_helper_geoip(control_connection_t
*control_conn
,
3380 const char *question
, char **answer
);
3381 void geoip_free_all(void);
3382 void dump_geoip_stats(void);
3384 /********************************* hibernate.c **********************/
3386 int accounting_parse_options(or_options_t
*options
, int validate_only
);
3387 int accounting_is_enabled(or_options_t
*options
);
3388 void configure_accounting(time_t now
);
3389 void accounting_run_housekeeping(time_t now
);
3390 void accounting_add_bytes(size_t n_read
, size_t n_written
, int seconds
);
3391 int accounting_record_bandwidth_usage(time_t now
, or_state_t
*state
);
3392 void hibernate_begin_shutdown(void);
3393 int we_are_hibernating(void);
3394 void consider_hibernation(time_t now
);
3395 int getinfo_helper_accounting(control_connection_t
*conn
,
3396 const char *question
, char **answer
);
3397 void accounting_set_bandwidth_usage_from_state(or_state_t
*state
);
3399 /********************************* main.c ***************************/
3401 extern int has_completed_circuit
;
3403 int connection_add(connection_t
*conn
);
3404 int connection_remove(connection_t
*conn
);
3405 int connection_in_array(connection_t
*conn
);
3406 void add_connection_to_closeable_list(connection_t
*conn
);
3407 int connection_is_on_closeable_list(connection_t
*conn
);
3409 smartlist_t
*get_connection_array(void);
3411 void connection_watch_events(connection_t
*conn
, short events
);
3412 int connection_is_reading(connection_t
*conn
);
3413 void connection_stop_reading(connection_t
*conn
);
3414 void connection_start_reading(connection_t
*conn
);
3416 int connection_is_writing(connection_t
*conn
);
3417 void connection_stop_writing(connection_t
*conn
);
3418 void connection_start_writing(connection_t
*conn
);
3420 void connection_stop_reading_from_linked_conn(connection_t
*conn
);
3422 void directory_all_unreachable(time_t now
);
3423 void directory_info_has_arrived(time_t now
, int from_cache
);
3425 void ip_address_changed(int at_interface
);
3426 void dns_servers_relaunch_checks(void);
3428 void control_signal_act(int the_signal
);
3429 void handle_signals(int is_parent
);
3430 void tor_cleanup(void);
3431 void tor_free_all(int postfork
);
3433 int tor_main(int argc
, char *argv
[]);
3436 int do_main_loop(void);
3437 int do_list_fingerprint(void);
3438 void do_hash_password(void);
3439 int tor_init(int argc
, char **argv
);
3442 /********************************* networkstatus.c *********************/
3444 /** How old do we allow a v2 network-status to get before removing it
3446 #define MAX_NETWORKSTATUS_AGE (10*24*60*60)
3449 NS_FROM_CACHE
, NS_FROM_DIR_BY_FP
, NS_FROM_DIR_ALL
, NS_GENERATED
3450 } networkstatus_source_t
;
3452 typedef enum version_status_t
{
3453 VS_RECOMMENDED
=0, /**< This version is listed as recommended. */
3454 VS_OLD
=1, /**< This version is older than any recommended version. */
3455 VS_NEW
=2, /**< This version is newer than any recommended version. */
3456 VS_NEW_IN_SERIES
=3, /**< This version is newer than any recommended version
3457 * in its series, but later recommended versions exist.
3459 VS_UNRECOMMENDED
=4, /**< This version is not recommended (general case). */
3460 VS_EMPTY
=5, /**< The version list was empty; no agreed-on versions. */
3461 VS_UNKNOWN
, /**< We have no idea. */
3464 void networkstatus_reset_warnings(void);
3465 void networkstatus_reset_download_failures(void);
3466 int router_reload_v2_networkstatus(void);
3467 int router_reload_consensus_networkstatus(void);
3468 void routerstatus_free(routerstatus_t
*rs
);
3469 void networkstatus_v2_free(networkstatus_v2_t
*ns
);
3470 void networkstatus_vote_free(networkstatus_t
*ns
);
3471 networkstatus_voter_info_t
*networkstatus_get_voter_by_id(
3472 networkstatus_t
*vote
,
3473 const char *identity
);
3474 int networkstatus_check_consensus_signature(networkstatus_t
*consensus
,
3476 int networkstatus_check_voter_signature(networkstatus_t
*consensus
,
3477 networkstatus_voter_info_t
*voter
,
3478 authority_cert_t
*cert
);
3479 char *networkstatus_get_cache_filename(const char *identity_digest
);
3480 int router_set_networkstatus_v2(const char *s
, time_t arrived_at
,
3481 networkstatus_source_t source
,
3482 smartlist_t
*requested_fingerprints
);
3483 void networkstatus_v2_list_clean(time_t now
);
3484 routerstatus_t
*networkstatus_v2_find_entry(networkstatus_v2_t
*ns
,
3485 const char *digest
);
3486 routerstatus_t
*networkstatus_vote_find_entry(networkstatus_t
*ns
,
3487 const char *digest
);
3488 int networkstatus_vote_find_entry_idx(networkstatus_t
*ns
,
3489 const char *digest
, int *found_out
);
3490 const smartlist_t
*networkstatus_get_v2_list(void);
3491 download_status_t
*router_get_dl_status_by_descriptor_digest(const char *d
);
3492 routerstatus_t
*router_get_consensus_status_by_id(const char *digest
);
3493 routerstatus_t
*router_get_consensus_status_by_descriptor_digest(
3494 const char *digest
);
3495 routerstatus_t
*router_get_consensus_status_by_nickname(const char *nickname
,
3496 int warn_if_unnamed
);
3497 const char *networkstatus_get_router_digest_by_nickname(const char *nickname
);
3498 int networkstatus_nickname_is_unnamed(const char *nickname
);
3499 void networkstatus_consensus_download_failed(int status_code
);
3500 void update_consensus_networkstatus_fetch_time(time_t now
);
3501 int should_delay_dir_fetches(or_options_t
*options
);
3502 void update_networkstatus_downloads(time_t now
);
3503 void update_certificate_downloads(time_t now
);
3504 int consensus_is_waiting_for_certs(void);
3505 networkstatus_v2_t
*networkstatus_v2_get_by_digest(const char *digest
);
3506 networkstatus_t
*networkstatus_get_latest_consensus(void);
3507 networkstatus_t
*networkstatus_get_live_consensus(time_t now
);
3508 networkstatus_t
*networkstatus_get_reasonably_live_consensus(time_t now
);
3509 #define NSSET_FROM_CACHE 1
3510 #define NSSET_WAS_WAITING_FOR_CERTS 2
3511 #define NSSET_DONT_DOWNLOAD_CERTS 4
3512 int networkstatus_set_current_consensus(const char *consensus
, unsigned flags
);
3513 void networkstatus_note_certs_arrived(void);
3514 void routers_update_all_from_networkstatus(time_t now
, int dir_version
);
3515 void routerstatus_list_update_from_consensus_networkstatus(time_t now
);
3516 void routers_update_status_from_consensus_networkstatus(smartlist_t
*routers
,
3517 int reset_failures
);
3518 void signed_descs_update_status_from_consensus_networkstatus(
3519 smartlist_t
*descs
);
3521 char *networkstatus_getinfo_helper_single(routerstatus_t
*rs
);
3522 char *networkstatus_getinfo_by_purpose(const char *purpose_string
, time_t now
);
3523 void networkstatus_dump_bridge_status_to_file(time_t now
);
3524 int getinfo_helper_networkstatus(control_connection_t
*conn
,
3525 const char *question
, char **answer
);
3526 void networkstatus_free_all(void);
3528 /********************************* ntmain.c ***************************/
3534 int nt_service_parse_options(int argc
, char **argv
, int *should_exit
);
3535 int nt_service_is_stopping(void);
3536 void nt_service_set_state(DWORD state
);
3538 #define nt_service_is_stopping() (0)
3541 /********************************* onion.c ***************************/
3543 int onion_pending_add(or_circuit_t
*circ
, char *onionskin
);
3544 or_circuit_t
*onion_next_task(char **onionskin_out
);
3545 void onion_pending_remove(or_circuit_t
*circ
);
3547 int onion_skin_create(crypto_pk_env_t
*router_key
,
3548 crypto_dh_env_t
**handshake_state_out
,
3549 char *onion_skin_out
);
3551 int onion_skin_server_handshake(const char *onion_skin
,
3552 crypto_pk_env_t
*private_key
,
3553 crypto_pk_env_t
*prev_private_key
,
3554 char *handshake_reply_out
,
3556 size_t key_out_len
);
3558 int onion_skin_client_handshake(crypto_dh_env_t
*handshake_state
,
3559 const char *handshake_reply
,
3561 size_t key_out_len
);
3563 int fast_server_handshake(const char *key_in
,
3564 char *handshake_reply_out
,
3566 size_t key_out_len
);
3568 int fast_client_handshake(const char *handshake_state
,
3569 const char *handshake_reply_out
,
3571 size_t key_out_len
);
3573 void clear_pending_onions(void);
3575 /********************************* policies.c ************************/
3577 /* (length of "accept 255.255.255.255/255.255.255.255:65535-65535\n" plus a
3580 #define POLICY_BUF_LEN 52
3583 ADDR_POLICY_ACCEPTED
=0,
3584 ADDR_POLICY_REJECTED
=-1,
3585 ADDR_POLICY_PROBABLY_ACCEPTED
=1,
3586 ADDR_POLICY_PROBABLY_REJECTED
=2
3587 } addr_policy_result_t
;
3589 int firewall_is_fascist_or(void);
3590 int fascist_firewall_allows_address_or(uint32_t addr
, uint16_t port
);
3591 int fascist_firewall_allows_address_dir(uint32_t addr
, uint16_t port
);
3592 int dir_policy_permits_address(uint32_t addr
);
3593 int socks_policy_permits_address(uint32_t addr
);
3594 int authdir_policy_permits_address(uint32_t addr
, uint16_t port
);
3595 int authdir_policy_valid_address(uint32_t addr
, uint16_t port
);
3596 int authdir_policy_baddir_address(uint32_t addr
, uint16_t port
);
3597 int authdir_policy_badexit_address(uint32_t addr
, uint16_t port
);
3599 int validate_addr_policies(or_options_t
*options
, char **msg
);
3600 void policy_expand_private(smartlist_t
**policy
);
3601 int policies_parse_from_options(or_options_t
*options
);
3603 addr_policy_t
*addr_policy_get_canonical_entry(addr_policy_t
*ent
);
3604 int cmp_addr_policies(smartlist_t
*a
, smartlist_t
*b
);
3605 addr_policy_result_t
compare_addr_to_addr_policy(uint32_t addr
,
3606 uint16_t port
, smartlist_t
*policy
);
3607 int policies_parse_exit_policy(config_line_t
*cfg
, smartlist_t
**dest
,
3608 int rejectprivate
, const char *local_address
);
3609 void policies_set_router_exitpolicy_to_reject_all(routerinfo_t
*exitrouter
);
3610 int exit_policy_is_general_exit(smartlist_t
*policy
);
3611 int policy_is_reject_star(smartlist_t
*policy
);
3612 int getinfo_helper_policies(control_connection_t
*conn
,
3613 const char *question
, char **answer
);
3614 int policy_write_item(char *buf
, size_t buflen
, addr_policy_t
*item
);
3616 void addr_policy_list_free(smartlist_t
*p
);
3617 void addr_policy_free(addr_policy_t
*p
);
3618 void policies_free_all(void);
3620 /********************************* reasons.c ***************************/
3622 const char *stream_end_reason_to_control_string(int reason
);
3623 const char *stream_end_reason_to_string(int reason
);
3624 socks5_reply_status_t
stream_end_reason_to_socks5_response(int reason
);
3625 uint8_t errno_to_stream_end_reason(int e
);
3627 const char *orconn_end_reason_to_control_string(int r
);
3628 int tls_error_to_orconn_end_reason(int e
);
3629 int errno_to_orconn_end_reason(int e
);
3631 const char *circuit_end_reason_to_control_string(int reason
);
3633 /********************************* relay.c ***************************/
3635 extern uint64_t stats_n_relay_cells_relayed
;
3636 extern uint64_t stats_n_relay_cells_delivered
;
3638 int circuit_receive_relay_cell(cell_t
*cell
, circuit_t
*circ
,
3639 int cell_direction
);
3641 void relay_header_pack(char *dest
, const relay_header_t
*src
);
3642 void relay_header_unpack(relay_header_t
*dest
, const char *src
);
3643 int relay_send_command_from_edge(uint16_t stream_id
, circuit_t
*circ
,
3644 uint8_t relay_command
, const char *payload
,
3645 size_t payload_len
, crypt_path_t
*cpath_layer
);
3646 int connection_edge_send_command(edge_connection_t
*fromconn
,
3647 uint8_t relay_command
, const char *payload
,
3648 size_t payload_len
);
3649 int connection_edge_package_raw_inbuf(edge_connection_t
*conn
,
3650 int package_partial
);
3651 void connection_edge_consider_sending_sendme(edge_connection_t
*conn
);
3653 extern uint64_t stats_n_data_cells_packaged
;
3654 extern uint64_t stats_n_data_bytes_packaged
;
3655 extern uint64_t stats_n_data_cells_received
;
3656 extern uint64_t stats_n_data_bytes_received
;
3658 void init_cell_pool(void);
3659 void free_cell_pool(void);
3660 void clean_cell_pool(void);
3661 void dump_cell_pool_usage(int severity
);
3663 void cell_queue_clear(cell_queue_t
*queue
);
3664 void cell_queue_append(cell_queue_t
*queue
, packed_cell_t
*cell
);
3665 void cell_queue_append_packed_copy(cell_queue_t
*queue
, const cell_t
*cell
);
3667 void append_cell_to_circuit_queue(circuit_t
*circ
, or_connection_t
*orconn
,
3668 cell_t
*cell
, int direction
);
3669 void connection_or_unlink_all_active_circs(or_connection_t
*conn
);
3670 int connection_or_flush_from_first_active_circuit(or_connection_t
*conn
,
3671 int max
, time_t now
);
3672 void assert_active_circuits_ok(or_connection_t
*orconn
);
3673 void make_circuit_inactive_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3674 void make_circuit_active_on_conn(circuit_t
*circ
, or_connection_t
*conn
);
3676 /********************************* rephist.c ***************************/
3678 void rep_hist_init(void);
3679 void rep_hist_note_connect_failed(const char* nickname
, time_t when
);
3680 void rep_hist_note_connect_succeeded(const char* nickname
, time_t when
);
3681 void rep_hist_note_disconnect(const char* nickname
, time_t when
);
3682 void rep_hist_note_connection_died(const char* nickname
, time_t when
);
3683 void rep_hist_note_extend_succeeded(const char *from_name
,
3684 const char *to_name
);
3685 void rep_hist_note_extend_failed(const char *from_name
, const char *to_name
);
3686 void rep_hist_dump_stats(time_t now
, int severity
);
3687 void rep_hist_note_bytes_read(size_t num_bytes
, time_t when
);
3688 void rep_hist_note_bytes_written(size_t num_bytes
, time_t when
);
3689 int rep_hist_bandwidth_assess(void);
3690 char *rep_hist_get_bandwidth_lines(int for_extrainfo
);
3691 void rep_hist_update_state(or_state_t
*state
);
3692 int rep_hist_load_state(or_state_t
*state
, char **err
);
3693 void rep_history_clean(time_t before
);
3695 void rep_hist_note_router_reachable(const char *id
, time_t when
);
3696 void rep_hist_note_router_unreachable(const char *id
, time_t when
);
3697 int rep_hist_record_mtbf_data(void);
3698 int rep_hist_load_mtbf_data(time_t now
);
3700 time_t rep_hist_downrate_old_runs(time_t now
);
3701 double rep_hist_get_stability(const char *id
, time_t when
);
3702 double rep_hist_get_weighted_fractional_uptime(const char *id
, time_t when
);
3703 long rep_hist_get_weighted_time_known(const char *id
, time_t when
);
3704 int rep_hist_have_measured_enough_stability(void);
3706 void rep_hist_note_used_port(time_t now
, uint16_t port
);
3707 smartlist_t
*rep_hist_get_predicted_ports(time_t now
);
3708 void rep_hist_note_used_resolve(time_t now
);
3709 void rep_hist_note_used_internal(time_t now
, int need_uptime
,
3711 int rep_hist_get_predicted_internal(time_t now
, int *need_uptime
,
3712 int *need_capacity
);
3714 int any_predicted_circuits(time_t now
);
3715 int rep_hist_circbuilding_dormant(time_t now
);
3717 /** Possible public/private key operations in Tor: used to keep track of where
3718 * we're spending our time. */
3721 VERIFY_DIR
, VERIFY_RTR
,
3722 ENC_ONIONSKIN
, DEC_ONIONSKIN
,
3723 TLS_HANDSHAKE_C
, TLS_HANDSHAKE_S
,
3724 REND_CLIENT
, REND_MID
, REND_SERVER
,
3726 void note_crypto_pk_op(pk_op_t operation
);
3727 void dump_pk_ops(int severity
);
3729 void rep_hist_free_all(void);
3731 /* for hidden service usage statistics */
3732 void hs_usage_note_publish_total(const char *service_id
, time_t now
);
3733 void hs_usage_note_publish_novel(const char *service_id
, time_t now
);
3734 void hs_usage_note_fetch_total(const char *service_id
, time_t now
);
3735 void hs_usage_note_fetch_successful(const char *service_id
, time_t now
);
3736 void hs_usage_write_statistics_to_file(time_t now
);
3737 void hs_usage_free_all(void);
3739 /********************************* rendclient.c ***************************/
3741 void rend_client_introcirc_has_opened(origin_circuit_t
*circ
);
3742 void rend_client_rendcirc_has_opened(origin_circuit_t
*circ
);
3743 int rend_client_introduction_acked(origin_circuit_t
*circ
, const char *request
,
3744 size_t request_len
);
3745 void rend_client_refetch_renddesc(const char *query
);
3746 void rend_client_refetch_v2_renddesc(const char *query
);
3747 int rend_client_remove_intro_point(extend_info_t
*failed_intro
,
3749 int rend_client_rendezvous_acked(origin_circuit_t
*circ
, const char *request
,
3750 size_t request_len
);
3751 int rend_client_receive_rendezvous(origin_circuit_t
*circ
, const char *request
,
3752 size_t request_len
);
3753 void rend_client_desc_here(const char *query
);
3755 extend_info_t
*rend_client_get_random_intro(const char *query
);
3757 int rend_client_send_introduction(origin_circuit_t
*introcirc
,
3758 origin_circuit_t
*rendcirc
);
3760 /********************************* rendcommon.c ***************************/
3762 /** ASCII-encoded v2 hidden service descriptor. */
3763 typedef struct rend_encoded_v2_service_descriptor_t
{
3764 char desc_id
[DIGEST_LEN
]; /**< Descriptor ID. */
3765 char *desc_str
; /**< Descriptor string. */
3766 } rend_encoded_v2_service_descriptor_t
;
3768 /** Introduction point information. */
3769 typedef struct rend_intro_point_t
{
3770 extend_info_t
*extend_info
; /**< Extend info of this introduction point. */
3771 crypto_pk_env_t
*intro_key
; /**< Introduction key that replaces the service
3772 * key, if this descriptor is V2. */
3773 } rend_intro_point_t
;
3775 /** Information used to connect to a hidden service. */
3776 typedef struct rend_service_descriptor_t
{
3777 crypto_pk_env_t
*pk
; /**< This service's public key. */
3778 int version
; /**< Version of the descriptor format: 0 or 2. */
3779 time_t timestamp
; /**< Time when the descriptor was generated. */
3780 uint16_t protocols
; /**< Bitmask: which rendezvous protocols are supported?
3781 * (We allow bits '0', '1', and '2' to be set.) */
3782 /** List of the service's introduction points. Elements are removed if
3783 * introduction attempts fail. */
3784 smartlist_t
*intro_nodes
;
3785 } rend_service_descriptor_t
;
3787 int rend_cmp_service_ids(const char *one
, const char *two
);
3789 void rend_process_relay_cell(circuit_t
*circ
, int command
, size_t length
,
3790 const char *payload
);
3792 void rend_service_descriptor_free(rend_service_descriptor_t
*desc
);
3793 int rend_encode_service_descriptor(rend_service_descriptor_t
*desc
,
3794 crypto_pk_env_t
*key
,
3797 rend_service_descriptor_t
*rend_parse_service_descriptor(const char *str
,
3799 int rend_get_service_id(crypto_pk_env_t
*pk
, char *out
);
3800 void rend_encoded_v2_service_descriptor_free(
3801 rend_encoded_v2_service_descriptor_t
*desc
);
3802 void rend_intro_point_free(rend_intro_point_t
*intro
);
3804 /** A cached rendezvous descriptor. */
3805 typedef struct rend_cache_entry_t
{
3806 size_t len
; /**< Length of <b>desc</b> */
3807 time_t received
; /**< When was the descriptor received? */
3808 char *desc
; /**< Service descriptor */
3809 rend_service_descriptor_t
*parsed
; /**< Parsed value of 'desc' */
3810 } rend_cache_entry_t
;
3812 void rend_cache_init(void);
3813 void rend_cache_clean(void);
3814 void rend_cache_clean_v2_descs_as_dir(void);
3815 void rend_cache_free_all(void);
3816 int rend_valid_service_id(const char *query
);
3817 int rend_cache_lookup_desc(const char *query
, int version
, const char **desc
,
3819 int rend_cache_lookup_entry(const char *query
, int version
,
3820 rend_cache_entry_t
**entry_out
);
3821 int rend_cache_lookup_v2_desc_as_dir(const char *query
, const char **desc
);
3822 int rend_cache_store(const char *desc
, size_t desc_len
, int published
);
3823 int rend_cache_store_v2_desc_as_client(const char *desc
,
3824 const char *descriptor_cookie
);
3825 int rend_cache_store_v2_desc_as_dir(const char *desc
);
3826 int rend_cache_size(void);
3827 int rend_encode_v2_descriptors(smartlist_t
*descs_out
,
3828 rend_service_descriptor_t
*desc
, time_t now
,
3829 const char *descriptor_cookie
, uint8_t period
);
3830 int rend_compute_v2_desc_id(char *desc_id_out
, const char *service_id
,
3831 const char *descriptor_cookie
,
3832 time_t now
, uint8_t replica
);
3833 int rend_id_is_in_interval(const char *a
, const char *b
, const char *c
);
3834 void rend_get_descriptor_id_bytes(char *descriptor_id_out
,
3835 const char *service_id
,
3836 const char *secret_id_part
);
3838 /********************************* rendservice.c ***************************/
3840 int num_rend_services(void);
3841 int rend_config_services(or_options_t
*options
, int validate_only
);
3842 int rend_service_load_keys(void);
3843 void rend_services_init(void);
3844 void rend_services_introduce(void);
3845 void rend_consider_services_upload(time_t now
);
3847 void rend_service_intro_has_opened(origin_circuit_t
*circuit
);
3848 int rend_service_intro_established(origin_circuit_t
*circuit
,
3849 const char *request
,
3850 size_t request_len
);
3851 void rend_service_rendezvous_has_opened(origin_circuit_t
*circuit
);
3852 int rend_service_introduce(origin_circuit_t
*circuit
, const char *request
,
3853 size_t request_len
);
3854 void rend_service_relaunch_rendezvous(origin_circuit_t
*oldcirc
);
3855 int rend_service_set_connection_addr_port(edge_connection_t
*conn
,
3856 origin_circuit_t
*circ
);
3857 void rend_service_dump_stats(int severity
);
3858 void rend_service_free_all(void);
3860 /********************************* rendmid.c *******************************/
3861 int rend_mid_establish_intro(or_circuit_t
*circ
, const char *request
,
3862 size_t request_len
);
3863 int rend_mid_introduce(or_circuit_t
*circ
, const char *request
,
3864 size_t request_len
);
3865 int rend_mid_establish_rendezvous(or_circuit_t
*circ
, const char *request
,
3866 size_t request_len
);
3867 int rend_mid_rendezvous(or_circuit_t
*circ
, const char *request
,
3868 size_t request_len
);
3870 /********************************* router.c ***************************/
3872 crypto_pk_env_t
*get_onion_key(void);
3873 time_t get_onion_key_set_at(void);
3874 void set_identity_key(crypto_pk_env_t
*k
);
3875 crypto_pk_env_t
*get_identity_key(void);
3876 int identity_key_is_set(void);
3877 authority_cert_t
*get_my_v3_authority_cert(void);
3878 crypto_pk_env_t
*get_my_v3_authority_signing_key(void);
3879 authority_cert_t
*get_my_v3_legacy_cert(void);
3880 crypto_pk_env_t
*get_my_v3_legacy_signing_key(void);
3881 void dup_onion_keys(crypto_pk_env_t
**key
, crypto_pk_env_t
**last
);
3882 void rotate_onion_key(void);
3883 crypto_pk_env_t
*init_key_from_file(const char *fname
, int generate
,
3885 void v3_authority_check_key_expiry(void);
3887 int init_keys(void);
3889 int check_whether_orport_reachable(void);
3890 int check_whether_dirport_reachable(void);
3891 void consider_testing_reachability(int test_or
, int test_dir
);
3892 void router_orport_found_reachable(void);
3893 void router_dirport_found_reachable(void);
3894 void router_perform_bandwidth_test(int num_circs
, time_t now
);
3896 int authdir_mode(or_options_t
*options
);
3897 int authdir_mode_v1(or_options_t
*options
);
3898 int authdir_mode_v2(or_options_t
*options
);
3899 int authdir_mode_v3(or_options_t
*options
);
3900 int authdir_mode_any_main(or_options_t
*options
);
3901 int authdir_mode_any_nonhidserv(or_options_t
*options
);
3902 int authdir_mode_handles_descs(or_options_t
*options
, int purpose
);
3903 int authdir_mode_publishes_statuses(or_options_t
*options
);
3904 int authdir_mode_tests_reachability(or_options_t
*options
);
3905 int authdir_mode_bridge(or_options_t
*options
);
3907 int clique_mode(or_options_t
*options
);
3908 int server_mode(or_options_t
*options
);
3909 int advertised_server_mode(void);
3910 int proxy_mode(or_options_t
*options
);
3911 void consider_publishable_server(int force
);
3913 int router_is_clique_mode(routerinfo_t
*router
);
3914 void router_upload_dir_desc_to_dirservers(int force
);
3915 void mark_my_descriptor_dirty_if_older_than(time_t when
);
3916 void mark_my_descriptor_dirty(void);
3917 void check_descriptor_bandwidth_changed(time_t now
);
3918 void check_descriptor_ipaddress_changed(time_t now
);
3919 void router_new_address_suggestion(const char *suggestion
,
3920 const dir_connection_t
*d_conn
);
3921 int router_compare_to_my_exit_policy(edge_connection_t
*conn
);
3922 routerinfo_t
*router_get_my_routerinfo(void);
3923 extrainfo_t
*router_get_my_extrainfo(void);
3924 const char *router_get_my_descriptor(void);
3925 int router_digest_is_me(const char *digest
);
3926 int router_extrainfo_digest_is_me(const char *digest
);
3927 int router_is_me(routerinfo_t
*router
);
3928 int router_fingerprint_is_me(const char *fp
);
3929 int router_pick_published_address(or_options_t
*options
, uint32_t *addr
);
3930 int router_rebuild_descriptor(int force
);
3931 int router_dump_router_to_string(char *s
, size_t maxlen
, routerinfo_t
*router
,
3932 crypto_pk_env_t
*ident_key
);
3933 int extrainfo_dump_to_string(char *s
, size_t maxlen
, extrainfo_t
*extrainfo
,
3934 crypto_pk_env_t
*ident_key
);
3935 int is_legal_nickname(const char *s
);
3936 int is_legal_nickname_or_hexdigest(const char *s
);
3937 int is_legal_hexdigest(const char *s
);
3938 void router_get_verbose_nickname(char *buf
, routerinfo_t
*router
);
3939 void router_reset_warnings(void);
3940 void router_reset_reachability(void);
3941 void router_free_all(void);
3943 const char *router_purpose_to_string(uint8_t p
);
3944 uint8_t router_purpose_from_string(const char *s
);
3946 #ifdef ROUTER_PRIVATE
3947 /* Used only by router.c and test.c */
3948 void get_platform_str(char *platform
, size_t len
);
3951 /********************************* routerlist.c ***************************/
3953 /** Represents information about a single trusted directory server. */
3954 typedef struct trusted_dir_server_t
{
3957 char *address
; /**< Hostname. */
3958 uint32_t addr
; /**< IPv4 address. */
3959 uint16_t dir_port
; /**< Directory port. */
3960 uint16_t or_port
; /**< OR port: Used for tunneling connections. */
3961 char digest
[DIGEST_LEN
]; /**< Digest of identity key. */
3962 char v3_identity_digest
[DIGEST_LEN
]; /**< Digest of v3 (authority only,
3963 * high-security) identity key. */
3965 unsigned int is_running
:1; /**< True iff we think this server is running. */
3967 /** True iff this server has accepted the most recent server descriptor
3968 * we tried to upload to it. */
3969 unsigned int has_accepted_serverdesc
:1;
3971 /** What kind of authority is this? (Bitfield.) */
3972 authority_type_t type
;
3974 download_status_t v2_ns_dl_status
; /**< Status of downloading this server's
3975 * v2 network status. */
3976 time_t addr_current_at
; /**< When was the document that we derived the
3977 * address information from published? */
3979 routerstatus_t fake_status
; /**< Used when we need to pass this trusted
3980 * dir_server_t to directory_initiate_command_*
3981 * as a routerstatus_t. Not updated by the
3982 * router-status management code!
3984 } trusted_dir_server_t
;
3986 #define ROUTER_REQUIRED_MIN_BANDWIDTH 10000
3988 #define ROUTER_MAX_DECLARED_BANDWIDTH INT32_MAX
3990 int get_n_authorities(authority_type_t type
);
3991 int trusted_dirs_reload_certs(void);
3992 int trusted_dirs_load_certs_from_string(const char *contents
, int from_store
,
3994 void trusted_dirs_flush_certs_to_disk(void);
3995 authority_cert_t
*authority_cert_get_newest_by_id(const char *id_digest
);
3996 authority_cert_t
*authority_cert_get_by_sk_digest(const char *sk_digest
);
3997 authority_cert_t
*authority_cert_get_by_digests(const char *id_digest
,
3998 const char *sk_digest
);
3999 void authority_cert_get_all(smartlist_t
*certs_out
);
4000 void authority_cert_dl_failed(const char *id_digest
, int status
);
4001 void authority_certs_fetch_missing(networkstatus_t
*status
, time_t now
);
4002 int router_reload_router_list(void);
4003 smartlist_t
*router_get_trusted_dir_servers(void);
4005 /* Flags for pick_directory_server and pick_trusteddirserver. */
4006 #define PDS_ALLOW_SELF (1<<0)
4007 #define PDS_RETRY_IF_NO_SERVERS (1<<1)
4008 #define PDS_IGNORE_FASCISTFIREWALL (1<<2)
4009 #define _PDS_PREFER_TUNNELED_DIR_CONNS (1<<16)
4010 routerstatus_t
*router_pick_directory_server(authority_type_t type
, int flags
);
4011 trusted_dir_server_t
*router_get_trusteddirserver_by_digest(const char *d
);
4012 trusted_dir_server_t
*trusteddirserver_get_by_v3_auth_digest(const char *d
);
4013 routerstatus_t
*router_pick_trusteddirserver(authority_type_t type
, int flags
);
4014 int router_get_my_share_of_directory_requests(double *v2_share_out
,
4015 double *v3_share_out
);
4016 void router_reset_status_download_failures(void);
4017 void routerlist_add_family(smartlist_t
*sl
, routerinfo_t
*router
);
4018 int routers_in_same_family(routerinfo_t
*r1
, routerinfo_t
*r2
);
4019 void add_nickname_list_to_smartlist(smartlist_t
*sl
, const char *list
,
4020 int must_be_running
);
4021 int router_nickname_is_in_list(routerinfo_t
*router
, const char *list
);
4022 routerinfo_t
*routerlist_find_my_routerinfo(void);
4023 routerinfo_t
*router_find_exact_exit_enclave(const char *address
,
4025 int router_is_unreliable(routerinfo_t
*router
, int need_uptime
,
4026 int need_capacity
, int need_guard
);
4027 uint32_t router_get_advertised_bandwidth(routerinfo_t
*router
);
4030 NO_WEIGHTING
, WEIGHT_FOR_EXIT
, WEIGHT_FOR_GUARD
4031 } bandwidth_weight_rule_t
;
4032 routerinfo_t
*routerlist_sl_choose_by_bandwidth(smartlist_t
*sl
,
4033 bandwidth_weight_rule_t rule
);
4034 routerstatus_t
*routerstatus_sl_choose_by_bandwidth(smartlist_t
*sl
);
4035 /* XXXX021. This is a truly hideous interface. */
4036 routerinfo_t
*router_choose_random_node(const char *preferred
,
4037 const char *excluded
,
4038 smartlist_t
*excludedsmartlist
,
4039 struct routerset_t
*excludedset
,
4040 int need_uptime
, int need_capacity
,
4042 int allow_invalid
, int strict
,
4043 int weight_for_exit
);
4044 routerinfo_t
*router_get_by_nickname(const char *nickname
,
4045 int warn_if_unnamed
);
4046 int router_digest_version_as_new_as(const char *digest
, const char *cutoff
);
4047 int router_digest_is_trusted_dir_type(const char *digest
,
4048 authority_type_t type
);
4049 #define router_digest_is_trusted_dir(d) \
4050 router_digest_is_trusted_dir_type((d), NO_AUTHORITY)
4052 int router_addr_is_trusted_dir(uint32_t addr
);
4053 int hexdigest_to_digest(const char *hexdigest
, char *digest
);
4054 routerinfo_t
*router_get_by_hexdigest(const char *hexdigest
);
4055 routerinfo_t
*router_get_by_digest(const char *digest
);
4056 signed_descriptor_t
*router_get_by_descriptor_digest(const char *digest
);
4057 signed_descriptor_t
*router_get_by_extrainfo_digest(const char *digest
);
4058 signed_descriptor_t
*extrainfo_get_by_descriptor_digest(const char *digest
);
4059 const char *signed_descriptor_get_body(signed_descriptor_t
*desc
);
4060 const char *signed_descriptor_get_annotations(signed_descriptor_t
*desc
);
4061 routerlist_t
*router_get_routerlist(void);
4062 void routerinfo_free(routerinfo_t
*router
);
4063 void extrainfo_free(extrainfo_t
*extrainfo
);
4064 void routerlist_free(routerlist_t
*rl
);
4065 void dump_routerlist_mem_usage(int severity
);
4066 void routerlist_remove(routerlist_t
*rl
, routerinfo_t
*ri
, int make_old
);
4067 void routerlist_free_all(void);
4068 void routerlist_reset_warnings(void);
4069 void router_set_status(const char *digest
, int up
);
4070 int router_add_to_routerlist(routerinfo_t
*router
, const char **msg
,
4071 int from_cache
, int from_fetch
);
4072 int router_add_extrainfo_to_routerlist(extrainfo_t
*ei
, const char **msg
,
4073 int from_cache
, int from_fetch
);
4074 void routerlist_remove_old_routers(void);
4075 int router_load_single_router(const char *s
, uint8_t purpose
, int cache
,
4077 void router_load_routers_from_string(const char *s
, const char *eos
,
4078 saved_location_t saved_location
,
4079 smartlist_t
*requested_fingerprints
,
4080 int descriptor_digests
,
4081 const char *prepend_annotations
);
4082 void router_load_extrainfo_from_string(const char *s
, const char *eos
,
4083 saved_location_t saved_location
,
4084 smartlist_t
*requested_fingerprints
,
4085 int descriptor_digests
);
4086 void routerlist_retry_directory_downloads(time_t now
);
4087 int router_exit_policy_all_routers_reject(uint32_t addr
, uint16_t port
,
4089 int router_exit_policy_rejects_all(routerinfo_t
*router
);
4090 trusted_dir_server_t
*add_trusted_dir_server(const char *nickname
,
4091 const char *address
,
4092 uint16_t dir_port
, uint16_t or_port
,
4093 const char *digest
, const char *v3_auth_digest
,
4094 authority_type_t type
);
4095 void authority_cert_free(authority_cert_t
*cert
);
4096 void clear_trusted_dir_servers(void);
4097 int any_trusted_dir_is_v1_authority(void);
4098 void update_router_descriptor_downloads(time_t now
);
4099 void update_extrainfo_downloads(time_t now
);
4100 int router_have_minimum_dir_info(void);
4101 void router_dir_info_changed(void);
4102 const char *get_dir_info_status_string(void);
4103 int count_loading_descriptors_progress(void);
4104 void router_reset_descriptor_download_failures(void);
4105 int router_differences_are_cosmetic(routerinfo_t
*r1
, routerinfo_t
*r2
);
4106 int routerinfo_incompatible_with_extrainfo(routerinfo_t
*ri
, extrainfo_t
*ei
,
4107 signed_descriptor_t
*sd
,
4109 void routerlist_assert_ok(routerlist_t
*rl
);
4110 const char *esc_router_info(routerinfo_t
*router
);
4111 void routers_sort_by_identity(smartlist_t
*routers
);
4113 typedef struct routerset_t routerset_t
;
4115 routerset_t
*routerset_new(void);
4116 int routerset_parse(routerset_t
*target
, const char *s
,
4117 const char *description
);
4118 void routerset_union(routerset_t
*target
, const routerset_t
*source
);
4119 int routerset_contains_router(const routerset_t
*set
, routerinfo_t
*ri
);
4120 int routerset_contains_routerstatus(const routerset_t
*set
,
4121 routerstatus_t
*rs
);
4122 void routerset_get_all_routers(smartlist_t
*out
, const routerset_t
*routerset
,
4124 void routerset_subtract_routers(smartlist_t
*out
,
4125 const routerset_t
*routerset
);
4126 char *routerset_to_string(const routerset_t
*routerset
);
4127 void routerset_free(routerset_t
*routerset
);
4129 int hid_serv_get_responsible_directories(smartlist_t
*responsible_dirs
,
4131 int hid_serv_acting_as_directory(void);
4132 int hid_serv_responsible_for_desc_id(const char *id
);
4134 /********************************* routerparse.c ************************/
4136 #define MAX_STATUS_TAG_LEN 32
4137 /** Structure to hold parsed Tor versions. This is a little messier
4138 * than we would like it to be, because we changed version schemes with 0.1.0.
4140 * See version-spec.txt for the whole business.
4142 typedef struct tor_version_t
{
4146 /** Release status. For version in the post-0.1 format, this is always
4148 enum { VER_PRE
=0, VER_RC
=1, VER_RELEASE
=2, } status
;
4150 char status_tag
[MAX_STATUS_TAG_LEN
];
4154 int router_get_router_hash(const char *s
, char *digest
);
4155 int router_get_dir_hash(const char *s
, char *digest
);
4156 int router_get_runningrouters_hash(const char *s
, char *digest
);
4157 int router_get_networkstatus_v2_hash(const char *s
, char *digest
);
4158 int router_get_networkstatus_v3_hash(const char *s
, char *digest
);
4159 int router_get_extrainfo_hash(const char *s
, char *digest
);
4160 int router_append_dirobj_signature(char *buf
, size_t buf_len
,
4162 crypto_pk_env_t
*private_key
);
4163 int router_parse_list_from_string(const char **s
, const char *eos
,
4165 saved_location_t saved_location
,
4167 int allow_annotations
,
4168 const char *prepend_annotations
);
4169 int router_parse_routerlist_from_directory(const char *s
,
4170 routerlist_t
**dest
,
4171 crypto_pk_env_t
*pkey
,
4173 int write_to_cache
);
4174 int router_parse_runningrouters(const char *str
);
4175 int router_parse_directory(const char *str
);
4176 routerinfo_t
*router_parse_entry_from_string(const char *s
, const char *end
,
4178 int allow_annotations
,
4179 const char *prepend_annotations
);
4180 extrainfo_t
*extrainfo_parse_entry_from_string(const char *s
, const char *end
,
4181 int cache_copy
, struct digest_ri_map_t
*routermap
);
4182 addr_policy_t
*router_parse_addr_policy_item_from_string(const char *s
,
4184 version_status_t
tor_version_is_obsolete(const char *myversion
,
4185 const char *versionlist
);
4186 int tor_version_parse(const char *s
, tor_version_t
*out
);
4187 int tor_version_as_new_as(const char *platform
, const char *cutoff
);
4188 int tor_version_compare(tor_version_t
*a
, tor_version_t
*b
);
4189 void sort_version_list(smartlist_t
*lst
, int remove_duplicates
);
4190 void assert_addr_policy_ok(smartlist_t
*t
);
4191 void dump_distinct_digest_count(int severity
);
4193 networkstatus_v2_t
*networkstatus_v2_parse_from_string(const char *s
);
4194 networkstatus_t
*networkstatus_parse_vote_from_string(const char *s
,
4195 const char **eos_out
,
4197 ns_detached_signatures_t
*networkstatus_parse_detached_signatures(
4198 const char *s
, const char *eos
);
4200 authority_cert_t
*authority_cert_parse_from_string(const char *s
,
4201 const char **end_of_string
);
4202 int rend_parse_v2_service_descriptor(rend_service_descriptor_t
**parsed_out
,
4204 char **intro_points_encrypted_out
,
4205 size_t *intro_points_encrypted_size_out
,
4206 size_t *encoded_size_out
,
4207 const char **next_out
, const char *desc
);
4208 int rend_decrypt_introduction_points(rend_service_descriptor_t
*parsed
,
4209 const char *descriptor_cookie
,
4210 const char *intro_content
,