config.c 169 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright (c) 2001 Matej Pfajfar.
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2010, The Tor Project, Inc. */
5
/* See LICENSE for licensing information */
6

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
9
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
10
11
 **/

12
13
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
15
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
16
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
17
#include "router.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
18
#include "routerlist.h"
19
20
21
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
22

Nick Mathewson's avatar
Nick Mathewson committed
23
24
/** Enumeration of types which option values can take */
typedef enum config_type_t {
25
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
26
  CONFIG_TYPE_FILENAME,     /**< A filename: some prefixes get expanded. */
27
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
28
29
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
30
31
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
Nick Mathewson's avatar
Nick Mathewson committed
32
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formatted time relative to GMT. */
33
34
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
35
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
36
37
38
39
40
  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.
                             */
41
42
  CONFIG_TYPE_ROUTERSET,    /**< A list of router names, addrs, and fps,
                             * parsed into a routerset_t. */
43
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
44
} config_type_t;
45

46
/** An abbreviation for a configuration option allowed on the command line. */
47
typedef struct config_abbrev_t {
48
49
  const char *abbreviated;
  const char *full;
50
  int commandline_only;
51
  int warn;
52
53
} config_abbrev_t;

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

58
59
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
60
static config_abbrev_t _option_abbrevs[] = {
61
  PLURAL(ExitNode),
62
  PLURAL(EntryNode),
63
64
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
65
  PLURAL(LongLivedPort),
66
67
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
68
  PLURAL(NumCpu),
69
70
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
71
72
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
73
  PLURAL(StrictNode),
74
  { "l", "Log", 1, 0},
75
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
76
77
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
78
79
80
81
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
82
83
84
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
85
86
87
88
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
89
90
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
91
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
92
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
93
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
94
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
95
96
  { "StrictEntryNodes", "StrictNodes", 0, 1},
  { "StrictExitNodes", "StrictNodes", 0, 1},
97
98
  { NULL, NULL, 0, 0},
};
99
100

/** A list of state-file "abbreviations," for compatibility. */
101
static config_abbrev_t _state_abbrevs[] = {
102
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
103
104
105
106
107
108
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
109
  { NULL, NULL, 0, 0},
110
};
111
#undef PLURAL
112

113
/** A variable allowed in the configuration file or on the command line. */
114
typedef struct config_var_t {
115
  const char *name; /**< The full keyword (case insensitive). */
116
117
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
118
119
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
120
121
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
122
123
124
125
/** 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>"
 */
126
127
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
128
      initvalue }
129
130
131
/** 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
132
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
133
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
134

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

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

376
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
377
};
378

379
380
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
381
static config_var_t testing_tor_network_defaults[] = {
382
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
383
384
385
386
387
388
389
390
391
392
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "0"),
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
393
394
395
396
397
  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"),
398
399
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
400
401
#undef VAR

402
403
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
404
      initvalue }
405
406

/** Array of "state" variables saved to the ~/.tor/state file. */
407
static config_var_t _state_vars[] = {
408
409
410
411
412
  V(AccountingBytesReadInInterval,    MEMUNIT,  NULL),
  V(AccountingBytesWrittenInInterval, MEMUNIT,  NULL),
  V(AccountingExpectedUsage,          MEMUNIT,  NULL),
  V(AccountingIntervalStart,          ISOTIME,  NULL),
  V(AccountingSecondsActive,          INTERVAL, NULL),
Roger Dingledine's avatar
Roger Dingledine committed
413

414
415
416
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
417
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
418
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
419

420
421
422
423
424
425
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
426

427
  V(TorVersion,                       STRING,   NULL),
428

429
430
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
431

432
  V(TotalBuildTimes,                  UINT,     NULL),
433
  V(CircuitBuildAbandonedCount,         UINT,     "0"),
434
435
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
436

437
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
438
439
};

440
#undef VAR
441
#undef V
442
443
#undef OBSOLETE

444
445
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
446
447
448
449
450
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

451
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
452
 * well-formed and consistent. See options_trial_assign() for documentation
