Avoid using the protect-tool to import pkcs#12.
[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.  */
168   err = gcry_sexp_build (&hash, NULL,
169                         "(data (flags raw) (value %b))",
170                         (int)mdlen, md);
171   if (!err)
172     *r_hash = hash;
173   return err;   
174 }
175
176
177 /* Special version of do_encode_md to take care of pkcs#1 padding.
178    For TLS-MD5SHA1 we need to do the padding ourself as Libgrypt does
179    not know about this special scheme.  Fixme: We should have a
180    pkcs1-only-padding flag for Libgcrypt. */
181 static int
182 do_encode_raw_pkcs1 (const byte *md, size_t mdlen, unsigned int nbits,
183                      gcry_sexp_t *r_hash)
184 {
185   int rc;
186   gcry_sexp_t hash;
187   unsigned char *frame;
188   size_t i, n, nframe;
189             
190   nframe = (nbits+7) / 8;
191   if ( !mdlen || mdlen + 8 + 4 > nframe )
192     {
193       /* Can't encode this hash into a frame of size NFRAME. */
194       return gpg_error (GPG_ERR_TOO_SHORT);
195     }
196
197   frame = xtrymalloc (nframe);
198   if (!frame)
199     return gpg_error_from_syserror ();
200   
201   /* Assemble the pkcs#1 block type 1. */
202   n = 0;
203   frame[n++] = 0;
204   frame[n++] = 1; /* Block type. */
205   i = nframe - mdlen - 3 ;
206   assert (i >= 8); /* At least 8 bytes of padding.  */
207   memset (frame+n, 0xff, i );
208   n += i;
209   frame[n++] = 0;
210   memcpy (frame+n, md, mdlen );
211   n += mdlen;
212   assert (n == nframe);
213   
214   /* Create the S-expression.  */
215   rc = gcry_sexp_build (&hash, NULL,
216                         "(data (flags raw) (value %b))",
217                         (int)nframe, frame);
218   xfree (frame);
219
220   *r_hash = hash;
221   return rc;   
222 }
223
224
225
226 /* SIGN whatever information we have accumulated in CTRL and return
227    the signature S-expression.  LOOKUP is an optional function to
228    provide a way for lower layers to ask for the caching TTL. */
229 int
230 agent_pksign_do (ctrl_t ctrl, const char *desc_text,
231                  gcry_sexp_t *signature_sexp,
232                  cache_mode_t cache_mode, lookup_ttl_t lookup_ttl)
233 {
234   gcry_sexp_t s_skey = NULL, s_sig = NULL;
235   unsigned char *shadow_info = NULL;
236   unsigned int rc = 0;          /* FIXME: gpg-error? */
237
238   if (! ctrl->have_keygrip)
239     return gpg_error (GPG_ERR_NO_SECKEY);
240
241   rc = agent_key_from_file (ctrl, desc_text, ctrl->keygrip,
242                             &shadow_info, cache_mode, lookup_ttl,
243                             &s_skey);
244   if (rc)
245     {
246       log_error ("failed to read the secret key\n");
247       goto leave;
248     }
249
250   if (!s_skey)
251     {
252       /* Divert operation to the smartcard */
253
254       unsigned char *buf = NULL;
255       size_t len = 0;
256
257       rc = divert_pksign (ctrl, 
258                           ctrl->digest.value, 
259                           ctrl->digest.valuelen,
260                           ctrl->digest.algo,
261                           shadow_info, &buf);
262       if (rc)
263         {
264           log_error ("smartcard signing failed: %s\n", gpg_strerror (rc));
265           goto leave;
266         }
267       len = gcry_sexp_canon_len (buf, 0, NULL, NULL);
268       assert (len);
269
270       rc = gcry_sexp_sscan (&s_sig, NULL, (char*)buf, len);
271       xfree (buf);
272       if (rc)
273         {
274           log_error ("failed to convert sigbuf returned by divert_pksign "
275                      "into S-Exp: %s", gpg_strerror (rc));
276           goto leave;
277         }
278     }
279   else
280     {
281       /* No smartcard, but a private key */
282       gcry_sexp_t s_hash = NULL;
283       int dsaalgo;
284
285       /* Put the hash into a sexp */
286       if (ctrl->digest.algo == MD_USER_TLS_MD5SHA1)
287         rc = do_encode_raw_pkcs1 (ctrl->digest.value,
288                                   ctrl->digest.valuelen,
289                                   gcry_pk_get_nbits (s_skey),
290                                   &s_hash);
291       else if ( (dsaalgo = agent_is_dsa_key (s_skey)) )
292         rc = do_encode_dsa (ctrl->digest.value,
293                             ctrl->digest.valuelen,
294                             dsaalgo, s_skey,
295                             &s_hash);
296       else
297         rc = do_encode_md (ctrl->digest.value,
298                            ctrl->digest.valuelen,
299                            ctrl->digest.algo,
300                            &s_hash,
301                            ctrl->digest.raw_value);
302       if (rc)
303         goto leave;
304
305       if (DBG_CRYPTO)
306         {
307           log_debug ("skey: ");
308           gcry_sexp_dump (s_skey);
309         }
310
311       /* sign */
312       rc = gcry_pk_sign (&s_sig, s_hash, s_skey);
313       gcry_sexp_release (s_hash);
314       if (rc)
315         {
316           log_error ("signing failed: %s\n", gpg_strerror (rc));
317           goto leave;
318         }
319
320       if (DBG_CRYPTO)
321         {
322           log_debug ("result: ");
323           gcry_sexp_dump (s_sig);
324         }
325     }
326
327  leave:
328
329   *signature_sexp = s_sig;
330
331   gcry_sexp_release (s_skey);
332   xfree (shadow_info);
333
334   return rc;
335 }
336
337 /* SIGN whatever information we have accumulated in CTRL and write it
338    back to OUTFP. */
339 int
340 agent_pksign (ctrl_t ctrl, const char *desc_text,
341               membuf_t *outbuf, cache_mode_t cache_mode) 
342 {
343   gcry_sexp_t s_sig = NULL;
344   char *buf = NULL;
345   size_t len = 0;
346   int rc = 0;
347
348   rc = agent_pksign_do (ctrl, desc_text, &s_sig, cache_mode, NULL);
349   if (rc)
350     goto leave;
351
352   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, NULL, 0);
353   assert (len);
354   buf = xmalloc (len);
355   len = gcry_sexp_sprint (s_sig, GCRYSEXP_FMT_CANON, buf, len);
356   assert (len);
357
358   put_membuf (outbuf, buf, len);
359
360  leave:
361   gcry_sexp_release (s_sig);
362   xfree (buf);
363
364   return rc;
365 }