config.c 9.84 KB
Newer Older
1
/* Copyright 2001,2002,2003 Roger Dingledine, Matej Pfajfar. */
2
3
4
/* 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
/* enumeration of types which option values can take */
#define CONFIG_TYPE_STRING  0
#define CONFIG_TYPE_CHAR    1
#define CONFIG_TYPE_INT     2
#define CONFIG_TYPE_LONG    3
#define CONFIG_TYPE_DOUBLE  4
#define CONFIG_TYPE_BOOL    5

15
#define CONFIG_LINE_MAXLEN 4096
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

struct config_line {
  char *key;
  char *value;
  struct config_line *next;
};

static FILE *config_open(const unsigned char *filename);
static int config_close(FILE *f);
static struct config_line *config_get_commandlines(int argc, char **argv);
static struct config_line *config_get_lines(FILE *f);
static void config_free_lines(struct config_line *front);
static int config_compare(struct config_line *c, char *key, int type, void *arg);
static void config_assign(or_options_t *options, struct config_line *list);

31
/* open configuration file for reading */
32
static FILE *config_open(const unsigned char *filename) {
33
34
35
36
37
38
39
40
41
  assert(filename);
  if (strspn(filename,CONFIG_LEGAL_FILENAME_CHARACTERS) != strlen(filename)) {
    /* filename has illegal letters */
    return NULL;
  }
  return fopen(filename, "r");
}

/* close configuration file */
42
static int config_close(FILE *f) {
43
44
45
46
  assert(f);
  return fclose(f);
}

47
static struct config_line *config_get_commandlines(int argc, char **argv) {
48
49
50
51
52
53
54
55
56
57
58
59
  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;
    }

60
    new = tor_malloc(sizeof(struct config_line));
61
62
63
    s = argv[i];
    while(*s == '-')
      s++;
64
65
    new->key = tor_strdup(s);
    new->value = tor_strdup(argv[i+1]);
66
67
68
69
70
71
72
73
74
75

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

76
77
/* parse the config file and strdup into key/value strings. Return list,
 * or NULL if parsing the file failed.
78
 * Warn and ignore mangled lines. */
79
static struct config_line *config_get_lines(FILE *f) {
80
81
82
  struct config_line *new;
  struct config_line *front = NULL;
  char line[CONFIG_LINE_MAXLEN];
83
84
  int result;
  char *key, *value;
85

86
  while( (result=parse_line_from_file(line,sizeof(line),f,&key,&value)) > 0) {
87
    new = tor_malloc(sizeof(struct config_line));
88
89
    new->key = tor_strdup(key);
    new->value = tor_strdup(value);
90
91
92

    new->next = front;
    front = new;
Roger Dingledine's avatar
Roger Dingledine committed
93
  }
94
95
  if(result < 0)
    return NULL;
96
  return front;
Roger Dingledine's avatar
Roger Dingledine committed
97
98
}

