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

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

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

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

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

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

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

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

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

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

264
265
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
266
      initvalue }
267
static config_var_t _state_vars[] = {
268
  VAR("AccountingBytesReadInInterval", MEMUNIT,
269
      AccountingBytesReadInInterval, NULL),
270
271
272
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
273
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
274
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
275
276
277
278
  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
279

280
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
281
282
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
283
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
284
285
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
286

287
288
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

289
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
290
291
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

292
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
293
294
};

295
296
297
#undef VAR
#undef OBSOLETE

298
299
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
300
301
302
303
304
305
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
306
  /* ==== general options */
307
308
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
309
310
311
312
313
314
315
316
317
318
319
320
  { "BandwidthRate", "A token bucket limits the average incoming bandwidth on "
    "this node to the specified number of bytes per second." },
  { "BandwidthBurst", "Limit the maximum token buffer size (also known as "
    "burst) to the given number of bytes." },
  { "ConnLimit", "Maximum number of simultaneous sockets allowed." },
  /*  ControlListenAddress */
  { "ControlPort", "If set, Tor will accept connections from the same machine "
    "(localhost only) on this port, and allow those connections to control "
    "the Tor process using the Tor Control Protocol (described in"
    "control-spec.txt).", },
  { "CookieAuthentication", "If this option is set to 1, don't allow any "
    "connections to the control port except when the connecting process "
321
    "can read a file that Tor creates in its data directory." },
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
  { "DataDirectory", "Store working data, state, keys, and caches here." },
  { "DirServer", "Tor only trusts directories signed with one of these "
    "servers' keys.  Used to override the standard list of directory "
    "authorities." },
  /* { "FastFirstHopPK", "" }, */
  /* FetchServerDescriptors, FetchHidServDescriptors,
   * FetchUselessDescriptors */
  { "Group", "On startup, setgid to this group." },
  { "HardwareAccel", "If set, Tor tries to use hardware crypto accelerators "
    "when it can." },
  /* HashedControlPassword */
  { "HTTPProxy", "Force Tor to make all HTTP directory requests through this "
    "host:port (or host:80 if port is not set)." },
  { "HTTPProxyAuthenticator", "A username:password pair to be used with "
    "HTTPProxy." },
  { "HTTPSProxy", "Force Tor to make all TLS (SSL) connectinos through this "
    "host:port (or host:80 if port is not set)." },
  { "HTTPSProxyAuthenticator", "A username:password pair to be used with "
    "HTTPSProxy." },
  { "KeepalivePeriod", "Send a padding cell every N seconds to keep firewalls "
    "from closing our connections while Tor is not in use." },
  { "Log", "Where to send logging messages.  Format is "
    "minSeverity[-maxSeverity] (stderr|stdout|syslog|file FILENAME)." },
  { "OutboundBindAddress", "Make all outbound connections originate from the "
346
    "provided IP address (only useful for multiple network interfaces)." },
347
348
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
349
350
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
    "don't support tunneled conncetions." },
351
  /* PreferTunneledDirConns */
352
353
354
355
356
357
  /* ProtocolWarnings */
  /* RephistTrackTime */
  { "RunAsDaemon", "If set, Tor forks and daemonizes to the background when "
    "started.  Unix only." },
  { "SafeLogging", "If set to 0, Tor logs potentially sensitive strings "
    "rather than replacing them with the string [scrubbed]." },
358
359
360
  { "TunnelDirConns", "If non-zero, when a directory server we contact "
    "supports it, we will build a one-hop circuit and make an encrypted "
    "connection via its ORPort." },
361
362
363
364
365
  { "User", "On startup, setuid to this user" },

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
366
367
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
368
369
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
370
    "server, even if ORPort is enabled." },
371
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
372
    "in circuits, when possible." },
373
374
375
376
377
  /* { "EnforceDistinctSubnets" , "" }, */
  { "ExitNodes", "A list of preferred nodes to use for the last hop in "
    "circuits, when possible." },
  { "ExcludeNodes", "A list of nodes never to use when building a circuit." },
  { "FascistFirewall", "If set, Tor will only create outgoing connections to "
378
379
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
380
381
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
382
    "high-uptime connections." },
