config.c 149 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-2007, Roger Dingledine, Nick Mathewson. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
7
const char config_c_id[] = \
  "$Id$";
8

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

14
15
#define CONFIG_PRIVATE

Roger Dingledine's avatar
Roger Dingledine committed
16
#include "or.h"
17
18
19
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
20
#include "../common/aes.h"
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
25
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
  CONFIG_TYPE_UINT,         /**< A non-negative integer less than MAX_INT */
26
27
  CONFIG_TYPE_INTERVAL,     /**< A number of seconds, with optional units*/
  CONFIG_TYPE_MEMUNIT,      /**< A number of bytes, with optional units*/
28
29
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
30
  CONFIG_TYPE_ISOTIME,      /**< An ISO-formated time relative to GMT. */
31
32
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and
                              * optional whitespace. */
33
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
34
35
36
37
38
  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.
                             */
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

Nick Mathewson's avatar
Nick Mathewson committed
54
/* A list of command-line abbreviations. */
55
static config_abbrev_t _option_abbrevs[] = {
56
  PLURAL(ExitNode),
57
  PLURAL(EntryNode),
58
59
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
60
  PLURAL(LongLivedPort),
61
62
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
63
  PLURAL(NumCpu),
64
65
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
66
67
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
68
  { "l", "Log", 1, 0},
69
  { "AllowUnverifiedNodes", "AllowInvalidNodes", 0, 0},
70
71
72
73
  { "BandwidthRateBytes", "BandwidthRate", 0, 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0, 0},
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0, 0},
  { "MaxConn", "ConnLimit", 0, 1},
74
75
76
  { "ORBindAddress", "ORListenAddress", 0, 0},
  { "DirBindAddress", "DirListenAddress", 0, 0},
  { "SocksBindAddress", "SocksListenAddress", 0, 0},
77
78
79
80
  { "UseHelperNodes", "UseEntryGuards", 0, 0},
  { "NumHelperNodes", "NumEntryGuards", 0, 0},
  { "UseEntryNodes", "UseEntryGuards", 0, 0},
  { "NumEntryNodes", "NumEntryGuards", 0, 0},
81
82
  { "ResolvConf", "ServerDNSResolvConfFile", 0, 1},
  { "SearchDomains", "ServerDNSSearchDomains", 0, 1},
83
84
85
86
  { NULL, NULL, 0, 0},
};
/* A list of state-file abbreviations, for compatibility. */
static config_abbrev_t _state_abbrevs[] = {
87
  { "AccountingBytesReadInterval", "AccountingBytesReadInInterval", 0, 0 },
88
89
90
91
92
93
  { "HelperNode", "EntryGuard", 0, 0 },
  { "HelperNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "HelperNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
  { "EntryNode", "EntryGuard", 0, 0 },
  { "EntryNodeDownSince", "EntryGuardDownSince", 0, 0 },
  { "EntryNodeUnlistedSince", "EntryGuardUnlistedSince", 0, 0 },
94
  { NULL, NULL, 0, 0},
95
};
96
#undef PLURAL
97

98
/** A variable allowed in the configuration file or on the command line. */
99
typedef struct config_var_t {
100
  const char *name; /**< The full keyword (case insensitive). */
101
102
  config_type_t type; /**< How to interpret the type and turn it into a
                       * value. */
103
104
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
105
106
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
107
108
109
110
/** 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>"
 */
111
112
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), \
113
      initvalue }
Nick Mathewson's avatar
Nick Mathewson committed
114
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
115
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
116

