config.c 180 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.
Roger Dingledine's avatar
Roger Dingledine committed
4
 * Copyright (c) 2007-2008, The Tor Project, Inc. */
5
6
/* See LICENSE for licensing information */
/* $Id$ */
7
8
const char config_c_id[] = \
  "$Id$";
9

Nick Mathewson's avatar
Nick Mathewson committed
10
/**
11
12
 * \file config.c
 * \brief Code to parse and interpret configuration files.
Nick Mathewson's avatar
Nick Mathewson committed
13
14
 **/

15
16
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
17
#include "or.h"
18
19
20
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
21

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

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

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

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

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
131
132
133
134
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
135
static config_var_t _option_vars[] = {
136
  OBSOLETE("AccountingMaxKB"),
137
138
139
140
141
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
  V(AllowInvalidNodes,           CSV,      "middle,rendezvous"),
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
142
143
  V(AllowSingleHopCircuits,      BOOL,     "0"),
  V(AllowSingleHopExits,         BOOL,     "0"),
144
145
146
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
  V(AlternateHSAuthority,        LINELIST, NULL),
147
  V(AssumeReachable,             BOOL,     "0"),
148
  V(AuthDirBadDir,               LINELIST, NULL),
149
150
151
152
  V(AuthDirBadExit,              LINELIST, NULL),
  V(AuthDirInvalid,              LINELIST, NULL),
  V(AuthDirReject,               LINELIST, NULL),
  V(AuthDirRejectUnlisted,       BOOL,     "0"),
153
  V(AuthDirListBadDirs,          BOOL,     "0"),
154
  V(AuthDirListBadExits,         BOOL,     "0"),
155
156
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
  V(AuthDirMaxServersPerAuthAddr,UINT,     "5"),
157
158
159
160
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
161
162
  V(BandwidthBurst,              MEMUNIT,  "10 MB"),
  V(BandwidthRate,               MEMUNIT,  "5 MB"),
163
164
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
165
  V(BridgePassword,              STRING,   NULL),
166
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
167
  V(BridgeRelay,                 BOOL,     "0"),
168
169
170
171
172
173
174
175
176
177
178
179
180
181
  V(CircuitBuildTimeout,         INTERVAL, "1 minute"),
  V(CircuitIdleTimeout,          INTERVAL, "1 hour"),
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
  V(ClientOnly,                  BOOL,     "0"),
  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),
182
  V(DataDirectory,               FILENAME, NULL),
183
  OBSOLETE("DebugLogFile"),
184
  V(DirAllowPrivateAddresses,    BOOL,     NULL),
185
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
186
  V(DirListenAddress,            LINELIST, NULL),
187
  OBSOLETE("DirFetchPeriod"),
188
189
  V(DirPolicy,                   LINELIST, NULL),
  V(DirPort,                     UINT,     "0"),
190
  V(DirPortFrontPage,            FILENAME, NULL),
191
  OBSOLETE("DirPostPeriod"),
192
193
#ifdef ENABLE_GEOIP_STATS
  V(DirRecordUsageByCountry,     BOOL,     "0"),
194
195
196
  V(DirRecordUsageGranularity,   UINT,     "4"),
  V(DirRecordUsageRetainIPs,     INTERVAL, "14 days"),
  V(DirRecordUsageSaveInterval,  INTERVAL, "6 hours"),
197
#endif
198
199
200
201
202
  VAR("DirServer",               LINELIST, DirServers, NULL),
  V(DNSPort,                     UINT,     "0"),
  V(DNSListenAddress,            LINELIST, NULL),
  V(DownloadExtraInfo,           BOOL,     "0"),
  V(EnforceDistinctSubnets,      BOOL,     "1"),
203
  V(EntryNodes,                  ROUTERSET,   NULL),
204
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
205
206
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
207
  V(ExcludeSingleHopRelays,      BOOL,     "1"),
208
  V(ExitNodes,                   ROUTERSET, NULL),
209
210
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
211
  V(FallbackNetworkstatusFile,   FILENAME,
212
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "fallback-consensus"),
213
214
215
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
  V(FastFirstHopPK,              BOOL,     "1"),
216
  V(FetchDirInfoEarly,           BOOL,     "0"),
217
218
219
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
220
#ifdef WIN32
221
  V(GeoIPFile,                   FILENAME, "<default>"),
