config.c 238 KB
Newer Older
1
/* Copyright (c) 2001 Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2014, 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
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
13
#include "or.h"
14
#include "addressmap.h"
15
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "circuitlist.h"
18
19
#include "circuitmux.h"
#include "circuitmux_ewma.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
20
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "connection_edge.h"
23
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "control.h"
25
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dns.h"
30
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "networkstatus.h"
35
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "router.h"
42
#include "sandbox.h"
43
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
44
#include "routerlist.h"
45
#include "routerset.h"
46
#include "scheduler.h"
47
#include "statefile.h"
48
#include "transports.h"
49
#include "ext_orport.h"
50
#include "torgzip.h"
51
#ifdef _WIN32
52
53
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
54

55
56
57
58
59
#include "procmon.h"

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

60
61
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
62
static config_abbrev_t option_abbrevs_[] = {
63
64
65
66
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
67
  PLURAL(ExitNode),
68
  PLURAL(EntryNode),
69
70
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
71
  PLURAL(LongLivedPort),
72
73
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
74
  PLURAL(NumCPU),
75
76
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
77
78
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
79
  PLURAL(StrictNode),
80
  { "l", "Log", 1, 0},
81
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
82
83
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
84
85
86
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
87
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX024 later, make this warn? */
88
  { "MaxConn", "ConnLimit", 0, 1},
89
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
90
91
92
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
93
94
95
96
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
97
98
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
99
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
100
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
101
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
102
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
103
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
104
  { "_UseFilteringSSLBufferevents", "UseFilteringSSLBufferevents", 0, 1},
105
106
  { NULL, NULL, 0, 0},
};
107

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

121
122
123
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