Nick Mathewson's avatar
Nick Mathewson committed
117
118
119
120
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
121
static config_var_t _option_vars[] = {
122
  OBSOLETE("AccountingMaxKB"),
Roger Dingledine's avatar
Roger Dingledine committed
123
  VAR("AccountingMax",       MEMUNIT,  AccountingMax,        "0 bytes"),
124
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
125
  VAR("Address",             STRING,   Address,              NULL),
126
  VAR("AllowInvalidNodes",   CSV,      AllowInvalidNodes,
127
                                                        "middle,rendezvous"),
128
  VAR("AllowNonRFC953Hostnames", BOOL, AllowNonRFC953Hostnames, "0"),
129
  VAR("AssumeReachable",     BOOL,     AssumeReachable,      "0"),
130
  VAR("AuthDirBadExit",      LINELIST, AuthDirBadExit,       NULL),
131
132
  VAR("AuthDirInvalid",      LINELIST, AuthDirInvalid,       NULL),
  VAR("AuthDirReject",       LINELIST, AuthDirReject,        NULL),
133
  VAR("AuthDirRejectUnlisted",BOOL,    AuthDirRejectUnlisted,"0"),
134
  VAR("AuthDirListBadExits", BOOL,     AuthDirListBadExits,  "0"),
135
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
136
  VAR("AvoidDiskWrites",     BOOL,     AvoidDiskWrites,      "0"),
137
138
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "6 MB"),
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "3 MB"),
139
  VAR("BridgeAuthoritativeDir", BOOL,  BridgeAuthoritativeDir, "0"),
140
  VAR("Bridge",              LINELIST, Bridges,              NULL),
141
142
  VAR("CircuitBuildTimeout", INTERVAL, CircuitBuildTimeout,  "1 minute"),
  VAR("CircuitIdleTimeout",  INTERVAL, CircuitIdleTimeout,   "1 hour"),
143
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
144
  VAR("ConnLimit",           UINT,     ConnLimit,            "1000"),
145
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
146
  VAR("ControlListenAddress",LINELIST, ControlListenAddress, NULL),
147
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
148
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
149
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
150
  OBSOLETE("DebugLogFile"),
151
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
152
  VAR("DirListenAddress",    LINELIST, DirListenAddress,     NULL),
153
  OBSOLETE("DirFetchPeriod"),
154
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
Nick Mathewson's avatar
Nick Mathewson committed
155
  VAR("DirPort",             UINT,     DirPort,              "0"),
156
  OBSOLETE("DirPostPeriod"),
157
  VAR("DirServer",           LINELIST, DirServers,           NULL),
158
  VAR("EnforceDistinctSubnets", BOOL,  EnforceDistinctSubnets,"1"),
159
160
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
Nick Mathewson's avatar
Nick Mathewson committed
161
162
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
163
  VAR("ExitPolicyRejectPrivate", BOOL, ExitPolicyRejectPrivate, "1"),
164
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
165
  VAR("FirewallPorts",       CSV,      FirewallPorts,        ""),
166
  VAR("FastFirstHopPK",      BOOL,     FastFirstHopPK,       "1"),
167
168
  VAR("FetchServerDescriptors",BOOL,   FetchServerDescriptors,"1"),
  VAR("FetchHidServDescriptors",BOOL,  FetchHidServDescriptors, "1"),
169
  VAR("FetchUselessDescriptors",BOOL,  FetchUselessDescriptors, "0"),
170
  VAR("Group",               STRING,   Group,                NULL),
171
  VAR("HardwareAccel",       BOOL,     HardwareAccel,        "0"),
172
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
173
174
175
176
177
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceExcludeNodes", LINELIST_S, RendConfigLines, NULL),
  VAR("HiddenServiceNodes",  LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
178
  VAR("HSAuthoritativeDir",  BOOL,     HSAuthoritativeDir,   "0"),
179
  VAR("HSAuthorityRecordStats",BOOL,   HSAuthorityRecordStats,"0"),
180
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
181
  VAR("HttpProxyAuthenticator",STRING, HttpProxyAuthenticator,NULL),
182
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
183
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
184
  OBSOLETE("IgnoreVersion"),
185
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
186
  VAR("Log",                 LINELIST, Logs,                 NULL),
187
  OBSOLETE("LinkPadding"),
188
189
  OBSOLETE("LogLevel"),
  OBSOLETE("LogFile"),
190
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,
191
                         "21,22,706,1863,5050,5190,5222,5223,6667,6697,8300"),
Nick Mathewson's avatar
Nick Mathewson committed
192
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
193
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"1 GB"),
Nick Mathewson's avatar
Nick Mathewson committed
194
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
195
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
196
  OBSOLETE("MonthlyAccountingStart"),
Nick Mathewson's avatar
Nick Mathewson committed
197
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
198
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
199
  VAR("NamingAuthoritativeDirectory",BOOL, NamingAuthoritativeDir, "0"),
