config.h 11 KB

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