config.c 115 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
  { NULL, NULL, 0, 0},
75
};
76
#undef PLURAL
77

78
/** A variable allowed in the configuration file or on the command line. */
79
typedef struct config_var_t {
80
  const char *name; /**< The full keyword (case insensitive). */
81
82
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
83
84
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
85
  const char *description;
86
87
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
88
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
89
90
#define STRUCT_OFFSET(tp, member) \
  ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
Nick Mathewson's avatar
Nick Mathewson committed
91
92
93
94
/** 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>"
 */
95
96
97
#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
98
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
99
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL, NULL }
100

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

215
216
217
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
      initvalue, NULL }
218
static config_var_t _state_vars[] = {
219
220
  VAR("AccountingBytesReadInterval", MEMUNIT, AccountingBytesReadInInterval,
                                                                    NULL),
221
222
223
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
224
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
225
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
226
227
228
  VAR("HelperNode",              LINELIST_S,  HelperNodes,          NULL),
  VAR("HelperNodeDownSince",     LINELIST_S,  HelperNodes,          NULL),
  VAR("HelperNodeUnlistedSince", LINELIST_S,  HelperNodes,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
229
230
231
  VAR("HelperNodes",             LINELIST_V,  HelperNodes,          NULL),
  VAR("LastWritten",             ISOTIME,     LastWritten,          NULL),

232
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL, NULL }
233
234
};

235
236
237
#undef VAR
#undef OBSOLETE

238
239
240
241
242
243
244
/** DOCDOC*/
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
245
  { "Address", "The advertised (external) address we should use." },
246
247
248
249
250
251
252
253
254
255
256
257
258
  // { "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 },
};

259
typedef int (*validate_fn_t)(void*,void*);
260

261
262
263
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
264
265
266
267
268
269
270
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;
271
  config_var_description_t *descriptions;
272
273
274
275
} config_format_t;

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
276
277
    tor_assert((fmt)->magic ==                                          \
               *(uint32_t*)(((char*)(cfg))+fmt->magic_offset));         \
278
279
  } while (0)

Nick Mathewson's avatar
Nick Mathewson committed
280
/** Largest allowed config line */
281
#define CONFIG_LINE_T_MAXLEN 4096
282

283
static void config_line_append(config_line_t **lst,
284
                               const char *key, const char *val);
285
286
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
287
static void option_reset(config_format_t *fmt, or_options_t *options,
288
                         config_var_t *var, int use_defaults);
289
static void config_free(config_format_t *fmt, void *options);
290
static int option_is_same(config_format_t *fmt,
291
292
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
293
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
294
295
static int options_validate(or_options_t *old_options,
                            or_options_t *options);
296
static int options_act_reversible(or_options_t *old_options);
297
static int options_act(or_options_t *old_options);
298
static int options_transition_allowed(or_options_t *old, or_options_t *new);
299
300
301
302
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);
303
static int check_nickname_list(const char *lst, const char *name);
304
static void config_register_addressmaps(or_options_t *options);
305

306
static int parse_dir_server_line(const char *line, int validate_only);
307
static int parse_redirect_line(smartlist_t *result,
308
                               config_line_t *line);
309
310
311
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
static int convert_log_option(or_options_t *options,
312
313
                              config_line_t *level_opt,
                              config_line_t *file_opt, int isDaemon);
314
315
316
317
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);
318
static int validate_data_directory(or_options_t *options);
319
static int write_configuration_file(const char *fname, or_options_t *options);
320
static config_line_t *get_assigned_option(config_format_t *fmt,
321
                                     or_options_t *options, const char *key);
322
static void config_init(config_format_t *fmt, void *options);
323
static int or_state_validate(or_state_t *old_options, or_state_t *options);
324

325
326
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
327
static void print_cvs_version(void);
328
static void parse_reachable_addresses(void);
329
static int init_libevent(void);
330
static int opt_streq(const char *s1, const char *s2);
331
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
332
static void check_libevent_version(const char *m, const char *v, int server);
333
#endif
334

335
336
/*static*/ or_options_t *options_new(void);

337
338
#define OR_OPTIONS_MAGIC 9090909

339
static config_format_t options_format = {
340
341
342
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
  _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),
  NULL,
  _state_vars,
  (validate_fn_t)or_state_validate,
  state_description
359
360
};

361
362
363
364
365
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
366
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
367
/** Name of most recently read torrc file. */
368
static char *torrc_fname = NULL;
369
370
/** Persistant serialized state. */
static or_state_t *global_state = NULL;
371
372
/** DOCDOC */
static addr_policy_t *reachable_addr_policy = NULL;
373

374
375
376
377
378
379
380
381
382
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;
}

383
384
/** Return the currently configured options. */
or_options_t *
385
386
get_options(void)
{
387
388
389
  tor_assert(global_options);
  return global_options;
}
390

391
392
393
/** 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.
394
 */