200
201
  VAR("NatdListenAddress",   LINELIST, NatdListenAddress,    NULL),
  VAR("NatdPort",            UINT,     NatdPort,             "0"),
Nick Mathewson's avatar
Nick Mathewson committed
202
203
204
  VAR("Nickname",            STRING,   Nickname,             NULL),
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
205
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
206
  VAR("NumEntryGuards",      UINT,     NumEntryGuards,       "3"),
207
  VAR("ORListenAddress",     LINELIST, ORListenAddress,      NULL),
Nick Mathewson's avatar
Nick Mathewson committed
208
  VAR("ORPort",              UINT,     ORPort,               "0"),
209
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
210
  OBSOLETE("PathlenCoinWeight"),
Nick Mathewson's avatar
Nick Mathewson committed
211
  VAR("PidFile",             STRING,   PidFile,              NULL),
212
  VAR("PreferTunneledDirConns", BOOL,  PreferTunneledDirConns, "0"),
213
  VAR("ProtocolWarnings",    BOOL,     ProtocolWarnings,     "0"),
214
  VAR("PublishServerDescriptor", CSV,  PublishServerDescriptor,"v1,v2"),
215
  VAR("PublishHidServDescriptors",BOOL,PublishHidServDescriptors, "1"),
216
  VAR("ReachableAddresses",  LINELIST, ReachableAddresses,   NULL),
217
218
  VAR("ReachableDirAddresses",LINELIST,ReachableDirAddresses,NULL),
  VAR("ReachableORAddresses",LINELIST, ReachableORAddresses, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
219
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
220
221
  VAR("RecommendedClientVersions", LINELIST, RecommendedClientVersions,  NULL),
  VAR("RecommendedServerVersions", LINELIST, RecommendedServerVersions,  NULL),
222
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
223
224
  VAR("RelayBandwidthBurst", MEMUNIT,  RelayBandwidthBurst,  "0"),
  VAR("RelayBandwidthRate",  MEMUNIT,  RelayBandwidthRate,   "0"),
Nick Mathewson's avatar
Nick Mathewson committed
225
226
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
227
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "1 hour"),
228
  VAR("RephistTrackTime",    INTERVAL, RephistTrackTime,     "24 hours"),
229
  OBSOLETE("RouterFile"),
230
231
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
232
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
233
  VAR("SafeSocks",           BOOL,     SafeSocks,            "0"),
234
235
  VAR("ServerDNSAllowNonRFC953Hostnames",
                             BOOL,     ServerDNSAllowNonRFC953Hostnames, "0"),
236
  VAR("ServerDNSDetectHijacking",BOOL,   ServerDNSDetectHijacking,"1"),
237
238
  VAR("ServerDNSResolvConfFile", STRING, ServerDNSResolvConfFile, NULL),
  VAR("ServerDNSSearchDomains",  BOOL,   ServerDNSSearchDomains,  "0"),
239
240
  VAR("ServerDNSTestAddresses",  CSV,    ServerDNSTestAddresses,
      "www.google.com,www.mit.edu,www.yahoo.com,www.slashdot.org"),
241
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
242
  VAR("SocksListenAddress",  LINELIST, SocksListenAddress,   NULL),
243
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
Nick Mathewson's avatar
Nick Mathewson committed
244
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
245
  VAR("SocksTimeout",        INTERVAL, SocksTimeout,         "2 minutes"),
246
  OBSOLETE("StatusFetchPeriod"),
Nick Mathewson's avatar
Nick Mathewson committed
247
248
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
249
  OBSOLETE("SysLog"),
250
  VAR("TestSocks",           BOOL,     TestSocks,            "0"),
251
  VAR("TestVia",             STRING,   TestVia,              NULL),
Nick Mathewson's avatar
Nick Mathewson committed
252
253
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
254
  OBSOLETE("TrafficShaping"),
255
256
  VAR("TransListenAddress",  LINELIST, TransListenAddress,   NULL),
  VAR("TransPort",           UINT,     TransPort,            "0"),
257
  VAR("TunnelDirConns",      BOOL,     TunnelDirConns,       "0"),
258
  VAR("UseBridges",          BOOL,     UseBridges,           "0"),
