config.c 82 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
/* Copyright 2001 Matej Pfajfar.
 * Copyright 2001-2004 Roger Dingledine.
Nick Mathewson's avatar
Nick Mathewson committed
3
 * Copyright 2004-2005 Roger Dingledine, Nick Mathewson. */
4
5
/* See LICENSE for licensing information */
/* $Id$ */
6
const char config_c_id[] = "$Id$";
7

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

Roger Dingledine's avatar
Roger Dingledine committed
14
#include "or.h"
15
16
17
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
18
#include "../common/aes.h"
Roger Dingledine's avatar
Roger Dingledine committed
19

Nick Mathewson's avatar
Nick Mathewson committed
20
21
/** Enumeration of types which option values can take */
typedef enum config_type_t {
22
23
  CONFIG_TYPE_STRING = 0,   /**< An arbitrary string. */
  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
28
29
30
  CONFIG_TYPE_DOUBLE,       /**< A floating-point value */
  CONFIG_TYPE_BOOL,         /**< A boolean value, expressed as 0 or 1. */
  CONFIG_TYPE_CSV,          /**< A list of strings, separated by commas and optional
                              * whitespace. */
  CONFIG_TYPE_LINELIST,     /**< Uninterpreted config lines */
31
32
33
34
35
  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.
                             */
36
  CONFIG_TYPE_OBSOLETE,     /**< Obsolete (ignored) option. */
Nick Mathewson's avatar
Nick Mathewson committed
37
} config_type_t;
38

Nick Mathewson's avatar
Nick Mathewson committed
39
/* An abbreviation for a configuration option allowed on the command line */
40
typedef struct config_abbrev_t {
41
42
  const char *abbreviated;
  const char *full;
43
  int commandline_only;
44
45
} config_abbrev_t;

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

Nick Mathewson's avatar
Nick Mathewson committed
50
/* A list of command-line abbreviations. */
51
static config_abbrev_t config_abbrevs[] = {
52
  PLURAL(ExitNode),
53
  PLURAL(EntryNode),
54
55
  PLURAL(ExcludeNode),
  PLURAL(FirewallPort),
56
  PLURAL(LongLivedPort),
57
58
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
59
  PLURAL(NumCpu),
60
61
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
62
63
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
64
  { "l", "Log", 1},
65
66
  { "BandwidthRateBytes", "BandwidthRate", 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0},
67
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0},
68
  { "MaxConn", "ConnLimit", 0},
69
  { NULL, NULL , 0},
70
};
71
#undef PLURAL
72

73
/** A variable allowed in the configuration file or on the command line. */
74
typedef struct config_var_t {
75
76
77
78
  const char *name; /**< The full keyword (case insensitive). */
  config_type_t type; /**< How to interpret the type and turn it into a value. */
  off_t var_offset; /**< Offset of the corresponding member of or_options_t. */
  const char *initvalue; /**< String (or null) describing initial value. */
79
80
} config_var_t;

Nick Mathewson's avatar
Nick Mathewson committed
81
/** Return the offset of <b>member</b> within the type <b>tp</b>, in bytes */
Nick Mathewson's avatar
Nick Mathewson committed
82
#define STRUCT_OFFSET(tp, member) ((off_t) (((char*)&((tp*)0)->member)-(char*)0))
Nick Mathewson's avatar
Nick Mathewson committed
83
84
85
86
/** 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>"
 */
87
88
#define VAR(name,conftype,member,initvalue) \
  { name, CONFIG_TYPE_ ## conftype, STRUCT_OFFSET(or_options_t, member), initvalue }
Nick Mathewson's avatar
Nick Mathewson committed
89
/** An entry for config_vars: "The option <b>name</b> is obsolete." */
90
#define OBSOLETE(name) { name, CONFIG_TYPE_OBSOLETE, 0, NULL }
91

Nick Mathewson's avatar
Nick Mathewson committed
92
93
94
95
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
96
static config_var_t config_vars[] = {
97
  VAR("Address",             STRING,   Address,              NULL),
98
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
99
  VAR("AllowUnverifiedNodes",CSV,      AllowUnverifiedNodes, "middle,rendezvous"),
100
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
101
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "2 MB"),
102
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "5 MB"),
103
  VAR("MaxAdvertisedBandwidth",MEMUNIT,MaxAdvertisedBandwidth,"128 TB"),
