config.c 79.8 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,        "1 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
138
139
140
141
  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),
142
  VAR("IgnoreVersion",       BOOL,     IgnoreVersion,        "0"),
143
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
144
145
146
  VAR("Log",                 LINELIST, Logs,                 NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
147
  OBSOLETE("LinkPadding"),
148
  VAR("ConnLimit",           UINT,     ConnLimit,            "1024"),
149
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
150
  VAR("MonthlyAccountingStart",UINT,   _MonthlyAccountingStart,"0"),
151
152
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
  VAR("AccountingMax",       MEMUNIT,   AccountingMax,        "0 bytes"),
153
  VAR("Nickname",            STRING,   Nickname,             NULL),
154
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
155
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
156
157
158
159
160
  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),
161
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,       "21,22,706,1863,5050,5190,5222,5223,6667,8300,8888"),
162
163
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
164
  OBSOLETE("RouterFile"),
165
166
167
168
169
  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),
170
  VAR("ShutdownWaitLength",  INTERVAL, ShutdownWaitLength,   "30 seconds"),
171
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
172
173
  VAR("SocksBindAddress",    LINELIST, SocksBindAddress,     NULL),
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
174
175
  /** DOCDOC */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "0 seconds"),
176
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
177
  OBSOLETE("TrafficShaping"),
178
  VAR("User",                STRING,   User,                 NULL),
179
  VAR("__LeaveStreamsUnattached", BOOL,LeaveStreamsUnattached, "0"),
180
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
181
182
183
184
};
#undef VAR
#undef OBSOLETE

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

188
189
static void config_line_append(struct config_line_t **lst,
                               const char *key, const char *val);
190
191
static void option_reset(or_options_t *options, config_var_t *var);
static void options_free(or_options_t *options);
192
static int option_is_same(or_options_t *o1, or_options_t *o2,const char *name);
193
194
195
196
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);
197
static void config_register_addressmaps(or_options_t *options);
198

199
static int parse_dir_server_line(const char *line, int validate_only);
200
static int parse_redirect_line(smartlist_t *result,
Roger Dingledine's avatar
Roger Dingledine committed
201
                               struct config_line_t *line);
202
203
204
205
206
207
208
209
210
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);
211
static int validate_data_directory(or_options_t *options);
212
static int write_configuration_file(const char *fname, or_options_t *options);
213

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

218
219
220
221
222
223
/*
 * 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
224
/** Name of most recently read torrc file. */
225
static char *config_fname = NULL;
226

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

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

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

251
252
253
/** 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.
254
255
256
257
258
259
 *
 * 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.
260
261
262
263
264
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
265
266
267
268
269
270
  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) {
271
    start_daemon();
272
273
  }
  if (!libevent_initialized) {
274
    configure_libevent_logging();
275
    suppress_libevent_log_msg("function not implemented");
276
    event_init();
277
    suppress_libevent_log_msg(NULL);
278
279
280
281
282
283
284
285
#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. */
    log_fn(LOG_NOTICE, "Initialized libevent version %s using method %s",
           event_get_version(), event_get_method());
#else
    log_fn(LOG_NOTICE, "Initialized old libevent (version 1.0b or earlier)");
#endif
286
287
    libevent_initialized = 1;
  }
288
289

  clear_trusted_dir_servers();
290
  for (cl = options->DirServers; cl; cl = cl->next) {
291
292
    if (parse_dir_server_line(cl->value, 0)<0) {
      log_fn(LOG_ERR,
293
             "Bug: Previously validated DirServer line could not be added!");
294
      return -1;
295
296
297
    }
  }

298
  if (rend_config_services(options, 0)<0) {
299
    log_fn(LOG_ERR,
300
           "Bug: Previously validated hidden services line could not be added!");
301
    return -1;
302
  }
303
304

  /* Setuid/setgid as appropriate */
305
306
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
307
308
309
310
311
      return -1;
    }
  }

  /* Ensure data directory is private; create if possible. */
