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

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

277
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
278
279
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
280
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
281
282
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
283

284
285
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

286
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
287
288
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

289
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
290
291
};

292
293
294
#undef VAR
#undef OBSOLETE

295
296
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
297
298
299
300
301
302
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
303
  { "Address", "The advertised (external) address we should use." },
304
305
306
307
308
  // { "AccountingStart", ""},
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
309
  { "AccountingBytesReadInInterval",
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
    "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." },

325
326
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
327
    "The last entry guard has been unreachable since this time." },
328
  { "EntryGuardUnlistedSince",
329
    "The last entry guard has been unusable since this time." },
330
331
332
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
333
334
335
  { NULL, NULL },
};

336
typedef int (*validate_fn_t)(void*,void*,int,char**);
337

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

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
356
    tor_assert((fmt)->magic ==                                          \
357
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
358
359
  } while (0)

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

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

404
405
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
406
static void print_svn_version(void);
407
static void init_libevent(void);
408
static int opt_streq(const char *s1, const char *s2);
409
/** Versions of libevent. */
410
typedef enum {
411
412
413
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_OTHER
414
415
} le_version_t;
static le_version_t decode_libevent_version(void);
416
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
417
static void check_libevent_version(const char *m, int server);
418
#endif
419

420
421
/*static*/ or_options_t *options_new(void);

422
423
#define OR_OPTIONS_MAGIC 9090909

424
static config_format_t options_format = {
425
426
427
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
428
429
430
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
431
432
  options_description,
  NULL
433
434
435
436
};

#define OR_STATE_MAGIC 0x57A73f57

437
438
439
440
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

441
442
443
444
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
445
  _state_abbrevs,
446
447
  _state_vars,
  (validate_fn_t)or_state_validate,
448
449
  state_description,
  &state_extra_var,
450
451
};

452
453
454
455
456
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
457
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
458
/** Name of most recently read torrc file. */
459
static char *torrc_fname = NULL;
460
/** Persistent serialized state. */
461
static or_state_t *global_state = NULL;
462

463
/** Allocate an empty configuration object of a given format type. */
464
465
466
static void *
config_alloc(config_format_t *fmt)
{
467
  void *opts = tor_malloc_zero(fmt->size);
468
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
469
470
471
472
  CHECK(fmt, opts);
  return opts;
}

473
474
/** Return the currently configured options. */
or_options_t *
475
476
get_options(void)
{
477
478
479
  tor_assert(global_options);
  return global_options;
}
480

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

  return 0;
506
507
}

508
509
/** Release all memory and resources held by global configuration structures.
 */
510
511
512
void
config_free_all(void)
{
513
514
515
516
517
518
519
520
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
521
  tor_free(torrc_fname);
522
523
}

524
525
526
527
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
528
529
safe_str(const char *address)
{
530
531
532
533
534
535
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

536
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
537
538
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
539
540
541
542
543
544
545
546
547
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

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

571
572
573
574
575
576
577
/** 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
578
options_act_reversible(or_options_t *old_options, char **msg)
579
580
581
582
583
584
585
586
{
  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;
587
  int logs_marked = 0;
588
589
590
591
592
593
594
595
596
597

  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. */
598
599
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
600
601
602
603
604
605
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
606
    init_libevent();
607
608
609
610
611
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
612
613
614
615
616
    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");
617
    goto done;
618
    /* No need to roll back, since you can't change the value. */
619
620
621
  }

  /* Bail out at this point if we're not going to be a client or server:
622
   * we don't run Tor itself. */
623
624
625
626
627
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
628
629
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
630
    goto rollback;
631
  }
632
633
634
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
635
    *msg = tor_strdup("Failed to bind one of the listener ports.");
636
637
638
    goto rollback;
  }

639
640
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
641
642
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
643
    goto rollback;
644
  }
645

646
647
 commit:
  r = 0;
