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

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
  PLURAL(ExcludeNode),
83
  PLURAL(Tor2webRendezvousPoint),
84
  PLURAL(FirewallPort),
85
  PLURAL(LongLivedPort),
86
87
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
88
  PLURAL(NumCPU),
89
  PLURAL(RendNode),
90
  PLURAL(RecommendedPackage),
91
  PLURAL(RendExcludeNode),
92
93
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
94
  PLURAL(StrictNode),
95
  { "l", "Log", 1, 0},
96
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
97
98
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
99
100
101
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
102
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX024 later, make this warn? */
103
  { "MaxConn", "ConnLimit", 0, 1},
104
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
105
106
107
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
108
109
110
111
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
112
113
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
114
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
115
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
116
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
117
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
118
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
119
  { "_UseFilteringSSLBufferevents", "UseFilteringSSLBufferevents", 0, 1},
120
121
  { NULL, NULL, 0, 0},
};
122

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

136
137
138
#define VPORT(member,conftype,initvalue)                                    \
  VAR(#member, conftype, member ## _lines, initvalue)

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

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

340
  OBSOLETE("PathBiasDisableRate"),
341
342
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
343
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
344
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
345
  V(PathBiasScaleThreshold,      INT,      "-1"),
346
347
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
348
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
349
350
351
352
353
354
  OBSOLETE("PathBiasUseCloseCounts"),

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

356
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
357
358
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
359
  V(PidFile,                     STRING,   NULL),
360
  V(TestingTorNetwork,           BOOL,     "0"),
361
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
362
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
363

364
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
365
366
367
368
369
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

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

486
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
487
};
488

489
490
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
491
static const config_var_t testing_tor_network_defaults[] = {
492
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
493
494
495
496
497
498
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
499
  V(ClientRejectInternalAddresses, BOOL,   "0"),
500
  V(CountPrivateBandwidth,       BOOL,     "1"),
501
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
502
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
503
504
505
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
506
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
507
508
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
509
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
510
511
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
512
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
  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"),
528
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
529
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
530
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
531
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
532
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
533

534
535
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
536

537
#undef VAR
538
#undef V
539
540
#undef OBSOLETE

541
#ifdef _WIN32
542
543
static char *get_windows_conf_root(void);
#endif
544
545
546
547
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,
548
                                      char **msg);
549
550
551
552
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);
553
static int check_nickname_list(char **lst, const char *name, char **msg);
554
555
static char *get_bindaddr_from_transport_listen_line(const char *line,
                                                     const char *transport);
556
static int parse_dir_authority_line(const char *line,
557
                                 dirinfo_type_t required_type,
558
                                 int validate_only);
559
static void port_cfg_free(port_cfg_t *port);
560
static int parse_ports(or_options_t *options, int validate_only,
561
                              char **msg_out, int *n_ports_out);
562
563
564
static int check_server_ports(const smartlist_t *ports,
                              const or_options_t *options);

565
static int validate_data_directory(or_options_t *options);
566
567
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
Arlo Breault's avatar
Arlo Breault committed
568
569
static int options_init_logs(const or_options_t *old_options,
                             or_options_t *options, int validate_only);
570

571
static void init_libevent(const or_options_t *options);
572
static int opt_streq(const char *s1, const char *s2);
573
574
static int parse_outbound_addresses(or_options_t *options, int validate_only,
                                    char **msg);
Linus Nordberg's avatar
Linus Nordberg committed
575
576
static void config_maybe_load_geoip_files_(const or_options_t *options,
                                           const or_options_t *old_options);
577
578
579
static int options_validate_cb(void *old_options, void *options,
                               void *default_options,
                               int from_setconf, char **msg);
580
581
static uint64_t compute_real_max_mem_in_queues(const uint64_t val,
                                               int log_guess);
582

583
/** Magic value for or_options_t. */
584
585
#define OR_OPTIONS_MAGIC 9090909

586
/** Configuration format for or_options_t. */
587
STATIC config_format_t options_format = {
588
589
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
590
591
592
  STRUCT_OFFSET(or_options_t, magic_),
  option_abbrevs_,
  option_vars_,
593
  options_validate_cb,
594
  NULL
595
596
};

597
598
599
600
601
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
602
static or_options_t *global_options = NULL;
603
604
/** The fallback options_t object; this is where we look for options not
 * in torrc before we fall back to Tor's defaults. */
605
static or_options_t *global_default_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
606
/** Name of most recently read torrc file. */
607
static char *torrc_fname = NULL;
608
/** Name of the most recently read torrc-defaults file.*/
609
static char *torrc_defaults_fname;
610
/** Configuration options set by command line. */
611
static config_line_t *global_cmdline_options = NULL;
612
613
614
615
/** 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
616
/** Contents of most recently read DirPortFrontPage file. */
617
static char *global_dirfrontpagecontents = NULL;
618
619
/** List of port_cfg_t for all configured ports. */
static smartlist_t *configured_ports = NULL;
620
621
622
623
624
625
626

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

628
629
/** Return the currently configured options. */
or_options_t *
630
get_options_mutable(void)
631
{
632
633
634
  tor_assert(global_options);
  return global_options;
}
635

636
/** Returns the currently configured options */
637
638
MOCK_IMPL(const or_options_t *,
get_options,(void))
639
640
641
642
{
  return get_options_mutable();
}

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

        if (line) {
Nick Mathewson's avatar
Nick Mathewson committed
683
684
685
          config_line_t *next;
          for (; line; line = next) {
            next = line->next;
686
687
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
Nick Mathewson's avatar
Nick Mathewson committed
688
            tor_free(line);
689
690
          }
        } else {
691
          smartlist_add(elements, tor_strdup(options_format.vars[i].name));
692
          smartlist_add(elements, NULL);
693
694
695
        }
      }
    }
696
    control_event_conf_changed(elements);
697
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
698
699
    smartlist_free(elements);
  }
700
701
702

  if (old_options != global_options)
    config_free(&options_format, old_options);
703
704

  return 0;
705
706
}

707
extern const char tor_git_revision[]; /* from tor_main.c */
708

709
/** The version of this Tor process, as parsed. */
710
static char *the_tor_version = NULL;
Nick Mathewson's avatar
Nick Mathewson committed
711
712
/** A shorter version of this Tor process's version, for export in our router
 *  descriptor.  (Does not include the git version, if any.) */
713
static char *the_short_tor_version = NULL;
714

715
/** Return the current Tor version. */
716
717
718
const char *
get_version(void)
{
719
  if (the_tor_version == NULL) {