config.c 182 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.
Karsten Loesing's avatar
Karsten Loesing committed
4
 * Copyright (c) 2007-2009, 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"
15
16
17
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
18

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

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

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

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

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

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

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

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

361
362
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
363
static config_var_t testing_tor_network_defaults[] = {
364
  V(ServerDNSAllowBrokenConfig,  BOOL,  "1"),
365
366
367
368
369
370
371
372
373
374
  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"),
375
376
377
378
379
  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"),
380
381
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
};
382
383
#undef VAR

384
385
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
386
      initvalue }
387
388

/** Array of "state" variables saved to the ~/.tor/state file. */
389
static config_var_t _state_vars[] = {
390
391
392
393
394
  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
395

396
397
398
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
399
  VAR("EntryGuardAddedBy",       LINELIST_S,  EntryGuards,             NULL),
400
  V(EntryGuards,                 LINELIST_V,  NULL),
Nick Mathewson's avatar
Nick Mathewson committed
401

402
403
404
405
406
407
  V(BWHistoryReadEnds,                ISOTIME,  NULL),
  V(BWHistoryReadInterval,            UINT,     "900"),
  V(BWHistoryReadValues,              CSV,      ""),
  V(BWHistoryWriteEnds,               ISOTIME,  NULL),
  V(BWHistoryWriteInterval,           UINT,     "900"),
  V(BWHistoryWriteValues,             CSV,      ""),
408

409
  V(TorVersion,                       STRING,   NULL),
410

411
412
  V(LastRotatedOnionKey,              ISOTIME,  NULL),
  V(LastWritten,                      ISOTIME,  NULL),
413

414
  V(TotalBuildTimes,                  UINT,     NULL),
415
416
  VAR("CircuitBuildTimeBin",          LINELIST_S, BuildtimeHistogram, NULL),
  VAR("BuildtimeHistogram",           LINELIST_V, BuildtimeHistogram, NULL),
417

418
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
419
420
};

421
#undef VAR
422
#undef V
423
424
#undef OBSOLETE

425
426
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
427
428
429
430
431
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

432
433
434
/** Descriptions of the configuration options, to be displayed by online
 * option browsers */
/* XXXX022 did anybody want this? at all? If not, kill it.*/
435
static config_var_description_t options_description[] = {
436
  /* ==== general options */
437
438
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
439
440
441
442
  { "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." },
443
  { "ConnLimit", "Minimum number of simultaneous sockets we must have." },
444
445
446
447
448
  { "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." },
449
450
451
  /*  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
452
    "the Tor process using the Tor Control Protocol (described in "
453
454
455
    "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 "
456
    "can read a file that Tor creates in its data directory." },
457
458
459
460
  { "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." },
461
462
  { "DisableAllSwap", "Tor will attempt a simple memory lock that "
    "will prevent leaking of all information in memory to the swap file." },
463
464
465
466
467
  /* { "FastFirstHopPK", "" }, */
  /* FetchServerDescriptors, FetchHidServDescriptors,
   * FetchUselessDescriptors */
  { "HardwareAccel", "If set, Tor tries to use hardware crypto accelerators "
    "when it can." },
468
469
470
471
  { "AccelName", "If set, try to use hardware crypto accelerator with this "
    "specific ID." },
  { "AccelDir", "If set, look in this directory for the dynamic hardware "
    "engine in addition to OpenSSL default path." },
472
473
474
475
476
  /* 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." },
Nick Mathewson's avatar
Nick Mathewson committed
477
  { "HTTPSProxy", "Force Tor to make all TLS (SSL) connections through this "
478
479
480
481
482
483
484
485
    "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 "
486
    "provided IP address (only useful for multiple network interfaces)." },
487
488
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
489
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
490
    "don't support tunneled connections." },
491
  /* PreferTunneledDirConns */
492
493
494
495
496
497
  /* 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]." },
498
499
500
  { "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
501
  { "User", "On startup, setuid to this user." },
502
503
504
505

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
506
507
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
508
509
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
510
    "server, even if ORPort is enabled." },
511
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
512
    "in circuits, when possible." },
513
514
515
516
517
  /* { "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 "
518
519
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
520
521
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
522
    "high-uptime connections." },
523
524
525
  { "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 "
526
    "every NUM seconds." },
527
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
528
    "been used more than this many seconds ago." },
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
  /* 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 "
551
    "accessed from the same exit node each time we connect to them." },
552
553
554
555
  { "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 "
556
557
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
558
559

  /* === server options */
560
  { "Address", "The advertised (external) address we should use." },
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
  /* 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." },
577
  { "NoPublish", "{DEPRECATED}" },
578
579
580
581
582
  { "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." },
583
  { "PublishServerDescriptor", "Set to 0 to keep the server from "
584
    "uploading info to the directory authorities." },
585
586
587
588
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },

589
  /* === directory cache options */
590
591
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
592
  { "DirPortFrontPage", "Serve a static html disclaimer on DirPort." },
593
  { "DirListenAddress", "Bind to this address to listen for connections from "
594
595
    "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
596
    "port." },
597
598
599
600
601
602
603
604
605
606
607

  /*  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 */

608
609
610
611
  /* Circuit build time histogram options */
  { "CircuitBuildTimeBin", "Histogram of recent circuit build times"},
  { "TotalBuildTimes", "Total number of buildtimes in histogram"},

612
  /* Nonpersistent options: __LeaveStreamsUnattached, __AllDirActionsPrivate */
613
614
615
  { NULL, NULL },
};

