config.c 297 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-2017, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
6

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
 * \file config.c
9
10
11
12
13
14
15
16
17
18
19
20
 * \brief Code to interpret the user's configuration of Tor.
 *
 * This module handles torrc configuration file, including parsing it,
 * combining it with torrc.defaults and the command line, allowing
 * user changes to it (via editing and SIGHUP or via the control port),
 * writing it back to disk (because of SAVECONF from the control port),
 * and -- most importantly, acting on it.
 *
 * The module additionally has some tools for manipulating and
 * inspecting values that are calculated as a result of the
 * configured options.
 *
21
 * <h3>How to add new options</h3>
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 *
 * To add new items to the torrc, there are a minimum of three places to edit:
 * <ul>
 *   <li>The or_options_t structure in or.h, where the options are stored.
 *   <li>The option_vars_ array below in this module, which configures
 *       the names of the torrc options, their types, their multiplicities,
 *       and their mappings to fields in or_options_t.
 *   <li>The manual in doc/tor.1.txt, to document what the new option
 *       is, and how it works.
 * </ul>
 *
 * Additionally, you might need to edit these places too:
 * <ul>
 *   <li>options_validate() below, in case you want to reject some possible
 *       values of the new configuration option.
 *   <li>options_transition_allowed() below, in case you need to
 *       forbid some or all changes in the option while Tor is
 *       running.
 *   <li>options_transition_affects_workers(), in case changes in the option
 *       might require Tor to relaunch or reconfigure its worker threads.
 *   <li>options_transition_affects_descriptor(), in case changes in the
 *       option might require a Tor relay to build and publish a new server
 *       descriptor.
 *   <li>options_act() and/or options_act_reversible(), in case there's some
 *       action that needs to be taken immediately based on the option's
 *       value.
 * </ul>
 *
 * <h3>Changing the value of an option</h3>
 *
 * Because of the SAVECONF command from the control port, it's a bad
 * idea to change the value of any user-configured option in the
 * or_options_t.  If you want to sometimes do this anyway, we recommend
 * that you create a secondary field in or_options_t; that you have the
 * user option linked only to the secondary field; that you use the
 * secondary field to initialize the one that Tor actually looks at; and that
 * you use the one Tor looks as the one that you modify.
Nick Mathewson's avatar
Nick Mathewson committed
59
60
 **/

61
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
62
#include "or.h"
63
#include "bridges.h"
64
#include "compat.h"
65
#include "addressmap.h"
66
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
67
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
68
#include "circuitlist.h"
69
70
#include "circuitmux.h"
#include "circuitmux_ewma.h"
71
#include "circuitstats.h"
72
#include "compress.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
73
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
74
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
75
#include "connection_edge.h"
76
#include "connection_or.h"
77
#include "consdiffmgr.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
78
#include "control.h"
79
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
80
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
81
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
82
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
83
#include "dns.h"
84
#include "entrynodes.h"
85
#include "git_revision.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
86
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
87
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
88
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
89
#include "networkstatus.h"
90
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
91
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
92
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
93
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
94
#include "rendservice.h"
95
#include "hs_config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
96
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
97
#include "router.h"
98
#include "sandbox.h"
99
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
100
#include "routerlist.h"
101
#include "routerset.h"
102
#include "scheduler.h"
103
#include "statefile.h"
104
#include "transports.h"
105
#include "ext_orport.h"
106
#ifdef _WIN32
107
108
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
109

110
111
#include "procmon.h"

112
113
114
115
116
117
#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
118
#endif /* defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__) */
119
#include <systemd/sd-daemon.h>
120
#endif /* defined(HAVE_SYSTEMD) */
121

122
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
123
static const char unix_socket_prefix[] = "unix:";
124
125
126
/* Prefix used to indicate a Unix socket with spaces in it, in a FooPort
 * configuration. */
static const char unix_q_socket_prefix[] = "unix:\"";
127

128
129
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
130
static config_abbrev_t option_abbrevs_[] = {
131
132
133
134
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
135
  PLURAL(EntryNode),
136
  PLURAL(ExcludeNode),
137
  PLURAL(Tor2webRendezvousPoint),
138
  PLURAL(FirewallPort),
139
  PLURAL(LongLivedPort),
140
141
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
142
  PLURAL(NumCPU),
143
  PLURAL(RendNode),
144
  PLURAL(RecommendedPackage),
145
  PLURAL(RendExcludeNode),
146
147
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
148
  PLURAL(StrictNode),
149
  { "l", "Log", 1, 0},
150
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
151
152
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
153
154
155
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
156
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX later, make this warn? */
157
  { "MaxConn", "ConnLimit", 0, 1},
158
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
159
160
161
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
162
163
164
165
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
166
167
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
168
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
169
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
170
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
171
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
172
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
173
174
  { NULL, NULL, 0, 0},
};
175