Nick Mathewson's avatar
Nick Mathewson committed
124
125
126
127
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
128
static config_var_t option_vars_[] = {
129
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
130
  VAR("AccountingRule",          STRING,   AccountingRule_option,  "max"),
131
132
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
133
  V(AllowDotExit,                BOOL,     "0"),
134
135
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
136
137
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
138
139
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
140
  OBSOLETE("AlternateHSAuthority"),
141
  V(AssumeReachable,             BOOL,     "0"),
142
143
  OBSOLETE("AuthDirBadDir"),
  OBSOLETE("AuthDirBadDirCCs"),
144
  V(AuthDirBadExit,              LINELIST, NULL),
145
  V(AuthDirBadExitCCs,           CSV,      ""),
146
  V(AuthDirInvalid,              LINELIST, NULL),
147
  V(AuthDirInvalidCCs,           CSV,      ""),
148
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
149
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
150
  V(AuthDirReject,               LINELIST, NULL),
151
  V(AuthDirRejectCCs,            CSV,      ""),
152
  OBSOLETE("AuthDirRejectUnlisted"),
153
  OBSOLETE("AuthDirListBadDirs"),
154
  V(AuthDirListBadExits,         BOOL,     "0"),
155
156
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
157
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
158
159
160
161
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
162
163
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
164
165
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
166
  V(BridgePassword,              STRING,   NULL),
167
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
168
  V(BridgeRelay,                 BOOL,     "0"),
169
  V(CellStatistics,              BOOL,     "0"),
170
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
171
  V(CircuitBuildTimeout,         INTERVAL, "0"),
172
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
173
  V(CircuitStreamTimeout,        INTERVAL, "0"),
174
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
175
176
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
177
  V(ClientPreferIPv6ORPort,      BOOL,     "0"),
178
  V(ClientRejectInternalAddresses, BOOL,   "1"),
179
  V(ClientTransportPlugin,       LINELIST, NULL),
180
  V(ClientUseIPv6,               BOOL,     "0"),
181
  V(ConsensusParams,             STRING,   NULL),
182
  V(ConnLimit,                   UINT,     "1000"),
183
  V(ConnDirectionStatistics,     BOOL,     "0"),
184
185
186
187
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
188
  VPORT(ControlPort,                 LINELIST, NULL),
189
  V(ControlPortFileGroupReadable,BOOL,     "0"),
190
  V(ControlPortWriteToFile,      FILENAME, NULL),
191
  V(ControlSocket,               LINELIST, NULL),
192
  V(ControlSocketsGroupWritable, BOOL,     "0"),
193
194
195
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
196
  V(CountPrivateBandwidth,       BOOL,     "0"),
197
  V(DataDirectory,               FILENAME, NULL),
198
  V(DisableNetwork,              BOOL,     "0"),
199
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
200
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
201
202
  V(DirListenAddress,            LINELIST, NULL),
  V(DirPolicy,                   LINELIST, NULL),
203
  VPORT(DirPort,                     LINELIST, NULL),
204
  V(DirPortFrontPage,            FILENAME, NULL),
205
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
206
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
207
  V(DirAuthorityFallbackRate,    DOUBLE,   "1.0"),
208
  V(DisableAllSwap,              BOOL,     "0"),
209
  V(DisableDebuggerAttachment,   BOOL,     "1"),
210
  V(DisableIOCP,                 BOOL,     "1"),
211
  OBSOLETE("DisableV2DirectoryInfo_"),
212
  V(DynamicDHGroups,             BOOL,     "0"),
213
  VPORT(DNSPort,                     LINELIST, NULL),
214
215
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
216
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
217
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
218
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
219
  V(EnforceDistinctSubnets,      BOOL,     "1"),
220
  V(EntryNodes,                  ROUTERSET,   NULL),
221
  V(EntryStatistics,             BOOL,     "0"),
222
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
223
224
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
225
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
226
  V(ExitNodes,                   ROUTERSET, NULL),
227
228
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
229
  V(ExitPortStatistics,          BOOL,     "0"),
230
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
231
  VPORT(ExtORPort,               LINELIST, NULL),
232
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
233
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
234
  V(ExtraInfoStatistics,         BOOL,     "1"),
235
  V(FallbackDir,                 LINELIST, NULL),
236

237
  OBSOLETE("FallbackNetworkstatusFile"),
238
239
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
240
  V(FastFirstHopPK,              AUTOBOOL, "auto"),
241
  V(FetchDirInfoEarly,           BOOL,     "0"),
242
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
243
244
245
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
246
  OBSOLETE("FetchV2Networkstatus"),
247
  V(GeoIPExcludeUnknown,         AUTOBOOL, "auto"),
248
#ifdef _WIN32
249
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
250
  V(GeoIPv6File,                 FILENAME, "<default>"),
251
#else
252
253
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
254
255
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
256
#endif
257
  OBSOLETE("Group"),
258
  V(GuardLifetime,               INTERVAL, "0 minutes"),
259
  V(HardwareAccel,               BOOL,     "0"),
260
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
261
262
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
263
  V(HashedControlPassword,       LINELIST, NULL),
264
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
265
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
266
  VAR("HiddenServiceDirGroupReadable",  LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
267
268
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
269
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
270
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
271
  V(HidServAuth,                 LINELIST, NULL),
272
  V(CloseHSClientCircuitsImmediatelyOnTimeout, BOOL, "0"),
273
  V(CloseHSServiceRendCircuitsImmediatelyOnTimeout, BOOL, "0"),
274
275
276
277
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
278
  V(IPv6Exit,                    BOOL,     "0"),
279
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
280
  V(ServerTransportListenAddr,   LINELIST, NULL),
281
  V(ServerTransportOptions,      LINELIST, NULL),
282
283
284
285
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
286
287
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
288
  V(LogMessageDomains,           BOOL,     "0"),
289
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
290
  V(TruncateLogFile,             BOOL,     "0"),
291
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
292
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
293
294
295
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
296
  V(MaxClientCircuitsPending,    UINT,     "32"),
297
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
298
299
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
300
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
301
302
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
303
  OBSOLETE("NamingAuthoritativeDirectory"),
304
  V(NATDListenAddress,           LINELIST, NULL),
305
  VPORT(NATDPort,                    LINELIST, NULL),
306
  V(Nickname,                    STRING,   NULL),
307
  V(PredictedPortsRelevanceTime,  INTERVAL, "1 hour"),
308
  V(WarnUnsafeSocks,              BOOL,     "1"),
309
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
310
  V(NumCPUs,                     UINT,     "0"),
311
  V(NumDirectoryGuards,          UINT,     "0"),
312
  V(NumEntryGuards,              UINT,     "0"),
313
  V(ORListenAddress,             LINELIST, NULL),
314
  VPORT(ORPort,                      LINELIST, NULL),
315
  V(OutboundBindAddress,         LINELIST,   NULL),
316

317
  OBSOLETE("PathBiasDisableRate"),
318
319
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
320
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
321
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
322
  V(PathBiasScaleThreshold,      INT,      "-1"),
323
324
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
325
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
326
327
328
329
330
331
  OBSOLETE("PathBiasUseCloseCounts"),

  V(PathBiasUseThreshold,       INT,      "-1"),
  V(PathBiasNoticeUseRate,          DOUBLE,   "-1"),
  V(PathBiasExtremeUseRate,         DOUBLE,   "-1"),
  V(PathBiasScaleUseThreshold,      INT,      "-1"),
332

333
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
334
335
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
336
  V(PidFile,                     STRING,   NULL),
337
  V(TestingTorNetwork,           BOOL,     "0"),
338
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
339
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
340
  V(OptimisticData,              AUTOBOOL, "auto"),
341
342
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
343
  OBSOLETE("PreferTunneledDirConns"),
344
  V(ProtocolWarnings,            BOOL,     "0"),
345
  V(PublishServerDescriptor,     CSV,      "1"),
346
347
348
349
350
351
352
  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),
353
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
354
  V(RejectPlaintextPorts,        CSV,      ""),
355
356
357
358
359
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
360
  OBSOLETE("RunTesting"), // currently unused
361
  V(Sandbox,                     BOOL,     "0"),
362
  V(SafeLogging,                 STRING,   "1"),
363
  V(SafeSocks,                   BOOL,     "0"),
364
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
365
366
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
367
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
368
369
370
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
371
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
372
373
374
  V(SchedulerLowWaterMark,       MEMUNIT,  "16 kB"),
  V(SchedulerHighWaterMark,      MEMUNIT,  "32 kB"),
  V(SchedulerMaxFlushCells,      UINT,     "16"),
375
376
377
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
378
  VPORT(SocksPort,                   LINELIST, NULL),
379
  V(SocksTimeout,                INTERVAL, "2 minutes"),
380
  V(SSLKeyLifetime,              INTERVAL, "0"),
381
382
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
383
  V(StrictNodes,                 BOOL,     "0"),
384
  OBSOLETE("Support022HiddenServices"),
385
  V(TestSocks,                   BOOL,     "0"),
386
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
387
  V(Tor2webMode,                 BOOL,     "0"),
388
  V(TLSECGroup,                  STRING,   NULL),
389
390
391
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
  V(TransListenAddress,          LINELIST, NULL),
392
  VPORT(TransPort,                   LINELIST, NULL),
393
  V(TransProxyType,              STRING,   "default"),
394
  OBSOLETE("TunnelDirConns"),
395
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
396
  V(UseBridges,                  BOOL,     "0"),
397
  V(UseEntryGuards,              BOOL,     "1"),
398
  V(UseEntryGuardsAsDirGuards,   BOOL,     "1"),
399
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
400
  V(UseNTorHandshake,            AUTOBOOL, "1"),
401
  V(User,                        STRING,   NULL),
402
  V(UserspaceIOCPBuffers,        BOOL,     "0"),
403
  OBSOLETE("V1AuthoritativeDirectory"),
404
  OBSOLETE("V2AuthoritativeDirectory"),
405
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
406
407
408
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
409
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
410
411
412
413
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
414
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
415
  V(V3BandwidthsFile,            FILENAME, NULL),
416
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
417
418
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
419
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
420
  V(UseFilteringSSLBufferevents, BOOL,    "0"),
421
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
422
423
424
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
425
426
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
427
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
428
  V(MinUptimeHidServDirectoryV2, INTERVAL, "25 hours"),
429
  V(VoteOnHidServDirectoriesV2,  BOOL,     "1"),
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 60, 60, 120, "
                                 "300, 900, 2147483647"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 60, 300, 600, "
                                 "2147483647"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 1800, 1800, 1800, "
                                 "1800, 3600, 7200"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 3600, 3600, 3600, "
                                 "10800, 21600, 43200"),
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "3600, 900, 900, 3600"),
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
447
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
448
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
449
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
450

