Make public key data structure easier to read.
[gnupg.git] / g10 / keyid.c
1 /* keyid.c - key ID and fingerprint handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2004, 2006, 2010 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <errno.h>
26 #include <time.h>
27 #include <assert.h>
28
29 #include "gpg.h"
30 #include "util.h"
31 #include "main.h"
32 #include "packet.h"
33 #include "options.h"
34 #include "keydb.h"
35 #include "i18n.h"
36 #include "rmd160.h"
37
38 #define KEYID_STR_SIZE 19
39
40
41 /* Return a letter describing the public key algorithms.  */
42 int
43 pubkey_letter( int algo )
44 {
45   switch (algo)
46     {
47     case PUBKEY_ALGO_RSA:       return 'R' ;
48     case PUBKEY_ALGO_RSA_E:     return 'r' ;
49     case PUBKEY_ALGO_RSA_S:     return 's' ;
50     case PUBKEY_ALGO_ELGAMAL_E: return 'g';
51     case PUBKEY_ALGO_ELGAMAL:   return 'G' ;
52     case PUBKEY_ALGO_DSA:       return 'D' ;
53     default: return '?';
54     }
55 }
56
57
58 /* Hash a public key.  This function is useful for v4 fingerprints and
59    for v3 or v4 key signing. */
60 void
61 hash_public_key (gcry_md_hd_t md, PKT_public_key *pk)
62 {
63   unsigned int n = 6;
64   unsigned int nn[PUBKEY_MAX_NPKEY];
65   byte *pp[PUBKEY_MAX_NPKEY];
66   int i;
67   unsigned int nbits;
68   size_t nbytes;
69   int npkey = pubkey_get_npkey (pk->pubkey_algo);
70
71   /* Two extra bytes for the expiration date in v3 */
72   if(pk->version<4)
73     n+=2;
74
75   if (npkey==0 && pk->pkey[0]
76       && gcry_mpi_get_flag (pk->pkey[0], GCRYMPI_FLAG_OPAQUE))
77     {
78       pp[0] = gcry_mpi_get_opaque (pk->pkey[0], &nbits);
79       nn[0] = (nbits+7)/8;
80       n+=nn[0];
81     }
82   else
83     {
84       for(i=0; i < npkey; i++ )
85         {
86           if (gcry_mpi_print (GCRYMPI_FMT_PGP, NULL, 0, &nbytes, pk->pkey[i]))
87             BUG ();
88           pp[i] = xmalloc (nbytes);
89           if (gcry_mpi_print (GCRYMPI_FMT_PGP, pp[i], nbytes,
90                               &nbytes, pk->pkey[i]))
91             BUG ();
92           nn[i] = nbytes;
93           n += nn[i];
94         }
95     }
96
97   gcry_md_putc ( md, 0x99 );     /* ctb */
98   /* What does it mean if n is greater than than 0xFFFF ? */
99   gcry_md_putc ( md, n >> 8 );   /* 2 byte length header */
100   gcry_md_putc ( md, n );
101   gcry_md_putc ( md, pk->version );
102
103   gcry_md_putc ( md, pk->timestamp >> 24 );
104   gcry_md_putc ( md, pk->timestamp >> 16 );
105   gcry_md_putc ( md, pk->timestamp >>  8 );
106   gcry_md_putc ( md, pk->timestamp       );
107
108   if(pk->version<4)
109     {
110       u16 days=0;
111       if(pk->expiredate)
112         days=(u16)((pk->expiredate - pk->timestamp) / 86400L);
113  
114       gcry_md_putc ( md, days >> 8 );
115       gcry_md_putc ( md, days );
116     }
117
118   gcry_md_putc ( md, pk->pubkey_algo );
119
120   if(npkey==0 && pk->pkey[0]
121      && gcry_mpi_get_flag (pk->pkey[0], GCRYMPI_FLAG_OPAQUE))
122     {
123       gcry_md_write (md, pp[0], nn[0]);
124     }
125   else
126     for(i=0; i < npkey; i++ )
127       {
128         gcry_md_write ( md, pp[i], nn[i] );
129         xfree(pp[i]);
130       }
131 }
132
133
134 static gcry_md_hd_t
135 do_fingerprint_md( PKT_public_key *pk )
136 {
137   gcry_md_hd_t md;
138
139   if (gcry_md_open (&md, DIGEST_ALGO_SHA1, 0))
140     BUG ();
141   hash_public_key(md,pk);
142   gcry_md_final( md );
143
144   return md;
145 }
146
147
148 /* fixme: Check whether we can replace this function or if not
149    describe why we need it.  */
150 u32
151 v3_keyid (gcry_mpi_t a, u32 *ki)
152 {
153   byte *buffer, *p;
154   size_t nbytes;
155
156   if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, &nbytes, a ))
157     BUG ();
158   /* fixme: allocate it on the stack */
159   buffer = xmalloc (nbytes);
160   if (gcry_mpi_print( GCRYMPI_FMT_USG, buffer, nbytes, NULL, a ))
161     BUG ();
162   if (nbytes < 8) /* oops */
163     ki[0] = ki[1] = 0;
164   else 
165     {
166       p = buffer + nbytes - 8;
167       ki[0] = (p[0] << 24) | (p[1] <<16) | (p[2] << 8) | p[3];
168       p += 4;
169       ki[1] = (p[0] << 24) | (p[1] <<16) | (p[2] << 8) | p[3];
170     }
171   xfree (buffer);
172   return ki[1];
173 }
174
175
176 size_t
177 keystrlen(void)
178 {
179   switch(opt.keyid_format)
180     {
181     case KF_SHORT:
182       return 8;
183
184     case KF_LONG:
185       return 16;
186
187     case KF_0xSHORT:
188       return 10;
189
190     case KF_0xLONG:
191       return 18;
192
193     default:
194       BUG();
195     }
196 }
197
198
199 const char *
200 keystr (u32 *keyid)
201 {  
202   static char keyid_str[KEYID_STR_SIZE];
203
204   switch (opt.keyid_format)
205     {
206     case KF_SHORT:
207       snprintf (keyid_str, sizeof keyid_str, "%08lX", (ulong)keyid[1]);
208       break;
209
210     case KF_LONG:
211       if (keyid[0])
212         snprintf (keyid_str, sizeof keyid_str, "%08lX%08lX", 
213                   (ulong)keyid[0], (ulong)keyid[1]);
214       else
215         snprintf (keyid_str, sizeof keyid_str, "%08lX", (ulong)keyid[1]);
216       break;
217
218     case KF_0xSHORT:
219       snprintf (keyid_str, sizeof keyid_str, "0x%08lX", (ulong)keyid[1]);
220       break;
221
222     case KF_0xLONG:
223       if(keyid[0])
224         snprintf (keyid_str, sizeof keyid_str, "0x%08lX%08lX", 
225                   (ulong)keyid[0],(ulong)keyid[1]);
226       else
227         snprintf (keyid_str, sizeof keyid_str, "0x%08lX", (ulong)keyid[1]);
228       break;
229       
230     default:
231       BUG();
232     }
233
234   return keyid_str;
235 }
236
237
238 const char *
239 keystr_with_sub (u32 *main_kid, u32 *sub_kid)
240 {  
241   static char buffer[KEYID_STR_SIZE+1+KEYID_STR_SIZE];
242   char *p;
243
244   mem2str (buffer, keystr (main_kid), KEYID_STR_SIZE);
245   if (sub_kid)
246     {
247       p = buffer + strlen (buffer);
248       *p++ = '/';
249       mem2str (p, keystr (sub_kid), KEYID_STR_SIZE);
250     }
251   return buffer;
252 }
253
254
255 const char *
256 keystr_from_pk(PKT_public_key *pk)
257 {
258   keyid_from_pk(pk,NULL);
259
260   return keystr(pk->keyid);
261 }
262
263
264 const char *
265 keystr_from_pk_with_sub (PKT_public_key *main_pk, PKT_public_key *sub_pk)
266 {
267   keyid_from_pk (main_pk, NULL);
268   if (sub_pk)
269     keyid_from_pk (sub_pk, NULL);
270
271   return keystr_with_sub (main_pk->keyid, sub_pk? sub_pk->keyid:NULL);
272 }
273
274
275
276 const char *
277 keystr_from_desc(KEYDB_SEARCH_DESC *desc)
278 {
279   switch(desc->mode)
280     {
281     case KEYDB_SEARCH_MODE_LONG_KID:
282     case KEYDB_SEARCH_MODE_SHORT_KID:
283       return keystr(desc->u.kid);
284
285     case KEYDB_SEARCH_MODE_FPR20:
286       {
287         u32 keyid[2];
288
289         keyid[0] = ((unsigned char)desc->u.fpr[12] << 24
290                     | (unsigned char)desc->u.fpr[13] << 16
291                     | (unsigned char)desc->u.fpr[14] << 8
292                     | (unsigned char)desc->u.fpr[15]);
293         keyid[1] = ((unsigned char)desc->u.fpr[16] << 24
294                     | (unsigned char)desc->u.fpr[17] << 16
295                     | (unsigned char)desc->u.fpr[18] << 8
296                     | (unsigned char)desc->u.fpr[19]);
297
298         return keystr(keyid);
299       }
300
301     case KEYDB_SEARCH_MODE_FPR16:
302       return "?v3 fpr?";
303
304     default:
305       BUG();
306     }
307 }
308
309
310 /*
311  * Get the keyid from the public key and put it into keyid
312  * if this is not NULL. Return the 32 low bits of the keyid.
313  */
314 u32
315 keyid_from_pk (PKT_public_key *pk, u32 *keyid)
316 {
317   u32 lowbits;
318   u32 dummy_keyid[2];
319
320   if (!keyid)
321     keyid = dummy_keyid;
322
323   if( pk->keyid[0] || pk->keyid[1] )
324     {
325       keyid[0] = pk->keyid[0];
326       keyid[1] = pk->keyid[1];
327       lowbits = keyid[1];
328     }
329   else if( pk->version < 4 )
330     {
331       if( is_RSA(pk->pubkey_algo) )
332         {
333           lowbits = (pubkey_get_npkey (pk->pubkey_algo) ?
334                      v3_keyid ( pk->pkey[0], keyid ) : 0); /* From n. */
335           pk->keyid[0] = keyid[0];
336           pk->keyid[1] = keyid[1];
337         }
338       else
339         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0xFFFFFFFF;
340     }
341   else
342     {
343       const byte *dp;
344       gcry_md_hd_t md;
345
346       md = do_fingerprint_md(pk);
347       if(md)
348         {
349           dp = gcry_md_read ( md, 0 );
350           keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
351           keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
352           lowbits = keyid[1];
353           gcry_md_close (md);
354           pk->keyid[0] = keyid[0];
355           pk->keyid[1] = keyid[1];
356         }
357       else
358         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0xFFFFFFFF;
359     }
360
361   return lowbits;
362 }
363
364
365 /*
366  * Get the keyid from the fingerprint.  This function is simple for most
367  * keys, but has to do a keylookup for old stayle keys.
368  */
369 u32
370 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid )
371 {
372   u32 dummy_keyid[2];
373
374   if( !keyid )
375     keyid = dummy_keyid;
376
377   if (fprint_len != 20)
378     {
379       /* This is special as we have to lookup the key first.  */
380       PKT_public_key pk;
381       int rc;
382
383       memset (&pk, 0, sizeof pk);
384       rc = get_pubkey_byfprint (&pk, fprint, fprint_len);
385       if( rc )
386         {
387           log_error("Oops: keyid_from_fingerprint: no pubkey\n");
388           keyid[0] = 0;
389           keyid[1] = 0;
390         }
391       else
392         keyid_from_pk (&pk, keyid);
393     }
394   else 
395     {
396       const byte *dp = fprint;
397       keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
398       keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
399     }
400
401   return keyid[1];
402 }
403
404
405 u32
406 keyid_from_sig (PKT_signature *sig, u32 *keyid)
407 {
408   if( keyid ) 
409     {
410       keyid[0] = sig->keyid[0];
411       keyid[1] = sig->keyid[1];
412     }
413   return sig->keyid[1];
414 }
415
416
417 byte *
418 namehash_from_uid (PKT_user_id *uid)
419 {
420   if (!uid->namehash)
421     {
422       uid->namehash = xmalloc (20);
423       
424       if (uid->attrib_data)
425         rmd160_hash_buffer (uid->namehash, uid->attrib_data, uid->attrib_len);
426       else
427         rmd160_hash_buffer (uid->namehash, uid->name, uid->len);
428     }
429   
430   return uid->namehash;
431 }
432
433
434 /*
435  * Return the number of bits used in PK.
436  */
437 unsigned int
438 nbits_from_pk (PKT_public_key *pk)
439 {
440     return pubkey_nbits (pk->pubkey_algo, pk->pkey);
441 }
442
443
444 static const char *
445 mk_datestr (char *buffer, time_t atime)
446 {
447   struct tm *tp;
448
449   /* Note: VMS uses an unsigned time_t thus the compiler yields a
450      warning here.  You may ignore this warning or def out this test
451      for VMS.  The proper way to handle this would be a configure test
452      to a detect properly implemented unsigned time_t.  */
453   if ( atime < 0 ) /* 32 bit time_t and after 2038-01-19 */
454     strcpy (buffer, "????" "-??" "-??"); /* mark this as invalid */
455   else 
456     {
457       tp = gmtime (&atime);
458       sprintf (buffer,"%04d-%02d-%02d",
459                1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
460     }
461   return buffer;
462 }
463
464
465 /*
466  * return a string with the creation date of the pk
467  * Note: this is alloced in a static buffer.
468  *    Format is: yyyy-mm-dd
469  */
470 const char *
471 datestr_from_pk (PKT_public_key *pk)
472 {
473   static char buffer[11+5];
474   time_t atime = pk->timestamp;
475   
476   return mk_datestr (buffer, atime);
477 }
478
479
480 const char *
481 datestr_from_sig (PKT_signature *sig )
482 {
483   static char buffer[11+5];
484   time_t atime = sig->timestamp;
485
486   return mk_datestr (buffer, atime);
487 }
488
489
490 const char *
491 expirestr_from_pk (PKT_public_key *pk)
492 {
493   static char buffer[11+5];
494   time_t atime;
495
496   if (!pk->expiredate)
497     return _("never     ");
498   atime = pk->expiredate;
499   return mk_datestr (buffer, atime);
500 }
501
502
503 const char *
504 expirestr_from_sig (PKT_signature *sig)
505 {
506   static char buffer[11+5];
507   time_t atime;
508   
509   if (!sig->expiredate)
510     return _("never     ");
511   atime=sig->expiredate;
512   return mk_datestr (buffer, atime);
513 }
514
515
516 const char *
517 revokestr_from_pk( PKT_public_key *pk )
518 {
519   static char buffer[11+5];
520   time_t atime;
521
522   if(!pk->revoked.date)
523     return _("never     ");
524   atime=pk->revoked.date;
525   return mk_datestr (buffer, atime);
526 }
527
528
529 const char *
530 usagestr_from_pk( PKT_public_key *pk )
531 {
532   static char buffer[10];
533   int i = 0;
534   unsigned int use = pk->pubkey_usage;
535
536   if ( use & PUBKEY_USAGE_SIG )
537     buffer[i++] = 'S';
538
539   if ( use & PUBKEY_USAGE_CERT )
540     buffer[i++] = 'C';
541
542   if ( use & PUBKEY_USAGE_ENC )
543     buffer[i++] = 'E';
544
545   if ( (use & PUBKEY_USAGE_AUTH) )
546     buffer[i++] = 'A';
547
548   while (i < 4)
549     buffer[i++] = ' ';
550
551   buffer[i] = 0;
552   return buffer;
553 }
554
555
556 const char *
557 colon_strtime (u32 t)
558 {
559   static char buf[20];
560
561   if (!t)
562     return "";
563   snprintf (buf, sizeof buf, "%lu", (ulong)t);
564   return buf;
565 }
566
567 const char *
568 colon_datestr_from_pk (PKT_public_key *pk)
569 {
570   static char buf[20];
571
572   snprintf (buf, sizeof buf, "%lu", (ulong)pk->timestamp);
573   return buf;
574 }
575
576
577 const char *
578 colon_datestr_from_sig (PKT_signature *sig)
579 {
580   static char buf[20];
581   
582   snprintf (buf, sizeof buf, "%lu", (ulong)sig->timestamp);
583   return buf;
584 }
585
586 const char *
587 colon_expirestr_from_sig (PKT_signature *sig)
588 {
589   static char buf[20];
590
591   if (!sig->expiredate)
592     return "";
593
594   snprintf (buf, sizeof buf,"%lu", (ulong)sig->expiredate);
595   return buf;
596 }
597
598
599 /*
600  * Return a byte array with the fingerprint for the given PK/SK
601  * The length of the array is returned in ret_len. Caller must free
602  * the array or provide an array of length MAX_FINGERPRINT_LEN.
603  */
604 byte *
605 fingerprint_from_pk (PKT_public_key *pk, byte *array, size_t *ret_len)
606 {
607   byte *buf;
608   const byte *dp;
609   size_t len, nbytes;
610   int i;
611   
612   if ( pk->version < 4 )
613     {
614       if ( is_RSA(pk->pubkey_algo) )
615         {
616           /* RSA in version 3 packets is special. */
617           gcry_md_hd_t md;
618           
619           if (gcry_md_open (&md, DIGEST_ALGO_MD5, 0))
620             BUG ();
621           if ( pubkey_get_npkey (pk->pubkey_algo) > 1 ) 
622             {
623               for (i=0; i < 2; i++)
624                 {
625                   if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, 
626                                       &nbytes, pk->pkey[i]))
627                     BUG ();
628                   /* fixme: Better allocate BUF on the stack */
629                   buf = xmalloc (nbytes);
630                   if (gcry_mpi_print (GCRYMPI_FMT_USG, buf, nbytes,
631                                       NULL, pk->pkey[i]))
632                     BUG ();
633                   gcry_md_write (md, buf, nbytes);
634                   xfree (buf);
635                 }
636             }
637           gcry_md_final (md);
638           if (!array)
639             array = xmalloc (16);
640           len = 16;
641           memcpy (array, gcry_md_read (md, DIGEST_ALGO_MD5), 16);
642           gcry_md_close(md);
643         }
644       else
645         {
646           if (!array)
647             array = xmalloc(16);
648           len = 16;
649           memset (array,0,16);
650         }
651     }
652   else 
653     {
654       gcry_md_hd_t md;
655       
656       md = do_fingerprint_md(pk);
657       dp = gcry_md_read( md, 0 );
658       len = gcry_md_get_algo_dlen (gcry_md_get_algo (md));
659       assert( len <= MAX_FINGERPRINT_LEN );
660       if (!array)
661         array = xmalloc ( len );
662       memcpy (array, dp, len );
663       pk->keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
664       pk->keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
665       gcry_md_close( md);
666     }
667   
668   *ret_len = len;
669   return array;
670 }
671
672
673
674
675 \f
676 /* Return the so called KEYGRIP which is the SHA-1 hash of the public
677    key parameters expressed as an canoncial encoded S-Exp.  ARRAY must
678    be 20 bytes long.  Returns 0 on sucess or an error code.  */
679 gpg_error_t
680 keygrip_from_pk (PKT_public_key *pk, unsigned char *array)
681 {
682   gpg_error_t err;
683   gcry_sexp_t s_pkey;
684   
685   if (DBG_PACKET)
686     log_debug ("get_keygrip for public key\n");
687
688   switch (pk->pubkey_algo)
689     {
690     case GCRY_PK_DSA:
691       err = gcry_sexp_build (&s_pkey, NULL,
692                              "(public-key(dsa(p%m)(q%m)(g%m)(y%m)))",
693                              pk->pkey[0], pk->pkey[1],
694                              pk->pkey[2], pk->pkey[3]);
695       break;
696
697     case GCRY_PK_ELG:
698     case GCRY_PK_ELG_E:
699       err = gcry_sexp_build (&s_pkey, NULL,
700                              "(public-key(elg(p%m)(g%m)(y%m)))",
701                              pk->pkey[0], pk->pkey[1], pk->pkey[2]);
702       break;
703
704     case GCRY_PK_RSA:
705     case GCRY_PK_RSA_S:
706     case GCRY_PK_RSA_E:
707       err = gcry_sexp_build (&s_pkey, NULL,
708                              "(public-key(rsa(n%m)(e%m)))",
709                              pk->pkey[0], pk->pkey[1]);
710       break;
711
712     default:
713       err = gpg_error (GPG_ERR_PUBKEY_ALGO);
714       break;
715     }
716   
717   if (err)
718     return err;
719
720   if (!gcry_pk_get_keygrip (s_pkey, array))
721     {
722       log_error ("error computing keygrip\n");
723       err = gpg_error (GPG_ERR_GENERAL);
724     }
725   else
726     {
727       if (DBG_PACKET)
728         log_printhex ("keygrip=", array, 20);
729       /* FIXME: Save the keygrip in PK.  */
730     }
731   gcry_sexp_release (s_pkey);
732   
733   return 0;
734 }
735
736
737 /* Store an allocated buffer with the keygrip of PK encoded as a
738    hexstring at r_GRIP.  Returns 0 on success.  */
739 gpg_error_t
740 hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip)
741 {
742   gpg_error_t err;
743   unsigned char grip[20];
744
745   *r_grip = NULL;
746   err = keygrip_from_pk (pk, grip);
747   if (!err)
748     {
749       char * buf = xtrymalloc (20*2+1);
750       if (!buf)
751         err = gpg_error_from_syserror ();
752       else
753         {
754           bin2hex (grip, 20, buf);
755           *r_grip = buf;
756         }
757     }
758   return err;
759 }
760