222
#else
223
224
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
225
#endif
226
  OBSOLETE("Group"),
227
  V(HardwareAccel,               BOOL,     "0"),
228
  V(HashedControlPassword,       LINELIST, NULL),
229
  V(HidServDirectoryV2,          BOOL,     "1"),
Nick Mathewson's avatar
Nick Mathewson committed
230
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
231
232
  OBSOLETE("HiddenServiceExcludeNodes"),
  OBSOLETE("HiddenServiceNodes"),
Nick Mathewson's avatar
Nick Mathewson committed
233
234
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
235
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
236
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
237
  V(HidServAuth,                 LINELIST, NULL),
238
239
240
241
242
243
  V(HSAuthoritativeDir,          BOOL,     "0"),
  V(HSAuthorityRecordStats,      BOOL,     "0"),
  V(HttpProxy,                   STRING,   NULL),
  V(HttpProxyAuthenticator,      STRING,   NULL),
  V(HttpsProxy,                  STRING,   NULL),
  V(HttpsProxyAuthenticator,     STRING,   NULL),
244
  OBSOLETE("IgnoreVersion"),
245
246
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
  VAR("Log",                     LINELIST, Logs,             NULL),
247
  OBSOLETE("LinkPadding"),
248
249
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
250
  V(LongLivedPorts,              CSV,
251
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
252
253
254
255
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
  V(MaxOnionsPending,            UINT,     "100"),
256
  OBSOLETE("MonthlyAccountingStart"),
257
258
  V(MyFamily,                    STRING,   NULL),
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
259
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
260
261
262
263
264
265
266
267
268
269
  V(NatdListenAddress,           LINELIST, NULL),
  V(NatdPort,                    UINT,     "0"),
  V(Nickname,                    STRING,   NULL),
  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),
270
  OBSOLETE("PathlenCoinWeight"),
271
  V(PidFile,                     STRING,   NULL),
272
  V(TestingTorNetwork,           BOOL,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
273
  V(PreferTunneledDirConns,      BOOL,     "1"),
274
  V(ProtocolWarnings,            BOOL,     "0"),
275
  V(PublishServerDescriptor,     CSV,      "1"),
276
277
278
279
280
281
282
  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),
283
  OBSOLETE("RedirectExit"),
284
  V(RejectPlaintextPorts,        CSV,      ""),
285
286
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
287
288
  OBSOLETE("RendExcludeNodes"),
  OBSOLETE("RendNodes"),
289
290
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
291
  OBSOLETE("RouterFile"),
292
293
294
295
  V(RunAsDaemon,                 BOOL,     "0"),
  V(RunTesting,                  BOOL,     "0"),
  V(SafeLogging,                 BOOL,     "1"),
  V(SafeSocks,                   BOOL,     "0"),
296
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
297
298
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
299
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
300
301
302
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
303
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
304
305
306
307
308
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
  V(SocksListenAddress,          LINELIST, NULL),
  V(SocksPolicy,                 LINELIST, NULL),
  V(SocksPort,                   UINT,     "9050"),
  V(SocksTimeout,                INTERVAL, "2 minutes"),
309
  OBSOLETE("StatusFetchPeriod"),
310
311
  V(StrictEntryNodes,            BOOL,     "0"),
  V(StrictExitNodes,             BOOL,     "0"),
312
  OBSOLETE("SysLog"),
313
  V(TestSocks,                   BOOL,     "0"),
314
  OBSOLETE("TestVia"),
315
316
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
317
  OBSOLETE("TrafficShaping"),
318
319
  V(TransListenAddress,          LINELIST, NULL),
  V(TransPort,                   UINT,     "0"),
Roger Dingledine's avatar
Roger Dingledine committed
320
  V(TunnelDirConns,              BOOL,     "1"),
321
322
323
324
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
  V(UseBridges,                  BOOL,     "0"),
  V(UseEntryGuards,              BOOL,     "1"),
  V(User,                        STRING,   NULL),
325
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
326
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
327
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
328
329
330
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
331
332
333
334
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
335
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
336
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
337
  V(VirtualAddrNetwork,          STRING,   "127.192.0.0/10"),
338
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
339
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
340
341
342
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
343
344
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
345
  V(MinUptimeHidServDirectoryV2, INTERVAL, "24 hours"),
346
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
347
};
348

