config.c 33.8 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"
13
14
15
#ifdef MS_WINDOWS
#include <shlobj.h>
#endif
Roger Dingledine's avatar
Roger Dingledine committed
16

Nick Mathewson's avatar
Nick Mathewson committed
17
18
19
20
21
22
/** 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. */
23
24
  CONFIG_TYPE_CSV, /**< A list of strings, separated by commas and optional
                    * whitespace. */
Nick Mathewson's avatar
Nick Mathewson committed
25
26
  CONFIG_TYPE_LINELIST, /**< Uninterpreted config lines */
} config_type_t;
27

Nick Mathewson's avatar
Nick Mathewson committed
28
/** Largest allowed config line */
29
#define CONFIG_LINE_T_MAXLEN 4096
30

31
32
33
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);
34
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg);
35
static int config_assign(or_options_t *options, struct config_line_t *list);
36

Nick Mathewson's avatar
Nick Mathewson committed
37
/** Helper: Read a list of configuration options from the command line. */
38
39
40
static struct config_line_t *config_get_commandlines(int argc, char **argv) {
  struct config_line_t *new;
  struct config_line_t *front = NULL;
41
42
43
  char *s;
  int i = 1;

Roger Dingledine's avatar
Roger Dingledine committed
44
  while(i < argc-1) {
45
46
47
48
49
50
    if(!strcmp(argv[i],"-f")) {
//      log(LOG_DEBUG,"Commandline: skipping over -f.");
      i+=2; /* this is the config file option. ignore it. */
      continue;
    }

51
    new = tor_malloc(sizeof(struct config_line_t));
52
53
54
    s = argv[i];
    while(*s == '-')
      s++;
55
56
    new->key = tor_strdup(s);
    new->value = tor_strdup(argv[i+1]);
57
58
59
60
61
62
63
64
65
66

    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
67
68
/** Helper: allocate a new configuration option mapping 'key' to 'val',
 * prepend it to 'front', and return the newly allocated config_line_t */
69
70
71
72
73
74
75
76
77
78
79
80
81
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;
}

82
/** Helper: parse the config file and strdup into key/value
Nick Mathewson's avatar
Nick Mathewson committed
83
84
 * strings. Return list, or NULL if parsing the file failed.  Warn and
 * ignore any misformatted lines. */
85
86
87
88
static struct config_line_t *config_get_lines(FILE *f) {

