config.c 216 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-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2011, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
6

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

12
13
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "connection_edge.h"
20
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "networkstatus.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "router.h"
36
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "routerlist.h"
38
#include "transports.h"
39
40
41
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
42

43
44
45
46
47
#include "procmon.h"

/* From main.c */
extern int quiet_level;

Nick Mathewson's avatar
Nick Mathewson committed
48
49
/** Enumeration of types which option values can take */
typedef enum config_type_t {
50
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
51
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
52
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
53
54
  CONFIG_TYPE_PORT,         /**< A port from 1...65535, 0 for "not set", or
                             * "auto".  */
55
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
56
57
  CONFIG_TYPE_MSEC_INTERVAL,/**< A number of milliseconds, with optional
                              * units */
58
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
59
60
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
61
62
  CONFIG_TYPE_AUTOBOOL,     /**< A boolean+auto value, expressed 0 for false,
                             * 1 for true, and -1 for auto  */
Nick Mathewson's avatar
Nick Mathewson committed
63
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
64
65
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
66
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
67
68
69
70
71
  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.
                             */
72
73
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
74
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
75
} config_type_t;
76

77
/** An abbreviation for a configuration option allowed on the command line. */
78
typedef struct config_abbrev_t {
79
80
  const char *abbreviated;
  const char *full;
81
  int commandline_only;
82
  int warn;
83
84
} config_abbrev_t;

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

89
90
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
91
static config_abbrev_t _option_abbrevs[] = {
92
  PLURAL(ExitNode),
93
  PLURAL(EntryNode),
94
95
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
96
  PLURAL(LongLivedPort),
97
98
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
99
  PLURAL(NumCPU),
100
101
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
102
103
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
104
  PLURAL(StrictNode),
105
  { "l", "Log", 1, 0},
106
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
107
108
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
109
110
111
112
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
113
114
115
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
116
117
118
119
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
120
121
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
122
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
123
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
124
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
125
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
126
127
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
128
129
  { NULL, NULL, 0, 0},
};
130
131

/** A list of state-file "abbreviations," for compatibility. */
132
static config_abbrev_t _state_abbrevs[] = {
133
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
134
135
136
137
138
139
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
140
  { NULL, NULL, 0, 0},
141
};
142
#undef PLURAL
143

144
/** A variable allowed in the configuration file or on the command line. */
145
typedef struct config_var_t {
146
  const char *name; /**< The full keyword (case insensitive). */
147
148
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
149
150
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
151
152
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
153
154
155
156
/** 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>"
 */
157
158
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
159
      initvalue }
160
161
162
/** As VAR, but the option name and member name are the same. */
#define V(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member, initvalue)
Nick Mathewson's avatar
Nick Mathewson committed
163
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
164
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
165

Nick Mathewson's avatar
Nick Mathewson committed
166
167
168
169
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
170
static config_var_t _option_vars[] = {
171
  OBSOLETE("AccountingMaxKB"),
172
173
174
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
175
  V(AllowDotExit,                BOOL,     "0"),
176
177
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
178
179
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
180
181
182
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
  V(AlternateHSAuthority,        LINELIST, NULL),
183
  V(AssumeReachable,             BOOL,     "0"),
184
  V(AuthDirBadDir,               LINELIST, NULL),
185
186
  V(AuthDirBadExit,              LINELIST, NULL),
  V(AuthDirInvalid,              LINELIST, NULL),
187
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
188
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "250 KB"),
189
190
  V(AuthDirReject,               LINELIST, NULL),
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
191
  V(AuthDirListBadDirs,          BOOL,     "0"),
192
  V(AuthDirListBadExits,         BOOL,     "0"),
193
194
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
195
196
197
198
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
199
200
  V(BandwidthBurst,              MEMUNIT,  "10 MB"),
  V(BandwidthRate,               MEMUNIT,  "5 MB"),
201
202
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
203
  V(BridgePassword,              STRING,   NULL),
