config.c 116 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright 2001 Matej Pfajfar.
 * Copyright 2001-2004 Roger Dingledine.
Nick Mathewson's avatar
Nick Mathewson committed
3
 * Copyright 2004-2005 Roger Dingledine, Nick Mathewson. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
7
const char config_c_id[] = \
  "$Id$";
8

Nick Mathewson's avatar
Nick Mathewson committed
9
/**
10
11
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
12
13
 **/

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
15
16
17
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
18
#include "../common/aes.h"
Roger Dingledine's avatar
Roger Dingledine committed
19

Nick Mathewson's avatar
Nick Mathewson committed
20
21
/** Enumeration of types which option values can take */
typedef enum config_type_t {
22
23
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
24
25
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
26
27
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
28
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formated time relative to GMT. */
29
30
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
31
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
32
33
34
35
36
  CONFIG_TYPE_LINELIST_S,   /**< Uninterpreted, context-sensitive config lines,
                             * mixed with other keywords. */
  CONFIG_TYPE_LINELIST_V,   /**< Catch-all "virtual" option to summarize
                             * context-sensitive config lines when fetching.
                             */
37
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
38
} config_type_t;
39

40
/** An abbreviation for a configuration option allowed on the command line. */
41
typedef struct config_abbrev_t {
42
43
  const char *abbreviated;
  const char *full;
44
  int commandline_only;
45
  int warn;
46
47
} config_abbrev_t;

48
49
/* Handy macro for declaring "In the config file or on the command line,
 * you can abbreviate <b>tok</b>s as <b>tok</b>". */
50
#define PLURAL(tok) { #tok, #tok "s", 0, 0 }
51

Nick Mathewson's avatar
Nick Mathewson committed
52
/* A list of command-line abbreviations. */
53
static config_abbrev_t _option_abbrevs[] = {
54
  PLURAL(ExitNode),
55
  PLURAL(EntryNode),
56
57
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
58
  PLURAL(LongLivedPort),
59
60
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
61
  PLURAL(NumCpu),
62
63
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
64
65
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
66
  { "l", "Log", 1, 0},
67
68
69
70
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
71
72
73
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
74
75
76
77
78
79
80
81
82
  { "UseHelperNodes", "UseEntryNodes", 0, 0},
  { "NumHelperNodes", "NumEntryNodes", 0, 0},
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
  { "HelperNode", "EntryNode", 0, 0},
  { "HelperNodeDownSince", "EntryNodeDownSince", 0, 0},
  { "HelperNodeUnlistedSince", "EntryNodeUnlistedSince", 0, 0},
83
  { NULL, NULL, 0, 0},
84
};
85
#undef PLURAL
86

87
/** A variable allowed in the configuration file or on the command line. */
88
typedef struct config_var_t {
89
  const char *name; /**< The full keyword (case insensitive). */
90
91
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
92
93
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
94
  const char *description;
95
96
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
97
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
98
99
#define STRUCT_OFFSET(tp, member) \
  ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
Nick Mathewson's avatar
Nick Mathewson committed
100
101
102
103
/** An entry for config_vars: "The option <b>name</b> has type
 * CONFIG_TYPE_<b>conftype</b>, and corresponds to
 * or_options_t.<b>member</b>"
 */
104
105
106
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
      initvalue, NULL }
Nick Mathewson's avatar
Nick Mathewson committed
107
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
108
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL, NULL }
109

Nick Mathewson's avatar
Nick Mathewson committed
110
111
112
113
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
114
static config_var_t _option_vars[] = {
Roger Dingledine's avatar
Roger Dingledine committed
115
  VAR("AccountingMax",       MEMUNIT,  AccountingMax,        "0 bytes"),
Nick Mathewson's avatar
Nick Mathewson committed
116
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
117
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
118
  VAR("Address",             STRING,   Address,              NULL),
119
120
  VAR("AllowUnverifiedNodes",CSV,      AllowUnverifiedNodes,
                                                        "middle,rendezvous"),
121
  VAR("AssumeReachable",     BOOL,     AssumeReachable,      "0"),
122
123
  VAR("AuthDirInvalid",      LINELIST, AuthDirInvalid,       NULL),
  VAR("AuthDirReject",       LINELIST, AuthDirReject,        NULL),
124
  VAR("AuthDirRejectUnlisted",BOOL,    AuthDirRejectUnlisted,"0"),
125
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
126
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "5 MB"),
Nick Mathewson's avatar
Nick Mathewson committed
127
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "2 MB"),
128
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
Nick Mathewson's avatar
Nick Mathewson committed
129
  VAR("ConnLimit",           UINT,     ConnLimit,            "1024"),