104
105
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
106
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
107
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
108
109
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
110
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
111
112
  VAR("DirPort",             UINT,     DirPort,              "0"),
  VAR("DirBindAddress",      LINELIST, DirBindAddress,       NULL),
113
114
  /** DOCDOC **/
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "0 seconds"),
115
116
  VAR("DirPostPeriod",       INTERVAL, DirPostPeriod,        "20 minutes"),
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "20 minutes"),
117
118
119
120
121
122
123
124
  VAR("DirPolicy",           LINELIST, DirPolicy,            NULL),
  VAR("DirServer",           LINELIST, DirServers,           NULL),
  VAR("ExitNodes",           STRING,   ExitNodes,            NULL),
  VAR("EntryNodes",          STRING,   EntryNodes,           NULL),
  VAR("StrictExitNodes",     BOOL,     StrictExitNodes,      "0"),
  VAR("StrictEntryNodes",    BOOL,     StrictEntryNodes,     "0"),
  VAR("ExitPolicy",          LINELIST, ExitPolicy,           NULL),
  VAR("ExcludeNodes",        STRING,   ExcludeNodes,         NULL),
125
126
  VAR("TrackHostExits",      CSV,      TrackHostExits,       NULL),
  VAR("TrackHostExitsExpire",INTERVAL, TrackHostExitsExpire, "30 minutes"),
127
  VAR("MapAddress",          LINELIST, AddressMap,           NULL),
128
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
129
  VAR("FirewallPorts",       CSV,      FirewallPorts,        "80,443"),
130
131
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
Roger Dingledine's avatar
Roger Dingledine committed
132
  VAR("NoPublish",           BOOL,     NoPublish,            "0"),
133
  VAR("Group",               STRING,   Group,                NULL),
134
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
135
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
136
  VAR("HttpsProxy",          STRING,   HttpsProxy,           NULL),
137
  VAR("HttpsProxyAuthenticator",STRING,HttpsProxyAuthenticator,NULL),
138
139
140
141
142
  VAR("HiddenServiceOptions",LINELIST_V, RendConfigLines,    NULL),
  VAR("HiddenServiceDir",    LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServicePort",   LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceNodes",  LINELIST_S, RendConfigLines,    NULL),
  VAR("HiddenServiceExcludeNodes", LINELIST_S, RendConfigLines, NULL),
143
  VAR("IgnoreVersion",       BOOL,     IgnoreVersion,        "0"),
144
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
145
146
147
  VAR("Log",                 LINELIST, Logs,                 NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
148
  OBSOLETE("LinkPadding"),
149
  VAR("ConnLimit",           UINT,     ConnLimit,            "1024"),
150
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
151
  VAR("MonthlyAccountingStart",UINT,   _MonthlyAccountingStart,"0"),
152
153
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
  VAR("AccountingMax",       MEMUNIT,   AccountingMax,        "0 bytes"),
154
  VAR("Nickname",            STRING,   Nickname,             NULL),
155
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
156
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
157
158
159
160
161
  VAR("NumCpus",             UINT,     NumCpus,              "1"),
  VAR("ORPort",              UINT,     ORPort,               "0"),
  VAR("ORBindAddress",       LINELIST, ORBindAddress,        NULL),
  VAR("OutboundBindAddress", STRING,   OutboundBindAddress,  NULL),
  VAR("PidFile",             STRING,   PidFile,              NULL),
162
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,       "21,22,706,1863,5050,5190,5222,5223,6667,8300,8888"),
163
164
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
165
  OBSOLETE("RouterFile"),
166
167
168
169
170
  VAR("RunAsDaemon",         BOOL,     RunAsDaemon,          "0"),
  VAR("RunTesting",          BOOL,     RunTesting,           "0"),
  VAR("RecommendedVersions", LINELIST, RecommendedVersions,  NULL),
  VAR("RendNodes",           STRING,   RendNodes,            NULL),
  VAR("RendExcludeNodes",    STRING,   RendExcludeNodes,     NULL),