616
/** Online description of state variables. */
617
static config_var_description_t state_description[] = {
618
  { "AccountingBytesReadInInterval",
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
    "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." },

634
635
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
636
    "The last entry guard has been unreachable since this time." },
637
  { "EntryGuardUnlistedSince",
638
    "The last entry guard has been unusable since this time." },
Roger Dingledine's avatar
Roger Dingledine committed
639

640
641
642
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
643
644
645
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
646
647
648
  { NULL, NULL },
};

649
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
650
 * well-formed and consistent. See options_trial_assign() for documentation
651
 * of arguments. */
652
typedef int (*validate_fn_t)(void*,void*,int,char**);
653

654
655
656
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
657
typedef struct {
658
659
660
  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
661
  off_t magic_offset; /**< Offset of the magic value within the struct. */
662
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
663
                             * parsing this format. */
664
665
666
667
  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. */
668
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
669
670
671
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
672
673
} config_format_t;

674
675
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
676
#define CHECK(fmt, cfg) STMT_BEGIN                                      \
677
    tor_assert(fmt && cfg);                                             \
678
    tor_assert((fmt)->magic ==                                          \
679
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
680
  STMT_END
681

682
683
684
#ifdef MS_WINDOWS
static char *get_windows_conf_root(void);
#endif
685
static void config_line_append(config_line_t **lst,
686
                               const char *key, const char *val);
687
688
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
689
static void option_reset(config_format_t *fmt, or_options_t *options,
690
                         config_var_t *var, int use_defaults);
691
static void config_free(config_format_t *fmt, void *options);
692
static int config_lines_eq(config_line_t *a, config_line_t *b);
693
static int option_is_same(config_format_t *fmt,
694
695
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
696
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
697
698
699
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);
700
static int options_act(or_options_t *old_options);
701
702
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
703
704
705
706
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);
707
static int check_nickname_list(const char *lst, const char *name, char **msg);
708
static void config_register_addressmaps(or_options_t *options);
709

710
static int parse_bridge_line(const char *line, int validate_only);
711
712
713
static int parse_dir_server_line(const char *line,
                                 authority_type_t required_type,
                                 int validate_only);
714
static int validate_data_directory(or_options_t *options);
715
static int write_configuration_file(const char *fname, or_options_t *options);
716
static config_line_t *get_assigned_option(config_format_t *fmt,
717
718
                                          void *options, const char *key,
                                          int escape_val);
