networkstatus.h 7.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  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-2017, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file networkstatus.h
  8. * \brief Header file for networkstatus.c.
  9. **/
  10. #ifndef TOR_NETWORKSTATUS_H
  11. #define TOR_NETWORKSTATUS_H
  12. #include "testsupport.h"
  13. void networkstatus_reset_warnings(void);
  14. void networkstatus_reset_download_failures(void);
  15. char *networkstatus_read_cached_consensus(const char *flavorname);
  16. int router_reload_consensus_networkstatus(void);
  17. void routerstatus_free(routerstatus_t *rs);
  18. void networkstatus_vote_free(networkstatus_t *ns);
  19. networkstatus_voter_info_t *networkstatus_get_voter_by_id(
  20. networkstatus_t *vote,
  21. const char *identity);
  22. int networkstatus_check_consensus_signature(networkstatus_t *consensus,
  23. int warn);
  24. int networkstatus_check_document_signature(const networkstatus_t *consensus,
  25. document_signature_t *sig,
  26. const authority_cert_t *cert);
  27. int compare_digest_to_routerstatus_entry(const void *_key,
  28. const void **_member);
  29. int compare_digest_to_vote_routerstatus_entry(const void *_key,
  30. const void **_member);
  31. const routerstatus_t *networkstatus_vote_find_entry(networkstatus_t *ns,
  32. const char *digest);
  33. routerstatus_t *networkstatus_vote_find_mutable_entry(networkstatus_t *ns,
  34. const char *digest);
  35. int networkstatus_vote_find_entry_idx(networkstatus_t *ns,
  36. const char *digest, int *found_out);
  37. MOCK_DECL(download_status_t *,
  38. networkstatus_get_dl_status_by_flavor,
  39. (consensus_flavor_t flavor));
  40. MOCK_DECL(download_status_t *,
  41. networkstatus_get_dl_status_by_flavor_bootstrap,
  42. (consensus_flavor_t flavor));
  43. MOCK_DECL(download_status_t *,
  44. networkstatus_get_dl_status_by_flavor_running,
  45. (consensus_flavor_t flavor));
  46. MOCK_DECL(smartlist_t *, router_get_descriptor_digests, (void));
  47. MOCK_DECL(download_status_t *,router_get_dl_status_by_descriptor_digest,
  48. (const char *d));
  49. const routerstatus_t *router_get_consensus_status_by_id(const char *digest);
  50. routerstatus_t *router_get_mutable_consensus_status_by_id(
  51. const char *digest);
  52. const routerstatus_t *router_get_consensus_status_by_descriptor_digest(
  53. networkstatus_t *consensus,
  54. const char *digest);
  55. MOCK_DECL(routerstatus_t *,
  56. router_get_mutable_consensus_status_by_descriptor_digest,
  57. (networkstatus_t *consensus, const char *digest));
  58. int we_want_to_fetch_flavor(const or_options_t *options, int flavor);
  59. int we_want_to_fetch_unknown_auth_certs(const or_options_t *options);
  60. void networkstatus_consensus_download_failed(int status_code,
  61. const char *flavname);
  62. void update_consensus_networkstatus_fetch_time(time_t now);
  63. int should_delay_dir_fetches(const or_options_t *options,const char **msg_out);
  64. void update_networkstatus_downloads(time_t now);
  65. void update_certificate_downloads(time_t now);
  66. int consensus_is_waiting_for_certs(void);
  67. int client_would_use_router(const routerstatus_t *rs, time_t now);
  68. MOCK_DECL(networkstatus_t *,networkstatus_get_latest_consensus,(void));
  69. MOCK_DECL(networkstatus_t *,networkstatus_get_latest_consensus_by_flavor,
  70. (consensus_flavor_t f));
  71. MOCK_DECL(networkstatus_t *, networkstatus_get_live_consensus,(time_t now));
  72. int networkstatus_is_live(const networkstatus_t *ns, time_t now);
  73. int networkstatus_consensus_reasonably_live(const networkstatus_t *consensus,
  74. time_t now);
  75. int networkstatus_valid_until_is_reasonably_live(time_t valid_until,
  76. time_t now);
  77. networkstatus_t *networkstatus_get_reasonably_live_consensus(time_t now,
  78. int flavor);
  79. MOCK_DECL(int, networkstatus_consensus_is_bootstrapping,(time_t now));
  80. int networkstatus_consensus_can_use_multiple_directories(
  81. const or_options_t *options);
  82. MOCK_DECL(int, networkstatus_consensus_can_use_extra_fallbacks,(
  83. const or_options_t *options));
  84. int networkstatus_consensus_is_already_downloading(const char *resource);
  85. #define NSSET_FROM_CACHE 1
  86. #define NSSET_WAS_WAITING_FOR_CERTS 2
  87. #define NSSET_DONT_DOWNLOAD_CERTS 4
  88. #define NSSET_ACCEPT_OBSOLETE 8
  89. #define NSSET_REQUIRE_FLAVOR 16
  90. int networkstatus_set_current_consensus(const char *consensus,
  91. const char *flavor,
  92. unsigned flags,
  93. const char *source_dir);
  94. void networkstatus_note_certs_arrived(const char *source_dir);
  95. void routers_update_all_from_networkstatus(time_t now, int dir_version);
  96. void routers_update_status_from_consensus_networkstatus(smartlist_t *routers,
  97. int reset_failures);
  98. void signed_descs_update_status_from_consensus_networkstatus(
  99. smartlist_t *descs);
  100. char *networkstatus_getinfo_helper_single(const routerstatus_t *rs);
  101. char *networkstatus_getinfo_by_purpose(const char *purpose_string, time_t now);
  102. void networkstatus_dump_bridge_status_to_file(time_t now);
  103. MOCK_DECL(int32_t, networkstatus_get_param,
  104. (const networkstatus_t *ns, const char *param_name,
  105. int32_t default_val, int32_t min_val, int32_t max_val));
  106. int32_t networkstatus_get_overridable_param(const networkstatus_t *ns,
  107. int32_t torrc_value,
  108. const char *param_name,
  109. int32_t default_val,
  110. int32_t min_val, int32_t max_val);
  111. int getinfo_helper_networkstatus(control_connection_t *conn,
  112. const char *question, char **answer,
  113. const char **errmsg);
  114. int32_t networkstatus_get_bw_weight(networkstatus_t *ns, const char *weight,
  115. int32_t default_val);
  116. const char *networkstatus_get_flavor_name(consensus_flavor_t flav);
  117. int networkstatus_parse_flavor_name(const char *flavname);
  118. void document_signature_free(document_signature_t *sig);
  119. document_signature_t *document_signature_dup(const document_signature_t *sig);
  120. void networkstatus_free_all(void);
  121. int networkstatus_get_weight_scale_param(networkstatus_t *ns);
  122. void vote_routerstatus_free(vote_routerstatus_t *rs);
  123. #ifdef NETWORKSTATUS_PRIVATE
  124. #ifdef TOR_UNIT_TESTS
  125. STATIC int networkstatus_set_current_consensus_from_ns(networkstatus_t *c,
  126. const char *flavor);
  127. extern networkstatus_t *current_ns_consensus;
  128. extern networkstatus_t *current_md_consensus;
  129. #endif /* defined(TOR_UNIT_TESTS) */
  130. #endif /* defined(NETWORKSTATUS_PRIVATE) */
  131. #endif /* !defined(TOR_NETWORKSTATUS_H) */