config.c 76.5 KB
Newer Older
Roger Dingledine's avatar
Roger Dingledine committed
1
2
3
/* Copyright 2001 Matej Pfajfar.
 * Copyright 2001-2004 Roger Dingledine.
 * Copyright 2004 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
59
60
  PLURAL(HiddenServiceNode),
  PLURAL(HiddenServiceExcludeNode),
  PLURAL(RendNode),
  PLURAL(RendExcludeNode),
61
62
  PLURAL(StrictEntryNode),
  PLURAL(StrictExitNode),
63
  { "l", "Log", 1},
64
65
  { "BandwidthRateBytes", "BandwidthRate", 0},
  { "BandwidthBurstBytes", "BandwidthBurst", 0},
66
  { "DirFetchPostPeriod", "StatusFetchPeriod", 0},
67
  { NULL, NULL , 0},
68
};
69
#undef PLURAL
70

71
/** A variable allowed in the configuration file or on the command line. */
72
typedef struct config_var_t {
73
74
75
76
  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. */
77
78
} config_var_t;

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

Nick Mathewson's avatar
Nick Mathewson committed
90
91
92
93
/** Array of configuration options.  Until we disallow nonstandard
 * abbreviations, order is significant, since the first matching option will
 * be chosen first.
 */
94
static config_var_t config_vars[] = {
95
  VAR("Address",             STRING,   Address,              NULL),
96
  VAR("AccountingStart",     STRING,   AccountingStart,      NULL),
97
  VAR("AllowUnverifiedNodes",CSV,      AllowUnverifiedNodes, "middle,rendezvous"),
98
  VAR("AuthoritativeDirectory",BOOL,   AuthoritativeDir,     "0"),
99
  VAR("BandwidthRate",       MEMUNIT,  BandwidthRate,        "1 MB"),
100
  VAR("BandwidthBurst",      MEMUNIT,  BandwidthBurst,       "5 MB"),
101
102
  VAR("ClientOnly",          BOOL,     ClientOnly,           "0"),
  VAR("ContactInfo",         STRING,   ContactInfo,          NULL),
103
  VAR("ControlPort",         UINT,     ControlPort,          "0"),
104
  VAR("CookieAuthentication",BOOL,     CookieAuthentication, "0"),
105
106
  VAR("DebugLogFile",        STRING,   DebugLogFile,         NULL),
  VAR("DataDirectory",       STRING,   DataDirectory,        NULL),
107
  VAR("DirAllowPrivateAddresses",BOOL, DirAllowPrivateAddresses, NULL),
108
109
  VAR("DirPort",             UINT,     DirPort,              "0"),
  VAR("DirBindAddress",      LINELIST, DirBindAddress,       NULL),
110
111
112
/* XXX we'd like dirfetchperiod to be higher for people with dirport not
 * set, but low for people with dirport set. how to have two defaults? */
  VAR("DirFetchPeriod",      INTERVAL, DirFetchPeriod,       "1 hour"),
113
114
  VAR("DirPostPeriod",       INTERVAL, DirPostPeriod,        "20 minutes"),
  VAR("RendPostPeriod",      INTERVAL, RendPostPeriod,       "20 minutes"),
115
116
117
118
119
120
121
122
123
  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),
  VAR("FascistFirewall",     BOOL,     FascistFirewall,      "0"),
124
  VAR("FirewallPorts",       CSV,      FirewallPorts,        "80,443"),
125
126
127
  VAR("MyFamily",            STRING,   MyFamily,             NULL),
  VAR("NodeFamily",          LINELIST, NodeFamilies,         NULL),
  VAR("Group",               STRING,   Group,                NULL),
128
  VAR("HashedControlPassword",STRING,  HashedControlPassword, NULL),
129
  VAR("HttpProxy",           STRING,   HttpProxy,            NULL),
130
131
132
133
134
  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),
135
  VAR("IgnoreVersion",       BOOL,     IgnoreVersion,        "0"),
136
  VAR("KeepalivePeriod",     INTERVAL, KeepalivePeriod,      "5 minutes"),