383
384
385
  { "MapAddress", "Force Tor to treat all requests for one address as if "
    "they were for another." },
  { "NewCircuitPeriod", "Force Tor to consider whether to build a new circuit "
386
    "every NUM seconds." },
387
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
388
    "been used more than this many seconds ago." },
389
390
391
392
393
394
395
396
397
  /* NatdPort, NatdListenAddress */
  { "NodeFamily", "A list of servers that constitute a 'family' and should "
    "never be used in the same circuit." },
  { "NumEntryGuards", "How many entry guards should we keep at a time?" },
  /* PathlenCoinWeight */
  { "ReachableAddresses", "Addresses we can connect to, as IP/bits:port-port. "
    "By default, we assume all addresses are reachable." },
  /* reachablediraddresses, reachableoraddresses. */
  { "RendNodes", "A list of preferred nodes to use for a rendezvous point, "
398
    "when possible." },
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
  { "RendExcludenodes", "A list of nodes never to use as rendezvous points." },
  /* SafeSOCKS */
  { "SOCKSPort", "The port where we listen for SOCKS connections from "
    "applications." },
  { "SOCKSListenAddress", "Bind to this address to listen to connections from "
    "SOCKS-speaking applications." },
  { "SOCKSPolicy", "Set an entry policy to limit which addresses can connect "
    "to the SOCKSPort." },
  /* SocksTimeout */
  { "StrictExitNodes", "If set, Tor will fail to operate when none of the "
    "configured ExitNodes can be used." },
  { "StrictEntryNodes", "If set, Tor will fail to operate when none of the "
    "configured EntryNodes can be used." },
  /* TestSocks */
  { "TrackHostsExit", "Hosts and domains which should, if possible, be "
414
    "accessed from the same exit node each time we connect to them." },
415
416
417
418
  { "TrackHostsExitExpire", "Time after which we forget which exit we were "
    "using to connect to hosts in TrackHostsExit." },
  /* "TransPort", "TransListenAddress */
  { "UseEntryGuards", "Set to 0 if we want to pick from the whole set of "
419
420
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
421
422

  /* === server options */
423
  { "Address", "The advertised (external) address we should use." },
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
  /* Accounting* options. */
  /* AssumeReachable */
  { "ContactInfo", "Administrative contact information to advertise for this "
    "server." },
  { "ExitPolicy", "Address/port ranges for which to accept or reject outgoing "
    "connections on behalf of Tor users." },
  /*  { "ExitPolicyRejectPrivate, "" }, */
  { "MaxAdvertisedBandwidth", "If set, we will not advertise more than this "
    "amount of bandwidth for our bandwidth rate, regardless of how much "
    "bandwidth we actually detect." },
  { "MaxOnionsPending", "Reject new attempts to extend circuits when we "
    "already have this many pending." },
  { "MyFamily", "Declare a list of other servers as belonging to the same "
    "family as this one, so that clients will not use two from the same "
    "family in the same circuit." },
  { "Nickname", "Set the server nickname." },
440
  { "NoPublish", "{DEPRECATED}" },
441
442
443
444
445
  { "NumCPUs", "How many processes to use at once for public-key crypto." },
  { "ORPort", "Advertise this port to listen for connections from Tor clients "
    "and servers." },
  { "ORListenAddress", "Bind to this address to listen for connections from "
    "clients and servers, instead of the default 0.0.0.0:ORPort." },
446
  { "PublishServerDescriptors", "Set to 0 in order to keep the server from "
447
    "uploading info to the directory authorities." },
448
449
450
451
452
453
454
455
  /*{ "RedirectExit", "When an outgoing connection tries to connect to a "
   *"given address, redirect it to another address instead." },
   */
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },
  /* { "TestVia", } */

456
  /* === directory cache options */
