dirvote.h 5.6 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136
  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-2014, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file dirvote.h
  8. * \brief Header file for dirvote.c.
  9. **/
  10. #ifndef TOR_DIRVOTE_H
  11. #define TOR_DIRVOTE_H
  12. #include "testsupport.h"
  13. /** Lowest allowable value for VoteSeconds. */
  14. #define MIN_VOTE_SECONDS 2
  15. /** Lowest allowable value for DistSeconds. */
  16. #define MIN_DIST_SECONDS 2
  17. /** Smallest allowable voting interval. */
  18. #define MIN_VOTE_INTERVAL 300
  19. /** The lowest consensus method that we currently support. */
  20. #define MIN_SUPPORTED_CONSENSUS_METHOD 13
  21. /** The highest consensus method that we currently support. */
  22. #define MAX_SUPPORTED_CONSENSUS_METHOD 18
  23. /** Lowest consensus method where microdesc consensuses omit any entry
  24. * with no microdesc. */
  25. #define MIN_METHOD_FOR_MANDATORY_MICRODESC 13
  26. /** Lowest consensus method that contains "a" lines. */
  27. #define MIN_METHOD_FOR_A_LINES 14
  28. /** Lowest consensus method where microdescs may include a "p6" line. */
  29. #define MIN_METHOD_FOR_P6_LINES 15
  30. /** Lowest consensus method where microdescs may include an onion-key-ntor
  31. * line */
  32. #define MIN_METHOD_FOR_NTOR_KEY 16
  33. /** Lowest consensus method that ensures that authorities output an
  34. * Unmeasured=1 flag for unmeasured bandwidths */
  35. #define MIN_METHOD_TO_CLIP_UNMEASURED_BW 17
  36. /** Lowest consensus method where authorities may include an "id" line in
  37. * microdescriptors. */
  38. #define MIN_METHOD_FOR_ID_HASH_IN_MD 18
  39. /** Default bandwidth to clip unmeasured bandwidths to using method >=
  40. * MIN_METHOD_TO_CLIP_UNMEASURED_BW */
  41. #define DEFAULT_MAX_UNMEASURED_BW_KB 20
  42. void dirvote_free_all(void);
  43. /* vote manipulation */
  44. char *networkstatus_compute_consensus(smartlist_t *votes,
  45. int total_authorities,
  46. crypto_pk_t *identity_key,
  47. crypto_pk_t *signing_key,
  48. const char *legacy_identity_key_digest,
  49. crypto_pk_t *legacy_signing_key,
  50. consensus_flavor_t flavor);
  51. int networkstatus_add_detached_signatures(networkstatus_t *target,
  52. ns_detached_signatures_t *sigs,
  53. const char *source,
  54. int severity,
  55. const char **msg_out);
  56. char *networkstatus_get_detached_signatures(smartlist_t *consensuses);
  57. void ns_detached_signatures_free(ns_detached_signatures_t *s);
  58. /* cert manipulation */
  59. authority_cert_t *authority_cert_dup(authority_cert_t *cert);
  60. /* vote scheduling */
  61. void dirvote_get_preferred_voting_intervals(vote_timing_t *timing_out);
  62. time_t dirvote_get_start_of_next_interval(time_t now,
  63. int interval,
  64. int offset);
  65. void dirvote_recalculate_timing(const or_options_t *options, time_t now);
  66. void dirvote_act(const or_options_t *options, time_t now);
  67. /* invoked on timers and by outside triggers. */
  68. struct pending_vote_t * dirvote_add_vote(const char *vote_body,
  69. const char **msg_out,
  70. int *status_out);
  71. int dirvote_add_signatures(const char *detached_signatures_body,
  72. const char *source,
  73. const char **msg_out);
  74. /* Item access */
  75. const char *dirvote_get_pending_consensus(consensus_flavor_t flav);
  76. const char *dirvote_get_pending_detached_signatures(void);
  77. #define DGV_BY_ID 1
  78. #define DGV_INCLUDE_PENDING 2
  79. #define DGV_INCLUDE_PREVIOUS 4
  80. const cached_dir_t *dirvote_get_vote(const char *fp, int flags);
  81. void set_routerstatus_from_routerinfo(routerstatus_t *rs,
  82. node_t *node,
  83. routerinfo_t *ri, time_t now,
  84. int listbadexits,
  85. int vote_on_hsdirs);
  86. networkstatus_t *
  87. dirserv_generate_networkstatus_vote_obj(crypto_pk_t *private_key,
  88. authority_cert_t *cert);
  89. microdesc_t *dirvote_create_microdescriptor(const routerinfo_t *ri,
  90. int consensus_method);
  91. ssize_t dirvote_format_microdesc_vote_line(char *out, size_t out_len,
  92. const microdesc_t *md,
  93. int consensus_method_low,
  94. int consensus_method_high);
  95. vote_microdesc_hash_t *dirvote_format_all_microdesc_vote_lines(
  96. const routerinfo_t *ri,
  97. time_t now,
  98. smartlist_t *microdescriptors_out);
  99. int vote_routerstatus_find_microdesc_hash(char *digest256_out,
  100. const vote_routerstatus_t *vrs,
  101. int method,
  102. digest_algorithm_t alg);
  103. document_signature_t *voter_get_sig_by_algorithm(
  104. const networkstatus_voter_info_t *voter,
  105. digest_algorithm_t alg);
  106. #ifdef DIRVOTE_PRIVATE
  107. STATIC char *format_networkstatus_vote(crypto_pk_t *private_key,
  108. networkstatus_t *v3_ns);
  109. STATIC char *dirvote_compute_params(smartlist_t *votes, int method,
  110. int total_authorities);
  111. #endif
  112. #endif