config.c 246 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
73
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
static const char *unix_socket_prefix = "unix:";

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

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

134
135
136
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

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

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

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

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

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

470
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
471
};
472

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

518
519
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
520

521
#undef VAR
522
#undef V
523
524
#undef OBSOLETE

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

551
static int validate_data_directory(or_options_t *options);
552
553
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
554
555
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
556

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

569
/** Magic value for or_options_t. */
570
571
#define OR_OPTIONS_MAGIC 9090909

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

583
584
585
586
587
/*
 * Functions to read and write the global options pointer.
 */

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

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

614
615
/** Return the currently configured options. */
or_options_t *
616
get_options_mutable(void)
617
{
618
619
620
  tor_assert(global_options);
  return global_options;
}
621

622
/** Returns the currently configured options */
623
624
MOCK_IMPL(const or_options_t *,
get_options,(void))
625
626
627
628
{
  return get_options_mutable();
}

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

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

  if (old_options != global_options)
    config_free(&options_format, old_options);
689
690

  return 0;
691
692
}

693
extern const char tor_git_revision[]; /* from tor_main.c */
694

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

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

716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
/** 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;
}

731
732
/** Release additional memory allocated in options
 */
733
STATIC void
734
735
or_options_free(or_options_t *options)
{
736
737
738
  if (!options)
    return;

739
  routerset_free(options->ExcludeExitNodesUnion_);