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

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

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

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

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

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

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

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

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

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

388
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
389
};
390

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

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

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

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

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

439
  V(TorVersion,                       STRING,   NULL),
440

441
442
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
443

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

449
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
450
451
};

452
#undef VAR
453
#undef V
454
455
#undef OBSOLETE

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

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

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

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

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

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

537
538
539
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

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

545
/** Magic value for or_options_t. */
546
547
#define OR_OPTIONS_MAGIC 9090909

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

559
/** Magic value for or_state_t. */
560
561
#define OR_STATE_MAGIC 0x57A73f57

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

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

579
580
581
582
583
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

  config_free(&options_format, old_options);
642
643

  return 0;
644
645
}

646
extern const char tor_git_revision[]; /* from tor_main.c */
647

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

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

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

675
  routerset_free(options->_ExcludeExitNodesUnion);
676
677
678
  config_free(&options_format, options);
}

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

693
  tor_free(torrc_fname);
694
  tor_free(_version);
695
  tor_free(global_dirfrontpagecontents);
696
697
}

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

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

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

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

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

/** 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)
832
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)