config.c 121 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
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
78
79
80
81
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
82
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
83
84
85
86
87
88
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
89
  { NULL, NULL, 0, 0},
90
};
91
#undef PLURAL
92

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

Nick Mathewson's avatar
Nick Mathewson committed
102
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
103
104
#define STRUCT_OFFSET(tp, member) \
  ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
Nick Mathewson's avatar
Nick Mathewson committed
105
106
107
108
/** 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>"
 */
109
110
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
111
      initvalue }
Nick Mathewson's avatar
Nick Mathewson committed
112
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
113
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
114

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

230
231
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
232
      initvalue }
233
static config_var_t _state_vars[] = {
234
  VAR("AccountingBytesReadInInterval", MEMUNIT,
235
      AccountingBytesReadInInterval, NULL),
236
237
238
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
239
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
240
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
241
242
243
244
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuards",             LINELIST_V,  EntryGuards,             NULL),
Nick Mathewson's avatar
Nick Mathewson committed
245

246
247
248
249
250
251
252
  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),

253
254
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

255
256
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

257
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
258
259
};

260
261
262
#undef VAR
#undef OBSOLETE

263
264
265
266
267
268
269
/** DOCDOC*/
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
270
  { "Address", "The advertised (external) address we should use." },
271
272
273
274
275
  // { "AccountingStart", ""},
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
276
  { "AccountingBytesReadInInterval",
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
    "How many bytes have we read in this accounting period?" },
  { "AccountingBytesWrittenInInterval",
    "How many bytes have we written in this accounting period?" },
  { "AccountingExpectedUsage",
    "How many bytes did we expect to use per minute? (0 for no estimate.)" },
  { "AccountingIntervalStart", "When did this accounting period begin?" },
  { "AccountingSecondsActive", "How long have we been awake in this period?" },

  { "BWHistoryReadEnds", "When does the last-recorded read-interval end?" },
  { "BWHistoryReadInterval", "How long is each read-interval (in seconds)?" },
  { "BWHistoryReadValues", "Number of bytes read in each interval." },
  { "BWHistoryWriteEnds", "When does the last-recorded write-interval end?" },
  { "BWHistoryWriteInterval", "How long is each write-interval (in seconds)?"},
  { "BWHistoryWriteValues", "Number of bytes written in each interval." },

292
293
294
295
296
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
    "The last entry guard has been down since this time." },
  { "EntryGuardUnlistedSince",
    "The last entry guard has been unlisted since this time." },
297
298
299
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
300
301
302
  { NULL, NULL },
};

Roger Dingledine's avatar
Roger Dingledine committed
303
typedef int (*validate_fn_t)(void*,void*,int);
304

305
306
307
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
308
309
310
311
312
313
314
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;
315
  config_var_description_t *descriptions;
316
317
318
319
} config_format_t;

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
320
321
    tor_assert((fmt)->magic ==                                          \
               *(uint32_t*)(((char*)(cfg))+fmt->magic_offset));         \
322
323
  } while (0)

Nick Mathewson's avatar
Nick Mathewson committed
324
/** Largest allowed config line */
325
#define CONFIG_LINE_T_MAXLEN 4096
326

327
static void config_line_append(config_line_t **lst,
328
                               const char *key, const char *val);
329
330
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
331
static void option_reset(config_format_t *fmt, or_options_t *options,
332
                         config_var_t *var, int use_defaults);
333
static void config_free(config_format_t *fmt, void *options);
334
static int option_is_same(config_format_t *fmt,
335
336
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
337
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
338
static int options_validate(or_options_t *old_options,
Roger Dingledine's avatar
Roger Dingledine committed
339
                            or_options_t *options, int from_setconf);
340
static int options_act_reversible(or_options_t *old_options);
341
static int options_act(or_options_t *old_options);
342
static int options_transition_allowed(or_options_t *old, or_options_t *new);
343
344
345
346
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);
347
static int check_nickname_list(const char *lst, const char *name);
348
static void config_register_addressmaps(or_options_t *options);
349

350
static int parse_dir_server_line(const char *line, int validate_only);
351
static int parse_redirect_line(smartlist_t *result,
352
                               config_line_t *line);
353
354
355
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
static int convert_log_option(or_options_t *options,
356
357
                              config_line_t *level_opt,
                              config_line_t *file_opt, int isDaemon);
358
359
360
361
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);
362
static int validate_data_directory(or_options_t *options);
363
static int write_configuration_file(const char *fname, or_options_t *options);
364
static config_line_t *get_assigned_option(config_format_t *fmt,
365
                                     or_options_t *options, const char *key);
366
static void config_init(config_format_t *fmt, void *options);
367
368
static int or_state_validate(or_state_t *old_options, or_state_t *options,
                             int from_setconf);
369

370
371
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
372
static void print_cvs_version(void);
373
static void parse_reachable_addresses(void);
374
static int init_libevent(void);
375
static int opt_streq(const char *s1, const char *s2);
376
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
377
static void check_libevent_version(const char *m, const char *v, int server);
378
#endif
379

380
381
/*static*/ or_options_t *options_new(void);