312
  if (check_private_dir(options->DataDirectory, CPD_CREATE) != 0) {
313
    log_fn(LOG_ERR, "Couldn't access/create private data directory %s",
314
           options->DataDirectory);
315
316
317
318
319
320
321
322
    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;

323
  mark_logs_temp(); /* Close current logs once new logs are open. */
324
  if (config_init_logs(options, 0)<0) /* Configure the log(s) */
325
326
327
328
    return -1;
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
329
330
  add_callback_log(LOG_ERR, LOG_ERR, control_event_logmsg);
  adjust_event_log_severity();
331

332
  options->_ConnLimit =
333
    set_max_file_descriptors((unsigned)options->ConnLimit, MAXCONNECTIONS);
334
  if (options->_ConnLimit < 0)
335
336
    return -1;

337
338
339
340
341
342
343
344
345
  {
    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);
  }

346
  /* Start backgrounding the process, if requested. */
347

348
  /* Finish backgrounding the process */
349
  if (options->RunAsDaemon) {
350
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
351
    finish_daemon(options->DataDirectory);
352
353
354
355
  }

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

359
360
361
  /* Register addressmap directives */
  config_register_addressmaps(options);

362
363
364
365
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();

366
367
  init_cookie_authentication(options->CookieAuthentication);

368
369
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
370
    log_fn(LOG_ERR,"Error loading rendezvous service keys");
371
372
373
    return -1;
  }

374
  /* Set up accounting */
375
  if (accounting_parse_options(options, 0)<0) {
376
    log_fn(LOG_ERR,"Error in accounting options");
377
378
    return -1;
  }
379
  if (accounting_is_enabled(options))
380
381
    configure_accounting(time(NULL));

382
  if (!we_are_hibernating() && retry_all_listeners(1) < 0) {
383
384
385
386
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }

387
388
389
390
391
392
#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
393
    log_fn(LOG_DEBUG, "We changed these options:\n%s",smin);
394
395
396
397
398
    tor_free(smin);
    tor_free(smax);
  }
#endif

399
400
401
402
403
404
  /* 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();

405
  return 0;
406
407
408
409
410
411
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
412
/** If <b>option</b> is an official abbreviation for a longer option,
413
414
415
 * 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. */
416
static const char *
417
expand_abbrev(const char *option, int command_line)
418
419
420
421
{
  int i;
  for (i=0; config_abbrevs[i].abbreviated; ++i) {
    /* Abbreviations aren't casei. */
422
    if (!strcasecmp(option,config_abbrevs[i].abbreviated) &&
423
        (command_line || !config_abbrevs[i].commandline_only)) {
424
      return config_abbrevs[i].full;
425
    }
426
427
428
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
429

Nick Mathewson's avatar
Nick Mathewson committed
430
/** Helper: Read a list of configuration options from the command line. */
431
432
433
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
434
435
  struct config_line_t *new;
  struct config_line_t *front = NULL;
436
437
438
  char *s;
  int i = 1;

439
  while (i < argc-1) {
440
441
442
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
443
      continue;
444
445
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
446
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
447
448
449
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
450
451
    }

452
    new = tor_malloc(sizeof(struct config_line_t));
453
    s = argv[i];
454

455
    while (*s == '-')
456
      s++;
457

458
    new->key = tor_strdup(expand_abbrev(s, 1));
459
    new->value = tor_strdup(argv[i+1]);
460
461

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
462
        new->key, new->value);
463
464
465
466
467
468
469
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
470
/** Helper: allocate a new configuration option mapping 'key' to 'val',
471
472
473
474
475
 * append it to *<b>lst</b>. */
static void
config_line_append(struct config_line_t **lst,
                   const char *key,
                   const char *val)
476
477
{
  struct config_line_t *newline;
478

479
480
481
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
482
483
484
485
486
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
487
488
}

489
490
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
491
492
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
493
494
int
config_get_lines(char *string, struct config_line_t **result)
495
{
496
  struct config_line_t *list = NULL, **next;
497
  char *k, *v;
498

499
  next = &list;
500
501
502
503
504
505
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
506
507
508
509
510
511
512
513
514
515
    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);
    }
516
  } while (*string);
517

518
  *result = list;
519
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
520
521
}

