config.c 130 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
3
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
7
const char config_c_id[] = \
  "$Id$";
8

Nick Mathewson's avatar
Nick Mathewson committed
9
/**
10
11
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
12
13
 **/

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
15
16
17
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
18
#include "../common/aes.h"
Roger Dingledine's avatar
Roger Dingledine committed
19

Nick Mathewson's avatar
Nick Mathewson committed
20
21
/** Enumeration of types which option values can take */
typedef enum config_type_t {
22
23
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
24
25
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
26
27
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
28
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formated time relative to GMT. */
29
30
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
31
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
32
33
34
35
36
  CONFIG_TYPE_LINELIST_S,   /**< Uninterpreted, context-sensitive config lines,
                             * mixed with other keywords. */
  CONFIG_TYPE_LINELIST_V,   /**< Catch-all "virtual" option to summarize
                             * context-sensitive config lines when fetching.
                             */
37
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
38
} config_type_t;
39

40
/** An abbreviation for a configuration option allowed on the command line. */
41
typedef struct config_abbrev_t {
42
43
  const char *abbreviated;
  const char *full;
44
  int commandline_only;
45
  int warn;
46
47
} config_abbrev_t;

48
49
/* Handy macro for declaring "In the config file or on the command line,
 * you can abbreviate <b>tok</b>s as <b>tok</b>". */
50
#define PLURAL(tok) { #tok, #tok "s", 0, 0 }
51

Nick Mathewson's avatar
Nick Mathewson committed
52
/* A list of command-line abbreviations. */
53
static config_abbrev_t _option_abbrevs[] = {
54
  PLURAL(ExitNode),
55
  PLURAL(EntryNode),
56
57
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
58
  PLURAL(LongLivedPort),
59
60
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
61
  PLURAL(Nameserver),
62
  PLURAL(NumCpu),
63
64
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
65
66
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
67
  { "l", "Log", 1, 0},
68
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
69
70
71
72
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
73
74
75
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
76
77
78
79
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
80
81
82
83
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
84
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
85
86
87
88
89
90
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
91
  { NULL, NULL, 0, 0},
92
};
93
#undef PLURAL
94

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

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

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

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

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

266
267
268
269
270
271
272
  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),

273
274
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

275
276
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

277
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
278
279
};

280
281
282
#undef VAR
#undef OBSOLETE

283
284
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
285
286
287
288
289
290
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
291
  { "Address", "The advertised (external) address we should use." },
292
293
294
295
296
  // { "AccountingStart", ""},
  { NULL, NULL },
};

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

313
314
315
316
317
  { "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." },
318
319
320
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
321
322
323
  { NULL, NULL },
};

324
typedef int (*validate_fn_t)(void*,void*,int,char**);
325

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

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
344
    tor_assert((fmt)->magic ==                                          \
345
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
346
347
  } while (0)

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

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

392
393
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
394
static void print_cvs_version(void);
395
static void init_libevent(void);
396
static int opt_streq(const char *s1, const char *s2);
397
398
399
400
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);
401
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
402
static void check_libevent_version(const char *m, int server);
403
#endif
404

405
406
/*static*/ or_options_t *options_new(void);

407
408
#define OR_OPTIONS_MAGIC 9090909

409
static config_format_t options_format = {
410
411
412
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
413
414
415
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
416
417
  options_description,
  NULL
418
419
420
421
};

#define OR_STATE_MAGIC 0x57A73f57

422
423
424
425
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

426
427
428
429
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
430
  _state_abbrevs,
431
432
  _state_vars,
  (validate_fn_t)or_state_validate,
433
434
  state_description,
  &state_extra_var,
435
436
};

437
438
439
440
441
/*
 * Functions to read and write the global options pointer.
 */

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

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

458
459
/** Return the currently configured options. */
or_options_t *
460
461
get_options(void)
{
462
463
464
  tor_assert(global_options);
  return global_options;
}
465

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

  return 0;
491
492
}

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

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

521
/** Equivalent to escaped(safe_str(address)) */
522
523
524
525
526
527
528
529
530
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

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

554
555
556
557
558
559
560
/** 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
561
options_act_reversible(or_options_t *old_options, char **msg)
562
563
564
565
566
567
568
569
{
  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;
570
  int logs_marked = 0;
571
572
573
574
575
576
577
578
579
580

  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. */
581
582
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
583
584
585
586
587
588
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
589
    init_libevent();
590
591
592
593
594
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
595
596
597
598
599
    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");
600
    goto done;
601
    /* No need to roll back, since you can't change the value. */
602
603
604
  }

  /* Bail out at this point if we're not going to be a client or server:
605
   * we don't run Tor itself. */
606
607
608
609
610
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
611
612
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
613
    goto rollback;
614
  }
615
616
617
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
618
    *msg = tor_strdup("Failed to bind one of the listener ports.");
619
620
621
    goto rollback;
  }

622
623
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
624
625
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
626
    goto rollback;
627
  }
628

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

 rollback:
  r = -1;
647
  tor_assert(*msg);
648

649
650
651
652
653
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

654
655
656
657
658
  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