  struct config_line_t *front = NULL;
  char line[CONFIG_LINE_T_MAXLEN];
89
90
  int result;
  char *key, *value;
91

92
  while( (result=parse_line_from_file(line,sizeof(line),f,&key,&value)) > 0) {
93
    front = config_line_prepend(front, key, value);
Roger Dingledine's avatar
Roger Dingledine committed
94
  }
95
96
  if(result < 0)
    return NULL;
97
  return front;
Roger Dingledine's avatar
Roger Dingledine committed
98
99
}

Nick Mathewson's avatar
Nick Mathewson committed
100
101
102
/**
 * Free all the configuration lines on the linked list <b>front</b>.
 */
103
104
static void config_free_lines(struct config_line_t *front) {
  struct config_line_t *tmp;
105
106
107
108
109
110
111
112
113
114
115

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

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

Nick Mathewson's avatar
Nick Mathewson committed
116
117
118
119
120
/** 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.
 */
121
static int config_compare(struct config_line_t *c, const char *key, config_type_t type, void *arg) {
122
  int i;
123
124
125
126

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

127
128
129
130
131
  if(strcasecmp(c->key,key)) {
    tor_free(c->key);
    c->key = tor_strdup(key);
  }

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

  switch(type) {
Roger Dingledine's avatar
Roger Dingledine committed
136
    case CONFIG_TYPE_INT:
137
      *(int *)arg = atoi(c->value);
138
      break;
139
140
141
    case CONFIG_TYPE_BOOL:
      i = atoi(c->value);
      if (i != 0 && i != 1) {
Roger Dingledine's avatar
Roger Dingledine committed
142
        log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1", c->key);
143
        return 0;
144
145
146
      }
      *(int *)arg = i;
      break;
147
    case CONFIG_TYPE_STRING:
148
      tor_free(*(char **)arg);
149
      *(char **)arg = tor_strdup(c->value);
150
      break;
151
152
    case CONFIG_TYPE_DOUBLE:
      *(double *)arg = atof(c->value);
153
      break;
154
    case CONFIG_TYPE_CSV:
155
156
      if(*(smartlist_t**)arg == NULL)
        *(smartlist_t**)arg = smartlist_create();
157
158
      smartlist_split_string(*(smartlist_t**)arg, c->value, ",",
                             SPLIT_SKIP_SPACE|SPLIT_IGNORE_BLANK, 0);
159
      break;
160
161
162
163
164
165
166
    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;
167
168
169
170
  }
  return 1;
}

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

  while(list) {
    if(

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

    /* string options */
183
    config_compare(list, "Address",        CONFIG_TYPE_STRING, &options->Address) ||
184
    config_compare(list, "AllowUnverifiedNodes", CONFIG_TYPE_CSV, &options->AllowUnverifiedNodes) ||
185
    config_compare(list, "AuthoritativeDirectory",CONFIG_TYPE_BOOL, &options->AuthoritativeDir) ||
186

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, "ClientOnly",     CONFIG_TYPE_BOOL, &options->ClientOnly) ||
191
    config_compare(list, "ContactInfo",    CONFIG_TYPE_STRING, &options->ContactInfo) ||
192

193
    config_compare(list, "DebugLogFile",   CONFIG_TYPE_STRING, &options->DebugLogFile) ||
194
    config_compare(list, "DataDirectory",  CONFIG_TYPE_STRING, &options->DataDirectory) ||
195
    config_compare(list, "DirPort",        CONFIG_TYPE_INT, &options->DirPort) ||
196
    config_compare(list, "DirBindAddress", CONFIG_TYPE_LINELIST, &options->DirBindAddress) ||
197
198
    config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_INT, &options->DirFetchPostPeriod) ||

199
200
    config_compare(list, "ExitNodes",      CONFIG_TYPE_STRING, &options->ExitNodes) ||
    config_compare(list, "EntryNodes",     CONFIG_TYPE_STRING, &options->EntryNodes) ||
201
202
    config_compare(list, "StrictExitNodes", CONFIG_TYPE_BOOL, &options->StrictExitNodes) ||
    config_compare(list, "StrictEntryNodes", CONFIG_TYPE_BOOL, &options->StrictEntryNodes) ||
203
    config_compare(list, "ExitPolicy",     CONFIG_TYPE_LINELIST, &options->ExitPolicy) ||
204
    config_compare(list, "ExcludeNodes",   CONFIG_TYPE_STRING, &options->ExcludeNodes) ||
205

206
    config_compare(list, "FascistFirewall",CONFIG_TYPE_BOOL, &options->FascistFirewall) ||
207
    config_compare(list, "FirewallPorts",CONFIG_TYPE_CSV, &options->FirewallPorts) ||
208

209
    config_compare(list, "Group",          CONFIG_TYPE_STRING, &options->Group) ||
210

211
212
213
214
215
    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)||

216
217
218
219
    config_compare(list, "IgnoreVersion",  CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||

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

220
221
    config_compare(list, "LogLevel",       CONFIG_TYPE_LINELIST, &options->LogOptions) ||
    config_compare(list, "LogFile",        CONFIG_TYPE_LINELIST, &options->LogOptions) ||
222
223
224
    config_compare(list, "LinkPadding",    CONFIG_TYPE_BOOL, &options->LinkPadding) ||

    config_compare(list, "MaxConn",        CONFIG_TYPE_INT, &options->MaxConn) ||
225
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
226
227

    config_compare(list, "Nickname",       CONFIG_TYPE_STRING, &options->Nickname) ||
228
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
229
    config_compare(list, "NumCpus",        CONFIG_TYPE_INT, &options->NumCpus) ||
230

231
    config_compare(list, "ORPort",         CONFIG_TYPE_INT, &options->ORPort) ||
232
    config_compare(list, "ORBindAddress",  CONFIG_TYPE_LINELIST, &options->ORBindAddress) ||
233
    config_compare(list, "OutboundBindAddress",CONFIG_TYPE_STRING, &options->OutboundBindAddress) ||
234

235
    config_compare(list, "PidFile",        CONFIG_TYPE_STRING, &options->PidFile) ||
236
    config_compare(list, "PathlenCoinWeight",CONFIG_TYPE_DOUBLE, &options->PathlenCoinWeight) ||
237
238
239

    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||
    config_compare(list, "RunAsDaemon",    CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
240
    config_compare(list, "RunTesting",     CONFIG_TYPE_BOOL, &options->RunTesting) ||
241
    config_compare(list, "RecommendedVersions",CONFIG_TYPE_STRING, &options->RecommendedVersions) ||
242
243
    config_compare(list, "RendNodes",      CONFIG_TYPE_STRING, &options->RendNodes) ||
    config_compare(list, "RendExcludeNodes",CONFIG_TYPE_STRING, &options->RendExcludeNodes) ||
244

245
    config_compare(list, "SocksPort",      CONFIG_TYPE_INT, &options->SocksPort) ||
246
247
    config_compare(list, "SocksBindAddress",CONFIG_TYPE_LINELIST,&options->SocksBindAddress) ||
    config_compare(list, "SocksPolicy",     CONFIG_TYPE_LINELIST,&options->SocksPolicy) ||
248
249
250

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

251
252
253
    config_compare(list, "User",           CONFIG_TYPE_STRING, &options->User)


254
255
256
    ) {
      /* then we're ok. it matched something. */
    } else {
257
258
      log_fn(LOG_WARN,"Unknown keyword '%s'. Failing.",list->key);
      return -1;
259
260
261
    }

    list = list->next;
Roger Dingledine's avatar
Roger Dingledine committed
262
  }
263
  return 0;
264
265
}

