Exporting secret keys via gpg-agent is now basically supported.
[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   if ( atime < 0 ) /* 32 bit time_t and after 2038-01-19 */
450     strcpy (buffer, "????" "-??" "-??"); /* mark this as invalid */
451   else 
452     {
453       tp = gmtime (&atime);
454       sprintf (buffer,"%04d-%02d-%02d",
455                1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
456     }
457   return buffer;
458 }
459
460
461 /*
462  * return a string with the creation date of the pk
463  * Note: this is alloced in a static buffer.
464  *    Format is: yyyy-mm-dd
465  */
466 const char *
467 datestr_from_pk (PKT_public_key *pk)
468 {
469   static char buffer[11+5];
470   time_t atime = pk->timestamp;
471   
472   return mk_datestr (buffer, atime);
473 }
474
475
476 const char *
477 datestr_from_sig (PKT_signature *sig )
478 {
479   static char buffer[11+5];
480   time_t atime = sig->timestamp;
481
482   return mk_datestr (buffer, atime);
483 }
484
485
486 const char *
487 expirestr_from_pk (PKT_public_key *pk)
488 {
489   static char buffer[11+5];
490   time_t atime;
491
492   if (!pk->expiredate)
493     return _("never     ");
494   atime = pk->expiredate;
495   return mk_datestr (buffer, atime);
496 }
497
498
499 const char *
500 expirestr_from_sig (PKT_signature *sig)
501 {
502   static char buffer[11+5];
503   time_t atime;
504   
505   if (!sig->expiredate)
506     return _("never     ");
507   atime=sig->expiredate;
508   return mk_datestr (buffer, atime);
509 }
510
511
512 const char *
513 revokestr_from_pk( PKT_public_key *pk )
514 {
515   static char buffer[11+5];
516   time_t atime;
517
518   if(!pk->revoked.date)
519     return _("never     ");
520   atime=pk->revoked.date;
521   return mk_datestr (buffer, atime);
522 }
523
524
525 const char *
526 usagestr_from_pk( PKT_public_key *pk )
527 {
528   static char buffer[10];
529   int i = 0;
530   unsigned int use = pk->pubkey_usage;
531
532   if ( use & PUBKEY_USAGE_SIG )
533     buffer[i++] = 'S';
534
535   if ( use & PUBKEY_USAGE_CERT )
536     buffer[i++] = 'C';
537
538   if ( use & PUBKEY_USAGE_ENC )
539     buffer[i++] = 'E';
540
541   if ( (use & PUBKEY_USAGE_AUTH) )
542     buffer[i++] = 'A';
543
544   while (i < 4)
545     buffer[i++] = ' ';
546
547   buffer[i] = 0;
548   return buffer;
549 }
550
551
552 const char *
553 colon_strtime (u32 t)
554 {
555   static char buf[20];
556
557   if (!t)
558     return "";
559   snprintf (buf, sizeof buf, "%lu", (ulong)t);
560   return buf;
561 }
562
563 const char *
564 colon_datestr_from_pk (PKT_public_key *pk)
565 {
566   static char buf[20];
567
568   snprintf (buf, sizeof buf, "%lu", (ulong)pk->timestamp);
569   return buf;
570 }
571
572
573 const char *
574 colon_datestr_from_sig (PKT_signature *sig)
575 {
576   static char buf[20];
577   
578   snprintf (buf, sizeof buf, "%lu", (ulong)sig->timestamp);
579   return buf;
580 }
581
582 const char *
583 colon_expirestr_from_sig (PKT_signature *sig)
584 {
585   static char buf[20];
586
587   if (!sig->expiredate)
588     return "";
589
590   snprintf (buf, sizeof buf,"%lu", (ulong)sig->expiredate);
591   return buf;
592 }
593
594
595 /*
596  * Return a byte array with the fingerprint for the given PK/SK
597  * The length of the array is returned in ret_len. Caller must free
598  * the array or provide an array of length MAX_FINGERPRINT_LEN.
599  */
600 byte *
601 fingerprint_from_pk (PKT_public_key *pk, byte *array, size_t *ret_len)
602 {
603   byte *buf;
604   const byte *dp;
605   size_t len, nbytes;
606   int i;
607   
608   if ( pk->version < 4 )
609     {
610       if ( is_RSA(pk->pubkey_algo) )
611         {
612           /* RSA in version 3 packets is special. */
613           gcry_md_hd_t md;
614           
615           if (gcry_md_open (&md, DIGEST_ALGO_MD5, 0))
616             BUG ();
617           if ( pubkey_get_npkey (pk->pubkey_algo) > 1 ) 
618             {
619               for (i=0; i < 2; i++)
620                 {
621                   if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, 
622                                       &nbytes, pk->pkey[i]))
623                     BUG ();
624                   /* fixme: Better allocate BUF on the stack */
625                   buf = xmalloc (nbytes);
626                   if (gcry_mpi_print (GCRYMPI_FMT_USG, buf, nbytes,
627                                       NULL, pk->pkey[i]))
628                     BUG ();
629                   gcry_md_write (md, buf, nbytes);
630                   xfree (buf);
631                 }
632             }
633           gcry_md_final (md);
634           if (!array)
635             array = xmalloc (16);
636           len = 16;
637           memcpy (array, gcry_md_read (md, DIGEST_ALGO_MD5), 16);
638           gcry_md_close(md);
639         }
640       else
641         {
642           if (!array)
643             array = xmalloc(16);
644           len = 16;
645           memset (array,0,16);
646         }
647     }
648   else 
649     {
650       gcry_md_hd_t md;
651       
652       md = do_fingerprint_md(pk);
653       dp = gcry_md_read( md, 0 );
654       len = gcry_md_get_algo_dlen (gcry_md_get_algo (md));
655       assert( len <= MAX_FINGERPRINT_LEN );
656       if (!array)
657         array = xmalloc ( len );
658       memcpy (array, dp, len );
659       pk->keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
660       pk->keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
661       gcry_md_close( md);
662     }
663   
664   *ret_len = len;
665   return array;
666 }
667
668
669
670
671 \f
672 /* Return the so called KEYGRIP which is the SHA-1 hash of the public
673    key parameters expressed as an canoncial encoded S-Exp.  ARRAY must
674    be 20 bytes long.  Returns 0 on sucess or an error code.  */
675 gpg_error_t
676 keygrip_from_pk (PKT_public_key *pk, unsigned char *array)
677 {
678   gpg_error_t err;
679   gcry_sexp_t s_pkey;
680   
681   if (DBG_PACKET)
682     log_debug ("get_keygrip for public key\n");
683
684   switch (pk->pubkey_algo)
685     {
686     case GCRY_PK_DSA:
687       err = gcry_sexp_build (&s_pkey, NULL,
688                              "(public-key(dsa(p%m)(q%m)(g%m)(y%m)))",
689                              pk->pkey[0], pk->pkey[1],
690                              pk->pkey[2], pk->pkey[3]);
691       break;
692
693     case GCRY_PK_ELG:
694     case GCRY_PK_ELG_E:
695       err = gcry_sexp_build (&s_pkey, NULL,
696                              "(public-key(elg(p%m)(g%m)(y%m)))",
697                              pk->pkey[0], pk->pkey[1], pk->pkey[2]);
698       break;
699
700     case GCRY_PK_RSA:
701     case GCRY_PK_RSA_S:
702     case GCRY_PK_RSA_E:
703       err = gcry_sexp_build (&s_pkey, NULL,
704                              "(public-key(rsa(n%m)(e%m)))",
705                              pk->pkey[0], pk->pkey[1]);
706       break;
707
708     default:
709       err = gpg_error (GPG_ERR_PUBKEY_ALGO);
710       break;
711     }
712   
713   if (err)
714     return err;
715
716   if (!gcry_pk_get_keygrip (s_pkey, array))
717     {
718       log_error ("error computing keygrip\n");
719       err = gpg_error (GPG_ERR_GENERAL);
720     }
721   else
722     {
723       if (DBG_PACKET)
724         log_printhex ("keygrip=", array, 20);
725       /* FIXME: Save the keygrip in PK.  */
726     }
727   gcry_sexp_release (s_pkey);
728   
729   return 0;
730 }
731
732
733 /* Store an allocated buffer with the keygrip of PK encoded as a
734    hexstring at r_GRIP.  Returns 0 on success.  */
735 gpg_error_t
736 hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip)
737 {
738   gpg_error_t err;
739   unsigned char grip[20];
740
741   *r_grip = NULL;
742   err = keygrip_from_pk (pk, grip);
743   if (!err)
744     {
745       char * buf = xtrymalloc (20*2+1);
746       if (!buf)
747         err = gpg_error_from_syserror ();
748       else
749         {
750           bin2hex (grip, 20, buf);
751           *r_grip = buf;
752         }
753     }
754   return err;
755 }
756