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