agent: PKSIGN should return signature in same format for card.
[gnupg.git] / agent / pksign.c
1 /* pksign.c - public key signing (well, actually using a secret key)
2  * Copyright (C) 2001-2004, 2010 Free Software Foundation, Inc.
3  * Copyright (C) 2001-2004, 2010, 2013  Werner Koch
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 3 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, see <https://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <errno.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <ctype.h>
27 #include <assert.h>
28 #include <unistd.h>
29 #include <sys/stat.h>
30
31 #include "agent.h"
32 #include "../common/i18n.h"
33
34
35 static int
36 do_encode_md (const byte * md, size_t mdlen, int algo, gcry_sexp_t * r_hash,
37               int raw_value)
38 {
39   gcry_sexp_t hash;
40   int rc;
41
42   if (!raw_value)
43     {
44       const char *s;
45       char tmp[16+1];
46       int i;
47
48       s = gcry_md_algo_name (algo);
49       if (s && strlen (s) < 16)
50         {
51           for (i=0; i < strlen (s); i++)
52             tmp[i] = tolower (s[i]);
53           tmp[i] = '\0';
54         }
55
56       rc = gcry_sexp_build (&hash, NULL,
57                             "(data (flags pkcs1) (hash %s %b))",
58                             tmp, (int)mdlen, md);
59     }
60   else
61     {
62       gcry_mpi_t mpi;
63
64       rc = gcry_mpi_scan (&mpi, GCRYMPI_FMT_USG, md, mdlen, NULL);
65       if (!rc)
66         {
67           rc = gcry_sexp_build (&hash, NULL,
68                                 "(data (flags raw) (value %m))",
69                                 mpi);
70           gcry_mpi_release (mpi);
71         }
72       else
73         hash = NULL;
74
75     }
76
77   *r_hash = hash;
78   return rc;
79 }
80
81
82 /* Return the number of bits of the Q parameter from the DSA key
83    KEY.  */
84 static unsigned int
85 get_dsa_qbits (gcry_sexp_t key)
86 {
87   gcry_sexp_t l1, l2;
88   gcry_mpi_t q;
89   unsigned int nbits;
90
91   l1 = gcry_sexp_find_token (key, "private-key", 0);
92   if (!l1)
93     l1 = gcry_sexp_find_token (key, "protected-private-key", 0);
94   if (!l1)
95     l1 = gcry_sexp_find_token (key, "shadowed-private-key", 0);
96   if (!l1)
97     l1 = gcry_sexp_find_token (key, "public-key", 0);
98   if (!l1)
99     return 0; /* Does not contain a key object.  */
100   l2 = gcry_sexp_cadr (l1);
101   gcry_sexp_release  (l1);
102   l1 = gcry_sexp_find_token (l2, "q", 1);
103   gcry_sexp_release (l2);
104   if (!l1)
105     return 0; /* Invalid object.  */
106   q = gcry_sexp_nth_mpi (l1, 1, GCRYMPI_FMT_USG);
107   gcry_sexp_release (l1);
108   if (!q)
109     return 0; /* Missing value.  */
110   nbits = gcry_mpi_get_nbits (q);
111   gcry_mpi_release (q);
112
113   return nbits;
114 }
115
116
117 /* Return an appropriate hash algorithm to be used with RFC-6979 for a
118    message digest of length MDLEN.  Although a fallback of SHA-256 is
119    used the current implementation in Libgcrypt will reject a hash
120    algorithm which does not match the length of the message.  */
121 static const char *
122 rfc6979_hash_algo_string (size_t mdlen)
123 {
124   switch (mdlen)
125     {
126     case 20: return "sha1";
127     case 28: return "sha224";
128     case 32: return "sha256";
129     case 48: return "sha384";
130     case 64: return "sha512";
131     default: return "sha256";
132     }
133 }
134
135
136 /* Encode a message digest for use with the EdDSA algorithm
137    (i.e. curve Ed25519). */
138 static gpg_error_t
139 do_encode_eddsa (const byte *md, size_t mdlen, gcry_sexp_t *r_hash)
140 {
141   gpg_error_t err;
142   gcry_sexp_t hash;
143
144   *r_hash = NULL;
145   err = gcry_sexp_build (&hash, NULL,
146                          "(data(flags eddsa)(hash-algo sha512)(value %b))",
147                          (int)mdlen, md);
148   if (!err)
149     *r_hash = hash;
150   return err;
151 }
152
153
154 /* Encode a message digest for use with an DSA algorithm. */
155 static gpg_error_t
156 do_encode_dsa (const byte *md, size_t mdlen, int pkalgo, gcry_sexp_t pkey,
157                gcry_sexp_t *r_hash)
158 {
159   gpg_error_t err;
160   gcry_sexp_t hash;
161   unsigned int qbits;
162
163   *r_hash = NULL;
164
165   if (pkalgo == GCRY_PK_ECDSA)
166     qbits = gcry_pk_get_nbits (pkey);
167   else if (pkalgo == GCRY_PK_DSA)
168     qbits = get_dsa_qbits (pkey);
169   else
170     return gpg_error (GPG_ERR_WRONG_PUBKEY_ALGO);
171
172   if (pkalgo == GCRY_PK_DSA && (qbits%8))
173     {
174       /* FIXME: We check the QBITS but print a message about the hash
175          length.  */
176       log_error (_("DSA requires the hash length to be a"
177                    " multiple of 8 bits\n"));
178       return gpg_error (GPG_ERR_INV_LENGTH);
179     }
180
181   /* Don't allow any Q smaller than 160 bits.  We don't want someone
182      to issue signatures from a key with a 16-bit Q or something like
183      that, which would look correct but allow trivial forgeries.  Yes,
184      I know this rules out using MD5 with DSA. ;) */
185   if (qbits < 160)
186     {
187       log_error (_("%s key uses an unsafe (%u bit) hash\n"),
188                  gcry_pk_algo_name (pkalgo), qbits);
189       return gpg_error (GPG_ERR_INV_LENGTH);
190     }
191
192   /* ECDSA 521 is special has it is larger than the largest hash
193      we have (SHA-512).  Thus we change the size for further
194      processing to 512.  */
195   if (pkalgo == GCRY_PK_ECDSA && qbits > 512)
196     qbits = 512;
197
198   /* Check if we're too short.  Too long is safe as we'll
199      automatically left-truncate.  */
200   if (mdlen < qbits/8)
201     {
202       log_error (_("a %zu bit hash is not valid for a %u bit %s key\n"),
203                  mdlen*8,
204                  gcry_pk_get_nbits (pkey),
205                  gcry_pk_algo_name (pkalgo));
206       return gpg_error (GPG_ERR_INV_LENGTH);
207     }
208
209   /* Truncate.  */
210   if (mdlen > qbits/8)
211     mdlen = qbits/8;
212
213   /* Create the S-expression.  */
214   err = gcry_sexp_build (&hash, NULL,
215                          "(data (flags rfc6979) (hash %s %b))",
216                          rfc6979_hash_algo_string (mdlen),
217                          (int)mdlen, md);
218   if (!err)
219     *r_hash = hash;
220   return err;
221 }
222
223
224 /* Special version of do_encode_md to take care of pkcs#1 padding.
225    For TLS-MD5SHA1 we need to do the padding ourself as Libgrypt does
226    not know about this special scheme.  Fixme: We should have a
227    pkcs1-only-padding flag for Libgcrypt. */
228 static int
229 do_encode_raw_pkcs1 (const byte *md, size_t mdlen, unsigned int nbits,
230                      gcry_sexp_t *r_hash)
231 {
232   int rc;
233   gcry_sexp_t hash;
234   unsigned char *frame;
235   size_t i, n, nframe;
236
237   nframe = (nbits+7) / 8;
238   if ( !mdlen || mdlen + 8 + 4 > nframe )
239     {
240       /* Can't encode this hash into a frame of size NFRAME. */
241       return gpg_error (GPG_ERR_TOO_SHORT);
242     }
243
244   frame = xtrymalloc (nframe);
245   if (!frame)
246     return gpg_error_from_syserror ();
247
248   /* Assemble the pkcs#1 block type 1. */
249   n = 0;
250   frame[n++] = 0;
251   frame[n++] = 1; /* Block type. */
252   i = nframe - mdlen - 3 ;
253   assert (i >= 8); /* At least 8 bytes of padding.  */
254   memset (frame+n, 0xff, i );
255   n += i;
256   frame[n++] = 0;
257   memcpy (frame+n, md, mdlen );
258   n += mdlen;
259   assert (n == nframe);
260
261   /* Create the S-expression.  */
262   rc = gcry_sexp_build (&hash, NULL,
263                         "(data (flags raw) (value %b))",
264                         (int)nframe, frame);
265   xfree (frame);
266
267   *r_hash = hash;
268   return rc;
269 }
270
271
272
273 /* SIGN whatever information we have accumulated in CTRL and return
274  * the signature S-expression.  LOOKUP is an optional function to
275  * provide a way for lower layers to ask for the caching TTL.  If a
276  * CACHE_NONCE is given that cache item is first tried to get a
277  * passphrase.  If OVERRIDEDATA is not NULL, OVERRIDEDATALEN bytes
278  * from this buffer are used instead of the data in CTRL.  The
279  * override feature is required to allow the use of Ed25519 with ssh
280  * because Ed25519 does the hashing itself.  */
281 gpg_error_t
282 agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
283                  const char *desc_text,
284                  gcry_sexp_t *signature_sexp,
285                  cache_mode_t cache_mode, lookup_ttl_t lookup_ttl,
286                  const void *overridedata, size_t overridedatalen)
287 {
288   gpg_error_t err = 0;
289   gcry_sexp_t s_skey = NULL;
290   gcry_sexp_t s_sig  = NULL;
291   gcry_sexp_t s_hash = NULL;
292   gcry_sexp_t s_pkey = NULL;
293   unsigned char *shadow_info = NULL;
294   const unsigned char *data;
295   int datalen;
296   int check_signature = 0;
297
298   if (overridedata)
299     {
300       data = overridedata;
301       datalen = overridedatalen;
302     }
303   else
304     {
305       data = ctrl->digest.value;
306       datalen = ctrl->digest.valuelen;
307     }
308
309   if (!ctrl->have_keygrip)
310     return gpg_error (GPG_ERR_NO_SECKEY);
311
312   err = agent_key_from_file (ctrl, cache_nonce, desc_text, ctrl->keygrip,
313                              &shadow_info, cache_mode, lookup_ttl,
314                              &s_skey, NULL);
315   if (err)
316     {
317       if (gpg_err_code (err) != GPG_ERR_NO_SECKEY)
318         log_error ("failed to read the secret key\n");
319       goto leave;
320     }
321
322   if (shadow_info)
323     {
324       /* Divert operation to the smartcard */
325       size_t len;
326       unsigned char *buf = NULL;
327       int key_type;
328       int is_RSA = 0;
329       int is_ECDSA = 0;
330       int is_EdDSA = 0;
331
332       err = agent_public_key_from_file (ctrl, ctrl->keygrip, &s_pkey);
333       if (err)
334         {
335           log_error ("failed to read the public key\n");
336           goto leave;
337         }
338
339       if (agent_is_eddsa_key (s_skey))
340         is_EdDSA = 1;
341       else
342         {
343           key_type = agent_is_dsa_key (s_skey);
344           if (key_type == 0)
345             is_RSA = 1;
346           else if (key_type == GCRY_PK_ECDSA)
347             is_ECDSA = 1;
348         }
349
350       {
351         char *desc2 = NULL;
352
353         if (desc_text)
354           agent_modify_description (desc_text, NULL, s_skey, &desc2);
355
356         err = divert_pksign (ctrl, desc2? desc2 : desc_text,
357                              data, datalen,
358                              ctrl->digest.algo,
359                              shadow_info, &buf, &len);
360         xfree (desc2);
361       }
362       if (err)
363         {
364           log_error ("smartcard signing failed: %s\n", gpg_strerror (err));
365           goto leave;
366         }
367
368       if (is_RSA)
369         {
370           unsigned char *p = buf;
371
372           check_signature = 1;
373
374           /*
375            * Smartcard returns fixed-size data, which is good for
376            * PKCS1.  If variable-size unsigned MPI is needed, remove
377            * zeros.
378            */
379           if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1
380               || ctrl->digest.raw_value)
381             {
382               int i;
383
384               for (i = 0; i < len - 1; i++)
385                 if (p[i])
386                   break;
387               p += i;
388               len -= i;
389             }
390
391           err = gcry_sexp_build (&s_sig, NULL, "(sig-val(rsa(s%b)))",
392                                  (int)len, p);
393         }
394       else if (is_EdDSA)
395         {
396           err = gcry_sexp_build (&s_sig, NULL, "(sig-val(eddsa(r%b)(s%b)))",
397                                  (int)len/2, buf, (int)len/2, buf + len/2);
398         }
399       else if (is_ECDSA)
400         {
401           unsigned char *r_buf, *s_buf;
402           int r_buflen, s_buflen;
403           int i;
404
405           r_buflen = s_buflen = len/2;
406
407           /*
408            * Smartcard returns fixed-size data.  For ECDSA signature,
409            * variable-size unsigned MPI is assumed, thus, remove
410            * zeros.
411            */
412           r_buf = buf;
413           for (i = 0; i < r_buflen - 1; i++)
414             if (r_buf[i])
415               break;
416           r_buf += i;
417           r_buflen -= i;
418
419           s_buf = buf + len/2;
420           for (i = 0; i < s_buflen - 1; i++)
421             if (s_buf[i])
422               break;
423           s_buf += i;
424           s_buflen -= i;
425
426           err = gcry_sexp_build (&s_sig, NULL, "(sig-val(ecdsa(r%b)(s%b)))",
427                                  r_buflen, r_buf,
428                                  s_buflen, s_buf);
429         }
430       else
431         err = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
432
433       xfree (buf);
434       if (err)
435         {
436           log_error ("failed to convert sigbuf returned by divert_pksign "
437                      "into S-Exp: %s", gpg_strerror (err));
438           goto leave;
439         }
440     }
441   else
442     {
443       /* No smartcard, but a private key */
444       int dsaalgo = 0;
445
446       /* Put the hash into a sexp */
447       if (agent_is_eddsa_key (s_skey))
448         err = do_encode_eddsa (data, datalen,
449                                &s_hash);
450       else if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
451         err = do_encode_raw_pkcs1 (data, datalen,
452                                    gcry_pk_get_nbits (s_skey),
453                                    &s_hash);
454       else if ( (dsaalgo = agent_is_dsa_key (s_skey)) )
455         err = do_encode_dsa (data, datalen,
456                              dsaalgo, s_skey,
457                              &s_hash);
458       else
459         err = do_encode_md (data, datalen,
460                             ctrl->digest.algo,
461                             &s_hash,
462                             ctrl->digest.raw_value);
463       if (err)
464         goto leave;
465
466       if (dsaalgo == 0 && GCRYPT_VERSION_NUMBER < 0x010700)
467         {
468           /* It's RSA and Libgcrypt < 1.7 */
469           check_signature = 1;
470         }
471
472       if (DBG_CRYPTO)
473         {
474           gcry_log_debugsxp ("skey", s_skey);
475           gcry_log_debugsxp ("hash", s_hash);
476         }
477
478       /* sign */
479       err = gcry_pk_sign (&s_sig, s_hash, s_skey);
480       if (err)
481         {
482           log_error ("signing failed: %s\n", gpg_strerror (err));
483           goto leave;
484         }
485
486       if (DBG_CRYPTO)
487         gcry_log_debugsxp ("rslt", s_sig);
488     }
489
490   /* Check that the signature verification worked and nothing is
491    * fooling us e.g. by a bug in the signature create code or by
492    * deliberately introduced faults.  Because Libgcrypt 1.7 does this
493    * for RSA internally there is no need to do it here again.  */
494   if (check_signature)
495     {
496       gcry_sexp_t sexp_key = s_pkey? s_pkey: s_skey;
497
498       if (s_hash == NULL)
499         {
500           if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
501             err = do_encode_raw_pkcs1 (data, datalen,
502                                        gcry_pk_get_nbits (sexp_key), &s_hash);
503           else
504             err = do_encode_md (data, datalen, ctrl->digest.algo, &s_hash,
505                                 ctrl->digest.raw_value);
506         }
507
508       if (!err)
509         err = gcry_pk_verify (s_sig, s_hash, sexp_key);
510
511       if (err)
512         {
513           log_error (_("checking created signature failed: %s\n"),
514                      gpg_strerror (err));
515           gcry_sexp_release (s_sig);
516           s_sig = NULL;
517         }
518     }
519
520  leave:
521
522   *signature_sexp = s_sig;
523
524   gcry_sexp_release (s_pkey);
525   gcry_sexp_release (s_skey);
526   gcry_sexp_release (s_hash);
527   xfree (shadow_info);
528
529   return err;
530 }
531
532
533 /* SIGN whatever information we have accumulated in CTRL and write it
534  * back to OUTFP.  If a CACHE_NONCE is given that cache item is first
535  * tried to get a passphrase.  */
536 gpg_error_t
537 agent_pksign (ctrl_t ctrl, const char *cache_nonce, const char *desc_text,
538               membuf_t *outbuf, cache_mode_t cache_mode)
539 {
540   gpg_error_t err;
541   gcry_sexp_t s_sig = NULL;
542   char *buf = NULL;
543   size_t len = 0;
544
545   err = agent_pksign_do (ctrl, cache_nonce, desc_text, &s_sig, cache_mode,
546                          NULL, NULL, 0);
547   if (err)
548     goto leave;
549
550   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, NULL, 0);
551   log_assert (len);
552   buf = xtrymalloc (len);
553   if (!buf)
554     {
555       err = gpg_error_from_syserror ();
556       goto leave;
557     }
558   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, buf, len);
559   log_assert (len);
560   put_membuf (outbuf, buf, len);
561
562  leave:
563   gcry_sexp_release (s_sig);
564   xfree (buf);
565
566   return err;
567 }