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

Nick Mathewson's avatar
Nick Mathewson committed
7
/**
8
 * \file config.c
9
10
11
12
13
14
15
16
17
18
19
20
 * \brief Code to interpret the user's configuration of Tor.
 *
 * This module handles torrc configuration file, including parsing it,
 * combining it with torrc.defaults and the command line, allowing
 * user changes to it (via editing and SIGHUP or via the control port),
 * writing it back to disk (because of SAVECONF from the control port),
 * and -- most importantly, acting on it.
 *
 * The module additionally has some tools for manipulating and
 * inspecting values that are calculated as a result of the
 * configured options.
 *
21
 * <h3>How to add new options</h3>
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
 *
 * To add new items to the torrc, there are a minimum of three places to edit:
 * <ul>
 *   <li>The or_options_t structure in or.h, where the options are stored.
 *   <li>The option_vars_ array below in this module, which configures
 *       the names of the torrc options, their types, their multiplicities,
 *       and their mappings to fields in or_options_t.
 *   <li>The manual in doc/tor.1.txt, to document what the new option
 *       is, and how it works.
 * </ul>
 *
 * Additionally, you might need to edit these places too:
 * <ul>
 *   <li>options_validate() below, in case you want to reject some possible
 *       values of the new configuration option.
 *   <li>options_transition_allowed() below, in case you need to
 *       forbid some or all changes in the option while Tor is
 *       running.
 *   <li>options_transition_affects_workers(), in case changes in the option
 *       might require Tor to relaunch or reconfigure its worker threads.
 *   <li>options_transition_affects_descriptor(), in case changes in the
 *       option might require a Tor relay to build and publish a new server
 *       descriptor.
 *   <li>options_act() and/or options_act_reversible(), in case there's some
 *       action that needs to be taken immediately based on the option's
 *       value.
 * </ul>
 *
 * <h3>Changing the value of an option</h3>
 *
 * Because of the SAVECONF command from the control port, it's a bad
 * idea to change the value of any user-configured option in the
 * or_options_t.  If you want to sometimes do this anyway, we recommend
 * that you create a secondary field in or_options_t; that you have the
 * user option linked only to the secondary field; that you use the
 * secondary field to initialize the one that Tor actually looks at; and that
 * you use the one Tor looks as the one that you modify.
Nick Mathewson's avatar
Nick Mathewson committed
59
60
 **/

61
#define CONFIG_PRIVATE
Roger Dingledine's avatar
Roger Dingledine committed
62
#include "or.h"
63
#include "bridges.h"
64
#include "compat.h"
65
#include "addressmap.h"
66
#include "channel.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
67
#include "circuitbuild.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
68
#include "circuitlist.h"
69
70
#include "circuitmux.h"
#include "circuitmux_ewma.h"
71
#include "circuitstats.h"
72
#include "compress.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
73
#include "config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
74
#include "connection.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
75
#include "connection_edge.h"
76
#include "connection_or.h"
77
#include "consdiffmgr.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
78
#include "control.h"
79
#include "confparse.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
80
#include "cpuworker.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
81
#include "dirserv.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
82
#include "dirvote.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
83
#include "dns.h"
84
#include "dos.h"
85
#include "entrynodes.h"
86
#include "git_revision.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
87
#include "geoip.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
88
#include "hibernate.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
89
#include "main.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
90
#include "networkstatus.h"
91
#include "nodelist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
92
#include "policies.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
93
#include "relay.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
94
#include "rendclient.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
95
#include "rendservice.h"
96
#include "hs_config.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
97
#include "rephist.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
98
#include "router.h"
99
#include "sandbox.h"
100
#include "util.h"
Sebastian Hahn's avatar
Sebastian Hahn committed
101
#include "routerlist.h"
102
#include "routerset.h"
103
#include "scheduler.h"
104
#include "statefile.h"
105
#include "transports.h"
106
#include "ext_orport.h"
107
#ifdef _WIN32
108
109
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
110

111
112
#include "procmon.h"

113
114
115
116
117
118
#ifdef HAVE_SYSTEMD
#   if defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__)
/* Systemd's use of gcc's __INCLUDE_LEVEL__ extension macro appears to confuse
 * Coverity. Here's a kludge to unconfuse it.
 */
#   define __INCLUDE_LEVEL__ 2
119
#endif /* defined(__COVERITY__) && !defined(__INCLUDE_LEVEL__) */
120
#include <systemd/sd-daemon.h>
121
#endif /* defined(HAVE_SYSTEMD) */
122

123
/* Prefix used to indicate a Unix socket in a FooPort configuration. */
124
static const char unix_socket_prefix[] = "unix:";
125
126
127
/* Prefix used to indicate a Unix socket with spaces in it, in a FooPort
 * configuration. */
static const char unix_q_socket_prefix[] = "unix:\"";
128

129
130
/** A list of abbreviations and aliases to map command-line options, obsolete
 * option names, or alternative option names, to their current values. */
