84990a30d04c80c9b3116b9cb42c69c6be18b0c6
[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  * Copyright (C) 2014 Werner Koch
5  * Copyright (C) 2016 g10 Code GmbH
6  *
7  * This file is part of GnuPG.
8  *
9  * GnuPG is free software; you can redistribute it and/or modify
10  * it under the terms of the GNU General Public License as published by
11  * the Free Software Foundation; either version 3 of the License, or
12  * (at your option) any later version.
13  *
14  * GnuPG is distributed in the hope that it will be useful,
15  * but WITHOUT ANY WARRANTY; without even the implied warranty of
16  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
17  * GNU General Public License for more details.
18  *
19  * You should have received a copy of the GNU General Public License
20  * along with this program; if not, see <http://www.gnu.org/licenses/>.
21  */
22
23 #include <config.h>
24 #include <stdio.h>
25 #include <stdlib.h>
26 #include <string.h>
27 #include <errno.h>
28 #include <time.h>
29
30 #include "gpg.h"
31 #include "util.h"
32 #include "main.h"
33 #include "packet.h"
34 #include "options.h"
35 #include "keydb.h"
36 #include "i18n.h"
37 #include "rmd160.h"
38 #include "host2net.h"
39
40
41 #define KEYID_STR_SIZE 19
42
43 #ifdef HAVE_UNSIGNED_TIME_T
44 # define IS_INVALID_TIME_T(a) ((a) == (time_t)(-1))
45 #else
46   /* Error or 32 bit time_t and value after 2038-01-19.  */
47 # define IS_INVALID_TIME_T(a) ((a) < 0)
48 #endif
49
50
51 /* Return a letter describing the public key algorithms.  */
52 int
53 pubkey_letter( int algo )
54 {
55   switch (algo)
56     {
57     case PUBKEY_ALGO_RSA:       return 'R' ;
58     case PUBKEY_ALGO_RSA_E:     return 'r' ;
59     case PUBKEY_ALGO_RSA_S:     return 's' ;
60     case PUBKEY_ALGO_ELGAMAL_E: return 'g' ;
61     case PUBKEY_ALGO_ELGAMAL:   return 'G' ;
62     case PUBKEY_ALGO_DSA:       return 'D' ;
63     case PUBKEY_ALGO_ECDH:      return 'e' ;    /* ECC DH (encrypt only) */
64     case PUBKEY_ALGO_ECDSA:     return 'E' ;    /* ECC DSA (sign only)   */
65     case PUBKEY_ALGO_EDDSA:     return 'E' ;    /* ECC EdDSA (sign only) */
66     default: return '?';
67     }
68 }
69
70 /* Return a string describing the public key algorithm and the
71    keysize.  For elliptic curves the functions prints the name of the
72    curve because the keysize is a property of the curve.  The string
73    is copied to the supplied buffer up a length of BUFSIZE-1.
74    Examples for the output are:
75
76    "rsa2048"  - RSA with 2048 bit
77    "elg1024"  - Elgamal with 1024 bit
78    "ed25519"  - ECC using the curve Ed25519.
79    "E_1.2.3.4"  - ECC using the unsupported curve with OID "1.2.3.4".
80    "E_1.3.6.1.4.1.11591.2.12242973" ECC with a bogus OID.
81    "unknown_N"  - Unknown OpenPGP algorithm N.
82
83    If the option --legacy-list-mode is active, the output use the
84    legacy format:
85
86    "2048R" - RSA with 2048 bit
87    "1024g" - Elgamal with 1024 bit
88    "256E"  - ECDSA using a curve with 256 bit
89
90    The macro PUBKEY_STRING_SIZE may be used to allocate a buffer with
91    a suitable size.*/
92 char *
93 pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize)
94 {
95   const char *prefix = NULL;
96
97   if (opt.legacy_list_mode)
98     {
99       snprintf (buffer, bufsize, "%4u%c",
100                 nbits_from_pk (pk), pubkey_letter (pk->pubkey_algo));
101       return buffer;
102     }
103
104   switch (pk->pubkey_algo)
105     {
106     case PUBKEY_ALGO_RSA:
107     case PUBKEY_ALGO_RSA_E:
108     case PUBKEY_ALGO_RSA_S:     prefix = "rsa"; break;
109     case PUBKEY_ALGO_ELGAMAL_E: prefix = "elg"; break;
110     case PUBKEY_ALGO_DSA:       prefix = "dsa"; break;
111     case PUBKEY_ALGO_ELGAMAL:   prefix = "xxx"; break;
112     case PUBKEY_ALGO_ECDH:
113     case PUBKEY_ALGO_ECDSA:
114     case PUBKEY_ALGO_EDDSA:     prefix = "";    break;
115     }
116
117   if (prefix && *prefix)
118     snprintf (buffer, bufsize, "%s%u", prefix, nbits_from_pk (pk));
119   else if (prefix)
120     {
121       char *curve = openpgp_oid_to_str (pk->pkey[0]);
122       const char *name = openpgp_oid_to_curve (curve, 0);
123
124       if (name)
125         snprintf (buffer, bufsize, "%s", name);
126       else if (curve)
127         snprintf (buffer, bufsize, "E_%s", curve);
128       else
129         snprintf (buffer, bufsize, "E_error");
130       xfree (curve);
131     }
132   else
133     snprintf (buffer, bufsize, "unknown_%u", (unsigned int)pk->pubkey_algo);
134
135   return buffer;
136 }
137
138
139 /* Hash a public key.  This function is useful for v4 fingerprints and
140    for v3 or v4 key signing. */
141 void
142 hash_public_key (gcry_md_hd_t md, PKT_public_key *pk)
143 {
144   unsigned int n = 6;
145   unsigned int nn[PUBKEY_MAX_NPKEY];
146   byte *pp[PUBKEY_MAX_NPKEY];
147   int i;
148   unsigned int nbits;
149   size_t nbytes;
150   int npkey = pubkey_get_npkey (pk->pubkey_algo);
151
152   /* FIXME: We can avoid the extra malloc by calling only the first
153      mpi_print here which computes the required length and calling the
154      real mpi_print only at the end.  The speed advantage would only be
155      for ECC (opaque MPIs) or if we could implement an mpi_print
156      variant with a callback handler to do the hashing.  */
157   if (npkey==0 && pk->pkey[0]
158       && gcry_mpi_get_flag (pk->pkey[0], GCRYMPI_FLAG_OPAQUE))
159     {
160       pp[0] = gcry_mpi_get_opaque (pk->pkey[0], &nbits);
161       nn[0] = (nbits+7)/8;
162       n+=nn[0];
163     }
164   else
165     {
166       for (i=0; i < npkey; i++ )
167         {
168           if (!pk->pkey[i])
169             {
170               /* This case may only happen if the parsing of the MPI
171                  failed but the key was anyway created.  May happen
172                  during "gpg KEYFILE".  */
173               pp[i] = NULL;
174               nn[i] = 0;
175             }
176           else if (gcry_mpi_get_flag (pk->pkey[i], GCRYMPI_FLAG_OPAQUE))
177             {
178               const void *p;
179
180               p = gcry_mpi_get_opaque (pk->pkey[i], &nbits);
181               pp[i] = xmalloc ((nbits+7)/8);
182               if (p)
183                 memcpy (pp[i], p, (nbits+7)/8);
184               else
185                 pp[i] = NULL;
186               nn[i] = (nbits+7)/8;
187               n += nn[i];
188             }
189           else
190             {
191               if (gcry_mpi_print (GCRYMPI_FMT_PGP, NULL, 0,
192                                   &nbytes, pk->pkey[i]))
193                 BUG ();
194               pp[i] = xmalloc (nbytes);
195               if (gcry_mpi_print (GCRYMPI_FMT_PGP, pp[i], nbytes,
196                                   &nbytes, pk->pkey[i]))
197                 BUG ();
198               nn[i] = nbytes;
199               n += nn[i];
200             }
201         }
202     }
203
204   gcry_md_putc ( md, 0x99 );     /* ctb */
205   /* What does it mean if n is greater than than 0xFFFF ? */
206   gcry_md_putc ( md, n >> 8 );   /* 2 byte length header */
207   gcry_md_putc ( md, n );
208   gcry_md_putc ( md, pk->version );
209
210   gcry_md_putc ( md, pk->timestamp >> 24 );
211   gcry_md_putc ( md, pk->timestamp >> 16 );
212   gcry_md_putc ( md, pk->timestamp >>  8 );
213   gcry_md_putc ( md, pk->timestamp       );
214
215   gcry_md_putc ( md, pk->pubkey_algo );
216
217   if(npkey==0 && pk->pkey[0]
218      && gcry_mpi_get_flag (pk->pkey[0], GCRYMPI_FLAG_OPAQUE))
219     {
220       if (pp[0])
221         gcry_md_write (md, pp[0], nn[0]);
222     }
223   else
224     {
225       for(i=0; i < npkey; i++ )
226         {
227           if (pp[i])
228             gcry_md_write ( md, pp[i], nn[i] );
229           xfree(pp[i]);
230         }
231     }
232 }
233
234
235 static gcry_md_hd_t
236 do_fingerprint_md( PKT_public_key *pk )
237 {
238   gcry_md_hd_t md;
239
240   if (gcry_md_open (&md, DIGEST_ALGO_SHA1, 0))
241     BUG ();
242   hash_public_key(md,pk);
243   gcry_md_final( md );
244
245   return md;
246 }
247
248
249 /* fixme: Check whether we can replace this function or if not
250    describe why we need it.  */
251 u32
252 v3_keyid (gcry_mpi_t a, u32 *ki)
253 {
254   byte *buffer, *p;
255   size_t nbytes;
256
257   if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, &nbytes, a ))
258     BUG ();
259   /* fixme: allocate it on the stack */
260   buffer = xmalloc (nbytes);
261   if (gcry_mpi_print( GCRYMPI_FMT_USG, buffer, nbytes, NULL, a ))
262     BUG ();
263   if (nbytes < 8) /* oops */
264     ki[0] = ki[1] = 0;
265   else
266     {
267       p = buffer + nbytes - 8;
268       ki[0] = buf32_to_u32 (p);
269       p += 4;
270       ki[1] = buf32_to_u32 (p);
271     }
272   xfree (buffer);
273   return ki[1];
274 }
275
276
277 /* Return PK's keyid.  The memory is owned by PK.  */
278 u32 *
279 pk_keyid (PKT_public_key *pk)
280 {
281   keyid_from_pk (pk, NULL);
282
283   /* Uncomment this for help tracking down bugs related to keyid or
284      main_keyid not being set correctly.  */
285 #if 0
286   if (! (pk->main_keyid[0] || pk->main_keyid[1]))
287     log_bug ("pk->main_keyid not set!\n");
288   if (keyid_cmp (pk->keyid, pk->main_keyid) == 0
289       && ! pk->flags.primary)
290     log_bug ("keyid and main_keyid are the same, but primary flag not set!\n");
291   if (keyid_cmp (pk->keyid, pk->main_keyid) != 0
292       && pk->flags.primary)
293     log_bug ("keyid and main_keyid are different, but primary flag set!\n");
294 #endif
295
296   return pk->keyid;
297 }
298
299 /* Return the keyid of the primary key associated with PK.  The memory
300    is owned by PK.  */
301 u32 *
302 pk_main_keyid (PKT_public_key *pk)
303 {
304   /* Uncomment this for help tracking down bugs related to keyid or
305      main_keyid not being set correctly.  */
306 #if 0
307   if (! (pk->main_keyid[0] || pk->main_keyid[1]))
308     log_bug ("pk->main_keyid not set!\n");
309 #endif
310
311   return pk->main_keyid;
312 }
313
314 /* Copy the keyid in SRC to DEST and return DEST.  */
315 u32 *
316 keyid_copy (u32 *dest, const u32 *src)
317 {
318   dest[0] = src[0];
319   dest[1] = src[1];
320   return dest;
321 }
322
323 char *
324 format_keyid (u32 *keyid, int format, char *buffer, int len)
325 {
326   char tmp[KEYID_STR_SIZE];
327   if (! buffer)
328     {
329       buffer = tmp;
330       len = sizeof (tmp);
331     }
332
333   if (format == KF_DEFAULT)
334     format = opt.keyid_format;
335   if (format == KF_DEFAULT)
336     format = KF_NONE;
337
338   switch (format)
339     {
340     case KF_NONE:
341       if (len)
342         *buffer = 0;
343       break;
344
345     case KF_SHORT:
346       snprintf (buffer, len, "%08lX", (ulong)keyid[1]);
347       break;
348
349     case KF_LONG:
350       snprintf (buffer, len, "%08lX%08lX", (ulong)keyid[0], (ulong)keyid[1]);
351       break;
352
353     case KF_0xSHORT:
354       snprintf (buffer, len, "0x%08lX", (ulong)keyid[1]);
355       break;
356
357     case KF_0xLONG:
358       snprintf (buffer, len, "0x%08lX%08lX", (ulong)keyid[0],(ulong)keyid[1]);
359       break;
360
361     default:
362       BUG();
363     }
364
365   if (buffer == tmp)
366     return xstrdup (buffer);
367   return buffer;
368 }
369
370 size_t
371 keystrlen(void)
372 {
373   int format = opt.keyid_format;
374   if (format == KF_DEFAULT)
375     format = KF_NONE;
376
377   switch(format)
378     {
379     case KF_NONE:
380       return 0;
381
382     case KF_SHORT:
383       return 8;
384
385     case KF_LONG:
386       return 16;
387
388     case KF_0xSHORT:
389       return 10;
390
391     case KF_0xLONG:
392       return 18;
393
394     default:
395       BUG();
396     }
397 }
398
399
400 const char *
401 keystr (u32 *keyid)
402 {
403   static char keyid_str[KEYID_STR_SIZE];
404   int format = opt.keyid_format;
405
406   if (format == KF_NONE)
407     format = KF_LONG;
408
409   return format_keyid (keyid, format, keyid_str, sizeof (keyid_str));
410 }
411
412 /* This function returns the key id of the main and possible the
413  * subkey as one string.  It is used by error messages.  */
414 const char *
415 keystr_with_sub (u32 *main_kid, u32 *sub_kid)
416 {
417   static char buffer[KEYID_STR_SIZE+1+KEYID_STR_SIZE];
418   char *p;
419   int format = opt.keyid_format;
420
421   if (format == KF_NONE)
422     format = KF_LONG;
423
424   format_keyid (main_kid, format, buffer, KEYID_STR_SIZE);
425   if (sub_kid)
426     {
427       p = buffer + strlen (buffer);
428       *p++ = '/';
429       format_keyid (sub_kid, format, p, KEYID_STR_SIZE);
430     }
431   return buffer;
432 }
433
434
435 const char *
436 keystr_from_pk(PKT_public_key *pk)
437 {
438   keyid_from_pk(pk,NULL);
439
440   return keystr(pk->keyid);
441 }
442
443
444 const char *
445 keystr_from_pk_with_sub (PKT_public_key *main_pk, PKT_public_key *sub_pk)
446 {
447   keyid_from_pk (main_pk, NULL);
448   if (sub_pk)
449     keyid_from_pk (sub_pk, NULL);
450
451   return keystr_with_sub (main_pk->keyid, sub_pk? sub_pk->keyid:NULL);
452 }
453
454
455 /* Return PK's key id as a string using the default format.  PK owns
456    the storage.  */
457 const char *
458 pk_keyid_str (PKT_public_key *pk)
459 {
460   return keystr (pk_keyid (pk));
461 }
462
463
464 const char *
465 keystr_from_desc(KEYDB_SEARCH_DESC *desc)
466 {
467   switch(desc->mode)
468     {
469     case KEYDB_SEARCH_MODE_LONG_KID:
470     case KEYDB_SEARCH_MODE_SHORT_KID:
471       return keystr(desc->u.kid);
472
473     case KEYDB_SEARCH_MODE_FPR20:
474       {
475         u32 keyid[2];
476
477         keyid[0] = buf32_to_u32 (desc->u.fpr+12);
478         keyid[1] = buf32_to_u32 (desc->u.fpr+16);
479         return keystr(keyid);
480       }
481
482     case KEYDB_SEARCH_MODE_FPR16:
483       return "?v3 fpr?";
484
485     default:
486       BUG();
487     }
488 }
489
490
491 /*
492  * Get the keyid from the public key and put it into keyid
493  * if this is not NULL. Return the 32 low bits of the keyid.
494  */
495 u32
496 keyid_from_pk (PKT_public_key *pk, u32 *keyid)
497 {
498   u32 lowbits;
499   u32 dummy_keyid[2];
500
501   if (!keyid)
502     keyid = dummy_keyid;
503
504   if( pk->keyid[0] || pk->keyid[1] )
505     {
506       keyid[0] = pk->keyid[0];
507       keyid[1] = pk->keyid[1];
508       lowbits = keyid[1];
509     }
510   else
511     {
512       const byte *dp;
513       gcry_md_hd_t md;
514
515       md = do_fingerprint_md(pk);
516       if(md)
517         {
518           dp = gcry_md_read ( md, 0 );
519           keyid[0] = buf32_to_u32 (dp+12);
520           keyid[1] = buf32_to_u32 (dp+16);
521           lowbits = keyid[1];
522           gcry_md_close (md);
523           pk->keyid[0] = keyid[0];
524           pk->keyid[1] = keyid[1];
525         }
526       else
527         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0xFFFFFFFF;
528     }
529
530   return lowbits;
531 }
532
533
534 /*
535  * Get the keyid from the fingerprint.  This function is simple for most
536  * keys, but has to do a keylookup for old stayle keys.
537  */
538 u32
539 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid )
540 {
541   u32 dummy_keyid[2];
542
543   if( !keyid )
544     keyid = dummy_keyid;
545
546   if (fprint_len != 20)
547     {
548       /* This is special as we have to lookup the key first.  */
549       PKT_public_key pk;
550       int rc;
551
552       memset (&pk, 0, sizeof pk);
553       rc = get_pubkey_byfprint (&pk, NULL, fprint, fprint_len);
554       if( rc )
555         {
556           log_error("Oops: keyid_from_fingerprint: no pubkey\n");
557           keyid[0] = 0;
558           keyid[1] = 0;
559         }
560       else
561         keyid_from_pk (&pk, keyid);
562     }
563   else
564     {
565       const byte *dp = fprint;
566       keyid[0] = buf32_to_u32 (dp+12);
567       keyid[1] = buf32_to_u32 (dp+16);
568     }
569
570   return keyid[1];
571 }
572
573
574 u32
575 keyid_from_sig (PKT_signature *sig, u32 *keyid)
576 {
577   if( keyid )
578     {
579       keyid[0] = sig->keyid[0];
580       keyid[1] = sig->keyid[1];
581     }
582   return sig->keyid[1];
583 }
584
585
586 byte *
587 namehash_from_uid (PKT_user_id *uid)
588 {
589   if (!uid->namehash)
590     {
591       uid->namehash = xmalloc (20);
592
593       if (uid->attrib_data)
594         rmd160_hash_buffer (uid->namehash, uid->attrib_data, uid->attrib_len);
595       else
596         rmd160_hash_buffer (uid->namehash, uid->name, uid->len);
597     }
598
599   return uid->namehash;
600 }
601
602
603 /*
604  * Return the number of bits used in PK.
605  */
606 unsigned int
607 nbits_from_pk (PKT_public_key *pk)
608 {
609     return pubkey_nbits (pk->pubkey_algo, pk->pkey);
610 }
611
612
613 static const char *
614 mk_datestr (char *buffer, time_t atime)
615 {
616   struct tm *tp;
617
618   if (IS_INVALID_TIME_T (atime))
619     strcpy (buffer, "????" "-??" "-??"); /* Mark this as invalid. */
620   else
621     {
622       tp = gmtime (&atime);
623       sprintf (buffer,"%04d-%02d-%02d",
624                1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
625     }
626   return buffer;
627 }
628
629
630 /*
631  * return a string with the creation date of the pk
632  * Note: this is alloced in a static buffer.
633  *    Format is: yyyy-mm-dd
634  */
635 const char *
636 datestr_from_pk (PKT_public_key *pk)
637 {
638   static char buffer[11+5];
639   time_t atime = pk->timestamp;
640
641   return mk_datestr (buffer, atime);
642 }
643
644
645 const char *
646 datestr_from_sig (PKT_signature *sig )
647 {
648   static char buffer[11+5];
649   time_t atime = sig->timestamp;
650
651   return mk_datestr (buffer, atime);
652 }
653
654
655 const char *
656 expirestr_from_pk (PKT_public_key *pk)
657 {
658   static char buffer[11+5];
659   time_t atime;
660
661   if (!pk->expiredate)
662     return _("never     ");
663   atime = pk->expiredate;
664   return mk_datestr (buffer, atime);
665 }
666
667
668 const char *
669 expirestr_from_sig (PKT_signature *sig)
670 {
671   static char buffer[11+5];
672   time_t atime;
673
674   if (!sig->expiredate)
675     return _("never     ");
676   atime=sig->expiredate;
677   return mk_datestr (buffer, atime);
678 }
679
680
681 const char *
682 revokestr_from_pk( PKT_public_key *pk )
683 {
684   static char buffer[11+5];
685   time_t atime;
686
687   if(!pk->revoked.date)
688     return _("never     ");
689   atime=pk->revoked.date;
690   return mk_datestr (buffer, atime);
691 }
692
693
694 const char *
695 usagestr_from_pk (PKT_public_key *pk, int fill)
696 {
697   static char buffer[10];
698   int i = 0;
699   unsigned int use = pk->pubkey_usage;
700
701   if ( use & PUBKEY_USAGE_SIG )
702     buffer[i++] = 'S';
703
704   if ( use & PUBKEY_USAGE_CERT )
705     buffer[i++] = 'C';
706
707   if ( use & PUBKEY_USAGE_ENC )
708     buffer[i++] = 'E';
709
710   if ( (use & PUBKEY_USAGE_AUTH) )
711     buffer[i++] = 'A';
712
713   while (fill && i < 4)
714     buffer[i++] = ' ';
715
716   buffer[i] = 0;
717   return buffer;
718 }
719
720
721 const char *
722 colon_strtime (u32 t)
723 {
724   static char buf[20];
725
726   if (!t)
727     return "";
728   snprintf (buf, sizeof buf, "%lu", (ulong)t);
729   return buf;
730 }
731
732 const char *
733 colon_datestr_from_pk (PKT_public_key *pk)
734 {
735   static char buf[20];
736
737   snprintf (buf, sizeof buf, "%lu", (ulong)pk->timestamp);
738   return buf;
739 }
740
741
742 const char *
743 colon_datestr_from_sig (PKT_signature *sig)
744 {
745   static char buf[20];
746
747   snprintf (buf, sizeof buf, "%lu", (ulong)sig->timestamp);
748   return buf;
749 }
750
751 const char *
752 colon_expirestr_from_sig (PKT_signature *sig)
753 {
754   static char buf[20];
755
756   if (!sig->expiredate)
757     return "";
758
759   snprintf (buf, sizeof buf,"%lu", (ulong)sig->expiredate);
760   return buf;
761 }
762
763
764 /*
765  * Return a byte array with the fingerprint for the given PK/SK
766  * The length of the array is returned in ret_len. Caller must free
767  * the array or provide an array of length MAX_FINGERPRINT_LEN.
768  */
769 byte *
770 fingerprint_from_pk (PKT_public_key *pk, byte *array, size_t *ret_len)
771 {
772   const byte *dp;
773   size_t len;
774   gcry_md_hd_t md;
775
776   md = do_fingerprint_md(pk);
777   dp = gcry_md_read( md, 0 );
778   len = gcry_md_get_algo_dlen (gcry_md_get_algo (md));
779   log_assert( len <= MAX_FINGERPRINT_LEN );
780   if (!array)
781     array = xmalloc ( len );
782   memcpy (array, dp, len );
783   pk->keyid[0] = buf32_to_u32 (dp+12);
784   pk->keyid[1] = buf32_to_u32 (dp+16);
785   gcry_md_close( md);
786
787   if (ret_len)
788     *ret_len = len;
789   return array;
790 }
791
792
793 /* Return an allocated buffer with the fingerprint of PK formatted as
794    a plain hexstring.  If BUFFER is NULL the result is a malloc'd
795    string.  If BUFFER is not NULL the result will be copied into this
796    buffer.  In the latter case BUFLEN describes the length of the
797    buffer; if this is too short the function terminates the process.
798    Returns a malloc'ed string or BUFFER.  A suitable length for BUFFER
799    is (2*MAX_FINGERPRINT_LEN + 1). */
800 char *
801 hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen)
802 {
803   unsigned char fpr[MAX_FINGERPRINT_LEN];
804   size_t len;
805
806   fingerprint_from_pk (pk, fpr, &len);
807   if (!buffer)
808     buffer = xmalloc (2 * len + 1);
809   else if (buflen < 2*len+1)
810     log_fatal ("%s: buffer too short (%zu)\n", __func__, buflen);
811   bin2hex (fpr, len, buffer);
812   return buffer;
813 }
814
815
816 /* Pretty print a hex fingerprint.  If BUFFER is NULL the result is a
817    malloc'd string.  If BUFFER is not NULL the result will be copied
818    into this buffer.  In the latter case BUFLEN describes the length
819    of the buffer; if this is too short the function terminates the
820    process.  Returns a malloc'ed string or BUFFER.  A suitable length
821    for BUFFER is (MAX_FORMATTED_FINGERPRINT_LEN + 1).  */
822 char *
823 format_hexfingerprint (const char *fingerprint, char *buffer, size_t buflen)
824 {
825   int hexlen = strlen (fingerprint);
826   int space;
827   int i, j;
828
829   if (hexlen == 40)  /* v4 fingerprint */
830     {
831       space = (/* The characters and the NUL.  */
832                40 + 1
833                /* After every fourth character, we add a space (except
834                   the last).  */
835                + 40 / 4 - 1
836                /* Half way through we add a second space.  */
837                + 1);
838     }
839   else  /* Other fingerprint versions - print as is.  */
840     {
841       space = hexlen + 1;
842     }
843
844   if (!buffer)
845     buffer = xmalloc (space);
846   else if (buflen < space)
847     log_fatal ("%s: buffer too short (%zu)\n", __func__, buflen);
848
849   if (hexlen == 40)  /* v4 fingerprint */
850     {
851       for (i = 0, j = 0; i < 40; i ++)
852         {
853           if (i && i % 4 == 0)
854             buffer[j ++] = ' ';
855           if (i == 40 / 2)
856             buffer[j ++] = ' ';
857
858           buffer[j ++] = fingerprint[i];
859         }
860       buffer[j ++] = 0;
861       log_assert (j == space);
862     }
863   else
864     {
865       strcpy (buffer, fingerprint);
866     }
867
868   return buffer;
869 }
870
871
872 \f
873 /* Return the so called KEYGRIP which is the SHA-1 hash of the public
874    key parameters expressed as an canoncial encoded S-Exp.  ARRAY must
875    be 20 bytes long.  Returns 0 on success or an error code.  */
876 gpg_error_t
877 keygrip_from_pk (PKT_public_key *pk, unsigned char *array)
878 {
879   gpg_error_t err;
880   gcry_sexp_t s_pkey;
881
882   if (DBG_PACKET)
883     log_debug ("get_keygrip for public key\n");
884
885   switch (pk->pubkey_algo)
886     {
887     case GCRY_PK_DSA:
888       err = gcry_sexp_build (&s_pkey, NULL,
889                              "(public-key(dsa(p%m)(q%m)(g%m)(y%m)))",
890                              pk->pkey[0], pk->pkey[1],
891                              pk->pkey[2], pk->pkey[3]);
892       break;
893
894     case GCRY_PK_ELG:
895     case GCRY_PK_ELG_E:
896       err = gcry_sexp_build (&s_pkey, NULL,
897                              "(public-key(elg(p%m)(g%m)(y%m)))",
898                              pk->pkey[0], pk->pkey[1], pk->pkey[2]);
899       break;
900
901     case GCRY_PK_RSA:
902     case GCRY_PK_RSA_S:
903     case GCRY_PK_RSA_E:
904       err = gcry_sexp_build (&s_pkey, NULL,
905                              "(public-key(rsa(n%m)(e%m)))",
906                              pk->pkey[0], pk->pkey[1]);
907       break;
908
909     case PUBKEY_ALGO_EDDSA:
910     case PUBKEY_ALGO_ECDSA:
911     case PUBKEY_ALGO_ECDH:
912       {
913         char *curve = openpgp_oid_to_str (pk->pkey[0]);
914         if (!curve)
915           err = gpg_error_from_syserror ();
916         else
917           {
918             err = gcry_sexp_build (&s_pkey, NULL,
919                                    pk->pubkey_algo == PUBKEY_ALGO_EDDSA?
920                                    "(public-key(ecc(curve%s)(flags eddsa)(q%m)))":
921                                    (pk->pubkey_algo == PUBKEY_ALGO_ECDH
922                                     && openpgp_oid_is_crv25519 (pk->pkey[0]))?
923                                    "(public-key(ecc(curve%s)(flags djb-tweak)(q%m)))":
924                                    "(public-key(ecc(curve%s)(q%m)))",
925                                    curve, pk->pkey[1]);
926             xfree (curve);
927           }
928       }
929       break;
930
931     default:
932       err = gpg_error (GPG_ERR_PUBKEY_ALGO);
933       break;
934     }
935
936   if (err)
937     return err;
938
939   if (!gcry_pk_get_keygrip (s_pkey, array))
940     {
941       log_info ("error computing keygrip\n");
942       memset (array, 0, 20);
943       err = gpg_error (GPG_ERR_GENERAL);
944     }
945   else
946     {
947       if (DBG_PACKET)
948         log_printhex ("keygrip=", array, 20);
949       /* FIXME: Save the keygrip in PK.  */
950     }
951   gcry_sexp_release (s_pkey);
952
953   return err;
954 }
955
956
957 /* Store an allocated buffer with the keygrip of PK encoded as a
958    hexstring at r_GRIP.  Returns 0 on success.  */
959 gpg_error_t
960 hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip)
961 {
962   gpg_error_t err;
963   unsigned char grip[20];
964
965   *r_grip = NULL;
966   err = keygrip_from_pk (pk, grip);
967   if (!err)
968     {
969       char * buf = xtrymalloc (20*2+1);
970       if (!buf)
971         err = gpg_error_from_syserror ();
972       else
973         {
974           bin2hex (grip, 20, buf);
975           *r_grip = buf;
976         }
977     }
978   return err;
979 }