648
649
650
651
652
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
653
654
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
655
656
    log_notice(LD_NET, "Closing old %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
657
658
659
660
661
662
663
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;
664
  tor_assert(*msg);
665

666
667
668
669
670
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

671
672
673
674
675
  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
676
    log_notice(LD_NET, "Closing partially-constructed listener %s on %s:%d",
Roger Dingledine's avatar
Roger Dingledine committed
677
               conn_type_to_string(conn->type), conn->address, conn->port);
678
679
680
681
682
683
684
685
686
687
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

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

  clear_trusted_dir_servers();
708
709
710
  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
711
        log_err(LD_BUG,
712
713
714
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
715
    }
716
717
  } else {
    add_default_trusted_dirservers();
718
719
  }

720
  if (running_tor && rend_config_services(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
721
722
    log_err(LD_BUG,
       "Bug: Previously validated hidden services line could not be added!");
723
    return -1;
724
  }
725

726
727
728
729
730
  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
731
732
      log_err(LD_CONFIG,
              "Couldn't access/create private data directory \"%s\"", fn);
733
734
735
      tor_free(fn);
      return -1;
    }
736
737
    tor_free(fn);
  }
738

739
740
  /* 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. */
741
742
743
  if (options->command != CMD_RUN_TOR)
    return 0;

744
745
746
747
748
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

749
750
  {
    smartlist_t *sl = smartlist_create();
751
    char *errmsg = NULL;
752
    for (cl = options->RedirectExit; cl; cl = cl->next) {
753
      if (parse_redirect_line(sl, cl, &errmsg)<0) {
754
755
        log_warn(LD_CONFIG, "%s", errmsg);
        tor_free(errmsg);
756
        return -1;
757
      }
758
759
760
761
    }
    set_exit_redirects(sl);
  }

762
  /* Finish backgrounding the process */
763
  if (running_tor && options->RunAsDaemon) {
764
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
765
    finish_daemon(options->DataDirectory);
766
767
768
769
  }

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

773
774
  /* Register addressmap directives */
  config_register_addressmaps(options);
775
  parse_virtual_addr_network(options->VirtualAddrNetwork, 0, &msg);
776

777
  /* Update address policies. */
778
  policies_parse_from_options(options);
779

780
781
  init_cookie_authentication(options->CookieAuthentication);

782
783
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
Roger Dingledine's avatar
Roger Dingledine committed
784
    log_err(LD_GENERAL,"Error loading rendezvous service keys");
785
786
787
    return -1;
  }

788
  /* Set up accounting */
789
  if (accounting_parse_options(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
790
    log_err(LD_CONFIG,"Error in accounting options");
791
792
    return -1;
  }
793
  if (accounting_is_enabled(options))
794
795
    configure_accounting(time(NULL));

796
797
798
  if (!running_tor)
    return 0;

799
800
  /* Check for transitions that need action. */
  if (old_options) {
801
    if (options->UseEntryGuards && !old_options->UseEntryGuards) {
Roger Dingledine's avatar
Roger Dingledine committed
802
803
      log_info(LD_CIRC,
               "Switching to entry guards; abandoning previous circuits");
804
805
806
807
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

808
    if (options_transition_affects_workers(old_options, options)) {
Roger Dingledine's avatar
Roger Dingledine committed
809
810
      log_info(LD_GENERAL,
               "Worker-related options changed. Rotating workers.");
811
812
      if (server_mode(options) && !server_mode(old_options)) {
        if (init_keys() < 0) {
813
          log_err(LD_BUG,"Error initializing keys; exiting");
814
815
816
          return -1;
        }
        server_has_changed_ip();
Roger Dingledine's avatar
Roger Dingledine committed
817
        if (has_completed_circuit || !any_predicted_circuits(time(NULL)))
818
819
          inform_testing_reachability();
      }
820
      cpuworkers_rotate();
821
      dns_reset();
822
    }
823
824
825
826
827
#ifdef USE_EVENTDNS
    else {
      dns_reset();
    }
#endif
828
829
  }

830
  /* Check if we need to parse and add the EntryNodes config option. */
831
832
833
  if (options->EntryNodes &&
      (!old_options ||
       !opt_streq(old_options->EntryNodes, options->EntryNodes)))
834
835
    entry_nodes_should_be_added();

836
  /* Since our options changed, we might need to regenerate and upload our
837
   * server descriptor.