131
static config_abbrev_t option_abbrevs_[] = {
132
133
134
135
  PLURAL(AuthDirBadDirCC),
  PLURAL(AuthDirBadExitCC),
  PLURAL(AuthDirInvalidCC),
  PLURAL(AuthDirRejectCC),
136
  PLURAL(EntryNode),
137
  PLURAL(ExcludeNode),
138
  PLURAL(Tor2webRendezvousPoint),
139
  PLURAL(FirewallPort),
140
  PLURAL(LongLivedPort),
141
142
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
143
  PLURAL(NumCPU),
144
  PLURAL(RendNode),
145
  PLURAL(RecommendedPackage),
146
  PLURAL(RendExcludeNode),
147
148
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
149
  PLURAL(StrictNode),
150
  { "l", "Log", 1, 0},
151
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
152
153
  { "AutomapHostSuffixes", "AutomapHostsSuffixes", 0, 0},
  { "AutomapHostOnResolve", "AutomapHostsOnResolve", 0, 0},
154
155
156
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
157
  { "DirServer", "DirAuthority", 0, 0}, /* XXXX later, make this warn? */
158
  { "MaxConn", "ConnLimit", 0, 1},
159
  { "MaxMemInCellQueues", "MaxMemInQueues", 0, 0},
160
161
162
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
163
164
165
166
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
167
168
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
169
  { "ServerDNSAllowBrokenResolvConf", "ServerDNSAllowBrokenConfig", 0, 0},
170
  { "PreferTunnelledDirConns", "PreferTunneledDirConns", 0, 0},
171
  { "BridgeAuthoritativeDirectory", "BridgeAuthoritativeDir", 0, 0},
172
  { "HashedControlPassword", "__HashedControlSessionPassword", 1, 0},
173
  { "VirtualAddrNetwork", "VirtualAddrNetworkIPv4", 0, 0},
174
  { "SocksSocketsGroupWritable", "UnixSocksGroupWritable", 0, 1},
175
176
  { NULL, NULL, 0, 0},
};
177

178
179
180
181
/** dummy instance of or_options_t, used for type-checking its
 * members with CONF_CHECK_VAR_TYPE. */
DUMMY_TYPECHECK_INSTANCE(or_options_t);

Nick Mathewson's avatar
Nick Mathewson committed
182
183
184
185
/** 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>"
 */
186
#define VAR(name,conftype,member,initvalue)                             \
Neel Chauhan's avatar
Neel Chauhan committed
187
  { name, CONFIG_TYPE_ ## conftype, offsetof(or_options_t, member),     \
188
      initvalue CONF_TEST_MEMBERS(or_options_t, conftype, member) }
189
190
191
/** 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
192
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
193
194
195
#ifdef TOR_UNIT_TESTS
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL, {.INT=NULL} }
#else
196
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
197
#endif
198

199
200
201
202
203
204
205
206
207
208
209
/**
 * Macro to declare *Port options.  Each one comes in three entries.
 * For example, most users should use "SocksPort" to configure the
 * socks port, but TorBrowser wants to use __SocksPort so that it
 * isn't stored by SAVECONF.  The SocksPortLines virtual option is
 * used to query both options from the controller.
 */
