Tor  0.4.5.0-alpha-dev
dirvote.h
Go to the documentation of this file.
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-2020, The Tor Project, Inc. */
5 /* See LICENSE for licensing information */
6 
7 /**
8  * \file dirvote.h
9  * \brief Header file for dirvote.c.
10  **/
11 
12 #ifndef TOR_DIRVOTE_H
13 #define TOR_DIRVOTE_H
14 
15 /*
16  * Ideally, assuming synced clocks, we should only need 1 second for each of:
17  * - Vote
18  * - Distribute
19  * - Consensus Publication
20  * As we can gather descriptors continuously.
21  * (Could we even go as far as publishing the previous consensus,
22  * in the same second that we vote for the next one?)
23  * But we're not there yet: these are the lowest working values at this time.
24  */
25 
26 /** Lowest allowable value for VoteSeconds. */
27 #define MIN_VOTE_SECONDS 2
28 /** Lowest allowable value for VoteSeconds when TestingTorNetwork is 1 */
29 #define MIN_VOTE_SECONDS_TESTING 2
30 
31 /** Lowest allowable value for DistSeconds. */
32 #define MIN_DIST_SECONDS 2
33 /** Lowest allowable value for DistSeconds when TestingTorNetwork is 1 */
34 #define MIN_DIST_SECONDS_TESTING 2
35 
36 /** Lowest allowable voting interval. */
37 #define MIN_VOTE_INTERVAL 300
38 /** Lowest allowable voting interval when TestingTorNetwork is 1:
39  * Voting Interval can be:
40  * 10, 12, 15, 18, 20, 24, 25, 30, 36, 40, 45, 50, 60, ...
41  * Testing Initial Voting Interval can be:
42  * 5, 6, 8, 9, or any of the possible values for Voting Interval,
43  * as they both need to evenly divide 30 minutes.
44  * If clock desynchronisation is an issue, use an interval of at least:
45  * 18 * drift in seconds, to allow for a clock slop factor */
46 #define MIN_VOTE_INTERVAL_TESTING \
47  (((MIN_VOTE_SECONDS_TESTING)+(MIN_DIST_SECONDS_TESTING)+1)*2)
48 
49 #define MIN_VOTE_INTERVAL_TESTING_INITIAL \
50  ((MIN_VOTE_SECONDS_TESTING)+(MIN_DIST_SECONDS_TESTING)+1)
51 
52 /** The lowest consensus method that we currently support. */
53 #define MIN_SUPPORTED_CONSENSUS_METHOD 28
54 
55 /** The highest consensus method that we currently support. */
56 #define MAX_SUPPORTED_CONSENSUS_METHOD 30
57 
58 /**
59  * Lowest consensus method where microdescriptor lines are put in canonical
60  * form for improved compressibility and ease of storage. See proposal 298.
61  **/
62 #define MIN_METHOD_FOR_CANONICAL_FAMILIES_IN_MICRODESCS 29
63 
64 /** Lowest consensus method where an unpadded base64 onion-key-ntor is allowed
65  * See #7869 */
66 #define MIN_METHOD_FOR_UNPADDED_NTOR_KEY 30
67 
68 /** Default bandwidth to clip unmeasured bandwidths to using method >=
69  * MIN_METHOD_TO_CLIP_UNMEASURED_BW. (This is not a consensus method; do not
70  * get confused with the above macros.) */
71 #define DEFAULT_MAX_UNMEASURED_BW_KB 20
72 
73 /* Directory Get Vote (DGV) flags for dirvote_get_vote(). */
74 #define DGV_BY_ID 1
75 #define DGV_INCLUDE_PENDING 2
76 #define DGV_INCLUDE_PREVIOUS 4
77 
78 /** Maximum size of a line in a vote. */
79 #define MAX_BW_FILE_HEADERS_LINE_LEN 1024
80 
81 extern const char DIRVOTE_UNIVERSAL_FLAGS[];
82 extern const char DIRVOTE_OPTIONAL_FLAGS[];
83 
84 /*
85  * Public API. Used outside of the dirauth subsystem.
86  *
87  * We need to nullify them if the module is disabled.
88  */
89 #ifdef HAVE_MODULE_DIRAUTH
90 
91 time_t dirvote_act(const or_options_t *options, time_t now);
92 void dirvote_free_all(void);
93 
94 void dirvote_parse_sr_commits(networkstatus_t *ns, const smartlist_t *tokens);
95 void dirvote_clear_commits(networkstatus_t *ns);
96 void dirvote_dirreq_get_status_vote(const char *url, smartlist_t *items,
97  smartlist_t *dir_items);
98 
99 /* Storing signatures and votes functions */
100 struct pending_vote_t * dirvote_add_vote(const char *vote_body,
101  time_t time_posted,
102  const char **msg_out,
103  int *status_out);
104 int dirvote_add_signatures(const char *detached_signatures_body,
105  const char *source,
106  const char **msg_out);
107 
108 struct config_line_t;
109 char *format_recommended_version_list(const struct config_line_t *line,
110  int warn);
111 
112 #else /* !defined(HAVE_MODULE_DIRAUTH) */
113 
114 static inline time_t
115 dirvote_act(const or_options_t *options, time_t now)
116 {
117  (void) options;
118  (void) now;
119  return TIME_MAX;
120 }
121 
122 static inline void
123 dirvote_free_all(void)
124 {
125 }
126 
127 static inline void
128 dirvote_parse_sr_commits(networkstatus_t *ns, const smartlist_t *tokens)
129 {
130  (void) ns;
131  (void) tokens;
132 }
133 
134 static inline void
135 dirvote_clear_commits(networkstatus_t *ns)
136 {
137  (void) ns;
138 }
139 
140 static inline void
141 dirvote_dirreq_get_status_vote(const char *url, smartlist_t *items,
142  smartlist_t *dir_items)
143 {
144  (void) url;
145  (void) items;
146  (void) dir_items;
147 }
148 
149 static inline struct pending_vote_t *
150 dirvote_add_vote(const char *vote_body,
151  time_t time_posted,
152  const char **msg_out,
153  int *status_out)
154 {
155  (void) vote_body;
156  (void) time_posted;
157  /* If the dirauth module is disabled, this should NEVER be called else we
158  * failed to safeguard the dirauth module. */
160 
161  /* We need to send out an error code. */
162  *status_out = 400;
163  *msg_out = "No directory authority support";
164  return NULL;
165 }
166 
167 static inline int
168 dirvote_add_signatures(const char *detached_signatures_body,
169  const char *source,
170  const char **msg_out)
171 {
172  (void) detached_signatures_body;
173  (void) source;
174  *msg_out = "No directory authority support";
175  /* If the dirauth module is disabled, this should NEVER be called else we
176  * failed to safeguard the dirauth module. */
178  return 0;
179 }
180 
181 #endif /* defined(HAVE_MODULE_DIRAUTH) */
182 
183 /* Item access */
185  (consensus_flavor_t flav));
187 const cached_dir_t *dirvote_get_vote(const char *fp, int flags);
188 
189 /*
190  * API used _only_ by the dirauth subsystem.
191  */
192 
195  authority_cert_t *cert);
196 
198  const routerinfo_t *ri,
199  time_t now,
200  smartlist_t *microdescriptors_out);
201 
202 /*
203  * Exposed functions for unit tests.
204  */
205 #ifdef DIRVOTE_PRIVATE
206 
207 /* Cert manipulation */
210  const smartlist_t *param_list,
211  const char *keyword,
212  int32_t default_val);
213 STATIC char *format_networkstatus_vote(crypto_pk_t *private_key,
214  networkstatus_t *v3_ns);
216  int total_authorities);
218 STATIC char *make_consensus_method_list(int low, int high, const char *sep);
219 STATIC int
221  int64_t M, int64_t E, int64_t D,
222  int64_t T, int64_t weight_scale);
223 STATIC
225  int total_authorities,
226  crypto_pk_t *identity_key,
227  crypto_pk_t *signing_key,
228  const char *legacy_identity_key_digest,
230  consensus_flavor_t flavor);
231 STATIC
234  const char *source,
235  int severity,
236  const char **msg_out);
237 STATIC
240  int consensus_method);
241 
242 /** The recommended relay protocols for this authority's votes.
243  * Recommending a new protocol causes old tor versions to log a warning.
244  */
245 #define DIRVOTE_RECOMMEND_RELAY_PROTO \
246  "Cons=1-2 Desc=1-2 DirCache=2 HSDir=2 HSIntro=4 HSRend=2 " \
247  "Link=5 LinkAuth=3 Microdesc=1-2 Relay=2"
248 /** The recommended client protocols for this authority's votes.
249  * Recommending a new protocol causes old tor versions to log a warning.
250  */
251 #define DIRVOTE_RECOMMEND_CLIENT_PROTO \
252  "Cons=1-2 Desc=1-2 DirCache=2 HSDir=2 HSIntro=4 HSRend=2 " \
253  "Link=5 LinkAuth=3 Microdesc=1-2 Relay=2"
254 
255 /** The required relay protocols for this authority's votes.
256  * WARNING: Requiring a new protocol causes old tor versions to shut down.
257  * Requiring the wrong protocols can break the tor network.
258  * See Proposal 303: When and how to remove support for protocol versions.
259  */
260 #define DIRVOTE_REQUIRE_RELAY_PROTO \
261  "Cons=1 Desc=1 DirCache=1 HSDir=1 HSIntro=3 HSRend=1 " \
262  "Link=3-4 Microdesc=1 Relay=1-2"
263 /** The required relay protocols for this authority's votes.
264  * WARNING: Requiring a new protocol causes old tor versions to shut down.
265  * Requiring the wrong protocols can break the tor network.
266  * See Proposal 303: When and how to remove support for protocol versions.
267  */
268 #define DIRVOTE_REQUIRE_CLIENT_PROTO \
269  "Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 HSIntro=3 HSRend=1 " \
270  "Link=4 Microdesc=1-2 Relay=2"
271 
272 #endif /* defined(DIRVOTE_PRIVATE) */
273 
274 #endif /* !defined(TOR_DIRVOTE_H) */
microdesc_t
Definition: microdesc_st.h:27
routerinfo_t
Definition: routerinfo_st.h:20
T
#define T(s, t, a, o)
Definition: parsecommon.h:246
vote_microdesc_hash_t
Definition: vote_microdesc_hash_st.h:18
dirvote_get_pending_consensus
const char * dirvote_get_pending_consensus(consensus_flavor_t flav)
Definition: dirvote.c:3763
dirvote_add_vote
pending_vote_t * dirvote_add_vote(const char *vote_body, time_t time_posted, const char **msg_out, int *status_out)
Definition: dirvote.c:3170
pending_vote_t
Definition: dirvote.c:2924
dirvote_act
time_t dirvote_act(const or_options_t *options, time_t now)
Definition: dirvote.c:2847
dirvote_get_pending_detached_signatures
const char * dirvote_get_pending_detached_signatures(void)
Definition: dirvote.c:3772
consensus_flavor_t
consensus_flavor_t
Definition: or.h:881
make_consensus_method_list
STATIC char * make_consensus_method_list(int low, int high, const char *separator)
Definition: dirvote.c:835
tor_assert_nonfatal_unreached
#define tor_assert_nonfatal_unreached()
Definition: util_bug.h:176
authority_cert_dup
STATIC authority_cert_t * authority_cert_dup(authority_cert_t *cert)
Definition: dirvote.c:145
DIRVOTE_OPTIONAL_FLAGS
const char DIRVOTE_OPTIONAL_FLAGS[]
Definition: dirvote.c:4455
dirserv_generate_networkstatus_vote_obj
networkstatus_t * dirserv_generate_networkstatus_vote_obj(crypto_pk_t *private_key, authority_cert_t *cert)
Definition: dirvote.c:4462
legacy_signing_key
static crypto_pk_t * legacy_signing_key
Definition: router.c:131
MOCK_DECL
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
cached_dir_t
Definition: cached_dir_st.h:17
authority_cert_t
Definition: authority_cert_st.h:19
dirvote_get_vote
const cached_dir_t * dirvote_get_vote(const char *fp, int flags)
Definition: dirvote.c:3786
networkstatus_compute_bw_weights_v10
int networkstatus_compute_bw_weights_v10(smartlist_t *chunks, int64_t G, int64_t M, int64_t E, int64_t D, int64_t T, int64_t weight_scale)
Definition: dirvote.c:1096
dirvote_format_all_microdesc_vote_lines
vote_microdesc_hash_t * dirvote_format_all_microdesc_vote_lines(const routerinfo_t *ri, time_t now, smartlist_t *microdescriptors_out)
Definition: dirvote.c:3984
dirvote_create_microdescriptor
STATIC microdesc_t * dirvote_create_microdescriptor(const routerinfo_t *ri, int consensus_method)
Definition: dirvote.c:3832
dirvote_free_all
void dirvote_free_all(void)
Definition: dirvote.c:3739
networkstatus_add_detached_signatures
STATIC int networkstatus_add_detached_signatures(networkstatus_t *target, ns_detached_signatures_t *sigs, const char *source, int severity, const char **msg_out)
Definition: dirvote.c:2545
crypto_pk_t
Definition: crypto_rsa_nss.c:37
dirvote_compute_params
STATIC smartlist_t * dirvote_compute_params(smartlist_t *votes, int method, int total_authorities)
Definition: dirvote.c:920
format_recommended_version_list
char * format_recommended_version_list(const config_line_t *ln, int warn)
Definition: dirvote.c:4332
config_line_t
Definition: confline.h:29
DIRVOTE_UNIVERSAL_FLAGS
const char DIRVOTE_UNIVERSAL_FLAGS[]
Definition: dirvote.c:4443
dirvote_get_intermediate_param_value
STATIC int32_t dirvote_get_intermediate_param_value(const smartlist_t *param_list, const char *keyword, int32_t default_val)
Definition: dirvote.c:884
networkstatus_compute_consensus
STATIC char * networkstatus_compute_consensus(smartlist_t *votes, int total_authorities, crypto_pk_t *identity_key, crypto_pk_t *signing_key, const char *legacy_id_key_digest, crypto_pk_t *legacy_signing_key, consensus_flavor_t flavor)
Definition: dirvote.c:1501
format_networkstatus_vote
STATIC char * format_networkstatus_vote(crypto_pk_t *private_signing_key, networkstatus_t *v3_ns)
Definition: dirvote.c:222
or_options_t
Definition: or_options_st.h:45
STATIC
#define STATIC
Definition: testsupport.h:32
compute_consensus_package_lines
STATIC char * compute_consensus_package_lines(smartlist_t *votes)
Definition: dirvote.c:2464
ns_detached_signatures_t
Definition: ns_detached_signatures_st.h:17
networkstatus_t
Definition: networkstatus_st.h:26
smartlist_t
Definition: smartlist_core.h:26
networkstatus_get_detached_signatures
STATIC char * networkstatus_get_detached_signatures(smartlist_t *consensuses)
Definition: dirvote.c:2737
dirvote_add_signatures
int dirvote_add_signatures(const char *detached_signatures_body, const char *source, const char **msg)
Definition: dirvote.c:3686