266
const char default_dirservers_string[] =
267
268
269
270
"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"
271
272
273
274
275
276
277
278
279
280
281
282
"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"
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
"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"
300
301
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
302
303
304
"o1eAoRHDAEAXsnh5wN++vIwrupd+DbAJ2p3wxHDrmqxTpygzxxCnyQyhMfX03ua2\n"
"4iplyNlwyFwzWcw0sk31otlO2HBYXT1V9G0YxGtKMOeOBMHjfGbUjGvEALHzWi4z\n"
"8DXGJp13zgnUyP4ZA6xaGROwcT6oB5e7UlztvvpGxTg=\n"
305
306
"-----END SIGNATURE-----\n"
"\n"
307
308
309
310
"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"
311
312
313
314
315
316
317
318
319
320
321
322
"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"
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
"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"
340
341
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
342
343
344
"RKROLwP1ExjTZeg6wuN0pzYqed9IJUd5lAe9hp4ritbnmJAgS6qfww6jgx61CfUR\n"
"6SElhOLE7Q77jAdoL45Ji5pn/Y+Q+E+5lJm1E/ed9ha+YsOPaOc7z6GQ7E4mihCL\n"
"gI1vsw92+P1Ty4RHj6fyD9DhbV19nh2Qs+pvGJOS2FY=\n"
345
346
"-----END SIGNATURE-----\n"
"\n"
347
348
349
350
"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"
351
352
"onion-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
353
354
355
"MIGJAoGBAMEHdDnpj3ik1AF1xe/VqjoguH2DbANifYqXXfempu0fS+tU9FGo6dU/\n"
"fnVHAZwL9Ek9k2rMzumShi1RduK9p035R/Gk+PBBcLfvwYJ/Nat+ZO/L8jn/3bZe\n"
"ieQd9CKj2LjNGKpRNry37vkwMGIOIlegwK+2us8aXJ7sIvlNts0TAgMBAAE=\n"
356
357
358
"-----END RSA PUBLIC KEY-----\n"
"signing-key\n"
"-----BEGIN RSA PUBLIC KEY-----\n"
359
360
361
"MIGJAoGBAMQgV2gXLbXgesWgeAsj8P1Uvm/zibrFXqwDq27lLKNgWGYGX2ax3LyT\n"
"3nzI1Y5oLs4kPKTsMM5ft9aokwf417lKoCRlZc9ptfRbgxDx90c9GtWVmkrmDvCK\n"
"ae59TMoXIiGfZiwWT6KKq5Zm9/Fu2Il3B2vHGkKJYKixmiBJRKp/AgMBAAE=\n"
362
"-----END RSA PUBLIC KEY-----\n"
363
364
365
"accept 62.245.184.24:25\n"
"accept 62.116.124.106:6666-6670\n"
"accept *:48099\n"
366
"reject *:*\n"
367
368
"router-signature\n"
"-----BEGIN SIGNATURE-----\n"
369
370
371
"qh/xRoqfLNFzPaB8VdpbdMAwRyuk5qjx4LeLVQ2pDwTZ55PqmG99+VKUNte2WTTD\n"
"7dZEA7um2rueohGe4nYmvbhJWr20/I0ZxmWDRDvFy0b5nwzDMGvLvDw95Zu/XJQ2\n"
"md32NE3y9VZCfbCN+GlvETX3fdR3Svzcm8Kzesg2/s4=\n"
372
373
374
"-----END SIGNATURE-----\n"
;