#define VPORT(member)                                           \
  VAR(#member "Lines", LINELIST_V, member ## _lines, NULL),     \
  VAR(#member, LINELIST_S, member ## _lines, NULL),             \
  VAR("__" #member, LINELIST_S, member ## _lines, NULL)
210

Nick Mathewson's avatar
Nick Mathewson committed
211
212
213
214
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
215
static config_var_t option_vars_[] = {
216
  V(AccountingMax,               MEMUNIT,  "0 bytes"),
217
  VAR("AccountingRule",          STRING,   AccountingRule_option,  "max"),
218
219
  V(AccountingStart,             STRING,   NULL),
  V(Address,                     STRING,   NULL),
Nick Mathewson's avatar
Nick Mathewson committed
220
  OBSOLETE("AllowDotExit"),
221
  OBSOLETE("AllowInvalidNodes"),
222
  V(AllowNonRFC953Hostnames,     BOOL,     "0"),
223
  OBSOLETE("AllowSingleHopCircuits"),
224
  OBSOLETE("AllowSingleHopExits"),
225
226
  V(AlternateBridgeAuthority,    LINELIST, NULL),
  V(AlternateDirAuthority,       LINELIST, NULL),
227
  OBSOLETE("AlternateHSAuthority"),
228
  V(AssumeReachable,             BOOL,     "0"),
229
230
  OBSOLETE("AuthDirBadDir"),
  OBSOLETE("AuthDirBadDirCCs"),
231
  V(AuthDirBadExit,              LINELIST, NULL),
232
  V(AuthDirBadExitCCs,           CSV,      ""),
233
  V(AuthDirInvalid,              LINELIST, NULL),
234
  V(AuthDirInvalidCCs,           CSV,      ""),
235
  V(AuthDirFastGuarantee,        MEMUNIT,  "100 KB"),
236
  V(AuthDirGuardBWGuarantee,     MEMUNIT,  "2 MB"),
237
  V(AuthDirPinKeys,              BOOL,     "1"),
238
  V(AuthDirReject,               LINELIST, NULL),
239
  V(AuthDirRejectCCs,            CSV,      ""),
240
  OBSOLETE("AuthDirRejectUnlisted"),
241
  OBSOLETE("AuthDirListBadDirs"),
242
  V(AuthDirListBadExits,         BOOL,     "0"),
243
  V(AuthDirMaxServersPerAddr,    UINT,     "2"),
244
  OBSOLETE("AuthDirMaxServersPerAuthAddr"),
245
  V(AuthDirHasIPv6Connectivity,  BOOL,     "0"),
246
247
248
249
  VAR("AuthoritativeDirectory",  BOOL, AuthoritativeDir,    "0"),
  V(AutomapHostsOnResolve,       BOOL,     "0"),
  V(AutomapHostsSuffixes,        CSV,      ".onion,.exit"),
  V(AvoidDiskWrites,             BOOL,     "0"),
250
251
  V(BandwidthBurst,              MEMUNIT,  "1 GB"),
  V(BandwidthRate,               MEMUNIT,  "1 GB"),
252
253
  V(BridgeAuthoritativeDir,      BOOL,     "0"),
  VAR("Bridge",                  LINELIST, Bridges,    NULL),
254
  V(BridgePassword,              STRING,   NULL),
255
  V(BridgeRecordUsageByCountry,  BOOL,     "1"),
256
  V(BridgeRelay,                 BOOL,     "0"),
257
  V(BridgeDistribution,          STRING,   NULL),
258
259
  VAR("CacheDirectory",          FILENAME, CacheDirectory_option, NULL),
  V(CacheDirectoryGroupReadable, BOOL,     "0"),
260
  V(CellStatistics,              BOOL,     "0"),
261
  V(PaddingStatistics,           BOOL,     "1"),
262
  V(LearnCircuitBuildTimeout,    BOOL,     "1"),
263
  V(CircuitBuildTimeout,         INTERVAL, "0"),
264
265
  OBSOLETE("CircuitIdleTimeout"),
  V(CircuitsAvailableTimeout,    INTERVAL, "0"),
266
  V(CircuitStreamTimeout,        INTERVAL, "0"),
267
  V(CircuitPriorityHalflife,     DOUBLE,  "-1.0"), /*negative:'Use default'*/
268
  V(ClientDNSRejectInternalAddresses, BOOL,"1"),
269
  V(ClientOnly,                  BOOL,     "0"),
270
271
  V(ClientPreferIPv6ORPort,      AUTOBOOL, "auto"),
  V(ClientPreferIPv6DirPort,     AUTOBOOL, "auto"),
272
  V(ClientRejectInternalAddresses, BOOL,   "1"),
273
  V(ClientTransportPlugin,       LINELIST, NULL),
274
  V(ClientUseIPv6,               BOOL,     "0"),
275
  V(ClientUseIPv4,               BOOL,     "1"),
276
  V(ConsensusParams,             STRING,   NULL),
277
  V(ConnLimit,                   UINT,     "1000"),
278
  V(ConnDirectionStatistics,     BOOL,     "0"),
279
280
281
  V(ConstrainedSockets,          BOOL,     "0"),
  V(ConstrainedSockSize,         MEMUNIT,  "8192"),
  V(ContactInfo,                 STRING,   NULL),
282
  OBSOLETE("ControlListenAddress"),
283
  VPORT(ControlPort),
284
  V(ControlPortFileGroupReadable,BOOL,     "0"),
285
  V(ControlPortWriteToFile,      FILENAME, NULL),
286
  V(ControlSocket,               LINELIST, NULL),
287
  V(ControlSocketsGroupWritable, BOOL,     "0"),
288
  V(UnixSocksGroupWritable,    BOOL,     "0"),
289
290
291
  V(CookieAuthentication,        BOOL,     "0"),
  V(CookieAuthFileGroupReadable, BOOL,     "0"),
  V(CookieAuthFile,              STRING,   NULL),
292
  V(CountPrivateBandwidth,       BOOL,     "0"),
293
  VAR("DataDirectory",           FILENAME, DataDirectory_option, NULL),
294
  V(DataDirectoryGroupReadable,  BOOL,     "0"),
295
  V(DisableOOSCheck,             BOOL,     "1"),
296
  V(DisableNetwork,              BOOL,     "0"),
297
  V(DirAllowPrivateAddresses,    BOOL,     "0"),
298
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "30 minutes"),
299
  OBSOLETE("DirListenAddress"),
300
  V(DirPolicy,                   LINELIST, NULL),
301
  VPORT(DirPort),
302
  V(DirPortFrontPage,            FILENAME, NULL),
303
  VAR("DirReqStatistics",        BOOL,     DirReqStatistics_option, "1"),
304
  VAR("DirAuthority",            LINELIST, DirAuthorities, NULL),
305
  V(DirCache,                    BOOL,     "1"),
306
307
308
309
310
  /* A DirAuthorityFallbackRate of 0.1 means that 0.5% of clients try an
   * authority when all fallbacks are up, and 2% try an authority when 25% of
   * fallbacks are down. (We rebuild the list when 25% of fallbacks are down).
   *
   * We want to reduce load on authorities, but keep these two figures within
Nick Mathewson's avatar
Nick Mathewson committed
311
312
   * an order of magnitude, so there isn't too much load shifting to
   * authorities when fallbacks go down. */
313
  V(DirAuthorityFallbackRate,    DOUBLE,   "0.1"),
314
  V(DisableAllSwap,              BOOL,     "0"),
315
  V(DisableDebuggerAttachment,   BOOL,     "1"),
316
  OBSOLETE("DisableIOCP"),
317
  OBSOLETE("DisableV2DirectoryInfo_"),
318
  OBSOLETE("DynamicDHGroups"),
319
  VPORT(DNSPort),
320
  OBSOLETE("DNSListenAddress"),
321
322
323
  /* DoS circuit creation options. */
  V(DoSCircuitCreationEnabled,   AUTOBOOL, "auto"),
  V(DoSCircuitCreationMinConnections,      UINT, "0"),
324
  V(DoSCircuitCreationRate,      UINT,     "0"),
325
326
327
328
329
330
331
332
333
  V(DoSCircuitCreationBurst,     UINT,     "0"),
  V(DoSCircuitCreationDefenseType,         INT,  "0"),
  V(DoSCircuitCreationDefenseTimePeriod,   INTERVAL, "0"),
  /* DoS connection options. */
  V(DoSConnectionEnabled,        AUTOBOOL, "auto"),
  V(DoSConnectionMaxConcurrentCount,       UINT, "0"),
  V(DoSConnectionDefenseType,    INT,      "0"),
  /* DoS single hop client options. */
  V(DoSRefuseSingleHopClientRendezvous,    AUTOBOOL, "auto"),
334
  V(DownloadExtraInfo,           BOOL,     "0"),
335
  V(TestingEnableConnBwEvent,    BOOL,     "0"),
336
  V(TestingEnableCellStatsEvent, BOOL,     "0"),
337
  V(TestingEnableTbEmptyEvent,   BOOL,     "0"),
338
  V(EnforceDistinctSubnets,      BOOL,     "1"),
339
  V(EntryNodes,                  ROUTERSET,   NULL),
340
  V(EntryStatistics,             BOOL,     "0"),
341
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "10 minutes"),
342
343
  V(ExcludeNodes,                ROUTERSET, NULL),
  V(ExcludeExitNodes,            ROUTERSET, NULL),
344
  OBSOLETE("ExcludeSingleHopRelays"),
345
  V(ExitNodes,                   ROUTERSET, NULL),
346
347
  V(ExitPolicy,                  LINELIST, NULL),
  V(ExitPolicyRejectPrivate,     BOOL,     "1"),
348
  V(ExitPolicyRejectLocalInterfaces, BOOL, "0"),
349
  V(ExitPortStatistics,          BOOL,     "0"),
350
  V(ExtendAllowPrivateAddresses, BOOL,     "0"),
351
  V(ExitRelay,                   AUTOBOOL, "auto"),
352
  VPORT(ExtORPort),
353
  V(ExtORPortCookieAuthFile,     STRING,   NULL),
354
  V(ExtORPortCookieAuthFileGroupReadable, BOOL, "0"),
355
  V(ExtraInfoStatistics,         BOOL,     "1"),
356
  V(ExtendByEd25519ID,           AUTOBOOL, "auto"),
357
  V(FallbackDir,                 LINELIST, NULL),
358

359
  V(UseDefaultFallbackDirs,      BOOL,     "1"),
360

361
  OBSOLETE("FallbackNetworkstatusFile"),
362
363
  V(FascistFirewall,             BOOL,     "0"),
  V(FirewallPorts,               CSV,      ""),
364
  OBSOLETE("FastFirstHopPK"),
365
  V(FetchDirInfoEarly,           BOOL,     "0"),
366
  V(FetchDirInfoExtraEarly,      BOOL,     "0"),
367
368
369
  V(FetchServerDescriptors,      BOOL,     "1"),
  V(FetchHidServDescriptors,     BOOL,     "1"),
  V(FetchUselessDescriptors,     BOOL,     "0"),
370
  OBSOLETE("FetchV2Networkstatus"),
371
  V(GeoIPExcludeUnknown,         AUTOBOOL, "auto"),
372
#ifdef _WIN32
373
  V(GeoIPFile,                   FILENAME, "<default>"),
nils's avatar
nils committed
374
  V(GeoIPv6File,                 FILENAME, "<default>"),
375
#else
376
377
  V(GeoIPFile,                   FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip"),
nils's avatar
nils committed
378
379
  V(GeoIPv6File,                 FILENAME,
    SHARE_DATADIR PATH_SEPARATOR "tor" PATH_SEPARATOR "geoip6"),
380
#endif /* defined(_WIN32) */
381
  OBSOLETE("Group"),
382
  V(GuardLifetime,               INTERVAL, "0 minutes"),
383
  V(HardwareAccel,               BOOL,     "0"),
384
  V(HeartbeatPeriod,             INTERVAL, "6 hours"),
Alexander Færøy's avatar
Alexander Færøy committed
385
  V(MainloopStats,               BOOL,     "0"),
386
387
  V(AccelName,                   STRING,   NULL),
  V(AccelDir,                    FILENAME, NULL),
388
  V(HashedControlPassword,       LINELIST, NULL),
389
  OBSOLETE("HidServDirectoryV2"),
Nick Mathewson's avatar
Nick Mathewson committed
390
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
391
  VAR("HiddenServiceDirGroupReadable",  LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
392
393
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
394
  VAR("HiddenServiceVersion",LINELIST_S, RendConfigLines,    NULL),
395
  VAR("HiddenServiceAuthorizeClient",LINELIST_S,RendConfigLines, NULL),
396
  VAR("HiddenServiceAllowUnknownPorts",LINELIST_S, RendConfigLines, NULL),
397
398
  VAR("HiddenServiceMaxStreams",LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceMaxStreamsCloseCircuit",LINELIST_S, RendConfigLines, NULL),
399
  VAR("HiddenServiceNumIntroductionPoints", LINELIST_S, RendConfigLines, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
400
  VAR("HiddenServiceStatistics", BOOL, HiddenServiceStatistics_option, "1"),
401
  V(HidServAuth,                 LINELIST, NULL),
402
  OBSOLETE("CloseHSClientCircuitsImmediatelyOnTimeout"),
403
  OBSOLETE("CloseHSServiceRendCircuitsImmediatelyOnTimeout"),
404
405
  V(HiddenServiceSingleHopMode,  BOOL,     "0"),
  V(HiddenServiceNonAnonymousMode,BOOL,    "0"),
406
407
408
409
  V(HTTPProxy,                   STRING,   NULL),
  V(HTTPProxyAuthenticator,      STRING,   NULL),
  V(HTTPSProxy,                  STRING,   NULL),
  V(HTTPSProxyAuthenticator,     STRING,   NULL),
410
  VPORT(HTTPTunnelPort),
411
  V(IPv6Exit,                    BOOL,     "0"),
412
  VAR("ServerTransportPlugin",   LINELIST, ServerTransportPlugin,  NULL),
413
  V(ServerTransportListenAddr,   LINELIST, NULL),
414
  V(ServerTransportOptions,      LINELIST, NULL),
415
  V(SigningKeyLifetime,          INTERVAL, "30 days"),
416
417
418
419
  V(Socks4Proxy,                 STRING,   NULL),
  V(Socks5Proxy,                 STRING,   NULL),
  V(Socks5ProxyUsername,         STRING,   NULL),
  V(Socks5ProxyPassword,         STRING,   NULL),
420
421
  VAR("KeyDirectory",            FILENAME, KeyDirectory_option, NULL),
  V(KeyDirectoryGroupReadable,   BOOL,     "0"),
422
423
  VAR("_HSLayer2Nodes",          ROUTERSET,  HSLayer2Nodes,  NULL),
  VAR("_HSLayer3Nodes",          ROUTERSET,  HSLayer3Nodes,  NULL),
424
  V(KeepalivePeriod,             INTERVAL, "5 minutes"),
425
  V(KeepBindCapabilities,            AUTOBOOL, "auto"),
426
  VAR("Log",                     LINELIST, Logs,             NULL),
427
  V(LogMessageDomains,           BOOL,     "0"),
428
  V(LogTimeGranularity,          MSEC_INTERVAL, "1 second"),
Arlo Breault's avatar
Arlo Breault committed
429
  V(TruncateLogFile,             BOOL,     "0"),
Peter Palfrader's avatar
Peter Palfrader committed
430
  V(SyslogIdentityTag,           STRING,   NULL),
431
  V(AndroidIdentityTag,          STRING,   NULL),
432
  V(LongLivedPorts,              CSV,
Nick Mathewson's avatar
Nick Mathewson committed
433
        "21,22,706,1863,5050,5190,5222,5223,6523,6667,6697,8300"),
434
435
436
  VAR("MapAddress",              LINELIST, AddressMap,           NULL),
  V(MaxAdvertisedBandwidth,      MEMUNIT,  "1 GB"),
  V(MaxCircuitDirtiness,         INTERVAL, "10 minutes"),
437
  V(MaxClientCircuitsPending,    UINT,     "32"),
438
  V(MaxConsensusAgeForDiffs,     INTERVAL, "0 seconds"),
439
  VAR("MaxMemInQueues",          MEMUNIT,   MaxMemInQueues_raw, "0"),
440
441
  OBSOLETE("MaxOnionsPending"),
  V(MaxOnionQueueDelay,          MSEC_INTERVAL, "1750 msec"),
442
  V(MaxUnparseableDescSizeToLog, MEMUNIT, "10 MB"),
443
  V(MinMeasuredBWsForAuthToIgnoreAdvertised, INT, "500"),
444
  VAR("MyFamily",                LINELIST, MyFamily_lines,       NULL),
445
  V(NewCircuitPeriod,            INTERVAL, "30 seconds"),
446
  OBSOLETE("NamingAuthoritativeDirectory"),
447
  OBSOLETE("NATDListenAddress"),
448
  VPORT(NATDPort),
449
  V(Nickname,                    STRING,   NULL),
450
  OBSOLETE("PredictedPortsRelevanceTime"),
451
  OBSOLETE("WarnUnsafeSocks"),
452
  VAR("NodeFamily",              LINELIST, NodeFamilies,         NULL),
453
  V(NoExec,                      BOOL,     "0"),
454
  V(NumCPUs,                     UINT,     "0"),
455
  V(NumDirectoryGuards,          UINT,     "0"),
456
  V(NumEntryGuards,              UINT,     "0"),
Nick Mathewson's avatar
Nick Mathewson committed
457
  V(OfflineMasterKey,            BOOL,     "0"),
458
  OBSOLETE("ORListenAddress"),
459
  VPORT(ORPort),
460
  V(OutboundBindAddress,         LINELIST,   NULL),
461
462
  V(OutboundBindAddressOR,       LINELIST,   NULL),
  V(OutboundBindAddressExit,     LINELIST,   NULL),
463

464
  OBSOLETE("PathBiasDisableRate"),
465
466
  V(PathBiasCircThreshold,       INT,      "-1"),
  V(PathBiasNoticeRate,          DOUBLE,   "-1"),
467
  V(PathBiasWarnRate,            DOUBLE,   "-1"),
468
  V(PathBiasExtremeRate,         DOUBLE,   "-1"),
469
  V(PathBiasScaleThreshold,      INT,      "-1"),
470
471
  OBSOLETE("PathBiasScaleFactor"),
  OBSOLETE("PathBiasMultFactor"),
472
  V(PathBiasDropGuards,          AUTOBOOL, "0"),
473
474
475
476
477
478
  OBSOLETE("PathBiasUseCloseCounts"),

  V(PathBiasUseThreshold,       INT,      "-1"),
  V(PathBiasNoticeUseRate,          DOUBLE,   "-1"),
  V(PathBiasExtremeUseRate,         DOUBLE,   "-1"),
  V(PathBiasScaleUseThreshold,      INT,      "-1"),
479

480
  V(PathsNeededToBuildCircuits,  DOUBLE,   "-1"),
481
482
  V(PerConnBWBurst,              MEMUNIT,  "0"),
  V(PerConnBWRate,               MEMUNIT,  "0"),
483
  V(PidFile,                     STRING,   NULL),
484
  V(TestingTorNetwork,           BOOL,     "0"),
485
  V(TestingMinExitFlagThreshold, MEMUNIT,  "0"),
486
  V(TestingMinFastFlagThreshold, MEMUNIT,  "0"),
487

488
  V(TestingLinkCertLifetime,          INTERVAL, "2 days"),
489
490
491
492
493
  V(TestingAuthKeyLifetime,          INTERVAL, "2 days"),
  V(TestingLinkKeySlop,              INTERVAL, "3 hours"),
  V(TestingAuthKeySlop,              INTERVAL, "3 hours"),
  V(TestingSigningKeySlop,           INTERVAL, "1 day"),

494
  V(OptimisticData,              AUTOBOOL, "auto"),
495
  OBSOLETE("PreferTunneledDirConns"),
496
  V(ProtocolWarnings,            BOOL,     "0"),
497
  V(PublishServerDescriptor,     CSV,      "1"),
498
499
500
501
502
503
504
  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),
505
  V(RecommendedPackages,         LINELIST, NULL),
506
507
  V(ReducedConnectionPadding,    BOOL,     "0"),
  V(ConnectionPadding,           AUTOBOOL, "auto"),
508
  V(RefuseUnknownExits,          AUTOBOOL, "auto"),
509
  V(RejectPlaintextPorts,        CSV,      ""),
510
511
512
513
514
  V(RelayBandwidthBurst,         MEMUNIT,  "0"),
  V(RelayBandwidthRate,          MEMUNIT,  "0"),
  V(RendPostPeriod,              INTERVAL, "1 hour"),
  V(RephistTrackTime,            INTERVAL, "24 hours"),
  V(RunAsDaemon,                 BOOL,     "0"),
515
  V(ReducedExitPolicy,           BOOL,     "0"),
516
  OBSOLETE("RunTesting"), // currently unused
517
  V(Sandbox,                     BOOL,     "0"),
518
  V(SafeLogging,                 STRING,   "1"),
519
  V(SafeSocks,                   BOOL,     "0"),
520
  V(ServerDNSAllowBrokenConfig,  BOOL,     "1"),
521
522
  V(ServerDNSAllowNonRFC953Hostnames, BOOL,"0"),
  V(ServerDNSDetectHijacking,    BOOL,     "1"),
523
  V(ServerDNSRandomizeCase,      BOOL,     "1"),
524
525
526
  V(ServerDNSResolvConfFile,     STRING,   NULL),
  V(ServerDNSSearchDomains,      BOOL,     "0"),
  V(ServerDNSTestAddresses,      CSV,
527
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
528
529
530
531
532
  OBSOLETE("SchedulerLowWaterMark__"),
  OBSOLETE("SchedulerHighWaterMark__"),
  OBSOLETE("SchedulerMaxFlushCells__"),
  V(KISTSchedRunInterval,        MSEC_INTERVAL, "0 msec"),
  V(KISTSockBufSizeFactor,       DOUBLE,   "1.0"),
533
  V(Schedulers,                  CSV,      "KIST,KISTLite,Vanilla"),
534
  V(ShutdownWaitLength,          INTERVAL, "30 seconds"),
535
  OBSOLETE("SocksListenAddress"),
536
  V(SocksPolicy,                 LINELIST, NULL),
537
  VPORT(SocksPort),
538
  V(SocksTimeout,                INTERVAL, "2 minutes"),
539
  V(SSLKeyLifetime,              INTERVAL, "0"),
540
541
  OBSOLETE("StrictEntryNodes"),
  OBSOLETE("StrictExitNodes"),
542
  V(StrictNodes,                 BOOL,     "0"),
543
  OBSOLETE("Support022HiddenServices"),
544
  V(TestSocks,                   BOOL,     "0"),
545
  V(TokenBucketRefillInterval,   MSEC_INTERVAL, "100 msec"),
546
  V(Tor2webMode,                 BOOL,     "0"),
547
  V(Tor2webRendezvousPoints,      ROUTERSET, NULL),
548
  OBSOLETE("TLSECGroup"),
549
550
  V(TrackHostExits,              CSV,      NULL),
  V(TrackHostExitsExpire,        INTERVAL, "30 minutes"),
551
  OBSOLETE("TransListenAddress"),
552
  VPORT(TransPort),
553
  V(TransProxyType,              STRING,   "default"),
554
  OBSOLETE("TunnelDirConns"),
555
  V(UpdateBridgesFromAuthority,  BOOL,     "0"),
556
  V(UseBridges,                  BOOL,     "0"),
557
  VAR("UseEntryGuards",          BOOL,     UseEntryGuards_option, "1"),
Nick Mathewson's avatar
Nick Mathewson committed
558
  OBSOLETE("UseEntryGuardsAsDirGuards"),
559
  V(UseGuardFraction,            AUTOBOOL, "auto"),
560
  V(UseMicrodescriptors,         AUTOBOOL, "auto"),
561
  OBSOLETE("UseNTorHandshake"),
562
  V(User,                        STRING,   NULL),
563
  OBSOLETE("UserspaceIOCPBuffers"),
564
  V(AuthDirSharedRandomness,     BOOL,     "1"),
565
  V(AuthDirTestEd25519LinkKeys,  BOOL,     "1"),
566
  OBSOLETE("V1AuthoritativeDirectory"),
567
  OBSOLETE("V2AuthoritativeDirectory"),
568
  VAR("V3AuthoritativeDirectory",BOOL, V3AuthoritativeDir,   "0"),
569
570
571
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "30 minutes"),
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "5 minutes"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "5 minutes"),
572
  V(TestingV3AuthVotingStartOffset, INTERVAL, "0"),
573
574
575
576
  V(V3AuthVotingInterval,        INTERVAL, "1 hour"),
  V(V3AuthVoteDelay,             INTERVAL, "5 minutes"),
  V(V3AuthDistDelay,             INTERVAL, "5 minutes"),
  V(V3AuthNIntervalsValid,       UINT,     "3"),
577
  V(V3AuthUseLegacyKey,          BOOL,     "0"),
578
  V(V3BandwidthsFile,            FILENAME, NULL),
579
  V(GuardfractionFile,           FILENAME, NULL),
580
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
581
  OBSOLETE("VoteOnHidServDirectoriesV2"),
582
583
  V(VirtualAddrNetworkIPv4,      STRING,   "127.192.0.0/10"),
  V(VirtualAddrNetworkIPv6,      STRING,   "[FE80::]/10"),
584
  V(WarnPlaintextPorts,          CSV,      "23,109,110,143"),
585
586
  OBSOLETE("UseFilteringSSLBufferevents"),
  OBSOLETE("__UseFilteringSSLBufferevents"),
587
  VAR("__ReloadTorrcOnSIGHUP",   BOOL,  ReloadTorrcOnSIGHUP,      "1"),
588
589
  VAR("__AllDirActionsPrivate",  BOOL,  AllDirActionsPrivate,     "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits, "0"),
590
  VAR("__DisableSignalHandlers", BOOL,  DisableSignalHandlers,    "0"),
591
  VAR("__LeaveStreamsUnattached",BOOL,  LeaveStreamsUnattached,   "0"),
592
593
  VAR("__HashedControlSessionPassword", LINELIST, HashedControlSessionPassword,
      NULL),
594
  VAR("__OwningControllerProcess",STRING,OwningControllerProcess, NULL),
595
  VAR("__OwningControllerFD",INT,OwningControllerFD, "-1"),
596
  V(MinUptimeHidServDirectoryV2, INTERVAL, "96 hours"),
597
598
599
600
601
602
603
604
605
606
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 60, 60, 120, "
                                 "300, 900, 2147483647"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 60, 300, 600, "
                                 "2147483647"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 1800, 1800, 1800, "
                                 "1800, 3600, 7200"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 60, "
                                 "300, 600, 1800, 3600, 3600, 3600, "
                                 "10800, 21600, 43200"),
607
  /* With the ClientBootstrapConsensus*Download* below:
608
   * Clients with only authorities will try:
609
610
   *  - at least 3 authorities over 10 seconds, then exponentially backoff,
   *    with the next attempt 3-21 seconds later,
611
   * Clients with authorities and fallbacks will try:
612
613
   *  - at least 2 authorities and 4 fallbacks over 21 seconds, then
   *    exponentially backoff, with the next attempts 4-33 seconds later,
614
   * Clients will also retry when an application request arrives.
615
   * After a number of failed requests, clients retry every 3 days + 1 hour.
616
617
618
619
620
621
   *
   * Clients used to try 2 authorities over 10 seconds, then wait for
   * 60 minutes or an application request.
   *
   * When clients have authorities and fallbacks available, they use these
   * schedules: (we stagger the times to avoid thundering herds) */
622
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
623
    "6, 11, 3600, 10800, 25200, 54000, 111600, 262800" /* 3 days + 1 hour */),
624
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
625
626
    "0, 1, 4, 11, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* When clients only have authorities available, they use this schedule: */
627
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
628
629
630
631
632
    "0, 3, 7, 3600, 10800, 25200, 54000, 111600, 262800"),
  /* We don't want to overwhelm slow networks (or mirrors whose replies are
   * blocked), but we also don't want to fail if only some mirrors are
   * blackholed. Clients will try 3 directories simultaneously.
   * (Relays never use simultaneous connections.) */
633
  V(ClientBootstrapConsensusMaxInProgressTries, UINT, "3"),
634
635
  /* When a client has any running bridges, check each bridge occasionally,
    * whether or not that bridge is actually up. */
636
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL,
637
638
639
640
641
642
643
    "10800, 25200, 54000, 111600, 262800"),
  /* When a client is just starting, or has no running bridges, check each
   * bridge a few times quickly, and then try again later. These schedules
   * are much longer than the other schedules, because we try each and every
   * configured bridge with this schedule. */
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL,
    "0, 30, 90, 600, 3600, 10800, 25200, 54000, 111600, 262800"),
