* keyid.c (keyid_from_sk): Minor performance boost by caching secret key
[gnupg.git] / g10 / keyid.c
1 /* keyid.c - key ID and fingerprint handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2003,
3  *               2004 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 2 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, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <errno.h>
27 #include <time.h>
28 #include <assert.h>
29 #include "util.h"
30 #include "main.h"
31 #include "packet.h"
32 #include "options.h"
33 #include "mpi.h"
34 #include "keydb.h"
35 #include "i18n.h"
36
37 int
38 pubkey_letter( int algo )
39 {
40     switch( algo ) {
41       case PUBKEY_ALGO_RSA:     return 'R' ;
42       case PUBKEY_ALGO_RSA_E:   return 'r' ;
43       case PUBKEY_ALGO_RSA_S:   return 's' ;
44       case PUBKEY_ALGO_ELGAMAL_E: return 'g';
45       case PUBKEY_ALGO_ELGAMAL: return 'G' ;
46       case PUBKEY_ALGO_DSA:     return 'D' ;
47       default: return '?';
48     }
49 }
50
51 /* This function is useful for v4 fingerprints and v3 or v4 key
52    signing. */
53 void
54 hash_public_key( MD_HANDLE md, PKT_public_key *pk )
55 {
56   unsigned n=6;
57   unsigned nb[PUBKEY_MAX_NPKEY];
58   unsigned nn[PUBKEY_MAX_NPKEY];
59   byte *pp[PUBKEY_MAX_NPKEY];
60   int i;
61   int npkey = pubkey_get_npkey( pk->pubkey_algo );
62
63   /* Two extra bytes for the expiration date in v3 */
64   if(pk->version<4)
65     n+=2;
66
67   if(npkey==0 && pk->pkey[0] && mpi_is_opaque(pk->pkey[0]))
68     {
69       pp[0]=mpi_get_opaque(pk->pkey[0],&nn[0]);
70       n+=nn[0];
71     }
72   else
73     for(i=0; i < npkey; i++ )
74       {
75         nb[i] = mpi_get_nbits(pk->pkey[i]);
76         pp[i] = mpi_get_buffer( pk->pkey[i], nn+i, NULL );
77         n += 2 + nn[i];
78       }
79
80   md_putc( md, 0x99 );     /* ctb */
81   /* What does it mean if n is greater than than 0xFFFF ? */
82   md_putc( md, n >> 8 );   /* 2 byte length header */
83   md_putc( md, n );
84   md_putc( md, pk->version );
85
86   md_putc( md, pk->timestamp >> 24 );
87   md_putc( md, pk->timestamp >> 16 );
88   md_putc( md, pk->timestamp >>  8 );
89   md_putc( md, pk->timestamp       );
90
91   if(pk->version<4)
92     {
93       u16 days=0;
94       if(pk->expiredate)
95         days=(u16)((pk->expiredate - pk->timestamp) / 86400L);
96  
97       md_putc( md, days >> 8 );
98       md_putc( md, days );
99     }
100
101   md_putc( md, pk->pubkey_algo );
102
103   if(npkey==0 && pk->pkey[0] && mpi_is_opaque(pk->pkey[0]))
104     md_write(md,pp[0],nn[0]);
105   else
106     for(i=0; i < npkey; i++ )
107       {
108         md_putc( md, nb[i]>>8);
109         md_putc( md, nb[i] );
110         md_write( md, pp[i], nn[i] );
111         m_free(pp[i]);
112       }
113 }
114
115 static MD_HANDLE
116 do_fingerprint_md( PKT_public_key *pk )
117 {
118   MD_HANDLE md;
119
120   md = md_open( DIGEST_ALGO_SHA1, 0);
121   hash_public_key(md,pk);
122   md_final( md );
123
124   return md;
125 }
126
127 static MD_HANDLE
128 do_fingerprint_md_sk( PKT_secret_key *sk )
129 {
130     PKT_public_key pk;
131     int npkey = pubkey_get_npkey( sk->pubkey_algo ); /* npkey is correct! */
132     int i;
133
134     if(npkey==0)
135       return NULL;
136
137     pk.pubkey_algo = sk->pubkey_algo;
138     pk.version     = sk->version;
139     pk.timestamp = sk->timestamp;
140     pk.expiredate = sk->expiredate;
141     pk.pubkey_algo = sk->pubkey_algo;
142     for( i=0; i < npkey; i++ )
143       pk.pkey[i] = sk->skey[i];
144     return do_fingerprint_md( &pk );
145 }
146
147 size_t
148 keystrlen(void)
149 {
150   switch(opt.keyid_format)
151     {
152     case KF_SHORT:
153       return 8;
154
155     case KF_LONG:
156       return 16;
157
158     case KF_0xSHORT:
159       return 10;
160
161     case KF_0xLONG:
162       return 18;
163
164     default:
165       BUG();
166     }
167 }
168
169 const char *
170 keystr(u32 *keyid)
171 {  
172   static char keyid_str[19];
173
174   switch(opt.keyid_format)
175     {
176     case KF_SHORT:
177       sprintf(keyid_str,"%08lX",(ulong)keyid[1]);
178       break;
179
180     case KF_LONG:
181       sprintf(keyid_str,"%08lX%08lX",(ulong)keyid[0],(ulong)keyid[1]);
182       break;
183
184     case KF_0xSHORT:
185       sprintf(keyid_str,"0x%08lX",(ulong)keyid[1]);
186       break;
187
188     case KF_0xLONG:
189       sprintf(keyid_str,"0x%08lX%08lX",(ulong)keyid[0],(ulong)keyid[1]);
190       break;
191
192     default:
193       BUG();
194     }
195
196   return keyid_str;
197 }
198
199
200 /****************
201  * Get the keyid from the secret key and put it into keyid
202  * if this is not NULL. Return the 32 low bits of the keyid.
203  */
204 u32
205 keyid_from_sk( PKT_secret_key *sk, u32 *keyid )
206 {
207   u32 lowbits;
208   u32 dummy_keyid[2];
209
210   if( !keyid )
211     keyid = dummy_keyid;
212
213   if( sk->keyid[0] || sk->keyid[1] )
214     {
215       keyid[0] = sk->keyid[0];
216       keyid[1] = sk->keyid[1];
217       lowbits = keyid[1];
218     }
219   else if( sk->version < 4 )
220     {
221       if( is_RSA(sk->pubkey_algo) )
222         {
223           lowbits = pubkey_get_npkey(sk->pubkey_algo) ?
224             mpi_get_keyid( sk->skey[0], keyid ) : 0; /* take n */
225           sk->keyid[0]=keyid[0];
226           sk->keyid[1]=keyid[1];
227         }
228       else
229         sk->keyid[0]=sk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
230     }
231   else
232     {
233       const byte *dp;
234       MD_HANDLE md;
235       md = do_fingerprint_md_sk(sk);
236       if(md)
237         {
238           dp = md_read( md, 0 );
239           keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
240           keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
241           lowbits = keyid[1];
242           md_close(md);
243           sk->keyid[0] = keyid[0];
244           sk->keyid[1] = keyid[1];
245         }
246       else
247         sk->keyid[0]=sk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
248     }
249
250   return lowbits;
251 }
252
253
254 /****************
255  * Get the keyid from the public key and put it into keyid
256  * if this is not NULL. Return the 32 low bits of the keyid.
257  */
258 u32
259 keyid_from_pk( PKT_public_key *pk, u32 *keyid )
260 {
261     u32 lowbits;
262     u32 dummy_keyid[2];
263
264     if( !keyid )
265         keyid = dummy_keyid;
266
267     if( pk->keyid[0] || pk->keyid[1] ) {
268         keyid[0] = pk->keyid[0];
269         keyid[1] = pk->keyid[1];
270         lowbits = keyid[1];
271     }
272     else if( pk->version < 4 )
273       {
274         if( is_RSA(pk->pubkey_algo) )
275           {
276             lowbits = pubkey_get_npkey(pk->pubkey_algo) ?
277               mpi_get_keyid( pk->pkey[0], keyid ) : 0 ; /* from n */
278             pk->keyid[0] = keyid[0];
279             pk->keyid[1] = keyid[1];
280           }
281         else
282           pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
283       }
284     else {
285         const byte *dp;
286         MD_HANDLE md;
287         md = do_fingerprint_md(pk);
288         dp = md_read( md, 0 );
289         keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
290         keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
291         lowbits = keyid[1];
292         md_close(md);
293         pk->keyid[0] = keyid[0];
294         pk->keyid[1] = keyid[1];
295     }
296
297     return lowbits;
298 }
299
300
301 /****************
302  * Get the keyid from the fingerprint.  This function is simple for most
303  * keys, but has to do a keylookup for old stayle keys.
304  */
305 u32
306 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid )
307 {
308     u32 dummy_keyid[2];
309
310     if( !keyid )
311         keyid = dummy_keyid;
312
313     if( fprint_len != 20 ) {
314         /* This is special as we have to lookup the key first */
315         PKT_public_key pk;
316         int rc;
317
318         memset( &pk, 0, sizeof pk );
319         rc = get_pubkey_byfprint( &pk, fprint, fprint_len );
320         if( rc ) {
321             log_error("Oops: keyid_from_fingerprint: no pubkey\n");
322             keyid[0] = 0;
323             keyid[1] = 0;
324         }
325         else
326             keyid_from_pk( &pk, keyid );
327     }
328     else {
329         const byte *dp = fprint;
330         keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
331         keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
332     }
333
334     return keyid[1];
335 }
336
337
338 u32
339 keyid_from_sig( PKT_signature *sig, u32 *keyid )
340 {
341     if( keyid ) {
342         keyid[0] = sig->keyid[0];
343         keyid[1] = sig->keyid[1];
344     }
345     return sig->keyid[1];
346 }
347
348 byte *
349 namehash_from_uid(PKT_user_id *uid)
350 {
351   if(uid->namehash==NULL)
352     {
353       uid->namehash=m_alloc(20);
354
355       if(uid->attrib_data)
356         rmd160_hash_buffer(uid->namehash,uid->attrib_data,uid->attrib_len);
357       else
358         rmd160_hash_buffer(uid->namehash,uid->name,uid->len);
359     }
360
361   return uid->namehash;
362 }
363
364 /****************
365  * return the number of bits used in the pk
366  */
367 unsigned
368 nbits_from_pk( PKT_public_key *pk )
369 {
370     return pubkey_nbits( pk->pubkey_algo, pk->pkey );
371 }
372
373 /****************
374  * return the number of bits used in the sk
375  */
376 unsigned
377 nbits_from_sk( PKT_secret_key *sk )
378 {
379     return pubkey_nbits( sk->pubkey_algo, sk->skey );
380 }
381
382 static const char *
383 mk_datestr (char *buffer, time_t atime)
384 {
385     struct tm *tp;
386
387     if ( atime < 0 ) /* 32 bit time_t and after 2038-01-19 */
388         strcpy (buffer, "????" "-??" "-??"); /* mark this as invalid */
389     else {
390         tp = gmtime (&atime);
391         sprintf (buffer,"%04d-%02d-%02d",
392                  1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
393     }
394     return buffer;
395 }
396
397 /****************
398  * return a string with the creation date of the pk
399  * Note: this is alloced in a static buffer.
400  *    Format is: yyyy-mm-dd
401  */
402 const char *
403 datestr_from_pk( PKT_public_key *pk )
404 {
405     static char buffer[11+5];
406     time_t atime = pk->timestamp;
407
408     return mk_datestr (buffer, atime);
409 }
410
411 const char *
412 datestr_from_sk( PKT_secret_key *sk )
413 {
414     static char buffer[11+5];
415     time_t atime = sk->timestamp;
416
417     return mk_datestr (buffer, atime);
418 }
419
420 const char *
421 datestr_from_sig( PKT_signature *sig )
422 {
423     static char buffer[11+5];
424     time_t atime = sig->timestamp;
425
426     return mk_datestr (buffer, atime);
427 }
428
429 const char *
430 expirestr_from_pk( PKT_public_key *pk )
431 {
432     static char buffer[11+5];
433     time_t atime;
434
435     if( !pk->expiredate )
436         return _("never     ");
437     atime = pk->expiredate;
438     return mk_datestr (buffer, atime);
439 }
440
441 const char *
442 expirestr_from_sk( PKT_secret_key *sk )
443 {
444     static char buffer[11+5];
445     time_t atime;
446
447     if( !sk->expiredate )
448         return _("never     ");
449     atime = sk->expiredate;
450     return mk_datestr (buffer, atime);
451 }
452
453 const char *
454 expirestr_from_sig( PKT_signature *sig )
455 {
456     static char buffer[11+5];
457     time_t atime;
458
459     if(!sig->expiredate)
460       return _("never     ");
461     atime=sig->expiredate;
462     return mk_datestr (buffer, atime);
463 }
464
465 const char *
466 revokestr_from_pk( PKT_public_key *pk )
467 {
468     static char buffer[11+5];
469     time_t atime;
470
471     if(!pk->revokedate)
472       return _("never     ");
473     atime=pk->revokedate;
474     return mk_datestr (buffer, atime);
475 }
476
477 const char *
478 colon_strtime (u32 t)
479 {
480     if (!t)
481         return "";
482     if (opt.fixed_list_mode) {
483         static char buf[15];
484         sprintf (buf, "%lu", (ulong)t);
485         return buf;
486     }
487     return strtimestamp(t);
488 }
489
490 const char *
491 colon_datestr_from_pk (PKT_public_key *pk)
492 {
493     if (opt.fixed_list_mode) {
494         static char buf[15];
495         sprintf (buf, "%lu", (ulong)pk->timestamp);
496         return buf;
497     }
498     return datestr_from_pk (pk);
499 }
500
501 const char *
502 colon_datestr_from_sk (PKT_secret_key *sk)
503 {
504     if (opt.fixed_list_mode) {
505         static char buf[15];
506         sprintf (buf, "%lu", (ulong)sk->timestamp);
507         return buf;
508     }
509     return datestr_from_sk (sk);
510 }
511
512 const char *
513 colon_datestr_from_sig (PKT_signature *sig)
514 {
515     if (opt.fixed_list_mode) {
516         static char buf[15];
517         sprintf (buf, "%lu", (ulong)sig->timestamp);
518         return buf;
519     }
520     return datestr_from_sig (sig);
521 }
522
523 const char *
524 colon_expirestr_from_sig (PKT_signature *sig)
525 {
526     if(!sig->expiredate)
527         return "";
528     if (opt.fixed_list_mode) {
529         static char buf[15];
530         sprintf (buf, "%lu", (ulong)sig->expiredate);
531         return buf;
532     }
533     return expirestr_from_sig (sig);
534 }
535
536
537 /**************** .
538  * Return a byte array with the fingerprint for the given PK/SK
539  * The length of the array is returned in ret_len. Caller must free
540  * the array or provide an array of length MAX_FINGERPRINT_LEN.
541  */
542
543 byte *
544 fingerprint_from_pk( PKT_public_key *pk, byte *array, size_t *ret_len )
545 {
546     byte *p, *buf;
547     const byte *dp;
548     size_t len;
549     unsigned int n;
550
551     if( pk->version < 4 )
552       {
553         if( is_RSA(pk->pubkey_algo) )
554           {
555             /* RSA in version 3 packets is special */
556             MD_HANDLE md;
557
558             md = md_open( DIGEST_ALGO_MD5, 0);
559             if( pubkey_get_npkey( pk->pubkey_algo ) > 1 ) {
560               p = buf = mpi_get_buffer( pk->pkey[0], &n, NULL );
561               md_write( md, p, n );
562               m_free(buf);
563               p = buf = mpi_get_buffer( pk->pkey[1], &n, NULL );
564               md_write( md, p, n );
565               m_free(buf);
566             }
567             md_final(md);
568             if( !array )
569               array = m_alloc( 16 );
570             len = 16;
571             memcpy(array, md_read(md, DIGEST_ALGO_MD5), 16 );
572             md_close(md);
573           }
574         else
575           {
576             if(!array)
577               array=m_alloc(16);
578             len=16;
579             memset(array,0,16);
580           }
581       }
582     else {
583         MD_HANDLE md;
584         md = do_fingerprint_md(pk);
585         dp = md_read( md, 0 );
586         len = md_digest_length( md_get_algo( md ) );
587         assert( len <= MAX_FINGERPRINT_LEN );
588         if( !array )
589             array = m_alloc( len );
590         memcpy(array, dp, len );
591         pk->keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
592         pk->keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
593         md_close(md);
594     }
595
596     *ret_len = len;
597     return array;
598 }
599
600 byte *
601 fingerprint_from_sk( PKT_secret_key *sk, byte *array, size_t *ret_len )
602 {
603     byte *p, *buf;
604     const char *dp;
605     size_t len;
606     unsigned n;
607
608     if( sk->version < 4 )
609       {
610         if( is_RSA(sk->pubkey_algo) )
611           {
612             /* RSA in version 3 packets is special */
613             MD_HANDLE md;
614
615             md = md_open( DIGEST_ALGO_MD5, 0);
616             if( pubkey_get_npkey( sk->pubkey_algo ) > 1 ) {
617               p = buf = mpi_get_buffer( sk->skey[0], &n, NULL );
618               md_write( md, p, n );
619               m_free(buf);
620               p = buf = mpi_get_buffer( sk->skey[1], &n, NULL );
621               md_write( md, p, n );
622               m_free(buf);
623             }
624             md_final(md);
625             if( !array )
626               array = m_alloc( 16 );
627             len = 16;
628             memcpy(array, md_read(md, DIGEST_ALGO_MD5), 16 );
629             md_close(md);
630           }
631         else
632           {
633             if(!array)
634               array=m_alloc(16);
635             len=16;
636             memset(array,0,16);
637           }
638       }
639     else {
640         MD_HANDLE md;
641         md = do_fingerprint_md_sk(sk);
642         if(md)
643           {
644             dp = md_read( md, 0 );
645             len = md_digest_length( md_get_algo( md ) );
646             assert( len <= MAX_FINGERPRINT_LEN );
647             if( !array )
648               array = m_alloc( len );
649             memcpy(array, dp, len );
650             md_close(md);
651           }
652         else
653           {
654             len=MAX_FINGERPRINT_LEN;
655             if(!array)
656               array=m_alloc(len);
657             memset(array,0,len);
658           }
659     }
660
661     *ret_len = len;
662     return array;
663 }