config.c 201 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

41
42
#include "procmon.h"

43
44
45
/* From main.c */
extern int quiet_level;

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

75
/** An abbreviation for a configuration option allowed on the command line. */
76
typedef struct config_abbrev_t {
77
78
  const char *abbreviated;
  const char *full;
79
  int commandline_only;
80
  int warn;
81
82
} config_abbrev_t;

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

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

/** A list of state-file "abbreviations," for compatibility. */
130
static config_abbrev_t _state_abbrevs[] = {
131
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
132
133
134
135
136
137
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
138
  { NULL, NULL, 0, 0},
139
};
140
#undef PLURAL
141

142
/** A variable allowed in the configuration file or on the command line. */
143
typedef struct config_var_t {
144
  const char *name; /**< The full keyword (case insensitive). */
145
146
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
147
148
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
149
150
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
151
152
153
154
/** 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>"
 */
155
156
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
157
      initvalue }
158
159
160
/** 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
161
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
162
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
163

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

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

426
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
427
};
428

429
430
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
431
static const config_var_t testing_tor_network_defaults[] = {
432
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
433
434
435
436
437
438
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
439
  V(ClientRejectInternalAddresses, BOOL,   "0"),
440
  V(CountPrivateBandwidth,       BOOL,     "1"),
441
442
443
444
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
445
446
447
448
449
  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"),
450
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
451
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
452

453
454
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
455
456
#undef VAR

457
458
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
459
      initvalue }
460
461

/** Array of "state" variables saved to the ~/.tor/state file. */
462
static config_var_t _state_vars[] = {
463
464
465
466
467
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
468
469
470
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
471

472
473
474
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
475
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
476
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
477

478
479
480
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
481
  V(BWHistoryReadMaxima,              CSV,      ""),
482
483
484
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
485
  V(BWHistoryWriteMaxima,             CSV,      ""),
486
487
488
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
489
  V(BWHistoryDirReadMaxima,           CSV,      ""),
490
491
492
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
493
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
494

495
  V(TorVersion,                       STRING,   NULL),
496

497
498
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
499

500
  V(TotalBuildTimes,                  UINT,     NULL),
501
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
502
503
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
504

505
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
506
507
};

508
#undef VAR
509
#undef V
510
511
#undef OBSOLETE

512
513
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
514
515
516
517
518
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

519
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
520
 * well-formed and consistent. See options_trial_assign() for documentation
521
 * of arguments. */
522
typedef int (*validate_fn_t)(void*,void*,int,char**);
523

524
525
526
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
527
typedef struct {
528
529
530
  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
531
  off_t magic_offset; /**< Offset of the magic value within the struct. */
532
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
533
                             * parsing this format. */
534
535
536
  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
537
538
539
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
540
541
} config_format_t;

542
543
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
544
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
545
    tor_assert(fmt && cfg);                                             \
546
    tor_assert((fmt)->magic ==                                          \
547
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
548
  STMT_END
549

550
551
552
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
553
static void config_line_append(config_line_t **lst,
554
                               const char *key, const char *val);
555
556
557
558
559
static void option_clear(const config_format_t *fmt, or_options_t *options,
                         const config_var_t *var);
static void option_reset(const config_format_t *fmt, or_options_t *options,
                         const config_var_t *var, int use_defaults);
static void config_free(const config_format_t *fmt, void *options);
560
static int config_lines_eq(config_line_t *a, config_line_t *b);
561
562
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
563
                          const char *name);
564
565
566
567
static or_options_t *options_dup(const config_format_t *fmt,
                                 const or_options_t *old);
static int options_validate(or_options_t *old_options,
                            or_options_t *options,
568
                            int from_setconf, char **msg);
569
570
571
572
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_act(const or_options_t *old_options);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
573
                                      char **msg);
574
575
576
577
static int options_transition_affects_workers(
      const or_options_t *old_options, const or_options_t *new_options);
static int options_transition_affects_descriptor(
      const or_options_t *old_options, const or_options_t *new_options);
578
static int check_nickname_list(const char *lst, const char *name, char **msg);
579

580
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
581
static int parse_client_transport_line(const char *line, int validate_only);
582
static int parse_dir_server_line(const char *line,
583
                                 dirinfo_type_t required_type,
584
                                 int validate_only);
585
static void port_cfg_free(port_cfg_t *port);
586
587
static int parse_client_ports(const or_options_t *options, int validate_only,
                              char **msg_out, int *n_ports_out);
