config.c 130 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
3
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, 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
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
68
69
70
71
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
72
73
74
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
75
76
77
78
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
79
80
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
81
82
83
84
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
85
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
86
87
88
89
90
91
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
92
  { NULL, NULL, 0, 0},
93
};
94
#undef PLURAL
95

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

105
106
107
#define STRUCT_VAR_P(st, off) \
  ((void*) ( ((char*)st) + off ) )

Nick Mathewson's avatar
Nick Mathewson committed
108
109
110
111
/** 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>"
 */
112
113
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
114
      initvalue }
Nick Mathewson's avatar
Nick Mathewson committed
115
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
116
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
117

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

254
255
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
256
      initvalue }
257
static config_var_t _state_vars[] = {
258
  VAR("AccountingBytesReadInInterval", MEMUNIT,
259
      AccountingBytesReadInInterval, NULL),
260
261
262
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
263
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
264
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
265
266
267
268
  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
269

270
271
272
273
274
275
276
  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),

277
278
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

279
280
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

281
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
282
283
};

284
285
286
#undef VAR
#undef OBSOLETE

287
288
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
289
290
291
292
293
294
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
295
  { "Address", "The advertised (external) address we should use." },
296
297
298
299
300
  // { "AccountingStart", ""},
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
301
  { "AccountingBytesReadInInterval",
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
    "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." },

317
318
319
320
321
  { "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." },
322
323
324
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
325
326
327
  { NULL, NULL },
};

328
typedef int (*validate_fn_t)(void*,void*,int,char**);
329

330
331
332
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
333
334
335
336
337
338
339
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;
340
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
341
342
343
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
344
345
346
347
} config_format_t;

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
348
    tor_assert((fmt)->magic ==                                          \
349
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
350
351
  } while (0)

352
static void config_line_append(config_line_t **lst,
353
                               const char *key, const char *val);
354
355
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
356
static void option_reset(config_format_t *fmt, or_options_t *options,
357
                         config_var_t *var, int use_defaults);
358
static void config_free(config_format_t *fmt, void *options);
359
static int option_is_same(config_format_t *fmt,
360
361
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
362
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
363
364
365
static int options_validate(or_options_t *old_options, or_options_t *options,
                            int from_setconf, char **msg);
static int options_act_reversible(or_options_t *old_options, char **msg);
366
static int options_act(or_options_t *old_options);
367
368
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
369
370
371
372
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);
373
static int check_nickname_list(const char *lst, const char *name, char **msg);
374
static void config_register_addressmaps(or_options_t *options);
375

376
static int parse_dir_server_line(const char *line, int validate_only);
377
static int parse_redirect_line(smartlist_t *result,
378
                               config_line_t *line, char **msg);
379
380
381
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
static int convert_log_option(or_options_t *options,
382
383
                              config_line_t *level_opt,
                              config_line_t *file_opt, int isDaemon);
384
385
386
387
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);
388
static int validate_data_directory(or_options_t *options);
389
static int write_configuration_file(const char *fname, or_options_t *options);
390
static config_line_t *get_assigned_option(config_format_t *fmt,
391
                                     or_options_t *options, const char *key);
392
static void config_init(config_format_t *fmt, void *options);
393
static int or_state_validate(or_state_t *old_options, or_state_t *options,
394
                             int from_setconf, char **msg);
395

396
397
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
398
static void print_svn_version(void);
399
static void init_libevent(void);
400
static int opt_streq(const char *s1, const char *s2);
401
402
403
404
typedef enum {
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_OTHER
} le_version_t;
static le_version_t decode_libevent_version(void);
405
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
406
static void check_libevent_version(const char *m, int server);
407
#endif
408

409
410
/*static*/ or_options_t *options_new(void);

411
412
#define OR_OPTIONS_MAGIC 9090909

413
static config_format_t options_format = {
414
415
416
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
417
418
419
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
420
421
  options_description,
  NULL
422
423
424
425
};

#define OR_STATE_MAGIC 0x57A73f57

426
427
428
429
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

430
431
432
433
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
434
  _state_abbrevs,
435
436
  _state_vars,
  (validate_fn_t)or_state_validate,
437
438
  state_description,
  &state_extra_var,
439
440
};

441
442
443
444
445
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
446
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
447
/** Name of most recently read torrc file. */
448
static char *torrc_fname = NULL;
449
/** Persistent serialized state. */
450
static or_state_t *global_state = NULL;
451

