gpg: Rework ECC support and add experimental support for Ed25519.
[gnupg.git] / agent / pksign.c
1 /* pksign.c - public key signing (well, actually using a secret key)
2  * Copyright (C) 2001, 2002, 2003, 2004, 2010 Free Software Foundation, Inc.
3  * Copyright (C) 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 <http://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 "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
73     }
74
75   *r_hash = hash;
76   return rc;
77 }
78
79
80 /* Return the number of bits of the Q parameter from the DSA key
81    KEY.  */
82 static unsigned int
83 get_dsa_qbits (gcry_sexp_t key)
84 {
85   gcry_sexp_t l1, l2;
86   gcry_mpi_t q;
87   unsigned int nbits;
88
89   l1 = gcry_sexp_find_token (key, "private-key", 0);
90   if (!l1)
91     l1 = gcry_sexp_find_token (key, "protected-private-key", 0);
92   if (!l1)
93     l1 = gcry_sexp_find_token (key, "shadowed-private-key", 0);
94   if (!l1)
95     l1 = gcry_sexp_find_token (key, "public-key", 0);
96   if (!l1)
97     return 0; /* Does not contain a key object.  */
98   l2 = gcry_sexp_cadr (l1);
99   gcry_sexp_release  (l1);
100   l1 = gcry_sexp_find_token (l2, "q", 1);
101   gcry_sexp_release (l2);
102   if (!l1)
103     return 0; /* Invalid object.  */
104   q = gcry_sexp_nth_mpi (l1, 1, GCRYMPI_FMT_USG);
105   gcry_sexp_release (l1);
106   if (!q)
107     return 0; /* Missing value.  */
108   nbits = gcry_mpi_get_nbits (q);
109   gcry_mpi_release (q);
110
111   return nbits;
112 }
113
114
115 /* Return an appropriate hash algorithm to be used with RFC-6979 for a
116    message digest of length MDLEN.  Although a fallback of SHA-256 is
117    used the current implementation in Libgcrypt will reject a hash
118    algorithm which does not match the length of the message.  */
119 static const char *
120 rfc6979_hash_algo_string (size_t mdlen)
121 {
122   switch (mdlen)
123     {
124     case 20: return "sha1";
125     case 28: return "sha224";
126     case 32: return "sha256";
127     case 48: return "sha384";
128     case 64: return "sha512";
129     default: return "sha256";
130     }
131 }
132
133
134 /* Encode a message digest for use with the EdDSA algorithm
135    (i.e. curve Ed25519). */
136 static gpg_error_t
137 do_encode_eddsa (const byte *md, size_t mdlen, gcry_sexp_t *r_hash)
138 {
139   gpg_error_t err;
140   gcry_sexp_t hash;
141
142   *r_hash = NULL;
143   err = gcry_sexp_build (&hash, NULL,
144                          "(data(flags eddsa)(hash-algo sha512)(value %b))",
145                          (int)mdlen, md);
146   if (!err)
147     *r_hash = hash;
148   return err;
149 }
150
151
152 /* Encode a message digest for use with an DSA algorithm. */
153 static gpg_error_t
154 do_encode_dsa (const byte *md, size_t mdlen, int dsaalgo, gcry_sexp_t pkey,
155                gcry_sexp_t *r_hash)
156 {
157   gpg_error_t err;
158   gcry_sexp_t hash;
159   unsigned int qbits;
160   int pkalgo;
161
162   *r_hash = NULL;
163
164   pkalgo = map_pk_openpgp_to_gcry (dsaalgo);
165
166   if (pkalgo == GCRY_PK_ECDSA)
167     qbits = gcry_pk_get_nbits (pkey);
168   else if (pkalgo == GCRY_PK_DSA)
169     qbits = get_dsa_qbits (pkey);
170   else
171     return gpg_error (GPG_ERR_WRONG_PUBKEY_ALGO);
172
173   if (pkalgo == GCRY_PK_DSA && (qbits%8))
174     {
175       /* FIXME: We check the QBITS but print a message about the hash
176          length.  */
177       log_error (_("DSA requires the hash length to be a"
178                    " multiple of 8 bits\n"));
179       return gpg_error (GPG_ERR_INV_LENGTH);
180     }
181
182   /* Don't allow any Q smaller than 160 bits.  We don't want someone
183      to issue signatures from a key with a 16-bit Q or something like
184      that, which would look correct but allow trivial forgeries.  Yes,
185      I know this rules out using MD5 with DSA. ;) */
186   if (qbits < 160)
187     {
188       log_error (_("%s key uses an unsafe (%u bit) hash\n"),
189                  gcry_pk_algo_name (pkalgo), qbits);
190       return gpg_error (GPG_ERR_INV_LENGTH);
191     }
192
193   /* Check if we're too short.  Too long is safe as we'll
194    * automatically left-truncate.
195    *
196    * This check would require the use of SHA512 with ECDSA 512. I
197    * think this is overkill to fail in this case.  Therefore, relax
198    * the check, but only for ECDSA keys.  We may need to adjust it
199    * later for general case.  (Note that the check is really a bug for
200    * ECDSA 521 as the only hash that matches it is SHA 512, but 512 <
201    * 521 ).
202    */
203   if (mdlen < ((pkalgo==GCRY_PK_ECDSA && qbits > 521) ? 512 : qbits)/8)
204     {
205       log_error (_("a %zu bit hash is not valid for a %u bit %s key\n"),
206                  mdlen*8,
207                  gcry_pk_get_nbits (pkey),
208                  gcry_pk_algo_name (pkalgo));
209       /* FIXME: we need to check the requirements for ECDSA.  */
210       if (mdlen < 20 || pkalgo == GCRY_PK_DSA)
211         return gpg_error (GPG_ERR_INV_LENGTH);
212     }
213
214   /* Truncate.  */
215   if (mdlen > qbits/8)
216     mdlen = qbits/8;
217
218   /* Create the S-expression.  */
219   err = gcry_sexp_build (&hash, NULL,
220                          "(data (flags rfc6979) (hash %s %b))",
221                          rfc6979_hash_algo_string (mdlen),
222                          (int)mdlen, md);
223   if (!err)
224     *r_hash = hash;
225   return err;
226 }
227
228
229 /* Special version of do_encode_md to take care of pkcs#1 padding.
230    For TLS-MD5SHA1 we need to do the padding ourself as Libgrypt does
231    not know about this special scheme.  Fixme: We should have a
232    pkcs1-only-padding flag for Libgcrypt. */
233 static int
234 do_encode_raw_pkcs1 (const byte *md, size_t mdlen, unsigned int nbits,
235                      gcry_sexp_t *r_hash)
236 {
237   int rc;
238   gcry_sexp_t hash;
239   unsigned char *frame;
240   size_t i, n, nframe;
241
242   nframe = (nbits+7) / 8;
243   if ( !mdlen || mdlen + 8 + 4 > nframe )
244     {
245       /* Can't encode this hash into a frame of size NFRAME. */
246       return gpg_error (GPG_ERR_TOO_SHORT);
247     }
248
249   frame = xtrymalloc (nframe);
250   if (!frame)
251     return gpg_error_from_syserror ();
252
253   /* Assemble the pkcs#1 block type 1. */
254   n = 0;
255   frame[n++] = 0;
256   frame[n++] = 1; /* Block type. */
257   i = nframe - mdlen - 3 ;
258   assert (i >= 8); /* At least 8 bytes of padding.  */
259   memset (frame+n, 0xff, i );
260   n += i;
261   frame[n++] = 0;
262   memcpy (frame+n, md, mdlen );
263   n += mdlen;
264   assert (n == nframe);
265
266   /* Create the S-expression.  */
267   rc = gcry_sexp_build (&hash, NULL,
268                         "(data (flags raw) (value %b))",
269                         (int)nframe, frame);
270   xfree (frame);
271
272   *r_hash = hash;
273   return rc;
274 }
275
276
277
278 /* SIGN whatever information we have accumulated in CTRL and return
279    the signature S-expression.  LOOKUP is an optional function to
280    provide a way for lower layers to ask for the caching TTL.  If a
281    CACHE_NONCE is given that cache item is first tried to get a
282    passphrase.  */
283 int
284 agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
285                  const char *desc_text,
286                  gcry_sexp_t *signature_sexp,
287                  cache_mode_t cache_mode, lookup_ttl_t lookup_ttl)
288 {
289   gcry_sexp_t s_skey = NULL, s_sig = NULL;
290   unsigned char *shadow_info = NULL;
291   unsigned int rc = 0;          /* FIXME: gpg-error? */
292
293   if (! ctrl->have_keygrip)
294     return gpg_error (GPG_ERR_NO_SECKEY);
295
296   rc = agent_key_from_file (ctrl, cache_nonce, desc_text, ctrl->keygrip,
297                             &shadow_info, cache_mode, lookup_ttl,
298                             &s_skey, NULL);
299   if (rc)
300     {
301       log_error ("failed to read the secret key\n");
302       goto leave;
303     }
304
305   if (!s_skey)
306     {
307       /* Divert operation to the smartcard */
308       gcry_sexp_t s_pkey, l;
309       const char *name;
310       size_t len;
311       unsigned char *buf = NULL;
312       int is_RSA = 0;
313       int is_ECDSA = 0;
314
315       /* Check keytype by public key */
316       rc = agent_public_key_from_file (ctrl, ctrl->keygrip, &s_pkey);
317       if (rc)
318         {
319           log_error ("failed to read the public key\n");
320           goto leave;
321         }
322       l = gcry_sexp_cadr (s_pkey);
323       name = gcry_sexp_nth_data (l, 0, &len);
324       if (len == 3 && !memcmp (name, "rsa", 3))
325         is_RSA = 1;
326       else if (len == 5 && !memcmp (name, "ecdsa", 5))
327         is_ECDSA = 1;
328       gcry_sexp_release (l);
329       gcry_sexp_release (s_pkey);
330
331       rc = divert_pksign (ctrl,
332                           ctrl->digest.value,
333                           ctrl->digest.valuelen,
334                           ctrl->digest.algo,
335                           shadow_info, &buf, &len);
336       if (rc)
337         {
338           log_error ("smartcard signing failed: %s\n", gpg_strerror (rc));
339           goto leave;
340         }
341
342       if (is_RSA)
343         {
344           if (*buf & 0x80)
345             {
346               len++;
347               buf = xtryrealloc (buf, len);
348               if (!buf)
349                 goto leave;
350
351               memmove (buf + 1, buf, len - 1);
352               *buf = 0;
353             }
354
355           rc = gcry_sexp_build (&s_sig, NULL, "(sig-val(rsa(s%b)))", len, buf);
356         }
357       else if (is_ECDSA)
358         {
359           unsigned char *r_buf_allocated = NULL;
360           unsigned char *s_buf_allocated = NULL;
361           unsigned char *r_buf, *s_buf;
362           int r_buflen, s_buflen;
363
364           r_buflen = s_buflen = len/2;
365
366           if (*buf & 0x80)
367             {
368               r_buflen++;
369               r_buf_allocated = xtrymalloc (r_buflen);
370               if (!r_buf_allocated)
371                 goto leave;
372
373               r_buf = r_buf_allocated;
374               memcpy (r_buf + 1, buf, len/2);
375               *r_buf = 0;
376             }
377           else
378             r_buf = buf;
379
380           if (*(buf + len/2) & 0x80)
381             {
382               s_buflen++;
383               s_buf_allocated = xtrymalloc (s_buflen);
384               if (!s_buf_allocated)
385                 {
386                   xfree (r_buf_allocated);
387                   goto leave;
388                 }
389
390               s_buf = s_buf_allocated;
391               memcpy (s_buf + 1, buf + len/2, len/2);
392               *s_buf = 0;
393             }
394           else
395             s_buf = buf + len/2;
396
397           rc = gcry_sexp_build (&s_sig, NULL, "(sig-val(ecdsa(r%b)(s%b)))",
398                                 r_buflen, r_buf,
399                                 s_buflen, s_buf);
400           xfree (r_buf_allocated);
401           xfree (s_buf_allocated);
402         }
403       else
404         rc = gpg_error (GPG_ERR_NOT_IMPLEMENTED);
405
406       xfree (buf);
407       if (rc)
408         {
409           log_error ("failed to convert sigbuf returned by divert_pksign "
410                      "into S-Exp: %s", gpg_strerror (rc));
411           goto leave;
412         }
413     }
414   else
415     {
416       /* No smartcard, but a private key */
417       gcry_sexp_t s_hash = NULL;
418       int dsaalgo;
419
420       /* Put the hash into a sexp */
421       if (agent_is_eddsa_key (s_skey))
422         rc = do_encode_eddsa (ctrl->digest.value,
423                               ctrl->digest.valuelen,
424                               &s_hash);
425       else if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
426         rc = do_encode_raw_pkcs1 (ctrl->digest.value,
427                                   ctrl->digest.valuelen,
428                                   gcry_pk_get_nbits (s_skey),
429                                   &s_hash);
430       else if ( (dsaalgo = agent_is_dsa_key (s_skey)) )
431         rc = do_encode_dsa (ctrl->digest.value,
432                             ctrl->digest.valuelen,
433                             dsaalgo, s_skey,
434                             &s_hash);
435       else
436         rc = do_encode_md (ctrl->digest.value,
437                            ctrl->digest.valuelen,
438                            ctrl->digest.algo,
439                            &s_hash,
440                            ctrl->digest.raw_value);
441       if (rc)
442         goto leave;
443
444       if (DBG_CRYPTO)
445         {
446           gcry_log_debugsxp ("skey", s_skey);
447           gcry_log_debugsxp ("hash", s_hash);
448         }
449
450       /* sign */
451       rc = gcry_pk_sign (&s_sig, s_hash, s_skey);
452       gcry_sexp_release (s_hash);
453       if (rc)
454         {
455           log_error ("signing failed: %s\n", gpg_strerror (rc));
456           goto leave;
457         }
458
459       if (DBG_CRYPTO)
460         gcry_log_debugsxp ("rslt", s_sig);
461     }
462
463  leave:
464
465   *signature_sexp = s_sig;
466
467   gcry_sexp_release (s_skey);
468   xfree (shadow_info);
469
470   return rc;
471 }
472
473 /* SIGN whatever information we have accumulated in CTRL and write it
474    back to OUTFP.  If a CACHE_NONCE is given that cache item is first
475    tried to get a passphrase.  */
476 int
477 agent_pksign (ctrl_t ctrl, const char *cache_nonce, const char *desc_text,
478               membuf_t *outbuf, cache_mode_t cache_mode)
479 {
480   gcry_sexp_t s_sig = NULL;
481   char *buf = NULL;
482   size_t len = 0;
483   int rc = 0;
484
485   rc = agent_pksign_do (ctrl, cache_nonce, desc_text, &s_sig, cache_mode, NULL);
486   if (rc)
487     goto leave;
488
489   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, NULL, 0);
490   assert (len);
491   buf = xmalloc (len);
492   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, buf, len);
493   assert (len);
494
495   put_membuf (outbuf, buf, len);
496
497  leave:
498   gcry_sexp_release (s_sig);
499   xfree (buf);
500
501   return rc;
502 }