config.h 6.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160
  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-2015, The Tor Project, Inc. */
  5. /* See LICENSE for licensing information */
  6. /**
  7. * \file config.h
  8. * \brief Header file for config.c.
  9. **/
  10. #ifndef TOR_CONFIG_H
  11. #define TOR_CONFIG_H
  12. #include "testsupport.h"
  13. const char *get_dirportfrontpage(void);
  14. MOCK_DECL(const or_options_t *,get_options,(void));
  15. or_options_t *get_options_mutable(void);
  16. int set_options(or_options_t *new_val, char **msg);
  17. void config_free_all(void);
  18. const char *safe_str_client(const char *address);
  19. const char *safe_str(const char *address);
  20. const char *escaped_safe_str_client(const char *address);
  21. const char *escaped_safe_str(const char *address);
  22. const char *get_version(void);
  23. const char *get_short_version(void);
  24. setopt_err_t options_trial_assign(config_line_t *list, int use_defaults,
  25. int clear_first, char **msg);
  26. uint32_t get_last_resolved_addr(void);
  27. void reset_last_resolved_addr(void);
  28. int resolve_my_address(int warn_severity, const or_options_t *options,
  29. uint32_t *addr_out,
  30. const char **method_out, char **hostname_out);
  31. MOCK_DECL(int, is_local_addr, (const tor_addr_t *addr));
  32. void options_init(or_options_t *options);
  33. #define OPTIONS_DUMP_MINIMAL 1
  34. #define OPTIONS_DUMP_DEFAULTS 2
  35. #define OPTIONS_DUMP_ALL 3
  36. char *options_dump(const or_options_t *options, int how_to_dump);
  37. int options_init_from_torrc(int argc, char **argv);
  38. setopt_err_t options_init_from_string(const char *cf_defaults, const char *cf,
  39. int command, const char *command_arg, char **msg);
  40. int option_is_recognized(const char *key);
  41. const char *option_get_canonical_name(const char *key);
  42. config_line_t *option_get_assignment(const or_options_t *options,
  43. const char *key);
  44. int options_save_current(void);
  45. const char *get_torrc_fname(int defaults_fname);
  46. char *options_get_datadir_fname2_suffix(const or_options_t *options,
  47. const char *sub1, const char *sub2,
  48. const char *suffix);
  49. #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
  50. options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
  51. /** Return a newly allocated string containing datadir/sub1. See
  52. * get_datadir_fname2_suffix. */
  53. #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
  54. /** Return a newly allocated string containing datadir/sub1/sub2. See
  55. * get_datadir_fname2_suffix. */
  56. #define get_datadir_fname2(sub1,sub2) \
  57. get_datadir_fname2_suffix((sub1), (sub2), NULL)
  58. /** Return a newly allocated string containing datadir/sub1/sub2 relative to
  59. * opts. See get_datadir_fname2_suffix. */
  60. #define options_get_datadir_fname2(opts,sub1,sub2) \
  61. options_get_datadir_fname2_suffix((opts),(sub1), (sub2), NULL)
  62. /** Return a newly allocated string containing datadir/sub1suffix. See
  63. * get_datadir_fname2_suffix. */
  64. #define get_datadir_fname_suffix(sub1, suffix) \
  65. get_datadir_fname2_suffix((sub1), NULL, (suffix))
  66. int check_or_create_data_subdir(const char *subdir);
  67. int write_to_data_subdir(const char* subdir, const char* fname,
  68. const char* str, const char* descr);
  69. int get_num_cpus(const or_options_t *options);
  70. const smartlist_t *get_configured_ports(void);
  71. int get_first_advertised_port_by_type_af(int listener_type,
  72. int address_family);
  73. #define get_primary_or_port() \
  74. (get_first_advertised_port_by_type_af(CONN_TYPE_OR_LISTENER, AF_INET))
  75. #define get_primary_dir_port() \
  76. (get_first_advertised_port_by_type_af(CONN_TYPE_DIR_LISTENER, AF_INET))
  77. char *get_first_listener_addrport_string(int listener_type);
  78. int options_need_geoip_info(const or_options_t *options,
  79. const char **reason_out);
  80. smartlist_t *get_list_of_ports_to_forward(void);
  81. int getinfo_helper_config(control_connection_t *conn,
  82. const char *question, char **answer,
  83. const char **errmsg);
  84. uint32_t get_effective_bwrate(const or_options_t *options);
  85. uint32_t get_effective_bwburst(const or_options_t *options);
  86. char *get_transport_bindaddr_from_config(const char *transport);
  87. int init_cookie_authentication(const char *fname, const char *header,
  88. int cookie_len, int group_readable,
  89. uint8_t **cookie_out, int *cookie_is_set_out);
  90. or_options_t *options_new(void);
  91. int config_parse_commandline(int argc, char **argv, int ignore_errors,
  92. config_line_t **result,
  93. config_line_t **cmdline_result);
  94. void config_register_addressmaps(const or_options_t *options);
  95. /* XXXX024 move to connection_edge.h */
  96. int addressmap_register_auto(const char *from, const char *to,
  97. time_t expires,
  98. addressmap_entry_source_t addrmap_source,
  99. const char **msg);
  100. int config_parse_unix_port(const char *addrport, char **path_out);
  101. /** Represents the information stored in a torrc Bridge line. */
  102. typedef struct bridge_line_t {
  103. tor_addr_t addr; /* The IP address of the bridge. */
  104. uint16_t port; /* The TCP port of the bridge. */
  105. char *transport_name; /* The name of the pluggable transport that
  106. should be used to connect to the bridge. */
  107. char digest[DIGEST_LEN]; /* The bridge's identity key digest. */
  108. smartlist_t *socks_args; /* SOCKS arguments for the pluggable
  109. transport proxy. */
  110. } bridge_line_t;
  111. void bridge_line_free(bridge_line_t *bridge_line);
  112. bridge_line_t *parse_bridge_line(const char *line);
  113. smartlist_t *get_options_from_transport_options_line(const char *line,
  114. const char *transport);
  115. smartlist_t *get_options_for_server_transport(const char *transport);
  116. #ifdef CONFIG_PRIVATE
  117. #ifdef TOR_UNIT_TESTS
  118. extern struct config_format_t options_format;
  119. #endif
  120. STATIC void or_options_free(or_options_t *options);
  121. STATIC int options_validate(or_options_t *old_options,
  122. or_options_t *options,
  123. or_options_t *default_options,
  124. int from_setconf, char **msg);
  125. STATIC int parse_transport_line(const or_options_t *options,
  126. const char *line, int validate_only,
  127. int server);
  128. STATIC int consider_adding_dir_servers(const or_options_t *options,
  129. const or_options_t *old_options);
  130. MOCK_DECL(STATIC void, add_default_fallback_dir_servers, (void));
  131. STATIC int
  132. parse_dir_fallback_line(const char *line,
  133. int validate_only);
  134. #endif
  135. #endif