28e208e55ca61402780dd1f8eb97f055f92eb1bb
[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
123   *r_hash = NULL;
124
125   if (dsaalgo == GCRY_PK_ECDSA)
126     qbits = gcry_pk_get_nbits (pkey);
127   else if (dsaalgo == GCRY_PK_DSA)
128     qbits = get_dsa_qbits (pkey);
129   else
130     return gpg_error (GPG_ERR_WRONG_PUBKEY_ALGO);
131   
132   if ((qbits%8))
133     {
134       log_error (_("DSA requires the hash length to be a"
135                    " multiple of 8 bits\n"));
136       return gpg_error (GPG_ERR_INV_LENGTH);
137     }
138
139   /* Don't allow any Q smaller than 160 bits.  We don't want someone
140      to issue signatures from a key with a 16-bit Q or something like
141      that, which would look correct but allow trivial forgeries.  Yes,
142      I know this rules out using MD5 with DSA. ;) */
143   if (qbits < 160)
144     {
145       log_error (_("%s key uses an unsafe (%u bit) hash\n"),
146                  gcry_pk_algo_name (dsaalgo), qbits);
147       return gpg_error (GPG_ERR_INV_LENGTH);
148     }
149
150   /* Check if we're too short.  Too long is safe as we'll
151      automatically left-truncate.  */
152   if (mdlen < qbits/8)
153     {
154       log_error (_("a %zu bit hash is not valid for a %u bit %s key\n"),
155                  mdlen*8,
156                  gcry_pk_get_nbits (pkey), 
157                  gcry_pk_algo_name (dsaalgo));
158       /* FIXME: we need to check the requirements for ECDSA.  */
159       if (mdlen < 20 || dsaalgo == GCRY_PK_DSA)
160         return gpg_error (GPG_ERR_INV_LENGTH);
161     }
162
163   /* Truncate.  */
164   if (mdlen > qbits/8)
165     mdlen = qbits/8;
166             
167   /* Create the S-expression.  We need to convert to an MPI first
168      because we want an unsigned integer.  Using %b directly is not
169      possible because libgcrypt assumes an mpi and uses
170      GCRYMPI_FMT_STD for parsing and thus possible yielding a negative
171      value.  */
172   {
173     gcry_mpi_t mpi;
174       
175     err = gcry_mpi_scan (&mpi, GCRYMPI_FMT_USG, md, mdlen, NULL);
176     if (!err)
177       {
178         err = gcry_sexp_build (&hash, NULL,
179                                "(data (flags raw) (value %m))", mpi);
180         gcry_mpi_release (mpi);
181       }
182   }
183   if (!err)
184     *r_hash = hash;
185   return err;   
186 }
187
188
189 /* Special version of do_encode_md to take care of pkcs#1 padding.
190    For TLS-MD5SHA1 we need to do the padding ourself as Libgrypt does
191    not know about this special scheme.  Fixme: We should have a
192    pkcs1-only-padding flag for Libgcrypt. */
193 static int
194 do_encode_raw_pkcs1 (const byte *md, size_t mdlen, unsigned int nbits,
195                      gcry_sexp_t *r_hash)
196 {
197   int rc;
198   gcry_sexp_t hash;
199   unsigned char *frame;
200   size_t i, n, nframe;
201             
202   nframe = (nbits+7) / 8;
203   if ( !mdlen || mdlen + 8 + 4 > nframe )
204     {
205       /* Can't encode this hash into a frame of size NFRAME. */
206       return gpg_error (GPG_ERR_TOO_SHORT);
207     }
208
209   frame = xtrymalloc (nframe);
210   if (!frame)
211     return gpg_error_from_syserror ();
212   
213   /* Assemble the pkcs#1 block type 1. */
214   n = 0;
215   frame[n++] = 0;
216   frame[n++] = 1; /* Block type. */
217   i = nframe - mdlen - 3 ;
218   assert (i >= 8); /* At least 8 bytes of padding.  */
219   memset (frame+n, 0xff, i );
220   n += i;
221   frame[n++] = 0;
222   memcpy (frame+n, md, mdlen );
223   n += mdlen;
224   assert (n == nframe);
225   
226   /* Create the S-expression.  */
227   rc = gcry_sexp_build (&hash, NULL,
228                         "(data (flags raw) (value %b))",
229                         (int)nframe, frame);
230   xfree (frame);
231
232   *r_hash = hash;
233   return rc;   
234 }
235
236
237
238 /* SIGN whatever information we have accumulated in CTRL and return
239    the signature S-expression.  LOOKUP is an optional function to
240    provide a way for lower layers to ask for the caching TTL. */
241 int
242 agent_pksign_do (ctrl_t ctrl, const char *desc_text,
243                  gcry_sexp_t *signature_sexp,
244                  cache_mode_t cache_mode, lookup_ttl_t lookup_ttl)
245 {
246   gcry_sexp_t s_skey = NULL, s_sig = NULL;
247   unsigned char *shadow_info = NULL;
248   unsigned int rc = 0;          /* FIXME: gpg-error? */
249
250   if (! ctrl->have_keygrip)
251     return gpg_error (GPG_ERR_NO_SECKEY);
252
253   rc = agent_key_from_file (ctrl, desc_text, ctrl->keygrip,
254                             &shadow_info, cache_mode, lookup_ttl,
255                             &s_skey);
256   if (rc)
257     {
258       log_error ("failed to read the secret key\n");
259       goto leave;
260     }
261
262   if (!s_skey)
263     {
264       /* Divert operation to the smartcard */
265
266       unsigned char *buf = NULL;
267       size_t len = 0;
268
269       rc = divert_pksign (ctrl, 
270                           ctrl->digest.value, 
271                           ctrl->digest.valuelen,
272                           ctrl->digest.algo,
273                           shadow_info, &buf);
274       if (rc)
275         {
276           log_error ("smartcard signing failed: %s\n", gpg_strerror (rc));
277           goto leave;
278         }
279       len = gcry_sexp_canon_len (buf, 0, NULL, NULL);
280       assert (len);
281
282       rc = gcry_sexp_sscan (&s_sig, NULL, (char*)buf, len);
283       xfree (buf);
284       if (rc)
285         {
286           log_error ("failed to convert sigbuf returned by divert_pksign "
287                      "into S-Exp: %s", gpg_strerror (rc));
288           goto leave;
289         }
290     }
291   else
292     {
293       /* No smartcard, but a private key */
294       gcry_sexp_t s_hash = NULL;
295       int dsaalgo;
296
297       /* Put the hash into a sexp */
298       if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
299         rc = do_encode_raw_pkcs1 (ctrl->digest.value,
300                                   ctrl->digest.valuelen,
301                                   gcry_pk_get_nbits (s_skey),
302                                   &s_hash);
303       else if ( (dsaalgo = agent_is_dsa_key (s_skey)) )
304         rc = do_encode_dsa (ctrl->digest.value,
305                             ctrl->digest.valuelen,
306                             dsaalgo, s_skey,
307                             &s_hash);
308       else
309         rc = do_encode_md (ctrl->digest.value,
310                            ctrl->digest.valuelen,
311                            ctrl->digest.algo,
312                            &s_hash,
313                            ctrl->digest.raw_value);
314       if (rc)
315         goto leave;
316
317       if (DBG_CRYPTO)
318         {
319           log_debug ("skey:\n");
320           gcry_sexp_dump (s_skey);
321           log_debug ("hash:\n");
322           gcry_sexp_dump (s_hash);
323         }
324
325       /* sign */
326       rc = gcry_pk_sign (&s_sig, s_hash, s_skey);
327       gcry_sexp_release (s_hash);
328       if (rc)
329         {
330           log_error ("signing failed: %s\n", gpg_strerror (rc));
331           goto leave;
332         }
333
334       if (DBG_CRYPTO)
335         {
336           log_debug ("result:\n");
337           gcry_sexp_dump (s_sig);
338         }
339     }
340
341  leave:
342
343   *signature_sexp = s_sig;
344
345   gcry_sexp_release (s_skey);
346   xfree (shadow_info);
347
348   return rc;
349 }
350
351 /* SIGN whatever information we have accumulated in CTRL and write it
352    back to OUTFP. */
353 int
354 agent_pksign (ctrl_t ctrl, const char *desc_text,
355               membuf_t *outbuf, cache_mode_t cache_mode) 
356 {
357   gcry_sexp_t s_sig = NULL;
358   char *buf = NULL;
359   size_t len = 0;
360   int rc = 0;
361
362   rc = agent_pksign_do (ctrl, desc_text, &s_sig, cache_mode, NULL);
363   if (rc)
364     goto leave;
365
366   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, NULL, 0);
367   assert (len);
368   buf = xmalloc (len);
369   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, buf, len);
370   assert (len);
371
372   put_membuf (outbuf, buf, len);
373
374  leave:
375   gcry_sexp_release (s_sig);
376   xfree (buf);
377
378   return rc;
379 }