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
}

/** 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.
238
239
240
241
242
243
 *
 * 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.
244
245
246
247
248
 */
int
options_act(void) {
  struct config_line_t *cl;
  or_options_t *options = get_options();
249
250
251
252
253
254
255
256
257
258
259
260
  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;
  }
261
262

  clear_trusted_dir_servers();
263
  for (cl = options->DirServers; cl; cl = cl->next) {
264
265
    if (parse_dir_server_line(cl->value, 0)<0) {
      log_fn(LOG_ERR,
266
             "Bug: Previously validated DirServer line could not be added!");
267
      return -1;
268
269
270
    }
  }

271
  if (rend_config_services(options, 0)<0) {
272
    log_fn(LOG_ERR,
273
           "Bug: Previously validated hidden services line could not be added!");
274
    return -1;
275
  }
276
277

  /* Setuid/setgid as appropriate */
278
279
  if (options->User || options->Group) {
    if (switch_id(options->User, options->Group) != 0) {
280
281
282
283
284
      return -1;
    }
  }

  /* Ensure data directory is private; create if possible. */
285
  if (check_private_dir(options->DataDirectory, CPD_CREATE) != 0) {
286
    log_fn(LOG_ERR, "Couldn't access/create private data directory %s",
287
           options->DataDirectory);
288
289
290
291
292
293
294
295
    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;

296
  mark_logs_temp(); /* Close current logs once new logs are open. */
297
  if (config_init_logs(options, 0)<0) /* Configure the log(s) */
298
299
300
301
    return -1;
  /* Close the temporary log we used while starting up, if it isn't already
   * gone. */
  close_temp_logs();
302
  add_callback_log(LOG_NOTICE, LOG_ERR, control_event_logmsg);
303

304
305
306
  if (set_max_file_descriptors(options->MaxConn) < 0)
    return -1;

307
308
309
310
311
312
313
314
315
  {
    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);
  }

316
  /* Start backgrounding the process, if requested. */
317

318
  /* Finish backgrounding the process */
319
  if (options->RunAsDaemon) {
320
    /* We may be calling this for the n'th time (on SIGHUP), but it's safe. */
321
322
323
324
325
    finish_daemon();
  }

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

329
330
331
332
  /* Update address policies. */
  parse_socks_policy();
  parse_dir_policy();

333
334
  init_cookie_authentication(options->CookieAuthentication);

335
336
  /* reload keys as needed for rendezvous services. */
  if (rend_service_load_keys()<0) {
337
    log_fn(LOG_ERR,"Error loading rendezvous service keys");
338
339
340
    return -1;
  }

341
  /* Set up accounting */
342
  if (accounting_parse_options(options, 0)<0) {
343
    log_fn(LOG_ERR,"Error in accounting options");
344
345
    return -1;
  }
346
  if (accounting_is_enabled(options))
347
348
    configure_accounting(time(NULL));

349
  if (!we_are_hibernating() && retry_all_listeners(1) < 0) {
350
351
352
353
    log_fn(LOG_ERR,"Failed to bind one of the listener ports.");
    return -1;
  }

354
355
356
357
358
359
#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
360
    log_fn(LOG_DEBUG, "We changed these options:\n%s",smin);
361
362
363
364
365
    tor_free(smin);
    tor_free(smax);
  }
#endif

366
367
368
369
370
371
  /* 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();

372
  return 0;
373
374
375
376
377
378
}

/*
 * Functions to parse config options
 */

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