204
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
205
  V(BridgeRelay,                 BOOL,     "0"),
206
  V(CellStatistics,              BOOL,     "0"),
207
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
208
  V(CircuitBuildTimeout,         INTERVAL, "0"),
209
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
210
  V(CircuitStreamTimeout,        INTERVAL, "0"),
211
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
212
213
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
214
  V(ClientRejectInternalAddresses, BOOL,   "1"),
215
  V(ClientTransportPlugin,       LINELIST, NULL),
216
  V(ConsensusParams,             STRING,   NULL),
217
  V(ConnLimit,                   UINT,     "1000"),
218
  V(ConnDirectionStatistics,     BOOL,     "0"),
219
220
221
222
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
223
  V(ControlPort,                 PORT,     "0"),
224
  V(ControlPortFileGroupReadable,BOOL,     "0"),
225
  V(ControlPortWriteToFile,      FILENAME, NULL),
226
  V(ControlSocket,               LINELIST, NULL),
227
  V(ControlSocketsGroupWritable, BOOL,     "0"),
228
229
230
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
231
  V(CountPrivateBandwidth,       BOOL,     "0"),
232
  V(DataDirectory,               FILENAME, NULL),
233
  OBSOLETE("DebugLogFile"),
234
  V(DirAllowPrivateAddresses,    BOOL,     NULL),
235
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
236
  V(DirListenAddress,            LINELIST, NULL),
237
  OBSOLETE("DirFetchPeriod"),
238
  V(DirPolicy,                   LINELIST, NULL),
239
  V(DirPort,                     PORT,     "0"),
240
  V(DirPortFrontPage,            FILENAME, NULL),
241
  OBSOLETE("DirPostPeriod"),
242
243
244
245
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
246
  V(DirReqStatistics,            BOOL,     "1"),
247
  VAR("DirServer",               LINELIST, DirServers, NULL),
248
  V(DisableAllSwap,              BOOL,     "0"),
249
  V(DisableDebuggerAttachment,   BOOL,     "1"),
250
  V(DisableIOCP,                 BOOL,     "1"),
251
  V(DNSPort,                     LINELIST, NULL),
252
253
254
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
255
  V(EntryNodes,                  ROUTERSET,   NULL),
256
  V(EntryStatistics,             BOOL,     "0"),
257
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
258
259
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
260
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
261
  V(ExitNodes,                   ROUTERSET, NULL),
262
263
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
264
  V(ExitPortStatistics,          BOOL,     "0"),
265
  V(ExtraInfoStatistics,         BOOL,     "1"),
266

