src/or/config.h

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