259
  VAR("UseEntryGuards",      BOOL,     UseEntryGuards,       "1"),
Nick Mathewson's avatar
Nick Mathewson committed
260
  VAR("User",                STRING,   User,                 NULL),
261
  VAR("V1AuthoritativeDirectory",BOOL, V1AuthoritativeDir,   "0"),
262
  VAR("V2AuthoritativeDirectory",BOOL, V2AuthoritativeDir,   "0"),
263
  VAR("VersioningAuthoritativeDirectory",BOOL,VersioningAuthoritativeDir, "0"),
264
  VAR("VirtualAddrNetwork",  STRING,   VirtualAddrNetwork,   "127.192.0.0/10"),
265
266
  VAR("__AllDirActionsPrivate",BOOL,   AllDirActionsPrivate, "0"),
  VAR("__DisablePredictedCircuits",BOOL,DisablePredictedCircuits,"0"),
267
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
268

269
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
270
};
271
272
#undef VAR

273
274
#define VAR(name,conftype,member,initvalue)                             \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_state_t, member),  \
275
      initvalue }
276
static config_var_t _state_vars[] = {
277
  VAR("AccountingBytesReadInInterval", MEMUNIT,
278
      AccountingBytesReadInInterval, NULL),
279
280
281
  VAR("AccountingBytesWrittenInInterval", MEMUNIT,
      AccountingBytesWrittenInInterval, NULL),
  VAR("AccountingExpectedUsage", MEMUNIT,     AccountingExpectedUsage, NULL),
282
  VAR("AccountingIntervalStart", ISOTIME,     AccountingIntervalStart, NULL),
Nick Mathewson's avatar
Nick Mathewson committed
283
  VAR("AccountingSecondsActive", INTERVAL,    AccountingSecondsActive, NULL),
284
285
286
287
  VAR("EntryGuard",              LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardDownSince",     LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuardUnlistedSince", LINELIST_S,  EntryGuards,             NULL),
  VAR("EntryGuards",             LINELIST_V,  EntryGuards,             NULL),
Nick Mathewson's avatar
Nick Mathewson committed
288

289
  VAR("BWHistoryReadEnds",       ISOTIME,     BWHistoryReadEnds,      NULL),
290
291
  VAR("BWHistoryReadInterval",   UINT,        BWHistoryReadInterval,  "900"),
  VAR("BWHistoryReadValues",     CSV,         BWHistoryReadValues,    ""),
292
  VAR("BWHistoryWriteEnds",      ISOTIME,     BWHistoryWriteEnds,     NULL),
293
294
  VAR("BWHistoryWriteInterval",  UINT,        BWHistoryWriteInterval, "900"),
  VAR("BWHistoryWriteValues",    CSV,         BWHistoryWriteValues,   ""),
295

296
297
  VAR("TorVersion",              STRING,      TorVersion,             NULL),

298
  VAR("LastRotatedOnionKey",     ISOTIME,     LastRotatedOnionKey,    NULL),
299
300
  VAR("LastWritten",             ISOTIME,     LastWritten,            NULL),

301
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
302
303
};

304
305
306
#undef VAR
#undef OBSOLETE

307
308
/** Represents an English description of a configuration variable; used when
 * generating configuration file comments. */
309
310
311
312
313
314
typedef struct config_var_description_t {
  const char *name;
  const char *description;
} config_var_description_t;

