doc: Fix section of functions age(xid) and mxid_age(xid)
[pgsql.git] / contrib / pgcrypto / pgp-pubkey.c
blob9a6561caf9ddedbb7cb7a22ffd18d4c26a03854a
1 /*
2 * pgp-pubkey.c
3 * Read public or secret key.
5 * Copyright (c) 2005 Marko Kreen
6 * All rights reserved.
8 * Redistribution and use in source and binary forms, with or without
9 * modification, are permitted provided that the following conditions
10 * are met:
11 * 1. Redistributions of source code must retain the above copyright
12 * notice, this list of conditions and the following disclaimer.
13 * 2. Redistributions in binary form must reproduce the above copyright
14 * notice, this list of conditions and the following disclaimer in the
15 * documentation and/or other materials provided with the distribution.
17 * THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
18 * ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
19 * IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
20 * ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
21 * FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
22 * DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
23 * OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
24 * HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
25 * LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
26 * OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
27 * SUCH DAMAGE.
29 * contrib/pgcrypto/pgp-pubkey.c
31 #include "postgres.h"
33 #include "mbuf.h"
34 #include "pgp.h"
35 #include "px.h"
37 int
38 pgp_key_alloc(PGP_PubKey **pk_p)
40 PGP_PubKey *pk;
42 pk = palloc0(sizeof(*pk));
43 *pk_p = pk;
44 return 0;
47 void
48 pgp_key_free(PGP_PubKey *pk)
50 if (pk == NULL)
51 return;
53 switch (pk->algo)
55 case PGP_PUB_ELG_ENCRYPT:
56 pgp_mpi_free(pk->pub.elg.p);
57 pgp_mpi_free(pk->pub.elg.g);
58 pgp_mpi_free(pk->pub.elg.y);
59 pgp_mpi_free(pk->sec.elg.x);
60 break;
61 case PGP_PUB_RSA_SIGN:
62 case PGP_PUB_RSA_ENCRYPT:
63 case PGP_PUB_RSA_ENCRYPT_SIGN:
64 pgp_mpi_free(pk->pub.rsa.n);
65 pgp_mpi_free(pk->pub.rsa.e);
66 pgp_mpi_free(pk->sec.rsa.d);
67 pgp_mpi_free(pk->sec.rsa.p);
68 pgp_mpi_free(pk->sec.rsa.q);
69 pgp_mpi_free(pk->sec.rsa.u);
70 break;
71 case PGP_PUB_DSA_SIGN:
72 pgp_mpi_free(pk->pub.dsa.p);
73 pgp_mpi_free(pk->pub.dsa.q);
74 pgp_mpi_free(pk->pub.dsa.g);
75 pgp_mpi_free(pk->pub.dsa.y);
76 pgp_mpi_free(pk->sec.dsa.x);
77 break;
79 px_memset(pk, 0, sizeof(*pk));
80 pfree(pk);
83 static int
84 calc_key_id(PGP_PubKey *pk)
86 int res;
87 PX_MD *md;
88 int len;
89 uint8 hdr[3];
90 uint8 hash[20];
92 res = pgp_load_digest(PGP_DIGEST_SHA1, &md);
93 if (res < 0)
94 return res;
96 len = 1 + 4 + 1;
97 switch (pk->algo)
99 case PGP_PUB_ELG_ENCRYPT:
100 len += 2 + pk->pub.elg.p->bytes;
101 len += 2 + pk->pub.elg.g->bytes;
102 len += 2 + pk->pub.elg.y->bytes;
103 break;
104 case PGP_PUB_RSA_SIGN:
105 case PGP_PUB_RSA_ENCRYPT:
106 case PGP_PUB_RSA_ENCRYPT_SIGN:
107 len += 2 + pk->pub.rsa.n->bytes;
108 len += 2 + pk->pub.rsa.e->bytes;
109 break;
110 case PGP_PUB_DSA_SIGN:
111 len += 2 + pk->pub.dsa.p->bytes;
112 len += 2 + pk->pub.dsa.q->bytes;
113 len += 2 + pk->pub.dsa.g->bytes;
114 len += 2 + pk->pub.dsa.y->bytes;
115 break;
118 hdr[0] = 0x99;
119 hdr[1] = len >> 8;
120 hdr[2] = len & 0xFF;
121 px_md_update(md, hdr, 3);
123 px_md_update(md, &pk->ver, 1);
124 px_md_update(md, pk->time, 4);
125 px_md_update(md, &pk->algo, 1);
127 switch (pk->algo)
129 case PGP_PUB_ELG_ENCRYPT:
130 pgp_mpi_hash(md, pk->pub.elg.p);
131 pgp_mpi_hash(md, pk->pub.elg.g);
132 pgp_mpi_hash(md, pk->pub.elg.y);
133 break;
134 case PGP_PUB_RSA_SIGN:
135 case PGP_PUB_RSA_ENCRYPT:
136 case PGP_PUB_RSA_ENCRYPT_SIGN:
137 pgp_mpi_hash(md, pk->pub.rsa.n);
138 pgp_mpi_hash(md, pk->pub.rsa.e);
139 break;
140 case PGP_PUB_DSA_SIGN:
141 pgp_mpi_hash(md, pk->pub.dsa.p);
142 pgp_mpi_hash(md, pk->pub.dsa.q);
143 pgp_mpi_hash(md, pk->pub.dsa.g);
144 pgp_mpi_hash(md, pk->pub.dsa.y);
145 break;
148 px_md_finish(md, hash);
149 px_md_free(md);
151 memcpy(pk->key_id, hash + 12, 8);
152 px_memset(hash, 0, 20);
154 return 0;
158 _pgp_read_public_key(PullFilter *pkt, PGP_PubKey **pk_p)
160 int res;
161 PGP_PubKey *pk;
163 res = pgp_key_alloc(&pk);
164 if (res < 0)
165 return res;
167 /* get version */
168 GETBYTE(pkt, pk->ver);
169 if (pk->ver != 4)
171 res = PXE_PGP_NOT_V4_KEYPKT;
172 goto out;
175 /* read time */
176 res = pullf_read_fixed(pkt, 4, pk->time);
177 if (res < 0)
178 goto out;
180 /* pubkey algorithm */
181 GETBYTE(pkt, pk->algo);
183 switch (pk->algo)
185 case PGP_PUB_DSA_SIGN:
186 res = pgp_mpi_read(pkt, &pk->pub.dsa.p);
187 if (res < 0)
188 break;
189 res = pgp_mpi_read(pkt, &pk->pub.dsa.q);
190 if (res < 0)
191 break;
192 res = pgp_mpi_read(pkt, &pk->pub.dsa.g);
193 if (res < 0)
194 break;
195 res = pgp_mpi_read(pkt, &pk->pub.dsa.y);
196 if (res < 0)
197 break;
199 res = calc_key_id(pk);
200 break;
202 case PGP_PUB_RSA_SIGN:
203 case PGP_PUB_RSA_ENCRYPT:
204 case PGP_PUB_RSA_ENCRYPT_SIGN:
205 res = pgp_mpi_read(pkt, &pk->pub.rsa.n);
206 if (res < 0)
207 break;
208 res = pgp_mpi_read(pkt, &pk->pub.rsa.e);
209 if (res < 0)
210 break;
212 res = calc_key_id(pk);
214 if (pk->algo != PGP_PUB_RSA_SIGN)
215 pk->can_encrypt = 1;
216 break;
218 case PGP_PUB_ELG_ENCRYPT:
219 res = pgp_mpi_read(pkt, &pk->pub.elg.p);
220 if (res < 0)
221 break;
222 res = pgp_mpi_read(pkt, &pk->pub.elg.g);
223 if (res < 0)
224 break;
225 res = pgp_mpi_read(pkt, &pk->pub.elg.y);
226 if (res < 0)
227 break;
229 res = calc_key_id(pk);
231 pk->can_encrypt = 1;
232 break;
234 default:
235 px_debug("unknown public algo: %d", pk->algo);
236 res = PXE_PGP_UNKNOWN_PUBALGO;
239 out:
240 if (res < 0)
241 pgp_key_free(pk);
242 else
243 *pk_p = pk;
245 return res;
248 #define HIDE_CLEAR 0
249 #define HIDE_CKSUM 255
250 #define HIDE_SHA1 254
252 static int
253 check_key_sha1(PullFilter *src, PGP_PubKey *pk)
255 int res;
256 uint8 got_sha1[20];
257 uint8 my_sha1[20];
258 PX_MD *md;
260 res = pullf_read_fixed(src, 20, got_sha1);
261 if (res < 0)
262 return res;
264 res = pgp_load_digest(PGP_DIGEST_SHA1, &md);
265 if (res < 0)
266 goto err;
267 switch (pk->algo)
269 case PGP_PUB_ELG_ENCRYPT:
270 pgp_mpi_hash(md, pk->sec.elg.x);
271 break;
272 case PGP_PUB_RSA_SIGN:
273 case PGP_PUB_RSA_ENCRYPT:
274 case PGP_PUB_RSA_ENCRYPT_SIGN:
275 pgp_mpi_hash(md, pk->sec.rsa.d);
276 pgp_mpi_hash(md, pk->sec.rsa.p);
277 pgp_mpi_hash(md, pk->sec.rsa.q);
278 pgp_mpi_hash(md, pk->sec.rsa.u);
279 break;
280 case PGP_PUB_DSA_SIGN:
281 pgp_mpi_hash(md, pk->sec.dsa.x);
282 break;
284 px_md_finish(md, my_sha1);
285 px_md_free(md);
287 if (memcmp(my_sha1, got_sha1, 20) != 0)
289 px_debug("key sha1 check failed");
290 res = PXE_PGP_KEYPKT_CORRUPT;
292 err:
293 px_memset(got_sha1, 0, 20);
294 px_memset(my_sha1, 0, 20);
295 return res;
298 static int
299 check_key_cksum(PullFilter *src, PGP_PubKey *pk)
301 int res;
302 unsigned got_cksum,
303 my_cksum = 0;
304 uint8 buf[2];
306 res = pullf_read_fixed(src, 2, buf);
307 if (res < 0)
308 return res;
310 got_cksum = ((unsigned) buf[0] << 8) + buf[1];
311 switch (pk->algo)
313 case PGP_PUB_ELG_ENCRYPT:
314 my_cksum = pgp_mpi_cksum(0, pk->sec.elg.x);
315 break;
316 case PGP_PUB_RSA_SIGN:
317 case PGP_PUB_RSA_ENCRYPT:
318 case PGP_PUB_RSA_ENCRYPT_SIGN:
319 my_cksum = pgp_mpi_cksum(0, pk->sec.rsa.d);
320 my_cksum = pgp_mpi_cksum(my_cksum, pk->sec.rsa.p);
321 my_cksum = pgp_mpi_cksum(my_cksum, pk->sec.rsa.q);
322 my_cksum = pgp_mpi_cksum(my_cksum, pk->sec.rsa.u);
323 break;
324 case PGP_PUB_DSA_SIGN:
325 my_cksum = pgp_mpi_cksum(0, pk->sec.dsa.x);
326 break;
328 if (my_cksum != got_cksum)
330 px_debug("key cksum check failed");
331 return PXE_PGP_KEYPKT_CORRUPT;
333 return 0;
336 static int
337 process_secret_key(PullFilter *pkt, PGP_PubKey **pk_p,
338 const uint8 *key, int key_len)
340 int res;
341 int hide_type;
342 int cipher_algo;
343 int bs;
344 uint8 iv[512];
345 PullFilter *pf_decrypt = NULL,
346 *pf_key;
347 PGP_CFB *cfb = NULL;
348 PGP_S2K s2k;
349 PGP_PubKey *pk;
351 /* first read public key part */
352 res = _pgp_read_public_key(pkt, &pk);
353 if (res < 0)
354 return res;
357 * is secret key encrypted?
359 GETBYTE(pkt, hide_type);
360 if (hide_type == HIDE_SHA1 || hide_type == HIDE_CKSUM)
362 if (key == NULL)
363 return PXE_PGP_NEED_SECRET_PSW;
364 GETBYTE(pkt, cipher_algo);
365 res = pgp_s2k_read(pkt, &s2k);
366 if (res < 0)
367 return res;
369 res = pgp_s2k_process(&s2k, cipher_algo, key, key_len);
370 if (res < 0)
371 return res;
373 bs = pgp_get_cipher_block_size(cipher_algo);
374 if (bs == 0)
376 px_debug("unknown cipher algo=%d", cipher_algo);
377 return PXE_PGP_UNSUPPORTED_CIPHER;
379 res = pullf_read_fixed(pkt, bs, iv);
380 if (res < 0)
381 return res;
384 * create decrypt filter
386 res = pgp_cfb_create(&cfb, cipher_algo, s2k.key, s2k.key_len, 0, iv);
387 if (res < 0)
388 return res;
389 res = pullf_create(&pf_decrypt, &pgp_decrypt_filter, cfb, pkt);
390 if (res < 0)
391 return res;
392 pf_key = pf_decrypt;
394 else if (hide_type == HIDE_CLEAR)
396 pf_key = pkt;
398 else
400 px_debug("unknown hide type");
401 return PXE_PGP_KEYPKT_CORRUPT;
404 /* read secret key */
405 switch (pk->algo)
407 case PGP_PUB_RSA_SIGN:
408 case PGP_PUB_RSA_ENCRYPT:
409 case PGP_PUB_RSA_ENCRYPT_SIGN:
410 res = pgp_mpi_read(pf_key, &pk->sec.rsa.d);
411 if (res < 0)
412 break;
413 res = pgp_mpi_read(pf_key, &pk->sec.rsa.p);
414 if (res < 0)
415 break;
416 res = pgp_mpi_read(pf_key, &pk->sec.rsa.q);
417 if (res < 0)
418 break;
419 res = pgp_mpi_read(pf_key, &pk->sec.rsa.u);
420 if (res < 0)
421 break;
422 break;
423 case PGP_PUB_ELG_ENCRYPT:
424 res = pgp_mpi_read(pf_key, &pk->sec.elg.x);
425 break;
426 case PGP_PUB_DSA_SIGN:
427 res = pgp_mpi_read(pf_key, &pk->sec.dsa.x);
428 break;
429 default:
430 px_debug("unknown public algo: %d", pk->algo);
431 res = PXE_PGP_KEYPKT_CORRUPT;
433 /* read checksum / sha1 */
434 if (res >= 0)
436 if (hide_type == HIDE_SHA1)
437 res = check_key_sha1(pf_key, pk);
438 else
439 res = check_key_cksum(pf_key, pk);
441 if (res >= 0)
442 res = pgp_expect_packet_end(pf_key);
444 if (pf_decrypt)
445 pullf_free(pf_decrypt);
446 if (cfb)
447 pgp_cfb_free(cfb);
449 if (res < 0)
450 pgp_key_free(pk);
451 else
452 *pk_p = pk;
454 return res;
457 static int
458 internal_read_key(PullFilter *src, PGP_PubKey **pk_p,
459 const uint8 *psw, int psw_len, int pubtype)
461 PullFilter *pkt = NULL;
462 int res;
463 uint8 tag;
464 int len;
465 PGP_PubKey *enc_key = NULL;
466 PGP_PubKey *pk = NULL;
467 int got_main_key = 0;
470 * Search for encryption key.
472 * Error out on anything fancy.
474 while (1)
476 res = pgp_parse_pkt_hdr(src, &tag, &len, 0);
477 if (res <= 0)
478 break;
479 res = pgp_create_pkt_reader(&pkt, src, len, res, NULL);
480 if (res < 0)
481 break;
483 switch (tag)
485 case PGP_PKT_PUBLIC_KEY:
486 case PGP_PKT_SECRET_KEY:
487 if (got_main_key)
489 res = PXE_PGP_MULTIPLE_KEYS;
490 break;
492 got_main_key = 1;
493 res = pgp_skip_packet(pkt);
494 break;
496 case PGP_PKT_PUBLIC_SUBKEY:
497 if (pubtype != 0)
498 res = PXE_PGP_EXPECT_SECRET_KEY;
499 else
500 res = _pgp_read_public_key(pkt, &pk);
501 break;
503 case PGP_PKT_SECRET_SUBKEY:
504 if (pubtype != 1)
505 res = PXE_PGP_EXPECT_PUBLIC_KEY;
506 else
507 res = process_secret_key(pkt, &pk, psw, psw_len);
508 break;
510 case PGP_PKT_SIGNATURE:
511 case PGP_PKT_MARKER:
512 case PGP_PKT_TRUST:
513 case PGP_PKT_USER_ID:
514 case PGP_PKT_USER_ATTR:
515 case PGP_PKT_PRIV_61:
516 res = pgp_skip_packet(pkt);
517 break;
518 default:
519 px_debug("unknown/unexpected packet: %d", tag);
520 res = PXE_PGP_UNEXPECTED_PKT;
522 pullf_free(pkt);
523 pkt = NULL;
525 if (pk != NULL)
527 if (res >= 0 && pk->can_encrypt)
529 if (enc_key == NULL)
531 enc_key = pk;
532 pk = NULL;
534 else
535 res = PXE_PGP_MULTIPLE_SUBKEYS;
538 if (pk)
539 pgp_key_free(pk);
540 pk = NULL;
543 if (res < 0)
544 break;
547 if (pkt)
548 pullf_free(pkt);
550 if (res < 0)
552 if (enc_key)
553 pgp_key_free(enc_key);
554 return res;
557 if (!enc_key)
558 res = PXE_PGP_NO_USABLE_KEY;
559 else
560 *pk_p = enc_key;
561 return res;
565 pgp_set_pubkey(PGP_Context *ctx, MBuf *keypkt,
566 const uint8 *key, int key_len, int pubtype)
568 int res;
569 PullFilter *src;
570 PGP_PubKey *pk = NULL;
572 res = pullf_create_mbuf_reader(&src, keypkt);
573 if (res < 0)
574 return res;
576 res = internal_read_key(src, &pk, key, key_len, pubtype);
577 pullf_free(src);
579 if (res >= 0)
580 ctx->pub_key = pk;
582 return res < 0 ? res : 0;