Merge branch 'master' into ECC-INTEGRATION-2-1
[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 pkalgo;
123
124   *r_hash = NULL;
125
126   pkalgo = map_pk_openpgp_to_gcry (dsaalgo);
127
128   if (pkalgo == GCRY_PK_ECDSA)
129     qbits = gcry_pk_get_nbits (pkey);
130   else if (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 (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
157    * think this is overkill to fail in this case.  Therefore, relax
158    * the check, but only for ECDSA keys.  We may need to adjust it
159    * later for general case.  (Note that the check is really a bug for
160    * ECDSA 521 as the only hash that matches it is SHA 512, but 512 <
161    * 521 ).
162    */
163   if (mdlen < ((pkalgo==GCRY_PK_ECDSA && qbits > 521) ? 512 : qbits)/8)
164     {
165       log_error (_("a %zu bit hash is not valid for a %u bit %s key\n"),
166                  mdlen*8,
167                  gcry_pk_get_nbits (pkey), 
168                  gcry_pk_algo_name (pkalgo));
169       /* FIXME: we need to check the requirements for ECDSA.  */
170       if (mdlen < 20 || pkalgo == GCRY_PK_DSA)
171         return gpg_error (GPG_ERR_INV_LENGTH);
172     }
173
174   /* Truncate.  */
175   if (mdlen > qbits/8)
176     mdlen = qbits/8;
177             
178   /* Create the S-expression.  We need to convert to an MPI first
179      because we want an unsigned integer.  Using %b directly is not
180      possible because libgcrypt assumes an mpi and uses
181      GCRYMPI_FMT_STD for parsing and thus possible yielding a negative
182      value.  */
183   {
184     gcry_mpi_t mpi;
185       
186     err = gcry_mpi_scan (&mpi, GCRYMPI_FMT_USG, md, mdlen, NULL);
187     if (!err)
188       {
189         err = gcry_sexp_build (&hash, NULL,
190                                "(data (flags raw) (value %m))", mpi);
191         gcry_mpi_release (mpi);
192       }
193   }
194   if (!err)
195     *r_hash = hash;
196   return err;   
197 }
198
199
200 /* Special version of do_encode_md to take care of pkcs#1 padding.
201    For TLS-MD5SHA1 we need to do the padding ourself as Libgrypt does
202    not know about this special scheme.  Fixme: We should have a
203    pkcs1-only-padding flag for Libgcrypt. */
204 static int
205 do_encode_raw_pkcs1 (const byte *md, size_t mdlen, unsigned int nbits,
206                      gcry_sexp_t *r_hash)
207 {
208   int rc;
209   gcry_sexp_t hash;
210   unsigned char *frame;
211   size_t i, n, nframe;
212             
213   nframe = (nbits+7) / 8;
214   if ( !mdlen || mdlen + 8 + 4 > nframe )
215     {
216       /* Can't encode this hash into a frame of size NFRAME. */
217       return gpg_error (GPG_ERR_TOO_SHORT);
218     }
219
220   frame = xtrymalloc (nframe);
221   if (!frame)
222     return gpg_error_from_syserror ();
223   
224   /* Assemble the pkcs#1 block type 1. */
225   n = 0;
226   frame[n++] = 0;
227   frame[n++] = 1; /* Block type. */
228   i = nframe - mdlen - 3 ;
229   assert (i >= 8); /* At least 8 bytes of padding.  */
230   memset (frame+n, 0xff, i );
231   n += i;
232   frame[n++] = 0;
233   memcpy (frame+n, md, mdlen );
234   n += mdlen;
235   assert (n == nframe);
236   
237   /* Create the S-expression.  */
238   rc = gcry_sexp_build (&hash, NULL,
239                         "(data (flags raw) (value %b))",
240                         (int)nframe, frame);
241   xfree (frame);
242
243   *r_hash = hash;
244   return rc;   
245 }
246
247
248
249 /* SIGN whatever information we have accumulated in CTRL and return
250    the signature S-expression.  LOOKUP is an optional function to
251    provide a way for lower layers to ask for the caching TTL.  If a
252    CACHE_NONCE is given that cache item is first tried to get a
253    passphrase.  */
254 int
255 agent_pksign_do (ctrl_t ctrl, const char *cache_nonce,
256                  const char *desc_text,
257                  gcry_sexp_t *signature_sexp,
258                  cache_mode_t cache_mode, lookup_ttl_t lookup_ttl)
259 {
260   gcry_sexp_t s_skey = NULL, s_sig = NULL;
261   unsigned char *shadow_info = NULL;
262   unsigned int rc = 0;          /* FIXME: gpg-error? */
263
264   if (! ctrl->have_keygrip)
265     return gpg_error (GPG_ERR_NO_SECKEY);
266
267   rc = agent_key_from_file (ctrl, cache_nonce, desc_text, ctrl->keygrip,
268                             &shadow_info, cache_mode, lookup_ttl,
269                             &s_skey, NULL);
270   if (rc)
271     {
272       log_error ("failed to read the secret key\n");
273       goto leave;
274     }
275
276   if (!s_skey)
277     {
278       /* Divert operation to the smartcard */
279
280       unsigned char *buf = NULL;
281       size_t len = 0;
282
283       rc = divert_pksign (ctrl, 
284                           ctrl->digest.value, 
285                           ctrl->digest.valuelen,
286                           ctrl->digest.algo,
287                           shadow_info, &buf);
288       if (rc)
289         {
290           log_error ("smartcard signing failed: %s\n", gpg_strerror (rc));
291           goto leave;
292         }
293       len = gcry_sexp_canon_len (buf, 0, NULL, NULL);
294       assert (len);
295
296       rc = gcry_sexp_sscan (&s_sig, NULL, (char*)buf, len);
297       xfree (buf);
298       if (rc)
299         {
300           log_error ("failed to convert sigbuf returned by divert_pksign "
301                      "into S-Exp: %s", gpg_strerror (rc));
302           goto leave;
303         }
304     }
305   else
306     {
307       /* No smartcard, but a private key */
308       gcry_sexp_t s_hash = NULL;
309       int dsaalgo;
310
311       /* Put the hash into a sexp */
312       if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
313         rc = do_encode_raw_pkcs1 (ctrl->digest.value,
314                                   ctrl->digest.valuelen,
315                                   gcry_pk_get_nbits (s_skey),
316                                   &s_hash);
317       else if ( (dsaalgo = agent_is_dsa_key (s_skey)) )
318         rc = do_encode_dsa (ctrl->digest.value,
319                             ctrl->digest.valuelen,
320                             dsaalgo, s_skey,
321                             &s_hash);
322       else
323         rc = do_encode_md (ctrl->digest.value,
324                            ctrl->digest.valuelen,
325                            ctrl->digest.algo,
326                            &s_hash,
327                            ctrl->digest.raw_value);
328       if (rc)
329         goto leave;
330
331       if (DBG_CRYPTO)
332         {
333           log_debug ("skey:\n");
334           gcry_sexp_dump (s_skey);
335           log_debug ("hash:\n");
336           gcry_sexp_dump (s_hash);
337         }
338
339       /* sign */
340       rc = gcry_pk_sign (&s_sig, s_hash, s_skey);
341       gcry_sexp_release (s_hash);
342       if (rc)
343         {
344           log_error ("signing failed: %s\n", gpg_strerror (rc));
345           goto leave;
346         }
347
348       if (DBG_CRYPTO)
349         {
350           log_debug ("result:\n");
351           gcry_sexp_dump (s_sig);
352         }
353     }
354
355  leave:
356
357   *signature_sexp = s_sig;
358
359   gcry_sexp_release (s_skey);
360   xfree (shadow_info);
361
362   return rc;
363 }
364
365 /* SIGN whatever information we have accumulated in CTRL and write it
366    back to OUTFP.  If a CACHE_NONCE is given that cache item is first
367    tried to get a passphrase.  */
368 int
369 agent_pksign (ctrl_t ctrl, const char *cache_nonce, const char *desc_text,
370               membuf_t *outbuf, cache_mode_t cache_mode) 
371 {
372   gcry_sexp_t s_sig = NULL;
373   char *buf = NULL;
374   size_t len = 0;
375   int rc = 0;
376
377   rc = agent_pksign_do (ctrl, cache_nonce, desc_text, &s_sig, cache_mode, NULL);
378   if (rc)
379     goto leave;
380
381   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, NULL, 0);
382   assert (len);
383   buf = xmalloc (len);
384   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, buf, len);
385   assert (len);
386
387   put_membuf (outbuf, buf, len);
388
389  leave:
390   gcry_sexp_release (s_sig);
391   xfree (buf);
392
393   return rc;
394 }