config.c 24.5 KB
Newer Older
1
/* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
2
3
4
/* See LICENSE for licensing information */
/* $Id$ */

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

Roger Dingledine's avatar
Roger Dingledine committed
12
#include "or.h"
Roger Dingledine's avatar
Roger Dingledine committed
13

Nick Mathewson's avatar
Nick Mathewson committed
14
15
16
17
18
19
20
21
/** Enumeration of types which option values can take */
typedef enum config_type_t {
  CONFIG_TYPE_STRING = 0, /**< An arbitrary string. */
  CONFIG_TYPE_INT, /**< An integer */
  CONFIG_TYPE_DOUBLE, /**< A floating-point value */
  CONFIG_TYPE_BOOL, /**< A boolean value, expressed as 0 or 1. */
  CONFIG_TYPE_LINELIST, /**< Uninterpreted config lines */
} config_type_t;
22

Nick Mathewson's avatar
Nick Mathewson committed
23
/** Largest allowed config line */
24
#define CONFIG_LINE_T_MAXLEN 4096
25
26
27

static FILE *config_open(const unsigned char *filename);
static int config_close(FILE *f);
28
29
30
static struct config_line_t *config_get_commandlines(int argc, char **argv);
static struct config_line_t *config_get_lines(FILE *f);
static void config_free_lines(struct config_line_t *front);
Nick Mathewson's avatar
Nick Mathewson committed
31
static int config_compare(struct config_line_t *c, char *key, config_type_t type, void *arg);
32
static int config_assign(or_options_t *options, struct config_line_t *list);
33

Nick Mathewson's avatar
Nick Mathewson committed
34
/** Open a configuration file for reading */
35
static FILE *config_open(const unsigned char *filename) {
Roger Dingledine's avatar
Roger Dingledine committed
36
  tor_assert(filename);
37
38
39
40
41
42
43
  if (strspn(filename,CONFIG_LEGAL_FILENAME_CHARACTERS) != strlen(filename)) {
    /* filename has illegal letters */
    return NULL;
  }
  return fopen(filename, "r");
}

Nick Mathewson's avatar
Nick Mathewson committed
44
/** Close the configuration file */
45
static int config_close(FILE *f) {
Roger Dingledine's avatar
Roger Dingledine committed
46
  tor_assert(f);
47
48
49
  return fclose(f);
}

Nick Mathewson's avatar
Nick Mathewson committed
50
/** Helper: Read a list of configuration options from the command line. */
51
52
53
static struct config_line_t *config_get_commandlines(int argc, char **argv) {
  struct config_line_t *new;
  struct config_line_t *front = NULL;
54
55
56
  char *s;
  int i = 1;

Roger Dingledine's avatar
Roger Dingledine committed
57
  while(i < argc-1) {
58
59
60
61
62
63
    if(!strcmp(argv[i],"-f")) {
//      log(LOG_DEBUG,"Commandline: skipping over -f.");
      i+=2; /* this is the config file option. ignore it. */
      continue;
    }

64
    new = tor_malloc(sizeof(struct config_line_t));
65
66
67
    s = argv[i];
    while(*s == '-')
      s++;
68
69
    new->key = tor_strdup(s);
    new->value = tor_strdup(argv[i+1]);
70
71
72
73
74
75
76
77
78
79

    log(LOG_DEBUG,"Commandline: parsed keyword '%s', value '%s'",
      new->key, new->value);
    new->next = front;
    front = new;
    i += 2;
  }
  return front;
}

Nick Mathewson's avatar
Nick Mathewson committed
80
81
/** Helper: allocate a new configuration option mapping 'key' to 'val',
 * prepend it to 'front', and return the newly allocated config_line_t */
82
83
84
85
86
87
88
89
90
91
92
93
94
static struct config_line_t *
config_line_prepend(struct config_line_t *front,
                    const char *key,
                    const char *val)
{
  struct config_line_t *newline;
  newline = tor_malloc(sizeof(struct config_line_t));
  newline->key = tor_strdup(key);
  newline->value = tor_strdup(val);
  newline->next = front;
  return newline;
}

95
/** Helper: parse the config file and strdup into key/value
Nick Mathewson's avatar
Nick Mathewson committed
96
97
 * strings. Return list, or NULL if parsing the file failed.  Warn and
 * ignore any misformatted lines. */