349
350
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
351
static config_var_t testing_tor_network_defaults[] = {
352
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
353
354
355
356
357
358
359
360
361
362
  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"),
363
364
365
366
367
  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"),
368
369
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
370
371
#undef VAR

372
373
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
374
      initvalue }
375
376

/** Array of "state" variables saved to the ~/.tor/state file. */
377
static config_var_t _state_vars[] = {
378
379
380
381
382
  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
383

384
385
386
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
387
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
388
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
389

390
391
392
393
394
395
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
396

397
  V(TorVersion,                       STRING,   NULL),
398

399
400
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
401

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

405
#undef VAR
406
#undef V
407
408
#undef OBSOLETE

409
410
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
411
412
413
414
415
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

416
417
418
/** Descriptions of the configuration options, to be displayed by online
 * option browsers */
/* XXXX022 did anybody want this? at all? If not, kill it.*/
419
static config_var_description_t options_description[] = {
420
  /* ==== general options */
421
422
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
423
424
425
426
  { "BandwidthRate", "A token bucket limits the average incoming bandwidth on "
    "this node to the specified number of bytes per second." },
  { "BandwidthBurst", "Limit the maximum token buffer size (also known as "
    "burst) to the given number of bytes." },
427
  { "ConnLimit", "Minimum number of simultaneous sockets we must have." },
428
429
430
431
432
  { "ConstrainedSockets", "Shrink tx and rx buffers for sockets to avoid "
    "system limits on vservers and related environments.  See man page for "
    "more information regarding this option." },
  { "ConstrainedSockSize", "Limit socket buffers to this size when "
    "ConstrainedSockets is enabled." },
433
434
435
  /*  ControlListenAddress */
  { "ControlPort", "If set, Tor will accept connections from the same machine "
    "(localhost only) on this port, and allow those connections to control "
Karsten Loesing's avatar
Karsten Loesing committed
436
    "the Tor process using the Tor Control Protocol (described in "
437
438
439
    "control-spec.txt).", },
  { "CookieAuthentication", "If this option is set to 1, don't allow any "
    "connections to the control port except when the connecting process "
440
    "can read a file that Tor creates in its data directory." },
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
  { "DataDirectory", "Store working data, state, keys, and caches here." },
  { "DirServer", "Tor only trusts directories signed with one of these "
    "servers' keys.  Used to override the standard list of directory "
    "authorities." },
  /* { "FastFirstHopPK", "" }, */
  /* FetchServerDescriptors, FetchHidServDescriptors,
   * FetchUselessDescriptors */
  { "HardwareAccel", "If set, Tor tries to use hardware crypto accelerators "
    "when it can." },
  /* HashedControlPassword */
  { "HTTPProxy", "Force Tor to make all HTTP directory requests through this "
    "host:port (or host:80 if port is not set)." },
  { "HTTPProxyAuthenticator", "A username:password pair to be used with "
    "HTTPProxy." },
  { "HTTPSProxy", "Force Tor to make all TLS (SSL) connectinos through this "
    "host:port (or host:80 if port is not set)." },
  { "HTTPSProxyAuthenticator", "A username:password pair to be used with "
    "HTTPSProxy." },
  { "KeepalivePeriod", "Send a padding cell every N seconds to keep firewalls "
    "from closing our connections while Tor is not in use." },
  { "Log", "Where to send logging messages.  Format is "
    "minSeverity[-maxSeverity] (stderr|stdout|syslog|file FILENAME)." },
  { "OutboundBindAddress", "Make all outbound connections originate from the "
464
    "provided IP address (only useful for multiple network interfaces)." },
465
466
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
467
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
468
    "don't support tunneled connections." },
469
  /* PreferTunneledDirConns */
470
471
472
473
474
475
  /* ProtocolWarnings */
  /* RephistTrackTime */
  { "RunAsDaemon", "If set, Tor forks and daemonizes to the background when "
    "started.  Unix only." },
  { "SafeLogging", "If set to 0, Tor logs potentially sensitive strings "
    "rather than replacing them with the string [scrubbed]." },
476
477
478
  { "TunnelDirConns", "If non-zero, when a directory server we contact "
    "supports it, we will build a one-hop circuit and make an encrypted "
    "connection via its ORPort." },
Karsten Loesing's avatar
Karsten Loesing committed
479
  { "User", "On startup, setuid to this user." },
480
481
482
483

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
484
485
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
486
487
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
488
    "server, even if ORPort is enabled." },