171
  VAR("SafeLogging",         BOOL,     SafeLogging,          "1"),
172
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
173
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
174
175
  VAR("SocksBindAddress",    LINELIST, SocksBindAddress,     NULL),
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
176
177
  /** DOCDOC */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "0 seconds"),
178
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
179
  OBSOLETE("TrafficShaping"),
180
  VAR("User",                STRING,   User,                 NULL),
181
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
182
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
183
184
185
186
};
#undef VAR
#undef OBSOLETE

Nick Mathewson's avatar
Nick Mathewson committed
187
/** Largest allowed config line */
188
#define CONFIG_LINE_T_MAXLEN 4096
189

190
191
static void config_line_append(struct config_line_t **lst,
                               const char *key, const char *val);
192
193
static void option_reset(or_options_t *options, config_var_t *var);
static void options_free(or_options_t *options);
194
static int option_is_same(or_options_t *o1, or_options_t *o2,const char *name);
195
196
197
198
static or_options_t *options_dup(or_options_t *old);
static int options_validate(or_options_t *options);
static int options_transition_allowed(or_options_t *old, or_options_t *new);
static int check_nickname_list(const char *lst, const char *name);
199
static void config_register_addressmaps(or_options_t *options);
200

201
static int parse_dir_server_line(const char *line, int validate_only);
202
static int parse_redirect_line(smartlist_t *result,
Roger Dingledine's avatar
Roger Dingledine committed
203
                               struct config_line_t *line);
204
205
206
207
208
209
210
211
212
static int parse_log_severity_range(const char *range, int *min_out,
                                    int *max_out);
static int convert_log_option(or_options_t *options,
                              struct config_line_t *level_opt,
                              struct config_line_t *file_opt, int isDaemon);
static int add_single_log_option(or_options_t *options, int minSeverity,
                                 int maxSeverity,
                                 const char *type, const char *fname);
static int normalize_log_options(or_options_t *options);
213
static int validate_data_directory(or_options_t *options);
214
static int write_configuration_file(const char *fname, or_options_t *options);
215

216
217
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
218
static void print_cvs_version(void);
219

220
221
222
223
224
225
/*
 * Functions to read and write the global options pointer.
 */

/** Command-line and config-file options. */
static or_options_t *global_options=NULL;
Roger Dingledine's avatar
Roger Dingledine committed
226
/** Name of most recently read torrc file. */
227
static char *config_fname = NULL;
228

229
230
231
/** Return the currently configured options. */
or_options_t *
get_options(void) {
232
233
234
  tor_assert(global_options);
  return global_options;
}
235

Roger Dingledine's avatar
Roger Dingledine committed
236
/** Change the current global options to contain <b>new_val</b> instead
237
 * of their current value; free the old value as necessary.
238
239
240
241
242
243
 */
void
set_options(or_options_t *new_val) {
  if (global_options)
    options_free(global_options);
  global_options = new_val;
244
245
}

246
247
248
249
250
251
252
void
config_free_all(void)
{
  options_free(global_options);
  tor_free(config_fname);
}

253
254
255
256
257
258
259
260
261
262
263
/** If options->SafeLogging is on, return a not very useful string,
 * else return address.
 */
const char *
safe_str(const char *address) {
  if (get_options()->SafeLogging)
    return "[scrubbed]";
  else
    return address;
}

