config.c 151 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
 **/

14
15
#define CONFIG_PRIVATE

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

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

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

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

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

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

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

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

271
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
272
};
273
274
#undef VAR

275
276
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
277
      initvalue }
278
static config_var_t _state_vars[] = {
279
  VAR("AccountingBytesReadInInterval", MEMUNIT,
280
      AccountingBytesReadInInterval, NULL),
281
282
283
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
284
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
285
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
286
287
288
289
  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
290

291
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
292
293
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
294
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
295
296
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
297

298
299
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

300
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
301
302
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

303
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
304
305
};

306
307
308
#undef VAR
#undef OBSOLETE

309
310
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
311
312
313
314
315
316
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
317
  /* ==== general options */
318
319
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
320
321
322
323
324
325
326
327
328
329
330
331
  { "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 "
332
    "can read a file that Tor creates in its data directory." },
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
  { "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 "
357
    "provided IP address (only useful for multiple network interfaces)." },
358
359
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
360
361
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
    "don't support tunneled conncetions." },
362
  /* PreferTunneledDirConns */
363
364
365
366
367
368
  /* 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]." },
369
370
371
  { "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." },
372
373
374
375
376
  { "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\"?" },
377
378
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
379
380
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
381
    "server, even if ORPort is enabled." },
382
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
383
    "in circuits, when possible." },
384
385
386
387
388
  /* { "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 "
389
390
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
391
392
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
393
    "high-uptime connections." },
394
395
396
  { "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 "
397
    "every NUM seconds." },
398
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
399
    "been used more than this many seconds ago." },
400
401
402
403
404
405
406
407
408
  /* 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, "
409
    "when possible." },
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
  { "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 "
425
    "accessed from the same exit node each time we connect to them." },
426
427
428
429
  { "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 "
430
431
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
432
433

  /* === server options */
434
  { "Address", "The advertised (external) address we should use." },
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
  /* 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." },
451
  { "NoPublish", "{DEPRECATED}" },
452
453
454
455
456
  { "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." },
457
  { "PublishServerDescriptors", "Set to \"\" to keep the server from "
458
    "uploading info to the directory authorities." },
459
460
461
462
463
464
465
466
  /*{ "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", } */

467
  /* === directory cache options */
468
469
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
470
  { "DirListenAddress", "Bind to this address to listen for connections from "
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
    "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 */
486
487
488
489
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
490
  { "AccountingBytesReadInInterval",
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
    "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." },

506
507
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
508
    "The last entry guard has been unreachable since this time." },
509
  { "EntryGuardUnlistedSince",
510
    "The last entry guard has been unusable since this time." },
511
512
513
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
514
515
516
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
517
518
519
  { NULL, NULL },
};

520
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
521
 * well-formed and consistent. See options_trial_assign() for documentation
522
 * of arguments. */
523
typedef int (*validate_fn_t)(void*,void*,int,char**);
524

525
526
527
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
528
typedef struct {
529
530
531
  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
532
  off_t magic_offset; /**< Offset of the magic value within the struct. */
533
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
534
                             * parsing this format. */
535
536
537
538
  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. */
539
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
540
541
542
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
543
544
} config_format_t;

545
546
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
547
548
#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
549
    tor_assert((fmt)->magic ==                                          \
550
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
551
552
  } while (0)

553
static void config_line_append(config_line_t **lst,
554
                               const char *key, const char *val);
555
556
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
557
static void option_reset(config_format_t *fmt, or_options_t *options,
558
                         config_var_t *var, int use_defaults);
559
static void config_free(config_format_t *fmt, void *options);
560
static int option_is_same(config_format_t *fmt,
561
562
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
563
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
564
565
566
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);
567
static int options_act(or_options_t *old_options);
568
569
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
570
571
572
573
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);
574
static int check_nickname_list(const char *lst, const char *name, char **msg);
575
static void config_register_addressmaps(or_options_t *options);
576

577
static int parse_bridge_line(const char *line, int validate_only);
578
static int parse_dir_server_line(const char *line, int validate_only);
579
static int parse_redirect_line(smartlist_t *result,
580
                               config_line_t *line, char **msg);
581
582
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
583
static int validate_data_directory(or_options_t *options);
584
static int write_configuration_file(const char *fname, or_options_t *options);
585
static config_line_t *get_assigned_option(config_format_t *fmt,
586
                                     or_options_t *options, const char *key);