453
 * of arguments. */
454
typedef int (*validate_fn_t)(void*,void*,int,char**);
455

456
457
458
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
459
typedef struct {
460
461
462
  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
463
  off_t magic_offset; /**< Offset of the magic value within the struct. */
464
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
465
                             * parsing this format. */
466
467
468
  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
469
470
471
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
472
473
} config_format_t;

474
475
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
476
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
477
    tor_assert(fmt && cfg);                                             \
478
    tor_assert((fmt)->magic ==                                          \
479
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
480
  STMT_END
481

482
483
484
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
485
static void config_line_append(config_line_t **lst,
486
                               const char *key, const char *val);
487
488
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
489
static void option_reset(config_format_t *fmt, or_options_t *options,
490
                         config_var_t *var, int use_defaults);
491
static void config_free(config_format_t *fmt, void *options);
492
static int config_lines_eq(config_line_t *a, config_line_t *b);
493
static int option_is_same(config_format_t *fmt,
494
495
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
496
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
497
498
499
static int options_validate(or_options_t *old_options, or_options_t *options,
                            int from_setconf, char **msg);
static int options_act_reversible(or_options_t *old_options, char **msg);
500
static int options_act(or_options_t *old_options);
501
502
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
503
504
505
506
static int options_transition_affects_workers(or_options_t *old_options,
                                              or_options_t *new_options);
static int options_transition_affects_descriptor(or_options_t *old_options,
                                                 or_options_t *new_options);
507
static int check_nickname_list(const char *lst, const char *name, char **msg);
508
static void config_register_addressmaps(or_options_t *options);
509

510
static int parse_bridge_line(const char *line, int validate_only);
511
512
513
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
514
static int validate_data_directory(or_options_t *options);
515
static int write_configuration_file(const char *fname, or_options_t *options);
516
static config_line_t *get_assigned_option(config_format_t *fmt,
517
518
                                          void *options, const char *key,
                                          int escape_val);
519
static void config_init(config_format_t *fmt, void *options);
520
static int or_state_validate(or_state_t *old_options, or_state_t *options,
521
                             int from_setconf, char **msg);
522
523
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
524

525
526
527
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

528
529
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
530
static void init_libevent(void);
531
static int opt_streq(const char *s1, const char *s2);
532

533
/** Magic value for or_options_t. */
534
535
#define OR_OPTIONS_MAGIC 9090909

536
/** Configuration format for or_options_t. */
537
static config_format_t options_format = {
538
539
540
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
541
542
543
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
544
  NULL
545
546
};

547
/** Magic value for or_state_t. */
548
549
#define OR_STATE_MAGIC 0x57A73f57

550
551
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
552
553
554
555
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

556
/** Configuration format for or_state_t. */
557
558
559
560
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
561
  _state_abbrevs,
562
563
  _state_vars,
  (validate_fn_t)or_state_validate,
564
  &state_extra_var,
565
566
};

567
568
569
570
571
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
572
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
573
/** Name of most recently read torrc file. */
574
static char *torrc_fname = NULL;
575
/** Persistent serialized state. */
576
static or_state_t *global_state = NULL;
577
578
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
579
/** Contents of most recently read DirPortFrontPage file. */
580
581
582
583
584
585
586
587
static char *global_dirfrontpagecontents = NULL;

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

589
/** Allocate an empty configuration object of a given format type. */
590
591
592
static void *
config_alloc(config_format_t *fmt)
{
593
  void *opts = tor_malloc_zero(fmt->size);
594
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
595
596
597
598
  CHECK(fmt, opts);
  return opts;
}

599
600
/** Return the currently configured options. */
or_options_t *
601
602
get_options(void)
{
603
604
605
  tor_assert(global_options);
  return global_options;
}
606

607
608
/** 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
609
 * as necessary.  Returns 0 on success, -1 on failure.
610
 */
611
int
612
set_options(or_options_t *new_val, char **msg)
613
{
614
  or_options_t *old_options = global_options;
615
  global_options = new_val;
616
617
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
618
619
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
620
621
622
    global_options = old_options;
    return -1;
  }
623
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
624
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
625
            "Acting on config options left us in a broken state. Dying.");
