Update French translation
[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 ionformation 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;*/
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       if (datalen < 2)
217         return gpg_error (GPG_ERR_INV_PACKET);
218       data += 2; datalen -= 2;
219     }
220
221   if (!datalen)
222     return gpg_error (GPG_ERR_INV_PACKET);
223   algorithm = *data++; datalen--;
224
225   switch (algorithm)
226     {
227     case 1:
228     case 2:
229     case 3: /* RSA */
230       npkey = 2;
231       break;
232     case 16:
233     case 20: /* Elgamal */
234       npkey = 3;
235       break;
236     case 17: /* DSA */
237       npkey = 4;
238       break;
239     default: /* Unknown algorithm. */
240       return gpg_error (GPG_ERR_UNKNOWN_ALGORITHM);
241     }
242
243   for (i=0; i < npkey; i++ )
244     {
245       unsigned int nbits, nbytes;
246
247       if (datalen < 2)
248         return gpg_error (GPG_ERR_INV_PACKET);
249       nbits = ((data[0]<<8)|(data[1]));
250       data += 2; datalen -=2;
251       nbytes = (nbits+7) / 8;
252       if (datalen < nbytes)
253         return gpg_error (GPG_ERR_INV_PACKET);
254       /* For use by v3 fingerprint calculation we need to know the RSA
255          modulus and exponent. */
256       if (i==0)
257         {
258           mpi_n = data;
259           mpi_n_len = nbytes;
260         }
261       else if (i==1)
262         mpi_e_len = nbytes;
263
264       data += nbytes; datalen -= nbytes;
265     }
266   n = data - data_start;
267
268   if (version < 4)
269     {
270       /* We do not support any other algorithm than RSA in v3
271          packets. */
272       if (algorithm < 1 || algorithm > 3)
273         return gpg_error (GPG_ERR_UNSUPPORTED_ALGORITHM);
274
275       err = gcry_md_open (&md, GCRY_MD_MD5, 0);
276       if (err)
277         return err; /* Oops */
278       gcry_md_write (md, mpi_n, mpi_n_len);
279       gcry_md_write (md, mpi_n+mpi_n_len+2, mpi_e_len);
280       memcpy (ki->fpr, gcry_md_read (md, 0), 16);
281       gcry_md_close (md);
282       ki->fprlen = 16;
283
284       if (mpi_n_len < 8)
285         {
286           /* Moduli less than 64 bit are out of the specs scope.  Zero
287              them out becuase this is what gpg does too. */
288           memset (ki->keyid, 0, 8);
289         }
290       else
291         memcpy (ki->keyid, mpi_n + mpi_n_len - 8, 8);
292     }
293   else
294     {
295       /* Its a pitty that we need to prefix the buffer with the tag
296          and a length header: We can't simply pass it to the fast
297          hashing fucntion for that reason.  It might be a good idea to
298          have a scatter-gather enabled hash function. What we do here
299          is to use a static buffer if this one is large enough and
300          only use the regular hash fucntions if this buffer is not
301          large enough. */
302       if ( 3 + n < sizeof hashbuffer )
303         {
304           hashbuffer[0] = 0x99;     /* CTB */
305           hashbuffer[1] = (n >> 8); /* 2 byte length header. */
306           hashbuffer[2] = n;
307           memcpy (hashbuffer + 3, data_start, n);
308           gcry_md_hash_buffer (GCRY_MD_SHA1, ki->fpr, hashbuffer, 3 + n);
309         }
310       else
311         {
312           err = gcry_md_open (&md, GCRY_MD_SHA1, 0);
313           if (err)
314             return err; /* Oops */
315           gcry_md_putc (md, 0x99 );     /* CTB */
316           gcry_md_putc (md, (n >> 8) ); /* 2 byte length header. */
317           gcry_md_putc (md, n );
318           gcry_md_write (md, data_start, n);
319           memcpy (ki->fpr, gcry_md_read (md, 0), 20);
320           gcry_md_close (md);
321         }
322       ki->fprlen = 20;
323       memcpy (ki->keyid, ki->fpr+12, 8);
324     }
325
326   return 0;
327 }
328
329
330
331 /* The caller must pass the address of an INFO structure which will
332    get filled on success with information pertaining to the OpenPGP
333    keyblock IMAGE of length IMAGELEN.  Note that a caller does only
334    need to release this INFO structure when the function returns
335    success.  If NPARSED is not NULL the actual number of bytes parsed
336    will be stored at this address.  */
337 gpg_error_t
338 _keybox_parse_openpgp (const unsigned char *image, size_t imagelen,
339                        size_t *nparsed,
340                        keybox_openpgp_info_t info)
341 {
342   gpg_error_t err = 0;
343   const unsigned char *image_start, *data;
344   size_t n, datalen;
345   int pkttype;
346   int first = 1;
347   struct _keybox_openpgp_key_info *k, **ktail = NULL;
348   struct _keybox_openpgp_uid_info *u, **utail = NULL;
349
350   memset (info, 0, sizeof *info);
351   if (nparsed)
352     *nparsed = 0;
353
354   image_start = image;
355   while (image)
356     {
357       err = next_packet (&image, &imagelen, &data, &datalen, &pkttype, &n);
358       if (err)
359         break;
360
361       if (first)
362         {
363           if (pkttype == PKT_PUBLIC_KEY)
364             ;
365           else if (pkttype == PKT_SECRET_KEY)
366             info->is_secret = 1;
367           else
368             {
369               err = gpg_error (GPG_ERR_UNEXPECTED);
370               break;
371             }
372           first = 0;
373         }
374       else if (pkttype == PKT_PUBLIC_KEY || pkttype == PKT_SECRET_KEY)
375         break; /* Next keyblock encountered - ready. */
376
377       if (nparsed)
378         *nparsed += n;
379
380       if (pkttype == PKT_SIGNATURE)
381         {
382           /* For now we only count the total number of signatures. */
383           info->nsigs++;
384         }
385       else if (pkttype == PKT_USER_ID)
386         {
387           info->nuids++;
388           if (info->nuids == 1)
389             {
390               info->uids.off = data - image_start;
391               info->uids.len = datalen;
392               utail = &info->uids.next;
393             }
394           else
395             {
396               u = xtrycalloc (1, sizeof *u);
397               if (!u)
398                 {
399                   err = gpg_error_from_syserror ();
400                   break;
401                 }
402               u->off = data - image_start;
403               u->len = datalen;
404               *utail = u;
405               utail = &u->next;
406             }
407         }
408       else if (pkttype == PKT_PUBLIC_KEY || pkttype == PKT_SECRET_KEY)
409         {
410           err = parse_key (data, datalen, &info->primary);
411           if (err)
412             break;
413         }
414       else if( pkttype == PKT_PUBLIC_SUBKEY && datalen && *data == '#' )
415         {
416           /* Early versions of GnuPG used old PGP comment packets;
417            * luckily all those comments are prefixed by a hash
418            * sign - ignore these packets. */
419         }
420       else if (pkttype == PKT_PUBLIC_SUBKEY || pkttype == PKT_SECRET_SUBKEY)
421         {
422           info->nsubkeys++;
423           if (info->nsubkeys == 1)
424             {
425               err = parse_key (data, datalen, &info->subkeys);
426               if (err)
427                 {
428                   info->nsubkeys--;
429                   if (gpg_err_code (err) != GPG_ERR_UNKNOWN_ALGORITHM)
430                     break;
431                   /* We ignore subkeys with unknown algorithms. */
432                 }
433               else
434                 ktail = &info->subkeys.next;
435             }
436           else
437             {
438               k = xtrycalloc (1, sizeof *k);
439               if (!k)
440                 {
441                   err = gpg_error_from_syserror ();
442                   break;
443                 }
444               err = parse_key (data, datalen, k);
445               if (err)
446                 {
447                   xfree (k);
448                   info->nsubkeys--;
449                   if (gpg_err_code (err) != GPG_ERR_UNKNOWN_ALGORITHM)
450                     break;
451                   /* We ignore subkeys with unknown algorithms. */
452                 }
453               else
454                 {
455                   *ktail = k;
456                   ktail = &k->next;
457                 }
458             }
459         }
460     }
461
462   if (err)
463     {
464       _keybox_destroy_openpgp_info (info);
465       if (!first
466           && (gpg_err_code (err) == GPG_ERR_UNSUPPORTED_ALGORITHM
467               || gpg_err_code (err) == GPG_ERR_UNKNOWN_ALGORITHM))
468         {
469           /* We are able to skip to the end of this keyblock. */
470           while (image)
471             {
472               if (next_packet (&image, &imagelen,
473                                &data, &datalen, &pkttype, &n) )
474                 break; /* Another error - stop here. */
475
476               if (pkttype == PKT_PUBLIC_KEY || pkttype == PKT_SECRET_KEY)
477                 break; /* Next keyblock encountered - ready. */
478
479               if (nparsed)
480                 *nparsed += n;
481             }
482         }
483     }
484
485   return err;
486 }
487
488
489 /* Release any malloced data in INFO but not INFO itself! */
490 void
491 _keybox_destroy_openpgp_info (keybox_openpgp_info_t info)
492 {
493   struct _keybox_openpgp_key_info *k, *k2;
494   struct _keybox_openpgp_uid_info *u, *u2;
495
496   assert (!info->primary.next);
497   for (k=info->subkeys.next; k; k = k2)
498     {
499       k2 = k->next;
500       xfree (k);
501     }
502
503   for (u=info->uids.next; u; u = u2)
504     {
505       u2 = u->next;
506       xfree (u);
507     }
508 }