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 "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "routerlist.h"
34
35
36
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
37

Nick Mathewson's avatar
Nick Mathewson committed
38
39
/** Enumeration of types which option values can take */
typedef enum config_type_t {
40
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
41
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
42
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
43
44
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
45
46
  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
47
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
48
49
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
50
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
51
52
53
54
55
  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.
                             */
56
57
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
58
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
59
} config_type_t;
60

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

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

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

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

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

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

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

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

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

394
395
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
396
static config_var_t testing_tor_network_defaults[] = {
397
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
398
399
400
401
402
403
404
405
406
407
  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"),
408
409
410
411
412
  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"),
413
414
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
415
416
#undef VAR

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

/** Array of "state" variables saved to the ~/.tor/state file. */
422
static config_var_t _state_vars[] = {
423
424
425
426
427
  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
428

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

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

442
  V(TorVersion,                       STRING,   NULL),
443

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

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

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

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

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

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

471
472
473
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
474
typedef struct {
475
476
477
  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
478
  off_t magic_offset; /**< Offset of the magic value within the struct. */
479
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
480
                             * parsing this format. */
481
482
483
  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
484
485
486
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
487
488
} config_format_t;

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
645
646

  return 0;
647
648
}

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

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

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

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

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

682
683
/** Release all memory and resources held by global configuration structures.
 */
684
685
686
void
config_free_all(void)
{
687
688
689
690
691
692
693
694
695
  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;

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

701
702
703
704
705
/** 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.)
706
707
 */
const char *
708
safe_str_client(const char *address)
709
{
710
  tor_assert(address);
711
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
712
713
714
715
716
    return "[scrubbed]";
  else
    return address;
}

717
718
719
720
721
722
/** 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.)
723
724
 */
const char *
725
726
safe_str(const char *address)
{
727
  tor_assert(address);
728
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
729
730
731
732
733
    return "[scrubbed]";
  else
    return address;
}

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

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

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

/** 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 "