Put asterisks in front of two function descriptions.
[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, 2010 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 "options.h"
30 #include "main.h"
31 #include "i18n.h"
32
33
34 /* Generate a new session key in *DEK that is appropriate for the
35  * algorithm DEK->ALGO (i.e., ensure that the key is not weak).
36  *
37  * This function overwrites DEK->KEYLEN, DEK->KEY.  The rest of the
38  * fields are left as is.  */
39 void
40 make_session_key( DEK *dek )
41 {
42     gcry_cipher_hd_t chd;
43     int i, rc;
44
45     dek->keylen = openpgp_cipher_get_algo_keylen (dek->algo);
46
47     if (openpgp_cipher_open (&chd, dek->algo, GCRY_CIPHER_MODE_CFB,
48                              (GCRY_CIPHER_SECURE
49                               | (dek->algo >= 100 ?
50                                  0 : GCRY_CIPHER_ENABLE_SYNC))) )
51       BUG();
52     gcry_randomize (dek->key, dek->keylen, GCRY_STRONG_RANDOM );
53     for (i=0; i < 16; i++ )
54       {
55         rc = gcry_cipher_setkey (chd, dek->key, dek->keylen);
56         if (!rc)
57           {
58             gcry_cipher_close (chd);
59             return;
60           }
61         if (gpg_err_code (rc) != GPG_ERR_WEAK_KEY)
62           BUG();
63         log_info(_("weak key created - retrying\n") );
64         /* Renew the session key until we get a non-weak key. */
65         gcry_randomize (dek->key, dek->keylen, GCRY_STRONG_RANDOM);
66       }
67     log_fatal (_("cannot avoid weak key for symmetric cipher; "
68                  "tried %d times!\n"), i);
69 }
70
71
72 /* Encode the session key stored in DEK as an MPI in preparation to
73  * encrypt it with the public key algorithm OPENPGP_PK_ALGO with a key
74  * whose length (the size of the public key) is NBITS.
75  *
76  * On success, returns an MPI, which the caller must free using
77  * gcry_mpi_release().  */
78 gcry_mpi_t
79 encode_session_key (int openpgp_pk_algo, DEK *dek, unsigned int nbits)
80 {
81   size_t nframe = (nbits+7) / 8;
82   byte *p;
83   byte *frame;
84   int i,n;
85   u16 csum;
86   gcry_mpi_t a;
87
88   if (DBG_CRYPTO)
89     log_debug ("encode_session_key: encoding %d byte DEK", dek->keylen);
90
91   csum = 0;
92   for (p = dek->key, i=0; i < dek->keylen; i++)
93     csum += *p++;
94
95   /* Shortcut for ECDH.  It's padding is minimal to simply make the
96      output be a multiple of 8 bytes.  */
97   if (openpgp_pk_algo == PUBKEY_ALGO_ECDH)
98     {
99       /* Pad to 8 byte granulatiry; the padding byte is the number of
100        * padded bytes.
101        *
102        * A  DEK(k bytes)  CSUM(2 bytes) 0x 0x 0x 0x ... 0x
103        *                                +---- x times ---+
104        */
105       nframe = (( 1 + dek->keylen + 2 /* The value so far is always odd. */
106                   + 7 ) & (~7));
107
108       /* alg+key+csum fit and the size is congruent to 8.  */
109       assert (!(nframe%8) && nframe > 1 + dek->keylen + 2 );
110
111       frame = xmalloc_secure (nframe);
112       n = 0;
113       frame[n++] = dek->algo;
114       memcpy (frame+n, dek->key, dek->keylen);
115       n += dek->keylen;
116       frame[n++] = csum >> 8;
117       frame[n++] = csum;
118       i = nframe - n;         /* Number of padded bytes.  */
119       memset (frame+n, i, i); /* Use it as the value of each padded byte.  */
120       assert (n+i == nframe);
121
122       if (DBG_CRYPTO)
123         log_debug ("encode_session_key: "
124                    "[%d] %02x  %02x %02x ...  %02x %02x %02x\n",
125                    (int) nframe, frame[0], frame[1], frame[2],
126                    frame[nframe-3], frame[nframe-2], frame[nframe-1]);
127
128       if (gcry_mpi_scan (&a, GCRYMPI_FMT_USG, frame, nframe, &nframe))
129         BUG();
130       xfree(frame);
131       return a;
132     }
133
134   /* The current limitation is that we can only use a session key
135    * whose length is a multiple of BITS_PER_MPI_LIMB
136    * I think we can live with that.
137    */
138   if (dek->keylen + 7 > nframe || !nframe)
139     log_bug ("can't encode a %d bit key in a %d bits frame\n",
140              dek->keylen*8, nbits );
141
142   /* We encode the session key according to PKCS#1 v1.5 (see section
143    * 13.1.1 of RFC 4880):
144    *
145    *       0  2  RND(i bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
146    *
147    * (But how can we store the leading 0 - the external representaion
148    *  of MPIs doesn't allow leading zeroes =:-)
149    *
150    * RND are (at least 1) non-zero random bytes.
151    * A   is the cipher algorithm
152    * DEK is the encryption key (session key) length k depends on the
153    *       cipher algorithm (20 is used with blowfish160).
154    * CSUM is the 16 bit checksum over the DEK
155    */
156
157   frame = xmalloc_secure( nframe );
158   n = 0;
159   frame[n++] = 0;
160   frame[n++] = 2;
161   /* The number of random bytes are the number of otherwise unused
162      bytes.  See diagram above.  */
163   i = nframe - 6 - dek->keylen;
164   assert( i > 0 );
165   p = gcry_random_bytes_secure (i, GCRY_STRONG_RANDOM);
166   /* Replace zero bytes by new values.  */
167   for (;;)
168     {
169       int j, k;
170       byte *pp;
171
172       /* Count the zero bytes. */
173       for (j=k=0; j < i; j++ )
174         if (!p[j])
175           k++;
176       if (!k)
177         break; /* Okay: no zero bytes. */
178       k += k/128 + 3; /* Better get some more. */
179       pp = gcry_random_bytes_secure (k, GCRY_STRONG_RANDOM);
180       for (j=0; j < i && k ;)
181         {
182           if (!p[j])
183             p[j] = pp[--k];
184           if (p[j])
185             j++;
186         }
187       xfree (pp);
188     }
189   memcpy (frame+n, p, i);
190   xfree (p);
191   n += i;
192   frame[n++] = 0;
193   frame[n++] = dek->algo;
194   memcpy (frame+n, dek->key, dek->keylen );
195   n += dek->keylen;
196   frame[n++] = csum >>8;
197   frame[n++] = csum;
198   assert (n == nframe);
199   if (gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, n, &nframe))
200     BUG();
201   xfree (frame);
202   return a;
203 }
204
205
206 static gcry_mpi_t
207 do_encode_md( gcry_md_hd_t md, int algo, size_t len, unsigned nbits,
208               const byte *asn, size_t asnlen )
209 {
210     size_t nframe = (nbits+7) / 8;
211     byte *frame;
212     int i,n;
213     gcry_mpi_t a;
214
215     if( len + asnlen + 4  > nframe )
216       log_bug ("can't encode a %d bit MD into a %d bits frame, algo=%d\n",
217                (int)(len*8), (int)nbits, algo);
218
219     /* We encode the MD in this way:
220      *
221      *     0  1 PAD(n bytes)   0  ASN(asnlen bytes)  MD(len bytes)
222      *
223      * PAD consists of FF bytes.
224      */
225     frame = gcry_md_is_secure (md)? xmalloc_secure (nframe) : xmalloc (nframe);
226     n = 0;
227     frame[n++] = 0;
228     frame[n++] = 1; /* block type */
229     i = nframe - len - asnlen -3 ;
230     assert( i > 1 );
231     memset( frame+n, 0xff, i ); n += i;
232     frame[n++] = 0;
233     memcpy( frame+n, asn, asnlen ); n += asnlen;
234     memcpy( frame+n, gcry_md_read (md, algo), len ); n += len;
235     assert( n == nframe );
236
237     if (gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, n, &nframe ))
238         BUG();
239     xfree(frame);
240
241     /* Note that PGP before version 2.3 encoded the MD as:
242      *
243      *   0   1   MD(16 bytes)   0   PAD(n bytes)   1
244      *
245      * The MD is always 16 bytes here because it's always MD5.  We do
246      * not support pre-v2.3 signatures, but I'm including this comment
247      * so the information is easily found in the future.
248      */
249
250     return a;
251 }
252
253
254 /****************
255  * Encode a message digest into an MPI.
256  * If it's for a DSA signature, make sure that the hash is large
257  * enough to fill up q.  If the hash is too big, take the leftmost
258  * bits.
259  */
260 gcry_mpi_t
261 encode_md_value (PKT_public_key *pk, gcry_md_hd_t md, int hash_algo)
262 {
263   gcry_mpi_t frame;
264   size_t mdlen;
265
266   assert (hash_algo);
267   assert (pk);
268
269   if (pk->pubkey_algo == PUBKEY_ALGO_EDDSA)
270     {
271       /* EdDSA signs data of arbitrary length.  Thus no special
272          treatment is required.  */
273       frame = gcry_mpi_set_opaque_copy (NULL, gcry_md_read (md, hash_algo),
274                                         8*gcry_md_get_algo_dlen (hash_algo));
275     }
276   else if (pk->pubkey_algo == PUBKEY_ALGO_DSA
277            || pk->pubkey_algo == PUBKEY_ALGO_ECDSA)
278     {
279       /* It's a DSA signature, so find out the size of q.  */
280
281       size_t qbits = gcry_mpi_get_nbits (pk->pkey[1]);
282
283       /* pkey[1] is Q for ECDSA, which is an uncompressed point,
284          i.e.  04 <x> <y>  */
285       if (pk->pubkey_algo == PUBKEY_ALGO_ECDSA)
286         qbits = ecdsa_qbits_from_Q (qbits);
287
288       /* Make sure it is a multiple of 8 bits. */
289       if ((qbits%8))
290         {
291           log_error(_("DSA requires the hash length to be a"
292                       " multiple of 8 bits\n"));
293           return NULL;
294         }
295
296       /* Don't allow any q smaller than 160 bits.  This might need a
297          revisit as the DSA2 design firms up, but for now, we don't
298          want someone to issue signatures from a key with a 16-bit q
299          or something like that, which would look correct but allow
300          trivial forgeries.  Yes, I know this rules out using MD5 with
301          DSA. ;) */
302       if (qbits < 160)
303         {
304           log_error (_("%s key %s uses an unsafe (%zu bit) hash\n"),
305                      openpgp_pk_algo_name (pk->pubkey_algo),
306                      keystr_from_pk (pk), qbits);
307           return NULL;
308         }
309
310
311       /* ECDSA 521 is special has it is larger than the largest hash
312          we have (SHA-512).  Thus we chnage the size for further
313          processing to 512.  */
314       if (pk->pubkey_algo == PUBKEY_ALGO_ECDSA && qbits > 512)
315         qbits = 512;
316
317       /* Check if we're too short.  Too long is safe as we'll
318          automatically left-truncate.  */
319       mdlen = gcry_md_get_algo_dlen (hash_algo);
320       if (mdlen < qbits/8)
321         {
322           log_error (_("%s key %s requires a %zu bit or larger hash "
323                        "(hash is %s)\n"),
324                      openpgp_pk_algo_name (pk->pubkey_algo),
325                      keystr_from_pk (pk), qbits,
326                      gcry_md_algo_name (hash_algo));
327           return NULL;
328         }
329
330      /* Note that we do the truncation by passing QBITS/8 as length to
331         mpi_scan.  */
332       if (gcry_mpi_scan (&frame, GCRYMPI_FMT_USG,
333                          gcry_md_read (md, hash_algo), qbits/8, NULL))
334         BUG();
335     }
336   else
337     {
338       gpg_error_t rc;
339       byte *asn;
340       size_t asnlen;
341
342       rc = gcry_md_algo_info (hash_algo, GCRYCTL_GET_ASNOID, NULL, &asnlen);
343       if (rc)
344         log_fatal ("can't get OID of digest algorithm %d: %s\n",
345                    hash_algo, gpg_strerror (rc));
346       asn = xtrymalloc (asnlen);
347       if (!asn)
348         return NULL;
349       if ( gcry_md_algo_info (hash_algo, GCRYCTL_GET_ASNOID, asn, &asnlen) )
350         BUG();
351       frame = do_encode_md (md, hash_algo, gcry_md_get_algo_dlen (hash_algo),
352                             gcry_mpi_get_nbits (pk->pkey[0]), asn, asnlen);
353       xfree (asn);
354     }
355
356   return frame;
357 }