99
static void config_free_lines(struct config_line *front) {
100
101
102
103
104
105
106
107
108
109
110
111
  struct config_line *tmp;

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

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

112
static int config_compare(struct config_line *c, char *key, int type, void *arg) {
113
  int i;
114
115
116
117
118

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

  /* it's a match. cast and assign. */
119
  log_fn(LOG_DEBUG,"Recognized keyword '%s' as %s, using value '%s'.",c->key,key,c->value);
120
121
122
123

  switch(type) {
    case CONFIG_TYPE_INT:   
      *(int *)arg = atoi(c->value);
124
      break;
125
126
127
    case CONFIG_TYPE_BOOL:
      i = atoi(c->value);
      if (i != 0 && i != 1) {
Roger Dingledine's avatar
Roger Dingledine committed
128
        log(LOG_WARN, "Boolean keyword '%s' expects 0 or 1", c->key);
129
        return 0;
130
131
132
      }
      *(int *)arg = i;
      break;
133
    case CONFIG_TYPE_STRING:
134
      *(char **)arg = tor_strdup(c->value);
135
      break;
136
137
    case CONFIG_TYPE_DOUBLE:
      *(double *)arg = atof(c->value);
138
      break;
139
140
141
142
  }
  return 1;
}

143
static void config_assign(or_options_t *options, struct config_line *list) {
144
145
146
147
148
149
150
151
152
153

  /* 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) ||
154
155
    config_compare(list, "LogFile",        CONFIG_TYPE_STRING, &options->LogFile) ||
    config_compare(list, "DebugLogFile",   CONFIG_TYPE_STRING, &options->DebugLogFile) ||
156
    config_compare(list, "DataDirectory",  CONFIG_TYPE_STRING, &options->DataDirectory) ||
157
    config_compare(list, "RouterFile",     CONFIG_TYPE_STRING, &options->RouterFile) ||
158
    config_compare(list, "PidFile",        CONFIG_TYPE_STRING, &options->PidFile) ||
Roger Dingledine's avatar
Roger Dingledine committed
159
    config_compare(list, "Nickname",       CONFIG_TYPE_STRING, &options->Nickname) ||
160
    config_compare(list, "Address",        CONFIG_TYPE_STRING, &options->Address) ||
161
    config_compare(list, "ExitPolicy",     CONFIG_TYPE_STRING, &options->ExitPolicy) ||
162
163
164
165
166
167

    /* 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) ||
168
    config_compare(list, "DirFetchPostPeriod",CONFIG_TYPE_INT, &options->DirFetchPostPeriod) ||
169
    config_compare(list, "KeepalivePeriod", CONFIG_TYPE_INT, &options->KeepalivePeriod) ||
170
    config_compare(list, "MaxOnionsPending",CONFIG_TYPE_INT, &options->MaxOnionsPending) ||
171
    config_compare(list, "NewCircuitPeriod",CONFIG_TYPE_INT, &options->NewCircuitPeriod) ||
172
    config_compare(list, "TotalBandwidth",  CONFIG_TYPE_INT, &options->TotalBandwidth) ||
173
    config_compare(list, "NumCpus",         CONFIG_TYPE_INT, &options->NumCpus) ||
174

175
    config_compare(list, "OnionRouter",     CONFIG_TYPE_BOOL, &options->OnionRouter) ||
176
177
    config_compare(list, "TrafficShaping",  CONFIG_TYPE_BOOL, &options->TrafficShaping) ||
    config_compare(list, "LinkPadding",     CONFIG_TYPE_BOOL, &options->LinkPadding) ||
178
    config_compare(list, "IgnoreVersion",   CONFIG_TYPE_BOOL, &options->IgnoreVersion) ||
179
    config_compare(list, "RunAsDaemon",     CONFIG_TYPE_BOOL, &options->RunAsDaemon) ||
180

181
182
183
184
185
186
    /* float options */
    config_compare(list, "CoinWeight",     CONFIG_TYPE_DOUBLE, &options->CoinWeight)

    ) {
      /* then we're ok. it matched something. */
    } else {
Roger Dingledine's avatar
Roger Dingledine committed
187
      log_fn(LOG_WARN,"Ignoring unknown keyword '%s'.",list->key);
188
189
190
191
192
193
194
195
196
197
    }

    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;
198
  char *fname;
199
200
201
  int i;
  int result = 0;

202
/* give reasonable values for each option. Defaults to zero. */
203
  memset(options,0,sizeof(or_options_t));
204
  options->LogLevel = "info";
Roger Dingledine's avatar
Roger Dingledine committed
205
  options->ExitPolicy = "reject 127.0.0.1:*,reject 18.244.0.188:25,accept *:*";
206
  options->loglevel = LOG_INFO;
207
  options->PidFile = "tor.pid";
208
  options->DataDirectory = NULL;
209
  options->CoinWeight = 0.1;
210
  options->MaxConn = 900;
211
  options->DirFetchPostPeriod = 600;
212
  options->KeepalivePeriod = 300;
213
  options->MaxOnionsPending = 10;
214
  options->NewCircuitPeriod = 60; /* once a minute */
215
  options->TotalBandwidth = 800000; /* at most 800kB/s total sustained incoming */
216
  options->NumCpus = 1;
217
218
219
220
221
222
223

/* 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 */
224
    fname = argv[i+1];
225
226
  } else { /* didn't find one, try CONFDIR */
    fname = CONFDIR "/torrc";
227
228
229
230
  }
  log(LOG_DEBUG,"Opening config file '%s'",fname);

  cf = config_open(fname);
