Switched to GPLv3.
[gnupg.git] / g10 / seskey.c
1 /* seskey.c -  make sesssion keys etc.
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004,
3  *               2006 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 #include "util.h"
27 #include "cipher.h"
28 #include "mpi.h"
29 #include "main.h"
30 #include "i18n.h"
31
32
33 /****************
34  * Make a session key and put it into DEK
35  */
36 void
37 make_session_key( DEK *dek )
38 {
39     CIPHER_HANDLE chd;
40     int i, rc;
41
42     dek->keylen = cipher_get_keylen( dek->algo ) / 8;
43
44     chd = cipher_open( dek->algo, CIPHER_MODE_AUTO_CFB, 1 );
45     randomize_buffer( dek->key, dek->keylen, 1 );
46     for(i=0; i < 16; i++ ) {
47         rc = cipher_setkey( chd, dek->key, dek->keylen );
48         if( !rc ) {
49             cipher_close( chd );
50             return;
51         }
52         log_info(_("weak key created - retrying\n") );
53         /* Renew the session key until we get a non-weak key. */
54         randomize_buffer( dek->key, dek->keylen, 1 );
55     }
56     log_fatal(_(
57             "cannot avoid weak key for symmetric cipher; tried %d times!\n"),
58                   i);
59 }
60
61
62 /****************
63  * Encode the session key. NBITS is the number of bits which should be used
64  * for packing the session key.
65  * returns: A mpi with the session key (caller must free)
66  */
67 MPI
68 encode_session_key( DEK *dek, unsigned nbits )
69 {
70     int nframe = (nbits+7) / 8;
71     byte *p;
72     byte *frame;
73     int i,n;
74     u16 csum;
75     MPI a;
76
77     /* the current limitation is that we can only use a session key
78      * whose length is a multiple of BITS_PER_MPI_LIMB
79      * I think we can live with that.
80      */
81     if( dek->keylen + 7 > nframe || !nframe )
82         log_bug("can't encode a %d bit key in a %d bits frame\n",
83                     dek->keylen*8, nbits );
84
85     /* We encode the session key in this way:
86      *
87      *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
88      *
89      * (But how can we store the leading 0 - the external representaion
90      *  of MPIs doesn't allow leading zeroes =:-)
91      *
92      * RND are non-zero random bytes.
93      * A   is the cipher algorithm
94      * DEK is the encryption key (session key) length k depends on the
95      *     cipher algorithm (20 is used with blowfish160).
96      * CSUM is the 16 bit checksum over the DEK
97      */
98     csum = 0;
99     for( p = dek->key, i=0; i < dek->keylen; i++ )
100         csum += *p++;
101
102     frame = xmalloc_secure( nframe );
103     n = 0;
104     frame[n++] = 0;
105     frame[n++] = 2;
106     i = nframe - 6 - dek->keylen;
107     assert( i > 0 );
108     p = get_random_bits( i*8, 1, 1 );
109     /* replace zero bytes by new values */
110     for(;;) {
111         int j, k;
112         byte *pp;
113
114         /* count the zero bytes */
115         for(j=k=0; j < i; j++ )
116             if( !p[j] )
117                 k++;
118         if( !k )
119             break; /* okay: no zero bytes */
120         k += k/128 + 3; /* better get some more */
121         pp = get_random_bits( k*8, 1, 1);
122         for(j=0; j < i && k ;) {
123             if( !p[j] )
124                 p[j] = pp[--k];
125             if (p[j])
126               j++;
127         }
128         xfree(pp);
129     }
130     memcpy( frame+n, p, i );
131     xfree(p);
132     n += i;
133     frame[n++] = 0;
134     frame[n++] = dek->algo;
135     memcpy( frame+n, dek->key, dek->keylen ); n += dek->keylen;
136     frame[n++] = csum >>8;
137     frame[n++] = csum;
138     assert( n == nframe );
139     a = mpi_alloc_secure ( mpi_nlimb_hint_from_nbytes (nframe) );
140     mpi_set_buffer( a, frame, nframe, 0 );
141     xfree(frame);
142     return a;
143 }
144
145
146 static MPI
147 do_encode_md( MD_HANDLE md, int algo, size_t len, unsigned nbits,
148               const byte *asn, size_t asnlen )
149 {
150     int nframe = (nbits+7) / 8;
151     byte *frame;
152     int i,n;
153     MPI a;
154
155     if( len + asnlen + 4  > nframe )
156         log_bug("can't encode a %d bit MD into a %d bits frame\n",
157                     (int)(len*8), (int)nbits);
158
159     /* We encode the MD in this way:
160      *
161      *     0  1 PAD(n bytes)   0  ASN(asnlen bytes)  MD(len bytes)
162      *
163      * PAD consists of FF bytes.
164      */
165     frame = md_is_secure(md)? xmalloc_secure( nframe ) : xmalloc( nframe );
166     n = 0;
167     frame[n++] = 0;
168     frame[n++] = 1; /* block type */
169     i = nframe - len - asnlen -3 ;
170     assert( i > 1 );
171     memset( frame+n, 0xff, i ); n += i;
172     frame[n++] = 0;
173     memcpy( frame+n, asn, asnlen ); n += asnlen;
174     memcpy( frame+n, md_read(md, algo), len ); n += len;
175     assert( n == nframe );
176     a = (md_is_secure(md)
177          ? mpi_alloc_secure ( mpi_nlimb_hint_from_nbytes (nframe) )
178          : mpi_alloc ( mpi_nlimb_hint_from_nbytes (nframe )));
179     mpi_set_buffer( a, frame, nframe, 0 );
180     xfree(frame);
181
182     /* Note that PGP before version 2.3 encoded the MD as:
183      *
184      *   0   1   MD(16 bytes)   0   PAD(n bytes)   1
185      *
186      * The MD is always 16 bytes here because it's always MD5.  We do
187      * not support pre-v2.3 signatures, but I'm including this comment
188      * so the information is easily found in the future.
189      */
190
191     return a;
192 }
193
194
195 /****************
196  * Encode a message digest into an MPI.
197  * If it's for a DSA signature, make sure that the hash is large
198  * enough to fill up q.  If the hash is too big, take the leftmost
199  * bits.
200  */
201 MPI
202 encode_md_value( PKT_public_key *pk, PKT_secret_key *sk,
203                  MD_HANDLE md, int hash_algo )
204 {
205   MPI frame;
206
207   assert(hash_algo);
208   assert(pk || sk);
209
210   if((pk?pk->pubkey_algo:sk->pubkey_algo) == PUBKEY_ALGO_DSA)
211     {
212       /* It's a DSA signature, so find out the size of q. */
213
214       unsigned int qbytes=mpi_get_nbits(pk?pk->pkey[1]:sk->skey[1]);
215
216       /* Make sure it is a multiple of 8 bits. */
217
218       if(qbytes%8)
219         {
220           log_error(_("DSA requires the hash length to be a"
221                       " multiple of 8 bits\n"));
222           return NULL;
223         }
224
225       /* Don't allow any q smaller than 160 bits.  This might need a
226          revisit as the DSA2 design firms up, but for now, we don't
227          want someone to issue signatures from a key with a 16-bit q
228          or something like that, which would look correct but allow
229          trivial forgeries.  Yes, I know this rules out using MD5 with
230          DSA. ;) */
231
232       if(qbytes<160)
233         {
234           log_error(_("DSA key %s uses an unsafe (%u bit) hash\n"),
235                     pk?keystr_from_pk(pk):keystr_from_sk(sk),qbytes);
236           return NULL;
237         }
238
239       qbytes/=8;
240
241       /* Check if we're too short.  Too long is safe as we'll
242          automatically left-truncate. */
243
244       if(md_digest_length(hash_algo) < qbytes)
245         {
246           log_error(_("DSA key %s requires a %u bit or larger hash\n"),
247                     pk?keystr_from_pk(pk):keystr_from_sk(sk),qbytes*8);
248           return NULL;
249         }
250
251       frame = (md_is_secure(md)
252                ? mpi_alloc_secure (mpi_nlimb_hint_from_nbytes (qbytes) )
253                : mpi_alloc ( mpi_nlimb_hint_from_nbytes (qbytes) ));
254
255       mpi_set_buffer( frame, md_read(md, hash_algo), qbytes, 0 );
256     }
257   else
258     {
259       const byte *asn;
260       size_t asnlen,mdlen;
261
262       asn = md_asn_oid( hash_algo, &asnlen, &mdlen );
263       frame = do_encode_md( md, hash_algo, mdlen,
264                             mpi_get_nbits(pk?pk->pkey[0]:sk->skey[0]),
265                             asn, asnlen );
266     }
267
268   return frame;
269 }