382
383
#define OR_OPTIONS_MAGIC 9090909

384
static config_format_t options_format = {
385
386
387
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
388
389
390
391
392
393
394
395
396
397
398
399
  _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),
400
  _state_abbrevs,
401
402
403
  _state_vars,
  (validate_fn_t)or_state_validate,
  state_description
404
405
};

406
407
408
409
410
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
411
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
412
/** Name of most recently read torrc file. */
413
static char *torrc_fname = NULL;
414
/** Persistent serialized state. */
415
static or_state_t *global_state = NULL;
416
417
/** DOCDOC */
static addr_policy_t *reachable_addr_policy = NULL;
418

419
420
421
422
423
424
425
426
427
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;
}

428
429
/** Return the currently configured options. */
or_options_t *
430
431
get_options(void)
{
432
433
434
  tor_assert(global_options);
  return global_options;
}
435

436
437
438
/** 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.
439
 */
440
int
441
442
set_options(or_options_t *new_val)
{
443
  or_options_t *old_options = global_options;
444
  global_options = new_val;
445
446
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
447
448
449
450
  if (options_act_reversible(old_options)<0) {
    global_options = old_options;
    return -1;
  }
451
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
452
453
    err(LD_CONFIG,
        "Acting on config options left us in a broken state. Dying.");
454
455
456
    exit(1);
  }
  if (old_options)
457
    config_free(&options_format, old_options);
458
459

  return 0;
460
461
}

462
463
464
void
config_free_all(void)
{
465
466
467
468
469
470
471
472
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
473
  tor_free(torrc_fname);
474
475
476
477
  if (reachable_addr_policy) {
    addr_policy_free(reachable_addr_policy);
    reachable_addr_policy = NULL;
  }
478
479
}

480
481
482
483
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
484
485
safe_str(const char *address)
{
486
487
488
489
490
491
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

492
493
494
495
496
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
  const char *dirservers[] = {
497
498
499
500
501
"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"
  };
502
503
504
505
506
  parse_dir_server_line(dirservers[0], 0);
  parse_dir_server_line(dirservers[1], 0);
  parse_dir_server_line(dirservers[2], 0);
}

507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
/** 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;
523
  int logs_marked = 0;
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546

  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) {
547
    err(LD_FS, "Couldn't access/create private data directory \"%s\"",
548
        options->DataDirectory);
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
    /* 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) {
565
    err(LD_CONFIG, "Failed to bind one of the listener ports.");
566
567
568
    goto rollback;
  }

569
570
571
572
573
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
  if (options_init_logs(options, 0)<0) /* Configure the log(s) */
    goto rollback;

574
575
 commit:
  r = 0;
576
577
578
579
580
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
581
582
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
583
    notice(LD_NET, "Closing old %s on %s:%d",
584
585
586
587
588
589
590
591
592
           conn_type_to_string(conn->type), conn->address, conn->port);
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;

593
594
595
596
597
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

598
599
600
601
602
  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
603
    notice(LD_NET, "Closing %s on %s:%d",
604
605
606
607
608
609
610
611
612
613
614
           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;
}

615
616
617
/** 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.
618
 *
619
 * Return 0 if all goes well, return -1 if it's time to die.
620
621
622
 *
 * Note 2: We haven't moved all the "act on new configuration" logic
 * here yet.  Some is still in do_hup() and other places.
623
 */
624
625
static int
options_act(or_options_t *old_options)
626
{
627
  config_line_t *cl;
628
629
  char *fn;
  size_t len;
630
  or_options_t *options = get_options();
631
  int running_tor = options->command == CMD_RUN_TOR;
632
633

  clear_trusted_dir_servers();
634
635
636
637
638
639
640
  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;
      }
641
    }
642
643
  } else {
    add_default_trusted_dirservers();
644
645
  }

646
  if (running_tor && rend_config_services(options, 0)<0) {
647
648
    err(LD_BUG,
        "Bug: Previously validated hidden services line could not be added!");
649
    return -1;
650
  }
651

652
653
654
655
656
  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) {
657
658
      err(LD_CONFIG,
          "Couldn't access/create private data directory \"%s\"", fn);
659
660
661
      tor_free(fn);
      return -1;
    }
662
663
    tor_free(fn);
  }
664

665
666
  /* 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. */
667
668
669
  if (options->command != CMD_RUN_TOR)
    return 0;

670
671
672
673
674
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

675
676
677
678
679
680
681
682
683
  {
    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);
  }

684
  /* Finish backgrounding the process */
685
  if (running_tor && options->RunAsDaemon) {
686
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
687
    finish_daemon(options->DataDirectory);
688
689
690
691
  }

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

695
696
697
  /* Register addressmap directives */
  config_register_addressmaps(options);

698
699
700
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();
701
  parse_authdir_policy();
702
  parse_reachable_addresses();
703

704
705
  init_cookie_authentication(options->CookieAuthentication);

706
707
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
708
    err(LD_GENERAL,"Error loading rendezvous service keys");
709
710
711
    return -1;
  }

712
  /* Set up accounting */
