chiark / gitweb /
server/peer.c, server/keyset.c: Fix key renegotiation behaviour.
[tripe] / server / keymgmt.c
1 /* -*-c-*-
2  *
3  * Key loading and storing
4  *
5  * (c) 2001 Straylight/Edgeware
6  */
7
8 /*----- Licensing notice --------------------------------------------------*
9  *
10  * This file is part of Trivial IP Encryption (TrIPE).
11  *
12  * TrIPE is free software; you can redistribute it and/or modify
13  * it under the terms of the GNU General Public License as published by
14  * the Free Software Foundation; either version 2 of the License, or
15  * (at your option) any later version.
16  *
17  * TrIPE is distributed in the hope that it will be useful,
18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
20  * GNU General Public License for more details.
21  *
22  * You should have received a copy of the GNU General Public License
23  * along with TrIPE; if not, write to the Free Software Foundation,
24  * Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
25  */
26
27 /*----- Header files ------------------------------------------------------*/
28
29 #include "tripe.h"
30
31 /*----- Global variables --------------------------------------------------*/
32
33 group *gg;
34 mp *kpriv;
35 ge *kpub;
36 algswitch algs;
37 size_t indexsz;
38
39 /*----- Static variables --------------------------------------------------*/
40
41 static key_file *kf_pub;
42 static const char *kr_priv, *kr_pub, *tag_priv;
43 static fwatch w_priv, w_pub;
44
45 /*----- Key groups --------------------------------------------------------*/
46
47 typedef struct kgops {
48   const char *ty;
49   const char *(*loadpriv)(key_data *, group **, mp **, dstr *);
50   const char *(*loadpub)(key_data *, group **, ge **, dstr *);
51 } kgops;
52
53 /* --- Diffie-Hellman --- */
54
55 static const char *kgdh_priv(key_data *kd, group **g, mp **x, dstr *t)
56 {
57   key_packstruct kps[DH_PRIVFETCHSZ];
58   key_packdef *kp;
59   dh_priv dp;
60   const char *e;
61   int rc;
62
63   kp = key_fetchinit(dh_privfetch, kps, &dp);
64   if ((rc = key_unpack(kp, kd, t)) != 0) {
65     e = key_strerror(rc);
66     goto done;
67   }
68   *g = group_prime(&dp.dp);
69   *x = MP_COPY(dp.x);
70   e = 0;
71 done:
72   key_fetchdone(kp);
73   return (e);
74 }
75
76 static const char *kgdh_pub(key_data *kd, group **g, ge **p, dstr *t)
77 {
78   key_packstruct kps[DH_PUBFETCHSZ];
79   key_packdef *kp;
80   dh_pub dp;
81   const char *e;
82   int rc;
83
84   kp = key_fetchinit(dh_pubfetch, kps, &dp);
85   if ((rc = key_unpack(kp, kd, t)) != 0) {
86     e = key_strerror(rc);
87     goto done;
88   }
89   *g = group_prime(&dp.dp);
90   *p = G_CREATE(*g);
91   if (G_FROMINT(*g, *p, dp.y)) {
92     e = "bad public value";
93     goto done;
94   }
95   e = 0;
96 done:
97   key_fetchdone(kp);
98   return (e);
99 }
100
101 static const kgops kgdh_ops = { "tripe-dh", kgdh_priv, kgdh_pub };
102
103 /* --- Elliptic curve --- */
104
105 static const char *kgec_priv(key_data *kd, group **g, mp **x, dstr *t)
106 {
107   key_packstruct kps[EC_PRIVFETCHSZ];
108   key_packdef *kp;
109   ec_priv ep;
110   ec_info ei;
111   const char *e;
112   int rc;
113
114   kp = key_fetchinit(ec_privfetch, kps, &ep);
115   if ((rc = key_unpack(kp, kd, t)) != 0) {
116     e = key_strerror(rc);
117     goto done;
118   }
119   if ((e = ec_getinfo(&ei, ep.cstr)) != 0)
120     goto done;
121   *g = group_ec(&ei);
122   *x = MP_COPY(ep.x);
123   e = 0;
124 done:
125   key_fetchdone(kp);
126   return (e);
127 }
128
129 static const char *kgec_pub(key_data *kd, group **g, ge **p, dstr *t)
130 {
131   key_packstruct kps[EC_PUBFETCHSZ];
132   key_packdef *kp;
133   ec_pub ep;
134   ec_info ei;
135   const char *e;
136   int rc;
137
138   kp = key_fetchinit(ec_pubfetch, kps, &ep);
139   if ((rc = key_unpack(kp, kd, t)) != 0) {
140     e = key_strerror(rc);
141     goto done;
142   }
143   if ((e = ec_getinfo(&ei, ep.cstr)) != 0)
144     goto done;
145   *g = group_ec(&ei);
146   *p = G_CREATE(*g);
147   if (G_FROMEC(*g, *p, &ep.p)) {
148     e = "bad public point";
149     goto done;
150   }
151   e = 0;
152 done:
153   key_fetchdone(kp);
154   return (e);
155 }
156
157 static const kgops kgec_ops = { "tripe-ec", kgec_priv, kgec_pub };
158
159 /* --- Table of supported key types --- */
160
161 static const kgops *kgtab[] = { &kgdh_ops, &kgec_ops, 0 };
162
163 /*----- Algswitch stuff ---------------------------------------------------*/
164
165 /* --- @algs_get@ --- *
166  *
167  * Arguments:   @algswitch *a@ = where to put the algorithms
168  *              @key_file *kf@ = key file (for some stupid reason)
169  *              @key *k@ = key to inspect
170  *
171  * Returns:     Null if OK, or an error message.
172  *
173  * Use:         Extracts an algorithm choice from a key.
174  */
175
176 static const char *algs_get(algswitch *a, key_file *kf, key *k)
177 {
178   const char *p;
179   char *q;
180   dstr d = DSTR_INIT;
181   const char *e;
182
183 #define FAIL(msg) do { e = msg; goto done; } while (0)
184
185   if ((p = key_getattr(kf, k, "cipher")) == 0)
186     p = "blowfish-cbc";
187   if ((a->c = gcipher_byname(p)) == 0)
188     FAIL("unknown-cipher");
189
190   if ((p = key_getattr(kf, k, "hash")) == 0)
191     p = "rmd160";
192   if ((a->h = ghash_byname(p)) == 0)
193     FAIL("unknown-hash");
194
195   if ((p = key_getattr(kf, k, "mgf")) == 0) {
196     dstr_reset(&d);
197     dstr_putf(&d, "%s-mgf", a->h->name);
198     p = d.buf;
199   }
200   if ((a->mgf = gcipher_byname(p)) == 0)
201     FAIL("unknown-mgf-cipher");
202
203   if ((p = key_getattr(kf, k, "mac")) != 0) {
204     dstr_reset(&d);
205     dstr_puts(&d, p);
206     if ((q = strchr(d.buf, '/')) != 0)
207       *q++ = 0;
208     if ((a->m = gmac_byname(d.buf)) == 0)
209       FAIL("unknown-mac");
210     if (!q)
211       a->tagsz = a->m->hashsz;
212     else {
213       unsigned long n = strtoul(q, &q, 0);
214       if (*q) FAIL("bad-tag-length-string");
215       if (n%8 || n > ~(size_t)0) FAIL("bad-tag-length");
216       a->tagsz = n/8;
217     }
218   } else {
219     dstr_reset(&d);
220     dstr_putf(&d, "%s-hmac", a->h->name);
221     if ((a->m = gmac_byname(d.buf)) == 0)
222       FAIL("no-hmac-for-hash");
223     a->tagsz = a->h->hashsz/2;
224   }
225
226   e = 0;
227 done:
228   dstr_destroy(&d);
229   return (e);
230 }
231
232 /* --- @algs_check@ --- *
233  *
234  * Arguments:   @algswitch *a@ = a choice of algorithms
235  *              @const group *g@ = the group we're working in
236  *
237  * Returns:     Null if OK, or an error message.
238  *
239  * Use:         Checks an algorithm choice for sensibleness.  This also
240  *              derives some useful information from the choices, and you
241  *              must call this before committing the algorithm selection
242  *              for use by @keyset@ functions.
243  */
244
245 static const char *algs_check(algswitch *a, const group *g)
246 {
247   /* --- Derive the key sizes --- *
248    *
249    * Must ensure that we have non-empty keys.  This isn't ideal, but it
250    * provides a handy sanity check.
251    */
252
253   a->hashsz = a->h->hashsz;
254   if ((a->cksz = keysz(a->hashsz, a->c->keysz)) == 0)
255     return ("no key size found for cipher");
256   if ((a->mksz = keysz(a->hashsz, a->m->keysz)) == 0)
257     return ("no key size found for MAC");
258
259   /* --- Ensure that the tag size is sane --- */
260
261   if (a->tagsz > a->m->hashsz) return ("tag length too large");
262
263   /* --- Ensure the MGF accepts hashes as keys --- */
264
265   if (keysz(a->hashsz, a->mgf->keysz) != a->hashsz)
266     return ("MGF not suitable -- restrictive key schedule");
267
268   /* --- All ship-shape and Bristol-fashion --- */
269
270   return (0);
271 }
272
273 /* --- @algs_samep@ --- *
274  *
275  * Arguments:   @const algswitch *a, *aa@ = two algorithm selections
276  *
277  * Returns:     Nonzero if the two selections are the same.
278  *
279  * Use:         Checks sameness of algorithm selections: used to ensure that
280  *              peers are using sensible algorithms.
281  */
282
283 static int algs_samep(const algswitch *a, const algswitch *aa)
284 {
285   return (a->c == aa->c && a->mgf == aa->mgf && a->h == aa->h &&
286           a->m == aa->m && a->tagsz == aa->tagsz);
287 }
288
289 /*----- Main code ---------------------------------------------------------*/
290
291 /* --- @keymoan@ --- *
292  *
293  * Arguments:   @const char *file@ = name of the file
294  *              @int line@ = line number in file
295  *              @const char *msg@ = error message
296  *              @void *p@ = argument pointer
297  *
298  * Returns:     ---
299  *
300  * Use:         Reports an error message about loading a key file.
301  */
302
303 static void keymoan(const char *file, int line, const char *msg, void *p)
304 {
305   a_warn("KEYMGMT",
306          "key-file-error",
307          "%s:%i", file, line,
308          "%s", msg,
309          A_END);
310 }
311
312 /* --- @loadpriv@ --- *
313  *
314  * Arguments:   @dstr *d@ = string to write errors in
315  *
316  * Returns:     Zero if OK, nonzero on error.
317  *
318  * Use:         Loads the private key from its keyfile.
319  */
320
321 static int loadpriv(dstr *d)
322 {
323   key_file kf;
324   key *k;
325   key_data **kd;
326   dstr t = DSTR_INIT;
327   group *g = 0;
328   mp *x = 0;
329   int rc = -1;
330   const kgops **ko;
331   const char *e;
332   algswitch a;
333
334   /* --- Open the private key file --- */
335
336   if (key_open(&kf, kr_priv, KOPEN_READ, keymoan, 0)) {
337     dstr_putf(d, "error reading private keyring `%s': %s",
338               kr_priv, strerror(errno));
339     goto done_0;
340   }
341
342   /* --- Find the private key --- */
343
344   if (key_qtag(&kf, tag_priv, &t, &k, &kd)) {
345     dstr_putf(d, "private key `%s' not found in keyring `%s'",
346               tag_priv, kr_priv);
347     goto done_1;
348   }
349
350   /* --- Look up the key type in the table --- */
351
352   for (ko = kgtab; *ko; ko++) {
353     if (strcmp((*ko)->ty, k->type) == 0)
354       goto tymatch;
355   }
356   dstr_putf(d, "private key `%s' has unknown type `%s'", t.buf, k->type);
357   goto done_1;
358 tymatch:;
359
360   /* --- Load the key --- */
361
362   if ((e = (*ko)->loadpriv(*kd, &g, &x, &t)) != 0) {
363     dstr_putf(d, "error reading private key `%s': %s", t.buf, e);
364     goto done_1;
365   }
366
367   /* --- Check that the key is sensible --- */
368
369   if ((e = G_CHECK(g, &rand_global)) != 0) {
370     dstr_putf(d, "bad group in private key `%s': %s", t.buf, e);
371     goto done_1;
372   }
373
374   /* --- Collect the algorithms --- */
375
376   if ((e = algs_get(&a, &kf, k)) != 0 ||
377       (e = algs_check(&a, g)) != 0) {
378     dstr_putf(d, "bad symmetric algorithm selection in private key `%s': %s",
379               t.buf, e);
380     goto done_1;
381   }
382
383   /* --- Good, we're happy --- *
384    *
385    * Dodginess!  We change the group over here, but don't free any old group
386    * elements.  This assumes that the new group is basically the same as the
387    * old one, and will happily adopt the existing elements.  If it isn't,
388    * then we lose badly.  Check this, then.
389    */
390
391   if (gg) {
392     if (!group_samep(g, gg)) {
393       dstr_putf(d, "private key `%s' has different group", t.buf);
394       goto done_1;
395     }
396     G_DESTROYGROUP(gg);
397   }
398   if (kpriv)
399     mp_drop(kpriv);
400
401   if (kpub)
402     G_DESTROY(g, kpub);
403   kpub = G_CREATE(g);
404   G_EXP(g, kpub, g->g, x);
405   indexsz = mp_octets(g->r);
406
407   /* --- Dump out the group --- */
408
409   IF_TRACING(T_KEYMGMT, {
410     trace(T_KEYMGMT, "keymgmt: extracted private key `%s'", t.buf);
411     IF_TRACING(T_CRYPTO, {
412       trace(T_CRYPTO, "crypto: r = %s", mpstr(g->r));
413       trace(T_CRYPTO, "crypto: h = %s", mpstr(g->h));
414       trace(T_CRYPTO, "crypto: x = %s", mpstr(x));
415       trace(T_CRYPTO, "crypto: cipher = %s", a.c->name);
416       trace(T_CRYPTO, "crypto: mgf = %s", a.mgf->name);
417       trace(T_CRYPTO, "crypto: hash = %s", a.h->name);
418       trace(T_CRYPTO, "crypto: mac = %s/%lu",
419             a.m->name, (unsigned long)a.tagsz * 8);
420     })
421   })
422
423   /* --- Success! --- */
424
425   gg = g; g = 0;
426   algs = a;
427   kpriv = x; x = 0;
428   rc = 0;
429
430   /* --- Tidy up --- */
431
432 done_1:
433   key_close(&kf);
434 done_0:
435   dstr_destroy(&t);
436   if (x) mp_drop(x);
437   if (g) G_DESTROYGROUP(g);
438   return (rc);
439 }
440
441 /* --- @loadpub@ --- *
442  *
443  * Arguments:   @dstr *d@ = string to write errors to
444  *
445  * Returns:     Zero if OK, nonzero on error.
446  *
447  * Use:         Reloads the public keyring.
448  */
449
450 static int loadpub(dstr *d)
451 {
452   key_file *kf = CREATE(key_file);
453
454   if (key_open(kf, kr_pub, KOPEN_READ, keymoan, 0)) {
455     dstr_putf(d, "error reading public keyring `%s': %s",
456               kr_pub, strerror(errno));
457     DESTROY(kf);
458     return (-1);
459   }
460   kf_pub = kf;
461   T( trace(T_KEYMGMT, "keymgmt: loaded public keyring `%s'", kr_pub); )
462   return (0);
463 }
464
465 /* --- @km_reload@ --- *
466  *
467  * Arguments:   ---
468  *
469  * Returns:     Zero if OK, nonzero to force reloading of keys.
470  *
471  * Use:         Checks the keyrings to see if they need reloading.
472  */
473
474 int km_reload(void)
475 {
476   dstr d = DSTR_INIT;
477   key_file *kf;
478   int reload = 0;
479
480   /* --- Check the private key first --- */
481
482   if (fwatch_update(&w_priv, kr_priv)) {
483     T( trace(T_KEYMGMT, "keymgmt: private keyring updated: reloading..."); )
484     DRESET(&d);
485     if (loadpriv(&d))
486       a_warn("KEYMGMT", "bad-private-key", "%s", d.buf, A_END);
487     else
488       reload = 1;
489   }
490
491   /* --- Now check the public keys --- */
492
493   if (fwatch_update(&w_pub, kr_pub)) {
494     T( trace(T_KEYMGMT, "keymgmt: public keyring updated: reloading..."); )
495     kf = kf_pub;
496     DRESET(&d);
497     if (loadpub(&d))
498       a_warn("KEYMGMT", "bad-public-keyring", "%s", d.buf, A_END);
499     else {
500       reload = 1;
501       key_close(kf);
502       DESTROY(kf);
503     }
504   }
505
506   /* --- Done --- */
507
508   return (reload);
509 }
510
511 /* --- @km_init@ --- *
512  *
513  * Arguments:   @const char *priv@ = private keyring file
514  *              @const char *pub@ = public keyring file
515  *              @const char *tag@ = tag to load
516  *
517  * Returns:     ---
518  *
519  * Use:         Initializes, and loads the private key.
520  */
521
522 void km_init(const char *priv, const char *pub, const char *tag)
523 {
524   dstr d = DSTR_INIT;
525   const gchash *const *hh;
526
527   kr_priv = priv;
528   kr_pub = pub;
529   tag_priv = tag;
530   fwatch_init(&w_priv, kr_priv);
531   fwatch_init(&w_pub, kr_pub);
532
533   for (hh = ghashtab; *hh; hh++) {
534     if ((*hh)->hashsz > MAXHASHSZ) {
535       die(EXIT_FAILURE, "INTERNAL ERROR: %s hash length %lu > MAXHASHSZ %d",
536           (*hh)->name, (unsigned long)(*hh)->hashsz, MAXHASHSZ);
537     }
538   }
539
540   DRESET(&d);
541   if (loadpriv(&d))
542     die(EXIT_FAILURE, "%s", d.buf);
543   if (loadpub(&d))
544     die(EXIT_FAILURE, "%s", d.buf);
545 }
546
547 /* --- @km_getpubkey@ --- *
548  *
549  * Arguments:   @const char *tag@ = public key tag to load
550  *              @ge *kpub@ = where to put the public key
551  *              @time_t *t_exp@ = where to put the expiry time
552  *
553  * Returns:     Zero if OK, nonzero if it failed.
554  *
555  * Use:         Fetches a public key from the keyring.
556  */
557
558 int km_getpubkey(const char *tag, ge *kpub, time_t *t_exp)
559 {
560   key *k;
561   key_data **kd;
562   dstr t = DSTR_INIT;
563   const kgops **ko;
564   const char *e;
565   group *g = 0;
566   ge *p = 0;
567   algswitch a;
568   int rc = -1;
569
570   /* --- Find the key --- */
571
572   if (key_qtag(kf_pub, tag, &t, &k, &kd)) {
573     a_warn("KEYMGMT", "public-key", "%s", tag, "not-found", A_END);
574     goto done;
575   }
576
577   /* --- Look up the key type in the table --- */
578
579   for (ko = kgtab; *ko; ko++) {
580     if (strcmp((*ko)->ty, k->type) == 0)
581       goto tymatch;
582   }
583   a_warn("KEYMGMT",
584          "public-key", "%s", t.buf,
585          "unknown-type", "%s", k->type,
586          A_END);
587   goto done;
588 tymatch:;
589
590   /* --- Load the key --- */
591
592   if ((e = (*ko)->loadpub(*kd, &g, &p, &t)) != 0) {
593     a_warn("KEYMGMT", "public-key", "%s", t.buf, "bad", "%s", e, A_END);
594     goto done;
595   }
596
597   /* --- Ensure that the group is correct --- *
598    *
599    * Dodginess!  We assume that if this works, our global group is willing to
600    * adopt this public element.  Probably reasonable.
601    */
602
603   if (!group_samep(gg, g)) {
604     a_warn("KEYMGMT", "public-key", "%s", t.buf, "incorrect-group", A_END);
605     goto done;
606   }
607
608   /* --- Check the public group element --- */
609
610   if (group_check(gg, p)) {
611     a_warn("KEYMGMT",
612            "public-key", "%s", t.buf,
613            "bad-public-group-element",
614            A_END);
615     goto done;
616   }
617
618   /* --- Check the algorithms --- */
619
620   if ((e = algs_get(&a, kf_pub, k)) != 0) {
621     a_warn("KEYMGMT",
622            "public-key", "%s", t.buf,
623            "bad-algorithm-selection", e,
624            A_END);
625     goto done;
626   }
627   if (!algs_samep(&a, &algs)) {
628     a_warn("KEYMGMT",
629            "public-key", "%s", t.buf,
630            "algorithm-mismatch",
631            A_END);
632     goto done;
633   }
634
635   /* --- Dump the public key --- */
636
637   IF_TRACING(T_KEYMGMT, {
638     trace(T_KEYMGMT, "keymgmt: extracted public key `%s'", t.buf);
639     trace(T_CRYPTO, "crypto: p = %s", gestr(gg, p));
640   })
641
642   /* --- OK, accept the public key --- */
643
644   *t_exp = k->exp;
645   G_COPY(gg, kpub, p);
646   rc = 0;
647
648   /* --- Tidy up --- */
649
650 done:
651   if (p) G_DESTROY(g, p);
652   if (g) G_DESTROYGROUP(g);
653   dstr_destroy(&t);
654   return (rc);
655 }
656
657 /*----- That's all, folks -------------------------------------------------*/