231
  if(!cf) {
Roger Dingledine's avatar
Roger Dingledine committed
232
    log(LOG_WARN, "Unable to open configuration file '%s'.",fname);
233
    return -1;
234
  }
235
236

  cl = config_get_lines(cf);
237
  if(!cl) return -1;
238
239
240
  config_assign(options,cl);
  config_free_lines(cl);
  config_close(cf);
241
242
243
244
245
246
247
248
249
 
/* go through command-line variables too */
  cl = config_get_commandlines(argc,argv);
  config_assign(options,cl);
  config_free_lines(cl);

/* Validate options */

  if(options->LogLevel) {
250
    if(!strcmp(options->LogLevel,"err"))
251
      options->loglevel = LOG_ERR;
Roger Dingledine's avatar
Roger Dingledine committed
252
253
    else if(!strcmp(options->LogLevel,"warn"))
      options->loglevel = LOG_WARN;
254
255
256
257
258
    else if(!strcmp(options->LogLevel,"info"))
      options->loglevel = LOG_INFO;
    else if(!strcmp(options->LogLevel,"debug"))
      options->loglevel = LOG_DEBUG;
    else {
Roger Dingledine's avatar
Roger Dingledine committed
259
      log(LOG_WARN,"LogLevel must be one of err|warn|info|debug.");
260
261
262
263
264
      result = -1;
    }
  }

  if(options->RouterFile == NULL) {
Roger Dingledine's avatar
Roger Dingledine committed
265
    log(LOG_WARN,"RouterFile option required, but not found.");
266
267
268
    result = -1;
  }

269
  if(options->ORPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
270
    log(LOG_WARN,"ORPort option can't be negative.");
271
272
273
    result = -1;
  }

274
  if(options->OnionRouter && options->ORPort == 0) {
Roger Dingledine's avatar
Roger Dingledine committed
275
    log(LOG_WARN,"If OnionRouter is set, then ORPort must be positive.");
276
277
278
    result = -1;
  }

279
  if(options->OnionRouter && options->DataDirectory == NULL) {
Roger Dingledine's avatar
Roger Dingledine committed
280
    log(LOG_WARN,"DataDirectory option required for OnionRouter, but not found.");
281
282
283
    result = -1;
  }

Roger Dingledine's avatar
Roger Dingledine committed
284
  if(options->OnionRouter && options->Nickname == NULL) {
Roger Dingledine's avatar
Roger Dingledine committed
285
    log_fn(LOG_WARN,"Nickname required for OnionRouter, but not found.");
286
287
288
    result = -1;
  }

289
  if(options->APPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
290
    log(LOG_WARN,"APPort option can't be negative.");
291
292
293
    result = -1;
  }

294
  if(options->DirPort < 0) {
Roger Dingledine's avatar
Roger Dingledine committed
295
    log(LOG_WARN,"DirPort option can't be negative.");
296
297
298
    result = -1;
  }

299
  if(options->APPort > 1 &&
300
     (options->CoinWeight < 0.0 || options->CoinWeight >= 1.0)) {
Roger Dingledine's avatar
Roger Dingledine committed
301
    log(LOG_WARN,"CoinWeight option must be >=0.0 and <1.0.");
302
303
304
    result = -1;
  }

305
  if(options->MaxConn < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
306
    log(LOG_WARN,"MaxConn option must be a non-zero positive integer.");
307
308
309
310
    result = -1;
  }

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

315
  if(options->DirFetchPostPeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
316
    log(LOG_WARN,"DirFetchPostPeriod option must be positive.");
317
318
319
320
    result = -1;
  }

  if(options->KeepalivePeriod < 1) {
Roger Dingledine's avatar
Roger Dingledine committed
321
    log(LOG_WARN,"KeepalivePeriod option must be positive.");
322
323
324
325
    result = -1;
  }

  return result;
326
327
}

328
329
330
331
332
333
334
/*
  Local Variables:
  mode:c
  indent-tabs-mode:nil
  c-basic-offset:2
  End:
*/