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
#define CONFIG_PRIVATE
13
#define CONTROL_PRIVATE
14

Roger Dingledine's avatar
Roger Dingledine committed
15
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "circuitlist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
19
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
20
#include "connection_edge.h"
21
#include "connection_or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
22
#include "control.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
23
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
24
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
25
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
26
#include "dns.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
27
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
28
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
29
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
30
#include "networkstatus.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
31
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
32
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
33
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
34
#include "rendservice.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
35
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
36
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "routerlist.h"
38
39
40
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
41

42
43
#include "procmon.h"

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

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

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

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

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

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

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

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

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

424
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
425
};
426

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

451
452
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
453
454
#undef VAR

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

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

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

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

493
  V(TorVersion,                       STRING,   NULL),
494

495
496
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
497

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

503
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
504
505
};

506
#undef VAR
507
#undef V
508
509
#undef OBSOLETE

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

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

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

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

548
549
550
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
551
static void config_line_append(config_line_t **lst,
552
                               const char *key, const char *val);
553
554
555
556
557
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);
558
static int config_lines_eq(config_line_t *a, config_line_t *b);
559
560
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
561
                          const char *name);
562
563
564
565
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,
566
                            int from_setconf, char **msg);
567
568
569
570
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,
571
                                      char **msg);
572
573
574
575
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);
576
static int check_nickname_list(const char *lst, const char *name, char **msg);
577

578
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
579
static int parse_client_transport_line(const char *line, int validate_only);
580
static int parse_dir_server_line(const char *line,
581
                                 dirinfo_type_t required_type,
582
                                 int validate_only);
583
static void port_cfg_free(port_cfg_t *port);
584
585
static int parse_client_ports(const or_options_t *options, int validate_only,
                              char **msg_out, int *n_ports_out);
586
static int validate_data_directory(or_options_t *options);
587
588
589
590
591
592
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);
593
static int or_state_validate(or_state_t *old_options, or_state_t *options,
594
                             int from_setconf, char **msg);
595
596
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
597

598
static int is_listening_on_low_port(int port_option,
599
600
                                    const config_line_t *listen_options);

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

607
/** Magic value for or_options_t. */
608
609
#define OR_OPTIONS_MAGIC 9090909

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

621
/** Magic value for or_state_t. */
622
623
#define OR_STATE_MAGIC 0x57A73f57

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

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

641
642
643
644
645
/*
 * Functions to read and write the global options pointer.
 */

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

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

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

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

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

690
691
/** 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
692
 * as necessary.  Returns 0 on success, -1 on failure.
693
 */
694
int
695
set_options(or_options_t *new_val, char **msg)
696
{
697
698
699
700
  int i;
  char *result;
  smartlist_t *elements;
  config_line_t *line;
701
  or_options_t *old_options = global_options;
702
  global_options = new_val;
703
704
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
705
706
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
707
708
709
    global_options = old_options;
    return -1;
  }
710
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
711
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
712
            "Acting on config options left us in a broken state. Dying.");
713
714
    exit(1);
  }
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
  /* 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,
        options_format.vars[i].name, 0);

        if (line) {
          for (; line; line = line->next) {
            char *tmp;
            tor_asprintf(&tmp, "650-%s=%s", line->key, line->value);
            smartlist_add(elements, tmp);
          }
        } else {
          char *tmp;
          tor_asprintf(&tmp, "650-%s", options_format.vars[i].name);
          smartlist_add(elements, tmp);
        }
      }
    }
    result = smartlist_join_strings(elements, "\r\n", 0, NULL);
    control_event_conf_changed(result);
    tor_free(result);
    SMARTLIST_FOREACH(elements, char *, cp, tor_free(cp));
    smartlist_free(elements);
  }
744
  config_free(&options_format, old_options);
745
746

  return 0;
747
748
}

749
extern const char tor_git_revision[]; /* from tor_main.c */
750

751
/** The version of this Tor process, as parsed. */
752
753
static char *_version = NULL;

754
/** Return the current Tor version. */
755
756
757
const char *
get_version(void)
{
758
  if (_version == NULL) {
759