713
  if (accounting_parse_options(options, 0)<0) {
714
    err(LD_CONFIG,"Error in accounting options");
715
716
    return -1;
  }
717
  if (accounting_is_enabled(options))
718
719
    configure_accounting(time(NULL));

720
721
722
  if (!running_tor)
    return 0;

723
724
  /* Check for transitions that need action. */
  if (old_options) {
725
726
    if (options->UseEntryGuards && !old_options->UseEntryGuards) {
      info(LD_CIRC,"Switching to entry guards; abandoning previous circuits");
727
728
729
730
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

731
    if (options_transition_affects_workers(old_options, options)) {
732
      info(LD_GENERAL,"Worker-related options changed. Rotating workers.");
733
734
735
736
737
738
739
740
741
742
      if (server_mode(options) && !server_mode(old_options)) {
        extern int has_completed_circuit;
        if (init_keys() < 0) {
          err(LD_GENERAL,"Error initializing keys; exiting");
          return -1;
        }
        server_has_changed_ip();
        if (has_completed_circuit)
          inform_testing_reachability();
      }
743
744
745
746
747
      cpuworkers_rotate();
      dnsworkers_rotate();
    }
  }

748
  /* Check if we need to parse and add the EntryNodes config option. */
749
750
751
  if (options->EntryNodes &&
      (!old_options ||
       !opt_streq(old_options->EntryNodes, options->EntryNodes)))
752
753
    entry_nodes_should_be_added();

754
  /* Since our options changed, we might need to regenerate and upload our
755
   * server descriptor.
756
   */
757
758
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
759
    mark_my_descriptor_dirty();
760

761
  return 0;
762
763
764
765
766
767
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
768
/** If <b>option</b> is an official abbreviation for a longer option,
769
770
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
771
772
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
773
static const char *
774
775
expand_abbrev(config_format_t *fmt, const char *option, int command_line,
              int warn_obsolete)
776
777
{
  int i;
778
779
780
  if (! fmt->abbrevs)
    return option;
  for (i=0; fmt->abbrevs[i].abbreviated; ++i) {
781
    /* Abbreviations are casei. */
782
783
    if (!strcasecmp(option,fmt->abbrevs[i].abbreviated) &&
        (command_line || !fmt->abbrevs[i].commandline_only)) {
784
      if (warn_obsolete && fmt->abbrevs[i].warn) {
785
        warn(LD_CONFIG,
786
787
788
             "The configuration option '%s' is deprecated; use '%s' instead.",
             fmt->abbrevs[i].abbreviated,
             fmt->abbrevs[i].full);
789
      }
790
      return fmt->abbrevs[i].full;
791
    }
792
793
794
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
795

796
797
798
799
800
/** 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)
801
{
802
803
  config_line_t *front = NULL;
  config_line_t **new = &front;
804
805
806
  char *s;
  int i = 1;

807
  while (i < argc) {
808
809
810
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
811
      continue;
812
813
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
814
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
815
816
817
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
818
    }
819
    if (i == argc-1) {
820
      warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.",
821
           argv[i]);
822
823
824
      config_free_lines(front);
      return -1;
    }
825

826
    *new = tor_malloc_zero(sizeof(config_line_t));
827
    s = argv[i];
828

829
    while (*s == '-')
830
      s++;
831

832
    (*new)->key = tor_strdup(expand_abbrev(&options_format, s, 1, 1));
833
834
    (*new)->value = tor_strdup(argv[i+1]);
    (*new)->next = NULL;
835
    log(LOG_DEBUG, LD_CONFIG, "Commandline: parsed keyword '%s', value '%s'",
836
837
838
        (*new)->key, (*new)->value);

    new = &((*new)->next);
839
840
    i += 2;
  }
841
842
  *result = front;
  return 0;
843
844
}

Nick Mathewson's avatar
Nick Mathewson committed
845
/** Helper: allocate a new configuration option mapping 'key' to 'val',
846
847
 * append it to *<b>lst</b>. */
static void
848
config_line_append(config_line_t **lst,
849
850
                   const char *key,
                   const char *val)
851
{
852
  config_line_t *newline;
853

854
  newline = tor_malloc(sizeof(config_line_t));
855
856
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
857
858
859
860
861
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
862
863
}

864
865
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
866
867
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
868
int
869
config_get_lines(char *string, config_line_t **result)
870
{
871
  config_line_t *list = NULL, **next;
872
  char *k, *v;
873

874
  next = &list;
875
876
877
878
879
880
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
881
882
883
884
    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. */
885
      *next = tor_malloc(sizeof(config_line_t));
886
887
888
889
890
      (*next)->key = tor_strdup(k);
      (*next)->value = tor_strdup(v);
      (*next)->next = NULL;
      next = &((*next)->next);
    }
891
  } while (*string);
892

893
  *result = list;
894
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
895
896
}

Nick Mathewson's avatar
Nick Mathewson committed
897
898
899
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
900
void
901
config_free_lines(config_line_t *front)
902
{
903
  config_line_t *tmp;
904

905
  while (front) {
906
907
908
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar