config.c 170 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2010, 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
13
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "connection_edge.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
20
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "networkstatus.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "routerlist.h"
33
34
35
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
36

Nick Mathewson's avatar
Nick Mathewson committed
37
38
/** Enumeration of types which option values can take */
typedef enum config_type_t {
39
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
40
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
41
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
42
43
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
44
45
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
Nick Mathewson's avatar
Nick Mathewson committed
46
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
47
48
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
49
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
50
51
52
53
54
  CONFIG_TYPE_LINELIST_S,   /**< Uninterpreted, context-sensitive config lines,
                             * mixed with other keywords. */
  CONFIG_TYPE_LINELIST_V,   /**< Catch-all "virtual" option to summarize
                             * context-sensitive config lines when fetching.
                             */
55
56
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
57
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
58
} config_type_t;
59

60
/** An abbreviation for a configuration option allowed on the command line. */
61
typedef struct config_abbrev_t {
62
63
  const char *abbreviated;
  const char *full;
64
  int commandline_only;
65
  int warn;
66
67
} config_abbrev_t;

68
69
/* Handy macro for declaring "In the config file or on the command line,
 * you can abbreviate <b>tok</b>s as <b>tok</b>". */
70
#define PLURAL(tok) { #tok, #tok "s", 0, 0 }
71

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

/** A list of state-file "abbreviations," for compatibility. */
115
static config_abbrev_t _state_abbrevs[] = {
116
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
117
118
119
120
121
122
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
123
  { NULL, NULL, 0, 0},
124
};
125
#undef PLURAL
126

127
/** A variable allowed in the configuration file or on the command line. */
128
typedef struct config_var_t {
129
  const char *name; /**< The full keyword (case insensitive). */
130
131
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
132
133
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
134
135
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
136
137
138
139
/** 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>"
 */
140
141
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
142
      initvalue }
143
144
145
/** 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
146
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
147
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
148

Nick Mathewson's avatar
Nick Mathewson committed
149
150
151
152
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
153
static config_var_t _option_vars[] = {
154
  OBSOLETE("AccountingMaxKB"),
155
156
157
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
158
  V(AllowDotExit,                BOOL,     "0"),
159
160
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
161
162
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
163
164
165
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
  V(AlternateHSAuthority,        LINELIST, NULL),
166
  V(AssumeReachable,             BOOL,     "0"),
167
  V(AuthDirBadDir,               LINELIST, NULL),
168
169
170
171
  V(AuthDirBadExit,              LINELIST, NULL),
  V(AuthDirInvalid,              LINELIST, NULL),
  V(AuthDirReject,               LINELIST, NULL),
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
172
  V(AuthDirListBadDirs,          BOOL,     "0"),
173
  V(AuthDirListBadExits,         BOOL,     "0"),
174
175
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
176
177
178
179
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
180
181
  V(BandwidthBurst,              MEMUNIT,  "10 MB"),
  V(BandwidthRate,               MEMUNIT,  "5 MB"),
182
183
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
184
  V(BridgePassword,              STRING,   NULL),
185
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
186
  V(BridgeRelay,                 BOOL,     "0"),
187
  V(CellStatistics,              BOOL,     "0"),
188
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
189
  V(CircuitBuildTimeout,         INTERVAL, "0"),
190
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
191
  V(CircuitStreamTimeout,        INTERVAL, "0"),
192
  V(CircuitPriorityHalflife,     DOUBLE,  "-100.0"), /*negative:'Use default'*/
193
194
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
195
  V(ConsensusParams,             STRING,   NULL),
196
197
198
199
200
201
202
203
204
205
  V(ConnLimit,                   UINT,     "1000"),
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
  V(ControlListenAddress,        LINELIST, NULL),
  V(ControlPort,                 UINT,     "0"),
  V(ControlSocket,               LINELIST, NULL),
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
206
  V(DataDirectory,               FILENAME, NULL),
207
  OBSOLETE("DebugLogFile"),
208
  V(DirAllowPrivateAddresses,    BOOL,     NULL),
209
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
210
  V(DirListenAddress,            LINELIST, NULL),
211
  OBSOLETE("DirFetchPeriod"),
212
213
  V(DirPolicy,                   LINELIST, NULL),
  V(DirPort,                     UINT,     "0"),
214
  V(DirPortFrontPage,            FILENAME, NULL),
215
  OBSOLETE("DirPostPeriod"),
216
217
218
219
  OBSOLETE("DirRecordUsageByCountry"),
  OBSOLETE("DirRecordUsageGranularity"),
  OBSOLETE("DirRecordUsageRetainIPs"),
  OBSOLETE("DirRecordUsageSaveInterval"),
Karsten Loesing's avatar
Karsten Loesing committed
220
  V(DirReqStatistics,            BOOL,     "0"),
221
  VAR("DirServer",               LINELIST, DirServers, NULL),
222
  V(DisableAllSwap,              BOOL,     "0"),
223
224
225
226
  V(DNSPort,                     UINT,     "0"),
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
227
  V(EntryNodes,                  ROUTERSET,   NULL),
228
  V(EntryStatistics,             BOOL,     "0"),
229
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
230
231
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
232
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
233
  V(ExitNodes,                   ROUTERSET, NULL),
234
235
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
236
  V(ExitPortStatistics,          BOOL,     "0"),
237
  V(ExtraInfoStatistics,         BOOL,     "0"),
238

valerino's avatar
valerino committed
239
240
241
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
242
  V(FallbackNetworkstatusFile,   FILENAME,
243
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
244
#endif
245
246
247
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
248
  V(FetchDirInfoEarly,           BOOL,     "0"),
249
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
250
251
252
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
253
#ifdef WIN32
254
  V(GeoIPFile,                   FILENAME, "<default>"),
255
#else
256
257
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
258
#endif
259
  OBSOLETE("Group"),
260
  V(HardwareAccel,               BOOL,     "0"),
261
262
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
263
  V(HashedControlPassword,       LINELIST, NULL),
264
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
265
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
266
267
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
268
269
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
270
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
271
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
272
  V(HidServAuth,                 LINELIST, NULL),
273
  V(HSAuthoritativeDir,          BOOL,     "0"),
274
  OBSOLETE("HSAuthorityRecordStats"),
275
276
277
278
  V(HttpProxy,                   STRING,   NULL),
  V(HttpProxyAuthenticator,      STRING,   NULL),
  V(HttpsProxy,                  STRING,   NULL),
  V(HttpsProxyAuthenticator,     STRING,   NULL),
279
280
281
282
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
283
  OBSOLETE("IgnoreVersion"),
284
285
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
286
  OBSOLETE("LinkPadding"),
287
288
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
289
  V(LongLivedPorts,              CSV,
290
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
291
292
293
294
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
  V(MaxOnionsPending,            UINT,     "100"),
295
  OBSOLETE("MonthlyAccountingStart"),
296
297
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
298
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
299
300
301
  V(NatdListenAddress,           LINELIST, NULL),
  V(NatdPort,                    UINT,     "0"),
  V(Nickname,                    STRING,   NULL),
302
  V(WarnUnsafeSocks,              BOOL,     "1"),
303
304
305
306
307
308
309
  V(NoPublish,                   BOOL,     "0"),
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
  V(NumCpus,                     UINT,     "1"),
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
  V(ORPort,                      UINT,     "0"),
  V(OutboundBindAddress,         STRING,   NULL),
310
  OBSOLETE("PathlenCoinWeight"),
311
312
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
313
  V(PidFile,                     STRING,   NULL),
314
  V(TestingTorNetwork,           BOOL,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
315
  V(PreferTunneledDirConns,      BOOL,     "1"),
316
  V(ProtocolWarnings,            BOOL,     "0"),
317
  V(PublishServerDescriptor,     CSV,      "1"),
318
319
320
321
322
323
324
  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),
325
  OBSOLETE("RedirectExit"),
326
  V(RefuseUnknownExits,          BOOL,     "0"),
327
  V(RejectPlaintextPorts,        CSV,      ""),
328
329
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
330
331
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
332
333
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
334
  OBSOLETE("RouterFile"),
335
336
  V(RunAsDaemon,                 BOOL,     "0"),
  V(RunTesting,                  BOOL,     "0"),
337
  V(SafeLogging,                 STRING,   "1"),
338
  V(SafeSocks,                   BOOL,     "0"),
339
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
340
341
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
342
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
343
344
345
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
346
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
347
348
349
350
351
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
  V(SocksPort,                   UINT,     "9050"),
  V(SocksTimeout,                INTERVAL, "2 minutes"),
352
  OBSOLETE("StatusFetchPeriod"),
353
  V(StrictNodes,                 BOOL,     "0"),
354
  OBSOLETE("SysLog"),
355
  V(TestSocks,                   BOOL,     "0"),
356
  OBSOLETE("TestVia"),
357
358
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
359
  OBSOLETE("TrafficShaping"),
360
361
  V(TransListenAddress,          LINELIST, NULL),
  V(TransPort,                   UINT,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
362
  V(TunnelDirConns,              BOOL,     "1"),
363
364
365
366
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
  V(UseBridges,                  BOOL,     "0"),
  V(UseEntryGuards,              BOOL,     "1"),
  V(User,                        STRING,   NULL),
367
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
368
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
369
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
370
371
372
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
373
374
375
376
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
377
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
378
  V(V3BandwidthsFile,            FILENAME, NULL),
379
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
380
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
381
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
382
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
383
384
385
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
386
387
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
388
  V(MinUptimeHidServDirectoryV2, INTERVAL, "24 hours"),
389

390
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
391
};
392

393
394
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
395
static config_var_t testing_tor_network_defaults[] = {
396
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
397
398
399
400
401
402
403
404
405
406
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
407
408
409
410
411
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
412
413
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
414
415
#undef VAR

416
417
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
418
      initvalue }
419
420

/** Array of "state" variables saved to the ~/.tor/state file. */
421
static config_var_t _state_vars[] = {
422
423
424
425
426
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
427

428
429
430
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
431
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
432
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
433

434
435
436
437
438
439
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
440

441
  V(TorVersion,                       STRING,   NULL),
442

443
444
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
445

446
  V(TotalBuildTimes,                  UINT,     NULL),
447
  V(CircuitBuildAbandonedCount,         UINT,     "0"),
448
449
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
450

451
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
452
453
};

454
#undef VAR
455
#undef V
456
457
#undef OBSOLETE

458
459
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
460
461
462
463
464
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

465
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
466
 * well-formed and consistent. See options_trial_assign() for documentation
467
 * of arguments. */
468
typedef int (*validate_fn_t)(void*,void*,int,char**);
469

470
471
472
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
473
typedef struct {
474
475
476
  size_t size; /**< Size of the struct that everything gets parsed into. */
  uint32_t magic; /**< Required 'magic value' to make sure we have a struct
                   * of the right type. */
Roger Dingledine's avatar
Roger Dingledine committed
477
  off_t magic_offset; /**< Offset of the magic value within the struct. */
478
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
479
                             * parsing this format. */
480
481
482
  config_var_t *vars; /**< List of variables we recognize, their default
                       * values, and where we stick them in the structure. */
  validate_fn_t validate_fn; /**< Function to validate config. */
Roger Dingledine's avatar
Roger Dingledine committed
483
484
485
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
486
487
} config_format_t;

488
489
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
490
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
491
    tor_assert(fmt && cfg);                                             \
492
    tor_assert((fmt)->magic ==                                          \
493
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
494
  STMT_END
495

496
497
498
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
499
static void config_line_append(config_line_t **lst,
500
                               const char *key, const char *val);
501
502
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
503
static void option_reset(config_format_t *fmt, or_options_t *options,
504
                         config_var_t *var, int use_defaults);
505
static void config_free(config_format_t *fmt, void *options);
506
static int config_lines_eq(config_line_t *a, config_line_t *b);
507
static int option_is_same(config_format_t *fmt,
508
509
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
510
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
511
512
513
static int options_validate(or_options_t *old_options, or_options_t *options,
                            int from_setconf, char **msg);
static int options_act_reversible(or_options_t *old_options, char **msg);
514
static int options_act(or_options_t *old_options);
515
516
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
517
518
519
520
static int options_transition_affects_workers(or_options_t *old_options,
                                              or_options_t *new_options);
static int options_transition_affects_descriptor(or_options_t *old_options,
                                                 or_options_t *new_options);
521
static int check_nickname_list(const char *lst, const char *name, char **msg);
522
static void config_register_addressmaps(or_options_t *options);
523

524
static int parse_bridge_line(const char *line, int validate_only);
525
526
527
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
528
static int validate_data_directory(or_options_t *options);
529
static int write_configuration_file(const char *fname, or_options_t *options);
530
static config_line_t *get_assigned_option(config_format_t *fmt,
531
532
                                          void *options, const char *key,
                                          int escape_val);
533
static void config_init(config_format_t *fmt, void *options);
534
static int or_state_validate(or_state_t *old_options, or_state_t *options,
535
                             int from_setconf, char **msg);
536
537
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
538

539
540
541
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

542
543
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
544
static void init_libevent(void);
545
static int opt_streq(const char *s1, const char *s2);
546

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

550
/** Configuration format for or_options_t. */
551
static config_format_t options_format = {
552
553
554
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
555
556
557
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
558
  NULL
559
560
};

561
/** Magic value for or_state_t. */
562
563
#define OR_STATE_MAGIC 0x57A73f57

564
565
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
566
567
568
569
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

570
/** Configuration format for or_state_t. */
571
572
573
574
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
575
  _state_abbrevs,
576
577
  _state_vars,
  (validate_fn_t)or_state_validate,
578
  &state_extra_var,
579
580
};

581
582
583
584
585
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
586
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
587
/** Name of most recently read torrc file. */
588
static char *torrc_fname = NULL;
589
/** Persistent serialized state. */
590
static or_state_t *global_state = NULL;
591
592
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
593
/** Contents of most recently read DirPortFrontPage file. */
594
595
596
597
598
599
600
601
static char *global_dirfrontpagecontents = NULL;

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

603
/** Allocate an empty configuration object of a given format type. */
604
605
606
static void *
config_alloc(config_format_t *fmt)
{
607
  void *opts = tor_malloc_zero(fmt->size);
608
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
609
610
611
612
  CHECK(fmt, opts);
  return opts;
}

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

621
622
/** 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
623
 * as necessary.  Returns 0 on success, -1 on failure.
624
 */
625
int
626
set_options(or_options_t *new_val, char **msg)
627
{
628
  or_options_t *old_options = global_options;
629
  global_options = new_val;
630
631
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
632
633
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
634
635
636
    global_options = old_options;
    return -1;
  }
637
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
638
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
639
            "Acting on config options left us in a broken state. Dying.");
640
641
    exit(1);
  }
642
643

  config_free(&options_format, old_options);
644
645

  return 0;
646
647
}

648
extern const char tor_git_revision[]; /* from tor_main.c */
649

650
/** The version of this Tor process, as parsed. */
651
652
static char *_version = NULL;

653
/** Return the current Tor version. */
654
655
656
const char *
get_version(void)
{
657
  if (_version == NULL) {
658
659
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
660
      _version = tor_malloc(len);
661
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
662
    } else {
663
      _version = tor_strdup(VERSION);
664
665
    }
  }
666
  return _version;
667
668
}

669
670
671
672
673
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
674
675
676
  if (!options)
    return;

677
  routerset_free(options->_ExcludeExitNodesUnion);
678
679
680
  config_free(&options_format, options);
}

681
682
/** Release all memory and resources held by global configuration structures.
 */
683
684
685
void
config_free_all(void)
{
686
687
688
689
690
691
692
693
694
  or_options_free(global_options);
  global_options = NULL;

  config_free(&state_format, global_state);
  global_state = NULL;

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

695
  tor_free(torrc_fname);
696
  tor_free(_version);
697
  tor_free(global_dirfrontpagecontents);
698
699
}

700
701
702
703
704
/** Make <b>address</b> -- a piece of information related to our operation as
 * a client -- safe to log according to the settings in options->SafeLogging,
 * and return it.
 *
 * (We return "[scrubbed]" if SafeLogging is "1", and address otherwise.)
705
706
 */
const char *
707
safe_str_client(const char *address)
708
{
709
  tor_assert(address);
710
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
711
712
713
714
715
    return "[scrubbed]";
  else
    return address;
}

716
717
718
719
720
721
/** Make <b>address</b> -- a piece of information of unspecified sensitivity
 * -- safe to log according to the settings in options->SafeLogging, and
 * return it.
 *
 * (We return "[scrubbed]" if SafeLogging is anything besides "0", and address
 * otherwise.)
722
723
 */
const char *
724
725
safe_str(const char *address)
{
726
  tor_assert(address);
727
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
728
729
730
731
732
    return "[scrubbed]";
  else
    return address;
}

733
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
734
735
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
736
const char *
737
escaped_safe_str_client(const char *address)
738
{
739
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
740
741
742
743
744
    return "[scrubbed]";
  else
    return escaped(address);
}

745
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
746
747
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
748
749
750
const char *
escaped_safe_str(const char *address)
{
751
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
752
753
754
755
756
    return "[scrubbed]";
  else
    return escaped(address);
}

757
758
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
759
static void
760
add_default_trusted_dir_authorities(authority_type_t type)
761
{
762
  int i;
763
  const char *dirservers[] = {
764
765
766
    "moria1 orport=9101 no-v2 "
      "v3ident=D586D18309DED4CD6D57C18FDB97EFA96D330566 "
      "128.31.0.39:9131 9695 DFC3 5FFE B861 329B 9F1A B04C 4639 7020 CE31",
767
    "tor26 v1 orport=443 v3ident=14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 "
Peter Palfrader's avatar
Peter Palfrader committed
768
      "86.59.21.38:80 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
Roger Dingledine's avatar
Roger Dingledine committed
769
770
    "dizum orport=443 v3ident=E8A9C45EDE6D711294FADF8E7951F4DE6CA56B58 "
      "194.109.206.212:80 7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
771
    "Tonga orport=443 bridge no-v2 82.94.251.203:80 "
772
      "4A0C CD2D DC79 9508 3D73 F5D6 6710 0C8A 5831 F16D",
773
774
    "ides orport=9090 no-v2 v3ident=27B6B5996C426270A5C95488AA5BCEB6BCC86956 "
      "216.224.124.114:9030 F397 038A DC51 3361 35E7 B80B D99C A384 4360 292B",
775
776
777
    "gabelmoo orport=8080 no-v2 "
      "v3ident=ED03BB616EB2F60BEC80151114BB25CEF515B226 "
      "80.190.246.100:8180 F204 4413 DAC2 E02E 3D6B CF47 35A1 9BCA 1DE9 7281",
778
779
    "dannenberg orport=443 no-v2 "
      "v3ident=585769C78764D58426B8B52B6651A5A71137189A "
780
      "193.23.244.244:80 7BE6 83E6 5D48 1413 21C5 ED92 F075 C553 64AC 7123",
781
782
    "urras orport=80 no-v2 v3ident=80550987E1D626E3EBA5E5E75A458DE0626D088C "
      "208.83.223.34:443 0AD3 FA88 4D18 F89E EA2D 89C0 1937 9E0E 7FD9 4417",
783
784
785
    "maatuska orport=80 no-v2 "
      "v3ident=49015F787433103580E3B66A1707A00E60F2D15B "
      "213.115.239.118:443 BD6A 8292 55CB 08E6 6FBE 7D37 4836 3586 E46B 3810",
786
    NULL
787
  };
788
789
790
791
792
793
  for (i=0; dirservers[i]; i++) {
    if (parse_dir_server_line(dirservers[i], type, 0)<0) {
      log_err(LD_BUG, "Couldn't parse internal dirserver line %s",
              dirservers[i]);
    }
  }
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
}

/** Look at all the config options for using alternate directory
 * authorities, and make sure none of them are broken. Also, warn the
 * user if we changed any dangerous ones.
 */
static int
validate_dir_authorities(or_options_t *options, or_options_t *old_options)
{
  config_line_t *cl;

  if (options->DirServers &&
      (options->AlternateDirAuthority || options->AlternateBridgeAuthority ||
       options->AlternateHSAuthority)) {
    log_warn(LD_CONFIG,
             "You cannot set both DirServers and Alternate*Authority.");
    return -1;
  }

  /* do we want to complain to the user about being partitionable? */
  if ((options->DirServers &&
       (!old_options ||
        !config_lines_eq(options->DirServers, old_options->DirServers))) ||
      (options->AlternateDirAuthority &&
       (!old_options ||
        !config_lines_eq(options->AlternateDirAuthority,
                         old_options->AlternateDirAuthority)))) {
    log_warn(LD_CONFIG,
             "You have used DirServer or AlternateDirAuthority to "
             "specify alternate directory authorities in "
             "your configuration. This is potentially dangerous: it can "
             "make you look different from all other Tor users, and hurt "
             "your anonymity. Even if you've specified the same "
             "authorities as Tor uses by default, the defaults could "
             "change in the future. Be sure you know what you're doing.");
  }

  /* Now go through the four ways you can configure an alternate
   * set of directory authorities, and make sure none are broken. */
  for (cl = options->DirServers; cl; cl = cl->next)