626
627
    exit(1);
  }
628
629

  config_free(&options_format, old_options);
630
631

  return 0;
632
633
}

634
extern const char tor_git_revision[]; /* from tor_main.c */
635

636
/** The version of this Tor process, as parsed. */
637
638
static char *_version = NULL;

639
/** Return the current Tor version. */
640
641
642
const char *
get_version(void)
{
643
  if (_version == NULL) {
644
645
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
646
      _version = tor_malloc(len);
647
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
648
    } else {
649
      _version = tor_strdup(VERSION);
650
651
    }
  }
652
  return _version;
653
654
}

655
656
657
658
659
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
660
661
662
  if (!options)
    return;

663
  routerset_free(options->_ExcludeExitNodesUnion);
664
665
666
  config_free(&options_format, options);
}

667
668
/** Release all memory and resources held by global configuration structures.
 */
669
670
671
void
config_free_all(void)
{
672
673
674
675
676
677
678
679
680
  or_options_free(global_options);
  global_options = NULL;

  config_free(&state_format, global_state);
  global_state = NULL;

  config_free_lines(global_cmdline_options);
  global_cmdline_options = NULL;

681
  tor_free(torrc_fname);
682
  tor_free(_version);
683
  tor_free(global_dirfrontpagecontents);
684
685
}

686
687
688
689
690
/** Make <b>address</b> -- a piece of information related to our operation as
 * a client -- safe to log according to the settings in options->SafeLogging,
 * and return it.
 *
 * (We return "[scrubbed]" if SafeLogging is "1", and address otherwise.)
691
692
 */
const char *
693
safe_str_client(const char *address)
694
{
695
  tor_assert(address);
696
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
697
698
699
700
701
    return "[scrubbed]";
  else
    return address;
}

702
703
704
705
706
707
/** Make <b>address</b> -- a piece of information of unspecified sensitivity
 * -- safe to log according to the settings in options->SafeLogging, and
 * return it.
 *
 * (We return "[scrubbed]" if SafeLogging is anything besides "0", and address
 * otherwise.)
708
709
 */
const char *
710
711
safe_str(const char *address)
{
712
  tor_assert(address);
713
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
714
715
716
717
718
    return "[scrubbed]";
  else
    return address;
}