264
265
266
/** Fetch the active option list, and take actions based on it. All
 * of the things we do should survive being done repeatedly.
 * Return 0 if all goes well, return -1 if it's time to die.
267
268
269
270
271
272
 *
 * Note 1: <b>new_val</b> must have previously been validated with
 * options_validate(), or Tor may freak out and exit.
 *
 * Note 2: We haven't moved all the "act on new configuration" logic
 * here yet.  Some is still in do_hup() and other places.
273
274
275
276
277
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
278
279
280
281
282
283
  static int libevent_initialized = 0;

  /* XXXX009 We once had a reason to separate start_daemon and finish_daemon:
   *    It let us have the parent process stick around until we were sure Tor
   *    was started.  Should we make start_daemon get called earlier? -NM */
  if (options->RunAsDaemon) {
284
    start_daemon();
285
286
  }
  if (!libevent_initialized) {
287
    configure_libevent_logging();
Nick Mathewson's avatar
Nick Mathewson committed
288
289
290
    /* If the kernel complains that some method (say, epoll) doesn't
     * exist, we don't care about it, since libevent will cope.
     */
291
    suppress_libevent_log_msg("Function not implemented");
292
    event_init();
293
    suppress_libevent_log_msg(NULL);
294
295
296
#if defined(HAVE_EVENT_GET_VERSION) && defined(HAVE_EVENT_GET_METHOD)
    /* Making this a NOTICE for now so we can link bugs to a libevent versions
     * or methods better. */
Roger Dingledine's avatar
Roger Dingledine committed
297
    log(LOG_NOTICE, "Initialized libevent version %s using method %s",
298
299
           event_get_version(), event_get_method());
#else
Roger Dingledine's avatar
Roger Dingledine committed
300
    log(LOG_NOTICE, "Initialized old libevent (version 1.0b or earlier)");
301
#endif
302
303
    libevent_initialized = 1;
  }
304
305

  clear_trusted_dir_servers();
306
  for (cl = options->DirServers; cl; cl = cl->next) {
307
308
    if (parse_dir_server_line(cl->value, 0)<0) {
      log_fn(LOG_ERR,
309
             "Bug: Previously validated DirServer line could not be added!");
310
      return -1;
311
312
313
    }
  }

314
  if (rend_config_services(options, 0)<0) {
315
    log_fn(LOG_ERR,
316
           "Bug: Previously validated hidden services line could not be added!");
317
    return -1;
318
  }
319
320

  /* Setuid/setgid as appropriate */
321
322
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
323
324
325
326
327
      return -1;
    }
  }

  /* Ensure data directory is private; create if possible. */
328
  if (check_private_dir(options->DataDirectory, CPD_CREATE) != 0) {
329
    log_fn(LOG_ERR, "Couldn't access/create private data directory %s",
330
           options->DataDirectory);
331
332
333
334
335
336
337
338
    return -1;
  }

  /* Bail out at this point if we're not going to be a server: we want
   * to not fork, and to log stuff to stderr. */
  if (options->command != CMD_RUN_TOR)
    return 0;

339
  mark_logs_temp(); /* Close current logs once new logs are open. */
340
  if (config_init_logs(options, 0)<0) /* Configure the log(s) */
341
342
343
344
    return -1;
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
345
346
  add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
  adjust_event_log_severity();
347

348
  options->_ConnLimit =
349
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
350
  if (options->_ConnLimit < 0)
351
352
    return -1;

353
354
355
356
357
358
359
360
361
  {
    smartlist_t *sl = smartlist_create();
    for (cl = options->RedirectExit; cl; cl = cl->next) {
      if (parse_redirect_line(sl, cl)<0)
        return -1;
    }
    set_exit_redirects(sl);
  }

362
  /* Finish backgrounding the process */
363
  if (options->RunAsDaemon) {
364
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
365
    finish_daemon(options->DataDirectory);
366
367
368
369
  }

  /* Write our pid to the pid file. If we do not have write permissions we
   * will log a warning */
370
  if (options->PidFile)
371
372
    write_pidfile(options->PidFile);

373
374
375
  /* Register addressmap directives */
  config_register_addressmaps(options);

376
377
378
379
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();

380
381
  init_cookie_authentication(options->CookieAuthentication);

382
383
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
384
    log_fn(LOG_ERR,"Error loading rendezvous service keys");
385
386
387
    return -1;
  }

388
  /* Set up accounting */
389
  if (accounting_parse_options(options, 0)<0) {
390
    log_fn(LOG_ERR,"Error in accounting options");
391
392
    return -1;
  }
393
  if (accounting_is_enabled(options))
394
395
    configure_accounting(time(NULL));

