config.c 218 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"
36
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
37
#include "routerlist.h"
38
#include "transports.h"
39
40
41
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
42

43
44
#include "procmon.h"

45
46
47
/* From main.c */
extern int quiet_level;

48
49
50
51
52
53
54
55
/* Includes for the process attaching prevention */
#if defined(HAVE_SYS_PRCTL_H) && defined(__linux__)
#include <sys/prctl.h> 
#elif defined(__APPLE__)
#include <sys/types.h>
#include <sys/ptrace.h>
#endif

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

85
/** An abbreviation for a configuration option allowed on the command line. */
86
typedef struct config_abbrev_t {
87
88
  const char *abbreviated;
  const char *full;
89
  int commandline_only;
90
  int warn;
91
92
} config_abbrev_t;

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

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

/** A list of state-file "abbreviations," for compatibility. */
140
static config_abbrev_t _state_abbrevs[] = {
141
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
142
143
144
145
146
147
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
148
  { NULL, NULL, 0, 0},
149
};
150
#undef PLURAL
151

152
/** A variable allowed in the configuration file or on the command line. */
153
typedef struct config_var_t {
154
  const char *name; /**< The full keyword (case insensitive). */
155
156
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
157
158
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
159
160
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
161
162
163
164
/** 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>"
 */
165
166
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
167
      initvalue }
168
169
170
/** 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
171
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
172
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
173

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

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

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

448
449
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
450
static const config_var_t testing_tor_network_defaults[] = {
451
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
452
453
454
455
456
457
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
458
  V(ClientRejectInternalAddresses, BOOL,   "0"),
459
  V(CountPrivateBandwidth,       BOOL,     "1"),
460
461
462
463
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
464
465
466
467
468
  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"),
469
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
470
  V(_UsingTestNetworkDefaults,   BOOL,     "1"),
471

472
473
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
474
475
#undef VAR

476
477
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
478
      initvalue }
479
480

/** Array of "state" variables saved to the ~/.tor/state file. */
481
static config_var_t _state_vars[] = {
482
483
484
485
486
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
487
488
489
  V(AccountingSecondsToReachSoftLimit,INTERVAL, NULL),
  V(AccountingSoftLimitHitAt,         ISOTIME,  NULL),
  V(AccountingBytesAtSoftLimit,       MEMUNIT,  NULL),
Roger Dingledine's avatar
Roger Dingledine committed
490

491
492
493
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
494
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
495
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
496

497
498
499
  VAR("TransportProxy",               LINELIST_S, TransportProxies, NULL),
  V(TransportProxies,                 LINELIST_V, NULL),

500
501
502
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
503
  V(BWHistoryReadMaxima,              CSV,      ""),
504
505
506
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
507
  V(BWHistoryWriteMaxima,             CSV,      ""),
508
509
510
  V(BWHistoryDirReadEnds,             ISOTIME,  NULL),
  V(BWHistoryDirReadInterval,         UINT,     "900"),
  V(BWHistoryDirReadValues,           CSV,      ""),
511
  V(BWHistoryDirReadMaxima,           CSV,      ""),
512
513
514
  V(BWHistoryDirWriteEnds,            ISOTIME,  NULL),
  V(BWHistoryDirWriteInterval,        UINT,     "900"),
  V(BWHistoryDirWriteValues,          CSV,      ""),
515
  V(BWHistoryDirWriteMaxima,          CSV,      ""),
516

517
  V(TorVersion,                       STRING,   NULL),
518

519
520
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
521

522
  V(TotalBuildTimes,                  UINT,     NULL),
523
  V(CircuitBuildAbandonedCount,       UINT,     "0"),
524
525
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
526
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
527
528
};

529
#undef VAR
530
#undef V
531
532
#undef OBSOLETE

533
534
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
535
536
537
538
539
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

540
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
541
 * well-formed and consistent. See options_trial_assign() for documentation
542
 * of arguments. */
543
typedef int (*validate_fn_t)(void*,void*,int,char**);
544

545
546
547
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
548
typedef struct {
549
550
551
  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
552
  off_t magic_offset; /**< Offset of the magic value within the struct. */
553
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
554
                             * parsing this format. */
555
556
557
  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
558
559
560
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
561
562
} config_format_t;

563
564
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
565
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
566
    tor_assert(fmt && cfg);                                             \
567
    tor_assert((fmt)->magic ==                                          \
568
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
569
  STMT_END
570

571
572
573
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
574
static void config_line_append(config_line_t **lst,
575
                               const char *key, const char *val);
576
577
578
579
580
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);
581
static int config_lines_eq(config_line_t *a, config_line_t *b);
582
583
static int option_is_same(const config_format_t *fmt,
                          const or_options_t *o1, const or_options_t *o2,
584
                          const char *name);
585
586
587
588
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,
589
                            int from_setconf, char **msg);
590
591
592
593
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,
594
                                      char **msg);
595
596
597
598
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);
599
static int check_nickname_list(const char *lst, const char *name, char **msg);
600

601
static int parse_bridge_line(const char *line, int validate_only);
George Kadianakis's avatar
George Kadianakis committed
602
static int parse_client_transport_line(const char *line, int validate_only);
603
604