176
177
178
179
/** dummy instance of or_options_t, used for type-checking its
 * members with CONF_CHECK_VAR_TYPE. */
DUMMY_TYPECHECK_INSTANCE(or_options_t);

Nick Mathewson's avatar
Nick Mathewson committed
180
181
182
183
/** 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>"
 */
184
#define VAR(name,conftype,member,initvalue)                             \
Neel Chauhan's avatar
Neel Chauhan committed
185
  { name, CONFIG_TYPE_ ## conftype, offsetof(or_options_t, member),     \
186
      initvalue CONF_TEST_MEMBERS(or_options_t, conftype, member) }
187
188
189
/** 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
190
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
191
192
193
#ifdef TOR_UNIT_TESTS
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL, {.INT=NULL} }
#else
194
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
195
#endif
196

197
198
199
200
201
202
203
204
205
206
207
/**
 * Macro to declare *Port options.  Each one comes in three entries.
 * For example, most users should use "SocksPort" to configure the
 * socks port, but TorBrowser wants to use __SocksPort so that it
 * isn't stored by SAVECONF.  The SocksPortLines virtual option is
 * used to query both options from the controller.
 */
#define VPORT(member)                                           \
  VAR(#member "Lines", LINELIST_V, member ## _lines, NULL),     \
  VAR(#member, LINELIST_S, member ## _lines, NULL),             \
  VAR("__" #member, LINELIST_S, member ## _lines, NULL)
208

Nick Mathewson's avatar
Nick Mathewson committed
209
210
211
212
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
213
static config_var_t option_vars_[] = {
214
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
215
  VAR("AccountingRule",          STRING,   AccountingRule_option,  "max"),
216
217
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
Nick Mathewson's avatar
Nick Mathewson committed
218
  OBSOLETE("AllowDotExit"),
219
  OBSOLETE("AllowInvalidNodes"),
220
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
221
  OBSOLETE("AllowSingleHopCircuits"),
222
  OBSOLETE("AllowSingleHopExits"),
223
224
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
225
  OBSOLETE("AlternateHSAuthority"),
226
  V(AssumeReachable,             BOOL,     "0"),
227
228
  OBSOLETE("AuthDirBadDir"),
  OBSOLETE("AuthDirBadDirCCs"),
229
  V(AuthDirBadExit,              LINELIST, NULL),
230
  V(AuthDirBadExitCCs,           CSV,      ""),
231
  V(AuthDirInvalid,              LINELIST, NULL),
232
  V(AuthDirInvalidCCs,           CSV,      ""),
233
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
234
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
235
  V(AuthDirPinKeys,              BOOL,     "1"),
236
  V(AuthDirReject,               LINELIST, NULL),
237
  V(AuthDirRejectCCs,            CSV,      ""),
238
  OBSOLETE("AuthDirRejectUnlisted"),
239
  OBSOLETE("AuthDirListBadDirs"),
240
  V(AuthDirListBadExits,         BOOL,     "0"),
241
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
242
  OBSOLETE("AuthDirMaxServersPerAuthAddr"),
243
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
244
245
246
247
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
248
249
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
250
251
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
252
  V(BridgePassword,              STRING,   NULL),
253
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
254
  V(BridgeRelay,                 BOOL,     "0"),
255
  V(BridgeDistribution,          STRING,   NULL),
256
257
  VAR("CacheDirectory",          FILENAME, CacheDirectory_option, NULL),
  V(CacheDirectoryGroupReadable, BOOL,     "0"),
258
  V(CellStatistics,              BOOL,     "0"),
259
  V(PaddingStatistics,           BOOL,     "1"),
260
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
261
  V(CircuitBuildTimeout,         INTERVAL, "0"),
262
263
  OBSOLETE("CircuitIdleTimeout"),
  V(CircuitsAvailableTimeout,    INTERVAL, "0"),
264
  V(CircuitStreamTimeout,        INTERVAL, "0"),
265
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
266
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
267
  V(ClientOnly,                  BOOL,     "0"),
268
269
  V(ClientPreferIPv6ORPort,      AUTOBOOL, "auto"),
  V(ClientPreferIPv6DirPort,     AUTOBOOL, "auto"),
270
  V(ClientRejectInternalAddresses, BOOL,   "1"),
271
  V(ClientTransportPlugin,       LINELIST, NULL),
272
  V(ClientUseIPv6,               BOOL,     "0"),
273
  V(ClientUseIPv4,               BOOL,     "1"),
274
  V(ConsensusParams,             STRING,   NULL),
275
  V(ConnLimit,                   UINT,     "1000"),
276
  V(ConnDirectionStatistics,     BOOL,     "0"),
277
278
279
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
280
  OBSOLETE("ControlListenAddress"),
281
  VPORT(ControlPort),
282
  V(ControlPortFileGroupReadable,BOOL,     "0"),
283
  V(ControlPortWriteToFile,      FILENAME, NULL),
284
  V(ControlSocket,               LINELIST, NULL),
285
  V(ControlSocketsGroupWritable, BOOL,     "0"),
286
  V(SocksSocketsGroupWritable,   BOOL,     "0"),
287
288
289
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
290
  V(CountPrivateBandwidth,       BOOL,     "0"),
291
  VAR("DataDirectory",           FILENAME, DataDirectory_option, NULL),
292
  V(DataDirectoryGroupReadable,  BOOL,     "0"),
293
  V(DisableOOSCheck,             BOOL,     "1"),
294
  V(DisableNetwork,              BOOL,     "0"),
295
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
296
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
297
  OBSOLETE("DirListenAddress"),
298
  V(DirPolicy,                   LINELIST, NULL),
299
  VPORT(DirPort),
300
  V(DirPortFrontPage,            FILENAME, NULL),
301
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
302
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
303
  V(DirCache,                    BOOL,     "1"),
304
305
306
307
308
  /* A DirAuthorityFallbackRate of 0.1 means that 0.5% of clients try an
   * authority when all fallbacks are up, and 2% try an authority when 25% of
   * fallbacks are down. (We rebuild the list when 25% of fallbacks are down).
   *
   * We want to reduce load on authorities, but keep these two figures within
Nick Mathewson's avatar
Nick Mathewson committed
309
310
   * an order of magnitude, so there isn't too much load shifting to
   * authorities when fallbacks go down. */
311
  V(DirAuthorityFallbackRate,    DOUBLE,   "0.1"),
312
  V(DisableAllSwap,              BOOL,     "0"),
313
  V(DisableDebuggerAttachment,   BOOL,     "1"),
314
  OBSOLETE("DisableIOCP"),
315
  OBSOLETE("DisableV2DirectoryInfo_"),
316
  OBSOLETE("DynamicDHGroups"),
317
  VPORT(DNSPort),
318
  OBSOLETE("DNSListenAddress"),
319
  V(DownloadExtraInfo,           BOOL,     "0"),
320
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
321
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
322
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
323
  V(EnforceDistinctSubnets,      BOOL,     "1"),
324
  V(EntryNodes,                  ROUTERSET,   NULL),
325
  V(EntryStatistics,             BOOL,     "0"),
326
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
327
328
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
329
  OBSOLETE("ExcludeSingleHopRelays"),
330
  V(ExitNodes,                   ROUTERSET, NULL),
331
332
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
333
  V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
334
  V(ExitPortStatistics,          BOOL,     "0"),
335
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
336
  V(ExitRelay,                   AUTOBOOL, "auto"),
337
  VPORT(ExtORPort),
338
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
339
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
340
  V(ExtraInfoStatistics,         BOOL,     "1"),
341
  V(ExtendByEd25519ID,           AUTOBOOL, "auto"),
342
  V(FallbackDir,                 LINELIST, NULL),
343

344
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
345

346
  OBSOLETE("FallbackNetworkstatusFile"),
347
348
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
349
  OBSOLETE("FastFirstHopPK"),
350
  V(FetchDirInfoEarly,           BOOL,     "0"),
351
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
352
353
354
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
355
  OBSOLETE("FetchV2Networkstatus"),
356
  V(GeoIPExcludeUnknown,         AUTOBOOL, "auto"),
357
#ifdef _WIN32
358
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
359
  V(GeoIPv6File,                 FILENAME, "<default>"),
360
#else
361
362
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
363
364
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
365
#endif /* defined(_WIN32) */
366
  OBSOLETE("Group"),
367
  V(GuardLifetime,               INTERVAL, "0 minutes"),
368
  V(HardwareAccel,               BOOL,     "0"),
369
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
Alexander Færøy's avatar
Alexander Færøy committed
370
  V(MainloopStats,               BOOL,     "0"),
371
372
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
373
  V(HashedControlPassword,       LINELIST, NULL),
374
  OBSOLETE("HidServDirectoryV2"),
Nick Mathewson's avatar
Nick Mathewson committed
375
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
376
  VAR("HiddenServiceDirGroupReadable",  LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
377
378
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
379
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
380
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
381
  VAR("HiddenServiceAllowUnknownPorts",LINELIST_S, RendConfigLines, NULL),
382
383
  VAR("HiddenServiceMaxStreams",LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceMaxStreamsCloseCircuit",LINELIST_S, RendConfigLines, NULL),
384
  VAR("HiddenServiceNumIntroductionPoints", LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
385
  VAR("HiddenServiceStatistics", BOOL, HiddenServiceStatistics_option, "1"),
386
  V(HidServAuth,                 LINELIST, NULL),
387
  OBSOLETE("CloseHSClientCircuitsImmediatelyOnTimeout"),
388
  OBSOLETE("CloseHSServiceRendCircuitsImmediatelyOnTimeout"),
389
390
  V(HiddenServiceSingleHopMode,  BOOL,     "0"),
  V(HiddenServiceNonAnonymousMode,BOOL,    "0"),
391
392
393
394
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
395
  VPORT(HTTPTunnelPort),
396
  V(IPv6Exit,                    BOOL,     "0"),
397
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
398
  V(ServerTransportListenAddr,   LINELIST, NULL),
399
  V(ServerTransportOptions,      LINELIST, NULL),
400
  V(SigningKeyLifetime,          INTERVAL, "30 days"),
401
402
403
404
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
405
406
  VAR("KeyDirectory",            FILENAME, KeyDirectory_option, NULL),
  V(KeyDirectoryGroupReadable,   BOOL,     "0"),
407
408
  VAR("_HSLayer2Nodes",          ROUTERSET,  HSLayer2Nodes,  NULL),
  VAR("_HSLayer3Nodes",          ROUTERSET,  HSLayer3Nodes,  NULL),
409
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
410
  V(KeepBindCapabilities,            AUTOBOOL, "auto"),
411
  VAR("Log",                     LINELIST, Logs,             NULL),
412
  V(LogMessageDomains,           BOOL,     "0"),
413
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
414
  V(TruncateLogFile,             BOOL,     "0"),
Peter Palfrader's avatar
Peter Palfrader committed
415
  V(SyslogIdentityTag,           STRING,   NULL),
416
  V(AndroidIdentityTag,          STRING,   NULL),
417
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
418
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
419
420
421
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
422
  V(MaxClientCircuitsPending,    UINT,     "32"),
423
  V(MaxConsensusAgeForDiffs,     INTERVAL, "0 seconds"),
424
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
425
426
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
427
  V(MaxUnparseableDescSizeToLog, MEMUNIT, "10 MB"),
428
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
429
  VAR("MyFamily",                LINELIST, MyFamily_lines,       NULL),
430
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
431
  OBSOLETE("NamingAuthoritativeDirectory"),
432
  OBSOLETE("NATDListenAddress"),
433
  VPORT(NATDPort),
434
  V(Nickname,                    STRING,   NULL),
435
  OBSOLETE("PredictedPortsRelevanceTime"),
436
  OBSOLETE("WarnUnsafeSocks"),
437
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
438
  V(NoExec,                      BOOL,     "0"),
439
  V(NumCPUs,                     UINT,     "0"),
440
  V(NumDirectoryGuards,          UINT,     "0"),
441
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
442
  V(OfflineMasterKey,            BOOL,     "0"),
443
  OBSOLETE("ORListenAddress"),
444
  VPORT(ORPort),
445
  V(OutboundBindAddress,         LINELIST,   NULL),
446
447
  V(OutboundBindAddressOR,       LINELIST,   NULL),
  V(OutboundBindAddressExit,     LINELIST,   NULL),
448

449
  OBSOLETE("PathBiasDisableRate"),
450
451
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
452
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
453
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
454
  V(PathBiasScaleThreshold,      INT,      "-1"),
455
456
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
457
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
458
459
460
461
462
463
  OBSOLETE("PathBiasUseCloseCounts"),

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

465
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
466
467
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
468
  V(PidFile,                     STRING,   NULL),
469
  V(TestingTorNetwork,           BOOL,     "0"),
470
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
471
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
472

473
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
474
475
476
477
478
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

479
  V(OptimisticData,              AUTOBOOL, "auto"),
480
481
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
482
  OBSOLETE("PreferTunneledDirConns"),
483
  V(ProtocolWarnings,            BOOL,     "0"),
484
  V(PublishServerDescriptor,     CSV,      "1"),
485
486
487
488
489
490
491
  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),
492
  V(RecommendedPackages,         LINELIST, NULL),
493
494
  V(ReducedConnectionPadding,    BOOL,     "0"),
  V(ConnectionPadding,           AUTOBOOL, "auto"),
495
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
496
  V(RejectPlaintextPorts,        CSV,      ""),
497
498
499
500
501
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
502
  V(ReducedExitPolicy,           BOOL,     "0"),
503
  OBSOLETE("RunTesting"), // currently unused
504
  V(Sandbox,                     BOOL,     "0"),
505
  V(SafeLogging,                 STRING,   "1"),
506
  V(SafeSocks,                   BOOL,     "0"),
507
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
508
509
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
510
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
511
512
513
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
514
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
515
516
517
518
519
  OBSOLETE("SchedulerLowWaterMark__"),
  OBSOLETE("SchedulerHighWaterMark__"),
  OBSOLETE("SchedulerMaxFlushCells__"),
  V(KISTSchedRunInterval,        MSEC_INTERVAL, "0 msec"),
  V(KISTSockBufSizeFactor,       DOUBLE,   "1.0"),
520
  V(Schedulers,                  CSV,      "KIST,KISTLite,Vanilla"),
521
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
522
  OBSOLETE("SocksListenAddress"),
523
  V(SocksPolicy,                 LINELIST, NULL),
524
  VPORT(SocksPort),
525
  V(SocksTimeout,                INTERVAL, "2 minutes"),
526
  V(SSLKeyLifetime,              INTERVAL, "0"),
527
528
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
529
  V(StrictNodes,                 BOOL,     "0"),
530
  OBSOLETE("Support022HiddenServices"),
531
  V(TestSocks,                   BOOL,     "0"),
532
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
533
  V(Tor2webMode,                 BOOL,     "0"),
534
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
535
  OBSOLETE("TLSECGroup"),
536
537
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
538
  OBSOLETE("TransListenAddress"),
539
  VPORT(TransPort),
540
  V(TransProxyType,              STRING,   "default"),
541
  OBSOLETE("TunnelDirConns"),
542
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
543
  V(UseBridges,                  BOOL,     "0"),
544
  VAR("UseEntryGuards",          BOOL,     UseEntryGuards_option, "1"),
Nick Mathewson's avatar
Nick Mathewson committed
545
  OBSOLETE("UseEntryGuardsAsDirGuards"),
546
  V(UseGuardFraction,            AUTOBOOL, "auto"),
547
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
548
  OBSOLETE("UseNTorHandshake"),
549
  V(User,                        STRING,   NULL),
550
  OBSOLETE("UserspaceIOCPBuffers"),
551
  V(AuthDirSharedRandomness,     BOOL,     "1"),
552
  V(AuthDirTestEd25519LinkKeys,  BOOL,     "1"),
553
  OBSOLETE("V1AuthoritativeDirectory"),
554
  OBSOLETE("V2AuthoritativeDirectory"),
555
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
556
557
558
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
559
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
560
561
562
563
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
564
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
565
  V(V3BandwidthsFile,            FILENAME, NULL),
566
  V(GuardfractionFile,           FILENAME, NULL),
567
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
568
  OBSOLETE("VoteOnHidServDirectoriesV2"),
569
570
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
571
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
572
573
  OBSOLETE("UseFilteringSSLBufferevents"),
  OBSOLETE("__UseFilteringSSLBufferevents"),
574
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
575
576
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
577
  VAR("__DisableSignalHandlers", BOOL,  DisableSignalHandlers,    "0"),
578
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
579
580
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
581
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
582
  VAR("__OwningControllerFD",INT,OwningControllerFD, "-1"),
583
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
584
585
586
587
588
589
590
591
592
593
  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"),
594
  /* With the ClientBootstrapConsensus*Download* below:
595
   * Clients with only authorities will try:
596
597
   *  - at least 3 authorities over 10 seconds, then exponentially backoff,
   *    with the next attempt 3-21 seconds later,
598
   * Clients with authorities and fallbacks will try:
599
600
   *  - at least 2 authorities and 4 fallbacks over 21 seconds, then
   *    exponentially backoff, with the next attempts 4-33 seconds later,
601
   * Clients will also retry when an application request arrives.
602
   * After a number of failed requests, clients retry every 3 days + 1 hour.
603
604
605
606
607
608
   *
   * Clients used to try 2 authorities over 10 seconds, then wait for
   * 60 minutes or an application request.
   *
   * When clients have authorities and fallbacks available, they use these
   * schedules: (we stagger the times to avoid thundering herds) */
609
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
610
    "6, 11, 3600, 10800, 25200, 54000, 111600, 262800" /* 3 days + 1 hour */),
611
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
612
613
    "0, 1, 4, 11, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* When clients only have authorities available, they use this schedule: */
614
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
615
616
617
618
619
    "0, 3, 7, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* We don't want to overwhelm slow networks (or mirrors whose replies are
   * blocked), but we also don't want to fail if only some mirrors are
   * blackholed. Clients will try 3 directories simultaneously.
   * (Relays never use simultaneous connections.) */
620
  V(ClientBootstrapConsensusMaxInProgressTries, UINT, "3"),
621
622
  /* When a client has any running bridges, check each bridge occasionally,
    * whether or not that bridge is actually up. */
623
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL,
624
625
626
627
628
629
630
    "10800, 25200, 54000, 111600, 262800"),
  /* When a client is just starting, or has no running bridges, check each
   * bridge a few times quickly, and then try again later. These schedules
   * are much longer than the other schedules, because we try each and every
   * configured bridge with this schedule. */
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL,
    "0, 30, 90, 600, 3600, 10800, 25200, 54000, 111600, 262800"),
631
632
633
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
  V(TestingConsensusMaxDownloadTries, UINT, "8"),
634
635
  /* Since we try connections rapidly and simultaneously, we can afford
   * to give up earlier. (This protects against overloading directories.) */
636
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "7"),
637
  /* We want to give up much earlier if we're only using authorities. */
638
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "4"),
639
640
641
  V(TestingDescriptorMaxDownloadTries, UINT, "8"),
  V(TestingMicrodescMaxDownloadTries, UINT, "8"),
  V(TestingCertMaxDownloadTries, UINT, "8"),