396
  if (!we_are_hibernating() && retry_all_listeners(1) < 0) {
397
398
399
400
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }

401
402
403
404
405
406
#if 0
  {
    char *smin, *smax;
    smin = config_dump_options(options, 1);
    smax = config_dump_options(options, 0);
    log_fn(LOG_DEBUG, "These are our options:\n%s",smax);
Roger Dingledine's avatar
Roger Dingledine committed
407
    log_fn(LOG_DEBUG, "We changed these options:\n%s",smin);
408
409
410
411
412
    tor_free(smin);
    tor_free(smax);
  }
#endif

413
414
415
416
417
418
  /* Since our options changed, we might need to regenerate and upload our
   * server descriptor.  (We could probably be more clever about only calling
   * this when something significant changed.)
   */
  mark_my_descriptor_dirty();

419
  return 0;
420
421
422
423
424
425
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
426
/** If <b>option</b> is an official abbreviation for a longer option,
427
428
429
 * return the longer option.  Otherwise return <b>option</b>.
 * If <b>command_line</b> is set, apply all abbreviations.  Otherwise, only
 * apply abbreviations that work for the config file and the command line. */
430
static const char *
431
expand_abbrev(const char *option, int command_line)
432
433
434
435
{
  int i;
  for (i=0; config_abbrevs[i].abbreviated; ++i) {
    /* Abbreviations aren't casei. */
436
    if (!strcasecmp(option,config_abbrevs[i].abbreviated) &&
437
        (command_line || !config_abbrevs[i].commandline_only)) {
438
      return config_abbrevs[i].full;
439
    }
440
441
442
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
443

Nick Mathewson's avatar
Nick Mathewson committed
444
/** Helper: Read a list of configuration options from the command line. */
445
446
447
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
448
449
  struct config_line_t *new;
  struct config_line_t *front = NULL;
450
451
452
  char *s;
  int i = 1;

453
  while (i < argc-1) {
454
455
456
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
457
      continue;
458
459
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
460
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
461
462
463
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
464
465
    }

466
    new = tor_malloc(sizeof(struct config_line_t));
467
    s = argv[i];
468

469
    while (*s == '-')
470
      s++;
471

472
    new->key = tor_strdup(expand_abbrev(s, 1));
473
    new->value = tor_strdup(argv[i+1]);
474
475

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
476
        new->key, new->value);
477
478
479
480
481
482
483
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
484
/** Helper: allocate a new configuration option mapping 'key' to 'val',
485
486
487
488
489
 * append it to *<b>lst</b>. */
static void
config_line_append(struct config_line_t **lst,
                   const char *key,
                   const char *val)
490
491
{
  struct config_line_t *newline;
492

493
494
495
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
496
497
498
499
500
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
501
502
}

503
504
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
505
506
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
507
508
int
config_get_lines(char *string, struct config_line_t **result)
509
{
510
  struct config_line_t *list = NULL, **next;
511
  char *k, *v;
512

513
  next = &list;
514
515
516
517
518
519
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
520
521
522
523
524
525
526
527
528
529
    if (k && v) {
      /* This list can get long, so we keep a pointer to the end of it
       * rather than using config_line_append over and over and getting n^2
       * performance.  This is the only really long list. */
      *next = tor_malloc(sizeof(struct config_line_t));
      (*next)->key = tor_strdup(k);
      (*next)->value = tor_strdup(v);
      (*next)->next = NULL;
      next = &((*next)->next);
    }
530
  } while (*string);
531

532
  *result = list;
533
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
534
535
}

