config.c 176 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-2011, 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"
20
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
21
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "networkstatus.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "routerlist.h"
37
38
39
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
40

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

66
/** An abbreviation for a configuration option allowed on the command line. */
67
typedef struct config_abbrev_t {
68
69
  const char *abbreviated;
  const char *full;
70
  int commandline_only;
71
  int warn;
72
73
} config_abbrev_t;

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

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

/** A list of state-file "abbreviations," for compatibility. */
121
static config_abbrev_t _state_abbrevs[] = {
122
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
123
124
125
126
127
128
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
129
  { NULL, NULL, 0, 0},
130
};
131
#undef PLURAL
132

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

Nick Mathewson's avatar
Nick Mathewson committed
142
143
144
145
/** 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>"
 */
146
147
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
148
      initvalue }
149
150
151
/** 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
152
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
153
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
154

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

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

401
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
402
};
403

404
405
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
406
static config_var_t testing_tor_network_defaults[] = {
407
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
408
409
410
411
412
413
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
414
  V(ClientRejectInternalAddresses, BOOL,   "0"),
415
416
417
418
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
419
420
421
422
423
  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"),
424
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
425
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
426
427
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
428
429
#undef VAR

430
431
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
432
      initvalue }
433
434

/** Array of "state" variables saved to the ~/.tor/state file. */
435
static config_var_t _state_vars[] = {
436
437
438
439
440
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
441
442
443
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
444

445
446
447
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
448
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
449
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
450

451
452
453
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
454
  V(BWHistoryReadMaxima,              CSV,      ""),
455
456
457
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
458
  V(BWHistoryWriteMaxima,             CSV,      ""),
459
460
461
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
462
  V(BWHistoryDirReadMaxima,           CSV,      ""),
463
464
465
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
466
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
467

468
  V(TorVersion,                       STRING,   NULL),
469

470
471
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
472

473
  V(TotalBuildTimes,                  UINT,     NULL),
474
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
475
476
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
477

478
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
479
480
};

481
#undef VAR
482
#undef V
483
484
#undef OBSOLETE

485
486
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
487
488
489
490
491
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

492
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
493
 * well-formed and consistent. See options_trial_assign() for documentation
494
 * of arguments. */
495
typedef int (*validate_fn_t)(void*,void*,int,char**);
496

497
498
499
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
500
typedef struct {
501
502
503
  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
504
  off_t magic_offset; /**< Offset of the magic value within the struct. */
505
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
506
                             * parsing this format. */
507
508
509
  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
510
511
512
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
513
514
} config_format_t;

515
516
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
517
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
518
    tor_assert(fmt && cfg);                                             \
519
    tor_assert((fmt)->magic ==                                          \
520
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
521
  STMT_END
522

523
524
525
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
526
static void config_line_append(config_line_t **lst,
527
                               const char *key, const char *val);
528
529
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
530
static void option_reset(config_format_t *fmt, or_options_t *options,
531
                         config_var_t *var, int use_defaults);
532
static void config_free(config_format_t *fmt, void *options);
533
static int config_lines_eq(config_line_t *a, config_line_t *b);
534
static int option_is_same(config_format_t *fmt,
535
536
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
537
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
538
539
540
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);
541
static int options_act(or_options_t *old_options);
542
543
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
544
545
546
547
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);
548
static int check_nickname_list(const char *lst, const char *name, char **msg);
549
static void config_register_addressmaps(or_options_t *options);
550

551
static int parse_bridge_line(const char *line, int validate_only);
552
553
554
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
555
static int validate_data_directory(or_options_t *options);
556
static int write_configuration_file(const char *fname, or_options_t *options);
557
static config_line_t *get_assigned_option(config_format_t *fmt,
558
559
                                          void *options, const char *key,
                                          int escape_val);
560
static void config_init(config_format_t *fmt, void *options);
561
static int or_state_validate(or_state_t *old_options, or_state_t *options,
562
                             int from_setconf, char **msg);