375
int config_assign_default_dirservers(void) {
376
  if(router_load_routerlist_from_string(default_dirservers_string, 1) < 0) {
377
378
379
380
381
382
    log_fn(LOG_WARN,"Bug: the default dirservers internal string is corrupt.");
    return -1;
  }
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
383
384
/** Set <b>options</b> to a reasonable default.
 *
Roger Dingledine's avatar
Roger Dingledine committed
385
 * Call this function when we can't find any torrc config file.
386
 */
Roger Dingledine's avatar
Roger Dingledine committed
387
static int config_assign_defaults(or_options_t *options) {
388
389
390
391

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

392
393
394
395
  options->AllowUnverifiedNodes = smartlist_create();
  smartlist_add(options->AllowUnverifiedNodes, "middle");
  smartlist_add(options->AllowUnverifiedNodes, "rendezvous");

Roger Dingledine's avatar
Roger Dingledine committed
396
397
398
  config_free_lines(options->ExitPolicy);
  options->ExitPolicy = config_line_prepend(NULL, "ExitPolicy", "reject *:*");

399
  /* plus give them a dirservers file */
400
  if(config_assign_default_dirservers() < 0)
401
402
403
404
    return -1;
  return 0;
}

Nick Mathewson's avatar
Nick Mathewson committed
405
/** Print a usage message for tor. */
406
static void print_usage(void) {
407
  printf("tor -f <torrc> [args]\n"
408
         "See man page for more options. This -h is probably obsolete.\n\n"
409
         "-b <bandwidth>\t\tbytes/second rate limiting\n"
410
         "-d <file>\t\tDebug file\n"
411
//         "-m <max>\t\tMax number of connections\n"
412
413
414
415
         "-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"
416
         "-s <IP>\t\t\tPort to bind to for Socks\n"
417
         );
418
419
  printf("\nServer options:\n"
         "-n <nick>\t\tNickname of router\n"
420
421
422
         "-o <port>\t\tOR port to bind to\n"
         "-p <file>\t\tPID file\n"
         );
423
424
}

Nick Mathewson's avatar
Nick Mathewson committed
425
426
427
/**
 * Adjust <b>options</b> to contain a reasonable value for Address.
 */
428
int resolve_my_address(const char *address, uint32_t *addr) {
429
430
  struct in_addr in;
  struct hostent *rent;
431
  char hostname[256];
432
  int explicit_ip=1;
433

434
435
436
437
438
  tor_assert(addr);

  if(address) {
    strlcpy(hostname,address,sizeof(hostname));
  } else { /* then we need to guess our address */
439
    explicit_ip = 0; /* it's implicit */
440

441
    if(gethostname(hostname,sizeof(hostname)) < 0) {
442
443
444
      log_fn(LOG_WARN,"Error obtaining local hostname");
      return -1;
    }
445
    log_fn(LOG_DEBUG,"Guessed local host name as '%s'",hostname);
446
447
  }

448
  /* now we know hostname. resolve it and keep only the IP */
449

450
  if(tor_inet_aton(hostname, &in) == 0) {
451
452
    /* then we have to resolve it */
    explicit_ip = 0;
453
    rent = (struct hostent *)gethostbyname(hostname);
454
    if (!rent) {
455
      log_fn(LOG_WARN,"Could not resolve local Address %s. Failing.", hostname);
456
457
      return -1;
    }
Roger Dingledine's avatar
Roger Dingledine committed
458
    tor_assert(rent->h_length == 4);
459
    memcpy(&in.s_addr, rent->h_addr,rent->h_length);
460
  }
461
  if(!explicit_ip && is_internal_IP(htonl(in.s_addr))) {
462
    log_fn(LOG_WARN,"Address '%s' resolves to private IP '%s'. "
463
           "Please set the Address config option to be the IP you want to use.",
464
           hostname, inet_ntoa(in));
465
466
    return -1;
  }
467
468
  log_fn(LOG_DEBUG,"Resolved Address to %s.", inet_ntoa(in));
  *addr = ntohl(in.s_addr);
469
470
471
  return 0;
}

472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
static char *get_default_nickname(void)
{
  char localhostname[256];
  char *cp, *out, *outp;

  if(gethostname(localhostname,sizeof(localhostname)) < 0) {
    log_fn(LOG_WARN,"Error obtaining local hostname");
    return NULL;
  }
  /* Put it in lowercase; stop at the first dot. */
  for(cp = localhostname; *cp; ++cp) {
    if (*cp == '.') {
      *cp = '\0';
      break;
    }
    *cp = tolower(*cp);
  }
  /* Strip invalid characters. */
  cp = localhostname;
  out = outp = tor_malloc(strlen(localhostname)+1);
  while (*cp) {
    if (strchr(LEGAL_NICKNAME_CHARACTERS, *cp))
      *outp++ = *cp++;
    else
      cp++;
  }
  *outp = '\0';
  /* Enforce length. */
  if (strlen(out) > MAX_NICKNAME_LEN)
    out[MAX_NICKNAME_LEN]='\0';

  return out;
}

Nick Mathewson's avatar
Nick Mathewson committed
506
/** Release storage held by <b>options</b> */
507
static void free_options(or_options_t *options) {
508
  config_free_lines(options->LogOptions);
509
  tor_free(options->ContactInfo);
510
511
512
513
514
515
  tor_free(options->DebugLogFile);
  tor_free(options->DataDirectory);
  tor_free(options->RouterFile);
  tor_free(options->Nickname);
  tor_free(options->Address);
  tor_free(options->PidFile);
516
517
  tor_free(options->ExitNodes);
  tor_free(options->EntryNodes);
518
  tor_free(options->ExcludeNodes);
519
520
  tor_free(options->RendNodes);
  tor_free(options->RendExcludeNodes);
521
  tor_free(options->OutboundBindAddress);
522
  tor_free(options->RecommendedVersions);
523
524
  tor_free(options->User);
  tor_free(options->Group);
525
  config_free_lines(options->RendConfigLines);
526
527
528
529
530
  config_free_lines(options->SocksBindAddress);
  config_free_lines(options->ORBindAddress);
  config_free_lines(options->DirBindAddress);
  config_free_lines(options->ExitPolicy);
  config_free_lines(options->SocksPolicy);
531
532
533
  if (options->FirewallPorts) {
    SMARTLIST_FOREACH(options->FirewallPorts, char *, cp, tor_free(cp));
    smartlist_free(options->FirewallPorts);
534
    options->FirewallPorts = NULL;
535
  }
536
}
537

Nick Mathewson's avatar
Nick Mathewson committed
538
/** Set <b>options</b> to hold reasonable defaults for most options. */
539
static void init_options(or_options_t *options) {
540
/* give reasonable values for each option. Defaults to zero. */
541
  memset(options,0,sizeof(or_options_t));
542
  options->LogOptions = NULL;
543
544
  options->ExitNodes = tor_strdup("");
  options->EntryNodes = tor_strdup("");
545
  options->StrictEntryNodes = options->StrictExitNodes = 0;
546
  options->ExcludeNodes = tor_strdup("");
547
548
  options->RendNodes = tor_strdup("");
  options->RendExcludeNodes = tor_strdup("");
549
550
551
552
553
  options->ExitPolicy = NULL;
  options->SocksPolicy = NULL;
  options->SocksBindAddress = NULL;
  options->ORBindAddress = NULL;
  options->DirBindAddress = NULL;
554
  options->OutboundBindAddress = NULL;
555
  options->RecommendedVersions = NULL;
556
  options->PidFile = NULL; // tor_strdup("tor.pid");
557
  options->DataDirectory = NULL;
558
  options->PathlenCoinWeight = 0.3;
559
  options->MaxConn = 900;
560
  options->DirFetchPostPeriod = 600;
561
  options->KeepalivePeriod = 300;
562
  options->MaxOnionsPending = 100;
563
  options->NewCircuitPeriod = 30; /* twice a minute */
564
565
  options->BandwidthRate = 800000; /* at most 800kB/s total sustained incoming */
  options->BandwidthBurst = 10000000; /* max burst on the token bucket */
566
  options->NumCpus = 1;
567
  options->RendConfigLines = NULL;
568
  options->FirewallPorts = NULL;
569
570
}

571
572
573
574
575
576
static char *get_default_conf_file(void)
{
#ifdef MS_WINDOWS
  char *path = tor_malloc(MAX_PATH);
  if (!SUCCEEDED(SHGetSpecialFolderPath(NULL, path, CSIDL_APPDATA, 1))) {
    tor_free(path);
Nick Mathewson's avatar
Nick Mathewson committed
577
    return NULL;
578
579
580
581
  }
  strlcat(path,"\\tor\\torrc",MAX_PATH);
  return path;
#else
582
  return tor_strdup(CONFDIR "/torrc");
583
584
585
#endif
}

Nick Mathewson's avatar
Nick Mathewson committed
586
587
588
/** 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. */
589
int getconfig(int argc, char **argv, or_options_t *options) {
590
  struct config_line_t *cl;
591
592
593
594
  FILE *cf;
  char *fname;
  int i;
  int result = 0;
595
596
597
598
599
  static int first_load = 1;
  static char **backup_argv;
  static int backup_argc;
  char *previous_pidfile = NULL;
  int previous_runasdaemon = 0;
600
  int previous_orport = -1;
601
  int using_default_torrc;
602
603
604
605
606
607
608
609
610
611

  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 */
612
613
    if(options->PidFile)
      previous_pidfile = tor_strdup(options->PidFile);
614
    previous_runasdaemon = options->RunAsDaemon;
615
    previous_orport = options->ORPort;
616
617
    free_options(options);
  }
Roger Dingledine's avatar
Roger Dingledine committed
618
  init_options(options);
619

620
621
622
623
624
  if(argc > 1 && (!strcmp(argv[1], "-h") || !strcmp(argv[1],"--help"))) {
    print_usage();
    exit(0);
  }

625
626
627
628
629
  if(argc > 1 && (!strcmp(argv[1],"--version"))) {
    printf("Tor version %s.\n",VERSION);
    exit(0);
  }

630
631
632
633
634
635
/* 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 */
636
    fname = tor_strdup(argv[i+1]);
637
    using_default_torrc = 0;
638
  } else {
639
    /* didn't find one, try CONFDIR */
Nick Mathewson's avatar
Nick Mathewson committed
640
641
642
    char *fn;
    using_default_torrc = 1;
    fn = get_default_conf_file();
643
    if (fn && file_status(fn)==FN_FILE) {
Nick Mathewson's avatar
Nick Mathewson committed
644
645
646
647
648
649
650
651
652
653
654
      fname = fn;
    } else {
      tor_free(fn);
      fn = expand_filename("~/.torrc");
      if (fn && file_status(fn)==FN_FILE) {
        fname = fn;
      } else {
        tor_free(fn);
        fname = get_default_conf_file();
      }
    }
655
  }
