Tor 0.4.9.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-2021, 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 32
54
55/** The highest consensus method that we currently support. */
56#define MAX_SUPPORTED_CONSENSUS_METHOD 34
57
58/**
59 * Lowest consensus method for which we suppress the published time in
60 * microdescriptor consensuses.
61 */
62#define MIN_METHOD_TO_SUPPRESS_MD_PUBLISHED 33
63
64/**
65 * Lowest (supported) consensus method for which we do not include
66 * any "package" lines.
67 **/
68#define MIN_METHOD_TO_OMIT_PACKAGE_FINGERPRINTS 34
69
70/** Default bandwidth to clip unmeasured bandwidths to using method >=
71 * MIN_METHOD_TO_CLIP_UNMEASURED_BW. (This is not a consensus method; do not
72 * get confused with the above macros.) */
73#define DEFAULT_MAX_UNMEASURED_BW_KB 20
74
75/* Directory Get Vote (DGV) flags for dirvote_get_vote(). */
76#define DGV_BY_ID 1
77#define DGV_INCLUDE_PENDING 2
78#define DGV_INCLUDE_PREVIOUS 4
79
80/** Maximum size of a line in a vote. */
81#define MAX_BW_FILE_HEADERS_LINE_LEN 1024
82
83extern const char DIRVOTE_UNIVERSAL_FLAGS[];
84extern const char DIRVOTE_OPTIONAL_FLAGS[];
85
86/*
87 * Public API. Used outside of the dirauth subsystem.
88 *
89 * We need to nullify them if the module is disabled.
90 */
91#ifdef HAVE_MODULE_DIRAUTH
92
93time_t dirvote_act(const or_options_t *options, time_t now);
94void dirvote_free_all(void);
95
96void dirvote_parse_sr_commits(networkstatus_t *ns, const smartlist_t *tokens);
97void dirvote_clear_commits(networkstatus_t *ns);
98void dirvote_dirreq_get_status_vote(const char *url, smartlist_t *items,
99 smartlist_t *dir_items);
100
101/* Storing signatures and votes functions */
102struct pending_vote_t * dirvote_add_vote(const char *vote_body,
103 time_t time_posted,
104 const char *where_from,
105 const char **msg_out,
106 int *status_out);
107int dirvote_add_signatures(const char *detached_signatures_body,
108 const char *source,
109 const char **msg_out);
110
111struct config_line_t;
112char *format_recommended_version_list(const struct config_line_t *line,
113 int warn);
114
115#else /* !defined(HAVE_MODULE_DIRAUTH) */
116
117static inline time_t
118dirvote_act(const or_options_t *options, time_t now)
119{
120 (void) options;
121 (void) now;
122 return TIME_MAX;
123}
124
125static inline void
127{
128}
129
130static inline void
131dirvote_parse_sr_commits(networkstatus_t *ns, const smartlist_t *tokens)
132{
133 (void) ns;
134 (void) tokens;
135}
136
137static inline void
138dirvote_clear_commits(networkstatus_t *ns)
139{
140 (void) ns;
141}
142
143static inline void
144dirvote_dirreq_get_status_vote(const char *url, smartlist_t *items,
145 smartlist_t *dir_items)
146{
147 (void) url;
148 (void) items;
149 (void) dir_items;
150}
151
152static inline struct pending_vote_t *
153dirvote_add_vote(const char *vote_body,
154 time_t time_posted,
155 const char *where_from,
156 const char **msg_out,
157 int *status_out)
158{
159 (void) vote_body;
160 (void) time_posted;
161 (void) where_from;
162 /* If the dirauth module is disabled, this should NEVER be called else we
163 * failed to safeguard the dirauth module. */
165
166 /* We need to send out an error code. */
167 *status_out = 400;
168 *msg_out = "No directory authority support";
169 return NULL;
170}
171
172static inline int
173dirvote_add_signatures(const char *detached_signatures_body,
174 const char *source,
175 const char **msg_out)
176{
177 (void) detached_signatures_body;
178 (void) source;
179 *msg_out = "No directory authority support";
180 /* If the dirauth module is disabled, this should NEVER be called else we
181 * failed to safeguard the dirauth module. */
183 return 0;
184}
185
186#endif /* defined(HAVE_MODULE_DIRAUTH) */
187
188/* Item access */
190 (consensus_flavor_t flav));
192 (const routerinfo_t *ri));
194const cached_dir_t *dirvote_get_vote(const char *fp, int flags);
195
196/*
197 * API used _only_ by the dirauth subsystem.
198 */
199
202 authority_cert_t *cert);
203
205 const routerinfo_t *ri,
206 time_t now,
207 smartlist_t *microdescriptors_out);
208
209/*
210 * Exposed functions for unit tests.
211 */
212#ifdef DIRVOTE_PRIVATE
213
214/* Cert manipulation */
217 const smartlist_t *param_list,
218 const char *keyword,
219 int32_t default_val);
221 networkstatus_t *v3_ns);
223 int total_authorities);
225STATIC char *make_consensus_method_list(int low, int high, const char *sep);
226STATIC int
228 int64_t M, int64_t E, int64_t D,
229 int64_t T, int64_t weight_scale);
230STATIC
232 int total_authorities,
233 crypto_pk_t *identity_key,
234 crypto_pk_t *signing_key,
235 const char *legacy_identity_key_digest,
237 consensus_flavor_t flavor);
238STATIC
241 const char *source,
242 int severity,
243 const char **msg_out);
244STATIC int
246 const routerinfo_t *second);
247STATIC
248int compare_routerinfo_by_ipv4(const void **a, const void **b);
249
250STATIC
251int compare_routerinfo_by_ipv6(const void **a, const void **b);
252
253STATIC
254digestmap_t * get_sybil_list_by_ip_version(
255 const smartlist_t *routers, sa_family_t family);
256
257STATIC
258digestmap_t * get_all_possible_sybil(const smartlist_t *routers);
259
260STATIC
263 int consensus_method);
264
265#endif /* defined(DIRVOTE_PRIVATE) */
266
267#endif /* !defined(TOR_DIRVOTE_H) */
STATIC microdesc_t * dirvote_create_microdescriptor(const routerinfo_t *ri, int consensus_method)
Definition: dirvote.c:3865
STATIC int compare_routerinfo_usefulness(const routerinfo_t *first, const routerinfo_t *second)
Definition: dirvote.c:4291
pending_vote_t * dirvote_add_vote(const char *vote_body, time_t time_posted, const char *where_from, const char **msg_out, int *status_out)
Definition: dirvote.c:3183
char * format_recommended_version_list(const config_line_t *ln, int warn)
Definition: dirvote.c:4445
STATIC authority_cert_t * authority_cert_dup(authority_cert_t *cert)
Definition: dirvote.c:146
STATIC int compare_routerinfo_by_ipv6(const void **a, const void **b)
Definition: dirvote.c:4272
STATIC char * make_consensus_method_list(int low, int high, const char *separator)
Definition: dirvote.c:837
STATIC digestmap_t * get_all_possible_sybil(const smartlist_t *routers)
Definition: dirvote.c:4381
time_t dirvote_act(const or_options_t *options, time_t now)
Definition: dirvote.c:2860
STATIC char * format_networkstatus_vote(crypto_pk_t *private_signing_key, networkstatus_t *v3_ns)
Definition: dirvote.c:223
STATIC int32_t dirvote_get_intermediate_param_value(const smartlist_t *param_list, const char *keyword, int32_t default_val)
Definition: dirvote.c:886
void dirvote_free_all(void)
Definition: dirvote.c:3772
STATIC smartlist_t * dirvote_compute_params(smartlist_t *votes, int method, int total_authorities)
Definition: dirvote.c:922
int dirvote_add_signatures(const char *detached_signatures_body, const char *source, const char **msg)
Definition: dirvote.c:3719
STATIC char * networkstatus_get_detached_signatures(smartlist_t *consensuses)
Definition: dirvote.c:2750
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:1098
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:2558
STATIC char * compute_consensus_package_lines(smartlist_t *votes)
Definition: dirvote.c:2477
STATIC digestmap_t * get_sybil_list_by_ip_version(const smartlist_t *routers, sa_family_t family)
Definition: dirvote.c:4341
STATIC int compare_routerinfo_by_ipv4(const void **a, const void **b)
Definition: dirvote.c:4254
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:1518
networkstatus_t * dirserv_generate_networkstatus_vote_obj(crypto_pk_t *private_key, authority_cert_t *cert)
Definition: dirvote.c:4581
const cached_dir_t * dirvote_get_vote(const char *fp, int flags)
Definition: dirvote.c:3819
const char * dirvote_get_pending_consensus(consensus_flavor_t flav)
Definition: dirvote.c:3796
uint32_t dirserv_get_bandwidth_for_router_kb(const routerinfo_t *ri)
Definition: dirvote.c:4206
const char DIRVOTE_OPTIONAL_FLAGS[]
Definition: dirvote.c:4573
const char * dirvote_get_pending_detached_signatures(void)
Definition: dirvote.c:3805
const char DIRVOTE_UNIVERSAL_FLAGS[]
Definition: dirvote.c:4560
vote_microdesc_hash_t * dirvote_format_all_microdesc_vote_lines(const routerinfo_t *ri, time_t now, smartlist_t *microdescriptors_out)
Definition: dirvote.c:4009
uint16_t sa_family_t
Definition: inaddr_st.h:77
consensus_flavor_t
Definition: or.h:763
#define T(s, t, a, o)
Definition: parsecommon.h:247
static crypto_pk_t * legacy_signing_key
Definition: router.c:131
#define STATIC
Definition: testsupport.h:32
#define MOCK_DECL(rv, funcname, arglist)
Definition: testsupport.h:127
#define tor_assert_nonfatal_unreached()
Definition: util_bug.h:177