config.c 132 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
  VAR("DirServer",           LINELIST, DirServers,           NULL),
155
  VAR("EnforceDistinctSubnets", BOOL,  EnforceDistinctSubnets,"1"),
156
157
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
158
159
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
160
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
161
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
162
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
163
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
164
165
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
166
  VAR("FetchUselessDescriptors",BOOL,  FetchUselessDescriptors, "0"),
167
  VAR("Group",               STRING,   Group,                NULL),
168
  VAR("HardwareAccel",       BOOL,     HardwareAccel,        "0"),
169
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
170
171
172
173
174
  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),
175
  VAR("HSAuthoritativeDir",  BOOL,     HSAuthoritativeDir,   "0"),
176
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
177
  VAR("HttpProxyAuthenticator",STRING, HttpProxyAuthenticator,NULL),
178
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
179
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
180
  OBSOLETE("IgnoreVersion"),
181
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
182
  VAR("Log",                 LINELIST, Logs,                 NULL),
183
  OBSOLETE("LinkPadding"),
Nick Mathewson's avatar
Nick Mathewson committed
184
185
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
186
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
187
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
Nick Mathewson's avatar
Nick Mathewson committed
188
189
190
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"128 TB"),
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
191
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
192
  OBSOLETE("MonthlyAccountingStart"),
Nick Mathewson's avatar
Nick Mathewson committed
193
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
194
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
195
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
Nick Mathewson's avatar
Nick Mathewson committed
196
197
198
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
199
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
200
  VAR("NumEntryGuards",      UINT,     NumEntryGuards,       "3"),
201
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
202
  VAR("ORPort",              UINT,     ORPort,               "0"),
203
204
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
Nick Mathewson's avatar
Nick Mathewson committed
205
  VAR("PidFile",             STRING,   PidFile,              NULL),
206
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
207
208
  VAR("PublishServerDescriptor",BOOL,  PublishServerDescriptor,"1"),
  VAR("PublishHidServDescriptors",BOOL,PublishHidServDescriptors, "1"),
209
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
210
211
  VAR("ReachableDirAddresses",LINELIST,ReachableDirAddresses,NULL),
  VAR("ReachableORAddresses",LINELIST, ReachableORAddresses, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
212
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
213
214
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
215
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
216
217
  VAR("RelayBandwidthBurst", MEMUNIT,  RelayBandwidthBurst,  "0"),
  VAR("RelayBandwidthRate",  MEMUNIT,  RelayBandwidthRate,   "0"),
Nick Mathewson's avatar
Nick Mathewson committed
218
219
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
220
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "1 hour"),
221
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
222
  OBSOLETE("RouterFile"),
223
224
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
225
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
226
  VAR("SafeSocks",           BOOL,     SafeSocks,            "0"),
227
  VAR("ServerDNSDetectHijacking",BOOL,   ServerDNSDetectHijacking,"1"),
228
229
  VAR("ServerDNSResolvConfFile", STRING, ServerDNSResolvConfFile, NULL),
  VAR("ServerDNSSearchDomains",  BOOL,   ServerDNSSearchDomains,  "0"),
230
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
231
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
232
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
233
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
234
  VAR("SocksTimeout",        INTERVAL, SocksTimeout,         "2 minutes"),
235
  OBSOLETE("StatusFetchPeriod"),
Nick Mathewson's avatar
Nick Mathewson committed
236
237
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
238
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
239
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
240
  VAR("TestVia",             STRING,   TestVia,              NULL),
Nick Mathewson's avatar
Nick Mathewson committed
241
242
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
243
  OBSOLETE("TrafficShaping"),
244
245
  VAR("TransListenAddress",  LINELIST, TransListenAddress,   NULL),
  VAR("TransPort",           UINT,     TransPort,            "0"),
246
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
247
  VAR("User",                STRING,   User,                 NULL),
248
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
249
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
250
  VAR("VirtualAddrNetwork",  STRING,   VirtualAddrNetwork,   "127.192.0.0/10"),
251
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
252
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
253
};
254
255
#undef VAR

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

272
273
274
275
276
277
278
  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),

279
280
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

281
282
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

283
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
284
285
};

286
287
288
#undef VAR
#undef OBSOLETE

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

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

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

319
320
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
321
    "The last entry guard has been unreachable since this time." },
322
  { "EntryGuardUnlistedSince",
323
    "The last entry guard has been unusable since this time." },
324
325
326
  { "LastWritten", "When was this state file last regenerated?" },

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

330
typedef int (*validate_fn_t)(void*,void*,int,char**);
331

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

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

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

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

398
399
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
400
static void print_svn_version(void);
401
static void init_libevent(void);
402
static int opt_streq(const char *s1, const char *s2);
403
404
405
406
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);
407
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
408
static void check_libevent_version(const char *m, int server);
409
#endif
410

411
412
/*static*/ or_options_t *options_new(void);

413
414
#define OR_OPTIONS_MAGIC 9090909

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

#define OR_STATE_MAGIC 0x57A73f57

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

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

443
444
445
446
447
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

  return 0;
497
498
}

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

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

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

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

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

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

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

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
603
604
605
606
607
    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");
608
    goto done;
609
    /* No need to roll back, since you can't change the value. */
610
611
612
  }

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

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

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

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

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

 rollback:
  r = -1;
655
  tor_assert(*msg);
656

657
658
659
660
661
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

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

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

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

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

  clear_trusted_dir_servers();
699
700
701
  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
702
        log_err(LD_BUG,
703
704
705
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
706
    }
707
708
  } else {
    add_default_trusted_dirservers();
709
710
  }

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

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

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

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

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

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

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

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

768
  /* Update address policies. */
769
  policies_parse_from_options(options);
770

771
772
  init_cookie_authentication(options->CookieAuthentication);

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

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

787
788
789
  if (!running_tor)
    return 0;

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

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

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

827
  /* Since our options changed, we might need to regenerate and upload our
828
   * server descriptor.
829
   */
830
831
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
832
    mark_my_descriptor_dirty();
833

834
  return 0;
835
836
837
838
839
840
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
841
/** If <b>option</b> is an official abbreviation for a longer option,
842
843
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
844
845
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
846
static const char *