valerino's avatar
valerino committed
267
268
269
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
270
  V(FallbackNetworkstatusFile,   FILENAME,
271
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
272
#endif
273
274
275
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
276
  V(FetchDirInfoEarly,           BOOL,     "0"),
277
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
278
279
280
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
281
  V(FetchV2Networkstatus,        BOOL,     "0"),
282
#ifdef WIN32
283
  V(GeoIPFile,                   FILENAME, "<default>"),
284
#else
285
286
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
287
#endif
288
289
  V(GiveGuardFlagTo_CVE_2011_2768_VulnerableRelays,
                                 BOOL,     "0"),
290
  OBSOLETE("Group"),
291
  V(HardwareAccel,               BOOL,     "0"),
292
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
293
294
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
295
  V(HashedControlPassword,       LINELIST, NULL),
296
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
297
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
298
299
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
300
301
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
302
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
303
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
304
  V(HidServAuth,                 LINELIST, NULL),
305
  V(HSAuthoritativeDir,          BOOL,     "0"),
306
  OBSOLETE("HSAuthorityRecordStats"),
307
308
309
310
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
311
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
312
313
314
315
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
316
  OBSOLETE("IgnoreVersion"),
317
318
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
319
  V(LogMessageDomains,           BOOL,     "0"),
320
  OBSOLETE("LinkPadding"),
321
322
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
323
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
324
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
325
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
326
327
328
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
329
  V(MaxClientCircuitsPending,    UINT,     "32"),
330
  V(MaxOnionsPending,            UINT,     "100"),
331
  OBSOLETE("MonthlyAccountingStart"),
332
333
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
334
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
335
  V(NATDListenAddress,           LINELIST, NULL),
336
  V(NATDPort,                    LINELIST, NULL),
337
  V(Nickname,                    STRING,   NULL),
338
  V(WarnUnsafeSocks,              BOOL,     "1"),
Sebastian Hahn's avatar
Sebastian Hahn committed
339
  OBSOLETE("NoPublish"),
340
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
341
  V(NumCPUs,                     UINT,     "0"),
342
343
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
344
  V(ORPort,                      PORT,     "0"),
345
  V(OutboundBindAddress,         STRING,   NULL),
346
  OBSOLETE("PathlenCoinWeight"),
347
348
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
349
  V(PidFile,                     STRING,   NULL),
350
  V(TestingTorNetwork,           BOOL,     "0"),
351
  V(OptimisticData,              AUTOBOOL, "auto"),
352
353
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
Roger Dingledine's avatar
Roger Dingledine committed
354
  V(PreferTunneledDirConns,      BOOL,     "1"),
355
  V(ProtocolWarnings,            BOOL,     "0"),
356
  V(PublishServerDescriptor,     CSV,      "1"),
357
358
359
360
361
362
363
  V(PublishHidServDescriptors,   BOOL,     "1"),
  V(ReachableAddresses,          LINELIST, NULL),
  V(ReachableDirAddresses,       LINELIST, NULL),
  V(ReachableORAddresses,        LINELIST, NULL),
  V(RecommendedVersions,         LINELIST, NULL),
  V(RecommendedClientVersions,   LINELIST, NULL),
  V(RecommendedServerVersions,   LINELIST, NULL),
364
  OBSOLETE("RedirectExit"),
365
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
366
  V(RejectPlaintextPorts,        CSV,      ""),
367
368
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
369
370
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
371
372
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
373
  OBSOLETE("RouterFile"),
374
  V(RunAsDaemon,                 BOOL,     "0"),
375
376
//  V(RunTesting,                  BOOL,     "0"),
  OBSOLETE("RunTesting"), // currently unused
377
  V(SafeLogging,                 STRING,   "1"),
378
  V(SafeSocks,                   BOOL,     "0"),
379
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
380
381
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
382
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
383
384
385
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
386
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
387
388
389
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
390
  V(SocksPort,                   LINELIST, NULL),
391
  V(SocksTimeout,                INTERVAL, "2 minutes"),
392
  OBSOLETE("StatusFetchPeriod"),
393
  V(StrictNodes,                 BOOL,     "0"),
394
  OBSOLETE("SysLog"),
395
  V(TestSocks,                   BOOL,     "0"),
396
  OBSOLETE("TestVia"),
397
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
398
399
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
400
  OBSOLETE("TrafficShaping"),
401
  V(TransListenAddress,          LINELIST, NULL),
402
  V(TransPort,                   LINELIST, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
403
  V(TunnelDirConns,              BOOL,     "1"),
404
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
405
  V(UseBridges,                  BOOL,     "0"),
406
  V(UseEntryGuards,              BOOL,     "1"),
407
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
408
  V(User,                        STRING,   NULL),
409
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
410
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
411
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
412
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
413
414
415
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
416
417
418
419
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
420
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
421
  V(V3BandwidthsFile,            FILENAME, NULL),
422
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
423
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
424
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
425
  V(_UseFilteringSSLBufferevents, BOOL,    "0"),
426
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
427
428
429
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
430
431
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
432
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
433
  V(MinUptimeHidServDirectoryV2, INTERVAL, "25 hours"),
434
  V(VoteOnHidServDirectoriesV2,  BOOL,     "1"),
435
  V(_UsingTestNetworkDefaults,   BOOL,     "0"),
436

437
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
438
};
439

440
441
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
442
static const config_var_t testing_tor_network_defaults[] = {
443
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
444
445
446
447
448
449
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
450
  V(ClientRejectInternalAddresses, BOOL,   "0"),
451
  V(CountPrivateBandwidth,       BOOL,     "1"),
452
453
454
455
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
456
457
458
459
460
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
461
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
462
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
463

464
465
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
466
467
#undef VAR

468
469
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
470
      initvalue }
471
472

/** Array of "state" variables saved to the ~/.tor/state file. */
473
static config_var_t _state_vars[] = {
474
475
476
477
478
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
479
480
481
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
482

483
484
485
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
486
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
487
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
488

489
490
491
  VAR("TransportProxy",               LINELIST_S, TransportProxies, NULL),
  V(TransportProxies,                 LINELIST_V, NULL),

492
493
494
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
495
  V(BWHistoryReadMaxima,              CSV,      ""),
496
497
498
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
499
  V(BWHistoryWriteMaxima,             CSV,      ""),
500
501
502
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
503
  V(BWHistoryDirReadMaxima,           CSV,      ""),
504
505
506
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
507
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
508

509
  V(TorVersion,                       STRING,   NULL),
510

511
512
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
513

514
  V(TotalBuildTimes,                  UINT,     NULL),
515
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
516
517
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
518
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
519
520
};

521
#undef VAR
522
#undef V
523
524
#undef OBSOLETE

525
526
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
527
528
529
530
531
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

532
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
533
 * well-formed and consistent. See options_trial_assign() for documentation
534
 * of arguments. */
535
typedef int (*validate_fn_t)(void*,void*,int,char**);
536

537
538
539
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
540
typedef struct {
541
542
543
  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
544
  off_t magic_offset; /**< Offset of the magic value within the struct. */
545
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
546
                             * parsing this format. */
547
548
549
  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. */
Roger Dingledine's avatar
Roger Dingledine committed
550
551
552
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
553
554
} config_format_t;

555
556
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
557
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
558
    tor_assert(fmt && cfg);                                             \
559
    tor_assert((fmt)->magic ==                                          \
560
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
561
  STMT_END
562

563
564
565
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
566
static void config_line_append(config_line_t **lst,
567
                               const char *key, const char *val);
568
569
570
571
572
static void option_clear(const config_format_t *fmt, or_options_t *options,
                         const config_var_t *var);
static void option_reset(const config_format_t *fmt, or_options_t *options,
                         const config_var_t *var, int use_defaults);
static void config_free(const config_format_t *fmt, void *options);
573
static int config_lines_eq(config_line_t *a, config_line_t *b);
574
575
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
576
                          const char *name);
577
578
579
580
static or_options_t *options_dup(const config_format_t *fmt,
                                 const or_options_t *old);
static int options_validate(or_options_t *old_options,
                            or_options_t *options,
581
                            int from_setconf, char **msg);
582
583
584
585
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_act(const or_options_t *old_options);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
586
                                      char **msg);
