routerparse.c 130 KB
Newer Older
1
/* Copyright (c) 2001 Matej Pfajfar.
Roger Dingledine's avatar
Roger Dingledine committed
2
 * Copyright (c) 2001-2004, Roger Dingledine.
3
 * Copyright (c) 2004-2006, Roger Dingledine, Nick Mathewson.
4
 * Copyright (c) 2007-2008, The Tor Project, Inc. */
5
6
/* See LICENSE for licensing information */
/* $Id$ */
7
8
const char routerparse_c_id[] =
  "$Id$";
9
10
11
12
13
14
15

/**
 * \file routerparse.c
 * \brief Code to parse and validate router descriptors and directories.
 **/

#include "or.h"
16
#include "memarea.h"
17
18
19

/****************************************************************************/

20
21
22
/** Enumeration of possible token types.  The ones starting with K_ correspond
 * to directory 'keywords'. _ERR is an error in the tokenizing process, _EOF
 * is an end-of-file marker, and _NIL is used to encode not-a-token.
23
24
 */
typedef enum {
25
  K_ACCEPT = 0,
26
  K_ACCEPT6,
27
28
29
  K_DIRECTORY_SIGNATURE,
  K_RECOMMENDED_SOFTWARE,
  K_REJECT,
30
  K_REJECT6,
31
32
33
34
35
36
37
  K_ROUTER,
  K_SIGNED_DIRECTORY,
  K_SIGNING_KEY,
  K_ONION_KEY,
  K_ROUTER_SIGNATURE,
  K_PUBLISHED,
  K_RUNNING_ROUTERS,
38
  K_ROUTER_STATUS,
39
40
41
  K_PLATFORM,
  K_OPT,
  K_BANDWIDTH,
42
  K_CONTACT,
43
  K_NETWORK_STATUS,
Nick Mathewson's avatar
Nick Mathewson committed
44
  K_UPTIME,
45
  K_DIR_SIGNING_KEY,
46
  K_FAMILY,
47
48
49
50
  K_FINGERPRINT,
  K_HIBERNATING,
  K_READ_HISTORY,
  K_WRITE_HISTORY,
51
52
53
54
55
  K_NETWORK_STATUS_VERSION,
  K_DIR_SOURCE,
  K_DIR_OPTIONS,
  K_CLIENT_VERSIONS,
  K_SERVER_VERSIONS,
56
  K_P,
57
58
  K_R,
  K_S,
59
  K_V,
60
  K_W,
61
  K_EVENTDNS,
62
63
64
  K_EXTRA_INFO,
  K_EXTRA_INFO_DIGEST,
  K_CACHES_EXTRA_INFO,
65
  K_HIDDEN_SERVICE_DIR,
66
  K_ALLOW_SINGLE_HOP_EXITS,
67
68
69
70
71
72

  K_DIR_KEY_CERTIFICATE_VERSION,
  K_DIR_IDENTITY_KEY,
  K_DIR_KEY_PUBLISHED,
  K_DIR_KEY_EXPIRES,
  K_DIR_KEY_CERTIFICATION,
73
  K_DIR_ADDRESS,
74
75

  K_VOTE_STATUS,
76
77
  K_VALID_AFTER,
  K_FRESH_UNTIL,
78
  K_VALID_UNTIL,
79
80
  K_VOTING_DELAY,

81
82
83
  K_KNOWN_FLAGS,
  K_VOTE_DIGEST,
  K_CONSENSUS_DIGEST,
84
  K_CONSENSUS_METHODS,
85
  K_CONSENSUS_METHOD,
86
  K_LEGACY_DIR_KEY,
87

88
89
90
  A_PURPOSE,
  _A_UNKNOWN,

91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
  R_RENDEZVOUS_SERVICE_DESCRIPTOR,
  R_VERSION,
  R_PERMANENT_KEY,
  R_SECRET_ID_PART,
  R_PUBLICATION_TIME,
  R_PROTOCOL_VERSIONS,
  R_INTRODUCTION_POINTS,
  R_SIGNATURE,

  R_IPO_IDENTIFIER,
  R_IPO_IP_ADDRESS,
  R_IPO_ONION_PORT,
  R_IPO_ONION_KEY,
  R_IPO_SERVICE_KEY,

106
107
108
109
  C_CLIENT_NAME,
  C_DESCRIPTOR_COOKIE,
  C_CLIENT_KEY,

110
111
112
113
114
115
  _UNRECOGNIZED,
  _ERR,
  _EOF,
  _NIL
} directory_keyword;

116
117
118
#define MIN_ANNOTATION A_PURPOSE
#define MAX_ANNOTATION _A_UNKNOWN

119
120
121
122
123
124
/** Structure to hold a single directory token.
 *
 * We parse a directory by breaking it into "tokens", each consisting
 * of a keyword, a line full of arguments, and a binary object.  The
 * arguments and object are both optional, depending on the keyword
 * type.
125
126
127
 *
 * This structure is only allocated in memareas; do not allocate it on
 * the heap, or token_free() won't work.
128
129
130
 */
typedef struct directory_token_t {
  directory_keyword tp;        /**< Type of the token. */
131
  int n_args:30;               /**< Number of elements in args */
132
  char **args;                 /**< Array of arguments from keyword line. */
133

134
  char *object_type;           /**< -----BEGIN [object_type]-----*/
135
  size_t object_size;          /**< Bytes in object_body */
136
  char *object_body;           /**< Contents of object, base64-decoded. */
137
138
139

  crypto_pk_env_t *key;        /**< For public keys only.  Heap-allocated. */

140
  char *error;                 /**< For _ERR tokens only. */
141
142
143
144
145
146
147
148
} directory_token_t;