587
static void config_init(config_format_t *fmt, void *options);
588
static int or_state_validate(or_state_t *old_options, or_state_t *options,
589
                             int from_setconf, char **msg);
590

591
592
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
593
static void print_svn_version(void);
594
static void init_libevent(void);
595
static int opt_streq(const char *s1, const char *s2);
596
/** Versions of libevent. */
597
typedef enum {
598
599
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
600
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
601
  LE_13, LE_13A,
602
  LE_OTHER
603
604
} le_version_t;
static le_version_t decode_libevent_version(void);
605
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
606
static void check_libevent_version(const char *m, int server);
607
#endif
608

609
/** Magic value for or_options_t. */
610
611
#define OR_OPTIONS_MAGIC 9090909

612
/** Configuration format for or_options_t. */
613
static config_format_t options_format = {
614
615
616
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
617
618
619
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
620
621
  options_description,
  NULL
622
623
};

624
/** Magic value for or_state_t. */
625
626
#define OR_STATE_MAGIC 0x57A73f57

627
628
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
629
630
631
632
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

633
/** Configuration format for or_state_t. */
634
635
636
637
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
638
  _state_abbrevs,
639
640
  _state_vars,
  (validate_fn_t)or_state_validate,
641
642
  state_description,
  &state_extra_var,
643
644
};

645
646
647
648
649
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
650
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
651
/** Name of most recently read torrc file. */
652
static char *torrc_fname = NULL;
653
/** Persistent serialized state. */
654
static or_state_t *global_state = NULL;
655

656
/** Allocate an empty configuration object of a given format type. */
657
658
659
static void *
config_alloc(config_format_t *fmt)
{
660
  void *opts = tor_malloc_zero(fmt->size);
661
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
662
663
664
665
  CHECK(fmt, opts);
  return opts;
}

666
667
/** Return the currently configured options. */
or_options_t *
668
669
get_options(void)
{
670
671
672
  tor_assert(global_options);
  return global_options;
}
673

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

  return 0;
699
700
}

701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
extern const char tor_svn_revision[]; /* from main.c */

/** Return the current Tor version, possibly */
const char *
get_version(void)
{
  static char *version = NULL;
  if (version == NULL) {
    if (strlen(tor_svn_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_svn_revision)+8;
      version = tor_malloc(len);
      tor_snprintf(version, len, "%s (r%s)", VERSION, tor_svn_revision);
    } else {
      version = tor_strdup(VERSION);
    }
  }
  return version;
}

720
721
/** Release all memory and resources held by global configuration structures.
 */
722
723
724
void
config_free_all(void)
{
725
726
727
728
729
730
731
732
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
733
  tor_free(torrc_fname);
734
735
}

736
737
738
739
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
740
741
safe_str(const char *address)
{
742
743
744
745
746
747
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

748
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
749
750
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
751
752
753
754
755
756
757
758
759
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

760
761
762
763
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
764
  int i;
765
  const char *dirservers[] = {
766
    /* eventually we should mark moria1 as "v1only" */
767
    "moria1 v1 orport=9001 18.244.0.188:9031 "
768
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
769
    "moria2 v1 orport=443 18.244.0.114:80 "
770
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
771
    "tor26 v1 orport=443 86.59.21.38:80 "
772
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
773
    "lefkada orport=443 140.247.60.64:80 "
774
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
775
776
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
777
    NULL
778
  };
779
780
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
781
782
}

783
784
785
786
787
788
789
/** 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
790
options_act_reversible(or_options_t *old_options, char **msg)
791
792
793
794
795
796
797
798
{
  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;
799
  int logs_marked = 0;
800
801
802
803
804
805
806
807
808
809

  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. */
810
811
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
812
813
814
815
816
817
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
818
    init_libevent();
819
820
821
822
823
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
824
825
826
827
828
    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");
829
    goto done;
830
    /* No need to roll back, since you can't change the value. */
831
832
833
  }

  /* Bail out at this point if we're not going to be a client or server:
834
   * we don't run Tor itself. */
835
836
837
838
839
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
840
841
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
842
    goto rollback;
843
  }
844
845
846
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
847
    *msg = tor_strdup("Failed to bind one of the listener ports.");
848
849
850
    goto rollback;
  }

851
852
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
853
854
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
855
    goto rollback;
856
  }
857

858
859
 commit:
  r = 0;
860
861
862
863
864
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
865
866
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
867
868
    log_notice(LD_NET, "Closing old %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
869
870
871
872
873
874
875
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;
876
  tor_assert(*msg);
877

878
879
880
881
882