587
588
589
590
static int options_transition_affects_workers(
      const or_options_t *old_options, const or_options_t *new_options);
static int options_transition_affects_descriptor(
      const or_options_t *old_options, const or_options_t *new_options);
591
static int check_nickname_list(const char *lst, const char *name, char **msg);
592

593
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
594
static int parse_client_transport_line(const char *line, int validate_only);
595
596

static int parse_server_transport_line(const char *line, int validate_only);
597
static int parse_dir_server_line(const char *line,
598
                                 dirinfo_type_t required_type,
599
                                 int validate_only);
600
static void port_cfg_free(port_cfg_t *port);
601
602
static int parse_client_ports(const or_options_t *options, int validate_only,
                              char **msg_out, int *n_ports_out);
603
static int validate_data_directory(or_options_t *options);
604
605
606
607
608
609
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
static config_line_t *get_assigned_option(const config_format_t *fmt,
                                        const void *options, const char *key,
                                        int escape_val);
static void config_init(const config_format_t *fmt, void *options);
610
static int or_state_validate(or_state_t *old_options, or_state_t *options,
611
                             int from_setconf, char **msg);
612
613
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
614

615
static int is_listening_on_low_port(int port_option,
616
617
                                    const config_line_t *listen_options);

618
static uint64_t config_parse_memunit(const char *s, int *ok);
619
static int config_parse_msec_interval(const char *s, int *ok);
620
static int config_parse_interval(const char *s, int *ok);
621
static void init_libevent(const or_options_t *options);
622
static int opt_streq(const char *s1, const char *s2);
623