/* ********************************************************************** */

/** We use a table of rules to decide how to parse each token type. */

/** Rules for whether the keyword needs an object. */
typedef enum {
149
150
  NO_OBJ,        /**< No object, ever. */
  NEED_OBJ,      /**< Object is required. */
151
  NEED_SKEY_1024,/**< Object is required, and must be a 1024 bit private key */
152
153
154
  NEED_KEY_1024, /**< Object is required, and must be a 1024 bit public key */
  NEED_KEY,      /**< Object is required, and must be a public key. */
  OBJ_OK,        /**< Object is optional. */
155
156
} obj_syntax;

157
#define AT_START 1
158
#define AT_END 2
159
160

/** Determines the parsing rules for a single token type. */
161
typedef struct token_rule_t {
162
163
164
165
166
167
168
169
170
171
172
173
  /** The string value of the keyword identifying the type of item. */
  const char *t;
  /** The corresponding directory_keyword enum. */
  directory_keyword v;
  /** Minimum number of arguments for this item */
  int min_args;
  /** Maximum number of arguments for this item */
  int max_args;
  /** If true, we concatenate all arguments for this item into a single
   * string. */
  int concat_args;
  /** Requirments on object syntax for this item. */
174
  obj_syntax os;
175
176
177
178
179
180
181
  /** Lowest number of times this item may appear in a document. */
  int min_cnt;
  /** Highest number of times this item may appear in a document. */
  int max_cnt;
  /** One or more of AT_START/AT_END to limit where the item may appear in a
   * document. */
  int pos;
182
  /** True iff this token is an annotation. */
183
  int is_annotation;
184
185
} token_rule_t;

186
187
188
189
190
191
/*
 * Helper macros to define token tables.  's' is a string, 't' is a
 * directory_keyword, 'a' is a trio of argument multiplicities, and 'o' is an
 * object syntax.
 *
 */
192

193
/** Appears to indicate the end of a table. */
194
#define END_OF_TABLE { NULL, _NIL, 0,0,0, NO_OBJ, 0, INT_MAX, 0, 0 }
195
/** An item with no restrictions: used for obsolete document types */
196
#define T(s,t,a,o)    { s, t, a, o, 0, INT_MAX, 0, 0 }
197
/** An item with no restrictions on multiplicity or location. */
198
#define T0N(s,t,a,o)  { s, t, a, o, 0, INT_MAX, 0, 0 }
199
/** An item that must appear exactly once */
200
#define T1(s,t,a,o)   { s, t, a, o, 1, 1, 0, 0 }
201
/** An item that must appear exactly once, at the start of the document */
202
#define T1_START(s,t,a,o)   { s, t, a, o, 1, 1, AT_START, 0 }
203
/** An item that must appear exactly once, at the end of the document */
204
#define T1_END(s,t,a,o)   { s, t, a, o, 1, 1, AT_END, 0 }
205
/** An item that must appear one or more times */
206
#define T1N(s,t,a,o)  { s, t, a, o, 1, INT_MAX, 0, 0 }
207
/** An item that must appear no more than once */
208
209
210
#define T01(s,t,a,o)  { s, t, a, o, 0, 1, 0, 0 }
/** An annotation that must appear no more than once */
#define A01(s,t,a,o)  { s, t, a, o, 0, 1, 0, 0 }
211
212

/* Argument multiplicity: any number of arguments. */
213
#define ARGS        0,INT_MAX,0
214
/* Argument multiplicity: no arguments. */
215
#define NO_ARGS     0,0,0
216
/* Argument multiplicity: concatenate all arguments. */
217
#define CONCAT_ARGS 1,1,1
218
/* Argument multiplicity: at least <b>n</b> arguments. */
219
#define GE(n)       n,INT_MAX,0
220
/* Argument multiplicity: exactly <b>n</b> arguments. */
221
222
#define EQ(n)       n,n,0

