config.c 179 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"
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
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
47
48
  CONFIG_TYPE_MSEC_INTERVAL,/**< A number of milliseconds, with optional
                              * units */
49
  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
200
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
201
  V(ConsensusParams,             STRING,   NULL),
202
  V(ConnLimit,                   UINT,     "1000"),
203
  V(ConnStatistics,              BOOL,     "0"),
204
205
206
207
208
209
210
211
212
  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),
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
220
  V(DirPolicy,                   LINELIST, NULL),
  V(DirPort,                     UINT,     "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(DisableIOCP,                 BOOL,     "1"),
231
232
233
234
  V(DNSPort,                     UINT,     "0"),
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
235
  V(EntryNodes,                  ROUTERSET,   NULL),
236
  V(EntryStatistics,             BOOL,     "0"),
237
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
238
239
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
240
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
241
  V(ExitNodes,                   ROUTERSET, NULL),
242
243
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
244
  V(ExitPortStatistics,          BOOL,     "0"),
245
  V(ExtraInfoStatistics,         BOOL,     "0"),
246

valerino's avatar
valerino committed
247
248
249
#if defined (WINCE)
  V(FallbackNetworkstatusFile,   FILENAME, "fallback-consensus"),
#else
250
  V(FallbackNetworkstatusFile,   FILENAME,
251
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
valerino's avatar
valerino committed
252
#endif
253
254
255
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
256
  V(FetchDirInfoEarly,           BOOL,     "0"),
257
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
258
259
260
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     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
  OBSOLETE("LinkPadding"),
295
296
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
297
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
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
309
  V(NATDListenAddress,           LINELIST, NULL),
  V(NATDPort,                    UINT,     "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,     "0"),
315
316
317
318
  V(NumEntryGuards,              UINT,     "3"),
  V(ORListenAddress,             LINELIST, NULL),
  V(ORPort,                      UINT,     "0"),
  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"),
324
325
  V(PortForwarding,              BOOL,     "0"),
  V(PortForwardingHelper,        FILENAME, "tor-fw-helper"),
Roger Dingledine's avatar
Roger Dingledine committed
326
  V(PreferTunneledDirConns,      BOOL,     "1"),
327
  V(ProtocolWarnings,            BOOL,     "0"),
328
  V(PublishServerDescriptor,     CSV,      "1"),
329
330
331
332
333
334
335
  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),
336
  OBSOLETE("RedirectExit"),
337
  V(RefuseUnknownExits,          STRING,   "auto"),
338
  V(RejectPlaintextPorts,        CSV,      ""),
339
340
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
341
342
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
343
344
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
345
  OBSOLETE("RouterFile"),
346
  V(RunAsDaemon,                 BOOL,     "0"),
347
348
//  V(RunTesting,                  BOOL,     "0"),
  OBSOLETE("RunTesting"), // currently unused
349
  V(SafeLogging,                 STRING,   "1"),
350
  V(SafeSocks,                   BOOL,     "0"),
351
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
352
353
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
354
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
355
356
357
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
358
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
359
360
361
362
363
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
  V(SocksPort,                   UINT,     "9050"),
  V(SocksTimeout,                INTERVAL, "2 minutes"),
364
  OBSOLETE("StatusFetchPeriod"),
365
  V(StrictNodes,                 BOOL,     "0"),
366
  OBSOLETE("SysLog"),
367
  V(TestSocks,                   BOOL,     "0"),
368
  OBSOLETE("TestVia"),
369
370
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
371
  OBSOLETE("TrafficShaping"),
372
373
  V(TransListenAddress,          LINELIST, NULL),
  V(TransPort,                   UINT,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
374
  V(TunnelDirConns,              BOOL,     "1"),
375
376
377
378
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
  V(UseBridges,                  BOOL,     "0"),
  V(UseEntryGuards,              BOOL,     "1"),
  V(User,                        STRING,   NULL),
379
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
380
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
381
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
382
383
384
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
385
386
387
388
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
389
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
390
  V(V3BandwidthsFile,            FILENAME, NULL),
391
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
392
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
393
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
394
  V(_UseFilteringSSLBufferevents, BOOL,    "0"),
395
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
396
397
398
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
399
400
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
401
  V(MinUptimeHidServDirectoryV2, INTERVAL, "24 hours"),
402

403
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
404
};
405

406
407
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
408
static config_var_t testing_tor_network_defaults[] = {
409
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
410
411
412
413
414
415
416
417
418
419
  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"),
420
421
422
423
424
  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"),
425
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
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
454
455
456
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
457
458
459
460
461
462
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
463

464
  V(TorVersion,                       STRING,   NULL),
465

466
467
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
468

469
  V(TotalBuildTimes,                  UINT,     NULL),
470
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
471
472
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
473

474
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
475
476
};

477
#undef VAR
478
#undef V
479
480
#undef OBSOLETE

481
482
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
483
484
485
486
487
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

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

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

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

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

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

562
563
564
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

565
static uint64_t config_parse_memunit(const char *s, int *ok);
566
static int config_parse_msec_interval(const char *s, int *ok);
567
static int config_parse_interval(const char *s, int *ok);
568
static void init_libevent(const or_options_t *options);
569
static int opt_streq(const char *s1, const char *s2);
570

571
/** Magic value for or_options_t. */
572
573
#define OR_OPTIONS_MAGIC 9090909

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

585
/** Magic value for or_state_t. */
586
587
#define OR_STATE_MAGIC 0x57A73f57

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

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

605
606
607
608
609
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

  config_free(&options_format, old_options);
668
669

  return 0;
670
671
}

672
extern const char tor_git_revision[]; /* from tor_main.c */
673

674
/** The version of this Tor process, as parsed. */
675
676
static char *_version = NULL;

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

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

701
  routerset_free(options->_ExcludeExitNodesUnion);
702
703
704
705
706
  if (options->NodeFamilySets) {
    SMARTLIST_FOREACH(options->NodeFamilySets, routerset_t *,
                      rs, routerset_free(rs));
    smartlist_free(options->NodeFamilySets);
  }
707
708
709
  config_free(&options_format, options);
}

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

724
  tor_free(torrc_fname);
725
  tor_free(_version);
726
  tor_free(global_dirfrontpagecontents);
727
728
}

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

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

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

774
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
775
776
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
777
778
779
const char *
escaped_safe_str(const char *address)
{
780
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
781
782
783
784
785
    return "[scrubbed]";
  else
    return escaped(address);
}

786
787
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
788
static void
789
add_default_trusted_dir_authorities(authority_type_t type)
790
{
791
  int i;
792
  const char *dirservers[] = {