719
/** Equivalent to escaped(safe_str_client(address)).  See reentrancy note on
720
721
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
722
const char *
723
escaped_safe_str_client(const char *address)
724
{
725
  if (get_options()->_SafeLogging == SAFELOG_SCRUB_ALL)
726
727
728
729
730
    return "[scrubbed]";
  else
    return escaped(address);
}

731
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
732
733
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
734
735
736
const char *
escaped_safe_str(const char *address)
{
737
  if (get_options()->_SafeLogging != SAFELOG_SCRUB_NONE)
738
739
740
741
742
    return "[scrubbed]";
  else
    return escaped(address);
}

743
744
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
745
static void
746
add_default_trusted_dir_authorities(authority_type_t type)
747
{
748
  int i;
749
  const char *dirservers[] = {
750
751
752
    "moria1 orport=9101 no-v2 "
      "v3ident=D586D18309DED4CD6D57C18FDB97EFA96D330566 "
      "128.31.0.39:9131 9695 DFC3 5FFE B861 329B 9F1A B04C 4639 7020 CE31",
753
    "tor26 v1 orport=443 v3ident=14C131DFC5C6F93646BE72FA1401C02A8DF2E8B4 "
Peter Palfrader's avatar
Peter Palfrader committed
754
      "86.59.21.38:80 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
Roger Dingledine's avatar
Roger Dingledine committed
755
756
    "dizum orport=443 v3ident=E8A9C45EDE6D711294FADF8E7951F4DE6CA56B58 "
      "194.109.206.212:80 7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
757
    "Tonga orport=443 bridge no-v2 82.94.251.203:80 "
758
      "4A0C CD2D DC79 9508 3D73 F5D6 6710 0C8A 5831 F16D",
759
760
    "ides orport=9090 no-v2 v3ident=27B6B5996C426270A5C95488AA5BCEB6BCC86956 "
      "216.224.124.114:9030 F397 038A DC51 3361 35E7 B80B D99C A384 4360 292B",
761
762
763
    "gabelmoo orport=8080 no-v2 "
      "v3ident=ED03BB616EB2F60BEC80151114BB25CEF515B226 "
      "80.190.246.100:8180 F204 4413 DAC2 E02E 3D6B CF47 35A1 9BCA 1DE9 7281",
764
765
    "dannenberg orport=443 no-v2 "
      "v3ident=585769C78764D58426B8B52B6651A5A71137189A "
766
      "193.23.244.244:80 7BE6 83E6 5D48 1413 21C5 ED92 F075 C553 64AC 7123",
767
768
    "urras orport=80 no-v2 v3ident=80550987E1D626E3EBA5E5E75A458DE0626D088C "
      "208.83.223.34:443 0AD3 FA88 4D18 F89E EA2D 89C0 1937 9E0E 7FD9 4417",
769
770
771
    "maatuska orport=80 no-v2 "
      "v3ident=49015F787433103580E3B66A1707A00E60F2D15B "
      "213.115.239.118:443 BD6A 8292 55CB 08E6 6FBE 7D37 4836 3586 E46B 3810",
772
    NULL
773
  };
774
775
776
777
778
779
  for (i=0; dirservers[i]; i++) {
    if (parse_dir_server_line(dirservers[i], type, 0)<0) {
      log_err(LD_BUG, "Couldn't parse internal dirserver line %s",
              dirservers[i]);
    }
  }
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
}

/** Look at all the config options for using alternate directory
 * authorities, and make sure none of them are broken. Also, warn the
 * user if we changed any dangerous ones.
 */
static int
validate_dir_authorities(or_options_t *options, or_options_t *old_options)
{
  config_line_t *cl;

  if (options->DirServers &&
      (options->AlternateDirAuthority || options->AlternateBridgeAuthority ||
       options->AlternateHSAuthority)) {
    log_warn(LD_CONFIG,
             "You cannot set both DirServers and Alternate*Authority.");
    return -1;
  }

  /* do we want to complain to the user about being partitionable? */
  if ((options->DirServers &&
       (!old_options ||
        !config_lines_eq(options->DirServers, old_options->DirServers))) ||
      (options->AlternateDirAuthority &&
       (!old_options ||
        !config_lines_eq(options->AlternateDirAuthority,
                         old_options->AlternateDirAuthority)))) {
    log_warn(LD_CONFIG,
             "You have used DirServer or AlternateDirAuthority to "
             "specify alternate directory authorities in "
             "your configuration. This is potentially dangerous: it can "
             "make you look different from all other Tor users, and hurt "
             "your anonymity. Even if you've specified the same "
             "authorities as Tor uses by default, the defaults could "
             "change in the future. Be sure you know what you're doing.");
  }

  /* Now go through the four ways you can configure an alternate
   * set of directory authorities, and make sure none are broken. */
  for (cl = options->DirServers; cl; cl = cl->next)
820
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
821
822
      return -1;
  for (cl = options->AlternateBridgeAuthority; cl; cl = cl->next)
823
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
824
825
      return -1;
  for (cl = options->AlternateDirAuthority; cl; cl = cl->next)
826
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
827
828
      return -1;
  for (cl = options->AlternateHSAuthority; cl; cl = cl->next)
829
    if (parse_dir_server_line(cl->value, NO_AUTHORITY, 1)<0)
830
831
832
833
834
835
836
837
838
839
840
841
842
      return -1;
  return 0;
}

/** Look at all the config options and assign new dir authorities
 * as appropriate.
 */
static int
consider_adding_dir_authorities(or_options_t *options,
                                or_options_t *old_options)
{
  config_line_t *cl;
  int need_to_update =
843
    !smartlist_len(router_get_trusted_dir_servers()) || !old_options ||