Nick Mathewson's avatar
Nick Mathewson committed
522
523
524
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
525
void
526
527
config_free_lines(struct config_line_t *front)
{
528
  struct config_line_t *tmp;
529

530
  while (front) {
531
532
533
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
534
535
536
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
537
538
539
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
540
541
542
543
/** 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.
 */
544
545
546
static config_var_t *config_find_option(const char *key)
{
  int i;
547
  size_t keylen = strlen(key);
548
  if (!keylen)
549
    return NULL; /* if they say "--" on the commandline, it's not an option */
Nick Mathewson's avatar
Nick Mathewson committed
550
  /* First, check for an exact (case-insensitive) match */
551
  for (i=0; config_vars[i].name; ++i) {
Nick Mathewson's avatar
Nick Mathewson committed
552
    if (!strcasecmp(key, config_vars[i].name))
553
      return &config_vars[i];
Nick Mathewson's avatar
Nick Mathewson committed
554
555
556
  }
  /* If none, check for an abbreviated match */
  for (i=0; config_vars[i].name; ++i) {
557
    if (!strncasecmp(key, config_vars[i].name, keylen)) {
558
559
560
561
562
563
      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];
    }
  }
564
  /* Okay, unrecognized options */
565
566
567
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
568
/** If <b>c</b> is a syntactically valid configuration line, update
569
570
 * <b>options</b> with its value and return 0.  Otherwise return -1 for bad key,
 * -2 for bad value.
571
572
573
574
 *
 * If 'reset' is set, and we get a line containing no value, restore the
 * option to its default value.
 */
575
static int
576
config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
577
{
578
  int i, ok;
579
580
  config_var_t *var;
  void *lvalue;
581

582
583
584
585
586
587
588
  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)) {
589
    tor_free(c->key);
590
    c->key = tor_strdup(var->name);
591
592
  }

593
  if (reset && !strlen(c->value)) {
594
    option_reset(options, var);
595
596
597
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
598
  lvalue = ((char*)options) + var->var_offset;
599
  switch (var->type) {
600

601
602
603
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
604
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
605
          c->key,c->value);
606
      return -2;
607
    }
608
    *(int *)lvalue = i;
609
610
    break;

611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
  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;
  }

629
630
631
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
632
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
633
      return -2;
634
    }
635
    *(int *)lvalue = i;
636
637
638
    break;

  case CONFIG_TYPE_STRING:
639
640
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
641
642
643
    break;

  case CONFIG_TYPE_DOUBLE:
644
    *(double *)lvalue = atof(c->value);
645
646
647
    break;

  case CONFIG_TYPE_CSV:
648
649
650
651
    if (*(smartlist_t**)lvalue) {
      SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
      smartlist_clear(*(smartlist_t**)lvalue);
    } else {
652
      *(smartlist_t**)lvalue = smartlist_create();
653
    }
654

655
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
656
657
658
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

659
660
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
661
    config_line_append((struct config_line_t**)lvalue, c->key, c->value);
662
    break;
663
664
665
666

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
667
668
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
669
    return -2;
670
671
672
  default:
    tor_assert(0);
    break;
673
  }
674
  return 0;
675
676
}

677
678
679
680
681
682
683
684
685
686
/** 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. */

687
  option_reset(options, var);
688
689
}

690
691
692
693
694
695
696
697
/** 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);
}

698
699
700
701
702
703
704
705
706
/** 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;
707
  tor_assert(options && key);
708
709
710
711
712

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
713
714
715
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
716
717
718
  }
  value = ((char*)options) + var->var_offset;

719
720
  if (var->type == CONFIG_TYPE_LINELIST ||
      var->type == CONFIG_TYPE_LINELIST_V) {
721
    /* Linelist requires special handling: we just copy and return it. */
Roger Dingledine's avatar
Roger Dingledine committed
722
    const struct config_line_t *next_in = *(const struct config_line_t**)value;
723
724
725
726
727
728
729
730
731
732
733
734
735
736
    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);
737
  switch (var->type)