656
  tor_assert(fname);
657
658
  log(LOG_DEBUG,"Opening config file '%s'",fname);

659
  cf = fopen(fname, "r");
660
  if(!cf) {
661
    if(using_default_torrc == 1) {
662
      log(LOG_NOTICE, "Configuration file '%s' not present, using reasonable defaults.",fname);
663
664
      tor_free(fname);
      if(config_assign_defaults(options) < 0) {
665
        return -1;
666
      }
667
668
    } else {
      log(LOG_WARN, "Unable to open configuration file '%s'.",fname);
669
      tor_free(fname);
670
671
672
      return -1;
    }
  } else { /* it opened successfully. use it. */
673
    tor_free(fname);
674
675
    cl = config_get_lines(cf);
    if(!cl) return -1;
676
677
    if(config_assign(options,cl) < 0)
      return -1;
678
    config_free_lines(cl);
679
    fclose(cf);
680
  }
681

682
683
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
684
685
  if(config_assign(options,cl) < 0)
    return -1;
686
687
688
689
  config_free_lines(cl);

/* Validate options */

690
  /* first check if any of the previous options have changed but aren't allowed to */
691
692
693
694
695
696
697
698
699
700
701
702
  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;
  }

703
  if(previous_orport == 0 && options->ORPort > 0) {
Roger Dingledine's avatar
Roger Dingledine committed
704
    log_fn(LOG_WARN,"During reload, change from ORPort=0 to >0 not allowed. Failing.");
705
706
707
    return -1;
  }