451
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
452
};
453

454
455
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
456
static const config_var_t testing_tor_network_defaults[] = {
457
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
458
459
460
461
462
463
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
464
  V(ClientRejectInternalAddresses, BOOL,   "0"),
465
  V(CountPrivateBandwidth,       BOOL,     "1"),
466
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
467
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
468
469
470
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
471
472
473
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
474
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
475
476
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
477
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 5, 10, 15, "
                                 "20, 30, 60"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, 15, 20, "
                                 "30, 60"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "60, 30, 30, 60"),
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "5 seconds"),
  V(TestingDirConnectionMaxStall, INTERVAL, "30 seconds"),
  V(TestingConsensusMaxDownloadTries, UINT, "80"),
  V(TestingDescriptorMaxDownloadTries, UINT, "80"),
  V(TestingMicrodescMaxDownloadTries, UINT, "80"),
  V(TestingCertMaxDownloadTries, UINT, "80"),
493
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
494
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
495
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
496
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
497

498
499
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
500

501
#undef VAR
502
#undef V
503
504
#undef OBSOLETE

505
#ifdef _WIN32
506
507
static char *get_windows_conf_root(void);
#endif
508
509
510
511
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,
512
                                      char **msg);
513
514
515
516
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);
517
static int check_nickname_list(char **lst, const char *name, char **msg);
518
519
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
520
static int parse_dir_authority_line(const char *line,
521
                                 dirinfo_type_t required_type,
522
                                 int validate_only);
