Integrating http://code.google.com/p/gnupg-ecc/source/detail?r=15 .
[gnupg.git] / kbx / keybox-openpgp.c
1 /* keybox-openpgp.c - OpenPGP key parsing
2  *      Copyright (C) 2001, 2003 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 /* This is a simple OpenPGP parser suitable for all OpenPGP key
21    material.  It just provides the functionality required to build and
22    parse an KBX OpenPGP key blob.  Thus it is not a complete parser.
23    However it is self-contained and optimized for fast in-memory
24    parsing.  Note that we don't support old ElGamal v3 keys
25    anymore. */
26
27 #include <config.h>
28 #include <stdlib.h>
29 #include <stdio.h>
30 #include <string.h>
31 #include <errno.h>
32 #include <assert.h>
33
34 #include "keybox-defs.h"
35
36 #include <gcrypt.h>
37
38
39 enum packet_types
40   {
41     PKT_NONE               =0,
42     PKT_PUBKEY_ENC         =1, /* public key encrypted packet */
43     PKT_SIGNATURE          =2, /* secret key encrypted packet */
44     PKT_SYMKEY_ENC         =3, /* session key packet (OpenPGP)*/
45     PKT_ONEPASS_SIG        =4, /* one pass sig packet (OpenPGP)*/
46     PKT_SECRET_KEY         =5, /* secret key */
47     PKT_PUBLIC_KEY         =6, /* public key */
48     PKT_SECRET_SUBKEY      =7, /* secret subkey (OpenPGP) */
49     PKT_COMPRESSED         =8, /* compressed data packet */
50     PKT_ENCRYPTED          =9, /* conventional encrypted data */
51     PKT_MARKER            =10, /* marker packet (OpenPGP) */
52     PKT_PLAINTEXT         =11, /* plaintext data with filename and mode */
53     PKT_RING_TRUST        =12, /* keyring trust packet */
54     PKT_USER_ID           =13, /* user id packet */
55     PKT_PUBLIC_SUBKEY     =14, /* public subkey (OpenPGP) */
56     PKT_OLD_COMMENT       =16, /* comment packet from an OpenPGP draft */
57     PKT_ATTRIBUTE         =17, /* PGP's attribute packet */
58     PKT_ENCRYPTED_MDC     =18, /* integrity protected encrypted data */
59     PKT_MDC               =19, /* manipulation detection code packet */
60     PKT_COMMENT           =61, /* new comment packet (private) */
61     PKT_GPG_CONTROL       =63  /* internal control packet */
62   };
63
64
65
66 /* Assume a valid OpenPGP packet at the address pointed to by BUFBTR
67    which is of amaximum length as stored at BUFLEN.  Return the header
68    information of that packet and advance the pointer stored at BUFPTR
69    to the next packet; also adjust the length stored at BUFLEN to
70    match the remaining bytes. If there are no more packets, store NULL
71    at BUFPTR.  Return an non-zero error code on failure or the
72    follwing data on success:
73
74    R_DATAPKT = Pointer to the begin of the packet data.
75    R_DATALEN = Length of this data.  This has already been checked to fit 
76                into the buffer. 
77    R_PKTTYPE = The packet type.
78    R_NTOTAL  = The total number of bytes of this packet
79
80    Note that these values are only updated on success.
81 */
82 static gpg_error_t
83 next_packet (unsigned char const **bufptr, size_t *buflen,
84              unsigned char const **r_data, size_t *r_datalen, int *r_pkttype,
85              size_t *r_ntotal)
86 {
87   const unsigned char *buf = *bufptr;
88   size_t len = *buflen;
89   int c, ctb, pkttype;
90   unsigned long pktlen;
91
92   if (!len)
93     return gpg_error (GPG_ERR_NO_DATA);
94   
95   ctb = *buf++; len--;
96   if ( !(ctb & 0x80) )
97     return gpg_error (GPG_ERR_INV_PACKET); /* Invalid CTB. */
98   
99   pktlen = 0;
100   if ((ctb & 0x40))  /* New style (OpenPGP) CTB.  */
101     {
102       pkttype = (ctb & 0x3f);
103       if (!len)
104         return gpg_error (GPG_ERR_INV_PACKET); /* No 1st length byte. */
105       c = *buf++; len--;
106       if (pkttype == PKT_COMPRESSED)
107         return gpg_error (GPG_ERR_UNEXPECTED); /* ... packet in a keyblock. */
108       if ( c < 192 )
109         pktlen = c;
110       else if ( c < 224 )
111         { 
112           pktlen = (c - 192) * 256;
113           if (!len)
114             return gpg_error (GPG_ERR_INV_PACKET); /* No 2nd length byte. */
115           c = *buf++; len--;
116           pktlen += c + 192;
117         }
118       else if (c == 255)
119         {
120           if (len <4 )
121             return gpg_error (GPG_ERR_INV_PACKET); /* No length bytes. */
122           pktlen  = (*buf++) << 24;
123           pktlen |= (*buf++) << 16;
124           pktlen |= (*buf++) << 8;
125           pktlen |= (*buf++);
126           len -= 4;
127       }
128       else /* Partial length encoding is not allowed for key packets. */
129         return gpg_error (GPG_ERR_UNEXPECTED);
130     }
131   else /* Old style CTB.  */
132     {
133       int lenbytes;
134
135       pktlen = 0;
136       pkttype = (ctb>>2)&0xf;
137       lenbytes = ((ctb&3)==3)? 0 : (1<<(ctb & 3));
138       if (!lenbytes) /* Not allowed in key packets.  */
139         return gpg_error (GPG_ERR_UNEXPECTED);
140       if (len < lenbytes)
141         return gpg_error (GPG_ERR_INV_PACKET); /* Not enough length bytes.  */
142       for (; lenbytes; lenbytes--)
143         {
144           pktlen <<= 8;
145           pktlen |= *buf++; len--;
146         }
147     }
148
149   /* Do some basic sanity check.  */
150   switch (pkttype)
151     {
152     case PKT_SIGNATURE:
153     case PKT_SECRET_KEY:        
154     case PKT_PUBLIC_KEY:
155     case PKT_SECRET_SUBKEY:
156     case PKT_MARKER:
157     case PKT_RING_TRUST:
158     case PKT_USER_ID:
159     case PKT_PUBLIC_SUBKEY:
160     case PKT_OLD_COMMENT:
161     case PKT_ATTRIBUTE:
162     case PKT_COMMENT:
163     case PKT_GPG_CONTROL:
164       break; /* Okay these are allowed packets. */
165     default:
166       return gpg_error (GPG_ERR_UNEXPECTED);
167     }
168
169   if (pktlen == 0xffffffff) 
170       return gpg_error (GPG_ERR_INV_PACKET);
171   
172   if (pktlen > len)
173     return gpg_error (GPG_ERR_INV_PACKET); /* Packet length header too long. */
174
175   *r_data = buf;
176   *r_datalen = pktlen;
177   *r_pkttype = pkttype;
178   *r_ntotal = (buf - *bufptr) + pktlen;
179
180   *bufptr = buf + pktlen;
181   *buflen = len - pktlen;
182   if (!*buflen)
183     *bufptr = NULL;
184
185   return 0;
186 }
187
188
189 /* Parse a key packet and store the information in KI. */
190 static gpg_error_t
191 parse_key (const unsigned char *data, size_t datalen,
192            struct _keybox_openpgp_key_info *ki)
193 {
194   gpg_error_t err;
195   const unsigned char *data_start = data;
196   int i, version, algorithm;
197   size_t n;
198   unsigned long timestamp, expiredate;
199   int npkey;
200   unsigned char hashbuffer[768];
201   const unsigned char *mpi_n = NULL;
202   size_t mpi_n_len = 0, mpi_e_len = 0;
203   gcry_md_hd_t md;
204
205   if (datalen < 5)
206     return gpg_error (GPG_ERR_INV_PACKET);
207   version = *data++; datalen--;
208   if (version < 2 || version > 4 )
209     return gpg_error (GPG_ERR_INV_PACKET); /* Invalid version. */
210   
211   timestamp = ((data[0]<<24)|(data[1]<<16)|(data[2]<<8)|(data[3]));
212   data +=4; datalen -=4;
213
214   if (version < 4)
215     {
216       unsigned short ndays;
217       
218       if (datalen < 2)
219         return gpg_error (GPG_ERR_INV_PACKET);
220       ndays = ((data[0]<<8)|(data[1]));
221       data +=2; datalen -= 2;
222       if (ndays)
223       expiredate = ndays? (timestamp + ndays * 86400L) : 0;
224     }
225   else
226     expiredate = 0; /* This is stored in the self-signature. */
227
228   if (!datalen)
229     return gpg_error (GPG_ERR_INV_PACKET);
230   algorithm = *data++; datalen--;
231
232   switch (algorithm)
233     {
234     case 1:
235     case 2:
236     case 3: /* RSA */
237       npkey = 2; 
238       break;
239     case 16:
240     case 20: /* Elgamal */
241       npkey = 3;
242       break;
243     case 17: /* DSA */
244       npkey = 4;
245       break;
246     case 18: /* ECDH */
247       npkey = 3;
248     case 19: /* ECDSA */
249       npkey = 2;
250       break;
251     default: /* Unknown algorithm. */
252       return gpg_error (GPG_ERR_UNKNOWN_ALGORITHM);
253     }
254
255   for (i=0; i < npkey; i++ )
256     {
257       unsigned int nbits, nbytes;
258       
259       if (datalen < 2)
260         return gpg_error (GPG_ERR_INV_PACKET);
261       nbits = ((data[0]<<8)|(data[1]));
262       data += 2; datalen -=2;
263       nbytes = (nbits+7) / 8;
264       if (datalen < nbytes)
265         return gpg_error (GPG_ERR_INV_PACKET);
266       /* For use by v3 fingerprint calculation we need to know the RSA
267          modulus and exponent. */
268       if (i==0) 
269         {
270           mpi_n = data; 
271           mpi_n_len = nbytes;
272         }
273       else if (i==1)
274         mpi_e_len = nbytes;
275         
276       data += nbytes; datalen -= nbytes;
277     }
278   n = data - data_start;
279
280   if (version < 4)
281     {
282       /* We do not support any other algorithm than RSA in v3
283          packets. */
284       if (algorithm < 1 || algorithm > 3)
285         return gpg_error (GPG_ERR_UNSUPPORTED_ALGORITHM);
286
287       err = gcry_md_open (&md, GCRY_MD_MD5, 0);
288       if (err)
289         return err; /* Oops */
290       gcry_md_write (md, mpi_n, mpi_n_len);
291       gcry_md_write (md, mpi_n+mpi_n_len+2, mpi_e_len);
292       memcpy (ki->fpr, gcry_md_read (md, 0), 16);
293       gcry_md_close (md);
294       ki->fprlen = 16;
295       
296       if (mpi_n_len < 8)
297         {
298           /* Moduli less than 64 bit are out of the specs scope.  Zero
299              them out becuase this is what gpg does too. */
300           memset (ki->keyid, 0, 8); 
301         }
302       else
303         memcpy (ki->keyid, mpi_n + mpi_n_len - 8, 8);
304     }
305   else
306     {
307       /* Its a pitty that we need to prefix the buffer with the tag
308          and a length header: We can't simply pass it to the fast
309          hashing fucntion for that reason.  It might be a good idea to
310          have a scatter-gather enabled hash function. What we do here
311          is to use a static buffer if this one is large enough and
312          only use the regular hash fucntions if this buffer is not
313          large enough. */
314       if ( 3 + n < sizeof hashbuffer )
315         {
316           hashbuffer[0] = 0x99;     /* CTB */
317           hashbuffer[1] = (n >> 8); /* 2 byte length header. */
318           hashbuffer[2] = n;
319           memcpy (hashbuffer + 3, data_start, n);
320           gcry_md_hash_buffer (GCRY_MD_SHA1, ki->fpr, hashbuffer, 3 + n);
321         }
322       else
323         {
324           err = gcry_md_open (&md, GCRY_MD_SHA1, 0);
325           if (err)
326             return err; /* Oops */
327           gcry_md_putc (md, 0x99 );     /* CTB */
328           gcry_md_putc (md, (n >> 8) ); /* 2 byte length header. */
329           gcry_md_putc (md, n );
330           gcry_md_write (md, data_start, n);
331           memcpy (ki->fpr, gcry_md_read (md, 0), 20);
332           gcry_md_close (md);
333         }
334       ki->fprlen = 20;
335       memcpy (ki->keyid, ki->fpr+12, 8);
336     }
337
338   return 0;
339 }
340
341
342
343 /* The caller must pass the address of an INFO structure which will
344    get filled on success with information pertaining to the OpenPGP
345    keyblock IMAGE of length IMAGELEN.  Note that a caller does only
346    need to release this INFO structure when the function returns
347    success.  If NPARSED is not NULL the actual number of bytes parsed
348    will be stored at this address.  */
349 gpg_error_t
350 _keybox_parse_openpgp (const unsigned char *image, size_t imagelen,
351                        size_t *nparsed,
352                        keybox_openpgp_info_t info)
353 {
354   gpg_error_t err = 0;
355   const unsigned char *image_start, *data;
356   size_t n, datalen;
357   int pkttype;
358   int first = 1;
359   struct _keybox_openpgp_key_info *k, **ktail = NULL;
360   struct _keybox_openpgp_uid_info *u, **utail = NULL;
361   
362   memset (info, 0, sizeof *info);
363   if (nparsed)
364     *nparsed = 0;
365
366   image_start = image;
367   while (image)
368     {
369       err = next_packet (&image, &imagelen, &data, &datalen, &pkttype, &n);
370       if (err)
371         break;
372
373       if (first)
374         {
375           if (pkttype == PKT_PUBLIC_KEY)
376             ;
377           else if (pkttype == PKT_SECRET_KEY)
378             info->is_secret = 1;
379           else
380             {
381               err = gpg_error (GPG_ERR_UNEXPECTED);
382               break;
383             }
384           first = 0;
385         }
386       else if (pkttype == PKT_PUBLIC_KEY || pkttype == PKT_SECRET_KEY)
387         break; /* Next keyblock encountered - ready. */
388       
389       if (nparsed)
390         *nparsed += n;
391
392       if (pkttype == PKT_SIGNATURE)
393         {
394           /* For now we only count the total number of signatures. */
395           info->nsigs++;
396         }
397       else if (pkttype == PKT_USER_ID)
398         {
399           info->nuids++;
400           if (info->nuids == 1)
401             {
402               info->uids.off = data - image_start;
403               info->uids.len = datalen;
404               utail = &info->uids.next;
405             }
406           else
407             {
408               u = xtrycalloc (1, sizeof *u);
409               if (!u)
410                 {
411                   err = gpg_error_from_syserror ();
412                   break;
413                 }
414               u->off = data - image_start;
415               u->len = datalen;
416               *utail = u;
417               utail = &u->next;
418             }
419         }
420       else if (pkttype == PKT_PUBLIC_KEY || pkttype == PKT_SECRET_KEY)
421         {
422           err = parse_key (data, datalen, &info->primary);
423           if (err)
424             break;
425         }
426       else if( pkttype == PKT_PUBLIC_SUBKEY && datalen && *data == '#' ) 
427         {
428           /* Early versions of GnuPG used old PGP comment packets;
429            * luckily all those comments are prefixed by a hash
430            * sign - ignore these packets. */
431         }
432       else if (pkttype == PKT_PUBLIC_SUBKEY || pkttype == PKT_SECRET_SUBKEY)
433         {
434           info->nsubkeys++;
435           if (info->nsubkeys == 1)
436             {
437               err = parse_key (data, datalen, &info->subkeys);
438               if (err)
439                 {
440                   info->nsubkeys--;
441                   if (gpg_err_code (err) != GPG_ERR_UNKNOWN_ALGORITHM)
442                     break;
443                   /* We ignore subkeys with unknown algorithms. */
444                 }
445               else
446                 ktail = &info->subkeys.next;
447             }
448           else
449             {
450               k = xtrycalloc (1, sizeof *k);
451               if (!k)
452                 {
453                   err = gpg_error_from_syserror ();
454                   break;
455                 }
456               err = parse_key (data, datalen, k);
457               if (err)
458                 {
459                   xfree (k);
460                   info->nsubkeys--;
461                   if (gpg_err_code (err) != GPG_ERR_UNKNOWN_ALGORITHM)
462                     break;
463                   /* We ignore subkeys with unknown algorithms. */
464                 }
465               else
466                 {
467                   *ktail = k;
468                   ktail = &k->next;
469                 }
470             }
471         }
472     }
473
474   if (err)
475     {
476       _keybox_destroy_openpgp_info (info);
477       if (!first
478           && (gpg_err_code (err) == GPG_ERR_UNSUPPORTED_ALGORITHM
479               || gpg_err_code (err) == GPG_ERR_UNKNOWN_ALGORITHM))
480         {
481           /* We are able to skip to the end of this keyblock. */
482           while (image)
483             {
484               if (next_packet (&image, &imagelen,
485                                &data, &datalen, &pkttype, &n) )
486                 break; /* Another error - stop here. */
487
488               if (pkttype == PKT_PUBLIC_KEY || pkttype == PKT_SECRET_KEY)
489                 break; /* Next keyblock encountered - ready. */
490               
491               if (nparsed)
492                 *nparsed += n;
493             }
494         }
495     }
496
497   return err;
498 }
499
500
501 /* Release any malloced data in INFO but not INFO itself! */
502 void
503 _keybox_destroy_openpgp_info (keybox_openpgp_info_t info)
504 {
505   struct _keybox_openpgp_key_info *k, *k2;
506   struct _keybox_openpgp_uid_info *u, *u2;
507
508   assert (!info->primary.next);
509   for (k=info->subkeys.next; k; k = k2)
510     {
511       k2 = k->next;
512       xfree (k);
513     }
514
515   for (u=info->uids.next; u; u = u2)
516     {
517       u2 = u->next;
518       xfree (u);
519     }
520 }