98
99
100
101
static struct config_line_t *config_get_lines(FILE *f) {

  struct config_line_t *front = NULL;
  char line[CONFIG_LINE_T_MAXLEN];
102
103
  int result;
  char *key, *value;
104

105
  while( (result=parse_line_from_file(line,sizeof(line),f,&key,&value)) > 0) {
106
    front = config_line_prepend(front, key, value);
Roger Dingledine's avatar
Roger Dingledine committed
107
  }
108
109
  if(result < 0)
    return NULL;
110
  return front;
Roger Dingledine's avatar
Roger Dingledine committed
111
112
}

Nick Mathewson's avatar
Nick Mathewson committed
113
114
115
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
116
117
static void config_free_lines(struct config_line_t *front) {
  struct config_line_t *tmp;
118
119
120
121
122
123
124
125
126
127
128

  while(front) {
    tmp = front;
    front = tmp->next;

    free(tmp->key);
    free(tmp->value);
    free(tmp);
  }
}

Nick Mathewson's avatar
Nick Mathewson committed
129
130
131
132
133
134
/** Search the linked list <b>c</b> for any option whose key is <b>key</b>.
 * If such an option is found, interpret it as of type <b>type</b>, and store
 * the result in <b>arg</b>.  If the option is misformatted, log a warning and
 * skip it.
 */
static int config_compare(struct config_line_t *c, char *key, config_type_t type, void *arg) {
135
  int i;
136
137
138
139
140

  if(strncasecmp(c->key,key,strlen(c->key)))
    return 0;

  /* it's a match. cast and assign. */
141
  log_fn(LOG_DEBUG,"Recognized keyword '%s' as %s, using value '%s'.",c->key,key,c->value);
142
143

  switch(type) {
Roger Dingledine's avatar
Roger Dingledine committed
144
    case CONFIG_TYPE_INT:
145
      *(int *)arg = atoi(c->value);
146
      break;
147
148
149
    case CONFIG_TYPE_BOOL:
      i = atoi(c->value);
      if (i != 0 && i != 1) {
Roger Dingledine's avatar
Roger Dingledine committed
150
        log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1", c->key);
151
        return 0;
152
153
154
      }
      *(int *)arg = i;
      break;
155
    case CONFIG_TYPE_STRING:
156
      tor_free(*(char **)arg);
157
      *(char **)arg = tor_strdup(c->value);
158
      break;
159
160
    case CONFIG_TYPE_DOUBLE:
      *(double *)arg = atof(c->value);
161
      break;
162
163
164
165
166
167
168
    case CONFIG_TYPE_LINELIST:
      /* Note: this reverses the order that the lines appear in.  That's
       * just fine, since we build up the list of lines reversed in the
       * first place. */
      *(struct config_line_t**)arg =
        config_line_prepend(*(struct config_line_t**)arg, c->key, c->value);
      break;
169
170
171
172
  }
  return 1;
}

Nick Mathewson's avatar
Nick Mathewson committed
173
174
/** Iterate through the linked list of options <b>list</b>.
 * For each item, convert as appropriate and assign to <b>options</b>.
175
176
 * If an item is unrecognized, return -1 immediately,
 * else return 0 for success. */
