config.h 12 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275
  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 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. #if defined(__FreeBSD__) || defined(__FreeBSD_kernel__) || defined(DARWIN)
  14. #define KERNEL_MAY_SUPPORT_IPFW
  15. #endif
  16. /** Lowest allowable value for HeartbeatPeriod; if this is too low, we might
  17. * expose more information than we're comfortable with. */
  18. #define MIN_HEARTBEAT_PERIOD (30*60)
  19. /** Maximum default value for MaxMemInQueues, in bytes. */
  20. #if SIZEOF_VOID_P >= 8
  21. #define MAX_DEFAULT_MEMORY_QUEUE_SIZE (U64_LITERAL(8) << 30)
  22. #else
  23. #define MAX_DEFAULT_MEMORY_QUEUE_SIZE (U64_LITERAL(2) << 30)
  24. #endif
  25. MOCK_DECL(const char*, get_dirportfrontpage, (void));
  26. MOCK_DECL(const or_options_t *, get_options, (void));
  27. MOCK_DECL(or_options_t *, get_options_mutable, (void));
  28. int set_options(or_options_t *new_val, char **msg);
  29. void config_free_all(void);
  30. const char *safe_str_client(const char *address);
  31. const char *safe_str(const char *address);
  32. const char *escaped_safe_str_client(const char *address);
  33. const char *escaped_safe_str(const char *address);
  34. void init_protocol_warning_severity_level(void);
  35. int get_protocol_warning_severity_level(void);
  36. const char *get_version(void);
  37. const char *get_short_version(void);
  38. setopt_err_t options_trial_assign(config_line_t *list, unsigned flags,
  39. char **msg);
  40. uint32_t get_last_resolved_addr(void);
  41. void reset_last_resolved_addr(void);
  42. int resolve_my_address(int warn_severity, const or_options_t *options,
  43. uint32_t *addr_out,
  44. const char **method_out, char **hostname_out);
  45. MOCK_DECL(int, is_local_addr, (const tor_addr_t *addr));
  46. void options_init(or_options_t *options);
  47. #define OPTIONS_DUMP_MINIMAL 1
  48. #define OPTIONS_DUMP_DEFAULTS 2
  49. #define OPTIONS_DUMP_ALL 3
  50. char *options_dump(const or_options_t *options, int how_to_dump);
  51. int options_init_from_torrc(int argc, char **argv);
  52. setopt_err_t options_init_from_string(const char *cf_defaults, const char *cf,
  53. int command, const char *command_arg, char **msg);
  54. int option_is_recognized(const char *key);
  55. const char *option_get_canonical_name(const char *key);
  56. config_line_t *option_get_assignment(const or_options_t *options,
  57. const char *key);
  58. int options_save_current(void);
  59. const char *get_torrc_fname(int defaults_fname);
  60. typedef enum {
  61. DIRROOT_DATADIR,
  62. DIRROOT_CACHEDIR,
  63. DIRROOT_KEYDIR
  64. } directory_root_t;
  65. MOCK_DECL(char *,
  66. options_get_dir_fname2_suffix,
  67. (const or_options_t *options,
  68. directory_root_t roottype,
  69. const char *sub1, const char *sub2,
  70. const char *suffix));
  71. /* These macros wrap options_get_dir_fname2_suffix to provide a more
  72. * convenient API for finding filenames that Tor uses inside its storage
  73. * They are named according to a pattern:
  74. * (options_)?get_(cache|key|data)dir_fname(2)?(_suffix)?
  75. *
  76. * Macros that begin with options_ take an options argument; the others
  77. * work with respect to the global options.
  78. *
  79. * Each macro works relative to the data directory, the key directory,
  80. * or the cache directory, as determined by which one is mentioned.
  81. *
  82. * Macro variants with "2" in their name take two path components; others
  83. * take one.
  84. *
  85. * Macro variants with "_suffix" at the end take an additional suffix
  86. * that gets appended to the end of the file
  87. */
  88. #define options_get_datadir_fname2_suffix(options, sub1, sub2, suffix) \
  89. options_get_dir_fname2_suffix((options), DIRROOT_DATADIR, \
  90. (sub1), (sub2), (suffix))
  91. #define options_get_cachedir_fname2_suffix(options, sub1, sub2, suffix) \
  92. options_get_dir_fname2_suffix((options), DIRROOT_CACHEDIR, \
  93. (sub1), (sub2), (suffix))
  94. #define options_get_keydir_fname2_suffix(options, sub1, sub2, suffix) \
  95. options_get_dir_fname2_suffix((options), DIRROOT_KEYDIR, \
  96. (sub1), (sub2), (suffix))
  97. #define options_get_datadir_fname(opts,sub1) \
  98. options_get_datadir_fname2_suffix((opts),(sub1), NULL, NULL)
  99. #define options_get_datadir_fname2(opts,sub1,sub2) \
  100. options_get_datadir_fname2_suffix((opts),(sub1), (sub2), NULL)
  101. #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
  102. options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
  103. #define get_datadir_fname(sub1) \
  104. get_datadir_fname2_suffix((sub1), NULL, NULL)
  105. #define get_datadir_fname2(sub1,sub2) \
  106. get_datadir_fname2_suffix((sub1), (sub2), NULL)
  107. #define get_datadir_fname_suffix(sub1, suffix) \
  108. get_datadir_fname2_suffix((sub1), NULL, (suffix))
  109. /** DOCDOC */
  110. #define options_get_keydir_fname(options, sub1) \
  111. options_get_keydir_fname2_suffix((options), (sub1), NULL, NULL)
  112. #define get_keydir_fname_suffix(sub1, suffix) \
  113. options_get_keydir_fname2_suffix(get_options(), (sub1), NULL, suffix)
  114. #define get_keydir_fname(sub1) \
  115. options_get_keydir_fname2_suffix(get_options(), (sub1), NULL, NULL)
  116. #define get_cachedir_fname(sub1) \
  117. options_get_cachedir_fname2_suffix(get_options(), (sub1), NULL, NULL)
  118. #define get_cachedir_fname_suffix(sub1, suffix) \
  119. options_get_cachedir_fname2_suffix(get_options(), (sub1), NULL, (suffix))
  120. int using_default_dir_authorities(const or_options_t *options);
  121. int create_keys_directory(const or_options_t *options);
  122. int check_or_create_data_subdir(const char *subdir);
  123. int write_to_data_subdir(const char* subdir, const char* fname,
  124. const char* str, const char* descr);
  125. int get_num_cpus(const or_options_t *options);
  126. MOCK_DECL(const smartlist_t *,get_configured_ports,(void));
  127. int get_first_advertised_port_by_type_af(int listener_type,
  128. int address_family);
  129. #define get_primary_or_port() \
  130. (get_first_advertised_port_by_type_af(CONN_TYPE_OR_LISTENER, AF_INET))
  131. #define get_primary_dir_port() \
  132. (get_first_advertised_port_by_type_af(CONN_TYPE_DIR_LISTENER, AF_INET))
  133. const tor_addr_t *get_first_advertised_addr_by_type_af(int listener_type,
  134. int address_family);
  135. int port_exists_by_type_addr_port(int listener_type, const tor_addr_t *addr,
  136. int port, int check_wildcard);
  137. int port_exists_by_type_addr32h_port(int listener_type, uint32_t addr_ipv4h,
  138. int port, int check_wildcard);
  139. char *get_first_listener_addrport_string(int listener_type);
  140. int options_need_geoip_info(const or_options_t *options,
  141. const char **reason_out);
  142. smartlist_t *get_list_of_ports_to_forward(void);
  143. int getinfo_helper_config(control_connection_t *conn,
  144. const char *question, char **answer,
  145. const char **errmsg);
  146. uint32_t get_effective_bwrate(const or_options_t *options);
  147. uint32_t get_effective_bwburst(const or_options_t *options);
  148. char *get_transport_bindaddr_from_config(const char *transport);
  149. int init_cookie_authentication(const char *fname, const char *header,
  150. int cookie_len, int group_readable,
  151. uint8_t **cookie_out, int *cookie_is_set_out);
  152. or_options_t *options_new(void);
  153. int config_parse_commandline(int argc, char **argv, int ignore_errors,
  154. config_line_t **result,
  155. config_line_t **cmdline_result);
  156. void config_register_addressmaps(const or_options_t *options);
  157. /* XXXX move to connection_edge.h */
  158. int addressmap_register_auto(const char *from, const char *to,
  159. time_t expires,
  160. addressmap_entry_source_t addrmap_source,
  161. const char **msg);
  162. int port_cfg_line_extract_addrport(const char *line,
  163. char **addrport_out,
  164. int *is_unix_out,
  165. const char **rest_out);
  166. /** Represents the information stored in a torrc Bridge line. */
  167. typedef struct bridge_line_t {
  168. tor_addr_t addr; /* The IP address of the bridge. */
  169. uint16_t port; /* The TCP port of the bridge. */
  170. char *transport_name; /* The name of the pluggable transport that
  171. should be used to connect to the bridge. */
  172. char digest[DIGEST_LEN]; /* The bridge's identity key digest. */
  173. smartlist_t *socks_args; /* SOCKS arguments for the pluggable
  174. transport proxy. */
  175. } bridge_line_t;
  176. void bridge_line_free_(bridge_line_t *bridge_line);
  177. #define bridge_line_free(line) \
  178. FREE_AND_NULL(bridge_line_t, bridge_line_free_, (line))
  179. bridge_line_t *parse_bridge_line(const char *line);
  180. smartlist_t *get_options_from_transport_options_line(const char *line,
  181. const char *transport);
  182. smartlist_t *get_options_for_server_transport(const char *transport);
  183. #ifdef CONFIG_PRIVATE
  184. #define CL_PORT_NO_STREAM_OPTIONS (1u<<0)
  185. #define CL_PORT_WARN_NONLOCAL (1u<<1)
  186. /* Was CL_PORT_ALLOW_EXTRA_LISTENADDR (1u<<2) */
  187. #define CL_PORT_SERVER_OPTIONS (1u<<3)
  188. #define CL_PORT_FORBID_NONLOCAL (1u<<4)
  189. #define CL_PORT_TAKES_HOSTNAMES (1u<<5)
  190. #define CL_PORT_IS_UNIXSOCKET (1u<<6)
  191. #define CL_PORT_DFLT_GROUP_WRITABLE (1u<<7)
  192. STATIC int options_act(const or_options_t *old_options);
  193. #ifdef TOR_UNIT_TESTS
  194. extern struct config_format_t options_format;
  195. #endif
  196. STATIC port_cfg_t *port_cfg_new(size_t namelen);
  197. #define port_cfg_free(port) \
  198. FREE_AND_NULL(port_cfg_t, port_cfg_free_, (port))
  199. STATIC void port_cfg_free_(port_cfg_t *port);
  200. #define or_options_free(opt) \
  201. FREE_AND_NULL(or_options_t, or_options_free_, (opt))
  202. STATIC void or_options_free_(or_options_t *options);
  203. STATIC int options_validate_single_onion(or_options_t *options,
  204. char **msg);
  205. STATIC int options_validate(or_options_t *old_options,
  206. or_options_t *options,
  207. or_options_t *default_options,
  208. int from_setconf, char **msg);
  209. STATIC int parse_transport_line(const or_options_t *options,
  210. const char *line, int validate_only,
  211. int server);
  212. STATIC int consider_adding_dir_servers(const or_options_t *options,
  213. const or_options_t *old_options);
  214. STATIC void add_default_trusted_dir_authorities(dirinfo_type_t type);
  215. MOCK_DECL(STATIC void, add_default_fallback_dir_servers, (void));
  216. STATIC int parse_dir_authority_line(const char *line,
  217. dirinfo_type_t required_type,
  218. int validate_only);
  219. STATIC int parse_dir_fallback_line(const char *line, int validate_only);
  220. STATIC int have_enough_mem_for_dircache(const or_options_t *options,
  221. size_t total_mem, char **msg);
  222. STATIC int parse_port_config(smartlist_t *out,
  223. const config_line_t *ports,
  224. const char *portname,
  225. int listener_type,
  226. const char *defaultaddr,
  227. int defaultport,
  228. const unsigned flags);
  229. STATIC int check_bridge_distribution_setting(const char *bd);
  230. STATIC uint64_t compute_real_max_mem_in_queues(const uint64_t val,
  231. int log_guess);
  232. #endif /* defined(CONFIG_PRIVATE) */
  233. #endif /* !defined(TOR_CONFIG_H) */