624
/** Magic value for or_options_t. */
625
626
#define OR_OPTIONS_MAGIC 9090909

627
/** Configuration format for or_options_t. */
628
static config_format_t options_format = {
629
630
631
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
632
633
634
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
635
  NULL
636
637
};

638
/** Magic value for or_state_t. */
639
640
#define OR_STATE_MAGIC 0x57A73f57

641
642
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
643
644
645
646
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

647
/** Configuration format for or_state_t. */
648
static const config_format_t state_format = {
649
650
651
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
652
  _state_abbrevs,
653
654
  _state_vars,
  (validate_fn_t)or_state_validate,
655
  &state_extra_var,
656
657
};

658
659
660
661
662
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
663
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
664
/** Name of most recently read torrc file. */
665
static char *torrc_fname = NULL;
666
/** Persistent serialized state. */
667
static or_state_t *global_state = NULL;
668
669
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
670
/** Contents of most recently read DirPortFrontPage file. */
671
static char *global_dirfrontpagecontents = NULL;
672
673
/** List of port_cfg_t for client-level (SOCKS, DNS, Trans, NATD) ports. */
static smartlist_t *configured_client_ports = NULL;
674
675
676
677
678
679
680

/** Return the contents of our frontpage string, or NULL if not configured. */
const char *
get_dirportfrontpage(void)
{
  return global_dirfrontpagecontents;
}
681

682
/** Allocate an empty configuration object of a given format type. */
683
static void *
684
config_alloc(const config_format_t *fmt)
685
{
686
  void *opts = tor_malloc_zero(fmt->size);
687
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
688
689
690
691
  CHECK(fmt, opts);
  return opts;
}

692
693
/** Return the currently configured options. */
or_options_t *
694
get_options_mutable(void)
695
{
696
697
698
  tor_assert(global_options);
  return global_options;
}
699

700
701
702
703
704
705
706
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

707
708
/** 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
709
 * as necessary.  Returns 0 on success, -1 on failure.
710
 */
711
int
712
set_options(or_options_t *new_val, char **msg)
713
{
714
715
716
  int i;
  smartlist_t *elements;
  config_line_t *line;
717
  or_options_t *old_options = global_options;
718
  global_options = new_val;
719
720
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
721
722
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
723
724
725
    global_options = old_options;
    return -1;
  }
726
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
727
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
728
            "Acting on config options left us in a broken state. Dying.");
729
730
    exit(1);
  }
731
732
733
734
735
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
  if (old_options) {
    elements = smartlist_create();
    for (i=0; options_format.vars[i].name; ++i) {
736
737
      const config_var_t *var = &options_format.vars[i];
      const char *var_name = var->name;
738
739
740
741
      if (var->type == CONFIG_TYPE_LINELIST_S ||
          var->type == CONFIG_TYPE_OBSOLETE) {
        continue;
      }
742
743
      if (!option_is_same(&options_format, new_val, old_options, var_name)) {
        line = get_assigned_option(&options_format, new_val, var_name, 1);
744
745
746

        if (line) {
          for (; line; line = line->next) {
747
748
            smartlist_add