177
static int config_assign(or_options_t *options, struct config_line_t *list) {
178
179
180
181
182
183
184

  while(list) {
    if(

    /* order matters here! abbreviated arguments use the first match. */

    /* string options */
185
186
    config_compare(list, "Address",        CONFIG_TYPE_STRING, &options->Address) ||

187
188
189
    config_compare(list, "BandwidthRate",  CONFIG_TYPE_INT, &options->BandwidthRate) ||
    config_compare(list, "BandwidthBurst", CONFIG_TYPE_INT, &options->BandwidthBurst) ||

190
    config_compare(list, "DebugLogFile",   CONFIG_TYPE_STRING, &options->DebugLogFile) ||
191
    config_compare(list, "DataDirectory",  CONFIG_TYPE_STRING, &options->DataDirectory) ||
192
193
194
195
    config_compare(list, "DirPort",        CONFIG_TYPE_INT, &options->DirPort) ||
    config_compare(list, "DirBindAddress", CONFIG_TYPE_STRING, &options->DirBindAddress) ||
    config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_INT, &options->DirFetchPostPeriod) ||

196
197
    config_compare(list, "ExitNodes",      CONFIG_TYPE_STRING, &options->ExitNodes) ||
    config_compare(list, "EntryNodes",     CONFIG_TYPE_STRING, &options->EntryNodes) ||
198
    config_compare(list, "ExitPolicy",     CONFIG_TYPE_STRING, &options->ExitPolicy) ||
199
    config_compare(list, "ExcludeNodes",   CONFIG_TYPE_STRING, &options->ExcludeNodes) ||
200

201
    config_compare(list, "Group",          CONFIG_TYPE_STRING, &options->Group) ||
202

203
204
205
206
207
208
209
210
211
    config_compare(list, "IgnoreVersion",  CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||

    config_compare(list, "KeepalivePeriod",CONFIG_TYPE_INT, &options->KeepalivePeriod) ||

    config_compare(list, "LogLevel",       CONFIG_TYPE_STRING, &options->LogLevel) ||
    config_compare(list, "LogFile",        CONFIG_TYPE_STRING, &options->LogFile) ||
    config_compare(list, "LinkPadding",    CONFIG_TYPE_BOOL, &options->LinkPadding) ||

    config_compare(list, "MaxConn",        CONFIG_TYPE_INT, &options->MaxConn) ||
212
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
213
214

    config_compare(list, "Nickname",       CONFIG_TYPE_STRING, &options->Nickname) ||
215
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
216
    config_compare(list, "NumCpus",        CONFIG_TYPE_INT, &options->NumCpus) ||
217

218
219
    config_compare(list, "ORPort",         CONFIG_TYPE_INT, &options->ORPort) ||
    config_compare(list, "ORBindAddress",  CONFIG_TYPE_STRING, &options->ORBindAddress) ||
220

221
    config_compare(list, "PidFile",        CONFIG_TYPE_STRING, &options->PidFile) ||
222
    config_compare(list, "PathlenCoinWeight",CONFIG_TYPE_DOUBLE, &options->PathlenCoinWeight) ||
223
224
225

    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||
    config_compare(list, "RunAsDaemon",    CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
226
    config_compare(list, "RecommendedVersions",CONFIG_TYPE_STRING, &options->RecommendedVersions) ||
227
228
    config_compare(list, "RendNodes",      CONFIG_TYPE_STRING, &options->RendNodes) ||
    config_compare(list, "RendExcludeNodes",CONFIG_TYPE_STRING, &options->RendExcludeNodes) ||
229

230
231
232
233
234
    config_compare(list, "SocksPort",      CONFIG_TYPE_INT, &options->SocksPort) ||
    config_compare(list, "SocksBindAddress",CONFIG_TYPE_STRING,&options->SocksBindAddress) ||

    config_compare(list, "TrafficShaping", CONFIG_TYPE_BOOL, &options->TrafficShaping) ||

235
    config_compare(list, "User",           CONFIG_TYPE_STRING, &options->User) ||
236
    config_compare(list, "RunTesting",     CONFIG_TYPE_BOOL, &options->RunTesting) ||
237
238
239
240
    config_compare(list, "HiddenServiceDir", CONFIG_TYPE_LINELIST, &options->RendConfigLines)||
    config_compare(list, "HiddenServicePort", CONFIG_TYPE_LINELIST, &options->RendConfigLines)||
    config_compare(list, "HiddenServiceNodes", CONFIG_TYPE_LINELIST, &options->RendConfigLines)||
    config_compare(list, "HiddenServiceExcludeNodes", CONFIG_TYPE_LINELIST, &options->RendConfigLines)
241
242
243
    ) {
      /* then we're ok. it matched something. */
    } else {
244
245
      log_fn(LOG_WARN,"Unknown keyword '%s'. Failing.",list->key);
      return -1;
246
247
248
    }

    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
249
  }
250
  return 0;
251
252
}

253
254
255
/* XXX are there any other specifiers we want to give so making
 * a several-thousand-byte string is less painful? */
const char default_dirservers_string[] =
256
257
258
259
"router moria1 18.244.0.188 9001 9021 9031\n"
"platform Tor 0.0.6rc1 on Linux moria.mit.edu i686\n"
"published 2004-04-25 21:54:28\n"
"bandwidth 800000 10000000\n"
260
261
262
263
264
265
266
267
268
269
270
271
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBANoIvHieyHUTzIacbnWOnyTyzGrLOdXqbcjz2GGMxyHEd5K1bO1ZBNHP\n"
"9i5qLQpN5viFk2K2rEGuG8tFgDEzSWZEtBqv3NVfUdiumdERWMBwlaQ0MVK4C+jf\n"
"y5gZ8KI3o9ZictgPS1AQF+Kk932/vIHTuRIUKb4ILTnQilNvID0NAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBAMHa0ZC/jo2Q2DrwKYF/6ZbmZ27PFYG91u4gUzzmZ/VXLpZ8wNzEV3oW\n"
"nt+I61048fBiC1frT1/DZ351n2bLSk9zJbB6jyGZJn0380FPRX3+cXyXS0Gq8Ril\n"
"xkhMQf5XuNFUb8UmYPSOH4WErjvYjKvU+gfjbK/82Jo9SuHpYz+BAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
"reject 0.0.0.0/255.0.0.0:*\n"
"reject 169.254.0.0/255.255.0.0:*\n"
"reject 127.0.0.0/255.0.0.0:*\n"
"reject 192.168.0.0/255.255.0.0:*\n"
"reject 10.0.0.0/255.0.0.0:*\n"
"reject 172.16.0.0/255.240.0.0:*\n"
"accept *:20-22\n"
"accept *:53\n"
"accept *:79-80\n"
"accept *:110\n"
"accept *:143\n"
"accept *:443\n"
"accept *:873\n"
"accept *:993\n"
"accept *:995\n"
"accept *:1024-65535\n"
"reject *:*\n"
289
290
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
291
292
293
"o1eAoRHDAEAXsnh5wN++vIwrupd+DbAJ2p3wxHDrmqxTpygzxxCnyQyhMfX03ua2\n"
"4iplyNlwyFwzWcw0sk31otlO2HBYXT1V9G0YxGtKMOeOBMHjfGbUjGvEALHzWi4z\n"
"8DXGJp13zgnUyP4ZA6xaGROwcT6oB5e7UlztvvpGxTg=\n"
294
295
"-----END SIGNATURE-----\n"
"\n"
296
297
298
299
"router moria2 18.244.0.188 9002 9022 9032\n"
"platform Tor 0.0.6rc1 on Linux moria.mit.edu i686\n"
"published 2004-04-25 21:54:30\n"
"bandwidth 800000 10000000\n"
300
301
302
303
304
305
306
307
308
309
310
311
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBAM4Cc/npgYC54XrYLC+grVxJp7PDmNO2DRRJOxKttBBtvLpnR1UaueTi\n"
"kyknT5kmlx+ihgZF/jmye//2dDUp2+kK/kSkpRV4xnDLXZmed+sNSQxqmm9TtZQ9\n"
"/hjpxhp5J9HmUTYhntBs+4E4CUKokmrI6oRLoln4SA39AX9QLPcnAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
"MIGJAoGBAOcrht/y5rkaahfX7sMe2qnpqoPibsjTSJaDvsUtaNP/Bq0MgNDGOR48\n"
"rtwfqTRff275Edkp/UYw3G3vSgKCJr76/bqOHCmkiZrnPV1zxNfrK18gNw2Cxre0\n"
"nTA+fD8JQqpPtb8b0SnG9kwy75eS//sRu7TErie2PzGMxrf9LH0LAgMBAAE=\n"
"-----END RSA PUBLIC KEY-----\n"
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
"reject 0.0.0.0/255.0.0.0:*\n"
"reject 169.254.0.0/255.255.0.0:*\n"
"reject 127.0.0.0/255.0.0.0:*\n"
"reject 192.168.0.0/255.255.0.0:*\n"
"reject 10.0.0.0/255.0.0.0:*\n"
"reject 172.16.0.0/255.240.0.0:*\n"
"accept *:20-22\n"
"accept *:53\n"
"accept *:79-80\n"
"accept *:110\n"
"accept *:143\n"
"accept *:443\n"
"accept *:873\n"
"accept *:993\n"
"accept *:995\n"
"accept *:1024-65535\n"
"reject *:*\n"
329
330
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
331
332
333
"RKROLwP1ExjTZeg6wuN0pzYqed9IJUd5lAe9hp4ritbnmJAgS6qfww6jgx61CfUR\n"
"6SElhOLE7Q77jAdoL45Ji5pn/Y+Q+E+5lJm1E/ed9ha+YsOPaOc7z6GQ7E4mihCL\n"
"gI1vsw92+P1Ty4RHj6fyD9DhbV19nh2Qs+pvGJOS2FY=\n"
334
335
"-----END SIGNATURE-----\n"
"\n"
336
337
338
339
"router tor26 62.116.124.106 9001 9050 9030\n"
"platform Tor 0.0.6 on Linux seppia i686\n"
"published 2004-05-06 21:33:23\n"
"bandwidth 500000 10000000\n"
340
341
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
342
343
344
"MIGJAoGBAMEHdDnpj3ik1AF1xe/VqjoguH2DbANifYqXXfempu0fS+tU9FGo6dU/\n"
"fnVHAZwL9Ek9k2rMzumShi1RduK9p035R/Gk+PBBcLfvwYJ/Nat+ZO/L8jn/3bZe\n"
"ieQd9CKj2LjNGKpRNry37vkwMGIOIlegwK+2us8aXJ7sIvlNts0TAgMBAAE=\n"
345
346
347
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
348
349
350
"MIGJAoGBAMQgV2gXLbXgesWgeAsj8P1Uvm/zibrFXqwDq27lLKNgWGYGX2ax3LyT\n"
"3nzI1Y5oLs4kPKTsMM5ft9aokwf417lKoCRlZc9ptfRbgxDx90c9GtWVmkrmDvCK\n"
"ae59TMoXIiGfZiwWT6KKq5Zm9/Fu2Il3B2vHGkKJYKixmiBJRKp/AgMBAAE=\n"
351
"-----END RSA PUBLIC KEY-----\n"
352
353
354
"accept 62.245.184.24:25\n"
"accept 62.116.124.106:6666-6670\n"
"accept *:48099\n"
355
"reject *:*\n"
356
357
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
358
359
360
"qh/xRoqfLNFzPaB8VdpbdMAwRyuk5qjx4LeLVQ2pDwTZ55PqmG99+VKUNte2WTTD\n"
"7dZEA7um2rueohGe4nYmvbhJWr20/I0ZxmWDRDvFy0b5nwzDMGvLvDw95Zu/XJQ2\n"
"md32NE3y9VZCfbCN+GlvETX3fdR3Svzcm8Kzesg2/s4=\n"
361
362
363
"-----END SIGNATURE-----\n"
;

364
int config_assign_default_dirservers(void) {
365
  if(router_load_routerlist_from_string(default_dirservers_string, 1) < 0) {
366
367
368
369
370
371
    log_fn(LOG_WARN,"Bug: the default dirservers internal string is corrupt.");
    return -1;
  }
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
372
373
374
375
/** Set <b>options</b> to a reasonable default.
 *
 * Call this function when they're using the default torrc but
 * we can't find it. For now, we just hard-code what comes in the
376
377
378
379
380
381
382
383
 * default torrc.
 */
static int config_assign_default(or_options_t *options) {

  /* set them up as a client only */
  options->SocksPort = 9050;

  /* plus give them a dirservers file */
384
  if(config_assign_default_dirservers() < 0)
385
386
387
388
    return -1;
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
389
/** Print a usage message for tor. */
390
static void print_usage(void) {
391
  printf("tor -f <torrc> [args]\n"
392
         "See man page for more options. This -h is probably obsolete.\n\n"
393
         "-b <bandwidth>\t\tbytes/second rate limiting\n"
394
         "-d <file>\t\tDebug file\n"
395
//         "-m <max>\t\tMax number of connections\n"
396
397
398
399
         "-l <level>\t\tLog level\n"
         "-r <file>\t\tList of known routers\n");
  printf("\nClient options:\n"
         "-e \"nick1 nick2 ...\"\t\tExit nodes\n"
400
         "-s <IP>\t\t\tPort to bind to for Socks\n"
401
         );
402
403
  printf("\nServer options:\n"
         "-n <nick>\t\tNickname of router\n"
404
405
406
         "-o <port>\t\tOR port to bind to\n"
         "-p <file>\t\tPID file\n"
         );
407
408
}

Nick Mathewson's avatar
Nick Mathewson committed
409
410
411
/**
 * Adjust <b>options</b> to contain a reasonable value for Address.
 */
412
static int resolve_my_address(or_options_t *options) {
413
414
415
  struct in_addr in;
  struct hostent *rent;
  char localhostname[256];
416
  int explicit_ip=1;
417
418

  if(!options->Address) { /* then we need to guess our address */
419
    explicit_ip = 0; /* it's implicit */
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437

    if(gethostname(localhostname,sizeof(localhostname)) < 0) {
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
#if 0 /* don't worry about complaining, as long as it resolves */
    if(!strchr(localhostname,'.')) {
      log_fn(LOG_WARN,"fqdn '%s' has only one element. Misconfigured machine?",address);
      log_fn(LOG_WARN,"Try setting the Address line in your config file.");
      return -1;
    }
#endif
    options->Address = tor_strdup(localhostname);
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",options->Address);
  }

  /* now we know options->Address is set. resolve it and keep only the IP */

438
439
440
441
442
443
444
445
  if(tor_inet_aton(options->Address, &in) == 0) {
    /* then we have to resolve it */
    explicit_ip = 0;
    rent = (struct hostent *)gethostbyname(options->Address);
    if (!rent) {
      log_fn(LOG_WARN,"Could not resolve Address %s. Failing.", options->Address);
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
446
    tor_assert(rent->h_length == 4);
447
    memcpy(&in.s_addr, rent->h_addr,rent->h_length);
448
  }
449
  if(!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
450
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
451
           "Please set the Address config option to be the IP you want to use.",
452
453
454
455
456
457
458
459
460
           options->Address, inet_ntoa(in));
    return -1;
  }
  tor_free(options->Address);
  options->Address = tor_strdup(inet_ntoa(in));
  log_fn(LOG_DEBUG,"Resolved Address to %s.", options->Address);
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
461
/** Release storage held by <b>options</b> */
462
static void free_options(or_options_t *options) {
463
464
465
466
467
468
469
470
  tor_free(options->LogLevel);
  tor_free(options->LogFile);
  tor_free(options->DebugLogFile);
  tor_free(options->DataDirectory);
  tor_free(options->RouterFile);
  tor_free(options->Nickname);
  tor_free(options->Address);
  tor_free(options->PidFile);
471
472
  tor_free(options->ExitNodes);
  tor_free(options->EntryNodes);
473
  tor_free(options->ExcludeNodes);
474
475
  tor_free(options->RendNodes);
  tor_free(options->RendExcludeNodes);
476
  tor_free(options->ExitPolicy);
477
478
  tor_free(options->SocksBindAddress);
  tor_free(options->ORBindAddress);
479
  tor_free(options->DirBindAddress);
480
  tor_free(options->RecommendedVersions);
481
482
  tor_free(options->User);
  tor_free(options->Group);
483
  config_free_lines(options->RendConfigLines);
484
}
485

Nick Mathewson's avatar
Nick Mathewson committed
486
/** Set <b>options</b> to hold reasonable defaults for most options. */
487
static void init_options(or_options_t *options) {
488
/* give reasonable values for each option. Defaults to zero. */
489
  memset(options,0,sizeof(or_options_t));
490
  options->LogLevel = tor_strdup("notice");
491
492
  options->ExitNodes = tor_strdup("");
  options->EntryNodes = tor_strdup("");
493
  options->ExcludeNodes = tor_strdup("");
494
495
  options->RendNodes = tor_strdup("");
  options->RendExcludeNodes = tor_strdup("");
496
  options->ExitPolicy = tor_strdup("");
497
498
  options->SocksBindAddress = tor_strdup("127.0.0.1");
  options->ORBindAddress = tor_strdup("0.0.0.0");
499
  options->DirBindAddress = tor_strdup("0.0.0.0");
500
  options->RecommendedVersions = NULL;
501
  options->loglevel = LOG_INFO;
502
  options->PidFile = NULL; // tor_strdup("tor.pid");
503
  options->DataDirectory = NULL;
504
  options->PathlenCoinWeight = 0.3;
505
  options->MaxConn = 900;
506
  options->DirFetchPostPeriod = 600;
507
  options->KeepalivePeriod = 300;
508
  options->MaxOnionsPending = 100;
509
  options->NewCircuitPeriod = 30; /* twice a minute */
510
511
  options->BandwidthRate = 800000; /* at most 800kB/s total sustained incoming */
  options->BandwidthBurst = 10000000; /* max burst on the token bucket */
512
  options->NumCpus = 1;
513
  options->RendConfigLines = NULL;
514
515
}

Nick Mathewson's avatar
Nick Mathewson committed
516
517
518
/** Read a configuration file into <b>options</b>, finding the configuration
 * file location based on the command line.  After loading the options,
 * validate them for consistency. Return 0 if success, <0 if failure. */
519
int getconfig(int argc, char **argv, or_options_t *options) {
520
  struct config_line_t *cl;
521
522
523
524
  FILE *cf;
  char *fname;
  int i;
  int result = 0;
525
526
527
528
529
  static int first_load = 1;
  static char **backup_argv;
  static int backup_argc;
  char *previous_pidfile = NULL;
  int previous_runasdaemon = 0;
530
  int previous_orport = -1;
531
  int using_default_torrc;
532
533
534
535
536
537
538
539
540
541

  if(first_load) { /* first time we're called. save commandline args */
    backup_argv = argv;
    backup_argc = argc;
    first_load = 0;
  } else { /* we're reloading. need to clean up old ones first. */
    argv = backup_argv;
    argc = backup_argc;

    /* record some previous values, so we can fail if they change */
542
543
    if(options->PidFile)
      previous_pidfile = tor_strdup(options->PidFile);
544
    previous_runasdaemon = options->RunAsDaemon;
545
    previous_orport = options->ORPort;
546
547
    free_options(options);
  }
Roger Dingledine's avatar
Roger Dingledine committed
548
  init_options(options);
549

550
551
552
553
554
  if(argc > 1 && (!strcmp(argv[1], "-h") || !strcmp(argv[1],"--help"))) {
    print_usage();
    exit(0);
  }

555
556
557
558
559
  if(argc > 1 && (!strcmp(argv[1],"--version"))) {
    printf("Tor version %s.\n",VERSION);
    exit(0);
  }

560
561
562
563
564
565
/* learn config file name, get config lines, assign them */
  i = 1;
  while(i < argc-1 && strcmp(argv[i],"-f")) {
    i++;
  }
  if(i < argc-1) { /* we found one */
566
    fname = argv[i+1];
567
    using_default_torrc = 0;
568
569
  } else { /* didn't find one, try CONFDIR */
    fname = CONFDIR "/torrc";
570
    using_default_torrc = 1;
571
572
573
574
  }
  log(LOG_DEBUG,"Opening config file '%s'",fname);

  cf = config_open(fname);
575
  if(!cf) {
576
    if(using_default_torrc == 1) {
577
      log(LOG_NOTICE, "Configuration file '%s' not present, using reasonable defaults.",fname);
578
579
580
581
582
583
584
585
586
      if(config_assign_default(options) < 0)
        return -1;
    } else {
      log(LOG_WARN, "Unable to open configuration file '%s'.",fname);
      return -1;
    }
  } else { /* it opened successfully. use it. */
    cl = config_get_lines(cf);
    if(!cl) return -1;
587
588
    if(config_assign(options,cl) < 0)
      return -1;
589
590
    config_free_lines(cl);
    config_close(cf);
591
  }
592

593
594
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
595
596
  if(config_assign(options,cl) < 0)
    return -1;
597
598
599
600
  config_free_lines(cl);

/* Validate options */

601
  /* first check if any of the previous options have changed but aren't allowed to */
602
603
604
605
606
607
608
609
610
611
612
613
  if(previous_pidfile && strcmp(previous_pidfile,options->PidFile)) {
    log_fn(LOG_WARN,"During reload, PidFile changed from %s to %s. Failing.",
           previous_pidfile, options->PidFile);
    return -1;
  }
  tor_free(previous_pidfile);

  if(previous_runasdaemon && !options->RunAsDaemon) {
    log_fn(LOG_WARN,"During reload, change from RunAsDaemon=1 to =0 not allowed. Failing.");
    return -1;
  }

614
  if(previous_orport == 0 && options->ORPort > 0) {
Roger Dingledine's avatar
Roger Dingledine committed
615
    log_fn(LOG_WARN,"During reload, change from ORPort=0 to >0 not allowed. Failing.");
616
617
618
    return -1;
  }

619
  if(options->LogLevel) {
620
    if(!strcmp(options->LogLevel,"err"))
621
      options->loglevel = LOG_ERR;
Roger Dingledine's avatar
Roger Dingledine committed
622
623
    else if(!strcmp(options->LogLevel,"warn"))
      options->loglevel = LOG_WARN;
624
625
    else if(!strcmp(options->LogLevel,"notice"))
      options->loglevel = LOG_NOTICE;
626
627
628
629
630
    else if(!strcmp(options->LogLevel,"info"))
      options->loglevel = LOG_INFO;
    else if(!strcmp(options->LogLevel,"debug"))
      options->loglevel = LOG_DEBUG;
    else {
631
      log(LOG_WARN,"LogLevel must be one of err|warn|notice|info|debug.");
632
633
634
635
      result = -1;
    }
  }

636
  if(options->ORPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
637
    log(LOG_WARN,"ORPort option can't be negative.");
638
639
640
    result = -1;
  }

641
642
  if(options->ORPort && options->DataDirectory == NULL) {
    log(LOG_WARN,"DataDirectory option required if ORPort is set, but not found.");
643
644
645
    result = -1;
  }

646
647
648
649
  if (options->ORPort) {
    if (options->Nickname == NULL) {
      log_fn(LOG_WARN,"Nickname required if ORPort is set, but not found.");
      result = -1;
650
651
652
653
654
655
656
657
658
659
660
    } else {
      if (strspn(options->Nickname, LEGAL_NICKNAME_CHARACTERS) !=
                 strlen(options->Nickname)) {
        log_fn(LOG_WARN, "Nickname '%s' contains illegal characters.", options->Nickname);
        result = -1;
      }
      if (strlen(options->Nickname) > MAX_NICKNAME_LEN) {
        log_fn(LOG_WARN, "Nickname '%s' has more than %d characters.",
               options->Nickname, MAX_NICKNAME_LEN);
        result = -1;
      }
661
    }
662
663
  }

664
  if(options->ORPort) { /* get an IP for ourselves */
665
666
    if(resolve_my_address(options) < 0)
      result = -1;
667
668
  }

669
670
  if(options->SocksPort < 0) {
    log(LOG_WARN,"SocksPort option can't be negative.");
671
672
673
    result = -1;
  }

674
675
676
  if(options->SocksPort == 0 && options->ORPort == 0) {
    log(LOG_WARN,"SocksPort and ORPort are both undefined? Quitting.");
    result = -1;
Roger Dingledine's avatar
Roger Dingledine committed
677
  }
678

679
  if(options->DirPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
680
    log(LOG_WARN,"DirPort option can't be negative.");
681
682
683
    result = -1;
  }

684
685
686
687
688
  if(options->DirPort && options->RecommendedVersions == NULL) {
    log(LOG_WARN,"Directory servers must configure RecommendedVersions.");
    result = -1;
  }

689
  if(options->SocksPort > 1 &&
690
691
     (options->PathlenCoinWeight < 0.0 || options->PathlenCoinWeight >= 1.0)) {
    log(LOG_WARN,"PathlenCoinWeight option must be >=0.0 and <1.0.");
692
693
694
    result = -1;
  }

695
  if(options->MaxConn < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
696
    log(LOG_WARN,"MaxConn option must be a non-zero positive integer.");
697
698
699
700
    result = -1;
  }

  if(options->MaxConn >= MAXCONNECTIONS) {
Roger Dingledine's avatar
Roger Dingledine committed
701
    log(LOG_WARN,"MaxConn option must be less than %d.", MAXCONNECTIONS);
702
703
704
    result = -1;
  }

705
  if(options->DirFetchPostPeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
706
    log(LOG_WARN,"DirFetchPostPeriod option must be positive.");
707
708
    result = -1;
  }
709
710
711
712
  if(options->DirFetchPostPeriod > MIN_ONION_KEY_LIFETIME/2) {
    log(LOG_WARN,"DirFetchPostPeriod is too large; clipping.");
    options->DirFetchPostPeriod = MIN_ONION_KEY_LIFETIME/2;
  }
713
714

  if(options->KeepalivePeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
715
    log(LOG_WARN,"KeepalivePeriod option must be positive.");
716
717
718
    result = -1;
  }

719
720
721
722
  /* XXX look at the various nicknamelists and make sure they're
   * valid and don't have hostnames that are too long.
   */

723
724
725
726
  if (rend_config_services(options) < 0) {
    result = -1;
  }

727
  return result;
728
729
}

730
731
732
733
734
735
736
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/