Fixed key generation with P-521. Confirmed that signature generation and verification...
[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  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 3 of the License, or
9  * (at your option) any later version.
10  *
11  * GnuPG is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, see <http://www.gnu.org/licenses/>.
18  */
19
20 #include <config.h>
21 #include <errno.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <ctype.h>
26 #include <assert.h>
27 #include <unistd.h>
28 #include <sys/stat.h>
29
30 #include "agent.h"
31 #include "i18n.h"
32
33
34 static int
35 do_encode_md (const byte * md, size_t mdlen, int algo, gcry_sexp_t * r_hash,
36               int raw_value)
37 {
38   gcry_sexp_t hash;
39   int rc;
40
41   if (!raw_value)
42     {
43       const char *s;
44       char tmp[16+1];
45       int i;
46       
47       s = gcry_md_algo_name (algo);
48       if (s && strlen (s) < 16)
49         {
50           for (i=0; i < strlen (s); i++)
51             tmp[i] = tolower (s[i]);
52           tmp[i] = '\0';   
53         }
54
55       rc = gcry_sexp_build (&hash, NULL,
56                             "(data (flags pkcs1) (hash %s %b))",
57                             tmp, (int)mdlen, md);
58     }
59   else
60     {
61       gcry_mpi_t mpi;
62       
63       rc = gcry_mpi_scan (&mpi, GCRYMPI_FMT_USG, md, mdlen, NULL);
64       if (! rc)
65         {
66           rc = gcry_sexp_build (&hash, NULL,
67                                 "(data (flags raw) (value %m))",
68                                 mpi);
69           gcry_mpi_release (mpi);
70         }
71           
72     }
73   
74   *r_hash = hash;
75   return rc;   
76 }
77
78
79 /* Return the number of bits of the Q parameter from the DSA key
80    KEY.  */
81 static unsigned int
82 get_dsa_qbits (gcry_sexp_t key)
83 {
84   gcry_sexp_t l1, l2;
85   gcry_mpi_t q;
86   unsigned int nbits;
87
88   l1 = gcry_sexp_find_token (key, "private-key", 0);
89   if (!l1)
90     l1 = gcry_sexp_find_token (key, "protected-private-key", 0);
91   if (!l1)
92     l1 = gcry_sexp_find_token (key, "shadowed-private-key", 0);
93   if (!l1)
94     l1 = gcry_sexp_find_token (key, "public-key", 0);
95   if (!l1)
96     return 0; /* Does not contain a key object.  */
97   l2 = gcry_sexp_cadr (l1);
98   gcry_sexp_release  (l1);
99   l1 = gcry_sexp_find_token (l2, "q", 1);
100   gcry_sexp_release (l2);
101   if (!l1)
102     return 0; /* Invalid object.  */
103   q = gcry_sexp_nth_mpi (l1, 1, GCRYMPI_FMT_USG);
104   gcry_sexp_release (l1);
105   if (!q)
106     return 0; /* Missing value.  */
107   nbits = gcry_mpi_get_nbits (q);
108   gcry_mpi_release (q);
109
110   return nbits;
111 }
112
113
114 /* Encode a message digest for use with an DSA algorithm. */
115 static gpg_error_t
116 do_encode_dsa (const byte * md, size_t mdlen, int dsaalgo, gcry_sexp_t pkey,
117                gcry_sexp_t *r_hash)
118 {
119   gpg_error_t err;
120   gcry_sexp_t hash;
121   unsigned int qbits;
122   int gcry_pkalgo;
123
124   *r_hash = NULL;
125
126   gcry_pkalgo = map_pk_openpgp_to_gcry( dsaalgo );
127
128   if (gcry_pkalgo == GCRY_PK_ECDSA)
129     qbits = gcry_pk_get_nbits (pkey);
130   else if (gcry_pkalgo == GCRY_PK_DSA)
131     qbits = get_dsa_qbits (pkey);
132   else
133     return gpg_error (GPG_ERR_WRONG_PUBKEY_ALGO);
134   
135   if ((qbits%8))
136     {
137       log_error (_("DSA requires the hash length to be a"
138                    " multiple of 8 bits\n"));
139       return gpg_error (GPG_ERR_INV_LENGTH);
140     }
141
142   /* Don't allow any Q smaller than 160 bits.  We don't want someone
143      to issue signatures from a key with a 16-bit Q or something like
144      that, which would look correct but allow trivial forgeries.  Yes,
145      I know this rules out using MD5 with DSA. ;) */
146   if (qbits < 160)
147     {
148       log_error (_("%s key uses an unsafe (%u bit) hash\n"),
149                  gcry_pk_algo_name (gcry_pkalgo), qbits);
150       return gpg_error (GPG_ERR_INV_LENGTH);
151     }
152
153   /* Check if we're too short.  Too long is safe as we'll
154      automatically left-truncate.  */
155
156   /* This check would require the use of SHA512 with ECDSA 512. I think this is overkill to fail in this case.
157    * Therefore, relax the check, but only for ECDSA keys. We may need to adjust it later for general case.
158    * ( Note that the check is really a bug for ECDSA 521 as the only hash that matches it is SHA 512, but 512 < 521 ).
159    */
160   if( mdlen < ((gcry_pkalgo==GCRY_PK_ECDSA && qbits>521) ? 512 : qbits) )
161     {
162       log_error (_("a %zu bit hash is not valid for a %u bit %s key\n"),
163                  mdlen,
164                  gcry_pk_get_nbits (pkey), 
165                  gcry_pk_algo_name (gcry_pkalgo));
166       /* FIXME: we need to check the requirements for ECDSA.  */
167       if (mdlen < 20 || gcry_pkalgo == GCRY_PK_DSA)
168         return gpg_error (GPG_ERR_INV_LENGTH);
169     }
170
171   /* Truncate.  */
172   if (mdlen > qbits/8)
173     mdlen = qbits/8;
174             
175   /* Create the S-expression.  We need to convert to an MPI first
176      because we want an unsigned integer.  Using %b directly is not
177      possible because libgcrypt assumes an mpi and uses
178      GCRYMPI_FMT_STD for parsing and thus possible yielding a negative
179      value.  */
180   {
181     gcry_mpi_t mpi;
182       
183     err = gcry_mpi_scan (&mpi, GCRYMPI_FMT_USG, md, mdlen, NULL);
184     if (!err)
185       {
186         err = gcry_sexp_build (&hash, NULL,
187                                "(data (flags raw) (value %m))", mpi);
188         gcry_mpi_release (mpi);
189       }
190   }
191   if (!err)
192     *r_hash = hash;
193   return err;   
194 }
195
196
197 /* Special version of do_encode_md to take care of pkcs#1 padding.
198    For TLS-MD5SHA1 we need to do the padding ourself as Libgrypt does
199    not know about this special scheme.  Fixme: We should have a
200    pkcs1-only-padding flag for Libgcrypt. */
201 static int
202 do_encode_raw_pkcs1 (const byte *md, size_t mdlen, unsigned int nbits,
203                      gcry_sexp_t *r_hash)
204 {
205   int rc;
206   gcry_sexp_t hash;
207   unsigned char *frame;
208   size_t i, n, nframe;
209             
210   nframe = (nbits+7) / 8;
211   if ( !mdlen || mdlen + 8 + 4 > nframe )
212     {
213       /* Can't encode this hash into a frame of size NFRAME. */
214       return gpg_error (GPG_ERR_TOO_SHORT);
215     }
216
217   frame = xtrymalloc (nframe);
218   if (!frame)
219     return gpg_error_from_syserror ();
220   
221   /* Assemble the pkcs#1 block type 1. */
222   n = 0;
223   frame[n++] = 0;
224   frame[n++] = 1; /* Block type. */
225   i = nframe - mdlen - 3 ;
226   assert (i >= 8); /* At least 8 bytes of padding.  */
227   memset (frame+n, 0xff, i );
228   n += i;
229   frame[n++] = 0;
230   memcpy (frame+n, md, mdlen );
231   n += mdlen;
232   assert (n == nframe);
233   
234   /* Create the S-expression.  */
235   rc = gcry_sexp_build (&hash, NULL,
236                         "(data (flags raw) (value %b))",
237                         (int)nframe, frame);
238   xfree (frame);
239
240   *r_hash = hash;
241   return rc;   
242 }
243
244
245
246 /* SIGN whatever information we have accumulated in CTRL and return
247    the signature S-expression.  LOOKUP is an optional function to
248    provide a way for lower layers to ask for the caching TTL.  If a
249    CACHE_NONCE is given that cache item is first tried to get a
250    passphrase.  */
251 int
252 agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
253                  const char *desc_text,
254                  gcry_sexp_t *signature_sexp,
255                  cache_mode_t cache_mode, lookup_ttl_t lookup_ttl)
256 {
257   gcry_sexp_t s_skey = NULL, s_sig = NULL;
258   unsigned char *shadow_info = NULL;
259   unsigned int rc = 0;          /* FIXME: gpg-error? */
260
261   if (! ctrl->have_keygrip)
262     return gpg_error (GPG_ERR_NO_SECKEY);
263
264   rc = agent_key_from_file (ctrl, cache_nonce, desc_text, ctrl->keygrip,
265                             &shadow_info, cache_mode, lookup_ttl,
266                             &s_skey, NULL);
267   if (rc)
268     {
269       log_error ("failed to read the secret key\n");
270       goto leave;
271     }
272
273   if (!s_skey)
274     {
275       /* Divert operation to the smartcard */
276
277       unsigned char *buf = NULL;
278       size_t len = 0;
279
280       rc = divert_pksign (ctrl, 
281                           ctrl->digest.value, 
282                           ctrl->digest.valuelen,
283                           ctrl->digest.algo,
284                           shadow_info, &buf);
285       if (rc)
286         {
287           log_error ("smartcard signing failed: %s\n", gpg_strerror (rc));
288           goto leave;
289         }
290       len = gcry_sexp_canon_len (buf, 0, NULL, NULL);
291       assert (len);
292
293       rc = gcry_sexp_sscan (&s_sig, NULL, (char*)buf, len);
294       xfree (buf);
295       if (rc)
296         {
297           log_error ("failed to convert sigbuf returned by divert_pksign "
298                      "into S-Exp: %s", gpg_strerror (rc));
299           goto leave;
300         }
301     }
302   else
303     {
304       /* No smartcard, but a private key */
305       gcry_sexp_t s_hash = NULL;
306       int dsaalgo;
307
308       /* Put the hash into a sexp */
309       if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
310         rc = do_encode_raw_pkcs1 (ctrl->digest.value,
311                                   ctrl->digest.valuelen,
312                                   gcry_pk_get_nbits (s_skey),
313                                   &s_hash);
314       else if ( (dsaalgo = agent_is_dsa_key (s_skey)) )
315         rc = do_encode_dsa (ctrl->digest.value,
316                             ctrl->digest.valuelen,
317                             dsaalgo, s_skey,
318                             &s_hash);
319       else
320         rc = do_encode_md (ctrl->digest.value,
321                            ctrl->digest.valuelen,
322                            ctrl->digest.algo,
323                            &s_hash,
324                            ctrl->digest.raw_value);
325       if (rc)
326         goto leave;
327
328       if (DBG_CRYPTO)
329         {
330           log_debug ("skey:\n");
331           gcry_sexp_dump (s_skey);
332           log_debug ("hash:\n");
333           gcry_sexp_dump (s_hash);
334         }
335
336       /* sign */
337       rc = gcry_pk_sign (&s_sig, s_hash, s_skey);
338       gcry_sexp_release (s_hash);
339       if (rc)
340         {
341           log_error ("signing failed: %s\n", gpg_strerror (rc));
342           goto leave;
343         }
344
345       if (DBG_CRYPTO)
346         {
347           log_debug ("result:\n");
348           gcry_sexp_dump (s_sig);
349         }
350     }
351
352  leave:
353
354   *signature_sexp = s_sig;
355
356   gcry_sexp_release (s_skey);
357   xfree (shadow_info);
358
359   return rc;
360 }
361
362 /* SIGN whatever information we have accumulated in CTRL and write it
363    back to OUTFP.  If a CACHE_NONCE is given that cache item is first
364    tried to get a passphrase.  */
365 int
366 agent_pksign (ctrl_t ctrl, const char *cache_nonce, const char *desc_text,
367               membuf_t *outbuf, cache_mode_t cache_mode) 
368 {
369   gcry_sexp_t s_sig = NULL;
370   char *buf = NULL;
371   size_t len = 0;
372   int rc = 0;
373
374   rc = agent_pksign_do (ctrl, cache_nonce, desc_text, &s_sig, cache_mode, NULL);
375   if (rc)
376     goto leave;
377
378   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, NULL, 0);
379   assert (len);
380   buf = xmalloc (len);
381   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, buf, len);
382   assert (len);
383
384   put_membuf (outbuf, buf, len);
385
386  leave:
387   gcry_sexp_release (s_sig);
388   xfree (buf);
389
390   return rc;
391 }