config.c 136 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
68
69
70
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
71
72
73
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
74
75
76
77
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
78
79
80
81
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
82
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
83
84
85
86
87
88
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
89
  { NULL, NULL, 0, 0},
90
};
91
#undef PLURAL
92

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

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
119
120
121
122
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
123
static config_var_t _option_vars[] = {
Roger Dingledine's avatar
Roger Dingledine committed
124
  VAR("AccountingMax",       MEMUNIT,  AccountingMax,        "0 bytes"),
Nick Mathewson's avatar
Nick Mathewson committed
125
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
126
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
127
  VAR("Address",             STRING,   Address,              NULL),
128
  VAR("__AllDirActionsPrivate",BOOL,   AllDirActionsPrivate, "0"),
129
130
  VAR("AllowUnverifiedNodes",CSV,      AllowUnverifiedNodes,
                                                        "middle,rendezvous"),
131
  VAR("AssumeReachable",     BOOL,     AssumeReachable,      "0"),
132
133
  VAR("AuthDirInvalid",      LINELIST, AuthDirInvalid,       NULL),
  VAR("AuthDirReject",       LINELIST, AuthDirReject,        NULL),
134
  VAR("AuthDirRejectUnlisted",BOOL,    AuthDirRejectUnlisted,"0"),
135
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
136
137
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "6 MB"),
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "3 MB"),
138
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
Nick Mathewson's avatar
Nick Mathewson committed
139
  VAR("ConnLimit",           UINT,     ConnLimit,            "1024"),
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
148
149
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
  /* if DirFetchPeriod is 0, see get_dir_fetch_period() in main.c */
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "0 seconds"),
150
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
151
  VAR("DirPort",             UINT,     DirPort,              "0"),
152
  OBSOLETE("DirPostPeriod"),
153
154
155
  VAR("DirServer",           LINELIST, DirServers,           NULL),
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
156
157
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
158
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
159
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
160
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
161
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
162
163
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
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("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
Nick Mathewson's avatar
Nick Mathewson committed
192
193
194
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
195
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
196
  VAR("NumEntryGuards",      UINT,     NumEntryGuards,       "3"),
197
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
198
  VAR("ORPort",              UINT,     ORPort,               "0"),
199
200
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
Nick Mathewson's avatar
Nick Mathewson committed
201
  VAR("PidFile",             STRING,   PidFile,              NULL),
202
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
203
204
  VAR("PublishServerDescriptor",BOOL,  PublishServerDescriptor,"1"),
  VAR("PublishHidServDescriptors",BOOL,PublishHidServDescriptors, "1"),
205
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
206
207
  VAR("ReachableDirAddresses",LINELIST,ReachableDirAddresses,NULL),
  VAR("ReachableORAddresses",LINELIST, ReachableORAddresses, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
208
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
209
210
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
211
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
212
213
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
214
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "1 hour"),
215
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
216
  OBSOLETE("RouterFile"),
217
218
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
219
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
220
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
221
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
222
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
223
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
224
225
  /* 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
226
227
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
228
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
229
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
Nick Mathewson's avatar
Nick Mathewson committed
230
231
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
232
  OBSOLETE("TrafficShaping"),
233
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
234
  VAR("User",                STRING,   User,                 NULL),
235
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
236
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
237
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
238
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
239
};
240
241
#undef VAR

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

258
259
260
261
262
263
264
  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),

265
266
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

267
268
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

269
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
270
271
};

272
273
274
#undef VAR
#undef OBSOLETE

275
276
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
277
278
279
280
281
282
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
283
  { "Address", "The advertised (external) address we should use." },
284
285
286
287
288
  // { "AccountingStart", ""},
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
289
  { "AccountingBytesReadInInterval",
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
    "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." },

305
306
307
308
309
  { "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." },
310
311
312
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
313
314
315
  { NULL, NULL },
};

Roger Dingledine's avatar
Roger Dingledine committed
316
typedef int (*validate_fn_t)(void*,void*,int);
317

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

#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
336
    tor_assert((fmt)->magic ==                                          \
337
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
338
339
  } while (0)

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

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

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

396
397
/*static*/ or_options_t *options_new(void);

398
399
#define OR_OPTIONS_MAGIC 9090909

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

#define OR_STATE_MAGIC 0x57A73f57

413
414
415
416
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

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

428
429
430
431
432
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

  return 0;
487
488
}

489
490
/** Release all memory and resources held by global configuration structures.
 */
491
492
493
void
config_free_all(void)
{
494
495
496
497
498
499
500
501
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
502
  tor_free(torrc_fname);
503
504
505
506
507
508
509
  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;
510
  }
511
512
}

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

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

535
536
537
538
539
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
  const char *dirservers[] = {
540
541
542
543
544
"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"
  };
545
546
547
548
549
  parse_dir_server_line(dirservers[0], 0);
  parse_dir_server_line(dirservers[1], 0);
  parse_dir_server_line(dirservers[2], 0);
}

