config.h 8.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197
  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-2016, 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. MOCK_DECL(const char*, get_dirportfrontpage, (void));
  17. MOCK_DECL(const or_options_t *, get_options, (void));
  18. MOCK_DECL(or_options_t *, get_options_mutable, (void));
  19. int set_options(or_options_t *new_val, char **msg);
  20. void config_free_all(void);
  21. const char *safe_str_client(const char *address);
  22. const char *safe_str(const char *address);
  23. const char *escaped_safe_str_client(const char *address);
  24. const char *escaped_safe_str(const char *address);
  25. const char *get_version(void);
  26. const char *get_short_version(void);
  27. setopt_err_t options_trial_assign(config_line_t *list, unsigned flags,
  28. char **msg);
  29. uint32_t get_last_resolved_addr(void);
  30. void reset_last_resolved_addr(void);
  31. int resolve_my_address(int warn_severity, const or_options_t *options,
  32. uint32_t *addr_out,
  33. const char **method_out, char **hostname_out);
  34. MOCK_DECL(int, is_local_addr, (const tor_addr_t *addr));
  35. void options_init(or_options_t *options);
  36. #define OPTIONS_DUMP_MINIMAL 1
  37. #define OPTIONS_DUMP_DEFAULTS 2
  38. #define OPTIONS_DUMP_ALL 3
  39. char *options_dump(const or_options_t *options, int how_to_dump);
  40. int options_init_from_torrc(int argc, char **argv);
  41. setopt_err_t options_init_from_string(const char *cf_defaults, const char *cf,
  42. int command, const char *command_arg, char **msg);
  43. int option_is_recognized(const char *key);
  44. const char *option_get_canonical_name(const char *key);
  45. config_line_t *option_get_assignment(const or_options_t *options,
  46. const char *key);
  47. int options_save_current(void);
  48. const char *get_torrc_fname(int defaults_fname);
  49. MOCK_DECL(char *,
  50. options_get_datadir_fname2_suffix,
  51. (const or_options_t *options,
  52. const char *sub1, const char *sub2,
  53. const char *suffix));
  54. #define get_datadir_fname2_suffix(sub1, sub2, suffix) \
  55. options_get_datadir_fname2_suffix(get_options(), (sub1), (sub2), (suffix))
  56. /** Return a newly allocated string containing datadir/sub1. See
  57. * get_datadir_fname2_suffix. */
  58. #define get_datadir_fname(sub1) get_datadir_fname2_suffix((sub1), NULL, NULL)
  59. /** Return a newly allocated string containing datadir/sub1/sub2. See
  60. * get_datadir_fname2_suffix. */
  61. #define get_datadir_fname2(sub1,sub2) \
  62. get_datadir_fname2_suffix((sub1), (sub2), NULL)
  63. /** Return a newly allocated string containing datadir/sub1/sub2 relative to
  64. * opts. See get_datadir_fname2_suffix. */
  65. #define options_get_datadir_fname2(opts,sub1,sub2) \
  66. options_get_datadir_fname2_suffix((opts),(sub1), (sub2), NULL)
  67. /** Return a newly allocated string containing datadir/sub1suffix. See
  68. * get_datadir_fname2_suffix. */
  69. #define get_datadir_fname_suffix(sub1, suffix) \
  70. get_datadir_fname2_suffix((sub1), NULL, (suffix))
  71. int check_or_create_data_subdir(const char *subdir);
  72. int write_to_data_subdir(const char* subdir, const char* fname,
  73. const char* str, const char* descr);
  74. int get_num_cpus(const or_options_t *options);
  75. MOCK_DECL(const smartlist_t *,get_configured_ports,(void));
  76. int get_first_advertised_port_by_type_af(int listener_type,
  77. int address_family);
  78. #define get_primary_or_port() \
  79. (get_first_advertised_port_by_type_af(CONN_TYPE_OR_LISTENER, AF_INET))
  80. #define get_primary_dir_port() \
  81. (get_first_advertised_port_by_type_af(CONN_TYPE_DIR_LISTENER, AF_INET))
  82. const tor_addr_t *get_first_advertised_addr_by_type_af(int listener_type,
  83. int address_family);
  84. int port_exists_by_type_addr_port(int listener_type, const tor_addr_t *addr,
  85. int port, int check_wildcard);
  86. int port_exists_by_type_addr32h_port(int listener_type, uint32_t addr_ipv4h,
  87. int port, int check_wildcard);
  88. char *get_first_listener_addrport_string(int listener_type);
  89. int options_need_geoip_info(const or_options_t *options,
  90. const char **reason_out);
  91. smartlist_t *get_list_of_ports_to_forward(void);
  92. int getinfo_helper_config(control_connection_t *conn,
  93. const char *question, char **answer,
  94. const char **errmsg);
  95. uint32_t get_effective_bwrate(const or_options_t *options);
  96. uint32_t get_effective_bwburst(const or_options_t *options);
  97. char *get_transport_bindaddr_from_config(const char *transport);
  98. int init_cookie_authentication(const char *fname, const char *header,
  99. int cookie_len, int group_readable,
  100. uint8_t **cookie_out, int *cookie_is_set_out);
  101. or_options_t *options_new(void);
  102. int config_parse_commandline(int argc, char **argv, int ignore_errors,
  103. config_line_t **result,
  104. config_line_t **cmdline_result);
  105. void config_register_addressmaps(const or_options_t *options);
  106. /* XXXX move to connection_edge.h */
  107. int addressmap_register_auto(const char *from, const char *to,
  108. time_t expires,
  109. addressmap_entry_source_t addrmap_source,
  110. const char **msg);
  111. int config_parse_unix_port(const char *addrport, char **path_out);
  112. /** Represents the information stored in a torrc Bridge line. */
  113. typedef struct bridge_line_t {
  114. tor_addr_t addr; /* The IP address of the bridge. */
  115. uint16_t port; /* The TCP port of the bridge. */
  116. char *transport_name; /* The name of the pluggable transport that
  117. should be used to connect to the bridge. */
  118. char digest[DIGEST_LEN]; /* The bridge's identity key digest. */
  119. smartlist_t *socks_args; /* SOCKS arguments for the pluggable
  120. transport proxy. */
  121. } bridge_line_t;
  122. void bridge_line_free(bridge_line_t *bridge_line);
  123. bridge_line_t *parse_bridge_line(const char *line);
  124. smartlist_t *get_options_from_transport_options_line(const char *line,
  125. const char *transport);
  126. smartlist_t *get_options_for_server_transport(const char *transport);
  127. #ifdef CONFIG_PRIVATE
  128. #define CL_PORT_NO_STREAM_OPTIONS (1u<<0)
  129. #define CL_PORT_WARN_NONLOCAL (1u<<1)
  130. #define CL_PORT_ALLOW_EXTRA_LISTENADDR (1u<<2)
  131. #define CL_PORT_SERVER_OPTIONS (1u<<3)
  132. #define CL_PORT_FORBID_NONLOCAL (1u<<4)
  133. #define CL_PORT_TAKES_HOSTNAMES (1u<<5)
  134. #define CL_PORT_IS_UNIXSOCKET (1u<<6)
  135. #define CL_PORT_DFLT_GROUP_WRITABLE (1u<<7)
  136. STATIC int options_act(const or_options_t *old_options);
  137. #ifdef TOR_UNIT_TESTS
  138. extern struct config_format_t options_format;
  139. #endif
  140. STATIC port_cfg_t *port_cfg_new(size_t namelen);
  141. STATIC void port_cfg_free(port_cfg_t *port);
  142. STATIC void or_options_free(or_options_t *options);
  143. STATIC int options_validate(or_options_t *old_options,
  144. or_options_t *options,
  145. or_options_t *default_options,
  146. int from_setconf, char **msg);
  147. STATIC int parse_transport_line(const or_options_t *options,
  148. const char *line, int validate_only,
  149. int server);
  150. STATIC int consider_adding_dir_servers(const or_options_t *options,
  151. const or_options_t *old_options);
  152. STATIC void add_default_trusted_dir_authorities(dirinfo_type_t type);
  153. MOCK_DECL(STATIC void, add_default_fallback_dir_servers, (void));
  154. STATIC int parse_dir_authority_line(const char *line,
  155. dirinfo_type_t required_type,
  156. int validate_only);
  157. STATIC int parse_dir_fallback_line(const char *line, int validate_only);
  158. STATIC int have_enough_mem_for_dircache(const or_options_t *options,
  159. size_t total_mem, char **msg);
  160. STATIC int parse_port_config(smartlist_t *out,
  161. const config_line_t *ports,
  162. const config_line_t *listenaddrs,
  163. const char *portname,
  164. int listener_type,
  165. const char *defaultaddr,
  166. int defaultport,
  167. const unsigned flags);
  168. #endif
  169. #endif