130
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
131
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
132
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
133
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
Nick Mathewson's avatar
Nick Mathewson committed
134
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
135
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
136
137
138
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
  /* if DirFetchPeriod is 0, see get_dir_fetch_period() in main.c */
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "0 seconds"),
139
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
140
  VAR("DirPort",             UINT,     DirPort,              "0"),
141
  OBSOLETE("DirPostPeriod"),
142
143
144
  VAR("DirServer",           LINELIST, DirServers,           NULL),
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
145
146
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
147
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
148
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
149
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
150
  VAR("Group",               STRING,   Group,                NULL),
Nick Mathewson's avatar
Nick Mathewson committed
151
  VAR("HardwareAccel",       BOOL,     HardwareAccel,        "1"),
152
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
153
154
155
156
157
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceExcludeNodes", LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceNodes",  LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
158
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
159
  VAR("HttpProxyAuthenticator",STRING, HttpProxyAuthenticator,NULL),
160
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
161
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
162
  OBSOLETE("IgnoreVersion"),
163
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
164
  VAR("Log",                 LINELIST, Logs,                 NULL),
165
  OBSOLETE("LinkPadding"),
Nick Mathewson's avatar
Nick Mathewson committed
166
167
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
168
169
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
                         "21,22,706,1863,5050,5190,5222,5223,6667,8300,8888"),
Nick Mathewson's avatar
Nick Mathewson committed
170
171
172
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"128 TB"),
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
173
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
174
  OBSOLETE("MonthlyAccountingStart"),
Nick Mathewson's avatar
Nick Mathewson committed
175
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
176
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
177
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
Nick Mathewson's avatar
Nick Mathewson committed
178
179
180
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
181
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
182
183
  VAR("NumEntryNodes",       UINT,     NumEntryNodes,        "3"),
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
184
  VAR("ORPort",              UINT,     ORPort,               "0"),
185
186
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
Nick Mathewson's avatar
Nick Mathewson committed
187
  VAR("PidFile",             STRING,   PidFile,              NULL),
188
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
189
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
Nick Mathewson's avatar
Nick Mathewson committed
190
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
191
192
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
193
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
194
195
196
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "20 minutes"),
197
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
198
  OBSOLETE("RouterFile"),
199
200
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
201
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
202
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
203
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
204
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
205
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
206
207
  /* if StatusFetchPeriod is 0, see get_status_fetch_period() in main.c */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "0 seconds"),
Nick Mathewson's avatar
Nick Mathewson committed
208
209
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
210
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
211
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
Nick Mathewson's avatar
Nick Mathewson committed
212
213
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
214
  OBSOLETE("TrafficShaping"),
215
  VAR("UseEntryNodes",       BOOL,     UseEntryNodes,        "0"),
Nick Mathewson's avatar
Nick Mathewson committed
216
  VAR("User",                STRING,   User,                 NULL),
217
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
218
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
219
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
220
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL, NULL }
221
};
222
223
#undef VAR

224
225
226
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
      initvalue, NULL }
227
static config_var_t _state_vars[] = {
228
229
  VAR("AccountingBytesReadInterval", MEMUNIT,
      AccountingBytesReadInInterval, NULL),
230
231
232
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
233
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
234
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
235
236
237
238
  VAR("EntryNode",               LINELIST_S,  EntryNodes,           NULL),
  VAR("EntryNodeDownSince",      LINELIST_S,  EntryNodes,           NULL),
  VAR("EntryNodeUnlistedSince",  LINELIST_S,  EntryNodes,           NULL),
  VAR("EntryNodes",              LINELIST_V,  EntryNodes,           NULL),
Nick Mathewson's avatar
Nick Mathewson committed
239

240
241
242
243
244
245
246
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  NULL),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    NULL),
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, NULL),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   NULL),

247
248
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

249
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL, NULL }
250
251
};

252
253
254
#undef VAR
#undef OBSOLETE

255
256
257
258
259
260
261
/** DOCDOC*/
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
262
  { "Address", "The advertised (external) address we should use." },
263
264
265
266
267
268
269
270
271
272
273
274
275
  // { "AccountingStart", ""},
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
  { "HelperNode", "One of the nodes we have chosen as a fixed entry" },
  { "HelperNodeDownSince",
    "The last helper node has been down since this time." },
  { "HelperNodeUnlistedSince",
    "The last helper node has been unlisted since this time." },
  { NULL, NULL },
};

