Integrating http://code.google.com/p/gnupg-ecc/source/detail?r=15 .
[gnupg.git] / g10 / seskey.c
1 /* seskey.c -  make sesssion keys etc.
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2006, 2009 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "gpg.h"
28 #include "util.h"
29 #include "cipher.h"
30 #include "options.h"
31 #include "main.h"
32 #include "i18n.h"
33
34
35 /****************
36  * Make a session key and put it into DEK
37  */
38 void
39 make_session_key( DEK *dek )
40 {
41     gcry_cipher_hd_t chd;
42     int i, rc;
43
44     dek->keylen = openpgp_cipher_get_algo_keylen (dek->algo);
45
46     if (openpgp_cipher_open (&chd, dek->algo, GCRY_CIPHER_MODE_CFB,
47                              (GCRY_CIPHER_SECURE
48                               | (dek->algo >= 100 ?
49                                  0 : GCRY_CIPHER_ENABLE_SYNC))) )
50       BUG();
51     gcry_randomize (dek->key, dek->keylen, GCRY_STRONG_RANDOM );
52     for (i=0; i < 16; i++ ) 
53       {
54         rc = gcry_cipher_setkey (chd, dek->key, dek->keylen);
55         if (!rc) 
56           {
57             gcry_cipher_close (chd);
58             return;
59           }
60         if (gpg_err_code (rc) != GPG_ERR_WEAK_KEY)
61           BUG();
62         log_info(_("weak key created - retrying\n") );
63         /* Renew the session key until we get a non-weak key. */
64         gcry_randomize (dek->key, dek->keylen, GCRY_STRONG_RANDOM);
65       }
66     log_fatal (_("cannot avoid weak key for symmetric cipher; "
67                  "tried %d times!\n"), i);
68 }
69
70
71 /****************
72  * Encode the session key. NBITS is the number of bits which should be used
73  * for packing the session key.
74  * returns: A mpi with the session key (caller must free)
75  */
76 gcry_mpi_t
77 encode_session_key (int openpgp_pk_algo, DEK *dek, unsigned int nbits)
78 {
79     size_t nframe = (nbits+7) / 8;
80     byte *p;
81     byte *frame;
82     int i,n;
83     u16 csum = 0;
84     gcry_mpi_t a;
85
86     if( DBG_CIPHER )
87        log_debug("encode_session_key: encoding %d byte DEK", dek->keylen);
88
89     for( p = dek->key, i=0; i < dek->keylen; i++ )
90         csum += *p++;
91
92     /* Shortcut for ECDH. It's padding is minimal to simply make the output be a multiple of 8 bytes. */
93     if( openpgp_pk_algo == PUBKEY_ALGO_ECDH )  {
94         /* pad to 8 byte granulatiry; the padding byte is the number of padded bytes.
95          * A  DEK(k bytes)  CSUM(2 bytes) 0x 0x 0x 0x ... 0x
96          *                                +---- x times ---+
97          */
98         nframe = ( 1 + dek->keylen + 2 /* the value so far is always odd */ + 7 ) & (~7);
99         assert( !(nframe%8) && nframe > 1 + dek->keylen + 2 );  /* alg+key+csum fit and the size is congruent to 8 */
100         frame = xmalloc_secure( nframe );
101         n = 0;
102         frame[n++] = dek->algo;
103         memcpy( frame+n, dek->key, dek->keylen ); n += dek->keylen;
104         frame[n++] = csum >>8;
105         frame[n++] = csum;
106         i = nframe - n;         /* number padded bytes */
107         memset( frame+n, i, i );/* use it as the value of each padded byte */
108         assert( n+i == nframe );
109
110         if( DBG_CIPHER )
111                 log_debug("encode_session_key: [%d] %02x  %02x %02x ...  %02x %02x %02x", nframe, frame[0],frame[1],frame[2], frame[nframe-3],frame[nframe-2],frame[nframe-1]);
112
113         if (gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, nframe, &nframe))
114                 BUG();
115         xfree(frame);
116         return a;
117     }
118
119     /* The current limitation is that we can only use a session key
120      * whose length is a multiple of BITS_PER_MPI_LIMB
121      * I think we can live with that.
122      */
123     if( dek->keylen + 7 > nframe || !nframe )
124         log_bug("can't encode a %d bit key in a %d bits frame\n",
125                     dek->keylen*8, nbits );
126
127     /* We encode the session key in this way:
128      *
129      *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
130      *
131      * (But how can we store the leading 0 - the external representaion
132      *  of MPIs doesn't allow leading zeroes =:-)
133      *
134      * RND are non-zero random bytes.
135      * A   is the cipher algorithm
136      * DEK is the encryption key (session key) length k depends on the
137      *     cipher algorithm (20 is used with blowfish160).
138      * CSUM is the 16 bit checksum over the DEK
139      */
140
141     frame = xmalloc_secure( nframe );
142     n = 0;
143     frame[n++] = 0;
144     frame[n++] = 2;
145     i = nframe - 6 - dek->keylen;
146     assert( i > 0 );
147     p = gcry_random_bytes_secure (i, GCRY_STRONG_RANDOM);
148     /* Replace zero bytes by new values. */
149     for(;;) {
150         int j, k;
151         byte *pp;
152
153         /* count the zero bytes */
154         for(j=k=0; j < i; j++ )
155             if( !p[j] )
156                 k++;
157         if( !k )
158             break; /* okay: no zero bytes */
159         k += k/128 + 3; /* better get some more */
160         pp = gcry_random_bytes_secure (k, GCRY_STRONG_RANDOM);
161         for(j=0; j < i && k ;) {
162             if( !p[j] )
163                 p[j] = pp[--k];
164             if (p[j])
165               j++;
166         }
167         xfree(pp);
168     }
169     memcpy( frame+n, p, i );
170     xfree(p);
171     n += i;
172     frame[n++] = 0;
173     frame[n++] = dek->algo;
174     memcpy( frame+n, dek->key, dek->keylen ); n += dek->keylen;
175     frame[n++] = csum >>8;
176     frame[n++] = csum;
177     assert( n == nframe );
178     if (gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, n, &nframe))
179       BUG();
180     xfree(frame);
181     return a;
182 }
183
184
185 static gcry_mpi_t
186 do_encode_md( gcry_md_hd_t md, int algo, size_t len, unsigned nbits,
187               const byte *asn, size_t asnlen )
188 {
189     size_t nframe = (nbits+7) / 8;
190     byte *frame;
191     int i,n;
192     gcry_mpi_t a;
193
194     if( len + asnlen + 4  > nframe )
195         log_bug("can't encode a %d bit MD into a %d bits frame, algo=%d\n",
196                     (int)(len*8), (int)nbits, algo);
197
198     /* We encode the MD in this way:
199      *
200      *     0  1 PAD(n bytes)   0  ASN(asnlen bytes)  MD(len bytes)
201      *
202      * PAD consists of FF bytes.
203      */
204     frame = gcry_md_is_secure (md)? xmalloc_secure (nframe) : xmalloc (nframe);
205     n = 0;
206     frame[n++] = 0;
207     frame[n++] = 1; /* block type */
208     i = nframe - len - asnlen -3 ;
209     assert( i > 1 );
210     memset( frame+n, 0xff, i ); n += i;
211     frame[n++] = 0;
212     memcpy( frame+n, asn, asnlen ); n += asnlen;
213     memcpy( frame+n, gcry_md_read (md, algo), len ); n += len;
214     assert( n == nframe );
215
216     if (gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, n, &nframe ))
217         BUG();
218     xfree(frame);
219
220     /* Note that PGP before version 2.3 encoded the MD as:
221      *
222      *   0   1   MD(16 bytes)   0   PAD(n bytes)   1
223      *
224      * The MD is always 16 bytes here because it's always MD5.  We do
225      * not support pre-v2.3 signatures, but I'm including this comment
226      * so the information is easily found in the future.
227      */
228
229     return a;
230 }
231
232
233 /****************
234  * Encode a message digest into an MPI.
235  * If it's for a DSA signature, make sure that the hash is large
236  * enough to fill up q.  If the hash is too big, take the leftmost
237  * bits.
238  */
239 gcry_mpi_t
240 encode_md_value (PKT_public_key *pk, gcry_md_hd_t md, int hash_algo)
241 {
242   gcry_mpi_t frame;
243   int gcry_pkalgo;
244
245   assert (hash_algo);
246   assert (pk);
247
248   gcry_pkalgo = map_pk_openpgp_to_gcry( pk->pubkey_algo );
249
250   if (gcry_pkalgo == GCRY_PK_DSA || gcry_pkalgo == GCRY_PK_ECDSA )
251     {
252       /* It's a DSA signature, so find out the size of q. */
253
254       size_t qbytes = gcry_mpi_get_nbits (pk->pkey[1]);
255
256       /* pkey[1] is Q for ECDSA, which is an uncompressed point, i.e.  04 <x> <y> */
257       if( gcry_pkalgo==GCRY_PK_ECDSA )
258           qbytes = ecdsa_qbits_from_Q( qbytes );
259
260       /* Make sure it is a multiple of 8 bits. */
261
262       if(qbytes%8)
263         {
264           log_error(_("DSA requires the hash length to be a"
265                       " multiple of 8 bits\n"));
266           return NULL;
267         }
268
269       /* Don't allow any q smaller than 160 bits.  This might need a
270          revisit as the DSA2 design firms up, but for now, we don't
271          want someone to issue signatures from a key with a 16-bit q
272          or something like that, which would look correct but allow
273          trivial forgeries.  Yes, I know this rules out using MD5 with
274          DSA. ;) */
275       if (qbytes < 160)
276         {
277           log_error (_("%s key %s uses an unsafe (%zu bit) hash\n"),
278                         gcry_pk_algo_name( gcry_pkalgo ),
279                      keystr_from_pk (pk), qbytes);
280           return NULL;
281         }
282
283       qbytes /= 8;
284
285       /* Check if we're too short.  Too long is safe as we'll
286          automatically left-truncate. */
287       /* This checks would require the use of SHA512 with ECDSA 512. I think this is overkill to fail in this case.
288        * Therefore, relax the check, but only for ECDSA keys. We may need to adjust it later for general case.
289        * ( Note that the check will never pass for ECDSA 521 anyway as the only hash that intended to match it is SHA 512, but 512 < 521 ).
290        */
291       //if (gcry_md_get_algo_dlen (hash_algo) < qbytes )
292       if (gcry_md_get_algo_dlen (hash_algo) < ((gcry_pkalgo==GCRY_PK_ECDSA && qbytes>(521)/8) ? 512/8 : qbytes) )
293         {
294           log_error (_("%s key %s requires a %zu bit or larger hash, used hash-algo=%d\n"),
295                         gcry_pk_algo_name( gcry_pkalgo ),
296                      keystr_from_pk(pk), qbytes*8, hash_algo);
297           return NULL;
298         }
299
300       if (gcry_mpi_scan (&frame, GCRYMPI_FMT_USG,
301                          gcry_md_read (md, hash_algo), qbytes, &qbytes))
302         BUG();
303     }
304   else
305     {
306       gpg_error_t rc;
307       byte *asn;
308       size_t asnlen;
309
310       rc = gcry_md_algo_info (hash_algo, GCRYCTL_GET_ASNOID, NULL, &asnlen);
311       if (rc)
312         log_fatal ("can't get OID of digest algorithm %d: %s\n",
313                    hash_algo, gpg_strerror (rc));
314       asn = xtrymalloc (asnlen);
315       if (!asn)
316         return NULL;
317       if ( gcry_md_algo_info (hash_algo, GCRYCTL_GET_ASNOID, asn, &asnlen) )
318         BUG();
319       frame = do_encode_md (md, hash_algo, gcry_md_get_algo_dlen (hash_algo),
320                             gcry_mpi_get_nbits (pk->pkey[0]), asn, asnlen);
321       xfree (asn);
322     }
323
324   return frame;
325 }