Add some libgcrypt dox
[gnupg.git] / g10 / seskey.c
1 /* seskey.c -  make sesssion keys etc.
2  *      Copyright (C) 1998 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
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 <gcrypt.h>
28 #include "util.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     GCRY_CIPHER_HD chd;
40     int i, rc;
41
42     dek->keylen = gcry_cipher_get_algo_keylen( dek->algo );
43
44     if( !(chd = gcry_cipher_open( dek->algo, GCRY_CIPHER_MODE_CFB,
45                                        GCRY_CIPHER_SECURE
46                                        | (dek->algo >= 100 ?
47                                            0 : GCRY_CIPHER_ENABLE_SYNC) ))
48                           ) {
49         BUG();
50     }
51
52     gcry_randomize( dek->key, dek->keylen, GCRY_STRONG_RANDOM );
53     for(i=0; i < 16; i++ ) {
54         rc = gcry_cipher_setkey( chd, dek->key, dek->keylen );
55         if( !rc ) {
56             gcry_cipher_close( chd );
57             return;
58         }
59         if( rc != GCRYERR_WEAK_KEY )
60             BUG();
61         log_info(_("weak key created - retrying\n") );
62         /* Renew the session key until we get a non-weak key. */
63         gcry_randomize( dek->key, dek->keylen, GCRY_STRONG_RANDOM );
64     }
65     log_fatal(_(
66             "cannot avoid weak key for symmetric cipher; tried %d times!\n"),
67                   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 MPI
77 encode_session_key( DEK *dek, unsigned nbits )
78 {
79     int nframe = (nbits+7) / 8;
80     byte *p;
81     byte *frame;
82     int i,n;
83     u16 csum;
84     MPI a;
85
86     /* the current limitation is that we can only use a session key
87      * whose length is a multiple of BITS_PER_MPI_LIMB
88      * I think we can live with that.
89      */
90     if( dek->keylen + 7 > nframe || !nframe )
91         log_bug("can't encode a %d bit key in a %d bits frame\n",
92                     dek->keylen*8, nbits );
93
94     /* We encode the session key in this way:
95      *
96      *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
97      *
98      * (But how can we store the leading 0 - the external representaion
99      *  of MPIs doesn't allow leading zeroes =:-)
100      *
101      * RND are non-zero random bytes.
102      * A   is the cipher algorithm
103      * DEK is the encryption key (session key) length k depends on the
104      *     cipher algorithm (20 is used with blowfish160).
105      * CSUM is the 16 bit checksum over the DEK
106      */
107     csum = 0;
108     for( p = dek->key, i=0; i < dek->keylen; i++ )
109         csum += *p++;
110
111     frame = gcry_xmalloc_secure( nframe );
112     n = 0;
113     frame[n++] = 0;
114     frame[n++] = 2;
115     i = nframe - 6 - dek->keylen;
116     assert( i > 0 );
117     p = gcry_random_bytes_secure( i, GCRY_STRONG_RANDOM );
118     /* replace zero bytes by new values */
119     for(;;) {
120         int j, k;
121         byte *pp;
122
123         /* count the zero bytes */
124         for(j=k=0; j < i; j++ )
125             if( !p[j] )
126                 k++;
127         if( !k )
128             break; /* okay: no zero bytes */
129         k += k/128; /* better get some more */
130         pp = gcry_random_bytes_secure( k, GCRY_STRONG_RANDOM);
131         for(j=0; j < i && k ; j++ )
132             if( !p[j] )
133                 p[j] = pp[--k];
134         gcry_free(pp);
135     }
136     memcpy( frame+n, p, i );
137     gcry_free(p);
138     n += i;
139     frame[n++] = 0;
140     frame[n++] = dek->algo;
141     memcpy( frame+n, dek->key, dek->keylen ); n += dek->keylen;
142     frame[n++] = csum >>8;
143     frame[n++] = csum;
144     assert( n == nframe );
145     if( gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, &nframe ) )
146         BUG();
147     gcry_free(frame);
148
149     return a;
150 }
151
152
153 static MPI
154 do_encode_md( GCRY_MD_HD md, int algo, size_t len, unsigned nbits,
155                                        const byte *asn, size_t asnlen )
156 {
157     int nframe = (nbits+7) / 8;
158     byte *frame;
159     int i,n;
160     MPI a;
161
162     if( len + asnlen + 4  > nframe )
163         log_bug("can't encode a %d bit MD into a %d bits frame\n",
164                     (int)(len*8), (int)nbits);
165
166     /* We encode the MD in this way:
167      *
168      *     0  A PAD(n bytes)   0  ASN(asnlen bytes)  MD(len bytes)
169      *
170      * PAD consists of FF bytes.
171      */
172     frame = gcry_md_is_secure(md)? gcry_xmalloc_secure( nframe )
173                                  : gcry_xmalloc( nframe );
174     n = 0;
175     frame[n++] = 0;
176     frame[n++] = algo;
177     i = nframe - len - asnlen -3 ;
178     assert( i > 1 );
179     memset( frame+n, 0xff, i ); n += i;
180     frame[n++] = 0;
181     memcpy( frame+n, asn, asnlen ); n += asnlen;
182     memcpy( frame+n, gcry_md_read(md, algo), len ); n += len;
183     assert( n == nframe );
184     if( gcry_mpi_scan( &a, GCRYMPI_FMT_USG, frame, &nframe ) )
185         BUG();
186     gcry_free(frame);
187     return a;
188 }
189
190
191 MPI
192 encode_md_value( int pubkey_algo, GCRY_MD_HD md, int hash_algo, unsigned nbits )
193 {
194     int algo = hash_algo? hash_algo : gcry_md_get_algo(md);
195     MPI frame;
196
197     if( pubkey_algo == GCRY_PK_DSA ) {
198         size_t n = gcry_md_get_algo_dlen(hash_algo);
199         if( gcry_mpi_scan( &frame, GCRYMPI_FMT_USG,
200                                    gcry_md_read(md, hash_algo), &n ) )
201             BUG();
202     }
203     else {
204         byte *asn;
205         size_t asnlen;
206
207         if( gcry_md_algo_info( algo, GCRYCTL_GET_ASNOID, NULL, &asnlen ) )
208             log_fatal("can't get OID of algo %d: %s\n",
209                                             algo, gcry_strerror(-1));
210         asn = gcry_xmalloc( asnlen );
211         if( gcry_md_algo_info( algo, GCRYCTL_GET_ASNOID, asn, &asnlen ) )
212             BUG();
213         frame = do_encode_md( md, algo, gcry_md_get_algo_dlen( algo ),
214                                                      nbits, asn, asnlen );
215         gcry_free( asn );
216     }
217     return frame;
218 }
219