137
138
139
  VAR("Log",                 LINELIST, Logs,                 NULL),
  VAR("LogLevel",            LINELIST_S, OldLogOptions,      NULL),
  VAR("LogFile",             LINELIST_S, OldLogOptions,      NULL),
140
  OBSOLETE("LinkPadding"),
141
142
  VAR("MaxConn",             UINT,     MaxConn,              "1024"),
  VAR("MaxOnionsPending",    UINT,     MaxOnionsPending,     "100"),
143
  VAR("MonthlyAccountingStart",UINT,   _MonthlyAccountingStart,"0"),
144
145
  VAR("AccountingMaxKB",     UINT,     _AccountingMaxKB,     "0"),
  VAR("AccountingMax",       MEMUNIT,   AccountingMax,        "0 bytes"),
146
  VAR("Nickname",            STRING,   Nickname,             NULL),
147
  VAR("NewCircuitPeriod",    INTERVAL, NewCircuitPeriod,     "30 seconds"),
148
  VAR("MaxCircuitDirtiness", INTERVAL, MaxCircuitDirtiness,  "10 minutes"),
149
150
151
152
153
  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),
154
  VAR("LongLivedPorts",      CSV,      LongLivedPorts,       "21,22,706,1863,5050,5190,5222,5223,6667,8300,8888"),
155
156
  VAR("PathlenCoinWeight",   DOUBLE,   PathlenCoinWeight,    "0.3"),
  VAR("RedirectExit",        LINELIST, RedirectExit,         NULL),
157
  OBSOLETE("RouterFile"),
158
159
160
161
162
  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),
163
  VAR("SocksPort",           UINT,     SocksPort,            "9050"),
164
165
  VAR("SocksBindAddress",    LINELIST, SocksBindAddress,     NULL),
  VAR("SocksPolicy",         LINELIST, SocksPolicy,          NULL),
166
167
168
/* XXX as with dirfetchperiod, we want this to be 15 minutes for people
 * with a dirport open, but higher for people without a dirport open. */
  VAR("StatusFetchPeriod",   INTERVAL, StatusFetchPeriod,    "15 minutes"),
169
  VAR("SysLog",              LINELIST_S, OldLogOptions,      NULL),
170
  OBSOLETE("TrafficShaping"),
171
172
  VAR("User",                STRING,   User,                 NULL),
  { NULL, CONFIG_TYPE_OBSOLETE, 0, NULL }
173
174
175
176
};
#undef VAR
#undef OBSOLETE

Nick Mathewson's avatar
Nick Mathewson committed
177
/** Largest allowed config line */
178
#define CONFIG_LINE_T_MAXLEN 4096
179

180
181
static void config_line_append(struct config_line_t **lst,
                               const char *key, const char *val);
182
183
static void option_reset(or_options_t *options, config_var_t *var);
static void options_free(or_options_t *options);
184
static int option_is_same(or_options_t *o1, or_options_t *o2,const char *name);
185
186
187
188
189
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);

190
static int parse_dir_server_line(const char *line, int validate_only);
191
static int parse_redirect_line(smartlist_t *result,
Roger Dingledine's avatar
Roger Dingledine committed
192
                               struct config_line_t *line);
193
194
195
196
197
198
199
200
201
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);
202
static int validate_data_directory(or_options_t *options);
203
static int write_configuration_file(const char *fname, or_options_t *options);
204

205
206
static uint64_t config_parse_memunit(const char *s, int *ok);
static int config_parse_interval(const char *s, int *ok);
207
static void print_cvs_version(void);
208

209
210
211
212
213
214
/*
 * 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
215
/** Name of most recently read torrc file. */
216
static char *config_fname = NULL;
217

218
219
220
/** Return the currently configured options. */
or_options_t *
get_options(void) {
221
222
223
  tor_assert(global_options);
  return global_options;
}
224

Roger Dingledine's avatar
Roger Dingledine committed
225
/** Change the current global options to contain <b>new_val</b> instead
226
 * of their current value; free the old value as necessary.
227
228
229
230
231
232
 */
