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
  { 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
233
234
235
236
237
238
  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),

239
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL, NULL }
240
241
};

242
243
244
#undef VAR
#undef OBSOLETE

245
246
247
248
249
250
251
/** DOCDOC*/
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
252
  { "Address", "The advertised (external) address we should use." },
253
254
255
256
257
258
259
260
261
262
263
264
265
  // { "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 },
};

266
typedef int (*validate_fn_t)(void*,void*);
267

268
269
270
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
271
272
273
274
275
276
277
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;
278
  config_var_description_t *descriptions;
279
280
281
282
} config_format_t;

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
283
284
    tor_assert((fmt)->magic ==                                          \
               *(uint32_t*)(((char*)(cfg))+fmt->magic_offset));         \
285
286
  } while (0)

Nick Mathewson's avatar
Nick Mathewson committed
287
/** Largest allowed config line */
288
#define CONFIG_LINE_T_MAXLEN 4096
289

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

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

332
333
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
334
static void print_cvs_version(void);
335
static void parse_reachable_addresses(void);
336
static int init_libevent(void);
337
static int opt_streq(const char *s1, const char *s2);
338
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
339
static void check_libevent_version(const char *m, const char *v, int server);
340
#endif
341

342
343
/*static*/ or_options_t *options_new(void);

344
345
#define OR_OPTIONS_MAGIC 9090909

346
static config_format_t options_format = {
347
348
349
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
  _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
366
367
};

368
369
370
371
372
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
373
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
374
/** Name of most recently read torrc file. */
375
static char *torrc_fname = NULL;
376
377
/** Persistant serialized state. */
static or_state_t *global_state = NULL;
378
379
/** DOCDOC */
static addr_policy_t *reachable_addr_policy = NULL;
380

381
382
383
384
385
386
387
388
389
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;
}

390
391
/** Return the currently configured options. */
or_options_t *
392
393
get_options(void)
{
394
395
396
  tor_assert(global_options);
  return global_options;
}
397

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

  return 0;
422
423
}

424
425
426
void
config_free_all(void)
{
427
428
429
430
431
432
433
434
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
435
  tor_free(torrc_fname);
436
437
438
439
  if (reachable_addr_policy) {
    addr_policy_free(reachable_addr_policy);
    reachable_addr_policy = NULL;
  }
440
441
}

442
443
444
445
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
446
447
safe_str(const char *address)
{
448
449
450
451
452
453
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

454
455
456
457
458
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
  const char *dirservers[] = {
459
460
461
462
463
"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"
  };
464
465
466
467
468
  parse_dir_server_line(dirservers[0], 0);
  parse_dir_server_line(dirservers[1], 0);
  parse_dir_server_line(dirservers[2], 0);
}

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
501
502
503
504
505
506
507
/** 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) {
508
    err(LD_FS, "Couldn't access/create private data directory \"%s\"",
509
        options->DataDirectory);
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
    /* 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) {
526
    err(LD_CONFIG, "Failed to bind one of the listener ports.");
527
528
529
530
531
532
533
    goto rollback;
  }

 commit:
  r = 0;
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
534
    notice(LD_NET, "Closing old %s on %s:%d",
535
536
537
538
539
540
541
542
543
544
545
546
547
548
           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,
  {
549
    notice(LD_NET, "Closing %s on %s:%d",
550
551
552
553
554
555
556
557
558
559
560
           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;
}

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

  clear_trusted_dir_servers();
580
581
582
583
584
585
586
  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;
      }
587
    }
588
589
  } else {
    add_default_trusted_dirservers();
590
591
  }

592
  if (running_tor && rend_config_services(options, 0)<0) {
593
594
    err(LD_BUG,
        "Bug: Previously validated hidden services line could not be added!");
595
    return -1;
596
  }
597

598
599
600
  if (options->EntryNodes && strlen(options->EntryNodes))
    options->UseHelperNodes = 0;

601
602
603
604
605
  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) {
606
607
      err(LD_CONFIG,
          "Couldn't access/create private data directory \"%s\"", fn);
608
609
610
      tor_free(fn);
      return -1;
    }
611
612
    tor_free(fn);
  }
613

614
615
  /* 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. */
616
617
618
  if (options->command != CMD_RUN_TOR)
    return 0;

