config.c 239 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-2013, 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 "statefile.h"
47
#include "transports.h"
48
#include "ext_orport.h"
49
#include "torgzip.h"
50
#ifdef _WIN32
51
52
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
53

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

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

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

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

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

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

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

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

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

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

444
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
445
};
446

447
448
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
449
static const config_var_t testing_tor_network_defaults[] = {
450
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
451
452
453
454
455
456
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
457
  V(ClientRejectInternalAddresses, BOOL,   "0"),
458
  V(CountPrivateBandwidth,       BOOL,     "1"),
459
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
460
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
461
462
463
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
464
465
466
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
467
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
468
469
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
470
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
  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"),
486
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
487
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
488
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
489
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
490

491
492
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
493

494
#undef VAR
495
#undef V
496
497
#undef OBSOLETE

498
#ifdef _WIN32
499
500
static char *get_windows_conf_root(void);
#endif
501
502
503
504
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,
505
                                      char **msg);
506
507
508
509
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);
510
static int check_nickname_list(char **lst, const char *name, char **msg);
511

512
513
static int parse_client_transport_line(const or_options_t *options,
                                       const char *line, int validate_only);
514

515
516
static int parse_server_transport_line(const or_options_t *options,
                                       const char *line, int validate_only);
517
518
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
519
static int parse_dir_authority_line(const char *line,
520
                                 dirinfo_type_t required_type,
521
                                 int validate_only);
522
523
static int parse_dir_fallback_line(const char *line,
                                   int validate_only);
524
static void port_cfg_free(port_cfg_t *port);
525
static int parse_ports(or_options_t *options, int validate_only,
526
                              char **msg_out, int *n_ports_out);
527
528
529
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

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

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

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

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

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

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

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

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

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

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

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

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

  return 0;
670
671
}

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

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

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

695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
/** 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;
}

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

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

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

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

742
743
744
  config_free_lines(global_cmdline_only_options);
  global_cmdline_only_options</