644
645
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "10 minutes"),
  V(TestingDirConnectionMaxStall, INTERVAL, "5 minutes"),
646
647
648
649
650
651
  OBSOLETE("TestingConsensusMaxDownloadTries"),
  OBSOLETE("ClientBootstrapConsensusMaxDownloadTries"),
  OBSOLETE("ClientBootstrapConsensusAuthorityOnlyMaxDownloadTries"),
  OBSOLETE("TestingDescriptorMaxDownloadTries"),
  OBSOLETE("TestingMicrodescMaxDownloadTries"),
  OBSOLETE("TestingCertMaxDownloadTries"),
652
  V(TestingDirAuthVoteExit, ROUTERSET, NULL),
653
  V(TestingDirAuthVoteExitIsStrict,  BOOL,     "0"),
654
  V(TestingDirAuthVoteGuard, ROUTERSET, NULL),
655
  V(TestingDirAuthVoteGuardIsStrict,  BOOL,     "0"),
656
  V(TestingDirAuthVoteHSDir, ROUTERSET, NULL),
657
  V(TestingDirAuthVoteHSDirIsStrict,  BOOL,     "0"),
658
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "0"),
659

660
  END_OF_CONFIG_VARS
661
};
662

663
664
/** Override default values with these if the user sets the TestingTorNetwork
 * option. */
