config.c 137 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
81
82
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
83
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
84
85
86
87
88
89
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
90
  { NULL, NULL, 0, 0},
91
};
92
#undef PLURAL
93

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

Nick Mathewson's avatar
Nick Mathewson committed
103
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
104
105
#define STRUCT_OFFSET(tp, member) \
  ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
106
107
108
109

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

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

Nick Mathewson's avatar
Nick Mathewson committed
120
121
122
123
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
124
static config_var_t _option_vars[] = {
Roger Dingledine's avatar
Roger Dingledine committed
125
  VAR("AccountingMax",       MEMUNIT,  AccountingMax,        "0 bytes"),
Nick Mathewson's avatar
Nick Mathewson committed
126
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
127
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
128
  VAR("Address",             STRING,   Address,              NULL),
129
  VAR("__AllDirActionsPrivate",BOOL,   AllDirActionsPrivate, "0"),
130
  VAR("AllowInvalidNodes",   CSV,      AllowInvalidNodes,
131
                                                        "middle,rendezvous"),
132
  VAR("AssumeReachable",     BOOL,     AssumeReachable,      "0"),
133
134
  VAR("AuthDirInvalid",      LINELIST, AuthDirInvalid,       NULL),
  VAR("AuthDirReject",       LINELIST, AuthDirReject,        NULL),
135
  VAR("AuthDirRejectUnlisted",BOOL,    AuthDirRejectUnlisted,"0"),
136
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
137
138
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "6 MB"),
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "3 MB"),
139
140
  VAR("CircuitBuildTimeout", INTERVAL, CircuitBuildTimeout,  "1 minute"),
  VAR("CircuitIdleTimeout",  INTERVAL, CircuitIdleTimeout,   "1 hour"),
141
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
Nick Mathewson's avatar
Nick Mathewson committed
142
  VAR("ConnLimit",           UINT,     ConnLimit,            "1024"),
143
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
144
  VAR("ControlListenAddress",LINELIST, ControlListenAddress, NULL),
145
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
146
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
147
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
Nick Mathewson's avatar
Nick Mathewson committed
148
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
149
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
150
151
152
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
  /* if DirFetchPeriod is 0, see get_dir_fetch_period() in main.c */
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "0 seconds"),
153
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
154
  VAR("DirPort",             UINT,     DirPort,              "0"),
155
  OBSOLETE("DirPostPeriod"),
156
157
158
  VAR("DirServer",           LINELIST, DirServers,           NULL),
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
159
160
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
161
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
162
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
163
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
164
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
165
166
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
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
186
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
                         "21,22,706,1863,5050,5190,5222,5223,6667,8300,8888"),
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),
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
230
  /* if StatusFetchPeriod is 0, see get_status_fetch_period() in main.c */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "0 seconds"),
Nick Mathewson's avatar
Nick Mathewson committed
231
232
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
233
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
234
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
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("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
243
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
244
};
245
246
#undef VAR

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

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

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

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

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

277
278
279
#undef VAR
#undef OBSOLETE

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

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

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

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

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

Roger Dingledine's avatar
Roger Dingledine committed
321
typedef int (*validate_fn_t)(void*,void*,int);
322

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

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

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

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

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

401
402
/*static*/ or_options_t *options_new(void);

403
404
#define OR_OPTIONS_MAGIC 9090909

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

#define OR_STATE_MAGIC 0x57A73f57

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

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

433
434
435
436
437
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
438
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
439
/** Name of most recently read torrc file. */
440
static char *torrc_fname = NULL;
441
/** Persistent serialized state. */
442
static or_state_t *global_state = NULL;
443
444
/** Parsed addr_policy_t describing which addresses we believe we can start
 * circuits at. */
445
static addr_policy_t *reachable_or_addr_policy = NULL;
446
447
/** Parsed addr_policy_t describing which addresses we believe we can connect
 * to directories at. */
448
static addr_policy_t *reachable_dir_addr_policy = NULL;
449

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

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

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

  return 0;
492
493
}

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

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

530
/** Equivalent to escaped(safe_str(address)) */
531
532
533
534
535
536
537
538
539
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

540
541
542
543
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
544
  int i;
545
  const char *dirservers[] = {
546
547
548
549
550
551
    "moria1 v1 18.244.0.188:9031 "
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
    "moria2 v1 18.244.0.114:80 "
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
    "tor26 v1 86.59.21.38:80 "
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
552
    "lefkada 140.247.60.64:80 "
553
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
554
    NULL
555
  };
556
557
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
558
559
}

560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
/** 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
options_act_reversible(or_options_t *old_options)
{
  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;
576
  int logs_marked = 0;
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599

  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. */
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
    if (init_libevent())
      goto done;
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
600
601
    log_err(LD_FS, "Couldn't access/create private data directory \"%s\"",
            options->DataDirectory);
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
    /* No need to roll back, since you can't change the value. */
    goto done;
  }

  /* Bail out at this point if we're not going to be a client or server:
   * we don't run  */
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
  if (options->_ConnLimit < 0)
    goto rollback;
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
618
    log_err(LD_CONFIG, "Failed to bind one of the listener ports.");
619
620
621
    goto rollback;
  }

622
623
624
625
626
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
  if (options_init_logs(options, 0)<0) /* Configure the log(s) */
    goto rollback;

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

 rollback:
  r = -1;

646
647
648
649
650
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

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

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

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

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

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

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

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

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

728
729
730
731
732
733
734
735
736
  {
    smartlist_t *sl = smartlist_create();
    for (cl = options->RedirectExit; cl; cl = cl->next) {
      if (parse_redirect_line(sl, cl)<0)
        return -1;
    }
    set_exit_redirects(sl);
  }

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

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

748
749
750
  /* Register addressmap directives */
  config_register_addressmaps(options);

751
752
753
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();
754
  parse_authdir_policy();
755
  parse_reachable_addresses();
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
795
796
797
          return -1;
        }
        server_has_changed_ip();
        if (has_completed_circuit)
          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
  /* Since our options changed, we might need to regenerate and upload our
810
   * server descriptor.
811
   */
812
813
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
814
    mark_my_descriptor_dirty();
815

816
  return 0;
817
818
819
820
821
822
}

/*
 * Functions to parse config options
 */

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

852
853
854
855
856
/** 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)
857
{
858
859
  config_line_t *front = NULL;
  config_line_t **new = &front;
860
861
862
  char *s;
  int i = 1;

863
  while (i < argc) {
864
865
866
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
867
      continue;
868
869
    } else if (!strcmp(argv[i],"--list-fingerprint") ||
               !strcmp(argv[i],"--verify-config")) {
870
      i += 1; /* command-line option. ignore it. */
871
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
872
873
874
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
875
    }
876
    if (i == argc-1) {
Roger Dingledine's avatar
Roger Dingledine committed
877
878
      log_warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.",
               argv[i]);
879
880
881
      config_free_lines(front);
      return -1;
    }
882

883
    *new = tor_malloc_zero(sizeof(config_line_t));
884
    s = argv[i];
885

886
    while (*s == '-')
887
      s++;
888

889
    (*new)->key = tor_strdup(expand_abbrev(&options_format, s, 1, 1));
890
891
    (*new)->value = tor_strdup(argv[i+1]);
    (*new)->next = NULL;
892
    log(LOG_DEBUG, LD_CONFIG, "Commandline: parsed keyword '%s', value '%s'",
893
894
895
        (*new)->key, (*new)->value);

    new = &((*new)->next);
896
897
    i += 2;
  }
898
899
  *result = front;
  return 0;