mirror of
https://gitlab.torproject.org/tpo/core/tor.git
synced 2024-11-14 07:03:44 +01:00
241 lines
9.7 KiB
C
241 lines
9.7 KiB
C
/* Copyright (c) 2001 Matej Pfajfar.
|
|
* Copyright (c) 2001-2004, Roger Dingledine.
|
|
* Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
|
|
* Copyright (c) 2007-2016, 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
|
|
|
|
#include "testsupport.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 13
|
|
|
|
/** The highest consensus method that we currently support. */
|
|
#define MAX_SUPPORTED_CONSENSUS_METHOD 25
|
|
|
|
/** Lowest consensus method where microdesc consensuses omit any entry
|
|
* with no microdesc. */
|
|
#define MIN_METHOD_FOR_MANDATORY_MICRODESC 13
|
|
|
|
/** Lowest consensus method that contains "a" lines. */
|
|
#define MIN_METHOD_FOR_A_LINES 14
|
|
|
|
/** Lowest consensus method where microdescs may include a "p6" line. */
|
|
#define MIN_METHOD_FOR_P6_LINES 15
|
|
|
|
/** Lowest consensus method where microdescs may include an onion-key-ntor
|
|
* line */
|
|
#define MIN_METHOD_FOR_NTOR_KEY 16
|
|
|
|
/** Lowest consensus method that ensures that authorities output an
|
|
* Unmeasured=1 flag for unmeasured bandwidths */
|
|
#define MIN_METHOD_TO_CLIP_UNMEASURED_BW 17
|
|
|
|
/** Lowest consensus method where authorities may include an "id" line in
|
|
* microdescriptors. */
|
|
#define MIN_METHOD_FOR_ID_HASH_IN_MD 18
|
|
|
|
/** Lowest consensus method where we include "package" lines*/
|
|
#define MIN_METHOD_FOR_PACKAGE_LINES 19
|
|
|
|
/** Lowest consensus method where authorities may include
|
|
* GuardFraction information in microdescriptors. */
|
|
#define MIN_METHOD_FOR_GUARDFRACTION 20
|
|
|
|
/** Lowest consensus method where authorities may include an "id" line for
|
|
* ed25519 identities in microdescriptors. (Broken; see
|
|
* consensus_method_is_supported() for more info.) */
|
|
#define MIN_METHOD_FOR_ED25519_ID_IN_MD 21
|
|
|
|
/** Lowest consensus method where authorities vote on ed25519 ids and ensure
|
|
* ed25519 id consistency. */
|
|
#define MIN_METHOD_FOR_ED25519_ID_VOTING 22
|
|
|
|
/** Lowest consensus method where authorities may include a shared random
|
|
* value(s). */
|
|
#define MIN_METHOD_FOR_SHARED_RANDOM 23
|
|
|
|
/** Lowest consensus method where authorities drop all nodes that don't get
|
|
* the Valid flag. */
|
|
#define MIN_METHOD_FOR_EXCLUDING_INVALID_NODES 24
|
|
|
|
/** 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
|
|
|
|
/** 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
|
|
|
|
void dirvote_free_all(void);
|
|
|
|
/* vote manipulation */
|
|
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);
|
|
int networkstatus_add_detached_signatures(networkstatus_t *target,
|
|
ns_detached_signatures_t *sigs,
|
|
const char *source,
|
|
int severity,
|
|
const char **msg_out);
|
|
char *networkstatus_get_detached_signatures(smartlist_t *consensuses);
|
|
void ns_detached_signatures_free(ns_detached_signatures_t *s);
|
|
|
|
/* cert manipulation */
|
|
authority_cert_t *authority_cert_dup(authority_cert_t *cert);
|
|
|
|
/* vote scheduling */
|
|
|
|
/** Scheduling information for a voting interval. */
|
|
typedef struct {
|
|
/** When do we generate and distribute our vote for this interval? */
|
|
time_t voting_starts;
|
|
/** When do we send an HTTP request for any votes that we haven't
|
|
* been posted yet?*/
|
|
time_t fetch_missing_votes;
|
|
/** When do we give up on getting more votes and generate a consensus? */
|
|
time_t voting_ends;
|
|
/** When do we send an HTTP request for any signatures we're expecting to
|
|
* see on the consensus? */
|
|
time_t fetch_missing_signatures;
|
|
/** When do we publish the consensus? */
|
|
time_t interval_starts;
|
|
|
|
/* True iff we have generated and distributed our vote. */
|
|
int have_voted;
|
|
/* True iff we've requested missing votes. */
|
|
int have_fetched_missing_votes;
|
|
/* True iff we have built a consensus and sent the signatures around. */
|
|
int have_built_consensus;
|
|
/* True iff we've fetched missing signatures. */
|
|
int have_fetched_missing_signatures;
|
|
/* True iff we have published our consensus. */
|
|
int have_published_consensus;
|
|
} voting_schedule_t;
|
|
|
|
voting_schedule_t *get_voting_schedule(const or_options_t *options,
|
|
time_t now, int severity);
|
|
|
|
void voting_schedule_free(voting_schedule_t *voting_schedule_to_free);
|
|
|
|
void dirvote_get_preferred_voting_intervals(vote_timing_t *timing_out);
|
|
time_t dirvote_get_start_of_next_interval(time_t now,
|
|
int interval,
|
|
int offset);
|
|
void dirvote_recalculate_timing(const or_options_t *options, time_t now);
|
|
void dirvote_act(const or_options_t *options, time_t now);
|
|
time_t get_next_valid_after_time(time_t now);
|
|
|
|
/* invoked on timers and by outside triggers. */
|
|
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);
|
|
|
|
/* Item access */
|
|
MOCK_DECL(const char*, dirvote_get_pending_consensus,
|
|
(consensus_flavor_t flav));
|
|
MOCK_DECL(const char*, dirvote_get_pending_detached_signatures, (void));
|
|
|
|
#define DGV_BY_ID 1
|
|
#define DGV_INCLUDE_PENDING 2
|
|
#define DGV_INCLUDE_PREVIOUS 4
|
|
const cached_dir_t *dirvote_get_vote(const char *fp, int flags);
|
|
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);
|
|
|
|
microdesc_t *dirvote_create_microdescriptor(const routerinfo_t *ri,
|
|
int consensus_method);
|
|
ssize_t dirvote_format_microdesc_vote_line(char *out, size_t out_len,
|
|
const microdesc_t *md,
|
|
int consensus_method_low,
|
|
int consensus_method_high);
|
|
vote_microdesc_hash_t *dirvote_format_all_microdesc_vote_lines(
|
|
const routerinfo_t *ri,
|
|
time_t now,
|
|
smartlist_t *microdescriptors_out);
|
|
|
|
int vote_routerstatus_find_microdesc_hash(char *digest256_out,
|
|
const vote_routerstatus_t *vrs,
|
|
int method,
|
|
digest_algorithm_t alg);
|
|
document_signature_t *voter_get_sig_by_algorithm(
|
|
const networkstatus_voter_info_t *voter,
|
|
digest_algorithm_t alg);
|
|
|
|
#ifdef DIRVOTE_PRIVATE
|
|
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);
|
|
#endif
|
|
|
|
#endif
|
|
|