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