659
660
    log_notice(LD_NET, "Closing %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
661
662
663
664
665
666
667
668
669
670
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

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

  clear_trusted_dir_servers();
691
692
693
  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
694
        log_err(LD_BUG,
695
696
697
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
698
    }
699
700
  } else {
    add_default_trusted_dirservers();
701
702
  }

703
  if (running_tor && rend_config_services(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
704
705
    log_err(LD_BUG,
       "Bug: Previously validated hidden services line could not be added!");
706
    return -1;
707
  }
708

709
710
711
712
713
  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
714
715
      log_err(LD_CONFIG,
              "Couldn't access/create private data directory \"%s\"", fn);
716
717
718
      tor_free(fn);
      return -1;
    }
719
720
    tor_free(fn);
  }
721

722
723
  /* 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. */
724
725
726
  if (options->command != CMD_RUN_TOR)
    return 0;

727
728
729
730
731
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

732
733
  {
    smartlist_t *sl = smartlist_create();
734
    char *errmsg = NULL;
735
    for (cl = options->RedirectExit; cl; cl = cl->next) {
736
      if (parse_redirect_line(sl, cl, &errmsg)<0) {
737
738
        log_warn(LD_CONFIG, "%s", errmsg);
        tor_free(errmsg);
739
        return -1;
740
      }
741
742
743
744
    }
    set_exit_redirects(sl);
  }

745
  /* Finish backgrounding the process */
746
  if (running_tor && options->RunAsDaemon) {
747
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
748
    finish_daemon(options->DataDirectory);
749
750
751
752
  }

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

756
757
  /* Register addressmap directives */
  config_register_addressmaps(options);
758
  parse_virtual_addr_network(options->VirtualAddrNetwork, 0, &msg);
759

760
  /* Update address policies. */
761
  policies_parse_from_options(options);
762

763
764
  init_cookie_authentication(options->CookieAuthentication);

765
766
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
Roger Dingledine's avatar
Roger Dingledine committed
767
    log_err(LD_GENERAL,"Error loading rendezvous service keys");
768
769
770
    return -1;
  }

771
  /* Set up accounting */
772
  if (accounting_parse_options(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
773
    log_err(LD_CONFIG,"Error in accounting options");
774
775
    return -1;
  }
776
  if (accounting_is_enabled(options))
777
778
    configure_accounting(time(NULL));

779
780
781
  if (!running_tor)
    return 0;

782
783
  /* Check for transitions that need action. */
  if (old_options) {
784
    if (options->UseEntryGuards && !old_options->UseEntryGuards) {
Roger Dingledine's avatar
Roger Dingledine committed
785
786
      log_info(LD_CIRC,
               "Switching to entry guards; abandoning previous circuits");
787
788
789
790
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

791
    if (options_transition_affects_workers(old_options, options)) {
Roger Dingledine's avatar
Roger Dingledine committed
792
793
      log_info(LD_GENERAL,
               "Worker-related options changed. Rotating workers.");
794
795
      if (server_mode(options) && !server_mode(old_options)) {
        if (init_keys() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
796
          log_err(LD_GENERAL,"Error initializing keys; exiting");
797
798
799
          return -1;
        }
        server_has_changed_ip();
Roger Dingledine's avatar
Roger Dingledine committed
800
        if (has_completed_circuit || !any_predicted_circuits(time(NULL)))
801
802
          inform_testing_reachability();
      }
803
804
805
806
807
      cpuworkers_rotate();
      dnsworkers_rotate();
    }
  }

808
  /* Check if we need to parse and add the EntryNodes config option. */
809
810
811
  if (options->EntryNodes &&
      (!old_options ||
       !opt_streq(old_options->EntryNodes, options->EntryNodes)))
812
813
    entry_nodes_should_be_added();

814
815
816
817
818
819
  /* If the user wants to avoid certain nodes, make sure none of them
   * are already entryguards */
  if (options->ExcludeNodes) {
    // XXX TODO
  }

820
  /* Since our options changed, we might need to regenerate and upload our
821
   * server descriptor.
822
   */
823
824
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
825
    mark_my_descriptor_dirty();
826

827
  return 0;
828
829
830
831
832
833
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
834
/** If <b>option</b> is an official abbreviation for a longer option,
835
836
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
837
838
 * apply abbreviations that work for the config file and the command line.
 * If <b>warn_obsolete</b> is set, warn about deprecated names. */
839
static const char *
840
841
expand_abbrev(config_format_t *fmt, const char *option, int command_line,
              int warn_obsolete)
842
843
{
  int i;
844
845
846
  if (! fmt->abbrevs)
    return option;
  for (i=0; fmt->abbrevs[i].abbreviated; ++i) {
847
    /* Abbreviations are casei. */
848
849
    if (!strcasecmp(option,fmt->abbrevs[i].abbreviated) &&
        (command_line || !fmt->abbrevs[i].commandline_only)) {
850
      if (warn_obsolete && fmt->abbrevs[i].warn) {
Roger Dingledine's avatar
Roger Dingledine committed
851
852
853
854
855
        log_warn(LD_CONFIG,
                 "The configuration option '%s' is deprecated; "
                 "use '%s' instead.",
                 fmt->abbrevs[i].abbreviated,
                 fmt->abbrevs[i].full);
856
      }
857
      return fmt->abbrevs[i].full;
858
    }
859
860
861
  }
  return option;
}