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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

436
  V(TorVersion,                       STRING,   NULL),
437

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  config_free(&options_format, old_options);
639
640

  return 0;
641
642
}

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

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

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

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

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

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

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

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

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

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

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

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

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