config.c 247 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-2015, 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 "compat.h"
15
#include "addressmap.h"
16
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "circuitlist.h"
19
20
#include "circuitmux.h"
#include "circuitmux_ewma.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "connection_edge.h"
24
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "control.h"
26
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "dns.h"
31
#include "entrynodes.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "networkstatus.h"
36
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
38
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
39
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
40
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
41
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
42
#include "router.h"
43
#include "sandbox.h"
44
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
45
#include "routerlist.h"
46
#include "routerset.h"
47
#include "scheduler.h"
48
#include "statefile.h"
49
#include "transports.h"
50
#include "ext_orport.h"
51
#include "torgzip.h"
52
#ifdef _WIN32
53
54
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
55

56
57
#include "procmon.h"

58
59
60
61
62
63
64
65
66
67
#ifdef HAVE_SYSTEMD
#   if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
/* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
 * Coverity. Here's a kludge to unconfuse it.
 */
#   define __INCLUDE_LEVEL__ 2
#   endif
#include <systemd/sd-daemon.h>
#endif

68
69
70
/* From main.c */
extern int quiet_level;

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

Nick Mathewson's avatar
Nick Mathewson committed
118
119
120
121
/** 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>"
 */
122
123
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
124
      initvalue }
125
126
127
/** 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
128
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
129
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
130

131
132
133
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

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

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

331
  OBSOLETE("PathBiasDisableRate"),
332
333
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
334
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
335
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
336
  V(PathBiasScaleThreshold,      INT,      "-1"),
337
338
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
339
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
340
341
342
343
344
345
  OBSOLETE("PathBiasUseCloseCounts"),

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

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

466
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
467
};
468

469
470
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
471
static const config_var_t testing_tor_network_defaults[] = {
472
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
473
474
475
476
477
478
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
479
  V(ClientRejectInternalAddresses, BOOL,   "0"),
480
  V(CountPrivateBandwidth,       BOOL,     "1"),
481
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
482
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
483
484
485
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
486
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
487
488
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
489
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
490
491
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
492
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
  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"),
508
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
509
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
510
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
511
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
512
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
513

514
515
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
516

517
#undef VAR
518
#undef V
519
520
#undef OBSOLETE

521
#ifdef _WIN32
522
523
static char *get_windows_conf_root(void);
#endif
524
525
526
527
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,
528
                                      char **msg);
529
530
531
532
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);
533
static int check_nickname_list(char **lst, const char *name, char **msg);
534
535
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
536
static int parse_dir_authority_line(const char *line,
537
                                 dirinfo_type_t required_type,
538
                                 int validate_only);
539
540
static int parse_dir_fallback_line(const char *line,
                                   int validate_only);
541
static void port_cfg_free(port_cfg_t *port);
542
static int parse_ports(or_options_t *options, int validate_only,
543
                              char **msg_out, int *n_ports_out);
544
545
546
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

547
static int validate_data_directory(or_options_t *options);
548
549
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
550
551
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
552

553
static void init_libevent(const or_options_t *options);
554
static int opt_streq(const char *s1, const char *s2);
555
556
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
557
558
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
559
560
561
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
562
563
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
564

565
/** Magic value for or_options_t. */
566
567
#define OR_OPTIONS_MAGIC 9090909

568
/** Configuration format for or_options_t. */
569
STATIC config_format_t options_format = {
570
571
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
572
573
574
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
575
  options_validate_cb,
576
  NULL
577
578
};

579
580
581
582
583
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
584
static or_options_t *global_options = NULL;
585
586
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
587
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
588
/** Name of most recently read torrc file. */
589
static char *torrc_fname = NULL;
590
/** Name of the most recently read torrc-defaults file.*/
591
static char *torrc_defaults_fname;
592
/** Configuration options set by command line. */
593
static config_line_t *global_cmdline_options = NULL;
594
595
596
597
/** 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
598
/** Contents of most recently read DirPortFrontPage file. */
599
static char *global_dirfrontpagecontents = NULL;
600
601
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
602
603
604
605
606
607
608

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

610
611
/** Return the currently configured options. */
or_options_t *
612
get_options_mutable(void)
613
{
614
615
616
  tor_assert(global_options);
  return global_options;
}
617

618
/** Returns the currently configured options */
619
620
MOCK_IMPL(const or_options_t *,
get_options,(void))
621
622
623
624
{
  return get_options_mutable();
}

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

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
665
666
667
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
668
669
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
670
            tor_free(line);
671
672
          }
        } else {
673
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
674
          smartlist_add(elements, NULL);
675
676
677
        }
      }
    }
678
    control_event_conf_changed(elements);
679
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
680
681
    smartlist_free(elements);
  }
682
683
684

  if (old_options != global_options)
    config_free(&options_format, old_options);
685
686

  return 0;
687
688
}

689
extern const char tor_git_revision[]; /* from tor_main.c */
690

691
/** The version of this Tor process, as parsed. */
692
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
693
694
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
695
static char *the_short_tor_version = NULL;
696

697
/** Return the current Tor version. */
698
699
700
const char *
get_version(void)
{
701
  if (the_tor_version == NULL) {
702
    if (strlen(tor_git_revision)) {
703
704
      tor_asprintf(&the_tor_version, "%s (git-%s)", get_short_version(),
                   tor_git_revision);
705
    } else {
706
      the_tor_version = tor_strdup(get_short_version());
707
708
    }
  }
709
  return the_tor_version;
710
711
}

712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
/** 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;
}

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

735
  routerset_free(options->ExcludeExitNodesUnion_);
736
737
738
739
740
  if (options->NodeFamilySets) {
    SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
                      rs, routerset_free(rs));
    smartlist_free(options->NodeFamilySets);
  }