708
  if(options->ORPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
709
    log(LOG_WARN,"ORPort option can't be negative.");
710
711
712
    result = -1;
  }

713
  if (options->Nickname == NULL) {
714
715
716
717
718
    if(server_mode()) {
      if (!(options->Nickname = get_default_nickname()))
        return -1;
      log_fn(LOG_NOTICE, "Choosing default nickname %s", options->Nickname);
    }
719
720
721
722
723
724
  } else {
    if (strspn(options->Nickname, LEGAL_NICKNAME_CHARACTERS) !=
        strlen(options->Nickname)) {
      log_fn(LOG_WARN, "Nickname '%s' contains illegal characters.", options->Nickname);
      result = -1;
    }
725
726
727
728
    if (strlen(options->Nickname) == 0) {
      log_fn(LOG_WARN, "Nickname must have at least one character");
      result = -1;
    }
729
730
731
732
    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;
733
    }
734
735
  }

736
737
738
739
  if(server_mode()) {
    /* confirm that our address isn't broken, so we can complain now */
    uint32_t tmp;
    if(resolve_my_address(options->Address, &tmp) < 0)
740
      result = -1;
741
742
  }

743
744
  if(options->SocksPort < 0) {
    log(LOG_WARN,"SocksPort option can't be negative.");
745
746
747
    result = -1;
  }

748
749
750
  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
751
  }
752

753
  if(options->DirPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
754
    log(LOG_WARN,"DirPort option can't be negative.");
755
756
757
    result = -1;
  }

758
759
760
761
762
763
764
765
  if(options->StrictExitNodes && !strlen(options->ExitNodes)) {
    log(LOG_WARN,"StrictExitNodes set, but no ExitNodes listed.");
  }

  if(options->StrictEntryNodes && !strlen(options->EntryNodes)) {
    log(LOG_WARN,"StrictEntryNodes set, but no EntryNodes listed.");
  }