Nick Mathewson's avatar
Nick Mathewson committed
536
537
538
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
539
void
540
541
config_free_lines(struct config_line_t *front)
{
542
  struct config_line_t *tmp;
543

544
  while (front) {
545
546
547
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
548
549
550
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
551
552
553
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
554
555
556
557
/** If <b>key</b> is a configuration option, return the corresponding
 * config_var_t.  Otherwise, if <b>key</b> is a non-standard abbreviation,
 * warn, and return the corresponding config_var_t.  Otherwise return NULL.
 */
558
559
560
static config_var_t *config_find_option(const char *key)
{
  int i;
561
  size_t keylen = strlen(key);
562
  if (!keylen)
563
    return NULL; /* if they say "--" on the commandline, it's not an option */
Nick Mathewson's avatar
Nick Mathewson committed
564
  /* First, check for an exact (case-insensitive) match */
565
  for (i=0; config_vars[i].name; ++i) {
Nick Mathewson's avatar
Nick Mathewson committed
566
    if (!strcasecmp(key, config_vars[i].name))
567
      return &config_vars[i];
Nick Mathewson's avatar
Nick Mathewson committed
568
569
570
  }
  /* If none, check for an abbreviated match */
  for (i=0; config_vars[i].name; ++i) {
571
    if (!strncasecmp(key, config_vars[i].name, keylen)) {
572
573
574
575
576
577
      log_fn(LOG_WARN, "The abbreviation '%s' is deprecated. "
          "Tell Nick and Roger to make it official, or just use '%s' instead",
             key, config_vars[i].name);
      return &config_vars[i];
    }
  }
578
  /* Okay, unrecognized options */
579
580
581
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
582
/** If <b>c</b> is a syntactically valid configuration line, update
583
584
 * <b>options</b> with its value and return 0.  Otherwise return -1 for bad key,
 * -2 for bad value.
585
586
587
588
 *
 * If 'reset' is set, and we get a line containing no value, restore the
 * option to its default value.
 */
589
static int
590
config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
591
{
592
  int i, ok;
593
594
  config_var_t *var;
  void *lvalue;
595

596
597
598
599
600
601
602
  var = config_find_option(c->key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", c->key);
    return -1;
  }
  /* Put keyword into canonical case. */
  if (strcmp(var->name, c->key)) {
603
    tor_free(c->key);
604
    c->key = tor_strdup(var->name);
605
606
  }

607
  if (reset && !strlen(c->value)) {
608
    option_reset(options, var);
609
610
611
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
612
  lvalue = ((char*)options) + var->var_offset;
613
  switch (var->type) {
614

615
616
617
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
618
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
619
          c->key,c->value);
620
      return -2;
621
    }
622
    *(int *)lvalue = i;
623
624
    break;

625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
  case CONFIG_TYPE_INTERVAL: {
    i = config_parse_interval(c->value, &ok);
    if (!ok) {
      return -2;
    }
    *(int *)lvalue = i;
    break;
  }

  case CONFIG_TYPE_MEMUNIT: {
    uint64_t u64 = config_parse_memunit(c->value, &ok);
    if (!ok) {
      return -2;
    }
    *(uint64_t *)lvalue = u64;
    break;
  }

643
644
645
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
646
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
647
      return -2;
648
    }
649
    *(int *)lvalue = i;
650
651
652
    break;

  case CONFIG_TYPE_STRING:
653
654
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
655
656
657
    break;

  case CONFIG_TYPE_DOUBLE:
658
    *(double *)lvalue = atof(c->value);
659
660
661
    break;

  case CONFIG_TYPE_CSV:
662
663
664
665
    if (*(smartlist_t**)lvalue) {
      SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
      smartlist_clear(*(smartlist_t**)lvalue);
    } else {
666
      *(smartlist_t**)lvalue = smartlist_create();
667
    }
668

669
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
670
671
672
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

673
674
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
675
    config_line_append((struct config_line_t**)lvalue, c->key, c->value);
676
    break;
677
678
679
680

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
681
682
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
683
    return -2;
684
685
686
  default:
    tor_assert(0);
    break;
687
  }
688
  return 0;
689
690
}

691
692
693
694
695
696
697
698
699
700
/** restore the option named <b>key</b> in options to its default value. */
static void
config_reset_line(or_options_t *options, const char *key)
{
  config_var_t *var;

  var = config_find_option(key);
  if (!var)
    return; /* give error on next pass. */

701
  option_reset(options, var);
702
703
}

704
705
706
707
708
709
710
711
/** Return true iff key is a valid configuration option. */
int
config_option_is_recognized(const char *key)
{
  config_var_t *var = config_find_option(key);
  return (var != NULL);
}

712
713
714
715
716
717
718
719
720
/** Return a canonicalized list of the options assigned for key.
 */
struct config_line_t *
config_get_assigned_option(or_options_t *options, const char *key)
{
  config_var_t *var;
  const void *value;
  char buf[32];
  struct config_line_t *result;
721
  tor_assert(options && key);
722
723
724
725
726

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
727
728
729
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
730
731
732
  }
  value = ((char*)options) + var->var_offset;

733
734
  if (var->type == CONFIG_TYPE_LINELIST ||
      var->type == CONFIG_TYPE_LINELIST_V) {
735
    /* Linelist requires special handling: we just copy and return it. */
Roger Dingledine's avatar
Roger Dingledine committed
736
    const struct config_line_t *next_in = *(const struct config_line_t**)value;
737
738
739
740
741
742
743
744
745
746
747
748
749
750
    struct config_line_t **next_out = &result;
    while (next_in) {
      *next_out = tor_malloc(sizeof(struct config_line_t));
      (*next_out)->key = tor_strdup(next_in->key);
      (*next_out)->value = tor_strdup(next_in->value);
      next_in = next_in->next;
      next_out = &((*next_out)->next);
    }
    (*next_out) = NULL;
    return result;
  }

  result = tor_malloc_zero(sizeof(struct config_line_t));
  result->key = tor_strdup(var->name);
751
  switch (var->type)
752
753
    {
    case CONFIG_TYPE_STRING:
754
755
756
757
758
759
760
      if (*(char**)value) {
        result->value = tor_strdup(*(char**)value);
      } else {
        tor_free(result->key);
        tor_free(result);
        return NULL;
      }
761
      break;
762
    case CONFIG_TYPE_INTERVAL:
763
    case CONFIG_TYPE_UINT:
764
      /* This means every or_options_t uint or bool element
765
       * needs to be an int. Not, say, a uint16_t or char. */
766
767
768
      tor_snprintf(buf, sizeof(buf), "%d", *(int*)value);
      result->value = tor_strdup(buf);
      break;
769
770
771
772
773
    case CONFIG_TYPE_MEMUNIT:
      tor_snprintf(buf, sizeof(buf), U64_FORMAT,
                   U64_PRINTF_ARG(*(uint64_t*)value));
      result->value = tor_strdup(buf);
      break;
774
775
776
777
778
779
780
781
    case CONFIG_TYPE_DOUBLE:
      tor_snprintf(buf, sizeof(buf), "%f", *(double*)value);
      result->value = tor_strdup(buf);
      break;
    case CONFIG_TYPE_BOOL:
      result->value = tor_strdup(*(int*)value ? "1" : "0");
      break;
    case CONFIG_TYPE_CSV:
Roger Dingledine's avatar
Roger Dingledine committed
782
783
      if (*(smartlist_t**)value)
        result->value = smartlist_join_strings(*(smartlist_t**)value,",",0,NULL);
784
785
786
      else
        result->value = tor_strdup("");
      break;
787
788
789
790
791
    case CONFIG_TYPE_OBSOLETE:
      log_fn(LOG_WARN,"You asked me for the value of an obsolete config option %s.", key);
      tor_free(result->key);
      tor_free(result);
      return NULL;
792
793
794
    default:
      tor_free(result->key);
      tor_free(result);
795
      log_fn(LOG_WARN,"Bug: unknown type %d for known key %s", var->type, key);
796
797
798
799
800
801
      return NULL;
    }

  return result;
}

