mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-12-04 09:33:33 +01:00
b67f7d722d
Since Tor 0.2.9 has been unsupported since January, 0.3.5 is the
oldest supported version, and its features constitute the oldest
recommended feature-set.
This patch updates these recommendations:
DirCache=2
Support for consensus diffs.
New in 0.3.1.1-alpha.
HSDir=2
Support for v3 onion service descriptors.
New in 0.3.0.4-alpha.
HSIntro=4
Support for Ed25519 intropoint authentication keys.
New in 0.3.0-4-alpha.
HSRend=2
Support for rendezvous cells longer than 20 bytes.
New in 0.2.9.4-alpha.
Link=5
Link padding and link padding negotiation.
New in 0.3.3.2-alpha.
LinkAuth=3
Ed25519 link authentication.
New in 0.3.0.1-alpha.
271 lines
9.6 KiB
C
271 lines
9.6 KiB
C
/* Copyright (c) 2001 Matej Pfajfar.
|
|
* Copyright (c) 2001-2004, Roger Dingledine.
|
|
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
|
* Copyright (c) 2007-2020, The Tor Project, Inc. */
|
|
/* See LICENSE for licensing information */
|
|
|
|
/**
|
|
* \file dirvote.h
|
|
* \brief Header file for dirvote.c.
|
|
**/
|
|
|
|
#ifndef TOR_DIRVOTE_H
|
|
#define TOR_DIRVOTE_H
|
|
|
|
/*
|
|
* Ideally, assuming synced clocks, we should only need 1 second for each of:
|
|
* - Vote
|
|
* - Distribute
|
|
* - Consensus Publication
|
|
* As we can gather descriptors continuously.
|
|
* (Could we even go as far as publishing the previous consensus,
|
|
* in the same second that we vote for the next one?)
|
|
* But we're not there yet: these are the lowest working values at this time.
|
|
*/
|
|
|
|
/** Lowest allowable value for VoteSeconds. */
|
|
#define MIN_VOTE_SECONDS 2
|
|
/** Lowest allowable value for VoteSeconds when TestingTorNetwork is 1 */
|
|
#define MIN_VOTE_SECONDS_TESTING 2
|
|
|
|
/** Lowest allowable value for DistSeconds. */
|
|
#define MIN_DIST_SECONDS 2
|
|
/** Lowest allowable value for DistSeconds when TestingTorNetwork is 1 */
|
|
#define MIN_DIST_SECONDS_TESTING 2
|
|
|
|
/** Lowest allowable voting interval. */
|
|
#define MIN_VOTE_INTERVAL 300
|
|
/** Lowest allowable voting interval when TestingTorNetwork is 1:
|
|
* Voting Interval can be:
|
|
* 10, 12, 15, 18, 20, 24, 25, 30, 36, 40, 45, 50, 60, ...
|
|
* Testing Initial Voting Interval can be:
|
|
* 5, 6, 8, 9, or any of the possible values for Voting Interval,
|
|
* as they both need to evenly divide 30 minutes.
|
|
* If clock desynchronisation is an issue, use an interval of at least:
|
|
* 18 * drift in seconds, to allow for a clock slop factor */
|
|
#define MIN_VOTE_INTERVAL_TESTING \
|
|
(((MIN_VOTE_SECONDS_TESTING)+(MIN_DIST_SECONDS_TESTING)+1)*2)
|
|
|
|
#define MIN_VOTE_INTERVAL_TESTING_INITIAL \
|
|
((MIN_VOTE_SECONDS_TESTING)+(MIN_DIST_SECONDS_TESTING)+1)
|
|
|
|
/** The lowest consensus method that we currently support. */
|
|
#define MIN_SUPPORTED_CONSENSUS_METHOD 28
|
|
|
|
/** The highest consensus method that we currently support. */
|
|
#define MAX_SUPPORTED_CONSENSUS_METHOD 29
|
|
|
|
/**
|
|
* Lowest consensus method where microdescriptor lines are put in canonical
|
|
* form for improved compressibility and ease of storage. See proposal 298.
|
|
**/
|
|
#define MIN_METHOD_FOR_CANONICAL_FAMILIES_IN_MICRODESCS 29
|
|
|
|
/** Default bandwidth to clip unmeasured bandwidths to using method >=
|
|
* MIN_METHOD_TO_CLIP_UNMEASURED_BW. (This is not a consensus method; do not
|
|
* get confused with the above macros.) */
|
|
#define DEFAULT_MAX_UNMEASURED_BW_KB 20
|
|
|
|
/* Directory Get Vote (DGV) flags for dirvote_get_vote(). */
|
|
#define DGV_BY_ID 1
|
|
#define DGV_INCLUDE_PENDING 2
|
|
#define DGV_INCLUDE_PREVIOUS 4
|
|
|
|
/** Maximum size of a line in a vote. */
|
|
#define MAX_BW_FILE_HEADERS_LINE_LEN 1024
|
|
|
|
extern const char DIRVOTE_UNIVERSAL_FLAGS[];
|
|
extern const char DIRVOTE_OPTIONAL_FLAGS[];
|
|
|
|
/*
|
|
* Public API. Used outside of the dirauth subsystem.
|
|
*
|
|
* We need to nullify them if the module is disabled.
|
|
*/
|
|
#ifdef HAVE_MODULE_DIRAUTH
|
|
|
|
time_t dirvote_act(const or_options_t *options, time_t now);
|
|
void dirvote_free_all(void);
|
|
|
|
void dirvote_parse_sr_commits(networkstatus_t *ns, const smartlist_t *tokens);
|
|
void dirvote_clear_commits(networkstatus_t *ns);
|
|
void dirvote_dirreq_get_status_vote(const char *url, smartlist_t *items,
|
|
smartlist_t *dir_items);
|
|
|
|
/* Storing signatures and votes functions */
|
|
struct pending_vote_t * dirvote_add_vote(const char *vote_body,
|
|
time_t time_posted,
|
|
const char **msg_out,
|
|
int *status_out);
|
|
int dirvote_add_signatures(const char *detached_signatures_body,
|
|
const char *source,
|
|
const char **msg_out);
|
|
|
|
struct config_line_t;
|
|
char *format_recommended_version_list(const struct config_line_t *line,
|
|
int warn);
|
|
|
|
#else /* !defined(HAVE_MODULE_DIRAUTH) */
|
|
|
|
static inline time_t
|
|
dirvote_act(const or_options_t *options, time_t now)
|
|
{
|
|
(void) options;
|
|
(void) now;
|
|
return TIME_MAX;
|
|
}
|
|
|
|
static inline void
|
|
dirvote_free_all(void)
|
|
{
|
|
}
|
|
|
|
static inline void
|
|
dirvote_parse_sr_commits(networkstatus_t *ns, const smartlist_t *tokens)
|
|
{
|
|
(void) ns;
|
|
(void) tokens;
|
|
}
|
|
|
|
static inline void
|
|
dirvote_clear_commits(networkstatus_t *ns)
|
|
{
|
|
(void) ns;
|
|
}
|
|
|
|
static inline void
|
|
dirvote_dirreq_get_status_vote(const char *url, smartlist_t *items,
|
|
smartlist_t *dir_items)
|
|
{
|
|
(void) url;
|
|
(void) items;
|
|
(void) dir_items;
|
|
}
|
|
|
|
static inline struct pending_vote_t *
|
|
dirvote_add_vote(const char *vote_body,
|
|
time_t time_posted,
|
|
const char **msg_out,
|
|
int *status_out)
|
|
{
|
|
(void) vote_body;
|
|
(void) time_posted;
|
|
/* If the dirauth module is disabled, this should NEVER be called else we
|
|
* failed to safeguard the dirauth module. */
|
|
tor_assert_nonfatal_unreached();
|
|
|
|
/* We need to send out an error code. */
|
|
*status_out = 400;
|
|
*msg_out = "No directory authority support";
|
|
return NULL;
|
|
}
|
|
|
|
static inline int
|
|
dirvote_add_signatures(const char *detached_signatures_body,
|
|
const char *source,
|
|
const char **msg_out)
|
|
{
|
|
(void) detached_signatures_body;
|
|
(void) source;
|
|
*msg_out = "No directory authority support";
|
|
/* If the dirauth module is disabled, this should NEVER be called else we
|
|
* failed to safeguard the dirauth module. */
|
|
tor_assert_nonfatal_unreached();
|
|
return 0;
|
|
}
|
|
|
|
#endif /* defined(HAVE_MODULE_DIRAUTH) */
|
|
|
|
/* Item access */
|
|
MOCK_DECL(const char*, dirvote_get_pending_consensus,
|
|
(consensus_flavor_t flav));
|
|
MOCK_DECL(const char*, dirvote_get_pending_detached_signatures, (void));
|
|
const cached_dir_t *dirvote_get_vote(const char *fp, int flags);
|
|
|
|
/*
|
|
* API used _only_ by the dirauth subsystem.
|
|
*/
|
|
|
|
networkstatus_t *
|
|
dirserv_generate_networkstatus_vote_obj(crypto_pk_t *private_key,
|
|
authority_cert_t *cert);
|
|
|
|
vote_microdesc_hash_t *dirvote_format_all_microdesc_vote_lines(
|
|
const routerinfo_t *ri,
|
|
time_t now,
|
|
smartlist_t *microdescriptors_out);
|
|
|
|
/*
|
|
* Exposed functions for unit tests.
|
|
*/
|
|
#ifdef DIRVOTE_PRIVATE
|
|
|
|
/* Cert manipulation */
|
|
STATIC authority_cert_t *authority_cert_dup(authority_cert_t *cert);
|
|
STATIC int32_t dirvote_get_intermediate_param_value(
|
|
const smartlist_t *param_list,
|
|
const char *keyword,
|
|
int32_t default_val);
|
|
STATIC char *format_networkstatus_vote(crypto_pk_t *private_key,
|
|
networkstatus_t *v3_ns);
|
|
STATIC smartlist_t *dirvote_compute_params(smartlist_t *votes, int method,
|
|
int total_authorities);
|
|
STATIC char *compute_consensus_package_lines(smartlist_t *votes);
|
|
STATIC char *make_consensus_method_list(int low, int high, const char *sep);
|
|
STATIC 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);
|
|
STATIC
|
|
char *networkstatus_compute_consensus(smartlist_t *votes,
|
|
int total_authorities,
|
|
crypto_pk_t *identity_key,
|
|
crypto_pk_t *signing_key,
|
|
const char *legacy_identity_key_digest,
|
|
crypto_pk_t *legacy_signing_key,
|
|
consensus_flavor_t flavor);
|
|
STATIC
|
|
int networkstatus_add_detached_signatures(networkstatus_t *target,
|
|
ns_detached_signatures_t *sigs,
|
|
const char *source,
|
|
int severity,
|
|
const char **msg_out);
|
|
STATIC
|
|
char *networkstatus_get_detached_signatures(smartlist_t *consensuses);
|
|
STATIC microdesc_t *dirvote_create_microdescriptor(const routerinfo_t *ri,
|
|
int consensus_method);
|
|
|
|
/** The recommended relay protocols for this authority's votes.
|
|
* Recommending a new protocol causes old tor versions to log a warning.
|
|
*/
|
|
#define DIRVOTE_RECOMMEND_RELAY_PROTO \
|
|
"Cons=1-2 Desc=1-2 DirCache=2 HSDir=2 HSIntro=4 HSRend=2 " \
|
|
"Link=5 LinkAuth=3 Microdesc=1-2 Relay=2"
|
|
/** The recommended client protocols for this authority's votes.
|
|
* Recommending a new protocol causes old tor versions to log a warning.
|
|
*/
|
|
#define DIRVOTE_RECOMMEND_CLIENT_PROTO \
|
|
"Cons=1-2 Desc=1-2 DirCache=2 HSDir=2 HSIntro=4 HSRend=2 " \
|
|
"Link=5 LinkAuth=3 Microdesc=1-2 Relay=2"
|
|
|
|
/** The required relay protocols for this authority's votes.
|
|
* WARNING: Requiring a new protocol causes old tor versions to shut down.
|
|
* Requiring the wrong protocols can break the tor network.
|
|
* See Proposal 303: When and how to remove support for protocol versions.
|
|
*/
|
|
#define DIRVOTE_REQUIRE_RELAY_PROTO \
|
|
"Cons=1 Desc=1 DirCache=1 HSDir=1 HSIntro=3 HSRend=1 " \
|
|
"Link=3-4 Microdesc=1 Relay=1-2"
|
|
/** The required relay protocols for this authority's votes.
|
|
* WARNING: Requiring a new protocol causes old tor versions to shut down.
|
|
* Requiring the wrong protocols can break the tor network.
|
|
* See Proposal 303: When and how to remove support for protocol versions.
|
|
*/
|
|
#define DIRVOTE_REQUIRE_CLIENT_PROTO \
|
|
"Cons=1-2 Desc=1-2 DirCache=1 HSDir=1 HSIntro=3 HSRend=1 " \
|
|
"Link=4 Microdesc=1-2 Relay=2"
|
|
|
|
#endif /* defined(DIRVOTE_PRIVATE) */
|
|
|
|
#endif /* !defined(TOR_DIRVOTE_H) */
|