738
739
    {
    case CONFIG_TYPE_STRING:
740
741
742
743
744
745
746
      if (*(char**)value) {
        result->value = tor_strdup(*(char**)value);
      } else {
        tor_free(result->key);
        tor_free(result);
        return NULL;
      }
747
      break;
748
    case CONFIG_TYPE_INTERVAL:
749
    case CONFIG_TYPE_UINT:
750
      /* This means every or_options_t uint or bool element
751
       * needs to be an int. Not, say, a uint16_t or char. */
752
753
754
      tor_snprintf(buf, sizeof(buf), "%d", *(int*)value);
      result->value = tor_strdup(buf);
      break;
755
756
757
758
759
    case CONFIG_TYPE_MEMUNIT:
      tor_snprintf(buf, sizeof(buf), U64_FORMAT,
                   U64_PRINTF_ARG(*(uint64_t*)value));
      result->value = tor_strdup(buf);
      break;
760
761
762
763
764
765
766
767
    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
768
769
      if (*(smartlist_t**)value)
        result->value = smartlist_join_strings(*(smartlist_t**)value,",",0,NULL);
770
771
772
      else
        result->value = tor_strdup("");
      break;
773
774
775
776
777
    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;
778
779
780
    default:
      tor_free(result->key);
      tor_free(result);
781
      log_fn(LOG_WARN,"Bug: unknown type %d for known key %s", var->type, key);
782
783
784
785
786
787
      return NULL;
    }

  return result;
}

788
/** Iterate through the linked list of requested options <b>list</b>.
Nick Mathewson's avatar
Nick Mathewson committed
789
 * For each item, convert as appropriate and assign to <b>options</b>.
790
 * If an item is unrecognized, return -1 immediately,
791
792
793
794
 * 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
795
796
 * extending) their previous values.  Return 0 on success, -1 on bad key,
 * -2 on bad value.
797
 */
798
static int
799
config_assign(or_options_t *options, struct config_line_t *list, int reset)
800
{
801
  struct config_line_t *p;
802
  tor_assert(options);
803
804
805
806
807
808
809

  /* 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);
810
    }
811
812
  }

813
  /* pass 2: if we're reading from a resetting source, clear all mentioned
814
815
816
817
818
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
819

820
821
  /* pass 3: assign. */
  while (list) {
822
823
824
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
825
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
826
  }
827
  return 0;
828
829
}

830
/** Try assigning <b>list</b> to the global options. You do this by duping
831
 * options, assigning list to the new one, then validating it. If it's
832
 * ok, then throw out the old one and stick with the new one. Else,
833
834
 * revert to old and return failure.  Return 0 on success, -1 on bad
 * keys, -2 on bad values, -3 on bad transition.
835
836
 */
int
837
config_trial_assign(struct config_line_t *list, int reset)
838
{
839
  int r;
840
  or_options_t *trial_options = options_dup(get_options());
841

842
  if ((r=config_assign(trial_options, list, reset)) < 0) {
843
    options_free(trial_options);
844
    return r;
845
846
847
848
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
849
    return -2;
850
851
  }

852
  if (options_transition_allowed(get_options(), trial_options) < 0) {
853
    options_free(trial_options);
854
    return -3;
855
856
  }

857
  set_options(trial_options); /* we liked it. put it in place. */
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
  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;
877
    case CONFIG_TYPE_INTERVAL:
878
879
880
881
    case CONFIG_TYPE_UINT:
    case CONFIG_TYPE_BOOL:
      *(int*)lvalue = 0;
      break;
882
883
884
    case CONFIG_TYPE_MEMUNIT:
      *(uint64_t*)lvalue = 0;
      break;
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
    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) {
904
    c = tor_malloc_zero(sizeof(struct config_line_t));
905
906
907
908
909
910
911
    c->key = tor_strdup(var->name);
    c->value = tor_strdup(var->initvalue);
    config_assign_line(options,c,0);
    config_free_lines(c);
  }
}

912
/** Set <b>options</b>-&gt;DirServers to contain the default directory
913
 * servers. */
914
static void
915
add_default_trusted_dirservers(or_options_t *options)
916
{
Nick Mathewson's avatar
Nick Mathewson committed
917
  /* moria1 */
918
  config_line_append(&options->DirServers, "DirServer",
919
       "18.244.0.188:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
Nick Mathewson's avatar
Nick Mathewson committed
920
  /* moria2 */
921
  config_line_append(&options->DirServers, "DirServer",
922
         "18.244.0.114:80 719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");
Nick Mathewson's avatar
Nick Mathewson committed
923
  /* tor26 */
924
  config_line_append(&options->DirServers, "DirServer",
925
     "62.116.124.106:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
926
//  "tor.noreply.org:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
927
928
}

Nick Mathewson's avatar
Nick Mathewson committed
929
/** Print a usage message for tor. */
930
931
932
static void
print_usage(void)
{