void
set_options(or_options_t *new_val) {
  if (global_options)
    options_free(global_options);
  global_options = new_val;
233
234
}

235
236
237
238
239
240
241
void
config_free_all(void)
{
  options_free(global_options);
  tor_free(config_fname);
}

242
243
244
/** 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.
245
246
247
248
249
250
 *
 * 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.
251
252
253
254
255
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
256
257
258
259
260
261
262
263
264
265
266
267
  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) {
    start_daemon(options->DataDirectory);
  }
  if (!libevent_initialized) {
    event_init();
    libevent_initialized = 1;
  }
268
269

  clear_trusted_dir_servers();
270
  for (cl = options->DirServers; cl; cl = cl->next) {
271
272
    if (parse_dir_server_line(cl->value, 0)<0) {
      log_fn(LOG_ERR,
273
             "Bug: Previously validated DirServer line could not be added!");
274
      return -1;
275
276
277
    }
  }

278
  if (rend_config_services(options, 0)<0) {
279
    log_fn(LOG_ERR,
280
           "Bug: Previously validated hidden services line could not be added!");
281
    return -1;
282
  }
283
284

  /* Setuid/setgid as appropriate */
285
286
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
287
288
289
290
291
      return -1;
    }
  }

  /* Ensure data directory is private; create if possible. */
292
  if (check_private_dir(options->DataDirectory, CPD_CREATE) != 0) {
293
    log_fn(LOG_ERR, "Couldn't access/create private data directory %s",
294
           options->DataDirectory);
295
296
297
298
299
300
301
302
    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;

303
  mark_logs_temp(); /* Close current logs once new logs are open. */
304
  if (config_init_logs(options, 0)<0) /* Configure the log(s) */
305
306
307
308
    return -1;
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
309
  add_callback_log(LOG_NOTICE, LOG_ERR, control_event_logmsg);
310

311
312
313
  if (set_max_file_descriptors(options->MaxConn) < 0)
    return -1;

314
315
316
317
318
319
320
321
322
  {
    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);
  }

323
  /* Start backgrounding the process, if requested. */
324

325
  /* Finish backgrounding the process */
326
  if (options->RunAsDaemon) {
327
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
328
329
330
331
332
    finish_daemon();
  }

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

336
337
338
339
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();

340
341
  init_cookie_authentication(options->CookieAuthentication);

342
343
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
344
    log_fn(LOG_ERR,"Error loading rendezvous service keys");
345
346
347
    return -1;
  }

348
  /* Set up accounting */
349
  if (accounting_parse_options(options, 0)<0) {
350
    log_fn(LOG_ERR,"Error in accounting options");
351
352
    return -1;
  }
353
  if (accounting_is_enabled(options))
354
355
    configure_accounting(time(NULL));

356
  if (!we_are_hibernating() && retry_all_listeners(1) < 0) {
357
358
359
360
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }

361
362
363
364
365
366
#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
367
    log_fn(LOG_DEBUG, "We changed these options:\n%s",smin);
368
369
370
371
372
    tor_free(smin);
    tor_free(smax);
  }
#endif

373
374
375
376
377
378
  /* 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();

379
  return 0;
380
381
382
383
384
385
}

/*
 * Functions to parse config options
 */

Nick Mathewson's avatar
Nick Mathewson committed
386
/** If <b>option</b> is an official abbreviation for a longer option,
387
388
389
 * 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. */
390
static const char *
391
expand_abbrev(const char *option, int command_line)
392
393
394
395
{
  int i;
  for (i=0; config_abbrevs[i].abbreviated; ++i) {
    /* Abbreviations aren't casei. */
396
    if (!strcasecmp(option,config_abbrevs[i].abbreviated) &&
397
        (command_line || !config_abbrevs[i].commandline_only)) {
398
      return config_abbrevs[i].full;
399
    }
400
401
402
  }
  return option;
}
Nick Mathewson's avatar
Nick Mathewson committed
403

Nick Mathewson's avatar
Nick Mathewson committed
404
/** Helper: Read a list of configuration options from the command line. */
405
406
407
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
408
409
  struct config_line_t *new;
  struct config_line_t *front = NULL;