452
/** Allocate an empty configuration object of a given format type. */
453
454
455
static void *
config_alloc(config_format_t *fmt)
{
456
  void *opts = tor_malloc_zero(fmt->size);
457
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
458
459
460
461
  CHECK(fmt, opts);
  return opts;
}

462
463
/** Return the currently configured options. */
or_options_t *
464
465
get_options(void)
{
466
467
468
  tor_assert(global_options);
  return global_options;
}
469

470
471
472
/** 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.
473
 */
474
int
475
set_options(or_options_t *new_val, char **msg)
476
{
477
  or_options_t *old_options = global_options;
478
  global_options = new_val;
479
480
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
481
482
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
483
484
485
    global_options = old_options;
    return -1;
  }
486
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
487
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
488
            "Acting on config options left us in a broken state. Dying.");
489
490
491
    exit(1);
  }
  if (old_options)
492
    config_free(&options_format, old_options);
493
494

  return 0;
495
496
}

497
498
/** Release all memory and resources held by global configuration structures.
 */
499
500
501
void
config_free_all(void)
{
502
503
504
505
506
507
508
509
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
510
  tor_free(torrc_fname);
511
512
}

513
514
515
516
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
517
518
safe_str(const char *address)
{
519
520
521
522
523
524
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

525
526
527
/** Equivalent to escaped(safe_str(address)).  See reentrancy node on
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
528
529
530
531
532
533
534
535
536
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

537
538
539
540
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
541
  int i;
542
  const char *dirservers[] = {
543
544
545
    /* eventually we should mark moria1 as "v1only" */
    "moria1 v1 18.244.0.188:9031 "
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
546
547
548
549
    "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",
550
    "lefkada 140.247.60.64:80 "
551
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
552
553
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
554
    NULL
555
  };
556
557
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
558
559
}

560
561
562
563
564
565
566
/** 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
567
options_act_reversible(or_options_t *old_options, char **msg)
568
569
570
571
572
573
574
575
{
  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;
576
  int logs_marked = 0;
577
578
579
580
581
582
583
584
585
586

  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. */
587
588
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
589
590
591
592
593
594
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
595
    init_libevent();
596
597
598
599
600
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
601
602
603
604
605
    char buf[1024];
    int tmp = tor_snprintf(buf, sizeof(buf),
              "Couldn't access/create private data directory \"%s\"",
              options->DataDirectory);
    *msg = tor_strdup(tmp >= 0 ? buf : "internal error");
606
    goto done;
607
    /* No need to roll back, since you can't change the value. */
608
609
610
  }

  /* Bail out at this point if we're not going to be a client or server:
611
   * we don't run Tor itself. */
612
613
614
615
616
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
617
618
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
619
    goto rollback;
620
  }
621
622
623
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
624
    *msg = tor_strdup("Failed to bind one of the listener ports.");
625
626
627
    goto rollback;
  }

628
629
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
630
631
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
632
    goto rollback;
633
  }
634

635
636
 commit:
  r = 0;
