mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-14 15:23:27 +01:00
63b4ea22af
This commit won't build yet -- it just puts everything in a slightly more logical place. The reasoning here is that "src/core" will hold the stuff that every (or nearly every) tor instance will need in order to do onion routing. Other features (including some necessary ones) will live in "src/feature". The "src/app" directory will hold the stuff needed to have Tor be an application you can actually run. This commit DOES NOT refactor the former contents of src/or into a logical set of acyclic libraries, or change any code at all. That will have to come in the future. We will continue to move things around and split them in the future, but I hope this lays a reasonable groundwork for doing so.
248 lines
8.6 KiB
C
248 lines
8.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-2018, 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)
|
|
|
|
/* A placeholder for routerstatus_format_entry() when the consensus method
|
|
* argument is not applicable. */
|
|
#define ROUTERSTATUS_FORMAT_NO_CONSENSUS_METHOD 0
|
|
|
|
/** The lowest consensus method that we currently support. */
|
|
#define MIN_SUPPORTED_CONSENSUS_METHOD 25
|
|
|
|
/** The highest consensus method that we currently support. */
|
|
#define MAX_SUPPORTED_CONSENSUS_METHOD 28
|
|
|
|
/** Lowest consensus method where authorities vote on required/recommended
|
|
* protocols. */
|
|
#define MIN_METHOD_FOR_RECOMMENDED_PROTOCOLS 25
|
|
|
|
/** Lowest consensus method where authorities add protocols to routerstatus
|
|
* entries. */
|
|
#define MIN_METHOD_FOR_RS_PROTOCOLS 25
|
|
|
|
/** Lowest consensus method where authorities initialize bandwidth weights to 1
|
|
* instead of 0. See #14881 */
|
|
#define MIN_METHOD_FOR_INIT_BW_WEIGHTS_ONE 26
|
|
|
|
/** Lowest consensus method where the microdesc consensus contains relay IPv6
|
|
* addresses. See #23826 and #20916. */
|
|
#define MIN_METHOD_FOR_A_LINES_IN_MICRODESC_CONSENSUS 27
|
|
|
|
/** Lowest consensus method where microdescriptors do not contain relay IPv6
|
|
* addresses. See #23828 and #20916. */
|
|
#define MIN_METHOD_FOR_NO_A_LINES_IN_MICRODESC 28
|
|
|
|
/** 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
|
|
|
|
/*
|
|
* 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,
|
|
const char **msg_out,
|
|
int *status_out);
|
|
int dirvote_add_signatures(const char *detached_signatures_body,
|
|
const char *source,
|
|
const char **msg_out);
|
|
|
|
#else /* 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, const char **msg_out, int *status_out)
|
|
{
|
|
(void) vote_body;
|
|
/* 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;
|
|
(void) msg_out;
|
|
/* 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 /* 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.
|
|
*/
|
|
|
|
void set_routerstatus_from_routerinfo(routerstatus_t *rs,
|
|
node_t *node,
|
|
routerinfo_t *ri, time_t now,
|
|
int listbadexits);
|
|
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);
|
|
|
|
#endif /* defined(DIRVOTE_PRIVATE) */
|
|
|
|
#endif /* !defined(TOR_DIRVOTE_H) */
|