static config_var_description_t options_description[] = {
315
  /* ==== general options */
316
317
  { "AvoidDiskWrites", "If non-zero, try to write to disk less frequently than"
    " we would otherwise." },
318
319
320
321
322
323
324
325
326
327
328
329
  { "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." },
  { "ConnLimit", "Maximum number of simultaneous sockets allowed." },
  /*  ControlListenAddress */
  { "ControlPort", "If set, Tor will accept connections from the same machine "
    "(localhost only) on this port, and allow those connections to control "
    "the Tor process using the Tor Control Protocol (described in"
    "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 "
330
    "can read a file that Tor creates in its data directory." },
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
  { "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 */
  { "Group", "On startup, setgid to this group." },
  { "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 "
355
    "provided IP address (only useful for multiple network interfaces)." },
356
357
  { "PIDFile", "On startup, write our PID to this file. On clean shutdown, "
    "remove the file." },
358
359
  { "PreferTunneledDirConns", "If non-zero, avoid directory servers that "
    "don't support tunneled conncetions." },
360
  /* PreferTunneledDirConns */
361
362
363
364
365
366
  /* 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]." },
367
368
369
  { "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." },
370
371
372
373
374
  { "User", "On startup, setuid to this user" },

  /* ==== client options */
  { "AllowInvalidNodes", "Where on our circuits should Tor allow servers "
    "that the directory authorities haven't called \"valid\"?" },
375
376
  { "AllowNonRFC953Hostnames", "If set to 1, we don't automatically reject "
    "hostnames for having invalid characters." },
377
378
  /*  CircuitBuildTimeout, CircuitIdleTimeout */
  { "ClientOnly", "If set to 1, Tor will under no circumstances run as a "
379
    "server, even if ORPort is enabled." },
380
  { "EntryNodes", "A list of preferred entry nodes to use for the first hop "
381
    "in circuits, when possible." },
382
383
384
385
386
  /* { "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 "
387
388
    "servers running on the ports listed in FirewallPorts." },
  { "FirewallPorts", "A list of ports that we can connect to.  Only used "
389
390
    "when FascistFirewall is set." },
  { "LongLivedPorts", "A list of ports for services that tend to require "
391
    "high-uptime connections." },
392
393
394
  { "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 "
395
    "every NUM seconds." },
396
  { "MaxCircuitDirtiness", "Do not attach new streams to a circuit that has "
397
    "been used more than this many seconds ago." },
398
399
400
401
402
403
404
405
406
  /* 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. */
  { "RendNodes", "A list of preferred nodes to use for a rendezvous point, "
407
    "when possible." },
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
  { "RendExcludenodes", "A list of nodes never to use as rendezvous points." },
  /* 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 "
423
    "accessed from the same exit node each time we connect to them." },
424
425
426
427
  { "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 "
428
429
    "servers for the first position in each circuit, rather than picking a "
    "set of 'Guards' to prevent profiling attacks." },
430
431

  /* === server options */
432
  { "Address", "The advertised (external) address we should use." },
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
  /* 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." },
449
  { "NoPublish", "{DEPRECATED}" },
450
451
452
453
454
  { "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." },
455
  { "PublishServerDescriptors", "Set to \"\" to keep the server from "
456
    "uploading info to the directory authorities." },
457
458
459
460
461
462
463
464
  /*{ "RedirectExit", "When an outgoing connection tries to connect to a "
   *"given address, redirect it to another address instead." },
   */
  /* ServerDNS: DetectHijacking, ResolvConfFile, SearchDomains */
  { "ShutdownWaitLength", "Wait this long for clients to finish when "
    "shutting down because of a SIGINT." },
  /* { "TestVia", } */

465
  /* === directory cache options */
466
467
  { "DirPort", "Serve directory information from this port, and act as a "
    "directory cache." },
468
  { "DirListenAddress", "Bind to this address to listen for connections from "
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
    "clients and servers, instead of the default 0.0.0.0:DirPort." },
  { "DirPolicy", "Set a policy to limit who can connect to the directory "
    "port" },

  /*  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 */
484
485
486
487
  { NULL, NULL },
};

static config_var_description_t state_description[] = {
488
  { "AccountingBytesReadInInterval",
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
    "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." },

504
505
  { "EntryGuard", "One of the nodes we have chosen as a fixed entry" },
  { "EntryGuardDownSince",
506
    "The last entry guard has been unreachable since this time." },
507
  { "EntryGuardUnlistedSince",
508
    "The last entry guard has been unusable since this time." },
509
510
511
  { "LastRotatedOnionKey",
    "The last time at which we changed the medium-term private key used for "
    "building circuits." },
512
513
514
  { "LastWritten", "When was this state file last regenerated?" },

  { "TorVersion", "Which version of Tor generated this state file?" },
515
516
517
  { NULL, NULL },
};

518
/** Type of a callback to validate whether a given configuration is
Roger Dingledine's avatar
Roger Dingledine committed
519
 * well-formed and consistent. See options_trial_assign() for documentation
520
 * of arguments. */
521
typedef int (*validate_fn_t)(void*,void*,int,char**);
522

523
524
525
/** Information on the keys, value types, key-to-struct-member mappings,
 * variable descriptions, validation functions, and abbreviations for a
 * configuration or storage format. */
526
typedef struct {
527
528
529
  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
530
  off_t magic_offset; /**< Offset of the magic value within the struct. */
531
  config_abbrev_t *abbrevs; /**< List of abbreviations that we expand when
Roger Dingledine's avatar
Roger Dingledine committed
532
                             * parsing this format. */
533
534
535
536
  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. */
537
  config_var_description_t *descriptions;
Roger Dingledine's avatar
Roger Dingledine committed
538
539
540
  /** If present, extra is a LINELIST variable for unrecognized
   * lines.  Otherwise, unrecognized lines are an error. */
  config_var_t *extra;
541
542
} config_format_t;

543
544
/** Macro: assert that <b>cfg</b> has the right magic field for format
 * <b>fmt</b>. */
545
546
#define CHECK(fmt, cfg) do {                                            \
    tor_assert(fmt && cfg);                                             \
547
    tor_assert((fmt)->magic ==                                          \
548
               *(uint32_t*)STRUCT_VAR_P(cfg,fmt->magic_offset));        \
549
550
  } while (0)