395
int
396
397
set_options(or_options_t *new_val)
{
398
  or_options_t *old_options = global_options;
399
  global_options = new_val;
400
401
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
402
403
404
405
  if (options_act_reversible(old_options)<0) {
    global_options = old_options;
    return -1;
  }
406
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
407
408
    err(LD_CONFIG,
        "Acting on config options left us in a broken state. Dying.");
409
410
411
    exit(1);
  }
  if (old_options)
412
    config_free(&options_format, old_options);
413
414

  return 0;
415
416
}

417
418
419
void
config_free_all(void)
{
420
421
422
423
424
425
426
427
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
428
  tor_free(torrc_fname);
429
430
431
432
  if (reachable_addr_policy) {
    addr_policy_free(reachable_addr_policy);
    reachable_addr_policy = NULL;
  }
433
434
}

435
436
437
438
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
439
440
safe_str(const char *address)
{
441
442
443
444
445
446
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

447
448
449
450
451
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
  const char *dirservers[] = {
452
453
454
455
456
"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"
  };
457
458
459
460
461
  parse_dir_server_line(dirservers[0], 0);
  parse_dir_server_line(dirservers[1], 0);
  parse_dir_server_line(dirservers[2], 0);
}

462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
/** 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) {
501
    err(LD_FS, "Couldn't access/create private data directory \"%s\"",
502
        options->DataDirectory);
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
    /* 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) {
519
    err(LD_CONFIG, "Failed to bind one of the listener ports.");
520
521
522
523
524
525
526
    goto rollback;
  }

 commit:
  r = 0;
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
527
    notice(LD_NET, "Closing old %s on %s:%d",
528
529
530
531
532
533
534
535
536
537
538
539
540
541
           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,
  {
542
    notice(LD_NET, "Closing %s on %s:%d",
543
544
545
546
547
548
549
550
551
552
553
           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;
}

554
555
556
/** 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.
557
 *
558
 * Return 0 if all goes well, return -1 if it's time to die.
559
560
561
 *
 * Note 2: We haven't moved all the "act on new configuration" logic
 * here yet.  Some is still in do_hup() and other places.
562
 */
563
564
static int
options_act(or_options_t *old_options)
565
{
566
  config_line_t *cl;
567
568
  char *fn;
  size_t len;
569
  or_options_t *options = get_options();
570
  int running_tor = options->command == CMD_RUN_TOR;
571
572

  clear_trusted_dir_servers();
573
574
575
576
577
578
579
  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;
      }
580
    }
581
582
  } else {
    add_default_trusted_dirservers();
583
584
  }

585
  if (running_tor && rend_config_services(options, 0)<0) {
586
587
    err(LD_BUG,
        "Bug: Previously validated hidden services line could not be added!");
588
    return -1;
589
  }
590

591
592
593
  if (options->EntryNodes && strlen(options->EntryNodes))
    options->UseHelperNodes = 0;

594
595
596
597
598
  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) {
599
600
      err(LD_CONFIG,
          "Couldn't access/create private data directory \"%s\"", fn);
601
602
603
      tor_free(fn);
      return -1;
    }
604
605
    tor_free(fn);
  }
606

607
608
  /* 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. */
609
610
611
  if (options->command != CMD_RUN_TOR)
    return 0;

612
  mark_logs_temp(); /* Close current logs once new logs are open. */
613
  if (options_init_logs(options, 0)<0) /* Configure the log(s) */
614
    return -1;
615

616
617
618
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
619
  add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
620
  control_adjust_event_log_severity();
621

622
623
624
625
626
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

627
628
629
630
631
632
633
634
635
  {
    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);
  }

636
  /* Finish backgrounding the process */
637
  if (running_tor && options->RunAsDaemon) {
638
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
639
    finish_daemon(options->DataDirectory);
640
641
642
643
  }

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

647
648
649
  /* Register addressmap directives */
  config_register_addressmaps(options);

650
651
652
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();
653
  parse_authdir_policy();
654
  parse_reachable_addresses();
655

656
657
  init_cookie_authentication(options->CookieAuthentication);

658
659
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
660
    err(LD_GENERAL,"Error loading rendezvous service keys");
661
662
663
    return -1;
  }

664
  /* Set up accounting */
665
  if (accounting_parse_options(options, 0)<0) {
666
    err(LD_CONFIG,"Error in accounting options");
667
668
    return -1;
  }
669
  if (accounting_is_enabled(options))
670
671
    configure_accounting(time(NULL));

672
673
674
  if (!running_tor)
    return 0;