802
/** Iterate through the linked list of requested options <b>list</b>.
Nick Mathewson's avatar
Nick Mathewson committed
803
 * For each item, convert as appropriate and assign to <b>options</b>.
804
 * If an item is unrecognized, return -1 immediately,
805
806
807
808
 * else return 0 for success.
 *
 * If <b>reset</b>, then interpret empty lines as meaning "restore to
 * default value", and interpret LINELIST* options as replacing (not
809
810
 * extending) their previous values.  Return 0 on success, -1 on bad key,
 * -2 on bad value.
811
 */
812
static int
813
config_assign(or_options_t *options, struct config_line_t *list, int reset)
814
{
815
  struct config_line_t *p;
816
  tor_assert(options);
817
818
819
820
821
822
823

  /* pass 1: normalize keys */
  for (p = list; p; p = p->next) {
    const char *full = expand_abbrev(p->key, 0);
    if (strcmp(full,p->key)) {
      tor_free(p->key);
      p->key = tor_strdup(full);
824
    }
825
826
  }

827
  /* pass 2: if we're reading from a resetting source, clear all mentioned
828
829
830
831
832
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
833

834
835
  /* pass 3: assign. */
  while (list) {
836
837
838
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
839
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
840
  }
841
  return 0;
842
843
}

844
/** Try assigning <b>list</b> to the global options. You do this by duping
845
 * options, assigning list to the new one, then validating it. If it's
846
 * ok, then throw out the old one and stick with the new one. Else,
847
848
 * revert to old and return failure.  Return 0 on success, -1 on bad
 * keys, -2 on bad values, -3 on bad transition.
849
850
 */