665
static const config_var_t testing_tor_network_defaults[] = {
666
667
668
669
  V(DirAllowPrivateAddresses,    BOOL,     "1"),
  V(EnforceDistinctSubnets,      BOOL,     "0"),
  V(AssumeReachable,             BOOL,     "1"),
  V(AuthDirMaxServersPerAddr,    UINT,     "0"),
670
671
672
673
674
675
  V(ClientBootstrapConsensusAuthorityDownloadSchedule, CSV_INTERVAL,
    "0, 2, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusFallbackDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
  V(ClientBootstrapConsensusAuthorityOnlyDownloadSchedule, CSV_INTERVAL,
    "0, 1, 4, 4, 4, 4, 4, 4, 4, 4, 4, 4, 8, 16, 32, 60"),
676
  V(ClientDNSRejectInternalAddresses, BOOL,"0"),
677
  V(ClientRejectInternalAddresses, BOOL,   "0"),
678
  V(CountPrivateBandwidth,       BOOL,     "1"),
679
  V(ExitPolicyRejectPrivate,     BOOL,     "0"),
680
  V(ExtendAllowPrivateAddresses, BOOL,     "1"),
681
682
683
  V(V3AuthVotingInterval,        INTERVAL, "5 minutes"),
  V(V3AuthVoteDelay,             INTERVAL, "20 seconds"),
  V(V3AuthDistDelay,             INTERVAL, "20 seconds"),
684
  V(TestingV3AuthInitialVotingInterval, INTERVAL, "150 seconds"),
685
686
687
688
  V(TestingV3AuthInitialVoteDelay, INTERVAL, "20 seconds"),
  V(TestingV3AuthInitialDistDelay, INTERVAL, "20 seconds"),
  V(TestingAuthDirTimeToLearnReachability, INTERVAL, "0 minutes"),
  V(TestingEstimatedDescriptorPropagationTime, INTERVAL, "0 minutes"),
689
  V(MinUptimeHidServDirectoryV2, INTERVAL, "0 minutes"),
690
691
692
693
694
695
696
697
  V(TestingServerDownloadSchedule, CSV_INTERVAL, "0, 0, 0, 5, 10, 15, "
                                 "20, 30, 60"),
  V(TestingClientDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, 15, 20, "
                                 "30, 60"),
  V(TestingServerConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
  V(TestingClientConsensusDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
698
699
700
  V(TestingBridgeDownloadSchedule, CSV_INTERVAL, "10, 30, 60"),
  V(TestingBridgeBootstrapDownloadSchedule, CSV_INTERVAL, "0, 0, 5, 10, "
                                 "15, 20, 30, 60"),
701
702
  V(TestingClientMaxIntervalWithoutRequest, INTERVAL, "5 seconds"),
  V(TestingDirConnectionMaxStall, INTERVAL, "30 seconds"),
703
  V(TestingEnableConnBwEvent,    BOOL,     "1"),
704
  V(TestingEnableCellStatsEvent, BOOL,     "1"),
705
  V(TestingEnableTbEmptyEvent,   BOOL,     "1"),
706
  VAR("___UsingTestNetworkDefaults", BOOL, UsingTestNetworkDefaults_, "1"),
707
  V(RendPostPeriod,              INTERVAL, "2 minutes"),
708

709
  END_OF_CONFIG_VARS
710
};
711

712
#undef VAR
713
#undef V
714
715
#undef OBSOLETE

716
static const config_deprecation_t option_deprecation_notes_[] = {
717
  /* Deprecated since 0.3.2.0-alpha. */
718
719
720
721
  { "HTTPProxy", "It only applies to direct unencrypted HTTP connections "
    "to your directory server, which your Tor probably wasn't using." },
  { "HTTPProxyAuthenticator", "HTTPProxy is deprecated in favor of HTTPSProxy "
    "which should be used with HTTPSProxyAuthenticator." },
722
723
724
  /* End of options deprecated since 0.3.2.1-alpha */

  /* Options deprecated since 0.3.2.2-alpha */
725
726
727
728
  { "ReachableDirAddresses", "It has no effect on relays, and has had no "
    "effect on clients since 0.2.8." },
  { "ClientPreferIPv6DirPort", "It has no effect on relays, and has had no "
    "effect on clients since 0.2.8." },
729
  /* End of options deprecated since 0.3.2.2-alpha. */
730

731
732
733
  { NULL, NULL }
};

734
#ifdef _WIN32
735
736
static char *get_windows_conf_root(void);
#endif
737
738
739
static int options_act_reversible(const or_options_t *old_options, char **msg);
static int options_transition_allowed(const or_options_t *old,
                                      const or_options_t *new,
740
                                      char **msg);
741
742
743
744
static int options_transition_affects_workers(
      const or_options_t *old_options, const or_options_t *new_options);
static int options_transition_affects_descriptor(
      const or_options_t *old_options, const or_options_t *new_options);