550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
/** 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;
566
  int logs_marked = 0;
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589

  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
590
591
    log_err(LD_FS, "Couldn't access/create private data directory \"%s\"",
            options->DataDirectory);
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
    /* 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
608
    log_err(LD_CONFIG, "Failed to bind one of the listener ports.");
609
610
611
    goto rollback;
  }

612
613
614
615
616
  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;

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

 rollback:
  r = -1;

636
637
638
639
640
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

641
642
643
644
645
  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
646
647
    log_notice(LD_NET, "Closing %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
648
649
650
651
652
653
654
655
656
657
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

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

  clear_trusted_dir_servers();
677
678
679
  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
680
        log_err(LD_BUG,
681
682
683
            "Bug: Previously validated DirServer line could not be added!");
        return -1;
      }
684
    }
685
686
  } else {
    add_default_trusted_dirservers();
687
688
  }

689
  if (running_tor && rend_config_services(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
690
691
    log_err(LD_BUG,
       "Bug: Previously validated hidden services line could not be added!");
692
    return -1;
693
  }
694

695
696
697
698
699
  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
700
701
      log_err(LD_CONFIG,
              "Couldn't access/create private data directory \"%s\"", fn);
702
703
704
      tor_free(fn);
      return -1;
    }
705
706
    tor_free(fn);
  }
707

708
709
  /* 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. */
710
711
712
  if (options->command != CMD_RUN_TOR)
    return 0;

713
714
715
716
717
  /* Load state */
  if (! global_state)
    if (or_state_load())
      return -1;

718
719
720
721
722
723
724
725
726
  {
    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);
  }

727
  /* Finish backgrounding the process */
728
  if (running_tor && options->RunAsDaemon) {
729
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
730
    finish_daemon(options->DataDirectory);
731
732
733
734
  }

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

738
739
740
  /* Register addressmap directives */
  config_register_addressmaps(options);

741
742
743
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();
744
  parse_authdir_policy();
745
  parse_reachable_addresses();
746

747
748
  init_cookie_authentication(options->CookieAuthentication);

749
750
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
Roger Dingledine's avatar
Roger Dingledine committed
751
    log_err(LD_GENERAL,"Error loading rendezvous service keys");
752
753
754
    return -1;
  }

755
  /* Set up accounting */
756
  if (accounting_parse_options(options, 0)<0) {
Roger Dingledine's avatar
Roger Dingledine committed
757
    log_err(LD_CONFIG,"Error in accounting options");
758
759
    return -1;
  }
760
  if (accounting_is_enabled(options))
761
762
    configure_accounting(time(NULL));

763
764
765
  if (!running_tor)
    return 0;

766
767
  /* Check for transitions that need action. */
  if (old_options) {
768
    if (options->UseEntryGuards && !old_options->UseEntryGuards) {
Roger Dingledine's avatar
Roger Dingledine committed
769
770
      log_info(LD_CIRC,
               "Switching to entry guards; abandoning previous circuits");
771
772
773
774
      circuit_mark_all_unused_circs();
      circuit_expire_all_dirty_circs();
    }

775
    if (options_transition_affects_workers(old_options, options)) {
Roger Dingledine's avatar
Roger Dingledine committed
776
777
      log_info(LD_GENERAL,
               "Worker-related options changed. Rotating workers.");
778
779
780
      if (server_mode(options) && !server_mode(old_options)) {
        extern int has_completed_circuit;
        if (init_keys() < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
781
          log_err(LD_GENERAL,"Error initializing keys; exiting");
782
783
784
785
786
787
          return -1;
        }
        server_has_changed_ip();
        if (has_completed_circuit)
          inform_testing_reachability();
      }
788
789
790
791
792
      cpuworkers_rotate();
      dnsworkers_rotate();
    }
  }

793
  /* Check if we need to parse and add the EntryNodes config option. */
794
795
796
  if (options->EntryNodes &&
      (!old_options ||
       !opt_streq(old_options->EntryNodes, options->EntryNodes)))
797
798
    entry_nodes_should_be_added();

799
  /* Since our options changed, we might need to regenerate and upload our
800
   * server descriptor.
801
   */
802
803
  if (!old_options ||
      options_transition_affects_descriptor(old_options, options))
804
    mark_my_descriptor_dirty();
805

806
  return 0;
807
808
809
810
811
812
}

/*
 * Functions to parse config options
 */

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

842
843
844
845
846
/** 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)
847
{
848
849
  config_line_t *front = NULL;
  config_line_t **new = &front;
850
851
852
  char *s;
  int i = 1;

853
  while (i < argc) {
854
855
856
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
857
      continue;
858
859
    } else if (!strcmp(argv[i],"--list-fingerprint") ||
               !strcmp(argv[i],"--verify-config")) {
860
      i += 1; /* command-line option. ignore it. */
861
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
862
863
864
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
865
    }
866
    if (i == argc-1) {
Roger Dingledine's avatar
Roger Dingledine committed
867
868
      log_warn(LD_CONFIG,"Command-line option '%s' with no value. Failing.",
               argv[i]);
869
870
871
      config_free_lines(front);
      return -1;
    }
872

873
    *new = tor_malloc_zero(sizeof(config_line_t));
874
    s = argv[i];
875

876
    while (*s == '-')
877
      s++;
878

879
    (*new)->key = tor_strdup(expand_abbrev(&options_format, s, 1, 1));
880
881
    (*new)->value = tor_strdup(argv[i+1]);
    (*new)->next = NULL;
882
    log(LOG_DEBUG, LD_CONFIG, "Commandline: parsed keyword '%s', value '%s'",
883
884
885
        (*new)->key, (*new)->value);

    new = &((*new)->next);
886
887
    i += 2;
  }
888
889
  *result = front;
  return 0;
890
891
}

Nick Mathewson's avatar
Nick Mathewson committed
892
/** Helper: allocate a new configuration option mapping 'key' to 'val',
893
894
 * append it to *<b>lst</b>. */
static void
895
config_line_append(config_line_t **lst,
896
897
                   const char *key,
                   const char *val)
898
{
899
  config_line_t *newline;
900

901
  newline = tor_malloc(sizeof(config_line_t));
902
903
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
904
905
906
907
908
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);