int
851
config_trial_assign(struct config_line_t *list, int reset)
852
{
853
  int r;
854
  or_options_t *trial_options = options_dup(get_options());
855

856
  if ((r=config_assign(trial_options, list, reset)) < 0) {
857
    options_free(trial_options);
858
    return r;
859
860
861
862
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
863
    return -2;
864
865
  }

866
  if (options_transition_allowed(get_options(), trial_options) < 0) {
867
    options_free(trial_options);
868
    return -3;
869
870
  }

871
  set_options(trial_options); /* we liked it. put it in place. */
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
  return 0;
}

/** Replace the option indexed by <b>var</b> in <b>options</b> with its
 * default value. */
static void
option_reset(or_options_t *options, config_var_t *var)
{
  struct config_line_t *c;
  void *lvalue;

  lvalue = ((char*)options) + var->var_offset;
  switch (var->type) {
    case CONFIG_TYPE_STRING:
      tor_free(*(char**)lvalue);
      break;
    case CONFIG_TYPE_DOUBLE:
      *(double*)lvalue = 0.0;
      break;
891
    case CONFIG_TYPE_INTERVAL:
892
893
894
895
    case CONFIG_TYPE_UINT:
    case CONFIG_TYPE_BOOL:
      *(int*)lvalue = 0;
      break;
896
897
898
    case CONFIG_TYPE_MEMUNIT:
      *(uint64_t*)lvalue = 0;
      break;
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
    case CONFIG_TYPE_CSV:
      if (*(smartlist_t**)lvalue) {
        SMARTLIST_FOREACH(*(smartlist_t **)lvalue, char *, cp, tor_free(cp));
        smartlist_free(*(smartlist_t **)lvalue);
        *(smartlist_t **)lvalue = NULL;
      }
      break;
    case CONFIG_TYPE_LINELIST:
    case CONFIG_TYPE_LINELIST_S:
      config_free_lines(*(struct config_line_t **)lvalue);
      *(struct config_line_t **)lvalue = NULL;
      break;
    case CONFIG_TYPE_LINELIST_V:
      /* handled by linelist_s. */
      break;
    case CONFIG_TYPE_OBSOLETE:
      break;
  }
  if (var->initvalue) {
918
    c = tor_malloc_zero(sizeof(struct config_line_t));
919
920
921
922
923
924
925
    c->key = tor_strdup(var->name);
    c->value = tor_strdup(var->initvalue);
    config_assign_line(options,c,0);
    config_free_lines(c);
  }
}

926
/** Set <b>options</b>-&gt;DirServers to contain the default directory
927
 * servers. */
928
static void
929
add_default_trusted_dirservers(or_options_t *options)
930
{
Nick Mathewson's avatar
Nick Mathewson committed
931
  /* moria1 */
932
  config_line_append(&options->DirServers, "DirServer",
933
       "18.244.0.188:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
Nick Mathewson's avatar
Nick Mathewson committed
934
  /* moria2 */
935
  config_line_append(&options->DirServers, "DirServer",
936
         "18.244.0.114:80 719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");