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