config.c 192 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
#include "procmon.h"

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

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

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

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

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

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

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

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

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

424
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
425
};
426

427
428
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
429
static config_var_t testing_tor_network_defaults[] = {
430
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
431
432
433
434
435
436
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
437
  V(ClientRejectInternalAddresses, BOOL,   "0"),
438
  V(CountPrivateBandwidth,       BOOL,     "1"),
439
440
441
442
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
443
444
445
446
447
  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"),
448
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
449
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
450

451
452
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
453
454
#undef VAR

455
456
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
457
      initvalue }
458
459

/** Array of "state" variables saved to the ~/.tor/state file. */
460
static config_var_t _state_vars[] = {
461
462
463
464
465
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
466
467
468
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
469

470
471
472
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
473
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
474
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
475

476
477
478
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
479
  V(BWHistoryReadMaxima,              CSV,      ""),
480
481
482
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
483
  V(BWHistoryWriteMaxima,             CSV,      ""),
484
485
486
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
487
  V(BWHistoryDirReadMaxima,           CSV,      ""),
488
489
490
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
491
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
492

493
  V(TorVersion,                       STRING,   NULL),
494

495
496
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
497

498
  V(TotalBuildTimes,                  UINT,     NULL),
499
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
500
501
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
502

503
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
504
505
};

506
#undef VAR
507
#undef V
508
509
#undef OBSOLETE

510
511
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
512
513
514
515
516
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

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

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

540
541
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
542
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
543
    tor_assert(fmt && cfg);                                             \
544
    tor_assert((fmt)->magic ==                                          \
545
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
546
  STMT_END
547

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

Nick Mathewson's avatar
Nick Mathewson committed
576
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
577
static int parse_client_transport_line(const char *line, int validate_only);
578
579

static int parse_server_transport_line(const char *line, int validate_only);
580
static int parse_dir_server_line(const char *line,
581
                                 dirinfo_type_t required_type,
582
                                 int validate_only);
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
587
                                          void *options, const char *key,
                                          int escape_val);
588
static void config_init(config_format_t *fmt, void *options);
589
static int or_state_validate(or_state_t *old_options, or_state_t *options,
590
                             int from_setconf, char **msg);
591
592
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
593

594
static int is_listening_on_low_port(int port_option,
595
596
                                    const config_line_t *listen_options);

597
static uint64_t config_parse_memunit(const char *s, int *ok);
598
static int config_parse_msec_interval(const char *s, int *ok);
599
static int config_parse_interval(const char *s, int *ok);
600
static void init_libevent(const or_options_t *options);
601
static int opt_streq(const char *s1, const char *s2);
602

603
/** Magic value for or_options_t. */
604
605
#define OR_OPTIONS_MAGIC 9090909

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

617
/** Magic value for or_state_t. */
618
619
#define OR_STATE_MAGIC 0x57A73f57

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

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

637
638
639
640
641
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
642
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
643
/** Name of most recently read torrc file. */
644
static char *torrc_fname = NULL;
645
/** Persistent serialized state. */
646
static or_state_t *global_state = NULL;
647
648
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
649
/** Contents of most recently read DirPortFrontPage file. */
650
651
652
653
654
655
656
657
static char *global_dirfrontpagecontents = NULL;

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

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

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

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

  config_free(&options_format, old_options);
700
701

  return 0;
702
703
}

704
extern const char tor_git_revision[]; /* from tor_main.c */
705

706
/** The version of this Tor process, as parsed. */
707
708
static char *_version = NULL;

709
/** Return the current Tor version. */
710
711
712
const char *
get_version(void)
{
713
  if (_version == NULL) {
714
715
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
716
      _version = tor_malloc(len);
717
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
718
    } else {
719
      _version = tor_strdup(VERSION);
720
721
    }
  }
722
  return _version;
723
724
}

725
726
727
728
729
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
730
731
732
  if (!options)
    return;

733
  routerset_free(options->_ExcludeExitNodesUnion);
734
735
736
737
738
  if (options