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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

438
  V(TorVersion,                       STRING,   NULL),
439

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
641
642

  return 0;
643
644
}

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

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

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

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

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

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

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

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

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

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

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

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

/** 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)
831
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
832
833
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)