642
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
643
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
644
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
645
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
646
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
647
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
648
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
649

650
  END_OF_CONFIG_VARS
651
};
652

653
654
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
655
static const config_var_t testing_tor_network_defaults[] = {
656
657
658
659
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
660
661
662
663
664
665
666
667
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
    "0, 2, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusMaxDownloadTries, UINT, "80"),
  V(ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries, UINT, "80"),
668
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
669
  V(ClientRejectInternalAddresses, BOOL,   "0"),
670
  V(CountPrivateBandwidth,       BOOL,     "1"),
671
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
672
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
673
674
675
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
676
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
677
678
679
680
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
681
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
682
683
684
685
686
687
688
689
  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"),
690
691
692
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "10, 30, 60"),
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
693
694
695
696
697
698
  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"),
699
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
700
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
701
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
702
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
703
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
704

705
  END_OF_CONFIG_VARS
706
};
707

708
#undef VAR
709
#undef V
710
711
#undef OBSOLETE

712
static const config_deprecation_t option_deprecation_notes_[] = {
713
  /* Deprecated since 0.3.2.0-alpha. */
714
715
716
717
  { "HTTPProxy", "It only applies to direct unencrypted HTTP connections "
    "to your directory server, which your Tor probably wasn't using." },
  { "HTTPProxyAuthenticator", "HTTPProxy is deprecated in favor of HTTPSProxy "
    "which should be used with HTTPSProxyAuthenticator." },
718
719
720
  /* End of options deprecated since 0.3.2.1-alpha */

  /* Options deprecated since 0.3.2.2-alpha */
721
722
723
724
  { "ReachableDirAddresses", "It has no effect on relays, and has had no "
    "effect on clients since 0.2.8." },
  { "ClientPreferIPv6DirPort", "It has no effect on relays, and has had no "
    "effect on clients since 0.2.8." },
725
  /* End of options deprecated since 0.3.2.2-alpha. */
726

727
728
729
  { NULL, NULL }
};

730
#ifdef _WIN32
731
732
static char *get_windows_conf_root(void);
#endif
733
734
735
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
736
                                      char **msg);
737
738
739
740
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);