588
static int validate_data_directory(or_options_t *options);
589
590
591
592
593
594
static int write_configuration_file(const char *fname,
                                    const or_options_t *options);
static config_line_t *get_assigned_option(const config_format_t *fmt,
                                        const void *options, const char *key,
                                        int escape_val);
static void config_init(const config_format_t *fmt, void *options);
595
static int or_state_validate(or_state_t *old_options, or_state_t *options,
596
                             int from_setconf, char **msg);
597
598
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
599

600
static int is_listening_on_low_port(int port_option,
601
602
                                    const config_line_t *listen_options);

603
static uint64_t config_parse_memunit(const char *s, int *ok);
604
static int config_parse_msec_interval(const char *s, int *ok);
605
static int config_parse_interval(const char *s, int *ok);
606
static void init_libevent(const or_options_t *options);
607
static int opt_streq(const char *s1, const char *s2);
608

609
/** Magic value for or_options_t. */
610
611
#define OR_OPTIONS_MAGIC 9090909

612
/** Configuration format for or_options_t. */
613
static config_format_t options_format = {
614
615
616
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
617
618
619
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
620
  NULL
621
622
};

623
/** Magic value for or_state_t. */
624
625
#define OR_STATE_MAGIC 0x57A73f57

626
627
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
628
629
630
631
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

632
/** Configuration format for or_state_t. */
633
static const config_format_t state_format = {
634
635
636
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
637
  _state_abbrevs,
638
639
  _state_vars,
  (validate_fn_t)or_state_validate,
640
  &state_extra_var,
641
642
};

643
644
645
646
647
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
648
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
649
/** Name of most recently read torrc file. */
650
static char *torrc_fname = NULL;
651
/** Persistent serialized state. */
652
static or_state_t *global_state = NULL;
653
654
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
655
/** Contents of most recently read DirPortFrontPage file. */
656
static char *global_dirfrontpagecontents = NULL;
657
658
/** List of port_cfg_t for client-level (SOCKS, DNS, Trans, NATD) ports. */
static smartlist_t *configured_client_ports = NULL;
659
660
661
662
663
664
665

/** Return the contents of our frontpage string, or NULL if not configured. */
const char *
get_dirportfrontpage(void)
{
  return global_dirfrontpagecontents;
}
666

667
/** Allocate an empty configuration object of a given format type. */
668
static void *
669
config_alloc(const config_format_t *fmt)
670
{
671
  void *opts = tor_malloc_zero(fmt->size);
672
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
673
674
675
676
  CHECK(fmt, opts);
  return opts;
}

677
678
/** Return the currently configured options. */
or_options_t *
679
get_options_mutable(void)
680
{
681
682
683
  tor_assert(global_options);
  return global_options;
}
684

685
686
687
688
689
690
691
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

692
693
/** 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
694
 * as necessary.  Returns 0 on success, -1 on failure.
695
 */
696
int
697
set_options(or_options_t *new_val, char **msg)
698
{
699
700
701
  int i;
  smartlist_t *elements;
  config_line_t *line;
702
  or_options_t *old_options = global_options;
703
  global_options = new_val;
704
705
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
706
707
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
708
709
710
    global_options = old_options;
    return -1;
  }
711
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
712
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
713
            "Acting on config options left us in a broken state. Dying.");
714
715
    exit(1);
  }
716
717
718
719
720
721
722
723
  /* Issues a CONF_CHANGED event to notify controller of the change. If Tor is
   * just starting up then the old_options will be undefined. */
  if (old_options) {
    elements = smartlist_create();
    for (i=0; options_format.vars[i].name; ++i) {
      if (!option_is_same(&options_format, new_val, old_options,
        options_format.vars[i].name)) {
        line = get_assigned_option(&options_format, new_val,
724
        options_format.vars[i].name, 1);
725
726
727

        if (line) {
          for (; line; line = line->next) {
728
729
            smartlist_add(elements, line->key);
            smartlist_add(elements, line->value);
730
731
          }
        } else {
732
          smartlist_add(elements, (char*)options_format.vars[i].name);
733
          smartlist_add(elements, NULL);
734
735
736
        }
      }
    }
737
    control_event_conf_changed(elements);
738
739
    smartlist_free(elements);
  }
740
  config_free(&options_format, old_options);
741
742

  return 0;
743
744
}

745
extern const char tor_git_revision[]; /* from tor_main.c */
746