551
static void config_line_append(config_line_t **lst,
552
                               const char *key, const char *val);
553
554
static void option_clear(config_format_t *fmt, or_options_t *options,
                         config_var_t *var);
555
static void option_reset(config_format_t *fmt, or_options_t *options,
556
                         config_var_t *var, int use_defaults);
557
static void config_free(config_format_t *fmt, void *options);
558
static int option_is_same(config_format_t *fmt,
559
560
                          or_options_t *o1, or_options_t *o2,
                          const char *name);
561
static or_options_t *options_dup(config_format_t *fmt, or_options_t *old);
562
563
564
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);
565
static int options_act(or_options_t *old_options);
566
567
static int options_transition_allowed(or_options_t *old, or_options_t *new,
                                      char **msg);
568
569
570
571
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);
572
static int check_nickname_list(const char *lst, const char *name, char **msg);
573
static void config_register_addressmaps(or_options_t *options);
574

575
static int parse_bridge_line(const char *line, int validate_only);
576
static int parse_dir_server_line(const char *line, int validate_only);
577
static int parse_redirect_line(smartlist_t *result,
578
                               config_line_t *line, char **msg);
579
580
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
581
static int validate_data_directory(or_options_t *options);
582
static int write_configuration_file(const char *fname, or_options_t *options);
583
static config_line_t *get_assigned_option(config_format_t *fmt,
584
                                     or_options_t *options, const char *key);
585
static void config_init(config_format_t *fmt, void *options);
586
static int or_state_validate(or_state_t *old_options, or_state_t *options,
587
                             int from_setconf, char **msg);
588

589
590
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
591
static void print_svn_version(void);
592
static void init_libevent(void);
593
static int opt_streq(const char *s1, const char *s2);
594
/** Versions of libevent. */
595
typedef enum {
596
597
  /* Note: we compare these, so it's important that "old" precede everything,
   * and that "other" come last. */
598
  LE_OLD=0, LE_10C, LE_10D, LE_10E, LE_11, LE_11A, LE_11B, LE_12, LE_12A,
599
  LE_13, LE_13A,
600
  LE_OTHER
601
602
} le_version_t;
static le_version_t decode_libevent_version(void);
603
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
604
static void check_libevent_version(const char *m, int server);
605
#endif
606

607
/** Magic value for or_options_t. */
608
609
#define OR_OPTIONS_MAGIC 9090909

610
/** Configuration format for or_options_t. */
611
static config_format_t options_format = {
612
613
614
  sizeof(or_options_t),
  OR_OPTIONS_MAGIC,
  STRUCT_OFFSET(or_options_t, _magic),
615
616
617
  _option_abbrevs,
  _option_vars,
  (validate_fn_t)options_validate,
618
619
  options_description,
  NULL
620
621
};

622
/** Magic value for or_state_t. */
623
624
#define OR_STATE_MAGIC 0x57A73f57

625
626
/** "Extra" variable in the state that receives lines we can't parse. This
 * lets us preserve options from versions of Tor newer than us. */