489
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
490
    "in circuits, when possible." },
491
492
493
494
495
  /* { "EnforceDistinctSubnets" , "" }, */
  { "ExitNodes", "A list of preferred nodes to use for the last hop in "
    "circuits, when possible." },
  { "ExcludeNodes", "A list of nodes never to use when building a circuit." },
  { "FascistFirewall", "If set, Tor will only create outgoing connections to "
496
497
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
498
499
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
500
    "high-uptime connections." },
501
502
503
  { "MapAddress", "Force Tor to treat all requests for one address as if "
    "they were for another." },
  { "NewCircuitPeriod", "Force Tor to consider whether to build a new circuit "
504
    "every NUM seconds." },
505
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
506
    "been used more than this many seconds ago." },
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
  /* NatdPort, NatdListenAddress */
  { "NodeFamily", "A list of servers that constitute a 'family' and should "
    "never be used in the same circuit." },
  { "NumEntryGuards", "How many entry guards should we keep at a time?" },
  /* PathlenCoinWeight */
  { "ReachableAddresses", "Addresses we can connect to, as IP/bits:port-port. "
    "By default, we assume all addresses are reachable." },
  /* reachablediraddresses, reachableoraddresses. */
  /* SafeSOCKS */
  { "SOCKSPort", "The port where we listen for SOCKS connections from "
    "applications." },
  { "SOCKSListenAddress", "Bind to this address to listen to connections from "
    "SOCKS-speaking applications." },
  { "SOCKSPolicy", "Set an entry policy to limit which addresses can connect "
    "to the SOCKSPort." },
  /* SocksTimeout */
  { "StrictExitNodes", "If set, Tor will fail to operate when none of the "
    "configured ExitNodes can be used." },
  { "StrictEntryNodes", "If set, Tor will fail to operate when none of the "
    "configured EntryNodes can be used." },
  /* TestSocks */
  { "TrackHostsExit", "Hosts and domains which should, if possible, be "
529
    "accessed from the same exit node each time we connect to them." },
530
531
532
533
  { "TrackHostsExitExpire", "Time after which we forget which exit we were "
    "using to connect to hosts in TrackHostsExit." },
  /* "TransPort", "TransListenAddress */
  { "UseEntryGuards", "Set to 0 if we want to pick from the whole set of "
534
535
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
536
537

  /* === server options */
538
  { "Address", "The advertised (external) address we should use." },
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
  /* Accounting* options. */
  /* AssumeReachable */
  { "ContactInfo", "Administrative contact information to advertise for this "
    "server." },
  { "ExitPolicy", "Address/port ranges for which to accept or reject outgoing "
    "connections on behalf of Tor users." },
  /*  { "ExitPolicyRejectPrivate, "" }, */
  { "MaxAdvertisedBandwidth", "If set, we will not advertise more than this "
    "amount of bandwidth for our bandwidth rate, regardless of how much "
    "bandwidth we actually detect." },
  { "MaxOnionsPending", "Reject new attempts to extend circuits when we "
    "already have this many pending." },
  { "MyFamily", "Declare a list of other servers as belonging to the same "
    "family as this one, so that clients will not use two from the same "
    "family in the same circuit." },
  { "Nickname", "Set the server nickname." },
555
  { "NoPublish", "{DEPRECATED}" },
556
557
558
559
560
  { "NumCPUs", "How many processes to use at once for public-key crypto." },
  { "ORPort", "Advertise this port to listen for connections from Tor clients "
    "and servers." },
  { "ORListenAddress", "Bind to this address to listen for connections from "
    "clients and servers, instead of the default 0.0.0.0:ORPort." },
561
  { "PublishServerDescriptor", "Set to 0 to keep the server from "
562
    "uploading info to the directory authorities." },
563
564
565
566
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },

567
  /* === directory cache options */
568
569
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
570
  { "DirPortFrontPage", "Serve a static html disclaimer on DirPort." },
571
  { "DirListenAddress", "Bind to this address to listen for connections from "
572
573
    "clients and servers, instead of the default 0.0.0.0:DirPort." },
  { "DirPolicy", "Set a policy to limit who can connect to the directory "
Karsten Loesing's avatar
Karsten Loesing committed
574
    "port." },
