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

Roger Dingledine's avatar
Roger Dingledine committed
5
#include "or.h"
Roger Dingledine's avatar
Roger Dingledine committed
6

7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
/* open configuration file for reading */
FILE *config_open(const unsigned char *filename) {
  assert(filename);
  if (strspn(filename,CONFIG_LEGAL_FILENAME_CHARACTERS) != strlen(filename)) {
    /* filename has illegal letters */
    return NULL;
  }
  return fopen(filename, "r");
}

/* close configuration file */
int config_close(FILE *f) {
  assert(f);
  return fclose(f);
}

struct config_line *config_get_commandlines(int argc, char **argv) {
  struct config_line *new;
  struct config_line *front = NULL;
  char *s;
  int i = 1;

  while(i < argc-1) { 
    if(!strcmp(argv[i],"-f")) {
//      log(LOG_DEBUG,"Commandline: skipping over -f.");
      i+=2; /* this is the config file option. ignore it. */
      continue;
    }

36
    new = tor_malloc(sizeof(struct config_line));
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
    s = argv[i];
    while(*s == '-')
      s++;
    new->key = strdup(s);
    new->value = strdup(argv[i+1]);

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

/* parse the config file and strdup into key/value strings. Return list.
53
 * Warn and ignore mangled lines. */
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
struct config_line *config_get_lines(FILE *f) {
  struct config_line *new;
  struct config_line *front = NULL;
  char line[CONFIG_LINE_MAXLEN];
  int lineno=0; /* current line number */
  char *s;
  char *start, *end;

  assert(f);

  fseek(f,0,SEEK_SET); /* make sure we start at the beginning of file */

  while(fgets(line, CONFIG_LINE_MAXLEN, f)) {
    lineno++;

    /* first strip comments */
    s = strchr(line,'#');
    if(s) {
      *s = 0; /* stop the line there */
    }

    /* walk to the end, remove end whitespace */
76
    s = strchr(line, 0); /* now we're at the null */
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
    do {
      *s = 0;
      s--;
    } while (isspace(*s));

    start = line;
    while(isspace(*start))
      start++;
    if(*start == 0)
      continue; /* this line has nothing on it */

    end = start;
    while(*end && !isspace(*end))
      end++;
    s = end;
    while(*s && isspace(*s))
      s++;
    if(!*end || !*s) { /* only a keyword on this line. no value. */
      log(LOG_WARNING,"Config line %d has keyword '%s' but no value. Skipping.",lineno,s);
    }
    *end = 0; /* null it out */

    /* prepare to parse the string into key / value */
100
    new = tor_malloc(sizeof(struct config_line));
101
102
103
104
105
106
107
    new->key = strdup(start);
    new->value = strdup(s);

    log(LOG_DEBUG,"Config line %d: parsed keyword '%s', value '%s'",
      lineno, new->key, new->value);
    new->next = front;
    front = new;
Roger Dingledine's avatar
Roger Dingledine committed
108
109
  }

110
  return front;
Roger Dingledine's avatar
Roger Dingledine committed
111
112
}

113
114
115
116
117
118
119
120
121
122
123
124
125
126
void config_free_lines(struct config_line *front) {
  struct config_line *tmp;

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

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

int config_compare(struct config_line *c, char *key, int type, void *arg) {
127
  int i;
128
129
130
131
132

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

  /* 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
136
137

  switch(type) {
    case CONFIG_TYPE_INT:   
      *(int *)arg = atoi(c->value);
138
      break;
139
140
141
    case CONFIG_TYPE_BOOL:
      i = atoi(c->value);
      if (i != 0 && i != 1) {
142
143
        log(LOG_ERR, "Boolean keyword '%s' expects 0 or 1", c->key);
        return 0;
144
145
146
      }
      *(int *)arg = i;
      break;
147
148
    case CONFIG_TYPE_STRING:
      *(char **)arg = strdup(c->value);
149
      break;
150
151
    case CONFIG_TYPE_DOUBLE:
      *(double *)arg = atof(c->value);
152
      break;
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
  }
  return 1;
}

void config_assign(or_options_t *options, struct config_line *list) {

  /* iterate through list. for each item convert as appropriate and assign to 'options'. */

  while(list) {
    if(

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

    /* string options */
    config_compare(list, "LogLevel",       CONFIG_TYPE_STRING, &options->LogLevel) ||
    config_compare(list, "PrivateKeyFile", CONFIG_TYPE_STRING, &options->PrivateKeyFile) ||
169
    config_compare(list, "SigningPrivateKeyFile", CONFIG_TYPE_STRING, &options->SigningPrivateKeyFile) ||
170
171
172
173
174
175
176
177
178
    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||

    /* int options */
    config_compare(list, "MaxConn",         CONFIG_TYPE_INT, &options->MaxConn) ||
    config_compare(list, "APPort",          CONFIG_TYPE_INT, &options->APPort) ||
    config_compare(list, "ORPort",          CONFIG_TYPE_INT, &options->ORPort) ||
    config_compare(list, "DirPort",         CONFIG_TYPE_INT, &options->DirPort) ||
    config_compare(list, "DirFetchPeriod",  CONFIG_TYPE_INT, &options->DirFetchPeriod) ||
    config_compare(list, "KeepalivePeriod", CONFIG_TYPE_INT, &options->KeepalivePeriod) ||
179
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
180
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
181
    config_compare(list, "TotalBandwidth",  CONFIG_TYPE_INT, &options->TotalBandwidth) ||
182
    config_compare(list, "NumCpus",         CONFIG_TYPE_INT, &options->NumCpus) ||
183

184
    config_compare(list, "OnionRouter",     CONFIG_TYPE_BOOL, &options->OnionRouter) ||
185
186
187
    config_compare(list, "Daemon",          CONFIG_TYPE_BOOL, &options->Daemon) ||
    config_compare(list, "TrafficShaping",  CONFIG_TYPE_BOOL, &options->TrafficShaping) ||
    config_compare(list, "LinkPadding",     CONFIG_TYPE_BOOL, &options->LinkPadding) ||
188
    config_compare(list, "IgnoreVersion",   CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||
189

190
191
192
193
194
195
    /* float options */
    config_compare(list, "CoinWeight",     CONFIG_TYPE_DOUBLE, &options->CoinWeight)

    ) {
      /* then we're ok. it matched something. */
    } else {
196
      log_fn(LOG_WARNING,"Ignoring unknown keyword '%s'.",list->key);
197
198
199
200
201
202
203
204
205
206
207
208
209
210
    }

    list = list->next;
  }  
}

/* return 0 if success, <0 if failure. */
int getconfig(int argc, char **argv, or_options_t *options) {
  struct config_line *cl;
  FILE *cf;
  char fname[256];
  int i;
  int result = 0;

211
/* give reasonable values for each option. Defaults to zero. */
212
213
214
215
  memset(options,0,sizeof(or_options_t));
  options->LogLevel = "debug";
  options->loglevel = LOG_DEBUG;
  options->CoinWeight = 0.8;
216
  options->MaxConn = 900;
217
  options->DirFetchPeriod = 600;
218
  options->KeepalivePeriod = 300;
219
  options->MaxOnionsPending = 10;
220
  options->NewCircuitPeriod = 60; /* once a minute */
221
  options->TotalBandwidth = 800000; /* at most 800kB/s total sustained incoming */
222
  options->NumCpus = 1;
223
224
225
//  options->ReconnectPeriod = 6001;

/* get config lines from /etc/torrc and assign them */
226
227
#define rcfile "torrc"
  snprintf(fname,256,"/etc/%s",rcfile);
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263

  cf = config_open(fname);
  if(cf) {
    /* we got it open. pull out the config lines. */
    cl = config_get_lines(cf);
    config_assign(options,cl);
    config_free_lines(cl);
    config_close(cf);
  }
  /* if we failed to open it, ignore */

/* learn config file name, get config lines, assign them */
  i = 1;
  while(i < argc-1 && strcmp(argv[i],"-f")) {
//    log(LOG_DEBUG,"examining arg %d (%s), it's not -f.",i,argv[i]);
    i++;
  }
  if(i < argc-1) { /* we found one */
    log(LOG_DEBUG,"Opening specified config file '%s'",argv[i+1]);
    cf = config_open(argv[i+1]);
    if(!cf) { /* it's defined but not there. that's no good. */
      log(LOG_ERR, "Unable to open configuration file '%s'.",argv[i+1]);
      return -1;
    }
    cl = config_get_lines(cf);
    config_assign(options,cl);
    config_free_lines(cl);
    config_close(cf);
  }
 
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
  config_assign(options,cl);
  config_free_lines(cl);

/* print config */
264
/* XXX this section is rotting. Should maybe remove it sometime. */
265
  if (options->loglevel == LOG_DEBUG) {
266
267
    printf("LogLevel=%s\n",
           options->LogLevel);
268
    printf("RouterFile=%s, PrivateKeyFile=%s, SigningPrivateKeyFile=%s\n",
269
           options->RouterFile ? options->RouterFile : "(undefined)",
270
271
           options->PrivateKeyFile ? options->PrivateKeyFile : "(undefined)",
           options->SigningPrivateKeyFile ? options->SigningPrivateKeyFile : "(undefined)");
272
273
    printf("ORPort=%d, APPort=%d DirPort=%d\n",
           options->ORPort,
274
275
276
277
278
279
           options->APPort,options->DirPort);
    printf("CoinWeight=%6.4f, MaxConn=%d, TrafficShaping=%d, LinkPadding=%d\n",
           options->CoinWeight,
           options->MaxConn,
           options->TrafficShaping,
           options->LinkPadding);
280
    printf("DirFetchPeriod=%d KeepalivePeriod=%d\n",
281
282
           options->DirFetchPeriod,
           options->KeepalivePeriod);
Roger Dingledine's avatar
Roger Dingledine committed
283
    printf("Daemon=%d\n", options->Daemon);
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
  }

/* Validate options */

  if(options->LogLevel) {
    if(!strcmp(options->LogLevel,"emerg"))
      options->loglevel = LOG_EMERG;
    else if(!strcmp(options->LogLevel,"alert"))
      options->loglevel = LOG_ALERT;
    else if(!strcmp(options->LogLevel,"crit"))
      options->loglevel = LOG_CRIT;
    else if(!strcmp(options->LogLevel,"err"))
      options->loglevel = LOG_ERR;
    else if(!strcmp(options->LogLevel,"warning"))
      options->loglevel = LOG_WARNING;
    else if(!strcmp(options->LogLevel,"notice"))
      options->loglevel = LOG_NOTICE;
    else if(!strcmp(options->LogLevel,"info"))
      options->loglevel = LOG_INFO;
    else if(!strcmp(options->LogLevel,"debug"))
      options->loglevel = LOG_DEBUG;
    else {
      log(LOG_ERR,"LogLevel must be one of emerg|alert|crit|err|warning|notice|info|debug.");
      result = -1;
    }
  }

  if(options->RouterFile == NULL) {
    log(LOG_ERR,"RouterFile option required, but not found.");
    result = -1;
  }

316
  if(options->ORPort < 0) {
317
    log(LOG_ERR,"ORPort option can't be negative.");
318
319
320
    result = -1;
  }

321
322
  if(options->OnionRouter && options->ORPort == 0) {
    log(LOG_ERR,"If OnionRouter is set, then ORPort must be positive.");
323
324
325
    result = -1;
  }

326
327
  if(options->OnionRouter && options->PrivateKeyFile == NULL) {
    log(LOG_ERR,"PrivateKeyFile option required for OnionRouter, but not found.");
328
329
330
    result = -1;
  }

331
332
  if(options->DirPort > 0 && options->SigningPrivateKeyFile == NULL) {
    log(LOG_ERR,"SigningPrivateKeyFile option required for DirServer, but not found.");
333
334
335
    result = -1;
  }

336
337
  if(options->APPort < 0) {
    log(LOG_ERR,"APPort option can't be negative.");
338
339
340
    result = -1;
  }

341
342
  if(options->DirPort < 0) {
    log(LOG_ERR,"DirPort option can't be negative.");
343
344
345
    result = -1;
  }

346
  if(options->APPort > 1 &&
347
     (options->CoinWeight < 0.0 || options->CoinWeight >= 1.0)) {
348
    log(LOG_ERR,"CoinWeight option must be >=0.0 and <1.0.");
349
350
351
    result = -1;
  }

352
  if(options->MaxConn < 1) {
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
    log(LOG_ERR,"MaxConn option must be a non-zero positive integer.");
    result = -1;
  }

  if(options->MaxConn >= MAXCONNECTIONS) {
    log(LOG_ERR,"MaxConn option must be less than %d.", MAXCONNECTIONS);
    result = -1;
  }

  if(options->DirFetchPeriod < 1) {
    log(LOG_ERR,"DirFetchPeriod option must be positive.");
    result = -1;
  }

  if(options->KeepalivePeriod < 1) {
    log(LOG_ERR,"KeepalivePeriod option must be positive.");
    result = -1;
  }

  return result;
373
374
}

375
376
377
378
379
380
381
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/