619
  mark_logs_temp(); /* Close current logs once new logs are open. */
620
  if (options_init_logs(options, 0)<0) /* Configure the log(s) */
621
    return -1;
622

623
624
625
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
626
  add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
627
  control_adjust_event_log_severity();
628

629
630
631
632
633
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

634
635
636
637
638
639
640
641
642
  {
    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);
  }

643
  /* Finish backgrounding the process */
644
  if (running_tor && options->RunAsDaemon) {
645
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
646
    finish_daemon(options->DataDirectory);
647
648
649
650
  }

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

654
655
656
  /* Register addressmap directives */
  config_register_addressmaps(options);

657
658
659
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();
660
  parse_authdir_policy();
661
  parse_reachable_addresses();
662

663
664
  init_cookie_authentication(options->CookieAuthentication);

665
666
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
667
    err(LD_GENERAL,"Error loading rendezvous service keys");
668
669
670
    return -1;
  }

671
  /* Set up accounting */
672
  if (accounting_parse_options(options, 0)<0) {
673
    err(LD_CONFIG,"Error in accounting options");
674
675
    return -1;
  }
676
  if (accounting_is_enabled(options))
677
678
    configure_accounting(time(NULL));

679
680
681
  if (!running_tor)
    return 0;

682
683
  /* Check for transitions that need action. */
  if (old_options) {
684
    if (options->UseHelperNodes && !old_options->UseHelperNodes) {
685
      info(LD_CIRC,"Switching to helper nodes; abandoning previous circuits");
686
687
688
689
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

690
    if (options_transition_affects_workers(old_options, options)) {
691
      info(LD_GENERAL,"Worker-related options changed. Rotating workers.");
692
693
694
695
696
      cpuworkers_rotate();
      dnsworkers_rotate();
    }
  }

697
  /* Since our options changed, we might need to regenerate and upload our
698
   * server descriptor.
699
   */
700
701
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
702
    mark_my_descriptor_dirty();
703

704
  return 0;
705
706
707
708
709
710
}

/*
 * Functions to parse config options
 */

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

739
740
741
742
743
/** 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)
744
{
745
746
  config_line_t *front = NULL;
  config_line_t **new = &front;
747
748
749
  char *s;
  int i = 1;

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

769
    *new = tor_malloc_zero(sizeof(config_line_t));
770
    s = argv[i];
771

772
    while (*s == '-')
773
      s++;
774

775
    (*new)->key = tor_strdup(expand_abbrev(&options_format, s, 1, 1));
776
777
    (*new)->value = tor_strdup(argv[i+1]);
    (*new)->next = NULL;
778
    log(LOG_DEBUG, LD_CONFIG, "Commandline: parsed keyword '%s', value '%s'",
779
780
781
        (*new)->key, (*new)->value);

    new = &((*new)->next);
782
783
    i += 2;
  }
784
785
  *result = front;
  return 0;
786
787
}

Nick Mathewson's avatar
Nick Mathewson committed
788
/** Helper: allocate a new configuration option mapping 'key' to 'val',
789
790
 * append it to *<b>lst</b>. */
static void
791
config_line_append(config_line_t **lst,
792
793
                   const char *key,
                   const char *val)
794
{
795
  config_line_t *newline;
796

797
  newline = tor_malloc(sizeof(config_line_t));
798
799
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
800
801
802
803
804
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
805
806
}

807
808
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
809
810
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
811
int
812
config_get_lines(char *string, config_line_t **result)
813
{
814
  config_line_t *list = NULL, **next;
815
  char *k, *v;
816

817
  next = &list;
818
819
820
821
822
823
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
824
825
826
827
    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. */
828
      *next = tor_malloc(sizeof(config_line_t));
829
830
831
832
833
      (*next)->key = tor_strdup(k);
      (*next)->value = tor_strdup(v);
      (*next)->next = NULL;
      next = &((*next)->next);
    }
834
  } while (*string);
835

836
  *result = list;
837
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
838
839
}

Nick Mathewson's avatar
Nick Mathewson committed
840
841
842
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
843
void
844
config_free_lines(config_line_t *front)
845
{
846
  config_line_t *tmp;
847

848
  while (front) {
849
850
851
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
852
853
854
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
855
856
857
  }
}

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

900
901
902
903