575
576
577
578
579
580
581
582
583
584
585
586

  /*  Authority options: AuthDirBadExit, AuthDirInvalid, AuthDirReject,
   * AuthDirRejectUnlisted, AuthDirListBadExits, AuthoritativeDirectory,
   * DirAllowPrivateAddresses, HSAuthoritativeDir,
   * NamingAuthoritativeDirectory, RecommendedVersions,
   * RecommendedClientVersions, RecommendedServerVersions, RendPostPeriod,
   * RunTesting, V1AuthoritativeDirectory, VersioningAuthoritativeDirectory, */

  /* Hidden service options: HiddenService: dir,excludenodes, nodes,
   * options, port.  PublishHidServDescriptor */

  /* Nonpersistent options: __LeaveStreamsUnattached, __AllDirActionsPrivate */
587
588
589
  { NULL, NULL },
};

590
/** Online description of state variables. */
591
static config_var_description_t state_description[] = {
592
  { "AccountingBytesReadInInterval",
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
    "How many bytes have we read in this accounting period?" },
  { "AccountingBytesWrittenInInterval",
    "How many bytes have we written in this accounting period?" },
  { "AccountingExpectedUsage",
    "How many bytes did we expect to use per minute? (0 for no estimate.)" },
  { "AccountingIntervalStart", "When did this accounting period begin?" },
  { "AccountingSecondsActive", "How long have we been awake in this period?" },

  { "BWHistoryReadEnds", "When does the last-recorded read-interval end?" },
  { "BWHistoryReadInterval", "How long is each read-interval (in seconds)?" },
  { "BWHistoryReadValues", "Number of bytes read in each interval." },
  { "BWHistoryWriteEnds", "When does the last-recorded write-interval end?" },
  { "BWHistoryWriteInterval", "How long is each write-interval (in seconds)?"},
  { "BWHistoryWriteValues", "Number of bytes written in each interval." },

608
609
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
610
    "The last entry guard has been unreachable since this time." },
611
  { "EntryGuardUnlistedSince",
612
    "The last entry guard has been unusable since this time." },
Roger Dingledine's avatar
Roger Dingledine committed
613

614
615
616
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
617
618
619
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
620
621
622
  { NULL, NULL },
};

623
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
624
 * well-formed and consistent. See options_trial_assign() for documentation
625
 * of arguments. */
626
typedef int (*validate_fn_t)(void*,void*,int,char**);
627

628
629
630
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
631
typedef struct {
632
633
634
  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
635
  off_t magic_offset; /**< Offset of the magic value within the struct. */
636
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
637
                             * parsing this format. */
638
639
640
641
  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. */
  /** Documentation for configuration variables. */
642
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
643
644
645
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
646
647
} config_format_t;

648
649
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
650
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
651
    tor_assert(fmt && cfg);                                             \
652
    tor_assert((fmt)->magic ==                                          \
653
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
654
  STMT_END
655

656
657
658
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
659
static void config_line_append(config_line_t **lst,
660
                               const char *key, const char *val);
661
662
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
663
static void option_reset(config_format_t *fmt, or_options_t *options,
664
                         config_var_t *var, int use_defaults);
665
static void config_free(config_format_t *fmt, void *options);
666
static int config_lines_eq(config_line_t *a, config_line_t *b);
667
static int option_is_same(config_format_t *fmt,
668
669
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
670
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
671
672
673
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);
674
static int options_act(or_options_t *old_options);
675
676
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
677
678
679
680
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);
681
static int check_nickname_list(const char *lst, const char *name, char **msg);
682
static void config_register_addressmaps(or_options_t *options);
683

684
static int parse_bridge_line(const char *line, int validate_only);
685
686
687
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
688
static int validate_data_directory(or_options_t *options);
689
static int write_configuration_file(const char *fname, or_options_t *options);
690
static config_line_t *get_assigned_option(config_format_t *fmt,
691
692
                                      or_options_t *options, const char *key,
                                      int escape_val);
693
static void config_init(config_format_t *fmt, void *options);
694
static int or_state_validate(or_state_t *old_options, or_state_t *options,
695
                             int from_setconf, char **msg);
696
697
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
698

