* keydb.h, keyid.c (keystr_from_pk, keystr_from_sk): New functions to pull
[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 const char *
200 keystr_from_pk(PKT_public_key *pk)
201 {
202   keyid_from_pk(pk,NULL);
203
204   return keystr(pk->keyid);
205 }
206
207 const char *
208 keystr_from_sk(PKT_secret_key *sk)
209 {
210   keyid_from_sk(sk,NULL);
211
212   return keystr(sk->keyid);
213 }
214
215 /****************
216  * Get the keyid from the secret key and put it into keyid
217  * if this is not NULL. Return the 32 low bits of the keyid.
218  */
219 u32
220 keyid_from_sk( PKT_secret_key *sk, u32 *keyid )
221 {
222   u32 lowbits;
223   u32 dummy_keyid[2];
224
225   if( !keyid )
226     keyid = dummy_keyid;
227
228   if( sk->keyid[0] || sk->keyid[1] )
229     {
230       keyid[0] = sk->keyid[0];
231       keyid[1] = sk->keyid[1];
232       lowbits = keyid[1];
233     }
234   else if( sk->version < 4 )
235     {
236       if( is_RSA(sk->pubkey_algo) )
237         {
238           lowbits = pubkey_get_npkey(sk->pubkey_algo) ?
239             mpi_get_keyid( sk->skey[0], keyid ) : 0; /* take n */
240           sk->keyid[0]=keyid[0];
241           sk->keyid[1]=keyid[1];
242         }
243       else
244         sk->keyid[0]=sk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
245     }
246   else
247     {
248       const byte *dp;
249       MD_HANDLE md;
250       md = do_fingerprint_md_sk(sk);
251       if(md)
252         {
253           dp = md_read( md, 0 );
254           keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
255           keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
256           lowbits = keyid[1];
257           md_close(md);
258           sk->keyid[0] = keyid[0];
259           sk->keyid[1] = keyid[1];
260         }
261       else
262         sk->keyid[0]=sk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
263     }
264
265   return lowbits;
266 }
267
268
269 /****************
270  * Get the keyid from the public key and put it into keyid
271  * if this is not NULL. Return the 32 low bits of the keyid.
272  */
273 u32
274 keyid_from_pk( PKT_public_key *pk, u32 *keyid )
275 {
276   u32 lowbits;
277   u32 dummy_keyid[2];
278
279   if( !keyid )
280     keyid = dummy_keyid;
281
282   if( pk->keyid[0] || pk->keyid[1] )
283     {
284       keyid[0] = pk->keyid[0];
285       keyid[1] = pk->keyid[1];
286       lowbits = keyid[1];
287     }
288   else if( pk->version < 4 )
289     {
290       if( is_RSA(pk->pubkey_algo) )
291         {
292           lowbits = pubkey_get_npkey(pk->pubkey_algo) ?
293             mpi_get_keyid( pk->pkey[0], keyid ) : 0 ; /* from n */
294           pk->keyid[0] = keyid[0];
295           pk->keyid[1] = keyid[1];
296         }
297       else
298         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
299     }
300   else
301     {
302       const byte *dp;
303       MD_HANDLE md;
304       md = do_fingerprint_md(pk);
305       if(md)
306         {
307           dp = md_read( md, 0 );
308           keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
309           keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
310           lowbits = keyid[1];
311           md_close(md);
312           pk->keyid[0] = keyid[0];
313           pk->keyid[1] = keyid[1];
314         }
315       else
316         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0;
317     }
318
319   return lowbits;
320 }
321
322
323 /****************
324  * Get the keyid from the fingerprint.  This function is simple for most
325  * keys, but has to do a keylookup for old stayle keys.
326  */
327 u32
328 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid )
329 {
330     u32 dummy_keyid[2];
331
332     if( !keyid )
333         keyid = dummy_keyid;
334
335     if( fprint_len != 20 ) {
336         /* This is special as we have to lookup the key first */
337         PKT_public_key pk;
338         int rc;
339
340         memset( &pk, 0, sizeof pk );
341         rc = get_pubkey_byfprint( &pk, fprint, fprint_len );
342         if( rc ) {
343             log_error("Oops: keyid_from_fingerprint: no pubkey\n");
344             keyid[0] = 0;
345             keyid[1] = 0;
346         }
347         else
348             keyid_from_pk( &pk, keyid );
349     }
350     else {
351         const byte *dp = fprint;
352         keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
353         keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
354     }
355
356     return keyid[1];
357 }
358
359
360 u32
361 keyid_from_sig( PKT_signature *sig, u32 *keyid )
362 {
363     if( keyid ) {
364         keyid[0] = sig->keyid[0];
365         keyid[1] = sig->keyid[1];
366     }
367     return sig->keyid[1];
368 }
369
370 byte *
371 namehash_from_uid(PKT_user_id *uid)
372 {
373   if(uid->namehash==NULL)
374     {
375       uid->namehash=m_alloc(20);
376
377       if(uid->attrib_data)
378         rmd160_hash_buffer(uid->namehash,uid->attrib_data,uid->attrib_len);
379       else
380         rmd160_hash_buffer(uid->namehash,uid->name,uid->len);
381     }
382
383   return uid->namehash;
384 }
385
386 /****************
387  * return the number of bits used in the pk
388  */
389 unsigned
390 nbits_from_pk( PKT_public_key *pk )
391 {
392     return pubkey_nbits( pk->pubkey_algo, pk->pkey );
393 }
394
395 /****************
396  * return the number of bits used in the sk
397  */
398 unsigned
399 nbits_from_sk( PKT_secret_key *sk )
400 {
401     return pubkey_nbits( sk->pubkey_algo, sk->skey );
402 }
403
404 static const char *
405 mk_datestr (char *buffer, time_t atime)
406 {
407     struct tm *tp;
408
409     if ( atime < 0 ) /* 32 bit time_t and after 2038-01-19 */
410         strcpy (buffer, "????" "-??" "-??"); /* mark this as invalid */
411     else {
412         tp = gmtime (&atime);
413         sprintf (buffer,"%04d-%02d-%02d",
414                  1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
415     }
416     return buffer;
417 }
418
419 /****************
420  * return a string with the creation date of the pk
421  * Note: this is alloced in a static buffer.
422  *    Format is: yyyy-mm-dd
423  */
424 const char *
425 datestr_from_pk( PKT_public_key *pk )
426 {
427     static char buffer[11+5];
428     time_t atime = pk->timestamp;
429
430     return mk_datestr (buffer, atime);
431 }
432
433 const char *
434 datestr_from_sk( PKT_secret_key *sk )
435 {
436     static char buffer[11+5];
437     time_t atime = sk->timestamp;
438
439     return mk_datestr (buffer, atime);
440 }
441
442 const char *
443 datestr_from_sig( PKT_signature *sig )
444 {
445     static char buffer[11+5];
446     time_t atime = sig->timestamp;
447
448     return mk_datestr (buffer, atime);
449 }
450
451 const char *
452 expirestr_from_pk( PKT_public_key *pk )
453 {
454     static char buffer[11+5];
455     time_t atime;
456
457     if( !pk->expiredate )
458         return _("never     ");
459     atime = pk->expiredate;
460     return mk_datestr (buffer, atime);
461 }
462
463 const char *
464 expirestr_from_sk( PKT_secret_key *sk )
465 {
466     static char buffer[11+5];
467     time_t atime;
468
469     if( !sk->expiredate )
470         return _("never     ");
471     atime = sk->expiredate;
472     return mk_datestr (buffer, atime);
473 }
474
475 const char *
476 expirestr_from_sig( PKT_signature *sig )
477 {
478     static char buffer[11+5];
479     time_t atime;
480
481     if(!sig->expiredate)
482       return _("never     ");
483     atime=sig->expiredate;
484     return mk_datestr (buffer, atime);
485 }
486
487 const char *
488 revokestr_from_pk( PKT_public_key *pk )
489 {
490     static char buffer[11+5];
491     time_t atime;
492
493     if(!pk->revokedate)
494       return _("never     ");
495     atime=pk->revokedate;
496     return mk_datestr (buffer, atime);
497 }
498
499 const char *
500 colon_strtime (u32 t)
501 {
502     if (!t)
503         return "";
504     if (opt.fixed_list_mode) {
505         static char buf[15];
506         sprintf (buf, "%lu", (ulong)t);
507         return buf;
508     }
509     return strtimestamp(t);
510 }
511
512 const char *
513 colon_datestr_from_pk (PKT_public_key *pk)
514 {
515     if (opt.fixed_list_mode) {
516         static char buf[15];
517         sprintf (buf, "%lu", (ulong)pk->timestamp);
518         return buf;
519     }
520     return datestr_from_pk (pk);
521 }
522
523 const char *
524 colon_datestr_from_sk (PKT_secret_key *sk)
525 {
526     if (opt.fixed_list_mode) {
527         static char buf[15];
528         sprintf (buf, "%lu", (ulong)sk->timestamp);
529         return buf;
530     }
531     return datestr_from_sk (sk);
532 }
533
534 const char *
535 colon_datestr_from_sig (PKT_signature *sig)
536 {
537     if (opt.fixed_list_mode) {
538         static char buf[15];
539         sprintf (buf, "%lu", (ulong)sig->timestamp);
540         return buf;
541     }
542     return datestr_from_sig (sig);
543 }
544
545 const char *
546 colon_expirestr_from_sig (PKT_signature *sig)
547 {
548     if(!sig->expiredate)
549         return "";
550     if (opt.fixed_list_mode) {
551         static char buf[15];
552         sprintf (buf, "%lu", (ulong)sig->expiredate);
553         return buf;
554     }
555     return expirestr_from_sig (sig);
556 }
557
558
559 /**************** .
560  * Return a byte array with the fingerprint for the given PK/SK
561  * The length of the array is returned in ret_len. Caller must free
562  * the array or provide an array of length MAX_FINGERPRINT_LEN.
563  */
564
565 byte *
566 fingerprint_from_pk( PKT_public_key *pk, byte *array, size_t *ret_len )
567 {
568     byte *p, *buf;
569     const byte *dp;
570     size_t len;
571     unsigned int n;
572
573     if( pk->version < 4 )
574       {
575         if( is_RSA(pk->pubkey_algo) )
576           {
577             /* RSA in version 3 packets is special */
578             MD_HANDLE md;
579
580             md = md_open( DIGEST_ALGO_MD5, 0);
581             if( pubkey_get_npkey( pk->pubkey_algo ) > 1 ) {
582               p = buf = mpi_get_buffer( pk->pkey[0], &n, NULL );
583               md_write( md, p, n );
584               m_free(buf);
585               p = buf = mpi_get_buffer( pk->pkey[1], &n, NULL );
586               md_write( md, p, n );
587               m_free(buf);
588             }
589             md_final(md);
590             if( !array )
591               array = m_alloc( 16 );
592             len = 16;
593             memcpy(array, md_read(md, DIGEST_ALGO_MD5), 16 );
594             md_close(md);
595           }
596         else
597           {
598             if(!array)
599               array=m_alloc(16);
600             len=16;
601             memset(array,0,16);
602           }
603       }
604     else {
605         MD_HANDLE md;
606         md = do_fingerprint_md(pk);
607         dp = md_read( md, 0 );
608         len = md_digest_length( md_get_algo( md ) );
609         assert( len <= MAX_FINGERPRINT_LEN );
610         if( !array )
611             array = m_alloc( len );
612         memcpy(array, dp, len );
613         pk->keyid[0] = dp[12] << 24 | dp[13] << 16 | dp[14] << 8 | dp[15] ;
614         pk->keyid[1] = dp[16] << 24 | dp[17] << 16 | dp[18] << 8 | dp[19] ;
615         md_close(md);
616     }
617
618     *ret_len = len;
619     return array;
620 }
621
622 byte *
623 fingerprint_from_sk( PKT_secret_key *sk, byte *array, size_t *ret_len )
624 {
625     byte *p, *buf;
626     const char *dp;
627     size_t len;
628     unsigned n;
629
630     if( sk->version < 4 )
631       {
632         if( is_RSA(sk->pubkey_algo) )
633           {
634             /* RSA in version 3 packets is special */
635             MD_HANDLE md;
636
637             md = md_open( DIGEST_ALGO_MD5, 0);
638             if( pubkey_get_npkey( sk->pubkey_algo ) > 1 ) {
639               p = buf = mpi_get_buffer( sk->skey[0], &n, NULL );
640               md_write( md, p, n );
641               m_free(buf);
642               p = buf = mpi_get_buffer( sk->skey[1], &n, NULL );
643               md_write( md, p, n );
644               m_free(buf);
645             }
646             md_final(md);
647             if( !array )
648               array = m_alloc( 16 );
649             len = 16;
650             memcpy(array, md_read(md, DIGEST_ALGO_MD5), 16 );
651             md_close(md);
652           }
653         else
654           {
655             if(!array)
656               array=m_alloc(16);
657             len=16;
658             memset(array,0,16);
659           }
660       }
661     else {
662         MD_HANDLE md;
663         md = do_fingerprint_md_sk(sk);
664         if(md)
665           {
666             dp = md_read( md, 0 );
667             len = md_digest_length( md_get_algo( md ) );
668             assert( len <= MAX_FINGERPRINT_LEN );
669             if( !array )
670               array = m_alloc( len );
671             memcpy(array, dp, len );
672             md_close(md);
673           }
674         else
675           {
676             len=MAX_FINGERPRINT_LEN;
677             if(!array)
678               array=m_alloc(len);
679             memset(array,0,len);
680           }
681     }
682
683     *ret_len = len;
684     return array;
685 }