563
564
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
565

566
static int is_listening_on_low_port(int port_option,
567
568
                                    const config_line_t *listen_options);

569
570
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
571
static void init_libevent(void);
572
static int opt_streq(const char *s1, const char *s2);
573

574
/** Magic value for or_options_t. */
575
576
#define OR_OPTIONS_MAGIC 9090909

577
/** Configuration format for or_options_t. */
578
static config_format_t options_format = {
579
580
581
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
582
583
584
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
585
  NULL
586
587
};

588
/** Magic value for or_state_t. */
589
590
#define OR_STATE_MAGIC 0x57A73f57

591
592
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
593
594
595
596
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

597
/** Configuration format for or_state_t. */
598
599
600
601
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
602
  _state_abbrevs,
603
604
  _state_vars,
  (validate_fn_t)or_state_validate,
605
  &state_extra_var,
606
607
};

608
609
610
611
612
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
613
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
614
/** Name of most recently read torrc file. */
615
static char *torrc_fname = NULL;
616
/** Persistent serialized state. */
617
static or_state_t *global_state = NULL;
618
619
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
620
/** Contents of most recently read DirPortFrontPage file. */
621
622
623
624
625
626
627
628
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;
}
629

630
/** Allocate an empty configuration object of a given format type. */
631
632
633
static void *
config_alloc(config_format_t *fmt)
{
634
  void *opts = tor_malloc_zero(fmt->size);
635
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
636
637
638
639
  CHECK(fmt, opts);
  return opts;
}

640
641
/** Return the currently configured options. */
or_options_t *
642
643
get_options(void)
{
644
645
646
  tor_assert(global_options);
  return global_options;
}
647

648
649
/** 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
650
 * as necessary.  Returns 0 on success, -1 on failure.
651
 */
652
int
653
set_options(or_options_t *new_val, char **msg)
654
{
655
  or_options_t *old_options = global_options;
656
  global_options = new_val;
657
658
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
659
660
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
661
662
663
    global_options = old_options;
    return -1;
  }
664
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
665
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
666
            "Acting on config options left us in a broken state. Dying.");
667
668
    exit(1);
  }
669
670

  config_free(&options_format, old_options);
671
672

  return 0;
673
674
}

675
extern const char tor_git_revision[]; /* from tor_main.c */
676

677
/** The version of this Tor process, as parsed. */
678
679
static char *_version = NULL;

680
/** Return the current Tor version. */
681
682
683
const char *
get_version(void)
{
684
  if (_version == NULL) {
685
686
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
687
      _version = tor_malloc(len);
688
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
689
    } else {
690
      _version = tor_strdup(VERSION);
691
692
    }
  }
693
  return _version;
694
695
}

696
697
698
699
700
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
701
702
703
  if (!options)
    return;

704
  routerset_free(options->_ExcludeExitNodesUnion);
705
706
707
  config_free(&options_format, options);
}

708
709
/** Release all memory and resources held by global configuration structures.
 */
710
711
712
void
config_free_all(void)
{
713
714
715
716
717
718
719
720
721
  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;

722
  tor_free(torrc_fname);
723
  tor_free(_version);
724
  tor_free(global_dirfrontpagecontents);
725
726
}

727
728
729
730
731
/** 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.)
732
733
 */
const char *
734
safe_str_client(const char *address)
735
{
736
  tor_assert(address);
737
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
738
739
740
741
742
    return "[scrubbed]";
  else
    return address;
}

743
744
745
746
747
748
/** 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.)
749
750
 */
const char *
751
752
safe_str(const char *address)
{
753
  tor_assert(address);
754
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
755
756
757
758
759
    return "[scrubbed]";
  else
    return address;
}

760
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
761
762
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
763
const char *
764
escaped_safe_str_client(const char *address)
765
{
766
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
767
768
769
770
771
    return "[scrubbed]";
  else
    return escaped(address);
}