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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

440
  V(TorVersion,                       STRING,   NULL),
441

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
643
644

  return 0;
645
646
}

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

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

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

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

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

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

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

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

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

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

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

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

/** 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)
833