276
typedef int (*validate_fn_t)(void*,void*);
277

278
279
280
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
281
282
283
284
285
286
287
typedef struct {
  size_t size;
  uint32_t magic;
  off_t magic_offset;
  config_abbrev_t *abbrevs;
  config_var_t *vars;
  validate_fn_t validate_fn;
288
  config_var_description_t *descriptions;
289
290
291
292
} config_format_t;

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
293
294
    tor_assert((fmt)->magic ==                                          \
               *(uint32_t*)(((char*)(cfg))+fmt->magic_offset));         \
295
296
  } while (0)

Nick Mathewson's avatar
Nick Mathewson committed
297
/** Largest allowed config line */
298
#define CONFIG_LINE_T_MAXLEN 4096
299

300
static void config_line_append(config_line_t **lst,
301
                               const char *key, const char *val);
302
303
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
304
static void option_reset(config_format_t *fmt, or_options_t *options,
305
                         config_var_t *var, int use_defaults);
306
static void config_free(config_format_t *fmt, void *options);
307
static int option_is_same(config_format_t *fmt,
308
309
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
310
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
311
312
static int options_validate(or_options_t *old_options,
                            or_options_t *options);
313
static int options_act_reversible(or_options_t *old_options);
314
static int options_act(or_options_t *old_options);
315
static int options_transition_allowed(or_options_t *old, or_options_t *new);
316
317
318
319
static int options_transition_affects_workers(or_options_t *old_options,
                                              or_options_t *new_options);
static int options_transition_affects_descriptor(or_options_t *old_options,
                                                 or_options_t *new_options);
320
static int check_nickname_list(const char *lst, const char *name);
321
static void config_register_addressmaps(or_options_t *options);
322

323
static int parse_dir_server_line(const char *line, int validate_only);
324
static int parse_redirect_line(smartlist_t *result,
325
                               config_line_t *line);
326
327
328
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
static int convert_log_option(or_options_t *options,
329
330
                              config_line_t *level_opt,
                              config_line_t *file_opt, int isDaemon);
331
332
333
334
static int add_single_log_option(or_options_t *options, int minSeverity,
                                 int maxSeverity,
                                 const char *type, const char *fname);
static int normalize_log_options(or_options_t *options);
335
static int validate_data_directory(or_options_t *options);
336
static int write_configuration_file(const char *fname, or_options_t *options);
337
static config_line_t *get_assigned_option(config_format_t *fmt,
338
                                     or_options_t *options, const char *key);
339
static void config_init(config_format_t *fmt, void *options);
340
static int or_state_validate(or_state_t *old_options, or_state_t *options);
341

342
343
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
344
static void print_cvs_version(void);
345
static void parse_reachable_addresses(void);
346
static int init_libevent(void);
347
static int opt_streq(const char *s1, const char *s2);
348
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
349
static void check_libevent_version(const char *m, const char *v, int server);
350
#endif
351

352
353
/*static*/ or_options_t *options_new(void);

354
355
#define OR_OPTIONS_MAGIC 9090909

356
static config_format_t options_format = {
357
358
359
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
360
361
362
363
364
365
366
367
368
369
370
371
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
  options_description
};

#define OR_STATE_MAGIC 0x57A73f57

static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
372
  _state_abbrevs,
373
374
375
  _state_vars,
  (validate_fn_t)or_state_validate,
  state_description
376
377
};

378
379
380
381
382
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
383
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
384
/** Name of most recently read torrc file. */
385
static char *torrc_fname = NULL;
386
387
/** Persistant serialized state. */
static or_state_t *global_state = NULL;
388
389
/** DOCDOC */
static addr_policy_t *reachable_addr_policy = NULL;
390

391
392
393
394
395
396
397
398
399
static void *
config_alloc(config_format_t *fmt)
{
  void *opts = opts = tor_malloc_zero(fmt->size);
  *(uint32_t*)(((char*)opts)+fmt->magic_offset) = fmt->magic;
  CHECK(fmt, opts);
  return opts;
}

400
401
/** Return the currently configured options. */
or_options_t *
402
403
get_options(void)
{
404
405
406
  tor_assert(global_options);
  return global_options;
}
407

408
409
410
/** Change the current global options to contain <b>new_val</b> instead of
 * their current value; take action based on the new value; free the old value
 * as necessary.
411
 */