Roger Dingledine's avatar
Roger Dingledine committed
766
  if(options->AuthoritativeDir && options->RecommendedVersions == NULL) {
767
768
769
770
    log(LOG_WARN,"Directory servers must configure RecommendedVersions.");
    result = -1;
  }

771
772
773
774
775
  if(options->AuthoritativeDir && !options->DirPort) {
    log(LOG_WARN,"Running as authoritative directory, but no DirPort set.");
    result = -1;
  }

Roger Dingledine's avatar
Roger Dingledine committed
776
777
778
779
  if(options->AuthoritativeDir && !options->ORPort) {
    log(LOG_WARN,"Running as authoritative directory, but no ORPort set.");
    result = -1;
  }
780

Roger Dingledine's avatar
Roger Dingledine committed
781
782
783
784
  if(options->AuthoritativeDir && options->ClientOnly) {
    log(LOG_WARN,"Running as authoritative directory, but ClientOnly also set.");
    result = -1;
  }
785

786
787
  if(options->FascistFirewall && !options->FirewallPorts) {
    options->FirewallPorts = smartlist_create();
788
789
    smartlist_add(options->FirewallPorts, tor_strdup("80"));
    smartlist_add(options->FirewallPorts, tor_strdup("443"));
790
791
792
  }
  if(options->FirewallPorts) {
    SMARTLIST_FOREACH(options->FirewallPorts, const char *, cp,
793
    { i = atoi(cp);
794
      if (i < 1 || i > 65535) {
795
796
797
798
799
800
801
802
803
804
805
806
807
808
        log(LOG_WARN, "Port '%s' out of range in FirewallPorts", cp);
        result=-1;
      }
    });
  }
  options->_AllowUnverified = 0;
  if(options->AllowUnverifiedNodes) {
    SMARTLIST_FOREACH(options->AllowUnverifiedNodes, const char *, cp,
    { if (!strcasecmp(cp, "entry"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_ENTRY;
      else if (!strcasecmp(cp, "exit"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_EXIT;
      else if (!strcasecmp(cp, "middle"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_MIDDLE;
809
810
811
812
      else if (!strcasecmp(cp, "introduction"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_INTRODUCTION;
      else if (!strcasecmp(cp, "rendezvous"))
        options->_AllowUnverified |= ALLOW_UNVERIFIED_RENDEZVOUS;
813
814
815
      else {
        log(LOG_WARN, "Unrecognized value '%s' in AllowUnverifiedNodes",
            cp);
816
817
818
819
820
        result=-1;
      }
    });
  }

821
  if(options->SocksPort >= 1 &&
822
823
     (options->PathlenCoinWeight < 0.0 || options->PathlenCoinWeight >= 1.0)) {
    log(LOG_WARN,"PathlenCoinWeight option must be >=0.0 and <1.0.");
824
825
826
    result = -1;
  }

827
  if(options->MaxConn < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
828
    log(LOG_WARN,"MaxConn option must be a non-zero positive integer.");
829
830
831
832
    result = -1;
  }

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

837
  if(options->DirFetchPostPeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
838
    log(LOG_WARN,"DirFetchPostPeriod option must be positive.");
839
840
    result = -1;
  }
841
842
843
844
  if(options->DirFetchPostPeriod > MIN_ONION_KEY_LIFETIME/2) {
    log(LOG_WARN,"DirFetchPostPeriod is too large; clipping.");
    options->DirFetchPostPeriod = MIN_ONION_KEY_LIFETIME/2;
  }
845
846

  if(options->KeepalivePeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
847
    log(LOG_WARN,"KeepalivePeriod option must be positive.");
848
849
850
    result = -1;
  }

851
852
853
854
  /* XXX look at the various nicknamelists and make sure they're
   * valid and don't have hostnames that are too long.
   */

855
856
857
858
  if (rend_config_services(options) < 0) {
    result = -1;
  }

859
  return result;
860
861
}

862
static int add_single_log(struct config_line_t *level_opt,
863
864
865
866
867
868
869
870
871
872
873
874
                           struct config_line_t *file_opt,
                           int isDaemon)
{
  int levelMin=-1, levelMax=-1;
  char *cp, *tmp_sev;

  if (level_opt) {
    cp = strchr(level_opt->value, '-');
    if (cp) {
      tmp_sev = tor_strndup(level_opt->value, cp - level_opt->value);
      levelMin = parse_log_level(tmp_sev);
      if (levelMin<0) {
875
876
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", tmp_sev);
        return -1;
877
878
879
880
      }
      tor_free(tmp_sev);
      levelMax = parse_log_level(cp+1);
      if (levelMax<0) {
881
882
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", cp+1);
        return -1;
883
884
885
886
      }
    } else {
      levelMin = parse_log_level(level_opt->value);
      if (levelMin<0) {
887
888
889
        log_fn(LOG_WARN, "Unrecognized log severity '%s': must be one of err|warn|notice|info|debug", level_opt->value);
        return -1;

890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
      }
    }
  }
  if (levelMin < 0 && levelMax < 0) {
    levelMin = LOG_NOTICE;
    levelMax = LOG_ERR;
  } else if (levelMin < 0) {
    levelMin = levelMax;
  } else {
    levelMax = LOG_ERR;
  }
  if (file_opt) {
    if (add_file_log(levelMin, levelMax, file_opt->value) < 0) {
      log_fn(LOG_WARN, "Cannot write to LogFile '%s': %s.", file_opt->value,
             strerror(errno));
905
      return -1;
906
907
908
909
    }
    log_fn(LOG_NOTICE, "Successfully opened LogFile '%s', redirecting output.",
           file_opt->value);
  } else if (!isDaemon) {
910
    add_stream_log(levelMin, levelMax, "<stdout>", stdout);
911
    close_temp_logs();
912
  }
913
  return 0;
914
915
916
917
918
}

/**
 * Initialize the logs based on the configuration file.
 */
919
int config_init_logs(or_options_t *options)
920
921
922
923
924
{
  /* The order of options is:  Level? (File Level?)+
   */
  struct config_line_t *opt = options->LogOptions;

925
926
927
928
  /* Special case if no options are given. */
  if (!opt) {
    add_stream_log(LOG_NOTICE, LOG_ERR, "<stdout>", stdout);
    close_temp_logs();
Roger Dingledine's avatar
Roger Dingledine committed
929
930
    /* don't return yet, in case we want to do a debuglogfile below */
  }
931

932
933
934
  /* Special case for if first option is LogLevel. */
  if (opt && !strcasecmp(opt->key, "LogLevel")) {
    if (opt->next && !strcasecmp(opt->next->key, "LogFile")) {
935
936
      if (add_single_log(opt, opt->next, options->RunAsDaemon)<0)
        return -1;
937
938
      opt = opt->next->next;
    } else if (!opt->next) {
939
940
      if (add_single_log(opt, NULL, options->RunAsDaemon)<0)
        return -1;
941
      opt = opt->next;
942
943
    } else {
      ; /* give warning below */
944
945
946
947
948
949
950
951
    }
  }

  while (opt) {
    if (!strcasecmp(opt->key, "LogLevel")) {
      log_fn(LOG_WARN, "Two LogLevel options in a row without intervening LogFile");
      opt = opt->next;
    } else {
952
      tor_assert(!strcasecmp(opt->key, "LogFile"));
953
954
      if (opt->next && !strcasecmp(opt->next->key, "LogLevel")) {
        /* LogFile followed by LogLevel */
955
956
        if (add_single_log(opt->next, opt, options->RunAsDaemon)<0)
          return -1;
957
958
959
        opt = opt->next->next;
      } else {
        /* LogFile followed by LogFile or end of list. */
960
961
        if (add_single_log(NULL, opt, options->RunAsDaemon)<0)
          return -1;
962
963
964
965
966
967
968
        opt = opt->next;
      }
    }
  }

  if (options->DebugLogFile) {
    log_fn(LOG_WARN, "DebugLogFile is deprecated; use LogFile and LogLevel instead");
969
970
    if (add_file_log(LOG_DEBUG, LOG_ERR, options->DebugLogFile)<0)
      return -1;
971
  }
972
  return 0;
973
974
}

Nick Mathewson's avatar
Nick Mathewson committed
975
976
977
978
/**
 * Given a linked list of config lines containing "allow" and "deny" tokens,
 * parse them and place the result in <b>dest</b>.  Skip malformed lines.
 */
979
980
981
982
983
void
config_parse_exit_policy(struct config_line_t *cfg,
                         struct exit_policy_t **dest)
{
  struct exit_policy_t **nextp;
984
  smartlist_t *entries;
985
986
987
988
989
990
991

  if (!cfg)
    return;
  nextp = dest;
  while (*nextp)
    nextp = &((*nextp)->next);

992
  entries = smartlist_create();
993
  for (; cfg; cfg = cfg->next) {
994
995
996
997
    smartlist_split_string(entries,cfg->value,",",SPLIT_SKIP_SPACE,0);
    SMARTLIST_FOREACH(entries, const char *, ent, {
      log_fn(LOG_DEBUG,"Adding new entry '%s'",ent);
      *nextp = router_parse_exit_policy_from_string(ent);
998
999
1000
      if(*nextp) {
        nextp = &((*nextp)->next);
      } else {