Nick Mathewson's avatar
Nick Mathewson committed
397
/** Helper: Read a list of configuration options from the command line. */
398
399
400
static struct config_line_t *
config_get_commandlines(int argc, char **argv)
{
401
402
  struct config_line_t *new;
  struct config_line_t *front = NULL;
403
404
405
  char *s;
  int i = 1;

406
  while (i < argc-1) {
407
408
409
    if (!strcmp(argv[i],"-f") ||
        !strcmp(argv[i],"--hash-password")) {
      i += 2; /* command-line option with argument. ignore them. */
410
      continue;
411
412
    } else if (!strcmp(argv[i],"--list-fingerprint")) {
      i += 1; /* command-line option. ignore it. */
413
      continue;
Nick Mathewson's avatar
Nick Mathewson committed
414
415
416
    } else if (!strcmp(argv[i],"--nt-service")) {
      i += 1;
      continue;
417
418
    }

419
    new = tor_malloc(sizeof(struct config_line_t));
420
    s = argv[i];
421

422
    while (*s == '-')
423
      s++;
424

425
    new->key = tor_strdup(expand_abbrev(s, 1));
426
    new->value = tor_strdup(argv[i+1]);
427
428

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
429
        new->key, new->value);
430
431
432
433
434
435
436
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
437
/** Helper: allocate a new configuration option mapping 'key' to 'val',
438
439
440
441
442
 * append it to *<b>lst</b>. */
static void
config_line_append(struct config_line_t **lst,
                   const char *key,
                   const char *val)
443
444
{
  struct config_line_t *newline;
445

446
447
448
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
449
450
451
452
453
  newline->next = NULL;
  while (*lst)
    lst = &((*lst)->next);

  (*lst) = newline;
454
455
}

456
457
/** Helper: parse the config string and strdup into key/value
 * strings. Set *result to the list, or NULL if parsing the string
458
459
 * failed.  Return 0 on success, -1 on failure. Warn and ignore any
 * misformatted lines. */
460
461
int
config_get_lines(char *string, struct config_line_t **result)
462
{
463
  struct config_line_t *list = NULL, **next;
464
  char *k, *v;
465

466
  next = &list;
467
468
469
470
471
472
  do {
    string = parse_line_from_str(string, &k, &v);
    if (!string) {
      config_free_lines(list);
      return -1;
    }
473
474
475
476
477
478
479
480
481
482
    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);
    }
483
  } while (*string);
484

485
  *result = list;
486
  return 0;
Roger Dingledine's avatar
Roger Dingledine committed
487
488
}

Nick Mathewson's avatar
Nick Mathewson committed
489
490
491
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
492
void
493
494
config_free_lines(struct config_line_t *front)
{
495
  struct config_line_t *tmp;
496

497
  while (front) {
498
499
500
    tmp = front;
    front = tmp->next;

Roger Dingledine's avatar
Roger Dingledine committed
501
502
503
    tor_free(tmp->key);
    tor_free(tmp->value);
    tor_free(tmp);
504
505
506
  }
}

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

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

549
550
551
552
553
554
555
  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)) {
556
    tor_free(c->key);
557
    c->key = tor_strdup(var->name);
558
559
  }

560
  if (reset && !strlen(c->value)) {
561
    option_reset(options, var);
562
563
564
    return 0;
  }

Nick Mathewson's avatar
Nick Mathewson committed
565
  lvalue = ((char*)options) + var->var_offset;
566
  switch (var->type) {
567

568
569
570
  case CONFIG_TYPE_UINT:
    i = tor_parse_long(c->value, 10, 0, INT_MAX, &ok, NULL);
    if (!ok) {
571
      log(LOG_WARN, "Int keyword '%s %s' is malformed or out of bounds.",
572
          c->key,c->value);
573
      return -2;
574
    }
575
    *(int *)lvalue = i;
576
577
    break;

578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
  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;
  }

596
597
598
  case CONFIG_TYPE_BOOL:
    i = tor_parse_long(c->value, 10, 0, 1, &ok, NULL);
    if (!ok) {
599
      log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1.", c->key);
600
      return -2;
601
    }
602
    *(int *)lvalue = i;
603
604
605
    break;

  case CONFIG_TYPE_STRING:
606
607
    tor_free(*(char **)lvalue);
    *(char **)lvalue = tor_strdup(c->value);
608
609
610
    break;

  case CONFIG_TYPE_DOUBLE:
611
    *(double *)lvalue = atof(c->value);
612
613
614
    break;

  case CONFIG_TYPE_CSV:
615
616
617
618
    if (*(smartlist_t**)lvalue) {
      SMARTLIST_FOREACH(*(smartlist_t**)lvalue, char *, cp, tor_free(cp));
      smartlist_clear(*(smartlist_t**)lvalue);
    } else {
619
      *(smartlist_t**)lvalue = smartlist_create();
620
    }
621

622
    smartlist_split_string(*(smartlist_t**)lvalue, c->value, ",",
623
624
625
                           SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
    break;

626
627
  case CONFIG_TYPE_LINELIST:
  case CONFIG_TYPE_LINELIST_S:
628
    config_line_append((struct config_line_t**)lvalue, c->key, c->value);
629
    break;
630
631
632
633

  case CONFIG_TYPE_OBSOLETE:
    log_fn(LOG_WARN, "Skipping obsolete configuration option '%s'", c->key);
    break;
634
635
  case CONFIG_TYPE_LINELIST_V:
    log_fn(LOG_WARN, "Can't provide value for virtual option '%s'", c->key);
636
    return -2;
637
638
639
  default:
    tor_assert(0);
    break;
640
  }
641
  return 0;
642
643
}

644
645
646
647
648
649
650
651
652
653
/** 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. */

654
  option_reset(options, var);
655
656
}

657
658
659
660
661
662
663
664
/** 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);
}

665
666
667
668
669
670
671
672
673
/** 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;
674
  tor_assert(options && key);
675
676
677
678
679

  var = config_find_option(key);
  if (!var) {
    log_fn(LOG_WARN, "Unknown option '%s'.  Failing.", key);
    return NULL;
680
681
682
  } else if (var->type == CONFIG_TYPE_LINELIST_S) {
    log_fn(LOG_WARN, "Can't return context-sensitive '%s' on its own", key);
    return NULL;
683
684
685
  }
  value = ((char*)options) + var->var_offset;

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

  return result;
}

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

  /* 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);
777
    }
778
779
  }

780
  /* pass 2: if we're reading from a resetting source, clear all mentioned
781
782
783
784
785
   * linelists. */
  if (reset) {
    for (p = list; p; p = p->next)
      config_reset_line(options, p->key);
  }
786

787
788
  /* pass 3: assign. */
  while (list) {
789
790
791
    int r;
    if ((r=config_assign_line(options, list, reset)))
      return r;
792
    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
793
  }
794
  return 0;
795
796
}

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

809
  if ((r=config_assign(trial_options, list, reset)) < 0) {
810
    options_free(trial_options);
811
    return r;
812
813
814
815
  }

  if (options_validate(trial_options) < 0) {
    options_free(trial_options);
816
    return -2;
817
818
  }

819
  if (options_transition_allowed(get_options(), trial_options) < 0) {
820
    options_free(trial_options);
821
    return -3;
822
823
  }

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

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

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

Nick Mathewson's avatar
Nick Mathewson committed
906
/**
907
908
 * Based on <b>address</b>, guess our public IP address and put it
 * in <b>addr</b>.
Nick Mathewson's avatar
Nick Mathewson committed
909
 */
910
911
912
int
resolve_my_address(const char *address, uint32_t *addr)
{
913
914
  struct in_addr in;
  struct hostent *rent;
915
  char hostname[256];
916
  int explicit_ip=1;
917

918
919
  tor_assert(addr);

920
921
  if (address) {
    strlcpy(hostname, address, sizeof(hostname));
922
  } else { /* then we need to guess our address */
923
    explicit_ip = 0; /* it's implicit */
924

925
    if (gethostname(hostname, sizeof(hostname)) < 0) {
926
927
928
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
929
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
930
931
  }

932
  /* now we know hostname. resolve it and keep only the IP */
933

934
  if (tor_inet_aton(hostname, &in) == 0) {
935
936
    /* then we have to resolve it */
    explicit_ip = 0;
937
    rent = (struct hostent *)gethostbyname(hostname);
938
    if (!rent) {
939
      log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
940
941
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
942
    tor_assert(rent->h_length == 4);
943
    memcpy(&in.s_addr, rent->h_addr, rent->h_length);
944
  }