523
524
static int parse_dir_fallback_line(const char *line,
                                   int validate_only);
525
static void port_cfg_free(port_cfg_t *port);
526
static int parse_ports(or_options_t *options, int validate_only,
527
                              char **msg_out, int *n_ports_out);
528
529
530
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

531
static int validate_data_directory(or_options_t *options);
532
533
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
534
535
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
536

537
static void init_libevent(const or_options_t *options);
538
static int opt_streq(const char *s1, const char *s2);
539
540
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
541
542
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
543
544
545
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
546
547
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
548

549
/** Magic value for or_options_t. */
550
551
#define OR_OPTIONS_MAGIC 9090909

552
/** Configuration format for or_options_t. */
553
STATIC config_format_t options_format = {
554
555
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
556
557
558
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
559
  options_validate_cb,
560
  NULL
561
562
};

563
564
565
566
567
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
568
static or_options_t *global_options = NULL;
569
570
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
571
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
572
/** Name of most recently read torrc file. */
573
static char *torrc_fname = NULL;
574
/** Name of the most recently read torrc-defaults file.*/
575
static char *torrc_defaults_fname;
576
/** Configuration options set by command line. */
577
static config_line_t *global_cmdline_options = NULL;
578
579
580
581
/** Non-configuration options set by the command line */
static config_line_t *global_cmdline_only_options = NULL;
/** Boolean: Have we parsed the command line? */
static int have_parsed_cmdline = 0;
Roger Dingledine's avatar
Roger Dingledine committed
582
/** Contents of most recently read DirPortFrontPage file. */
583
static char *global_dirfrontpagecontents = NULL;
584
585
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
586
587
588
589
590
591
592

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