223
/** List of tokens allowable in router derscriptors */
224
225
static token_rule_t routerdesc_token_table[] = {
  T0N("reject",              K_REJECT,              ARGS,    NO_OBJ ),
226
  T0N("accept",              K_ACCEPT,              ARGS,    NO_OBJ ),
227
228
229
  T0N("reject6",             K_REJECT6,             ARGS,    NO_OBJ ),
  T0N("accept6",             K_ACCEPT6,             ARGS,    NO_OBJ ),
  T1_START( "router",        K_ROUTER,              GE(5),   NO_OBJ ),
230
231
  T1( "signing-key",         K_SIGNING_KEY,         NO_ARGS, NEED_KEY_1024 ),
  T1( "onion-key",           K_ONION_KEY,           NO_ARGS, NEED_KEY_1024 ),
232
  T1_END( "router-signature",    K_ROUTER_SIGNATURE,    NO_ARGS, NEED_OBJ ),
233
  T1( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
234
  T01("uptime",              K_UPTIME,              GE(1),   NO_OBJ ),
235
  T01("fingerprint",         K_FINGERPRINT,     CONCAT_ARGS, NO_OBJ ),
236
  T01("hibernating",         K_HIBERNATING,         GE(1),   NO_OBJ ),
237
238
  T01("platform",            K_PLATFORM,        CONCAT_ARGS, NO_OBJ ),
  T01("contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
239
240
  T01("read-history",        K_READ_HISTORY,        ARGS,    NO_OBJ ),
  T01("write-history",       K_WRITE_HISTORY,       ARGS,    NO_OBJ ),
241
  T01("extra-info-digest",   K_EXTRA_INFO_DIGEST,   GE(1),   NO_OBJ ),
242
  T01("hidden-service-dir",  K_HIDDEN_SERVICE_DIR,  NO_ARGS, NO_OBJ ),
243
  T01("allow-single-hop-exits",K_ALLOW_SINGLE_HOP_EXITS,    NO_ARGS, NO_OBJ ),
244
245

  T01("family",              K_FAMILY,              ARGS,    NO_OBJ ),
246
  T01("caches-extra-info",   K_CACHES_EXTRA_INFO,   NO_ARGS, NO_OBJ ),
247
248
249
  T01("eventdns",            K_EVENTDNS,            ARGS,    NO_OBJ ),

  T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
250
  T1( "bandwidth",           K_BANDWIDTH,           GE(3),   NO_OBJ ),
251
  A01("@purpose",            A_PURPOSE,             GE(1),   NO_OBJ ),
252
253
254
255

  END_OF_TABLE
};

256
/** List of tokens allowable in extra-info documents. */
257
static token_rule_t extrainfo_token_table[] = {
258
  T1_END( "router-signature",    K_ROUTER_SIGNATURE,    NO_ARGS, NEED_OBJ ),
259
260
261
262
  T1( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
  T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  T01("read-history",        K_READ_HISTORY,        ARGS,    NO_OBJ ),
  T01("write-history",       K_WRITE_HISTORY,       ARGS,    NO_OBJ ),
263
  T1_START( "extra-info",          K_EXTRA_INFO,          GE(2),   NO_OBJ ),
264
265
266
267

  END_OF_TABLE
};

268
269
/** List of tokens allowable in the body part of v2 and v3 networkstatus
 * documents. */
270
static token_rule_t rtrstatus_token_table[] = {
271
  T01("p",                   K_P,               CONCAT_ARGS, NO_OBJ ),
Roger Dingledine's avatar
Roger Dingledine committed
272
  T1( "r",                   K_R,                   GE(8),   NO_OBJ ),
273
274
  T1( "s",                   K_S,                   ARGS,    NO_OBJ ),
  T01("v",                   K_V,               CONCAT_ARGS, NO_OBJ ),
275
  T01("w",                   K_W,                   ARGS,    NO_OBJ ),
276
277
278
279
  T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  END_OF_TABLE
};

280
281
/** List of tokens allowable in the header part of v2 networkstatus documents.
 */
282
283
284
285
static token_rule_t netstatus_token_table[] = {
  T1( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
  T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  T1( "contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
286
  T1( "dir-signing-key",     K_DIR_SIGNING_KEY,  NO_ARGS,    NEED_KEY_1024 ),
287
  T1( "fingerprint",         K_FINGERPRINT,     CONCAT_ARGS, NO_OBJ ),
288
  T1_START("network-status-version", K_NETWORK_STATUS_VERSION,
289
290
                                                    GE(1),   NO_OBJ ),
  T1( "dir-source",          K_DIR_SOURCE,          GE(3),   NO_OBJ ),
291
  T01("dir-options",         K_DIR_OPTIONS,         ARGS,    NO_OBJ ),
292
  T01("client-versions",     K_CLIENT_VERSIONS, CONCAT_ARGS, NO_OBJ ),
Roger Dingledine's avatar
Roger Dingledine committed
293
  T01("server-versions",     K_SERVER_VERSIONS, CONCAT_ARGS, NO_OBJ ),
294
295
296
297

  END_OF_TABLE
};

298
299
/** List of tokens allowable in the footer of v1/v2 directory/networkstatus
 * footers. */
300
static token_rule_t dir_footer_token_table[] = {
301
  T1("directory-signature", K_DIRECTORY_SIGNATURE, EQ(1), NEED_OBJ ),
302
303
304
  END_OF_TABLE
};

305
/** List of tokens allowable in v1 directory headers/footers. */
306
307
308
309
static token_rule_t dir_token_table[] = {
  /* don't enforce counts; this is obsolete. */
  T( "network-status",      K_NETWORK_STATUS,      NO_ARGS, NO_OBJ ),
  T( "directory-signature", K_DIRECTORY_SIGNATURE, ARGS,    NEED_OBJ ),
310
  T( "recommended-software",K_RECOMMENDED_SOFTWARE,CONCAT_ARGS, NO_OBJ ),
311
312
313
314
  T( "signed-directory",    K_SIGNED_DIRECTORY,    NO_ARGS, NO_OBJ ),

  T( "running-routers",     K_RUNNING_ROUTERS,     ARGS,    NO_OBJ ),
  T( "router-status",       K_ROUTER_STATUS,       ARGS,    NO_OBJ ),
315
  T( "published",           K_PUBLISHED,       CONCAT_ARGS, NO_OBJ ),
316
317
318
319
320
321
  T( "opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  T( "contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  T( "dir-signing-key",     K_DIR_SIGNING_KEY,     ARGS,    OBJ_OK ),
  T( "fingerprint",         K_FINGERPRINT,     CONCAT_ARGS, NO_OBJ ),

  END_OF_TABLE
322
323
};

324
325
#define CERTIFICATE_MEMBERS                                                  \
  T1("dir-key-certificate-version", K_DIR_KEY_CERTIFICATE_VERSION,           \
Roger Dingledine's avatar
Roger Dingledine committed
326
                                                     GE(1),       NO_OBJ ),  \
327
328
329
330
331
  T1("dir-identity-key", K_DIR_IDENTITY_KEY,         NO_ARGS,     NEED_KEY ),\
  T1("dir-key-published",K_DIR_KEY_PUBLISHED,        CONCAT_ARGS, NO_OBJ),   \
  T1("dir-key-expires",  K_DIR_KEY_EXPIRES,          CONCAT_ARGS, NO_OBJ),   \
  T1("dir-signing-key",  K_DIR_SIGNING_KEY,          NO_ARGS,     NEED_KEY ),\
  T1("dir-key-certification", K_DIR_KEY_CERTIFICATION,                       \
332
333
                                                     NO_ARGS,     NEED_OBJ), \
  T01("dir-address",     K_DIR_ADDRESS,              GE(1),       NO_OBJ),
334
335
336
337
338
339
340

static token_rule_t dir_key_certificate_table[] = {
  CERTIFICATE_MEMBERS
  T1("fingerprint",      K_FINGERPRINT,              CONCAT_ARGS, NO_OBJ ),
  END_OF_TABLE
};

341
342
/** List of tokens allowable in rendezvous service descriptors */
static token_rule_t desc_token_table[] = {
343
344
  T1_START("rendezvous-service-descriptor", R_RENDEZVOUS_SERVICE_DESCRIPTOR,
           EQ(1), NO_OBJ),
345
346
347
348
349
  T1("version", R_VERSION, EQ(1), NO_OBJ),
  T1("permanent-key", R_PERMANENT_KEY, NO_ARGS, NEED_KEY_1024),
  T1("secret-id-part", R_SECRET_ID_PART, EQ(1), NO_OBJ),
  T1("publication-time", R_PUBLICATION_TIME, CONCAT_ARGS, NO_OBJ),
  T1("protocol-versions", R_PROTOCOL_VERSIONS, EQ(1), NO_OBJ),
350
  T01("introduction-points", R_INTRODUCTION_POINTS, NO_ARGS, NEED_OBJ),
351
  T1_END("signature", R_SIGNATURE, NO_ARGS, NEED_OBJ),
352
353
354
355
356
357
  END_OF_TABLE
};

/** List of tokens allowed in the (encrypted) list of introduction points of
 * rendezvous service descriptors */
static token_rule_t ipo_token_table[] = {
358
  T1_START("introduction-point", R_IPO_IDENTIFIER, EQ(1), NO_OBJ),
359
360
361
362
363
364
365
  T1("ip-address", R_IPO_IP_ADDRESS, EQ(1), NO_OBJ),
  T1("onion-port", R_IPO_ONION_PORT, EQ(1), NO_OBJ),
  T1("onion-key", R_IPO_ONION_KEY, NO_ARGS, NEED_KEY_1024),
  T1("service-key", R_IPO_SERVICE_KEY, NO_ARGS, NEED_KEY_1024),
  END_OF_TABLE
};

366
367
368
369
370
371
372
373
374
/** List of tokens allowed in the (possibly encrypted) list of introduction
 * points of rendezvous service descriptors */
static token_rule_t client_keys_token_table[] = {
  T1_START("client-name", C_CLIENT_NAME, CONCAT_ARGS, NO_OBJ),
  T1("descriptor-cookie", C_DESCRIPTOR_COOKIE, EQ(1), NO_OBJ),
  T01("client-key", C_CLIENT_KEY, NO_ARGS, NEED_SKEY_1024),
  END_OF_TABLE
};

375
static token_rule_t networkstatus_token_table[] = {
376
377
378
379
  T1("network-status-version", K_NETWORK_STATUS_VERSION,
                                                   GE(1),       NO_OBJ ),
  T1("vote-status",            K_VOTE_STATUS,      GE(1),       NO_OBJ ),
  T1("published",              K_PUBLISHED,        CONCAT_ARGS, NO_OBJ ),
380
381
  T1("valid-after",            K_VALID_AFTER,      CONCAT_ARGS, NO_OBJ ),
  T1("fresh-until",            K_FRESH_UNTIL,      CONCAT_ARGS, NO_OBJ ),
382
  T1("valid-until",            K_VALID_UNTIL,      CONCAT_ARGS, NO_OBJ ),
383
  T1("voting-delay",           K_VOTING_DELAY,     GE(2),       NO_OBJ ),
384
  T1("known-flags",            K_KNOWN_FLAGS,      ARGS,        NO_OBJ ),
385
386
387
388
389
390
  T( "fingerprint",            K_FINGERPRINT,      CONCAT_ARGS, NO_OBJ ),

  CERTIFICATE_MEMBERS

  T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),
  T1( "contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
391
  T1( "dir-source",          K_DIR_SOURCE,      GE(6),       NO_OBJ ),
392
  T01("legacy-dir-key",      K_LEGACY_DIR_KEY,  GE(1),       NO_OBJ ),
393
394
395
  T1( "known-flags",         K_KNOWN_FLAGS,     CONCAT_ARGS, NO_OBJ ),
  T01("client-versions",     K_CLIENT_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  T01("server-versions",     K_SERVER_VERSIONS, CONCAT_ARGS, NO_OBJ ),
396
  T1( "consensus-methods",   K_CONSENSUS_METHODS, GE(1),     NO_OBJ ),
397
398
399

  END_OF_TABLE
};
400
static token_rule_t networkstatus_consensus_token_table[] = {
401
402
403
  T1("network-status-version", K_NETWORK_STATUS_VERSION,
                                                   GE(1),       NO_OBJ ),
  T1("vote-status",            K_VOTE_STATUS,      GE(1),       NO_OBJ ),
404
405
  T1("valid-after",            K_VALID_AFTER,      CONCAT_ARGS, NO_OBJ ),
  T1("fresh-until",            K_FRESH_UNTIL,      CONCAT_ARGS, NO_OBJ ),
406
  T1("valid-until",            K_VALID_UNTIL,      CONCAT_ARGS, NO_OBJ ),
407
  T1("voting-delay",           K_VOTING_DELAY,     GE(2),       NO_OBJ ),
408
409
410
411
412
413
414
415
416
417

  T0N("opt",                 K_OPT,             CONCAT_ARGS, OBJ_OK ),

  T1N("dir-source",          K_DIR_SOURCE,          GE(3),   NO_OBJ ),
  T1N("contact",             K_CONTACT,         CONCAT_ARGS, NO_OBJ ),
  T1N("vote-digest",         K_VOTE_DIGEST,         GE(1),   NO_OBJ ),

  T1( "known-flags",         K_KNOWN_FLAGS,     CONCAT_ARGS, NO_OBJ ),

  T01("client-versions",     K_CLIENT_VERSIONS, CONCAT_ARGS, NO_OBJ ),
418
419
  T01("server-versions",     K_SERVER_VERSIONS, CONCAT_ARGS, NO_OBJ ),
  T01("consensus-method",    K_CONSENSUS_METHOD,    EQ(1),   NO_OBJ),
420
421
422
423

  END_OF_TABLE
};

424
425
/** List of tokens allowable in the footer of v1/v2 directory/networkstatus
 * footers. */
426
static token_rule_t networkstatus_vote_footer_token_table[] = {
427
428
429
  T(  "directory-signature", K_DIRECTORY_SIGNATURE, GE(2),   NEED_OBJ ),
  END_OF_TABLE
};
430

431
432
433
434
435
static token_rule_t networkstatus_detached_signature_token_table[] = {
  T1_START("consensus-digest", K_CONSENSUS_DIGEST, GE(1),       NO_OBJ ),
  T1("valid-after",            K_VALID_AFTER,      CONCAT_ARGS, NO_OBJ ),
  T1("fresh-until",            K_FRESH_UNTIL,      CONCAT_ARGS, NO_OBJ ),
  T1("valid-until",            K_VALID_UNTIL,      CONCAT_ARGS, NO_OBJ ),
436
  T1N("directory-signature", K_DIRECTORY_SIGNATURE, GE(2),   NEED_OBJ ),
437
438
439
  END_OF_TABLE
};

440
441
#undef T

442
443
/* static function prototypes */
static int router_add_exit_policy(routerinfo_t *router,directory_token_t *tok);
444
static addr_policy_t *router_parse_addr_policy(directory_token_t *tok);
445
446
static addr_policy_t *router_parse_addr_policy_private(directory_token_t *tok);

447
static int router_get_hash_impl(const char *s, char *digest,
448
449
                                const char *start_str, const char *end_str,
                                char end_char);
450
451
static void token_free(directory_token_t *tok);
static smartlist_t *find_all_exitpolicy(smartlist_t *s);
452
453
454
455
456
457
458
static directory_token_t *_find_by_keyword(smartlist_t *s,
                                           directory_keyword keyword,
                                           const char *keyword_str);
#define find_by_keyword(s, keyword) _find_by_keyword((s), (keyword), #keyword)
static directory_token_t *find_opt_by_keyword(smartlist_t *s,
                                              directory_keyword keyword);

459
460
461
#define TS_ANNOTATIONS_OK 1
#define TS_NOCHECK 2
#define TS_NO_NEW_ANNOTATIONS 4
462
463
static int tokenize_string(memarea_t *area,
                           const char *start, const char *end,
464
                           smartlist_t *out,
465
                           token_rule_t *table,
466
                           int flags);
467
468
static directory_token_t *get_next_token(memarea_t *area,
                                         const char **s,
469
                                         const char *eos,
470
471
472
473
474
475
                                         token_rule_t *table);
static int check_signature_token(const char *digest,
                                 directory_token_t *tok,
                                 crypto_pk_env_t *pkey,
                                 int check_authority,
                                 const char *doctype);
476
static crypto_pk_env_t *find_dir_signing_key(const char *str, const char *eos);
477
static int tor_version_same_series(tor_version_t *a, tor_version_t *b);
478

479
480
481
482
483
484
485
486
487
488
489
490
491
#undef DEBUG_AREA_ALLOC

#ifdef DEBUG_AREA_ALLOC
#define DUMP_AREA(a,name) STMT_BEGIN                              \
  size_t alloc=0, used=0;                                         \
  memarea_get_stats((a),&alloc,&used);                            \
  log_debug(LD_MM, "Area for %s has %lu allocated; using %lu.",   \
            name, (unsigned long)alloc, (unsigned long)used);     \
  STMT_END
#else
#define DUMP_AREA(a,name) STMT_NIL
#endif

492
/** Set <b>digest</b> to the SHA-1 digest of the hash of the directory in
493
 * <b>s</b>.  Return 0 on success, -1 on failure.
494
 */
495
496
int
router_get_dir_hash(const char *s, char *digest)
497
498
{
  return router_get_hash_impl(s,digest,
499
                              "signed-directory","\ndirectory-signature",'\n');
500
501
502
}

/** Set <b>digest</b> to the SHA-1 digest of the hash of the first router in
503
 * <b>s</b>. Return 0 on success, -1 on failure.
504
 */
505
506
int
router_get_router_hash(const char *s, char *digest)
507
508
{
  return router_get_hash_impl(s,digest,
509
                              "router ","\nrouter-signature", '\n');
510
511
}

Nick Mathewson's avatar
Nick Mathewson committed
512
/** Set <b>digest</b> to the SHA-1 digest of the hash of the running-routers
513
 * string in <b>s</b>. Return 0 on success, -1 on failure.
Nick Mathewson's avatar
Nick Mathewson committed
514
 */
515
516
int
router_get_runningrouters_hash(const char *s, char *digest)
517
518
{
  return router_get_hash_impl(s,digest,
519
                              "network-status","\ndirectory-signature", '\n');
520
521
}

522
523
/** Set <b>digest</b> to the SHA-1 digest of the hash of the network-status
 * string in <b>s</b>.  Return 0 on success, -1 on failure. */
524
525
526
527
int
router_get_networkstatus_v2_hash(const char *s, char *digest)
{
  return router_get_hash_impl(s,digest,
528
529
530
531
532
533
534
535
536
537
538
539
                              "network-status-version","\ndirectory-signature",
                              '\n');
}

/** Set <b>digest</b> to the SHA-1 digest of the hash of the network-status
 * string in <b>s</b>.  Return 0 on success, -1 on failure. */
int
router_get_networkstatus_v3_hash(const char *s, char *digest)
{
  return router_get_hash_impl(s,digest,
                              "network-status-version","\ndirectory-signature",
                              ' ');
540
541
}

542
543
/** Set <b>digest</b> to the SHA-1 digest of the hash of the extrainfo
 * string in <b>s</b>.  Return 0 on success, -1 on failure. */
544
545
546
int
router_get_extrainfo_hash(const char *s, char *digest)
{
547
  return router_get_hash_impl(s,digest,"extra-info","\nrouter-signature",'\n');
548
549
}

550
551
552
553
554
555
556
557
558
559
560
/** Helper: used to generate signatures for routers, directories and
 * network-status objects.  Given a digest in <b>digest</b> and a secret
 * <b>private_key</b>, generate an PKCS1-padded signature, BASE64-encode it,
 * surround it with -----BEGIN/END----- pairs, and write it to the
 * <b>buf_len</b>-byte buffer at <b>buf</b>.  Return 0 on success, -1 on
 * failure.
 */
int
router_append_dirobj_signature(char *buf, size_t buf_len, const char *digest,
                               crypto_pk_env_t *private_key)
{
561
  char *signature;
562
  size_t i;
563

564
  signature = tor_malloc(crypto_pk_keysize(private_key));
565
566
  if (crypto_pk_private_sign(private_key, signature, digest, DIGEST_LEN) < 0) {

567
    log_warn(LD_BUG,"Couldn't sign digest.");
568
    goto err;
569
570
571
572
573
574
  }
  if (strlcat(buf, "-----BEGIN SIGNATURE-----\n", buf_len) >= buf_len)
    goto truncated;

  i = strlen(buf);
  if (base64_encode(buf+i, buf_len-i, signature, 128) < 0) {
575
    log_warn(LD_BUG,"couldn't base64-encode signature");
576
    goto err;
577
578
579
580
581
  }

  if (strlcat(buf, "-----END SIGNATURE-----\n", buf_len) >= buf_len)
    goto truncated;

582
  tor_free(signature);
583
  return 0;
584

585
 truncated:
586
  log_warn(LD_BUG,"tried to exceed string length.");
587
588
 err:
  tor_free(signature);
589
590
591
  return -1;
}

592
/** Return VS_RECOMMENDED if <b>myversion</b> is contained in
593
594
 * <b>versionlist</b>.  Else, return VS_EMPTY if versionlist has no
 * entries. Else, return VS_OLD if every member of
595
596
597
598
599
600
 * <b>versionlist</b> is newer than <b>myversion</b>.  Else, return
 * VS_NEW_IN_SERIES if there is at least one member of <b>versionlist</b> in
 * the same series (major.minor.micro) as <b>myversion</b>, but no such member
 * is newer than <b>myversion.</b>.  Else, return VS_NEW if every memeber of
 * <b>versionlist</b> is older than <b>myversion</b>.  Else, return
 * VS_UNRECOMMENDED.
601
 *
602
603
 * (versionlist is a comma-separated list of version strings,
 * optionally prefixed with "Tor".  Versions that can't be parsed are
604
 * ignored.)
605
 */
606
607
608
version_status_t
tor_version_is_obsolete(const char *myversion, const char *versionlist)
{
609
  tor_version_t mine, other;
610
611
612
  int found_newer = 0, found_older = 0, found_newer_in_series = 0,
    found_any_in_series = 0, r, same;
  version_status_t ret = VS_UNRECOMMENDED;
613
  smartlist_t *version_sl;
614

615
616
  log_debug(LD_CONFIG,"Checking whether version '%s' is in '%s'",
            myversion, versionlist);
617

618
  if (tor_version_parse(myversion, &mine)) {
619
    log_err(LD_BUG,"I couldn't parse my own version (%s)", myversion);
620
621
    tor_assert(0);
  }
622
623
  version_sl = smartlist_create();
  smartlist_split_string(version_sl, versionlist, ",", SPLIT_SKIP_SPACE, 0);
624

625
626
627
628
629
  if (!strlen(versionlist)) { /* no authorities cared or agreed */
    ret = VS_EMPTY;
    goto done;
  }

630
631
  SMARTLIST_FOREACH(version_sl, const char *, cp, {
    if (!strcmpstart(cp, "Tor "))
632
633
634
635
636
      cp += 4;

    if (tor_version_parse(cp, &other)) {
      /* Couldn't parse other; it can't be a match. */
    } else {
637
638
639
      same = tor_version_same_series(&mine, &other);
      if (same)
        found_any_in_series = 1;
640
641
      r = tor_version_compare(&mine, &other);
      if (r==0) {
642
        ret = VS_RECOMMENDED;
643
        goto done;
644
645
      } else if (r<0) {
        found_newer = 1;
646
647
        if (same)
          found_newer_in_series = 1;
648
649
      } else if (r>0) {
        found_older = 1;
650
651
      }
    }
652
653
  });

654
  /* We didn't find the listed version. Is it new or old? */
655
  if (found_any_in_series && !found_newer_in_series && found_newer) {
656
657
658
659
660
    ret = VS_NEW_IN_SERIES;
  } else if (found_newer && !found_older) {
    ret = VS_OLD;
  } else if (found_older && !found_newer) {
    ret = VS_NEW;
661
  } else {
662
    ret = VS_UNRECOMMENDED;
663
  }
664
665
666
667
668

 done:
  SMARTLIST_FOREACH(version_sl, char *, version, tor_free(version));
  smartlist_free(version_sl);
  return ret;
669
670
}

671
672
/** Read a signed directory from <b>str</b>.  If it's well-formed, return 0.
 * Otherwise, return -1.  If we're a directory cache, cache it.
673
 */
674
675
int
router_parse_directory(const char *str)
676
677
{
  directory_token_t *tok;
678
679
  char digest[DIGEST_LEN];
  time_t published_on;
680
  int r;
681
  const char *end, *cp;
682
  smartlist_t *tokens = NULL;
683
  crypto_pk_env_t *declared_key = NULL;
684
  memarea_t *area = memarea_new();
685

686
687
  /* XXXX This could be simplified a lot, but it will all go away
   * once pre-0.1.1.8 is obsolete, and for now it's better not to
Roger Dingledine's avatar
Roger Dingledine committed
688
   * touch it. */
689

690
  if (router_get_dir_hash(str, digest)) {
691
    log_warn(LD_DIR, "Unable to compute digest of directory");
692
693
    goto err;
  }
694
  log_debug(LD_DIR,"Received directory hashes to %s",hex_str(digest,4));
695

696
697
698
699
700
  /* Check signature first, before we try to tokenize. */
  cp = str;
  while (cp && (end = strstr(cp+1, "\ndirectory-signature")))
    cp = end;
  if (cp == str || !cp) {
701
    log_warn(LD_DIR, "No signature found on directory."); goto err;
702
703
704
  }
  ++cp;
  tokens = smartlist_create();
705
  if (tokenize_string(area,cp,strchr(cp,'\0'),tokens,dir_token_table,0)) {
706
    log_warn(LD_DIR, "Error tokenizing directory signature"); goto err;
707
708
  }
  if (smartlist_len(tokens) != 1) {
709
    log_warn(LD_DIR, "Unexpected number of tokens in signature"); goto err;
710
  }
711
  tok=smartlist_get(tokens,0);
712
  if (tok->tp != K_DIRECTORY_SIGNATURE) {
713
    log_warn(LD_DIR,"Expected a single directory signature"); goto err;
714
  }
715
  declared_key = find_dir_signing_key(str, str+strlen(str));
716
  note_crypto_pk_op(VERIFY_DIR);
717
  if (check_signature_token(digest, tok, declared_key, 1, "directory")<0)
718
    goto err;
719

720
  SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
721
722
  smartlist_clear(tokens);
  memarea_clear(area);
723
724

  /* Now try to parse the first part of the directory. */
725
726
727
728
729
730
731
732
  if ((end = strstr(str,"\nrouter "))) {
    ++end;
  } else if ((end = strstr(str, "\ndirectory-signature"))) {
    ++end;
  } else {
    end = str + strlen(str);
  }

733
  if (tokenize_string(area,str,end,tokens,dir_token_table,0)) {
734
    log_warn(LD_DIR, "Error tokenizing directory"); goto err;
735
736
  }

737
  tok = find_by_keyword(tokens, K_PUBLISHED);
738
739
  tor_assert(tok->n_args == 1);

740
  if (parse_iso_time(tok->args[0], &published_on) < 0) {
741
742
743
     goto err;
  }

744
745
  /* Now that we know the signature is okay, and we have a
   * publication time, cache the directory. */
746
  if (directory_caches_v1_dir_info(get_options()) &&
747
      !authdir_mode_v1(get_options()))
748
    dirserv_set_cached_directory(str, published_on, 0);
749

750
751
752
753
754
  r = 0;
  goto done;
 err:
  r = -1;
 done:
755
  if (declared_key) crypto_free_pk_env(declared_key);
756
  if (tokens) {
757
    SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
758
759
    smartlist_free(tokens);
  }
760
761
  if (area) {
    DUMP_AREA(area, "v1 directory");
762
    memarea_drop_all(area);
763
  }
764
765
766
  return r;
}

767
768
769
/** Read a signed router status statement from <b>str</b>.  If it's
 * well-formed, return 0.  Otherwise, return -1.  If we're a directory cache,
 * cache it.*/
770
771
int
router_parse_runningrouters(const char *str)
772
773
774
775
{
  char digest[DIGEST_LEN];
  directory_token_t *tok;
  time_t published_on;
776
  int r = -1;
777
  crypto_pk_env_t *declared_key = NULL;
778
  smartlist_t *tokens = NULL;
779
  const char *eos = str + strlen(str);
780
  memarea_t *area = NULL;
781
782

  if (router_get_runningrouters_hash(str, digest)) {
783
    log_warn(LD_DIR, "Unable to compute digest of running-routers");
784
785
    goto err;
  }
786
  area = memarea_new();
787
  tokens = smartlist_create();
788
  if (tokenize_string(area,str,eos,tokens,dir_token_table,0)) {
789
    log_warn(LD_DIR, "Error tokenizing running-routers"); goto err;
790
791
792
  }
  tok = smartlist_get(tokens,0);
  if (tok->tp != K_NETWORK_STATUS) {
793
    log_warn(LD_DIR, "Network-status starts with wrong token");
794
795
796
    goto err;
  }

797
  tok = find_by_keyword(tokens, K_PUBLISHED);
798
  tor_assert(tok->n_args == 1);
799
  if (parse_iso_time(tok->args[0], &published_on) < 0) {
800
801
     goto err;
  }
802
  if (!(tok = find_opt_by_keyword(tokens, K_DIRECTORY_SIGNATURE))) {
803
    log_warn(LD_DIR, "Missing signature on running-routers");
804
805
    goto err;
  }
806
  declared_key = find_dir_signing_key(str, eos);
807
  note_crypto_pk_op(VERIFY_DIR);
808
809
  if (check_signature_token(digest, tok, declared_key, 1, "running-routers")
      < 0)
810
811
    goto err;

812
813
  /* Now that we know the signature is okay, and we have a
   * publication time, cache the list. */
814
  if (get_options()->DirPort && !authdir_mode_v1(get_options()))
815
816
817
    dirserv_set_cached_directory(str, published_on, 1);

  r = 0;
818
 err:
819
  if (declared_key) crypto_free_pk_env(declared_key);
820
  if (tokens) {
821
    SMARTLIST_FOREACH(tokens, directory_token_t *, t, token_free(t));
822
823
    smartlist_free(tokens);
  }
824
825
  if (area) {
    DUMP_AREA(area, "v1 running-routers");
826
    memarea_drop_all(area);
827
  }
828
  return r;
829
830
}

831
832
833
/** Given a directory or running-routers string in <b>str</b>, try to
 * find the its dir-signing-key token (if any).  If this token is
 * present, extract and return the key.  Return NULL on failure. */
834
static crypto_pk_env_t *
835
find_dir_signing_key(const char *str, const char *eos)
836
837
838
839
{
  const char *cp;
  directory_token_t *tok;
  crypto_pk_env_t *key = NULL;
840
  memarea_t *area = NULL;
841
842
  tor_assert(str);
  tor_assert(eos);
843
844

  /* Is there a dir-signing-key in the directory? */
845
  cp = tor_memstr(str, eos-str, "\nopt dir-signing-key");
846
  if (!cp)
847
    cp = tor_memstr(str, eos-str, "\ndir-signing-key");
848
849
850
851
  if (!cp)
    return NULL;
  ++cp; /* Now cp points to the start of the token. */

852
  area = memarea_new();
853
  tok = get_next_token(area, &cp, eos, dir_token_table);
854
  if (!tok) {
855
    log_warn(LD_DIR, "Unparseable dir-signing-key token");
856
    goto done;
857
858
  }
  if (tok->tp != K_DIR_SIGNING_KEY) {
859
    log_warn(LD_DIR, "Dir-signing-key token did not parse as expected");
860
    goto done;
861
862
863
864
865
866
  }

  if (tok->key) {
    key = tok->key;
    tok->key = NULL; /* steal reference. */
  } else {
867
    log_warn(LD_DIR, "Dir-signing-key token contained no key");
868
869
  }

870
871
 done:
  if (tok) token_free(tok);
872
873
874
875
  if (area) {
    DUMP_AREA(area, "dir-signing-key token");
    memarea_drop_all(area);
  }
876
877
878
879
880
  return key;
}

/** Return true iff <b>key</b> is allowed to sign directories.
 */
881
882
static int
dir_signing_key_is_trusted(crypto_pk_env_t *key)
883
884
885
886
{
  char digest[DIGEST_LEN];
  if (!key) return 0;
  if (crypto_pk_get_digest(key, digest) < 0) {
887
    log_warn(LD_DIR, "Error computing dir-signing-key digest");
888
889
    return 0;
  }
890
  if (!router_digest_is_trusted_dir(digest)) {
891
    log_warn(LD_DIR, "Listed dir-signing-key is not trusted");
892
893
894
895
896
    return 0;
  }
  return 1;
}

897
898
899
900
901
/** Check whether the object body of the token in <b>tok</b> has a good
 * signature for <b>digest</b> using key <b>pkey</b>.  If
 * <b>check_authority</b> is set, make sure that <b>pkey</b> is the key of a
 * directory authority.  Use <b>doctype</b> as the type of the document when
 * generating log messages.  Return 0 on success, negative on failure.
902
 */
903
static int
904
905
906
907
908
check_signature_token(const char *digest,
                      directory_token_t *tok,
                      crypto_pk_env_t *pkey,
                      int check_authority,
                      const char *doctype)
909
{
910
  char *signed_digest;
911

912
913
914
915
916
917
918
919
  tor_assert(pkey);
  tor_assert(tok);
  tor_assert(digest);
  tor_assert(doctype);

  if (check_authority && !dir_signing_key_is_trusted(pkey)) {
    log_warn(LD_DIR, "Key on %s did not come from an authority; rejecting",
             doctype);
920
    return -1;
921
  }
922

923
  if (strcmp(tok->object_type, "SIGNATURE")) {
924
    log_warn(LD_DIR, "Bad object type on %s signature", doctype);
925
    return -1;
926
  }
927

928