627
628
629
630
static config_var_t state_extra_var = {
  "__extra", CONFIG_TYPE_LINELIST, STRUCT_OFFSET(or_state_t, ExtraLines), NULL
};

631
/** Configuration format for or_state_t. */
632
633
634
635
static config_format_t state_format = {
  sizeof(or_state_t),
  OR_STATE_MAGIC,
  STRUCT_OFFSET(or_state_t, _magic),
636
  _state_abbrevs,
637
638
  _state_vars,
  (validate_fn_t)or_state_validate,
639
640
  state_description,
  &state_extra_var,
641
642
};

643
644
645
646
647
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
648
static or_options_t *global_options = NULL;
Roger Dingledine's avatar
Roger Dingledine committed
649
/** Name of most recently read torrc file. */
650
static char *torrc_fname = NULL;
651
/** Persistent serialized state. */
652
static or_state_t *global_state = NULL;
653

654
/** Allocate an empty configuration object of a given format type. */
655
656
657
static void *
config_alloc(config_format_t *fmt)
{
658
  void *opts = tor_malloc_zero(fmt->size);
659
  *(uint32_t*)STRUCT_VAR_P(opts, fmt->magic_offset) = fmt->magic;
660
661
662
663
  CHECK(fmt, opts);
  return opts;
}

664
665
/** Return the currently configured options. */
or_options_t *
666
667
get_options(void)
{
668
669
670
  tor_assert(global_options);
  return global_options;
}
671

672
673
674
/** 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
 * as necessary.
675
 */
676
int
677
set_options(or_options_t *new_val, char **msg)
678
{
679
  or_options_t *old_options = global_options;
680
  global_options = new_val;
681
682
  /* Note that we pass the *old* options below, for comparison. It
   * pulls the new options directly out of global_options. */
683
684
  if (options_act_reversible(old_options, msg)<0) {
    tor_assert(*msg);
685
686
687
    global_options = old_options;
    return -1;
  }
688
  if (options_act(old_options) < 0) { /* acting on the options failed. die. */
689
    log_err(LD_BUG,
Roger Dingledine's avatar
Roger Dingledine committed
690
            "Acting on config options left us in a broken state. Dying.");
691
692
693
    exit(1);
  }
  if (old_options)
694
    config_free(&options_format, old_options);
695
696

  return 0;
697
698
}

699
700
/** Release all memory and resources held by global configuration structures.
 */
701
702
703
void
config_free_all(void)
{
704
705
706
707
708
709
710
711
  if (global_options) {
    config_free(&options_format, global_options);
    global_options = NULL;
  }
  if (global_state) {
    config_free(&state_format, global_state);
    global_state = NULL;
  }
712
  tor_free(torrc_fname);
713
714
}