412
int
413
414
set_options(or_options_t *new_val)
{
415
  or_options_t *old_options = global_options;
416
  global_options = new_val;
417
418
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
419
420
421
422
  if (options_act_reversible(old_options)<0) {
    global_options = old_options;
    return -1;
  }
423
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
424
425
    err(LD_CONFIG,
        "Acting on config options left us in a broken state. Dying.");
426
427
428
    exit(1);
  }
  if (old_options)
429
    config_free(&options_format, old_options);
430
431

  return 0;
432
433
}

434
435
436
void
config_free_all(void)
{
437
438
439
440
441
442
443
444
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
445
  tor_free(torrc_fname);
446
447
448
449
  if (reachable_addr_policy) {
    addr_policy_free(reachable_addr_policy);
    reachable_addr_policy = NULL;
  }
450
451
}

452
453
454
455
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
456
457
safe_str(const char *address)
{
458
459
460
461
462
463
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

464
465
466
467
468
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
  const char *dirservers[] = {
469
470
471
472
473
"moria1 v1 18.244.0.188:9031 "
                           "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
"moria2 v1 18.244.0.114:80  719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
"tor26 v1 86.59.21.38:80    847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D"
  };
474
475
476
477
478
  parse_dir_server_line(dirservers[0], 0);
  parse_dir_server_line(dirservers[1], 0);
  parse_dir_server_line(dirservers[2], 0);
}

479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
/** Fetch the active option list, and take actions based on it. All of the
 * things we do should survive being done repeatedly.  If present,
 * <b>old_options</b> contains the previous value of the options.
 *
 * Return 0 if all goes well, return -1 if things went badly.
 */
static int
options_act_reversible(or_options_t *old_options)
{
  smartlist_t *new_listeners = smartlist_create();
  smartlist_t *replaced_listeners = smartlist_create();
  static int libevent_initialized = 0;
  or_options_t *options = get_options();
  int running_tor = options->command == CMD_RUN_TOR;
  int set_conn_limit = 0;
  int r = -1;

  if (running_tor && options->RunAsDaemon) {
    /* No need to roll back, since you can't change the value. */
    start_daemon();
  }

  /* Setuid/setgid as appropriate */
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
      /* No need to roll back, since you can't change the value. */
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
    if (init_libevent())
      goto done;
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
518
    err(LD_FS, "Couldn't access/create private data directory \"%s\"",
519
        options->DataDirectory);
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
    /* No need to roll back, since you can't change the value. */
    goto done;
  }

  /* Bail out at this point if we're not going to be a client or server:
   * we don't run  */
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
  if (options->_ConnLimit < 0)
    goto rollback;
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
536
    err(LD_CONFIG, "Failed to bind one of the listener ports.");
537
538
539
540
541
542
543
    goto rollback;
  }

 commit:
  r = 0;
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
544
    notice(LD_NET, "Closing old %s on %s:%d",
545
546
547
548
549
550
551
552
553
554
555
556
557
558
           conn_type_to_string(conn->type), conn->address, conn->port);
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;

  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
559
    notice(LD_NET, "Closing %s on %s:%d",
560
561
562
563
564
565
566
567
568
569
570
           conn_type_to_string(conn->type), conn->address, conn->port);
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

 done:
  smartlist_free(new_listeners);
  smartlist_free(replaced_listeners);
  return r;
}

571
572
573
/** Fetch the active option list, and take actions based on it. All of the
 * things we do should survive being done repeatedly.  If present,
 * <b>old_options</b> contains the previous value of the options.
574
 *
575
 * Return 0 if all goes well, return -1 if it's time to die.
576
577
578
 *
 * Note 2: We haven't moved all the "act on new configuration" logic
 * here yet.  Some is still in do_hup() and other places.
579
 */