410
411
412
  char *s;
  int i = 1;

413
  while (i < argc-1) {
414
415
416
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
417
      continue;
418
419
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
420
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
421
422
423
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
424
425
    }

426
    new = tor_malloc(sizeof(struct config_line_t));
427
    s = argv[i];
428

429
    while (*s == '-')
430
      s++;
431

432
    new->key = tor_strdup(expand_abbrev(s, 1));
433
    new->value = tor_strdup(argv[i+1]);
434
435

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
436
        new->key, new->value);
437
438
439
440
441
442
443
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
444
/** Helper: allocate a new configuration option mapping 'key' to 'val',
445
446
447
448
449
 * append it to *<b>lst</b>. */
static void
config_line_append(struct config_line_t **lst,
                   const char *key,
                   const char *val)
450
451
{
  struct config_line_t *newline;
452

453
454
455
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
456
457
458
459
460
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
461
462
}

463
464
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
465
466
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
467
468
int
config_get_lines(char *string, struct config_line_t **result)
469
{
470
  struct config_line_t *list = NULL, **next;
471
  char *k, *v;
472

473
  next = &list;
474
475
476
477
478
479
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
480
481
482
483
484
485
486
487
488
489
    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);
    }
490
  } while (*string);
491

492
  *result = list;
493
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
494
495
}

Nick Mathewson's avatar
Nick Mathewson committed
496
497
498
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
499
void
500
501
config_free_lines(struct config_line_t *front)
{
502
  struct config_line_t *tmp;
503

504
  while (front) {
505
506
507
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
508
509
510
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
511
512
513
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
514
515
516
517
/** 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.
 */
518
519
520
static config_var_t *config_find_option(const char *key)
{
  int i;
521
  size_t keylen = strlen(key);
522
  if (!keylen)
523
    return NULL; /* if they say "--" on the commandline, it's not an option */
Nick Mathewson's avatar
Nick Mathewson committed
524
  /* First, check for an exact (case-insensitive) match */
525
  for (i=0; config_vars[i].name; ++i) {
Nick Mathewson's avatar
Nick Mathewson committed
526
    if (!strcasecmp(key, config_vars[i].name))
527
      return &config_vars[i];
Nick Mathewson's avatar
Nick Mathewson committed
528
529
530
  }
  /* If none, check for an abbreviated match */
  for (i=0; config_vars[i].name; ++i) {
531
    if (!strncasecmp(key, config_vars[i].name, keylen)) {
532
533
534
535
536
537
      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];
    }
  }
538
  /* Okay, unrecognized options */
539
540
541
  return NULL;
}

Nick Mathewson's avatar
Nick Mathewson committed
542
/** If <b>c</b> is a syntactically valid configuration line, update
543
544
 * <b>options</b> with its value and return 0.  Otherwise return -1 for bad key,
 * -2 for bad value.
545
546
547
548
 *
 * If 'reset' is set, and we get a line containing no value, restore the
 * option to its default value.
 */
549
static int
550
config_assign_line(or_options_t *options, struct config_line_t *c, int reset)
551
{
552
  int i, ok;
553
554
  config_var_t *var;
  void *lvalue;
555

556
557
558
559
560
561
562
  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)) {
563
    tor_free(c->key);
564
    c->key = tor_strdup(var->name);
565
566
  }

567
  if (reset && !strlen(c->value)) {
568
    option_reset(options, var);
569
570
571
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
572
  lvalue = ((char*)options) + var->var_offset;
573
  switch (var->type) {
574

575
576
577
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
578
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
579
          c->key,c->value);
580
      return -2;
581
    }
582
    *(int *)lvalue = i;
583
584
    break;

585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
  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;
  }

603
604
605
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
606
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
607
      return -2;
608
    }
609
    *(int *)lvalue = i;
610
611
612
    break;

  case CONFIG_TYPE_STRING:
613
614
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
615
616
617
    break;

  case CONFIG_TYPE_DOUBLE:
618
    *(double *)lvalue = atof(c->value);
619
620
621
    break;

  case CONFIG_TYPE_CSV:
622
623
624
625
    if (*(smartlist_t**)lvalue) {
      SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
      smartlist_clear(*(smartlist_t**)lvalue);
    } else {
626
      *(smartlist_t**)lvalue = smartlist_create();
627
    }
628

629
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
630
631
632
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

633
634
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
635
    config_line_append((struct config_line_t**)lvalue, c->key, c->value);
636
    break;
637
638
639
640

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
641
642
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
643
    return -2;
644
645
646
  default:
    tor_assert(0);
    break;
647
  }
648
  return 0;
649
650
}

651
652
653
654
655
656
657
658
659
660
/** 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. */

661
  option_reset(options, var);
662
663
}

664
665
666
667
668
669
670
671
/** 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);
}

672
673
674
675
676
677
678
679
680
/** 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;
681
  tor_assert(options && key);
682
683
684
685
686

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
687
688
689
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
690
691
692
  }
  value = ((char*)options) + var->var_offset;

693
694
  if (var->type == CONFIG_TYPE_LINELIST ||
      var->type == CONFIG_TYPE_LINELIST_V) {
695
    /* Linelist requires special handling: we just copy and return it. */
Roger Dingledine's avatar
Roger Dingledine committed
696
    const struct config_line_t *next_in = *(const struct config_line_t**)value;
697
698
699
700
701
702
703
704
705
706
707
708
709
710
    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);
711
  switch (var->type)
712
713
    {
    case CONFIG_TYPE_STRING:
714
715
716
717
718
719
720
      if (*(char**)value) {
        result->value = tor_strdup(*(char**)value);
      } else {
        tor_free(result->key);
        tor_free(result);
        return NULL;
      }
721
      break;
722
    case CONFIG_TYPE_INTERVAL:
723
    case CONFIG_TYPE_UINT:
724
      /* This means every or_options_t uint or bool element
725
       * needs to be an int. Not, say, a uint16_t or char. */
726
727
728
      tor_snprintf(buf, sizeof(buf), "%d", *(int*)value);
      result->value = tor_strdup(buf);
      break;
729
730
731
732
733
    case CONFIG_TYPE_MEMUNIT:
      tor_snprintf(buf, sizeof(buf), U64_FORMAT,
                   U64_PRINTF_ARG(*(uint64_t*)value));
      result->value = tor_strdup(buf);
      break;
734
735
736
737
738
739
740
741
    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
742
743
      if (*(smartlist_t**)value)
        result->value = smartlist_join_strings(*(smartlist_t**)value,",",0,NULL);
744
745
746
      else
        result->value = tor_strdup("");
      break;
747
748
749
750
751
    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;
752
753
754
    default:
      tor_free(result->key);
      tor_free(result);
755
      log_fn(LOG_WARN,"Bug: unknown type %d for known key %s", var->type, key);
756
757
758
759
760
761
      return NULL;
    }

  return result;
}

762
/** Iterate through the linked list of requested options <b>list</b>.
Nick Mathewson's avatar
Nick Mathewson committed
763
 * For each item, convert as appropriate and assign to <b>options</b>.
764
 * If an item is unrecognized, return -1 immediately,
765
766
767
768
 * 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
769
770
 * extending) their previous values.  Return 0 on success, -1 on bad key,
 * -2 on bad value.
771
 */
772
static int
773
config_assign(or_options_t *options, struct config_line_t *list, int reset)
774
{
775
  struct config_line_t *p;
776
  tor_assert(options);
777
778
779
780
781
782
783

  /* 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);
784
    }
785
786
  }

787
  /* pass 2: if we're reading from a resetting source, clear all mentioned
788
789
790
791
792
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
793

794
795
  /* pass 3: assign. */
  while (list) {
796
797
798
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
799
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
800
  }
801
  return 0;
802
803
}

