gpg: Implement --keyid-format=none.
[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_SHORT;
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       if (keyid[0])
351         snprintf (buffer, len, "%08lX%08lX",
352                   (ulong)keyid[0], (ulong)keyid[1]);
353       else
354         snprintf (buffer, len, "%08lX", (ulong)keyid[1]);
355       break;
356
357     case KF_0xSHORT:
358       snprintf (buffer, len, "0x%08lX", (ulong)keyid[1]);
359       break;
360
361     case KF_0xLONG:
362       if(keyid[0])
363         snprintf (buffer, len, "0x%08lX%08lX",
364                   (ulong)keyid[0],(ulong)keyid[1]);
365       else
366         snprintf (buffer, len, "0x%08lX", (ulong)keyid[1]);
367       break;
368
369     default:
370       BUG();
371     }
372
373   if (buffer == tmp)
374     return xstrdup (buffer);
375   return buffer;
376 }
377
378 size_t
379 keystrlen(void)
380 {
381   int format = opt.keyid_format;
382   if (format == KF_DEFAULT)
383     format = KF_SHORT;
384
385   switch(format)
386     {
387     case KF_SHORT:
388       return 8;
389
390     case KF_LONG:
391       return 16;
392
393     case KF_0xSHORT:
394       return 10;
395
396     case KF_0xLONG:
397       return 18;
398
399     default:
400       BUG();
401     }
402 }
403
404
405 const char *
406 keystr (u32 *keyid)
407 {
408   static char keyid_str[KEYID_STR_SIZE];
409   int format = opt.keyid_format;
410
411   if (format == KF_NONE)
412     format = KF_LONG;
413
414   return format_keyid (keyid, format, keyid_str, sizeof (keyid_str));
415 }
416
417 /* This function returns the key id of the main and possible the
418  * subkey as one string.  It is used by error messages.  */
419 const char *
420 keystr_with_sub (u32 *main_kid, u32 *sub_kid)
421 {
422   static char buffer[KEYID_STR_SIZE+1+KEYID_STR_SIZE];
423   char *p;
424   int format = opt.keyid_format;
425
426   if (format == KF_NONE)
427     format = KF_LONG;
428
429   format_keyid (main_kid, format, buffer, KEYID_STR_SIZE);
430   if (sub_kid)
431     {
432       p = buffer + strlen (buffer);
433       *p++ = '/';
434       format_keyid (sub_kid, format, p, KEYID_STR_SIZE);
435     }
436   return buffer;
437 }
438
439
440 const char *
441 keystr_from_pk(PKT_public_key *pk)
442 {
443   keyid_from_pk(pk,NULL);
444
445   return keystr(pk->keyid);
446 }
447
448
449 const char *
450 keystr_from_pk_with_sub (PKT_public_key *main_pk, PKT_public_key *sub_pk)
451 {
452   keyid_from_pk (main_pk, NULL);
453   if (sub_pk)
454     keyid_from_pk (sub_pk, NULL);
455
456   return keystr_with_sub (main_pk->keyid, sub_pk? sub_pk->keyid:NULL);
457 }
458
459
460 /* Return PK's key id as a string using the default format.  PK owns
461    the storage.  */
462 const char *
463 pk_keyid_str (PKT_public_key *pk)
464 {
465   return keystr (pk_keyid (pk));
466 }
467
468
469 const char *
470 keystr_from_desc(KEYDB_SEARCH_DESC *desc)
471 {
472   switch(desc->mode)
473     {
474     case KEYDB_SEARCH_MODE_LONG_KID:
475     case KEYDB_SEARCH_MODE_SHORT_KID:
476       return keystr(desc->u.kid);
477
478     case KEYDB_SEARCH_MODE_FPR20:
479       {
480         u32 keyid[2];
481
482         keyid[0] = buf32_to_u32 (desc->u.fpr+12);
483         keyid[1] = buf32_to_u32 (desc->u.fpr+16);
484         return keystr(keyid);
485       }
486
487     case KEYDB_SEARCH_MODE_FPR16:
488       return "?v3 fpr?";
489
490     default:
491       BUG();
492     }
493 }
494
495
496 /*
497  * Get the keyid from the public key and put it into keyid
498  * if this is not NULL. Return the 32 low bits of the keyid.
499  */
500 u32
501 keyid_from_pk (PKT_public_key *pk, u32 *keyid)
502 {
503   u32 lowbits;
504   u32 dummy_keyid[2];
505
506   if (!keyid)
507     keyid = dummy_keyid;
508
509   if( pk->keyid[0] || pk->keyid[1] )
510     {
511       keyid[0] = pk->keyid[0];
512       keyid[1] = pk->keyid[1];
513       lowbits = keyid[1];
514     }
515   else
516     {
517       const byte *dp;
518       gcry_md_hd_t md;
519
520       md = do_fingerprint_md(pk);
521       if(md)
522         {
523           dp = gcry_md_read ( md, 0 );
524           keyid[0] = buf32_to_u32 (dp+12);
525           keyid[1] = buf32_to_u32 (dp+16);
526           lowbits = keyid[1];
527           gcry_md_close (md);
528           pk->keyid[0] = keyid[0];
529           pk->keyid[1] = keyid[1];
530         }
531       else
532         pk->keyid[0]=pk->keyid[1]=keyid[0]=keyid[1]=lowbits=0xFFFFFFFF;
533     }
534
535   return lowbits;
536 }
537
538
539 /*
540  * Get the keyid from the fingerprint.  This function is simple for most
541  * keys, but has to do a keylookup for old stayle keys.
542  */
543 u32
544 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid )
545 {
546   u32 dummy_keyid[2];
547
548   if( !keyid )
549     keyid = dummy_keyid;
550
551   if (fprint_len != 20)
552     {
553       /* This is special as we have to lookup the key first.  */
554       PKT_public_key pk;
555       int rc;
556
557       memset (&pk, 0, sizeof pk);
558       rc = get_pubkey_byfprint (&pk, NULL, fprint, fprint_len);
559       if( rc )
560         {
561           log_error("Oops: keyid_from_fingerprint: no pubkey\n");
562           keyid[0] = 0;
563           keyid[1] = 0;
564         }
565       else
566         keyid_from_pk (&pk, keyid);
567     }
568   else
569     {
570       const byte *dp = fprint;
571       keyid[0] = buf32_to_u32 (dp+12);
572       keyid[1] = buf32_to_u32 (dp+16);
573     }
574
575   return keyid[1];
576 }
577
578
579 u32
580 keyid_from_sig (PKT_signature *sig, u32 *keyid)
581 {
582   if( keyid )
583     {
584       keyid[0] = sig->keyid[0];
585       keyid[1] = sig->keyid[1];
586     }
587   return sig->keyid[1];
588 }
589
590
591 byte *
592 namehash_from_uid (PKT_user_id *uid)
593 {
594   if (!uid->namehash)
595     {
596       uid->namehash = xmalloc (20);
597
598       if (uid->attrib_data)
599         rmd160_hash_buffer (uid->namehash, uid->attrib_data, uid->attrib_len);
600       else
601         rmd160_hash_buffer (uid->namehash, uid->name, uid->len);
602     }
603
604   return uid->namehash;
605 }
606
607
608 /*
609  * Return the number of bits used in PK.
610  */
611 unsigned int
612 nbits_from_pk (PKT_public_key *pk)
613 {
614     return pubkey_nbits (pk->pubkey_algo, pk->pkey);
615 }
616
617
618 static const char *
619 mk_datestr (char *buffer, time_t atime)
620 {
621   struct tm *tp;
622
623   if (IS_INVALID_TIME_T (atime))
624     strcpy (buffer, "????" "-??" "-??"); /* Mark this as invalid. */
625   else
626     {
627       tp = gmtime (&atime);
628       sprintf (buffer,"%04d-%02d-%02d",
629                1900+tp->tm_year, tp->tm_mon+1, tp->tm_mday );
630     }
631   return buffer;
632 }
633
634
635 /*
636  * return a string with the creation date of the pk
637  * Note: this is alloced in a static buffer.
638  *    Format is: yyyy-mm-dd
639  */
640 const char *
641 datestr_from_pk (PKT_public_key *pk)
642 {
643   static char buffer[11+5];
644   time_t atime = pk->timestamp;
645
646   return mk_datestr (buffer, atime);
647 }
648
649
650 const char *
651 datestr_from_sig (PKT_signature *sig )
652 {
653   static char buffer[11+5];
654   time_t atime = sig->timestamp;
655
656   return mk_datestr (buffer, atime);
657 }
658
659
660 const char *
661 expirestr_from_pk (PKT_public_key *pk)
662 {
663   static char buffer[11+5];
664   time_t atime;
665
666   if (!pk->expiredate)
667     return _("never     ");
668   atime = pk->expiredate;
669   return mk_datestr (buffer, atime);
670 }
671
672
673 const char *
674 expirestr_from_sig (PKT_signature *sig)
675 {
676   static char buffer[11+5];
677   time_t atime;
678
679   if (!sig->expiredate)
680     return _("never     ");
681   atime=sig->expiredate;
682   return mk_datestr (buffer, atime);
683 }
684
685
686 const char *
687 revokestr_from_pk( PKT_public_key *pk )
688 {
689   static char buffer[11+5];
690   time_t atime;
691
692   if(!pk->revoked.date)
693     return _("never     ");
694   atime=pk->revoked.date;
695   return mk_datestr (buffer, atime);
696 }
697
698
699 const char *
700 usagestr_from_pk (PKT_public_key *pk, int fill)
701 {
702   static char buffer[10];
703   int i = 0;
704   unsigned int use = pk->pubkey_usage;
705
706   if ( use & PUBKEY_USAGE_SIG )
707     buffer[i++] = 'S';
708
709   if ( use & PUBKEY_USAGE_CERT )
710     buffer[i++] = 'C';
711
712   if ( use & PUBKEY_USAGE_ENC )
713     buffer[i++] = 'E';
714
715   if ( (use & PUBKEY_USAGE_AUTH) )
716     buffer[i++] = 'A';
717
718   while (fill && i < 4)
719     buffer[i++] = ' ';
720
721   buffer[i] = 0;
722   return buffer;
723 }
724
725
726 const char *
727 colon_strtime (u32 t)
728 {
729   static char buf[20];
730
731   if (!t)
732     return "";
733   snprintf (buf, sizeof buf, "%lu", (ulong)t);
734   return buf;
735 }
736
737 const char *
738 colon_datestr_from_pk (PKT_public_key *pk)
739 {
740   static char buf[20];
741
742   snprintf (buf, sizeof buf, "%lu", (ulong)pk->timestamp);
743   return buf;
744 }
745
746
747 const char *
748 colon_datestr_from_sig (PKT_signature *sig)
749 {
750   static char buf[20];
751
752   snprintf (buf, sizeof buf, "%lu", (ulong)sig->timestamp);
753   return buf;
754 }
755
756 const char *
757 colon_expirestr_from_sig (PKT_signature *sig)
758 {
759   static char buf[20];
760
761   if (!sig->expiredate)
762     return "";
763
764   snprintf (buf, sizeof buf,"%lu", (ulong)sig->expiredate);
765   return buf;
766 }
767
768
769 /*
770  * Return a byte array with the fingerprint for the given PK/SK
771  * The length of the array is returned in ret_len. Caller must free
772  * the array or provide an array of length MAX_FINGERPRINT_LEN.
773  */
774 byte *
775 fingerprint_from_pk (PKT_public_key *pk, byte *array, size_t *ret_len)
776 {
777   const byte *dp;
778   size_t len;
779   gcry_md_hd_t md;
780
781   md = do_fingerprint_md(pk);
782   dp = gcry_md_read( md, 0 );
783   len = gcry_md_get_algo_dlen (gcry_md_get_algo (md));
784   log_assert( len <= MAX_FINGERPRINT_LEN );
785   if (!array)
786     array = xmalloc ( len );
787   memcpy (array, dp, len );
788   pk->keyid[0] = buf32_to_u32 (dp+12);
789   pk->keyid[1] = buf32_to_u32 (dp+16);
790   gcry_md_close( md);
791
792   if (ret_len)
793     *ret_len = len;
794   return array;
795 }
796
797
798 /* Return an allocated buffer with the fingerprint of PK formatted as
799    a plain hexstring.  If BUFFER is NULL the result is a malloc'd
800    string.  If BUFFER is not NULL the result will be copied into this
801    buffer.  In the latter case BUFLEN describes the length of the
802    buffer; if this is too short the function terminates the process.
803    Returns a malloc'ed string or BUFFER.  A suitable length for BUFFER
804    is (2*MAX_FINGERPRINT_LEN + 1). */
805 char *
806 hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen)
807 {
808   unsigned char fpr[MAX_FINGERPRINT_LEN];
809   size_t len;
810
811   fingerprint_from_pk (pk, fpr, &len);
812   if (!buffer)
813     buffer = xmalloc (2 * len + 1);
814   else if (buflen < 2*len+1)
815     log_fatal ("%s: buffer too short (%zu)\n", __func__, buflen);
816   bin2hex (fpr, len, buffer);
817   return buffer;
818 }
819
820
821 /* Pretty print a hex fingerprint.  If BUFFER is NULL the result is a
822    malloc'd string.  If BUFFER is not NULL the result will be copied
823    into this buffer.  In the latter case BUFLEN describes the length
824    of the buffer; if this is too short the function terminates the
825    process.  Returns a malloc'ed string or BUFFER.  A suitable length
826    for BUFFER is (MAX_FORMATTED_FINGERPRINT_LEN + 1).  */
827 char *
828 format_hexfingerprint (const char *fingerprint, char *buffer, size_t buflen)
829 {
830   int hexlen = strlen (fingerprint);
831   int space;
832   int i, j;
833
834   if (hexlen == 40)  /* v4 fingerprint */
835     {
836       space = (/* The characters and the NUL.  */
837                40 + 1
838                /* After every fourth character, we add a space (except
839                   the last).  */
840                + 40 / 4 - 1
841                /* Half way through we add a second space.  */
842                + 1);
843     }
844   else  /* Other fingerprint versions - print as is.  */
845     {
846       space = hexlen + 1;
847     }
848
849   if (!buffer)
850     buffer = xmalloc (space);
851   else if (buflen < space)
852     log_fatal ("%s: buffer too short (%zu)\n", __func__, buflen);
853
854   if (hexlen == 40)  /* v4 fingerprint */
855     {
856       for (i = 0, j = 0; i < 40; i ++)
857         {
858           if (i && i % 4 == 0)
859             buffer[j ++] = ' ';
860           if (i == 40 / 2)
861             buffer[j ++] = ' ';
862
863           buffer[j ++] = fingerprint[i];
864         }
865       buffer[j ++] = 0;
866       log_assert (j == space);
867     }
868   else
869     {
870       strcpy (buffer, fingerprint);
871     }
872
873   return buffer;
874 }
875
876
877 \f
878 /* Return the so called KEYGRIP which is the SHA-1 hash of the public
879    key parameters expressed as an canoncial encoded S-Exp.  ARRAY must
880    be 20 bytes long.  Returns 0 on success or an error code.  */
881 gpg_error_t
882 keygrip_from_pk (PKT_public_key *pk, unsigned char *array)
883 {
884   gpg_error_t err;
885   gcry_sexp_t s_pkey;
886
887   if (DBG_PACKET)
888     log_debug ("get_keygrip for public key\n");
889
890   switch (pk->pubkey_algo)
891     {
892     case GCRY_PK_DSA:
893       err = gcry_sexp_build (&s_pkey, NULL,
894                              "(public-key(dsa(p%m)(q%m)(g%m)(y%m)))",
895                              pk->pkey[0], pk->pkey[1],
896                              pk->pkey[2], pk->pkey[3]);
897       break;
898
899     case GCRY_PK_ELG:
900     case GCRY_PK_ELG_E:
901       err = gcry_sexp_build (&s_pkey, NULL,
902                              "(public-key(elg(p%m)(g%m)(y%m)))",
903                              pk->pkey[0], pk->pkey[1], pk->pkey[2]);
904       break;
905
906     case GCRY_PK_RSA:
907     case GCRY_PK_RSA_S:
908     case GCRY_PK_RSA_E:
909       err = gcry_sexp_build (&s_pkey, NULL,
910                              "(public-key(rsa(n%m)(e%m)))",
911                              pk->pkey[0], pk->pkey[1]);
912       break;
913
914     case PUBKEY_ALGO_EDDSA:
915     case PUBKEY_ALGO_ECDSA:
916     case PUBKEY_ALGO_ECDH:
917       {
918         char *curve = openpgp_oid_to_str (pk->pkey[0]);
919         if (!curve)
920           err = gpg_error_from_syserror ();
921         else
922           {
923             err = gcry_sexp_build (&s_pkey, NULL,
924                                    pk->pubkey_algo == PUBKEY_ALGO_EDDSA?
925                                    "(public-key(ecc(curve%s)(flags eddsa)(q%m)))":
926                                    (pk->pubkey_algo == PUBKEY_ALGO_ECDH
927                                     && openpgp_oid_is_crv25519 (pk->pkey[0]))?
928                                    "(public-key(ecc(curve%s)(flags djb-tweak)(q%m)))":
929                                    "(public-key(ecc(curve%s)(q%m)))",
930                                    curve, pk->pkey[1]);
931             xfree (curve);
932           }
933       }
934       break;
935
936     default:
937       err = gpg_error (GPG_ERR_PUBKEY_ALGO);
938       break;
939     }
940
941   if (err)
942     return err;
943
944   if (!gcry_pk_get_keygrip (s_pkey, array))
945     {
946       log_info ("error computing keygrip\n");
947       memset (array, 0, 20);
948       err = gpg_error (GPG_ERR_GENERAL);
949     }
950   else
951     {
952       if (DBG_PACKET)
953         log_printhex ("keygrip=", array, 20);
954       /* FIXME: Save the keygrip in PK.  */
955     }
956   gcry_sexp_release (s_pkey);
957
958   return err;
959 }
960
961
962 /* Store an allocated buffer with the keygrip of PK encoded as a
963    hexstring at r_GRIP.  Returns 0 on success.  */
964 gpg_error_t
965 hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip)
966 {
967   gpg_error_t err;
968   unsigned char grip[20];
969
970   *r_grip = NULL;
971   err = keygrip_from_pk (pk, grip);
972   if (!err)
973     {
974       char * buf = xtrymalloc (20*2+1);
975       if (!buf)
976         err = gpg_error_from_syserror ();
977       else
978         {
979           bin2hex (grip, 20, buf);
980           *r_grip = buf;
981         }
982     }
983   return err;
984 }