675
676
  /* Check for transitions that need action. */
  if (old_options) {
677
    if (options->UseHelperNodes && !old_options->UseHelperNodes) {
678
      info(LD_CIRC,"Switching to helper nodes; abandoning previous circuits");
679
680
681
682
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

683
    if (options_transition_affects_workers(old_options, options)) {
684
      info(LD_GENERAL,"Worker-related options changed. Rotating workers.");
685
686
687
688
689
      cpuworkers_rotate();
      dnsworkers_rotate();
    }
  }

690
  /* Since our options changed, we might need to regenerate and upload our
691
   * server descriptor.
692
   */
693
694
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
695
    mark_my_descriptor_dirty();
696

697
  return 0;
698
699
700
701
702
703
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
704
/** If <b>option</b> is an official abbreviation for a longer option,
705
706
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
707
708
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
709
static const char *
710
711
expand_abbrev(config_format_t *fmt, const char *option, int command_line,
              int warn_obsolete)
712
713
{
  int i;
714
715
716
  if (! fmt->abbrevs)
    return option;
  for (i=0; fmt->abbrevs[i].abbreviated; ++i) {
717
    /* Abbreviations are casei. */
718
719
    if (!strcasecmp(option,fmt->abbrevs[i].abbreviated) &&
        (command_line || !fmt->abbrevs[i].commandline_only)) {
720
      if (warn_obsolete && fmt->abbrevs[i].warn) {
721
        warn(LD_CONFIG,
722
723
724
             "The configuration option '%s' is deprecated; use '%s' instead.",
             fmt->abbrevs[i].abbreviated,
             fmt->abbrevs[i].full);
725
      }
726
      return fmt->abbrevs[i].full;
727
    }
728
729
730
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
731

732
733
734
735
736
/** 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)
737
{
738
739
  config_line_t *front = NULL;
  config_line_t **new = &front;
740
741
742
  char *s;
  int i = 1;

743
  while (i < argc) {
744
745
746
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
747
      continue;
748
749
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
750
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
751
752
753
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
754
    }
755
    if (i == argc-1) {
756
      warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.",
757
           argv[i]);
758
759
760
      config_free_lines(front);
      return -1;
    }
761

762
    *new = tor_malloc_zero(sizeof(config_line_t));
763
    s = argv[i];
764

765
    while (*s == '-')
766
      s++;
767

768
    (*new)->key = tor_strdup(expand_abbrev(&options_format, s, 1, 1));
769
770
    (*new)->value = tor_strdup(argv[i+1]);
    (*new)->next = NULL;
771
    log(LOG_DEBUG, LD_CONFIG, "Commandline: parsed keyword '%s', value '%s'",
772
773
774
        (*new)->key, (*new)->value);

    new = &((*new)->next);
775
776
    i += 2;
  }
777
778
  *result = front;
  return 0;
779
780
}

Nick Mathewson's avatar
Nick Mathewson committed
781
/** Helper: allocate a new configuration option mapping 'key' to 'val',
782
783
 * append it to *<b>lst</b>. */
static void
784
config_line_append(config_line_t **lst,
785
786
                   const char *key,
                   const char *val)
787
{
788
  config_line_t *newline;
789

790
  newline = tor_malloc(sizeof(config_line_t));
791
792
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
793
794
795
796
797
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
798
799
}

800
801
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
802
803
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
804
int
805
config_get_lines(char *string, config_line_t **result)
806
{
807
  config_line_t *list = NULL, **next;
808
  char *k, *v;
809

810
  next = &list;
811
812
813
814
815
816
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
817
818
819
820
    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. */
821
      *next = tor_malloc(sizeof(config_line_t));
822
823
824
825
826
      (*next)->key = tor_strdup(k);
      (*next)->value = tor_strdup(v);
      (*next)->next = NULL;
      next = &((*next)->next);
    }
827
  } while (*string);
828

829
  *result = list;
830
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
831
832
}

Nick Mathewson's avatar
Nick Mathewson committed
833
834
835
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
836
void
837
config_free_lines(config_line_t *front)
838
{
839
  config_line_t *tmp;
840

841
  while (front) {
842
843
844
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
845
846
847
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
848
849
850
  }
}

851
852
853
854
855
856
857
858
859
860
861
862
/** 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
863
864
865
866
/** 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.
 */
867
static config_var_t *
868
config_find_option(config_format_t *fmt, const char *key)
869
870
{
  int i;
871
  size_t keylen = strlen(key);
872
  if (!keylen)
873
    return NULL; /* if they say "--" on the commandline, it's not an option */
Nick Mathewson's avatar
Nick Mathewson committed
874
  /* First, check for an exact (case-insensitive) match */
875
  for (i=0; fmt->vars[i].name; ++i) {
876
    if (!strcasecmp(key, fmt->vars[i].name)) {
877
      return &fmt->vars[i];
878
    }
Nick Mathewson's avatar
Nick Mathewson committed
879
880
  }
  /* If none, check for an abbreviated match */
881
882
  for (i=0; fmt->vars[i].name; ++i) {
    if (!strncasecmp(key, fmt->vars[i].name, keylen)) {
883
      warn(LD_CONFIG, "The abbreviation '%s' is deprecated. "
884
885
           "Please use '%s' instead",
           key, fmt->vars[i].name);
886
      return &fmt->vars[i];
887
888
    }
  }
889
  /* Okay, unrecognized options */
890
891
892
  return NULL;
}

893
894
895
896
/*
 * Functions to assign config options.
 */