config.h 6.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151
  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/sub1suffix. See
  59. * get_datadir_fname2_suffix. */
  60. #define get_datadir_fname_suffix(sub1, suffix) \
  61. get_datadir_fname2_suffix((sub1), NULL, (suffix))
  62. int check_or_create_data_subdir(const char *subdir);
  63. int write_to_data_subdir(const char* subdir, const char* fname,
  64. const char* str, const char* descr);
  65. int get_num_cpus(const or_options_t *options);
  66. const smartlist_t *get_configured_ports(void);
  67. int get_first_advertised_port_by_type_af(int listener_type,
  68. int address_family);
  69. #define get_primary_or_port() \
  70. (get_first_advertised_port_by_type_af(CONN_TYPE_OR_LISTENER, AF_INET))
  71. #define get_primary_dir_port() \
  72. (get_first_advertised_port_by_type_af(CONN_TYPE_DIR_LISTENER, AF_INET))
  73. char *get_first_listener_addrport_string(int listener_type);
  74. int options_need_geoip_info(const or_options_t *options,
  75. const char **reason_out);
  76. smartlist_t *get_list_of_ports_to_forward(void);
  77. int getinfo_helper_config(control_connection_t *conn,
  78. const char *question, char **answer,
  79. const char **errmsg);
  80. const char *tor_get_digests(void);
  81. uint32_t get_effective_bwrate(const or_options_t *options);
  82. uint32_t get_effective_bwburst(const or_options_t *options);
  83. char *get_transport_bindaddr_from_config(const char *transport);
  84. int init_cookie_authentication(const char *fname, const char *header,
  85. int cookie_len, int group_readable,
  86. uint8_t **cookie_out, int *cookie_is_set_out);
  87. or_options_t *options_new(void);
  88. int config_parse_commandline(int argc, char **argv, int ignore_errors,
  89. config_line_t **result,
  90. config_line_t **cmdline_result);
  91. void config_register_addressmaps(const or_options_t *options);
  92. /* XXXX024 move to connection_edge.h */
  93. int addressmap_register_auto(const char *from, const char *to,
  94. time_t expires,
  95. addressmap_entry_source_t addrmap_source,
  96. const char **msg);
  97. int config_parse_unix_port(const char *addrport, char **path_out);
  98. /** Represents the information stored in a torrc Bridge line. */
  99. typedef struct bridge_line_t {
  100. tor_addr_t addr; /* The IP address of the bridge. */
  101. uint16_t port; /* The TCP port of the bridge. */
  102. char *transport_name; /* The name of the pluggable transport that
  103. should be used to connect to the bridge. */
  104. char digest[DIGEST_LEN]; /* The bridge's identity key digest. */
  105. smartlist_t *socks_args; /* SOCKS arguments for the pluggable
  106. transport proxy. */
  107. } bridge_line_t;
  108. void bridge_line_free(bridge_line_t *bridge_line);
  109. bridge_line_t *parse_bridge_line(const char *line);
  110. smartlist_t *get_options_from_transport_options_line(const char *line,
  111. const char *transport);
  112. smartlist_t *get_options_for_server_transport(const char *transport);
  113. #ifdef CONFIG_PRIVATE
  114. #ifdef TOR_UNIT_TESTS
  115. extern struct config_format_t options_format;
  116. #endif
  117. STATIC void or_options_free(or_options_t *options);
  118. STATIC int options_validate(or_options_t *old_options,
  119. or_options_t *options,
  120. or_options_t *default_options,
  121. int from_setconf, char **msg);
  122. STATIC int parse_transport_line(const or_options_t *options,
  123. const char *line, int validate_only,
  124. int server);
  125. #endif
  126. #endif