g10: ECDH shared point format.
[gnupg.git] / g10 / ecdh.c
1 /* ecdh.c - ECDH public key operations used in public key glue code
2  *      Copyright (C) 2010, 2011 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 <stdio.h>
22 #include <stdlib.h>
23 #include <string.h>
24 #include <errno.h>
25
26 #include "gpg.h"
27 #include "util.h"
28 #include "pkglue.h"
29 #include "main.h"
30 #include "options.h"
31
32 /* A table with the default KEK parameters used by GnuPG.  */
33 static const struct
34 {
35   unsigned int qbits;
36   int openpgp_hash_id;   /* KEK digest algorithm. */
37   int openpgp_cipher_id; /* KEK cipher algorithm. */
38 } kek_params_table[] =
39   /* Note: Must be sorted by ascending values for QBITS.  */
40   {
41     { 256, DIGEST_ALGO_SHA256, CIPHER_ALGO_AES    },
42     { 384, DIGEST_ALGO_SHA384, CIPHER_ALGO_AES256 },
43
44     /* Note: 528 is 521 rounded to the 8 bit boundary */
45     { 528, DIGEST_ALGO_SHA512, CIPHER_ALGO_AES256 }
46   };
47
48
49
50 /* Return KEK parameters as an opaque MPI The caller must free the
51    returned value.  Returns NULL and sets ERRNO on error.  */
52 gcry_mpi_t
53 pk_ecdh_default_params (unsigned int qbits)
54 {
55   byte *kek_params;
56   int i;
57
58   kek_params = xtrymalloc (4);
59   if (!kek_params)
60     return NULL;
61   kek_params[0] = 3; /* Number of bytes to follow. */
62   kek_params[1] = 1; /* Version for KDF+AESWRAP.   */
63
64   /* Search for matching KEK parameter.  Defaults to the strongest
65      possible choices.  Performance is not an issue here, only
66      interoperability.  */
67   for (i=0; i < DIM (kek_params_table); i++)
68     {
69       if (kek_params_table[i].qbits >= qbits
70           || i+1 == DIM (kek_params_table))
71         {
72           kek_params[2] = kek_params_table[i].openpgp_hash_id;
73           kek_params[3] = kek_params_table[i].openpgp_cipher_id;
74           break;
75         }
76     }
77   log_assert (i < DIM (kek_params_table));
78   if (DBG_CRYPTO)
79     log_printhex ("ECDH KEK params are", kek_params, sizeof(kek_params) );
80
81   return gcry_mpi_set_opaque (NULL, kek_params, 4 * 8);
82 }
83
84
85 /* Encrypts/decrypts DATA using a key derived from the ECC shared
86    point SHARED_MPI using the FIPS SP 800-56A compliant method
87    key_derivation+key_wrapping.  If IS_ENCRYPT is true the function
88    encrypts; if false, it decrypts.  PKEY is the public key and PK_FP
89    the fingerprint of this public key.  On success the result is
90    stored at R_RESULT; on failure NULL is stored at R_RESULT and an
91    error code returned.  */
92 gpg_error_t
93 pk_ecdh_encrypt_with_shared_point (int is_encrypt, gcry_mpi_t shared_mpi,
94                                    const byte pk_fp[MAX_FINGERPRINT_LEN],
95                                    gcry_mpi_t data, gcry_mpi_t *pkey,
96                                    gcry_mpi_t *r_result)
97 {
98   gpg_error_t err;
99   byte *secret_x;
100   int secret_x_size;
101   unsigned int nbits;
102   const unsigned char *kek_params;
103   size_t kek_params_size;
104   int kdf_hash_algo;
105   int kdf_encr_algo;
106   unsigned char message[256];
107   size_t message_size;
108
109   *r_result = NULL;
110
111   nbits = pubkey_nbits (PUBKEY_ALGO_ECDH, pkey);
112   if (!nbits)
113     return gpg_error (GPG_ERR_TOO_SHORT);
114
115   {
116     size_t nbytes;
117
118     /* Extract x component of the shared point: this is the actual
119        shared secret. */
120     nbytes = (mpi_get_nbits (pkey[1] /* public point */)+7)/8;
121     secret_x = xtrymalloc_secure (nbytes);
122     if (!secret_x)
123       return gpg_error_from_syserror ();
124
125     err = gcry_mpi_print (GCRYMPI_FMT_USG, secret_x, nbytes,
126                           &nbytes, shared_mpi);
127     if (err)
128       {
129         xfree (secret_x);
130         log_error ("ECDH ephemeral export of shared point failed: %s\n",
131                    gpg_strerror (err));
132         return err;
133       }
134
135     /* Expected size of the x component */
136     secret_x_size = (nbits+7)/8;
137
138     if (nbytes > secret_x_size)
139       {
140         /* Uncompressed format expected, so it must start with 04 */
141         if (secret_x[0] != (byte)0x04)
142           {
143             return gpg_error (GPG_ERR_BAD_DATA);
144           }
145
146         /* Remove the "04" prefix of non-compressed format.  */
147         memmove (secret_x, secret_x+1, secret_x_size);
148
149         /* Zeroize the y component following */
150         if (nbytes > secret_x_size)
151           memset (secret_x+secret_x_size, 0, nbytes-secret_x_size);
152       }
153     else if (nbytes < secret_x_size)
154       {
155         /* Raw share secret (x coordinate), without leading zeros */
156         memmove (secret_x+(secret_x_size - nbytes), secret_x, nbytes);
157         memset (secret_x, 0, secret_x_size - nbytes);
158       }
159     if (DBG_CRYPTO)
160       log_printhex ("ECDH shared secret X is:", secret_x, secret_x_size );
161   }
162
163   /*** We have now the shared secret bytes in secret_x. ***/
164
165   /* At this point we are done with PK encryption and the rest of the
166    * function uses symmetric key encryption techniques to protect the
167    * input DATA.  The following two sections will simply replace
168    * current secret_x with a value derived from it.  This will become
169    * a KEK.
170    */
171   if (!gcry_mpi_get_flag (pkey[2], GCRYMPI_FLAG_OPAQUE))
172     {
173       xfree (secret_x);
174       return gpg_error (GPG_ERR_BUG);
175     }
176   kek_params = gcry_mpi_get_opaque (pkey[2], &nbits);
177   kek_params_size = (nbits+7)/8;
178
179   if (DBG_CRYPTO)
180     log_printhex ("ecdh KDF params:", kek_params, kek_params_size);
181
182   /* Expect 4 bytes  03 01 hash_alg symm_alg.  */
183   if (kek_params_size != 4 || kek_params[0] != 3 || kek_params[1] != 1)
184     {
185       xfree (secret_x);
186       return gpg_error (GPG_ERR_BAD_PUBKEY);
187     }
188
189   kdf_hash_algo = kek_params[2];
190   kdf_encr_algo = kek_params[3];
191
192   if (DBG_CRYPTO)
193     log_debug ("ecdh KDF algorithms %s+%s with aeswrap\n",
194                openpgp_md_algo_name (kdf_hash_algo),
195                openpgp_cipher_algo_name (kdf_encr_algo));
196
197   if (kdf_hash_algo != GCRY_MD_SHA256
198       && kdf_hash_algo != GCRY_MD_SHA384
199       && kdf_hash_algo != GCRY_MD_SHA512)
200     {
201       xfree (secret_x);
202       return gpg_error (GPG_ERR_BAD_PUBKEY);
203     }
204   if (kdf_encr_algo != CIPHER_ALGO_AES
205       && kdf_encr_algo != CIPHER_ALGO_AES192
206       && kdf_encr_algo != CIPHER_ALGO_AES256)
207     {
208       xfree (secret_x);
209       return gpg_error (GPG_ERR_BAD_PUBKEY);
210     }
211
212   /* Build kdf_params.  */
213   {
214     IOBUF obuf;
215
216     obuf = iobuf_temp();
217     /* variable-length field 1, curve name OID */
218     err = gpg_mpi_write_nohdr (obuf, pkey[0]);
219     /* fixed-length field 2 */
220     iobuf_put (obuf, PUBKEY_ALGO_ECDH);
221     /* variable-length field 3, KDF params */
222     err = (err ? err : gpg_mpi_write_nohdr (obuf, pkey[2]));
223     /* fixed-length field 4 */
224     iobuf_write (obuf, "Anonymous Sender    ", 20);
225     /* fixed-length field 5, recipient fp */
226     iobuf_write (obuf, pk_fp, 20);
227
228     message_size = iobuf_temp_to_buffer (obuf, message, sizeof message);
229     iobuf_close (obuf);
230     if (err)
231       {
232         xfree (secret_x);
233         return err;
234       }
235
236     if(DBG_CRYPTO)
237       log_printhex ("ecdh KDF message params are:", message, message_size);
238   }
239
240   /* Derive a KEK (key wrapping key) using MESSAGE and SECRET_X. */
241   {
242     gcry_md_hd_t h;
243     int old_size;
244
245     err = gcry_md_open (&h, kdf_hash_algo, 0);
246     if (err)
247       {
248         log_error ("gcry_md_open failed for kdf_hash_algo %d: %s",
249                    kdf_hash_algo, gpg_strerror (err));
250         xfree (secret_x);
251         return err;
252       }
253     gcry_md_write(h, "\x00\x00\x00\x01", 4);      /* counter = 1 */
254     gcry_md_write(h, secret_x, secret_x_size);    /* x of the point X */
255     gcry_md_write(h, message, message_size);      /* KDF parameters */
256
257     gcry_md_final (h);
258
259     log_assert( gcry_md_get_algo_dlen (kdf_hash_algo) >= 32 );
260
261     memcpy (secret_x, gcry_md_read (h, kdf_hash_algo),
262             gcry_md_get_algo_dlen (kdf_hash_algo));
263     gcry_md_close (h);
264
265     old_size = secret_x_size;
266     log_assert( old_size >= gcry_cipher_get_algo_keylen( kdf_encr_algo ) );
267     secret_x_size = gcry_cipher_get_algo_keylen( kdf_encr_algo );
268     log_assert( secret_x_size <= gcry_md_get_algo_dlen (kdf_hash_algo) );
269
270     /* We could have allocated more, so clean the tail before returning.  */
271     memset (secret_x+secret_x_size, 0, old_size - secret_x_size);
272     if (DBG_CRYPTO)
273       log_printhex ("ecdh KEK is:", secret_x, secret_x_size );
274   }
275
276   /* And, finally, aeswrap with key secret_x.  */
277   {
278     gcry_cipher_hd_t hd;
279     size_t nbytes;
280
281     byte *data_buf;
282     int data_buf_size;
283
284     gcry_mpi_t result;
285
286     err = gcry_cipher_open (&hd, kdf_encr_algo, GCRY_CIPHER_MODE_AESWRAP, 0);
287     if (err)
288       {
289         log_error ("ecdh failed to initialize AESWRAP: %s\n",
290                    gpg_strerror (err));
291         xfree (secret_x);
292         return err;
293       }
294
295     err = gcry_cipher_setkey (hd, secret_x, secret_x_size);
296     xfree (secret_x);
297     secret_x = NULL;
298     if (err)
299       {
300         gcry_cipher_close (hd);
301         log_error ("ecdh failed in gcry_cipher_setkey: %s\n",
302                    gpg_strerror (err));
303         return err;
304       }
305
306     data_buf_size = (gcry_mpi_get_nbits(data)+7)/8;
307     if ((data_buf_size & 7) != (is_encrypt ? 0 : 1))
308       {
309         log_error ("can't use a shared secret of %d bytes for ecdh\n",
310                    data_buf_size);
311         return gpg_error (GPG_ERR_BAD_DATA);
312       }
313
314     data_buf = xtrymalloc_secure( 1 + 2*data_buf_size + 8);
315     if (!data_buf)
316       {
317         err = gpg_error_from_syserror ();
318         gcry_cipher_close (hd);
319         return err;
320       }
321
322     if (is_encrypt)
323       {
324         byte *in = data_buf+1+data_buf_size+8;
325
326         /* Write data MPI into the end of data_buf. data_buf is size
327            aeswrap data.  */
328         err = gcry_mpi_print (GCRYMPI_FMT_USG, in,
329                              data_buf_size, &nbytes, data/*in*/);
330         if (err)
331           {
332             log_error ("ecdh failed to export DEK: %s\n", gpg_strerror (err));
333             gcry_cipher_close (hd);
334             xfree (data_buf);
335             return err;
336           }
337
338         if (DBG_CRYPTO)
339           log_printhex ("ecdh encrypting  :", in, data_buf_size );
340
341         err = gcry_cipher_encrypt (hd, data_buf+1, data_buf_size+8,
342                                    in, data_buf_size);
343         memset (in, 0, data_buf_size);
344         gcry_cipher_close (hd);
345         if (err)
346           {
347             log_error ("ecdh failed in gcry_cipher_encrypt: %s\n",
348                        gpg_strerror (err));
349             xfree (data_buf);
350             return err;
351           }
352         data_buf[0] = data_buf_size+8;
353
354         if (DBG_CRYPTO)
355           log_printhex ("ecdh encrypted to:", data_buf+1, data_buf[0] );
356
357         result = gcry_mpi_set_opaque (NULL, data_buf, 8 * (1+data_buf[0]));
358         if (!result)
359           {
360             err = gpg_error_from_syserror ();
361             xfree (data_buf);
362             log_error ("ecdh failed to create an MPI: %s\n",
363                        gpg_strerror (err));
364             return err;
365           }
366
367         *r_result = result;
368       }
369     else
370       {
371         byte *in;
372         const void *p;
373
374         p = gcry_mpi_get_opaque (data, &nbits);
375         nbytes = (nbits+7)/8;
376         if (!p || nbytes > data_buf_size || !nbytes)
377           {
378             xfree (data_buf);
379             return gpg_error (GPG_ERR_BAD_MPI);
380           }
381         memcpy (data_buf, p, nbytes);
382         if (data_buf[0] != nbytes-1)
383           {
384             log_error ("ecdh inconsistent size\n");
385             xfree (data_buf);
386             return gpg_error (GPG_ERR_BAD_MPI);
387           }
388         in = data_buf+data_buf_size;
389         data_buf_size = data_buf[0];
390
391         if (DBG_CRYPTO)
392           log_printhex ("ecdh decrypting :", data_buf+1, data_buf_size);
393
394         err = gcry_cipher_decrypt (hd, in, data_buf_size, data_buf+1,
395                                    data_buf_size);
396         gcry_cipher_close (hd);
397         if (err)
398           {
399             log_error ("ecdh failed in gcry_cipher_decrypt: %s\n",
400                        gpg_strerror (err));
401             xfree (data_buf);
402             return err;
403           }
404
405         data_buf_size -= 8;
406
407         if (DBG_CRYPTO)
408           log_printhex ("ecdh decrypted to :", in, data_buf_size);
409
410         /* Padding is removed later.  */
411         /* if (in[data_buf_size-1] > 8 ) */
412         /*   { */
413         /*     log_error ("ecdh failed at decryption: invalid padding." */
414         /*                " 0x%02x > 8\n", in[data_buf_size-1] ); */
415         /*     return gpg_error (GPG_ERR_BAD_KEY); */
416         /*   } */
417
418         err = gcry_mpi_scan (&result, GCRYMPI_FMT_USG, in, data_buf_size, NULL);
419         xfree (data_buf);
420         if (err)
421           {
422             log_error ("ecdh failed to create a plain text MPI: %s\n",
423                        gpg_strerror (err));
424             return err;
425           }
426
427         *r_result = result;
428       }
429   }
430
431   return err;
432 }
433
434
435 static gcry_mpi_t
436 gen_k (unsigned nbits)
437 {
438   gcry_mpi_t k;
439
440   k = gcry_mpi_snew (nbits);
441   if (DBG_CRYPTO)
442     log_debug ("choosing a random k of %u bits\n", nbits);
443
444   gcry_mpi_randomize (k, nbits-1, GCRY_STRONG_RANDOM);
445
446   if (DBG_CRYPTO)
447     {
448       unsigned char *buffer;
449       if (gcry_mpi_aprint (GCRYMPI_FMT_HEX, &buffer, NULL, k))
450         BUG ();
451       log_debug ("ephemeral scalar MPI #0: %s\n", buffer);
452       gcry_free (buffer);
453     }
454
455   return k;
456 }
457
458
459 /* Generate an ephemeral key for the public ECDH key in PKEY.  On
460    success the generated key is stored at R_K; on failure NULL is
461    stored at R_K and an error code returned.  */
462 gpg_error_t
463 pk_ecdh_generate_ephemeral_key (gcry_mpi_t *pkey, gcry_mpi_t *r_k)
464 {
465   unsigned int nbits;
466   gcry_mpi_t k;
467
468   *r_k = NULL;
469
470   nbits = pubkey_nbits (PUBKEY_ALGO_ECDH, pkey);
471   if (!nbits)
472     return gpg_error (GPG_ERR_TOO_SHORT);
473   k = gen_k (nbits);
474   if (!k)
475     BUG ();
476
477   *r_k = k;
478   return 0;
479 }
480
481
482
483 /* Perform ECDH decryption.   */
484 int
485 pk_ecdh_decrypt (gcry_mpi_t * result, const byte sk_fp[MAX_FINGERPRINT_LEN],
486                  gcry_mpi_t data, gcry_mpi_t shared, gcry_mpi_t * skey)
487 {
488   if (!data)
489     return gpg_error (GPG_ERR_BAD_MPI);
490   return pk_ecdh_encrypt_with_shared_point (0 /*=decryption*/, shared,
491                                             sk_fp, data/*encr data as an MPI*/,
492                                             skey, result);
493 }