637
638
639
640
641
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
642
643
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
644
645
    log_notice(LD_NET, "Closing old %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
646
647
648
649
650
651
652
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;
653
  tor_assert(*msg);
654

655
656
657
658
659
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

660
661
662
663
664
  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
665
666
    log_notice(LD_NET, "Closing %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
667
668
669
670
671
672
673
674
675
676
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

677
678
679
/** 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.
680
 *
681
 * Return 0 if all goes well, return -1 if it's time to die.
682
 *
683
 * Note: We haven't moved all the "act on new configuration" logic
684
 * here yet.  Some is still in do_hup() and other places.
685
 */
686
687
static int
options_act(or_options_t *old_options)
688
{
689
  config_line_t *cl;
690
691
  char *fn;
  size_t len;
692
  or_options_t *options = get_options();
693
  int running_tor = options->command == CMD_RUN_TOR;
694
  char *msg;
695
696

  clear_trusted_dir_servers();
697
698
699
  if (options->DirServers) {
    for (cl = options->DirServers; cl; cl = cl->next) {
      if (parse_dir_server_line(cl->value, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
700
        log_err(LD_BUG,
701
702
703
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
704
    }
705
706
  } else {
    add_default_trusted_dirservers();
707
708
  }

709
  if (running_tor && rend_config_services(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
710
711
    log_err(LD_BUG,
       "Bug: Previously validated hidden services line could not be added!");
712
    return -1;
713
  }
714

715
716
717
718
719
  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) {
Roger Dingledine's avatar
Roger Dingledine committed
720
721
      log_err(LD_CONFIG,
              "Couldn't access/create private data directory \"%s\"", fn);
722
723
724
      tor_free(fn);
      return -1;
    }
725
726
    tor_free(fn);
  }
727

728
729
  /* 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. */
730
731
732
  if (options->command != CMD_RUN_TOR)
    return 0;

733
734
735
736
737
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

738
739
  {
    smartlist_t *sl = smartlist_create();
740
    char *errmsg = NULL;
741
    for (cl = options->RedirectExit; cl; cl = cl->next) {
742
      if (parse_redirect_line(sl, cl, &errmsg)<0) {
743
744
        log_warn(LD_CONFIG, "%s", errmsg);
        tor_free(errmsg);
745
        return -1;
746
      }
747
748
749
750
    }
    set_exit_redirects(sl);
  }

751
  /* Finish backgrounding the process */
752
  if (running_tor && options->RunAsDaemon) {
753
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
754
    finish_daemon(options->DataDirectory);
755
756
757
758
  }

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

762
763
  /* Register addressmap directives */
  config_register_addressmaps(options);
764
  parse_virtual_addr_network(options->VirtualAddrNetwork, 0, &msg);
765

766
  /* Update address policies. */
767
  policies_parse_from_options(options);
768

769
770
  init_cookie_authentication(options->CookieAuthentication);

771
772
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
Roger Dingledine's avatar
Roger Dingledine committed
773
    log_err(LD_GENERAL,"Error loading rendezvous service keys");
774
775
776
    return -1;
  }

777
  /* Set up accounting */
778
  if (accounting_parse_options(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
779
    log_err(LD_CONFIG,"Error in accounting options");
780
781
    return -1;
  }
782
  if (accounting_is_enabled(options))
783
784
    configure_accounting(time(NULL));

785
786
787
  if (!running_tor)
    return 0;

788
789
  /* Check for transitions that need action. */
  if (old_options) {
790
    if (options->UseEntryGuards && !old_options->UseEntryGuards) {
Roger Dingledine's avatar
Roger Dingledine committed
791
792
      log_info(LD_CIRC,
               "Switching to entry guards; abandoning previous circuits");
793
794
795
796
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

797
    if (options_transition_affects_workers(old_options, options)) {
Roger Dingledine's avatar
Roger Dingledine committed
798
799
      log_info(LD_GENERAL,
               "Worker-related options changed. Rotating workers.");
800
801
      if (server_mode(options) && !server_mode(old_options)) {
        if (init_keys() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
802
          log_err(LD_GENERAL,"Error initializing keys; exiting");
803
804
805
          return -1;
        }
        server_has_changed_ip();
Roger Dingledine's avatar
Roger Dingledine committed
806
        if (has_completed_circuit || !any_predicted_circuits(time(NULL)))
807
808
          inform_testing_reachability();
      }
809
      cpuworkers_rotate();
810
      dns_reset();
811
    }
812
813
814
815
816
#ifdef USE_EVENTDNS
    else {
      dns_reset();
    }
#endif
817
818
  }

819
  /* Check if we need to parse and add the EntryNodes config option. */
820
821
822
  if (options->EntryNodes &&
      (!old_options ||
       !opt_streq(old_options->EntryNodes, options->EntryNodes)))
823
824
    entry_nodes_should_be_added();

825
826
827
828
829
830
  /* If the user wants to avoid certain nodes, make sure none of them
   * are already entryguards */
  if (options->ExcludeNodes) {
    // XXX TODO
  }

831
  /* Since our options changed, we might need to regenerate and upload our
832
   * server descriptor.
833
   */
834
835
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
836
    mark_my_descriptor_dirty();
837

838
  return 0;
839
840
841
842
843
844
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
845
/** If <b>option</b> is an official abbreviation for a longer option,
846
847
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
848
849
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
850
static const char *
851
852
expand_abbrev(config_format_t *fmt, const char *option, int command_line,
              int warn_obsolete)
853
854
{
  int i;
855
856
857
  if (! fmt->abbrevs)
    return option;
  for (i=0; fmt->abbrevs[i].abbreviated; ++i) {
858
    /* Abbreviations are casei. */
859
860
    if (!strcasecmp(option,fmt->abbrevs[i].abbreviated) &&