580
581
static int
options_act(or_options_t *old_options)
582
{
583
  config_line_t *cl;
584
585
  char *fn;
  size_t len;
586
  or_options_t *options = get_options();
587
  int running_tor = options->command == CMD_RUN_TOR;
588
589

  clear_trusted_dir_servers();
590
591
592
593
594
595
596
  if (options->DirServers) {
    for (cl = options->DirServers; cl; cl = cl->next) {
      if (parse_dir_server_line(cl->value, 0)<0) {
        err(LD_BUG,
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
597
    }
598
599
  } else {
    add_default_trusted_dirservers();
600
601
  }

602
  if (running_tor && rend_config_services(options, 0)<0) {
603
604
    err(LD_BUG,
        "Bug: Previously validated hidden services line could not be added!");
605
    return -1;
606
  }
607

608
609
610
611
612
  if (running_tor) {
    len = strlen(options->DataDirectory)+32;
    fn = tor_malloc(len);
    tor_snprintf(fn, len, "%s/cached-status", options->DataDirectory);
    if (check_private_dir(fn, CPD_CREATE) != 0) {
613
614
      err(LD_CONFIG,
          "Couldn't access/create private data directory \"%s\"", fn);
615
616
617
      tor_free(fn);
      return -1;
    }
618
619
    tor_free(fn);
  }
620

621
622
  /* Bail out at this point if we're not going to be a client or server:
   * we want to not fork, and to log stuff to stderr. */
623
624
625
  if (options->command != CMD_RUN_TOR)
    return 0;

626
  mark_logs_temp(); /* Close current logs once new logs are open. */
627
  if (options_init_logs(options, 0)<0) /* Configure the log(s) */
628
    return -1;
629

630
631
632
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
633
  add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
634
  control_adjust_event_log_severity();
635

636
637
638
639
640
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

641
642
643
644
645
646
647
648
649
  {
    smartlist_t *sl = smartlist_create();
    for (cl = options->RedirectExit; cl; cl = cl->next) {
      if (parse_redirect_line(sl, cl)<0)
        return -1;
    }
    set_exit_redirects(sl);
  }

650
  /* Finish backgrounding the process */
651
  if (running_tor && options->RunAsDaemon) {
652
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
653
    finish_daemon(options->DataDirectory);
654
655
656
657
  }

  /* Write our pid to the pid file. If we do not have write permissions we
   * will log a warning */
658
  if (running_tor && options->PidFile)
659
660
    write_pidfile(options->PidFile);

661
662
663
  /* Register addressmap directives */
  config_register_addressmaps(options);

664
665
666
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();
667
  parse_authdir_policy();
668
  parse_reachable_addresses();
669

670
671
  init_cookie_authentication(options->CookieAuthentication);

672
673
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
674
    err(LD_GENERAL,"Error loading rendezvous service keys");
675
676
677
    return -1;
  }

678
  /* Set up accounting */
679
  if (accounting_parse_options(options, 0)<0) {
680
    err(LD_CONFIG,"Error in accounting options");
681
682
    return -1;
  }
683
  if (accounting_is_enabled(options))
684
685
    configure_accounting(time(NULL));

686
687
688
  if (!running_tor)
    return 0;

689
690
  /* Check for transitions that need action. */
  if (old_options) {
691
692
    if (options->UseEntryNodes && !old_options->UseEntryNodes) {
      info(LD_CIRC,"Switching to entry nodes; abandoning previous circuits");
693
694
695
696
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

697
    if (options_transition_affects_workers(old_options, options)) {
698
      info(LD_GENERAL,"Worker-related options changed. Rotating workers.");
699
700
701
702
703
      cpuworkers_rotate();
      dnsworkers_rotate();
    }
  }

704
705
706
707
708
  /* Check if we need to parse and add the EntryNodes config option. */
  if (!old_options ||
      !opt_streq(old_options->EntryNodes, options->EntryNodes))
    entry_nodes_should_be_added();

709
  /* Since our options changed, we might need to regenerate and upload our
710
   * server descriptor.
711
   */
712
713
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
714
    mark_my_descriptor_dirty();
715

716
  return 0;
717
718
719
720
721
722
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
723
/** If <b>option</b> is an official abbreviation for a longer option,
724
725
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
726
727
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
728
static const char *
729
730
expand_abbrev(config_format_t *fmt, const char *option, int command_line,
              int warn_obsolete)
731
732
{
  int i;
733
734
735
  if (! fmt->abbrevs)
    return option;
  for (i=0; fmt->abbrevs[i].abbreviated; ++i) {
736
    /* Abbreviations are casei. */
737
738
    if (!strcasecmp(option,fmt->abbrevs[i].abbreviated) &&
        (command_line || !fmt->abbrevs[i].commandline_only)) {
739
      if (warn_obsolete && fmt->abbrevs[i].warn) {
740
        warn(LD_CONFIG,
741
742
743
             "The configuration option '%s' is deprecated; use '%s' instead.",
             fmt->abbrevs[i].abbreviated,
             fmt->abbrevs[i].full);
744
      }
745
      return fmt->abbrevs[i].full;
746
    }
747
748
749
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
750

751
752
753
754
755
/** Helper: Read a list of configuration options from the command line.
 * If successful, put them in *<b>result</b> and return 0, and return
 * -1 and leave *<b>result</b> alone. */
static int
config_get_commandlines(int argc, char **argv, config_line_t **result)
756
{
757
758
  config_line_t *front = NULL;
  config_line_t **new = &front;
759
760
761
  char *s;
  int i = 1;

762
  while (i < argc) {
763
764
765
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
766
      continue;
767
768
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
769
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
770
771
772
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
773
    }
774
    if (i == argc-1) {
775
      warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.",
776
           argv[i]);
777
778
779
      config_free_lines(front);
      return -1;
    }
780

781
    *new = tor_malloc_zero(sizeof(config_line_t));
782
    s = argv[i];
783

784
    while (*s == '-')
785
      s++;
786

787
    (*new)->key = tor_strdup(expand_abbrev(&options_format, s, 1, 1));
788
789
    (*new)->value = tor_strdup(argv[i+1]);
    (*new)->next = NULL;
790
    log(LOG_DEBUG, LD_CONFIG, "Commandline: parsed keyword '%s', value '%s'",
791
792
793
        (*new)->key, (*new)->value);

    new = &((*new)->next);
794
795
    i += 2;
  }
796
797
  *result = front;
  return 0;
798
799
}

Nick Mathewson's avatar
Nick Mathewson committed
800
/** Helper: allocate a new configuration option mapping 'key' to 'val',
801
802
 * append it to *<b>lst</b>. */
static void
803
config_line_append(config_line_t **lst,
804
805
                   const char *key,
                   const char *val)
806
{
807
  config_line_t *newline;
808

809
  newline = tor_malloc(sizeof(config_line_t));
810
811
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
812
813
814
815
816
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
817
818
}

819
820
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
821
822
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
823
int
824
config_get_lines(char *string, config_line_t **result)
825
{
826
  config_line_t *list = NULL, **next;
827
  char *k, *v;
828

829
  next = &list;
830
831
832
833
834
835
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
836
837
838
839
    if (k && v) {
      /* This list can get long, so we keep a pointer to the end of it
       * rather than using config_line_append over and over and getting n^2
       * performance.  This is the only really long list. */
840
      *next = tor_malloc(sizeof(config_line_t));
841
842
843
844
845
      (*next)->key = tor_strdup(k);
      (*next)->value = tor_strdup(v);
      (*next)->next = NULL;
      next = &((*next)->next);
    }
846
  } while (*string);
847

848
  *result = list;
849
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
850
851
}