457
458
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
459
  { "DirListenAddress", "Bind to this address to listen for connections from "
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
    "clients and servers, instead of the default 0.0.0.0:DirPort." },
  { "DirPolicy", "Set a policy to limit who can connect to the directory "
    "port" },

  /*  Authority options: AuthDirBadExit, AuthDirInvalid, AuthDirReject,
   * AuthDirRejectUnlisted, AuthDirListBadExits, AuthoritativeDirectory,
   * DirAllowPrivateAddresses, HSAuthoritativeDir,
   * NamingAuthoritativeDirectory, RecommendedVersions,
   * RecommendedClientVersions, RecommendedServerVersions, RendPostPeriod,
   * RunTesting, V1AuthoritativeDirectory, VersioningAuthoritativeDirectory, */

  /* Hidden service options: HiddenService: dir,excludenodes, nodes,
   * options, port.  PublishHidServDescriptor */

  /* Nonpersistent options: __LeaveStreamsUnattached, __AllDirActionsPrivate */
475
476
477
478
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
479
  { "AccountingBytesReadInInterval",
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
    "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." },

495
496
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
497
    "The last entry guard has been unreachable since this time." },
498
  { "EntryGuardUnlistedSince",
499
    "The last entry guard has been unusable since this time." },
500
501
502
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
503
504
505
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
506
507
508
  { NULL, NULL },
};

509
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
510
 * well-formed and consistent. See options_trial_assign() for documentation
511
 * of arguments. */
512
typedef int (*validate_fn_t)(void*,void*,int,char**);
513

514
515
516
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
517
typedef struct {
518
519
520
  size_t size; /**< Size of the struct that everything gets parsed into. */
  uint32_t magic; /**< Required 'magic value' to make sure we have a struct
                   * of the right type. */
Roger Dingledine's avatar
Roger Dingledine committed
521
  off_t magic_offset; /**< Offset of the magic value within the struct. */
522
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
523
                             * parsing this format. */
524
525
526
527
  config_var_t *vars; /**< List of variables we recognize, their default
                       * values, and where we stick them in the structure. */
  validate_fn_t validate_fn; /**< Function to validate config. */
  /** Documentation for configuration variables. */
528
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
529
530
531
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
532
533
} config_format_t;

534
535
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
536
537
#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
538
    tor_assert((fmt)->magic ==                                          \
539
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
540
541
  } while (0)

542
static void config_line_append(config_line_t **lst,
543
                               const char *key, const char *val);
544
545
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
546
static void option_reset(config_format_t *fmt, or_options_t *options,
547
                         config_var_t *var, int use_defaults);
548
static void config_free(config_format_t *fmt, void *options);
549
static int option_is_same(config_format_t *fmt,
550
551
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
552
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
553
554
555
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);
556
static int options_act(or_options_t *old_options);
557
558
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
559
560
561
562
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);
563
static int check_nickname_list(const char *lst, const char *name, char **msg);
564
static void config_register_addressmaps(or_options_t *options);
565

566
static int parse_dir_server_line(const char *line, int validate_only);
567
static int parse_redirect_line(smartlist_t *result,
568
                               config_line_t *line, char **msg);
569
570
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
571
static int validate_data_directory(or_options_t *options);
572
static int write_configuration_file(const char *fname, or_options_t *options);
573
static config_line_t *get_assigned_option(config_format_t *fmt,
574
                                     or_options_t *options, const char *key);
575
static void config_init(config_format_t *fmt, void *options);
576
static int or_state_validate(or_state_t *old_options, or_state_t *options,
577
                             int from_setconf, char **msg);
578

579
580
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
581
static void print_svn_version(void);
582
static void init_libevent(void);
583
static int opt_streq(const char *s1, const char *s2);
584
/** Versions of libevent. */
585
typedef enum {
586
587
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
588
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
589
  LE_13, LE_13A,
590
  LE_OTHER
591
592
} le_version_t;
static le_version_t decode_libevent_version(void);
593
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
594
static void check_libevent_version(const char *m, int server);
595
#endif
596

597
598
/*static*/ or_options_t *options_new(void);

599
/** Magic value for or_options_t. */
600
601
#define OR_OPTIONS_MAGIC 9090909

602
/** Configuration format for or_options_t. */
603
static config_format_t options_format = {
604
605
606
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
607
608
609
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
610
611
  options_description,
  NULL
612
613
};

614
/** Magic value for or_state_t. */
615
616
#define OR_STATE_MAGIC 0x57A73f57

617
618
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
619
620
621
622
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

