config.c 127 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
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
239
  VAR("User",                STRING,   User,                 NULL),
240
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
241
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
242
  VAR("VirtualAddrNetwork",  STRING,   VirtualAddrNetwork,   "127.192.0.0/10"),
243
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
244
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
245
};
246
247
#undef VAR

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

264
265
266
267
268
269
270
  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),

271
272
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

273
274
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

275
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
276
277
};

278
279
280
#undef VAR
#undef OBSOLETE

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

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

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

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

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

322
typedef int (*validate_fn_t)(void*,void*,int,char**);
323

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

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

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

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

390
391
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
392
static void print_cvs_version(void);
393
static void init_libevent(void);
394
static int opt_streq(const char *s1, const char *s2);
395
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
396
static void check_libevent_version(const char *m, const char *v, int server);
397
#endif
398

399
400
/*static*/ or_options_t *options_new(void);

401
402
#define OR_OPTIONS_MAGIC 9090909

403
static config_format_t options_format = {
404
405
406
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
407
408
409
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
410
411
  options_description,
  NULL
412
413
414
415
};

#define OR_STATE_MAGIC 0x57A73f57

416
417
418
419
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

420
421
422
423
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
424
  _state_abbrevs,
425
426
  _state_vars,
  (validate_fn_t)or_state_validate,
427
428
  state_description,
  &state_extra_var,
429
430
};

431
432
433
434
435
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
436
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
437
/** Name of most recently read torrc file. */
438
static char *torrc_fname = NULL;
439
/** Persistent serialized state. */
440
static or_state_t *global_state = NULL;
441

442
/** Allocate an empty configuration object of a given format type. */
443
444
445
446
static void *
config_alloc(config_format_t *fmt)
{
  void *opts = opts = tor_malloc_zero(fmt->size);
447
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
448
449
450
451
  CHECK(fmt, opts);
  return opts;
}

452
453
/** Return the currently configured options. */
or_options_t *
454
455
get_options(void)
{
456
457
458
  tor_assert(global_options);
  return global_options;
}
459

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

  return 0;
485
486
}

487
488
/** Release all memory and resources held by global configuration structures.
 */
489
490
491
void
config_free_all(void)
{
492
493
494
495
496
497
498
499
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
500
  tor_free(torrc_fname);
501
502
}

503
504
505
506
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
507
508
safe_str(const char *address)
{
509
510
511
512
513
514
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

515
/** Equivalent to escaped(safe_str(address)) */
516
517
518
519
520
521
522
523
524
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

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

548
549
550
551
552
553
554
/** 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
555
options_act_reversible(or_options_t *old_options, char **msg)
556
557
558
559
560
561
562
563
{
  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;
564
  int logs_marked = 0;
565
566
567
568
569
570
571
572
573
574

  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. */
575
576
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
577
578
579
580
581
582
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
583
    init_libevent();
584
585
586
587
588
    libevent_initialized = 1;
  }

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

  /* Bail out at this point if we're not going to be a client or server:
599
   * we don't run Tor itself. */
600
601
602
603
604
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
605
606
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
607
    goto rollback;
608
  }
609
610
611
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
612
    *msg = tor_strdup("Failed to bind one of the listener ports.");
613
614
615
    goto rollback;
  }

616
617
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
618
619
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
620
    goto rollback;
621
  }
622

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

 rollback:
  r = -1;
641
  tor_assert(*msg);
642

643
644
645
646
647
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

648
649
650
651
652
  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
653
654
    log_notice(LD_NET, "Closing %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
655
656
657
658
659
660
661
662
663
664
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

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

  clear_trusted_dir_servers();
685
686
687
  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
688
        log_err(LD_BUG,
689
690
691
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
692
    }
693
694
  } else {
    add_default_trusted_dirservers();
695
696
  }

697
  if (running_tor && rend_config_services(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
698
699
    log_err(LD_BUG,
       "Bug: Previously validated hidden services line could not be added!");
700
    return -1;
701
  }
702

703
704
705
706
707
  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
708
709
      log_err(LD_CONFIG,
              "Couldn't access/create private data directory \"%s\"", fn);
710
711
712
      tor_free(fn);
      return -1;
    }
713
714
    tor_free(fn);
  }
715

716
717
  /* 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. */
718
719
720
  if (options->command != CMD_RUN_TOR)
    return 0;

721
722
723
724
725
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

726
727
  {
    smartlist_t *sl = smartlist_create();
728
    char *errmsg = NULL;
729
    for (cl = options->RedirectExit; cl; cl = cl->next) {
730
      if (parse_redirect_line(sl, cl, &errmsg)<0) {
731
732
        log_warn(LD_CONFIG, "%s", errmsg);
        tor_free(errmsg);
733
        return -1;
734
      }
735
736
737
738
    }
    set_exit_redirects(sl);
  }

739
  /* Finish backgrounding the process */
740
  if (running_tor && options->RunAsDaemon) {
741
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
742
    finish_daemon(options->DataDirectory);
743
744
745
746
  }

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

750
751
  /* Register addressmap directives */
  config_register_addressmaps(options);
752
  parse_virtual_addr_network(options->VirtualAddrNetwork, 0, &msg);
753

754
  /* Update address policies. */
755
  policies_parse_from_options(options);
756

757
758
  init_cookie_authentication(options->CookieAuthentication);

759
760
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
Roger Dingledine's avatar
Roger Dingledine committed
761
    log_err(LD_GENERAL,"Error loading rendezvous service keys");
762
763
764
    return -1;
  }

765
  /* Set up accounting */
766
  if (accounting_parse_options(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
767
    log_err(LD_CONFIG,"Error in accounting options");
768
769
    return -1;
  }
770
  if (accounting_is_enabled(options))
771
772
    configure_accounting(time(NULL));

773
774
775
  if (!running_tor)
    return 0;

776
777
  /* Check for transitions that need action. */
  if (old_options) {
778
    if (options->UseEntryGuards && !old_options->UseEntryGuards) {
Roger Dingledine's avatar
Roger Dingledine committed
779
780
      log_info(LD_CIRC,
               "Switching to entry guards; abandoning previous circuits");
781
782
783
784
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

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

803
  /* Check if we need to parse and add the EntryNodes config option. */
804
805
806
  if (options->EntryNodes &&
      (!old_options ||
       !opt_streq(old_options->EntryNodes, options->EntryNodes)))
807
808
    entry_nodes_should_be_added();

809
810
811
812
813
814
  /* If the user wants to avoid certain nodes, make sure none of them
   * are already entryguards */
  if (options->ExcludeNodes) {
    // XXX TODO
  }

815
  /* Since our options changed, we might need to regenerate and upload our
816
   * server descriptor.
817
   */
818
819
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
820
    mark_my_descriptor_dirty();
821

822
  return 0;
823
824
825
826
827
828
}

/*
 * Functions to parse config options
 */

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

858
859
860
861
862
/** Helper: Read a list of configuration options from the command line.
 * If successful, put them in *<b>result</b> and return 0, and return
 * -1 and leave *<b>result</b> alone. */
static int
config_get_commandlines(int argc, char **argv, config_line_t **result)
863
{