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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

437
  V(TorVersion,                       STRING,   NULL),
438

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
640
641

  return 0;
642
643
}

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

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

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

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

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

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

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

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

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

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

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

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

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