623
/** Configuration format for or_state_t. */
624
625
626
627
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
628
  _state_abbrevs,
629
630
  _state_vars,
  (validate_fn_t)or_state_validate,
631
632
  state_description,
  &state_extra_var,
633
634
};

635
636
637
638
639
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
640
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
641
/** Name of most recently read torrc file. */
642
static char *torrc_fname = NULL;
643
/** Persistent serialized state. */
644
static or_state_t *global_state = NULL;
645

646
/** Allocate an empty configuration object of a given format type. */
647
648
649
static void *
config_alloc(config_format_t *fmt)
{
650
  void *opts = tor_malloc_zero(fmt->size);
651
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
652
653
654
655
  CHECK(fmt, opts);
  return opts;
}

656
657
/** Return the currently configured options. */
or_options_t *
658
659
get_options(void)
{
660
661
662
  tor_assert(global_options);
  return global_options;
}
663

664
665
666
/** 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.
667
 */
668
int
669
set_options(or_options_t *new_val, char **msg)
670
{
671
  or_options_t *old_options = global_options;
672
  global_options = new_val;
673
674
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
675
676
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
677
678
679
    global_options = old_options;
    return -1;
  }
680
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
681
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
682
            "Acting on config options left us in a broken state. Dying.");
683
684
685
    exit(1);
  }
  if (old_options)
686
    config_free(&options_format, old_options);
687
688

  return 0;
689
690
}

691
692
/** Release all memory and resources held by global configuration structures.
 */
693
694
695
void
config_free_all(void)
{
696
697
698
699
700
701
702
703
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
704
  tor_free(torrc_fname);
705
706
}

707
708
709
710
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
711
712
safe_str(const char *address)
{
713
714
715
716
717
718
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

719
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
720
721
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
722
723
724
725
726
727
728
729
730
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

731
732
733
734
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
735
  int i;
736
  const char *dirservers[] = {
737
    /* eventually we should mark moria1 as "v1only" */
738
    "moria1 v1 orport=9001 18.244.0.188:9031 "
739
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
740
    "moria2 v1 orport=443 18.244.0.114:80 "
741
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
742
    "tor26 v1 orport=443 86.59.21.38:80 "
743
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
744
    "lefkada orport=443 140.247.60.64:80 "
745
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
746
747
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
748
    NULL
749
  };
750
751
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
752
753
}

754
755
756
757
758
759
760
/** 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
761
options_act_reversible(or_options_t *old_options, char **msg)
762
763
764
765
766
767
768
769
{
  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;
770
  int logs_marked = 0;
771
772
773
774
775
776
777
778
779
780

  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. */
781
782
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
783
784
785
786
787
788
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
789
    init_libevent();
790
791
792
793
794
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
795
796
797
798
799
    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");
800
    goto done;
801
    /* No need to roll back, since you can't change the value. */
802
803
804
  }

  /* Bail out at this point if we're not going to be a client or server:
805
   * we don't run Tor itself. */
806
807
808
809
810
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
811
812
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
813
    goto rollback;
814
  }
815
816
817
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
818
    *msg = tor_strdup("Failed to bind one of the listener ports.");
819
820
821
    goto rollback;
  }

822
823
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
824
825
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
826
    goto rollback;
827
  }
828

829
830
 commit:
  r = 0;
831
832
833
834
835
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
836
837
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
838
839
    log_notice(LD_NET, "Closing old %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
840
841
842
843
844
845
846
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;
847
  tor_assert(*msg);
848

849
850
851
852
853
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

854
855
856
857
858
  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
859
    log_notice(LD_NET, "Closing partially-constructed listener %s on %s:%d",
Roger Dingledine's avatar
Roger Dingledine committed
860
               conn_type_to_string(conn->type), conn->address, conn->port);
861
862
863
864
865
866
867
868
869
870
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

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

871
872
873
/** 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.
874
 *
875
 * Return 0 if all goes well, return -1 if it's time to die.
876
 *
877
 * Note: We haven't moved all the "act on new configuration" logic
878
 * here yet.  Some is still in do_hup() and other places.
879
 */
880
881
static int
options_act(or_options_t *old_options)
882
{