Nick Mathewson's avatar
Nick Mathewson committed
852
853
854
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
855
void
856
config_free_lines(config_line_t *front)
857
{
858
  config_line_t *tmp;
859

860
  while (front) {
861
862
863
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
864
865
866
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
867
868
869
  }
}

870
871
872
873
874
875
876
877
878
879
880
881
/** DOCDOC */
static const char *
config_find_description(config_format_t *fmt, const char *name)
{
  int i;
  for (i=0; fmt->descriptions[i].name; ++i) {
    if (!strcasecmp(name, fmt->descriptions[i].name))
      return fmt->descriptions[i].description;
  }
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
882
883
884
885
/** If <b>key</b> is a configuration option, return the corresponding
 * config_var_t.  Otherwise, if <b>key</b> is a non-standard abbreviation,
 * warn, and return the corresponding config_var_t.  Otherwise return NULL.
 */
886
static config_var_t *
887
config_find_option(config_format_t *fmt, const char *key)
888
889
{
  int i;
890
  size_t keylen = strlen(key);
891
  if (!keylen)
892
    return NULL; /* if they say "--" on the commandline, it's not an option */
Nick Mathewson's avatar
Nick Mathewson committed
893
  /* First, check for an exact (case-insensitive) match */
894
  for (i=0; fmt->vars[i].name; ++i) {
895
    if (!strcasecmp(key, fmt->vars[i].name)) {
896
      return &fmt->vars[i];
897
    }
Nick Mathewson's avatar
Nick Mathewson committed
898
899
  }
  /* If none, check for an abbreviated match */
900
901
  for (i=0; fmt->vars[i].name; ++i) {
    if (!strncasecmp(key, fmt->vars[i].name, keylen)) {
902
      warn(LD_CONFIG, "The abbreviation '%s' is deprecated. "