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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

443
  V(TorVersion,                       STRING,   NULL),
444

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
646
647

  return 0;
648
649
}

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

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

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

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

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

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

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

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

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

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

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

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

/** 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 &&
       (