715
716
717
718
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
719
720
safe_str(const char *address)
{
721
722
723
724
725
726
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

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

739
740
741
742
/** Add the default directory servers directly into the trusted dir list. */
static void
add_default_trusted_dirservers(void)
{
743
  int i;
744
  const char *dirservers[] = {
745
    /* eventually we should mark moria1 as "v1only" */
746
    "moria1 v1 orport=9001 18.244.0.188:9031 "
747
      "FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441",
748
    "moria2 v1 orport=443 18.244.0.114:80 "
749
      "719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF",
750
    "tor26 v1 orport=443 86.59.21.38:80 "
751
      "847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D",
752
    "lefkada orport=443 140.247.60.64:80 "
753
      "38D4 F5FC F7B1 0232 28B8 95EA 56ED E7D5 CCDC AF32",
754
755
    "dizum 194.109.206.212:80 "
      "7EA6 EAD6 FD83 083C 538F 4403 8BBF A077 587D D755",
756
    NULL
757
  };
758
759
  for (i=0; dirservers[i]; i++)
    parse_dir_server_line(dirservers[i], 0);
760
761
}

762
763
764
765
766
767
768
/** Fetch the active option list, and take actions based on it. All of the
 * things we do should survive being done repeatedly.  If present,
 * <b>old_options</b> contains the previous value of the options.
 *
 * Return 0 if all goes well, return -1 if things went badly.
 */
static int
769
options_act_reversible(or_options_t *old_options, char **msg)
770
771
772
773
774
775
776
777
{
  smartlist_t *new_listeners = smartlist_create();
  smartlist_t *replaced_listeners = smartlist_create();
  static int libevent_initialized = 0;
  or_options_t *options = get_options();
  int running_tor = options->command == CMD_RUN_TOR;
  int set_conn_limit = 0;
  int r = -1;
778
  int logs_marked = 0;
779
780
781
782
783
784
785
786
787
788

  if (running_tor && options->RunAsDaemon) {
    /* No need to roll back, since you can't change the value. */
    start_daemon();
  }

  /* Setuid/setgid as appropriate */
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
      /* No need to roll back, since you can't change the value. */
789
790
      *msg = tor_strdup("Problem with User or Group value. "
                        "See logs for details.");
791
792
793
794
795
796
      goto done;
    }
  }

  /* Set up libevent. */
  if (running_tor && !libevent_initialized) {
797
    init_libevent();
798
799
800
801
802
    libevent_initialized = 1;
  }

  /* Ensure data directory is private; create if possible. */
  if (check_private_dir(options->DataDirectory, CPD_CREATE)<0) {
803
804
805
806
807
    char buf[1024];
    int tmp = tor_snprintf(buf, sizeof(buf),
              "Couldn't access/create private data directory \"%s\"",
              options->DataDirectory);
    *msg = tor_strdup(tmp >= 0 ? buf : "internal error");
808
    goto done;
809
    /* No need to roll back, since you can't change the value. */
810
811
812
  }

  /* Bail out at this point if we're not going to be a client or server:
813
   * we don't run Tor itself. */
814
815
816
817
818
  if (options->command != CMD_RUN_TOR)
    goto commit;

  options->_ConnLimit =
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
819
820
  if (options->_ConnLimit < 0) {
    *msg = tor_strdup("Problem with ConnLimit value. See logs for details.");
821
    goto rollback;
822
  }
823
824
825
  set_conn_limit = 1;

  if (retry_all_listeners(0, replaced_listeners, new_listeners) < 0) {
826
    *msg = tor_strdup("Failed to bind one of the listener ports.");
827
828
829
    goto rollback;
  }

830
831
  mark_logs_temp(); /* Close current logs once new logs are open. */
  logs_marked = 1;
832
833
  if (options_init_logs(options, 0)<0) { /* Configure the log(s) */
    *msg = tor_strdup("Failed to init Log options. See logs for details.");
834
    goto rollback;
835
  }
836

837
838
 commit:
  r = 0;
839
840
841
842
843
  if (logs_marked) {
    close_temp_logs();
    add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
    control_adjust_event_log_severity();
  }
844
845
  SMARTLIST_FOREACH(replaced_listeners, connection_t *, conn,
  {
Roger Dingledine's avatar
Roger Dingledine committed
846
847
    log_notice(LD_NET, "Closing old %s on %s:%d",
               conn_type_to_string(conn->type), conn->address, conn->port);
848
849
850
851
852
853
854
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });
  goto done;

 rollback:
  r = -1;
855
  tor_assert(*msg);
856

857
858
859
860
861
  if (logs_marked) {
    rollback_log_changes();
    control_adjust_event_log_severity();
  }

862
863
864
865
866
  if (set_conn_limit && old_options)
    set_max_file_descriptors((unsigned)old_options->ConnLimit,MAXCONNECTIONS);

  SMARTLIST_FOREACH(new_listeners, connection_t *, conn,
  {
867
    log_notice(LD_NET, "Closing partially-constructed listener %s on %s:%d",
Roger Dingledine's avatar
Roger Dingledine committed
868
               conn_type_to_string(conn->type), conn->address, conn->port);
869
870
871
872
873
874
875
876
877
878
    connection_close_immediate(conn);
    connection_mark_for_close(conn);
  });

 done:
  smartlist_free(new_listeners);
  smartlist_free(replaced_listeners);
  return r;
}

879
880
881
/** Fetch the active option list, and take actions based on it. All of the
 * things we do should survive being done repeatedly.  If present,
 * <b>old_options</b> contains the previous value of the options.
882
 *
883
 * Return 0 if all goes well, return -1 if it's time to die.