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

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

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

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

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

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

285
286
287
#undef VAR
#undef OBSOLETE

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

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

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

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

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

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

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

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

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

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

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

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

412
413
#define OR_OPTIONS_MAGIC 9090909

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

#define OR_STATE_MAGIC 0x57A73f57

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

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

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

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

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

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

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

  return 0;
496
497
}

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

661
662
663
664
665
  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
666
667
    log_notice(LD_NET, "Closing %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
668
669
670
671
672
673
674
675
676
677
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

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

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

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

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

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

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

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

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

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

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

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

770
771
  init_cookie_authentication(options->CookieAuthentication);

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

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

786
787
788
  if (!running_tor)
    return 0;

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

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

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

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

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

839
  return 0;
840
841
842
843
844
845
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
846
/** If <b>option</b> is an official abbreviation for a longer option,
847
848
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
849
850
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
851
static const char *
852
853
expand_abbrev(config_format_t *fmt, const char *option, int command_line,
              int warn_obsolete)
854
855
{
  int i;
856
857