Removed more secret key related code.
[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   p = buffer + strlen (buffer);
246   *p++ = '/';
247   mem2str (p, keystr (sub_kid), KEYID_STR_SIZE);
248   return buffer;
249 }
250
251
252 const char *
253 keystr_from_pk(PKT_public_key *pk)
254 {
255   keyid_from_pk(pk,NULL);
256
257   return keystr(pk->keyid);
258 }
259
260
261 const char *
262 keystr_from_pk_with_sub (PKT_public_key *main_pk, PKT_public_key *sub_pk)
263 {
264   keyid_from_pk (main_pk, NULL);
265   keyid_from_pk (sub_pk, NULL);
266
267   return keystr_with_sub (main_pk->keyid, sub_pk->keyid);
268 }
269
270
271
272 const char *
273 keystr_from_desc(KEYDB_SEARCH_DESC *desc)
274 {
275   switch(desc->mode)
276     {
277     case KEYDB_SEARCH_MODE_LONG_KID:
278     case KEYDB_SEARCH_MODE_SHORT_KID:
279       return keystr(desc->u.kid);
280
281     case KEYDB_SEARCH_MODE_FPR20:
282       {
283         u32 keyid[2];
284
285         keyid[0] = ((unsigned char)desc->u.fpr[12] << 24
286                     | (unsigned char)desc->u.fpr[13] << 16
287                     | (unsigned char)desc->u.fpr[14] << 8
288                     | (unsigned char)desc->u.fpr[15]);
289         keyid[1] = ((unsigned char)desc->u.fpr[16] << 24
290                     | (unsigned char)desc->u.fpr[17] << 16
291                     | (unsigned char)desc->u.fpr[18] << 8
292                     | (unsigned char)desc->u.fpr[19]);
293
294         return keystr(keyid);
295       }
296
297     case KEYDB_SEARCH_MODE_FPR16:
298       return "?v3 fpr?";
299
300     default:
301       BUG();
302     }
303 }
304
305
306 /*
307  * Get the keyid from the public key and put it into keyid
308  * if this is not NULL. Return the 32 low bits of the keyid.
309  */
310 u32
311 keyid_from_pk (PKT_public_key *pk, u32 *keyid)
312 {
313   u32 lowbits;
314   u32 dummy_keyid[2];
315
316   if (!keyid)
317     keyid = dummy_keyid;
318
319   if( pk->keyid[0] || pk->keyid[1] )
320     {
321       keyid[0] = pk->keyid[0];
322       keyid[1] = pk->keyid[1];
323       lowbits = keyid[1];
324     }
325   else if( pk->version < 4 )
326     {
327       if( is_RSA(pk->pubkey_algo) )
328         {
329           lowbits = (pubkey_get_npkey (pk->pubkey_algo) ?
330                      v3_keyid ( pk->pkey[0], keyid ) : 0); /* From n. */
331           pk->keyid[0] = keyid[0];
332           pk->keyid[1] = keyid[1];
333         }
334       else
335         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0xFFFFFFFF;
336     }
337   else
338     {
339       const byte *dp;
340       gcry_md_hd_t md;
341
342       md = do_fingerprint_md(pk);
343       if(md)
344         {
345           dp = gcry_md_read ( md, 0 );
346           keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
347           keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
348           lowbits = keyid[1];
349           gcry_md_close (md);
350           pk->keyid[0] = keyid[0];
351           pk->keyid[1] = keyid[1];
352         }
353       else
354         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0xFFFFFFFF;
355     }
356
357   return lowbits;
358 }
359
360
361 /*
362  * Get the keyid from the fingerprint.  This function is simple for most
363  * keys, but has to do a keylookup for old stayle keys.
364  */
365 u32
366 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid )
367 {
368   u32 dummy_keyid[2];
369
370   if( !keyid )
371     keyid = dummy_keyid;
372
373   if (fprint_len != 20)
374     {
375       /* This is special as we have to lookup the key first.  */
376       PKT_public_key pk;
377       int rc;
378
379       memset (&pk, 0, sizeof pk);
380       rc = get_pubkey_byfprint (&pk, fprint, fprint_len);
381       if( rc )
382         {
383           log_error("Oops: keyid_from_fingerprint: no pubkey\n");
384           keyid[0] = 0;
385           keyid[1] = 0;
386         }
387       else
388         keyid_from_pk (&pk, keyid);
389     }
390   else 
391     {
392       const byte *dp = fprint;
393       keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
394       keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
395     }
396
397   return keyid[1];
398 }
399
400
401 u32
402 keyid_from_sig (PKT_signature *sig, u32 *keyid)
403 {
404   if( keyid ) 
405     {
406       keyid[0] = sig->keyid[0];
407       keyid[1] = sig->keyid[1];
408     }
409   return sig->keyid[1];
410 }
411
412
413 byte *
414 namehash_from_uid (PKT_user_id *uid)
415 {
416   if (!uid->namehash)
417     {
418       uid->namehash = xmalloc (20);
419       
420       if (uid->attrib_data)
421         rmd160_hash_buffer (uid->namehash, uid->attrib_data, uid->attrib_len);
422       else
423         rmd160_hash_buffer (uid->namehash, uid->name, uid->len);
424     }
425   
426   return uid->namehash;
427 }
428
429
430 /*
431  * Return the number of bits used in PK.
432  */
433 unsigned int
434 nbits_from_pk (PKT_public_key *pk)
435 {
436     return pubkey_nbits (pk->pubkey_algo, pk->pkey);
437 }
438
439
440 static const char *
441 mk_datestr (char *buffer, time_t atime)
442 {
443   struct tm *tp;
444
445   if ( atime < 0 ) /* 32 bit time_t and after 2038-01-19 */
446     strcpy (buffer, "????" "-??" "-??"); /* mark this as invalid */
447   else 
448     {
449       tp = gmtime (&atime);
450       sprintf (buffer,"%04d-%02d-%02d",
451                1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
452     }
453   return buffer;
454 }
455
456
457 /*
458  * return a string with the creation date of the pk
459  * Note: this is alloced in a static buffer.
460  *    Format is: yyyy-mm-dd
461  */
462 const char *
463 datestr_from_pk (PKT_public_key *pk)
464 {
465   static char buffer[11+5];
466   time_t atime = pk->timestamp;
467   
468   return mk_datestr (buffer, atime);
469 }
470
471
472 const char *
473 datestr_from_sig (PKT_signature *sig )
474 {
475   static char buffer[11+5];
476   time_t atime = sig->timestamp;
477
478   return mk_datestr (buffer, atime);
479 }
480
481
482 const char *
483 expirestr_from_pk (PKT_public_key *pk)
484 {
485   static char buffer[11+5];
486   time_t atime;
487
488   if (!pk->expiredate)
489     return _("never     ");
490   atime = pk->expiredate;
491   return mk_datestr (buffer, atime);
492 }
493
494
495 const char *
496 expirestr_from_sig (PKT_signature *sig)
497 {
498   static char buffer[11+5];
499   time_t atime;
500   
501   if (!sig->expiredate)
502     return _("never     ");
503   atime=sig->expiredate;
504   return mk_datestr (buffer, atime);
505 }
506
507
508 const char *
509 revokestr_from_pk( PKT_public_key *pk )
510 {
511   static char buffer[11+5];
512   time_t atime;
513
514   if(!pk->revoked.date)
515     return _("never     ");
516   atime=pk->revoked.date;
517   return mk_datestr (buffer, atime);
518 }
519
520
521 const char *
522 usagestr_from_pk( PKT_public_key *pk )
523 {
524   static char buffer[10];
525   int i = 0;
526   unsigned int use = pk->pubkey_usage;
527
528   if ( use & PUBKEY_USAGE_SIG )
529     buffer[i++] = 'S';
530
531   if ( use & PUBKEY_USAGE_CERT )
532     buffer[i++] = 'C';
533
534   if ( use & PUBKEY_USAGE_ENC )
535     buffer[i++] = 'E';
536
537   if ( (use & PUBKEY_USAGE_AUTH) )
538     buffer[i++] = 'A';
539
540   while (i < 4)
541     buffer[i++] = ' ';
542
543   buffer[i] = 0;
544   return buffer;
545 }
546
547
548 const char *
549 colon_strtime (u32 t)
550 {
551   static char buf[20];
552
553   if (!t)
554     return "";
555   snprintf (buf, sizeof buf, "%lu", (ulong)t);
556   return buf;
557 }
558
559 const char *
560 colon_datestr_from_pk (PKT_public_key *pk)
561 {
562   static char buf[20];
563
564   snprintf (buf, sizeof buf, "%lu", (ulong)pk->timestamp);
565   return buf;
566 }
567
568
569 const char *
570 colon_datestr_from_sig (PKT_signature *sig)
571 {
572   static char buf[20];
573   
574   snprintf (buf, sizeof buf, "%lu", (ulong)sig->timestamp);
575   return buf;
576 }
577
578 const char *
579 colon_expirestr_from_sig (PKT_signature *sig)
580 {
581   static char buf[20];
582
583   if (!sig->expiredate)
584     return "";
585
586   snprintf (buf, sizeof buf,"%lu", (ulong)sig->expiredate);
587   return buf;
588 }
589
590
591 /*
592  * Return a byte array with the fingerprint for the given PK/SK
593  * The length of the array is returned in ret_len. Caller must free
594  * the array or provide an array of length MAX_FINGERPRINT_LEN.
595  */
596 byte *
597 fingerprint_from_pk (PKT_public_key *pk, byte *array, size_t *ret_len)
598 {
599   byte *buf;
600   const byte *dp;
601   size_t len, nbytes;
602   int i;
603   
604   if ( pk->version < 4 )
605     {
606       if ( is_RSA(pk->pubkey_algo) )
607         {
608           /* RSA in version 3 packets is special. */
609           gcry_md_hd_t md;
610           
611           if (gcry_md_open (&md, DIGEST_ALGO_MD5, 0))
612             BUG ();
613           if ( pubkey_get_npkey (pk->pubkey_algo) > 1 ) 
614             {
615               for (i=0; i < 2; i++)
616                 {
617                   if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, 
618                                       &nbytes, pk->pkey[i]))
619                     BUG ();
620                   /* fixme: Better allocate BUF on the stack */
621                   buf = xmalloc (nbytes);
622                   if (gcry_mpi_print (GCRYMPI_FMT_USG, buf, nbytes,
623                                       NULL, pk->pkey[i]))
624                     BUG ();
625                   gcry_md_write (md, buf, nbytes);
626                   xfree (buf);
627                 }
628             }
629           gcry_md_final (md);
630           if (!array)
631             array = xmalloc (16);
632           len = 16;
633           memcpy (array, gcry_md_read (md, DIGEST_ALGO_MD5), 16);
634           gcry_md_close(md);
635         }
636       else
637         {
638           if (!array)
639             array = xmalloc(16);
640           len = 16;
641           memset (array,0,16);
642         }
643     }
644   else 
645     {
646       gcry_md_hd_t md;
647       
648       md = do_fingerprint_md(pk);
649       dp = gcry_md_read( md, 0 );
650       len = gcry_md_get_algo_dlen (gcry_md_get_algo (md));
651       assert( len <= MAX_FINGERPRINT_LEN );
652       if (!array)
653         array = xmalloc ( len );
654       memcpy (array, dp, len );
655       pk->keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
656       pk->keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
657       gcry_md_close( md);
658     }
659   
660   *ret_len = len;
661   return array;
662 }
663
664
665
666
667 \f
668 /* Return the so called KEYGRIP which is the SHA-1 hash of the public
669    key parameters expressed as an canoncial encoded S-Exp.  ARRAY must
670    be 20 bytes long.  Returns 0 on sucess or an error code.  */
671 gpg_error_t
672 keygrip_from_pk (PKT_public_key *pk, unsigned char *array)
673 {
674   gpg_error_t err;
675   gcry_sexp_t s_pkey;
676   
677   if (DBG_PACKET)
678     log_debug ("get_keygrip for public key\n");
679
680   switch (pk->pubkey_algo)
681     {
682     case GCRY_PK_DSA:
683       err = gcry_sexp_build (&s_pkey, NULL,
684                              "(public-key(dsa(p%m)(q%m)(g%m)(y%m)))",
685                              pk->pkey[0], pk->pkey[1],
686                              pk->pkey[2], pk->pkey[3]);
687       break;
688
689     case GCRY_PK_ELG:
690     case GCRY_PK_ELG_E:
691       err = gcry_sexp_build (&s_pkey, NULL,
692                              "(public-key(elg(p%m)(g%m)(y%m)))",
693                              pk->pkey[0], pk->pkey[1], pk->pkey[2]);
694       break;
695
696     case GCRY_PK_RSA:
697     case GCRY_PK_RSA_S:
698     case GCRY_PK_RSA_E:
699       err = gcry_sexp_build (&s_pkey, NULL,
700                              "(public-key(rsa(n%m)(e%m)))",
701                              pk->pkey[0], pk->pkey[1]);
702       break;
703
704     default:
705       err = gpg_error (GPG_ERR_PUBKEY_ALGO);
706       break;
707     }
708   
709   if (err)
710     return err;
711
712   if (!gcry_pk_get_keygrip (s_pkey, array))
713     {
714       log_error ("error computing keygrip\n");
715       err = gpg_error (GPG_ERR_GENERAL);
716     }
717   else
718     {
719       if (DBG_PACKET)
720         log_printhex ("keygrip=", array, 20);
721       /* FIXME: Save the keygrip in PK.  */
722     }
723   gcry_sexp_release (s_pkey);
724   
725   return 0;
726 }
727
728
729 /* Store an allocated buffer with the keygrip of PK encoded as a
730    hexstring at r_GRIP.  Returns 0 on success.  */
731 gpg_error_t
732 hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip)
733 {
734   gpg_error_t err;
735   unsigned char grip[20];
736
737   *r_grip = NULL;
738   err = keygrip_from_pk (pk, grip);
739   if (!err)
740     {
741       char * buf = xtrymalloc (20*2+1);
742       if (!buf)
743         err = gpg_error_from_syserror ();
744       else
745         {
746           bin2hex (grip, 20, buf);
747           *r_grip = buf;
748         }
749     }
750   return err;
751 }
752