594
595
/** Return the currently configured options. */
or_options_t *
596
get_options_mutable(void)
597
{
598
599
600
  tor_assert(global_options);
  return global_options;
}
601

602
/** Returns the currently configured options */
603
604
MOCK_IMPL(const or_options_t *,
get_options,(void))
605
606
607
608
{
  return get_options_mutable();
}

609
610
/** 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
611
 * as necessary.  Returns 0 on success, -1 on failure.
612
 */
613
int
614
set_options(or_options_t *new_val, char **msg)
615
{
616
617
618
  int i;
  smartlist_t *elements;
  config_line_t *line;
619
  or_options_t *old_options = global_options;
620
  global_options = new_val;
621
622
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
623
624
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
625
626
627
    global_options = old_options;
    return -1;
  }
628
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
629
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
630
            "Acting on config options left us in a broken state. Dying.");
631
632
    exit(1);
  }
633
634
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
635
  if (old_options && old_options != global_options) {
636
    elements = smartlist_new();
637
    for (i=0; options_format.vars[i].name; ++i) {
638
639
      const config_var_t *var = &options_format.vars[i];
      const char *var_name = var->name;
640
641
642
643
      if (var->type == CONFIG_TYPE_LINELIST_S ||
          var->type == CONFIG_TYPE_OBSOLETE) {
        continue;
      }
644
645
646
      if (!config_is_same(&options_format, new_val, old_options, var_name)) {
        line = config_get_assigned_option(&options_format, new_val,
                                          var_name, 1);
647
648

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
649
650
651
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
652
653
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
654
            tor_free(line);
655
656
          }
        } else {
657
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
658
          smartlist_add(elements, NULL);
659
660
661
        }
      }
    }
662
    control_event_conf_changed(elements);
663
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
664
665
    smartlist_free(elements);
  }
666
667
668

  if (old_options != global_options)
    config_free(&options_format, old_options);
669
670

  return 0;
671
672
}

673
extern const char tor_git_revision[]; /* from tor_main.c */
674

675
/** The version of this Tor process, as parsed. */
676
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
677
678
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
679
static char *the_short_tor_version = NULL;
680

681
/** Return the current Tor version. */
682
683
684
const char *
get_version(void)
{
685
  if (the_tor_version == NULL) {
686
    if (strlen(tor_git_revision)) {
687
688
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
689
    } else {
690
      the_tor_version = tor_strdup(get_short_version());
691
692
    }
  }
693
  return the_tor_version;
694
695
}

696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
/** Return the current Tor version, without any git tag. */
const char *
get_short_version(void)
{

  if (the_short_tor_version == NULL) {
#ifdef TOR_BUILD_TAG
    tor_asprintf(&the_short_tor_version, "%s (%s)", VERSION, TOR_BUILD_TAG);
#else
    the_short_tor_version = tor_strdup(VERSION);
#endif
  }
  return the_short_tor_version;
}

711
712
/** Release additional memory allocated in options
 */
713
STATIC void
714
715
or_options_free(or_options_t *options)
{
716
717
718
  if (!options)
    return;

719
  routerset_free(options->ExcludeExitNodesUnion_);
720
721
722
723
724
  if (options->NodeFamilySets) {
    SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
                      rs, routerset_free(rs));
    smartlist_free(options->NodeFamilySets);
  }
725
  tor_free(options->BridgePassword_AuthDigest_);
726
  tor_free(options->command_arg);
727
728
729
  config_free(&options_format, options);
}

730
731
/** Release all memory and resources held by global configuration structures.
 */
732
733
734
void
config_free_all(void)
{
735
736
  or_options_free(global_options);
  global_options = NULL;
737
738
  or_options_free(global_default_options);</