config.c 239 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-2012, 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
#ifdef _WIN32
40
41
#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
93
94
95
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
96
  PLURAL(ExitNode),
97
  PLURAL(EntryNode),
98
99
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
100
  PLURAL(LongLivedPort),
101
102
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
103
  PLURAL(NumCPU),
104
105
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
106
107
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
108
  PLURAL(StrictNode),
109
  { "l", "Log", 1, 0},
110
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
111
112
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
113
114
115
116
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
117
118
119
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
120
121
122
123
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
124
125
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
126
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
127
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
128
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
129
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
130
131
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
132
133
  { NULL, NULL, 0, 0},
};
134
135

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

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

Nick Mathewson's avatar
Nick Mathewson committed
157
158
159
160
/** 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>"
 */
161
162
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
163
      initvalue }
164
165
166
/** 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
167
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
168
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
169

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

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

449
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
450
};
451

452
453
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
454
static const config_var_t testing_tor_network_defaults[] = {
455
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
456
457
458
459
460
461
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
462
  V(ClientRejectInternalAddresses, BOOL,   "0"),
463
  V(CountPrivateBandwidth,       BOOL,     "1"),
464
465
466
467
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
468
469
470
471
472
  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"),
473
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
474
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
475

476
477
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
478
479
#undef VAR

480
481
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
482
      initvalue }
483
484

/** Array of "state" variables saved to the ~/.tor/state file. */
485
static config_var_t _state_vars[] = {
486
487
  /* Remember to document these in state-contents.txt ! */

488
489
490
491
492
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
493
494
495
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
496

497
498
499
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
500
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
501
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
502

503
504
505
  VAR("TransportProxy",               LINELIST_S, TransportProxies, NULL),
  V(TransportProxies,                 LINELIST_V, NULL),

506
507
508
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
509
  V(BWHistoryReadMaxima,              CSV,      ""),
510
511
512
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
513
  V(BWHistoryWriteMaxima,             CSV,      ""),
514
515
516
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
517
  V(BWHistoryDirReadMaxima,           CSV,      ""),
518
519
520
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
521
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
522

523
  V(TorVersion,                       STRING,   NULL),
524

525
526
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
527

528
  V(TotalBuildTimes,                  UINT,     NULL),
529
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
530
531
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
532
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
533
534
};

535
#undef VAR
536
#undef V
537
538
#undef OBSOLETE

539
540
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
541
542
543
544
545
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

546
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
547
 * well-formed and consistent. See options_trial_assign() for documentation
548
 * of arguments. */
549
typedef int (*validate_fn_t)(void*,void*,int,char**);
550

551
552
553
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
554
typedef struct {
555
556
557
  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
558
  off_t magic_offset; /**< Offset of the magic value within the struct. */
559
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
560
                             * parsing this format. */
561
562
563
  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
564
565
566
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
567
568
} config_format_t;

569
570
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
571
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
572
    tor_assert(fmt && cfg);                                             \
573
    tor_assert((fmt)->magic ==                                          \
574
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
575
  STMT_END
576

577
#ifdef _WIN32
578
579
static char *get_windows_conf_root(void);
#endif
580
static void config_line_append(config_line_t **lst,
581
                               const char *key, const char *val);
582
583
584
585
586
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);
587
static int config_lines_eq(config_line_t *a, config_line_t *b);
588
589
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
590
                          const char *name);
591
592
593
594
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,
595
                            int from_setconf, char **msg);
596
597
598
599
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,
600
                                      char **msg);
601
602
603
604
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);
605
static int check_nickname_list(const char *lst, const char *name, char **msg);
606

607
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
608
static int parse_client_transport_line(const char *line, int validate_only);
609
610

static int parse_server_transport_line(const char *line, int validate_only);
611
static int parse_dir_server_line(const char *line,
612
                                 dirinfo_type_t required_type,
613
                                 int validate_only);
614
static void port_cfg_free(port_cfg_t *port);
615
static int parse_ports(const or_options_t *options, int validate_only,
616
                              char **msg_out, int *n_ports_out);
617
618
619
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

620
static int validate_data_directory(or_options_t *options);
621
622
623
624
625
626
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);
627
static int or_state_validate(or_state_t *old_options, or_state_t *options,
628
                             int from_setconf, char **msg);
629
630
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
631

632
static uint64_t config_parse_memunit(const char *s, int *ok);
633
static int config_parse_msec_interval(const char *s, int *ok);
634
static int config_parse_interval(const char *s, int *ok);
635
static void init_libevent(const or_options_t *options);
636
static int opt_streq(const char *s1, const char *s2);
637

638
/** Magic value for or_options_t. */
639
640
#define OR_OPTIONS_MAGIC 9090909

641
/** Configuration format for or_options_t. */
642
static config_format_t options_format = {
643
644
645
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
646
647
648
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
649
  NULL
650
651
};

652
/** Magic value for or_state_t. */
653
654
#define OR_STATE_MAGIC 0x57A73f57

655
656
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
657
658
659
660
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

661
/** Configuration format for or_state_t. */
662
static const config_format_t state_format = {
663
664
665
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
666
  _state_abbrevs,
667
668
  _state_vars,
  (validate_fn_t)or_state_validate,
669
  &state_extra_var,
670
671
};

672
673
674
675
676
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
677
static or_options_t *global_options = NULL;
678
679
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
680
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
681
/** Name of most recently read torrc file. */
682
static char *torrc_fname = NULL;
683
/** Name of the most recently read torrc-defaults file.*/
684
static char *torrc_defaults_fname;
685
/** Persistent serialized state. */
686
static or_state_t *global_state = NULL;
687
688
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
689
/** Contents of most recently read DirPortFrontPage file. */
690
static char *global_dirfrontpagecontents = NULL;
691
692
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
693
694
695
696
697
698
699

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

701
/** Allocate an empty configuration object of a given format type. */
702
static void *
703
config_alloc(const config_format_t *fmt)
704
{
705
  void *opts = tor_malloc_zero(fmt->size);
706
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
707
708
709
710
  CHECK(fmt, opts);
  return opts;
}

711
712
/** Return the currently configured options. */
or_options_t *
713
get_options_mutable(void)
714
{
715
716
717
  tor_assert(global_options);
  return global_options;
}
718

719
720
721
722
723
724
725
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

726
727
/** 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
728
 * as necessary.  Returns 0 on success, -1 on failure.
729
 */
730
int
731
set_options(or_options_t *new_val, char **msg)