699
700
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
701
static void print_svn_version(void);
702
static void init_libevent(void);
703
static int opt_streq(const char *s1, const char *s2);
704
/** Versions of libevent. */
705
typedef enum {
706
707
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
708
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
709
  LE_13, LE_13A, LE_13B, LE_13C, LE_13D,
710
  LE_OTHER
711
712
} le_version_t;
static le_version_t decode_libevent_version(void);
713
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
714
static void check_libevent_version(const char *m, int server);
715
#endif
716

717
/** Magic value for or_options_t. */
718
719
#define OR_OPTIONS_MAGIC 9090909

720
/** Configuration format for or_options_t. */
721
static config_format_t options_format = {
722
723
724
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
725
726
727
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
728
729
  options_description,
  NULL
730
731
};

732
/** Magic value for or_state_t. */
733
734
#define OR_STATE_MAGIC 0x57A73f57

735
736
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
737
738
739
740
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

741
/** Configuration format for or_state_t. */
742
743
744
745
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
746
  _state_abbrevs,
747
748
  _state_vars,
  (validate_fn_t)or_state_validate,
749
750
  state_description,
  &state_extra_var,
751
752
};

753
754
755
756
757
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
758
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
759
/** Name of most recently read torrc file. */
760
static char *torrc_fname = NULL;
761
/** Persistent serialized state. */
762
static or_state_t *global_state = NULL;
763
764
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
765
/** Contents of most recently read DirPortFrontPage file. */
766
767
768
769
770
771
772
773
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;
}
774

775
/** Allocate an empty configuration object of a given format type. */
776
777
778
static void *
config_alloc(config_format_t *fmt)
{
779
  void *opts = tor_malloc_zero(fmt->size);
780
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
781
782
783
784
  CHECK(fmt, opts);
  return opts;
}

785
786
/** Return the currently configured options. */
or_options_t *
787
788
get_options(void)
{
789
790
791
  tor_assert(global_options);
  return global_options;
}
792

793
794
/** 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
795
 * as necessary.  Returns 0 on success, -1 on failure.
796
 */
797
int
798
set_options(or_options_t *new_val, char **msg)
799
{
800
  or_options_t *old_options = global_options;
801
  global_options = new_val;
802
803
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
804
805
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
806
807
808
    global_options = old_options;
    return -1;
  }
809
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
810
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
811
            "Acting on config options left us in a broken state. Dying.");
812
813
814
    exit(1);
  }
  if (old_options)
815
    config_free(&options_format, old_options);
816
817

  return 0;
818
819
}

Roger Dingledine's avatar
Roger Dingledine committed
820
extern const char tor_svn_revision[]; /* from tor_main.c */
821

822
/** The version of this Tor process, as parsed. */
823
824
static char *_version = NULL;

825
/** Return the current Tor version. */
826
827
828
const char *
get_version(void)
{
829
  if (_version == NULL) {
830
831
    if (strlen(tor_svn_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_svn_revision)+8;
832
833
      _version = tor_malloc(len);
      tor_snprintf(_version, len, "%s (r%s)", VERSION, tor_svn_revision);
834
    } else {
835
      _version = tor_strdup(VERSION);
836
837
    }
  }
838
  return _version;
839
840
}

841
842
843
844
845
846
847
848
849
850
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
  if (options->_ExcludeExitNodesUnion)
    routerset_free(options->_ExcludeExitNodesUnion);
  config_free(&options_format, options);
}

851
852
/** Release all memory and resources held by global configuration structures.
 */
853
854
855
void
config_free_all(void)
{
856
  if (global_options) {
857
    or_options_free(global_options);
858
859
860
861
862
863
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
864
865
866
867
  if (global_cmdline_options) {
    config_free_lines(global_cmdline_options);
    global_cmdline_options = NULL;
  }
868
  tor_free(torrc_fname);
869
  tor_free(_version);
870
  tor_free(global_dirfrontpagecontents);
871
872
}

873
874
875
876
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
877
878
safe_str(const char *address)
{
879
  tor_assert(address);
880
881
882
883
884
885
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

886
/** Equivalent to escaped(safe_str(address)).  See reentrancy note on
887
888
 * escaped(): don't use this outside the main thread, or twice in the same
 * log statement. */
889
890
891
892
893
894
895
896
897
const char *
escaped_safe_str(const char *address)
{
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return escaped(address);
}

898
899
/** Add the default directory authorities directly into the trusted dir list,
 * but only add them insofar as they share bits with <b>type</b>. */
900
static void
901