static int parse_server_transport_line(const char *line, int validate_only);
605
static int parse_dir_server_line(const char *line,
606
                                 dirinfo_type_t required_type,
607
                                 int validate_only);
608
static void port_cfg_free(port_cfg_t *port);
609
610
static int parse_client_ports(const or_options_t *options, int validate_only,
                              char **msg_out, int *n_ports_out);
611
static int validate_data_directory(or_options_t *options);
612
613
614
615
616
617
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);
618
static int or_state_validate(or_state_t *old_options, or_state_t *options,
619
                             int from_setconf, char **msg);
620
621
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
622

623
static int is_listening_on_low_port(int port_option,
624
625
                                    const config_line_t *listen_options);

626
static uint64_t config_parse_memunit(const char *s, int *ok);
627
static int config_parse_msec_interval(const char *s, int *ok);
628
static int config_parse_interval(const char *s, int *ok);
629
static void init_libevent(const or_options_t *options);
630
static int opt_streq(const char *s1, const char *s2);
631

632
/** Magic value for or_options_t. */
633
634
#define OR_OPTIONS_MAGIC 9090909

635
/** Configuration format for or_options_t. */
636
static config_format_t options_format = {
637
638
639
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
640
641
642
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
643
  NULL
644
645
};

646
/** Magic value for or_state_t. */
647
648
#define OR_STATE_MAGIC 0x57A73f57

649
650
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
651
652
653
654
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

655
/** Configuration format for or_state_t. */
656
static const config_format_t state_format = {
657
658
659
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
660
  _state_abbrevs,
661
662
  _state_vars,
  (validate_fn_t)or_state_validate,
663
  &state_extra_var,
664
665
};

666
667
668
669
670
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
671
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
672
/** Name of most recently read torrc file. */
673
static char *torrc_fname = NULL;
674
/** Persistent serialized state. */
675
static or_state_t *global_state = NULL;
676
677
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
678
/** Contents of most recently read DirPortFrontPage file. */
679
static char *global_dirfrontpagecontents = NULL;
680
681
/** List of port_cfg_t for client-level (SOCKS, DNS, Trans, NATD) ports. */
static smartlist_t *configured_client_ports = NULL;
682
683
684
685
686
687
688

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

690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
/* We only use the linux prctl for now. There is no Win32 support; this may
 * also work on various BSD systems and Mac OS X - send testing feedback!
 * 
 * On recent Gnu/Linux kernels it is possible to create a system-wide policy
 * that will prevent non-root processes from attaching to other processes
 * unless they are the parent process; thus gdb can attach to programs that
 * they execute but they cannot attach to other processes running as the same
 * user. The system wide policy may be set with the sysctl
 * kernel.yama.ptrace_scope or by inspecting /proc/sys/kernel/yama/ptrace_scope
 * and it is 1 by default on Ubuntu 11.04.
 *
 * This ptrace scope will be ignored on Gnu/Linux for users with
 * CAP_SYS_PTRACE and so it is very likely that root will still be able to
 * attach to the Tor process.
*/
/** Attempt to disable debugger attachment. */
static int tor_disable_debugger_attach(void) {
    int r;
    r = -1;
    log_debug(LD_CONFIG,
    "Attemping to disable debugger attachment to Tor for unprivileged users.");
#if defined(__linux__) && defined(HAVE_SYS_PRCTL_H) && defined(HAVE_PRCTL)
#ifdef PR_SET_DUMPABLE
    r = prctl(PR_SET_DUMPABLE, 0);
#endif
#endif
#if defined(__APPLE__) && defined(PT_DENY_ATTACH)
    r = ptrace(PT_DENY_ATTACH, 0, 0, 0);
#endif

// XXX: TODO - Mac OS X has dtrace and this may be disabled - implement it here
// XXX: TODO - Windows probably has something similar - implement it here
    if (r == 0) {
      log_debug(LD_CONFIG,"Debugger attachment disabled for unprivileged users.");
    } else {
      log_warn(LD_CONFIG, "Unable to disable ptrace attach: %s",
                          strerror(errno));
    }
    return r;
}

731
/** Allocate an empty configuration object of a given format type. */
732
static void *
733
config_alloc(const config_format_t *fmt)
734
{
735
  void *opts = tor_malloc_zero(fmt->size);
736
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
737
738
739
740
  CHECK(fmt, opts);
  return opts;
}

741
742
/** Return the currently configured options. */
or_options_t *
743
get_options_mutable(void)
744
{
745
746
747
  tor_assert(global_options);
  return global_options;
}
748

749
750
751
752
753
754
755
/** Returns the currently configured options */
const or_options_t *
get_options(void)
{
  return get_options_mutable();
}

756
757
/** 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
758
 * as necessary.  Returns 0 on success, -1 on failure.
759
 */
760
int
761
set_options(or_options_t *new_val, char **msg)
762
{
763
764
765
  int i;
  smartlist_t *elements;
  config_line_t *line;
766
  or_options_t *old_options = global_options;
767
  global_options = new_val;
768
769
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
770
771
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
772
773
774
    global_options = old_options;
    return -1;
  }
775
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
776
    log_err(LD_BUG,