719
static void config_init(config_format_t *fmt, void *options);
720
static int or_state_validate(or_state_t *old_options, or_state_t *options,
721
                             int from_setconf, char **msg);
722
723
static int or_state_load(void);
static int options_init_logs(or_options_t *options, int validate_only);
724

725
726
727
static int is_listening_on_low_port(uint16_t port_option,
                                    const config_line_t *listen_options);

728
729
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
730
static void init_libevent(void);
731
static int opt_streq(const char *s1, const char *s2);
732

733
/** Magic value for or_options_t. */
734
735
#define OR_OPTIONS_MAGIC 9090909

736
/** Configuration format for or_options_t. */
737
static config_format_t options_format = {
738
739
740
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
741
742
743
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
744
745
  options_description,
  NULL
746
747
};

748
/** Magic value for or_state_t. */
749
750
#define OR_STATE_MAGIC 0x57A73f57

751
752
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
753
754
755
756
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

757
/** Configuration format for or_state_t. */
758
759
760
761
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
762
  _state_abbrevs,
763
764
  _state_vars,
  (validate_fn_t)or_state_validate,
765
766
  state_description,
  &state_extra_var,
767
768
};

769
770
771
772
773
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
774
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
775
/** Name of most recently read torrc file. */
776
static char *torrc_fname = NULL;
777
/** Persistent serialized state. */
778
static or_state_t *global_state = NULL;
779
780
/** Configuration Options set by command line. */
static config_line_t *global_cmdline_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
781
/** Contents of most recently read DirPortFrontPage file. */
782
783
784
785
786
787
788
789
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;
}
790

791
/** Allocate an empty configuration object of a given format type. */
792
793
794
static void *
config_alloc(config_format_t *fmt)
{
795
  void *opts = tor_malloc_zero(fmt->size);
796
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
797
798
799
800
  CHECK(fmt, opts);
  return opts;
}

801
802
/** Return the currently configured options. */
or_options_t *
803
804
get_options(void)
{
805
806
807
  tor_assert(global_options);
  return global_options;
}
808

809
810
/** 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
811
 * as necessary.  Returns 0 on success, -1 on failure.
812
 */
813
int
814
set_options(or_options_t *new_val, char **msg)
815
{
816
  or_options_t *old_options = global_options;
817
  global_options = new_val;
818
819
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
820
821
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
822
823
824
    global_options = old_options;
    return -1;
  }
825
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
826
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
827
            "Acting on config options left us in a broken state. Dying.");
828
829
830
    exit(1);
  }
  if (old_options)
831
    config_free(&options_format, old_options);
832
833

  return 0;
834
835
}

836
extern const char tor_git_revision[]; /* from tor_main.c */
837

838
/** The version of this Tor process, as parsed. */
839
840
static char *_version = NULL;

841
/** Return the current Tor version. */
842
843
844
const char *
get_version(void)
{
845
  if (_version == NULL) {
846
847
    if (strlen(tor_git_revision)) {
      size_t len = strlen(VERSION)+strlen(tor_git_revision)+16;
848
      _version = tor_malloc(len);
849
      tor_snprintf(_version, len, "%s (git-%s)", VERSION, tor_git_revision);
850
    } else {
851
      _version = tor_strdup(VERSION);
852
853
    }
  }
854
  return _version;
855
856
}

857
858
859
860
861
/** Release additional memory allocated in options
 */
static void
or_options_free(or_options_t *options)
{
862
863
864
  if (!options)
    return;

865
866
867
868
869
  if (options->_ExcludeExitNodesUnion)
    routerset_free(options->_ExcludeExitNodesUnion);
  config_free(&options_format, options);
}

870
871
/** Release all memory and resources held by global configuration structures.
 */
872
873
874
void
config_free_all(void)
{
875
  if (global_options) {
876
    or_options_free(global_options);