804
/** Try assigning <b>list</b> to the global options. You do this by duping
805
 * options, assigning list to the new one, then validating it. If it's
806
 * ok, then throw out the old one and stick with the new one. Else,
807
808
 * revert to old and return failure.  Return 0 on success, -1 on bad
 * keys, -2 on bad values, -3 on bad transition.
809
810
 */
int
811
config_trial_assign(struct config_line_t *list, int reset)
812
{
813
  int r;
814
  or_options_t *trial_options = options_dup(get_options());
815

816
  if ((r=config_assign(trial_options, list, reset)) < 0) {
817
    options_free(trial_options);
818
    return r;
819
820
821
822
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
823
    return -2;
824
825
  }

826
  if (options_transition_allowed(get_options(), trial_options) < 0) {
827
    options_free(trial_options);
828
    return -3;
829
830
  }

831
  set_options(trial_options); /* we liked it. put it in place. */
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
  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;
851
    case CONFIG_TYPE_INTERVAL:
852
853
854
855
    case CONFIG_TYPE_UINT:
    case CONFIG_TYPE_BOOL:
      *(int*)lvalue = 0;
      break;
856
857
858
    case CONFIG_TYPE_MEMUNIT:
      *(uint64_t*)lvalue = 0;
      break;
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
    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) {
878
    c = tor_malloc_zero(sizeof(struct config_line_t));
879
880
881
882
883
884
885
    c->key = tor_strdup(var->name);
    c->value = tor_strdup(var->initvalue);
    config_assign_line(options,c,0);
    config_free_lines(c);
  }
}

886
/** Set <b>options</b>-&gt;DirServers to contain the default directory
887
 * servers. */
888
static void
889
add_default_trusted_dirservers(or_options_t *options)
890
{
Nick Mathewson's avatar
Nick Mathewson committed
891
  /* moria1 */
892
  config_line_append(&options->DirServers, "DirServer",
893
       "18.244.0.188:9031 FFCB 46DB 1339 DA84 674C 70D7 CB58 6434 C437 0441");
Nick Mathewson's avatar
Nick Mathewson committed
894
  /* moria2 */
895
  config_line_append(&options->DirServers, "DirServer",
896
         "18.244.0.114:80 719B E45D E224 B607 C537 07D0 E214 3E2D 423E 74CF");
Nick Mathewson's avatar
Nick Mathewson committed
897
  /* tor26 */
898
  config_line_append(&options->DirServers, "DirServer",
899
     "62.116.124.106:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
900
//  "tor.noreply.org:9030 847B 1F85 0344 D787 6491 A548 92F9 0493 4E4E B85D");
901
902
}

Nick Mathewson's avatar
Nick Mathewson committed
903
/** Print a usage message for tor. */
904
905
906
static void
print_usage(void)
{
907
908
909
  printf(
"Copyright 2001-2004 Roger Dingledine, Nick Mathewson, Matej Pfajfar.\n\n"
"tor -f <torrc> [args]\n"
910
"See man page for options, or http://tor.eff.org/ for documentation.\n");
911
912
}

Nick Mathewson's avatar
Nick Mathewson committed
913
/**
914
915
 * Based on <b>address</b>, guess our public IP address and put it
 * in <b>addr</b>.
Nick Mathewson's avatar
Nick Mathewson committed
916
 */
917
918
919
int
resolve_my_address(const char *address, uint32_t *addr)
{
920
921
  struct in_addr in;
  struct hostent *rent;
922
  char hostname[256];
923
  int explicit_ip=1;
924

925
926
  tor_assert(addr);

927
928
  if (address) {
    strlcpy(hostname, address, sizeof(hostname));
929
  } else { /* then we need to guess our address */
930
    explicit_ip = 0; /* it's implicit */
931

932
    if (gethostname(hostname, sizeof(hostname)) < 0) {
933
934
935
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
936
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
937
938
  }

939
  /* now we know hostname. resolve it and keep only the IP */
940

941
  if (tor_inet_aton(hostname, &in) == 0) {
942
943
    /* then we have to resolve it */
    explicit_ip = 0;
944
    rent = (struct hostent *)gethostbyname(hostname);
945
    if (!rent) {
946
      log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
947
948
      return -1;
    }