ready for a new release
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certifucate packet handling
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 #include "util.h"
27 #include "memory.h"
28 #include "packet.h"
29 #include "mpi.h"
30 #include "keydb.h"
31 #include "cipher.h"
32 #include "main.h"
33 #include "options.h"
34 #include "i18n.h"
35
36
37 static int
38 do_check( PKT_secret_key *sk )
39 {
40     byte *buffer;
41     u16 csum=0;
42     int i, res;
43     unsigned nbytes;
44
45     if( sk->is_protected ) { /* remove the protection */
46         DEK *dek = NULL;
47         u32 keyid[2];
48         CIPHER_HANDLE cipher_hd=NULL;
49         PKT_secret_key *save_sk;
50         char save_iv[8];
51
52         if( sk->protect.algo == CIPHER_ALGO_NONE )
53             BUG();
54         if( check_cipher_algo( sk->protect.algo ) )
55             return G10ERR_CIPHER_ALGO; /* unsupported protection algorithm */
56         if( cipher_get_blocksize( sk->protect.algo ) != 8 )
57             return G10ERR_CIPHER_ALGO; /* unsupported protection algorithm */
58         keyid_from_sk( sk, keyid );
59         dek = passphrase_to_dek( keyid, sk->protect.algo,
60                                  &sk->protect.s2k, 0 );
61         cipher_hd = cipher_open( sk->protect.algo,
62                                  CIPHER_MODE_AUTO_CFB, 1);
63         cipher_setkey( cipher_hd, dek->key, dek->keylen );
64         cipher_setiv( cipher_hd, NULL );
65         m_free(dek);
66         save_sk = copy_secret_key( NULL, sk );
67         memcpy(save_iv, sk->protect.iv, 8 );
68         cipher_decrypt( cipher_hd, sk->protect.iv, sk->protect.iv, 8 );
69         csum = 0;
70         if( sk->version >= 4 ) {
71             int ndata;
72             byte *p, *data;
73
74
75             i = pubkey_get_npkey(sk->pubkey_algo);
76             assert( mpi_is_opaque( sk->skey[i] ) );
77             p = mpi_get_opaque( sk->skey[i], &ndata );
78             data = m_alloc_secure( ndata );
79             cipher_decrypt( cipher_hd, data, p, ndata );
80             mpi_free( sk->skey[i] ); sk->skey[i] = NULL ;
81             p = data;
82             if( ndata < 2 ) {
83                 log_error("not enough bytes for checksum\n");
84                 sk->csum = 0;
85                 csum = 1;
86             }
87             else {
88                 csum = checksum( data, ndata-2);
89                 sk->csum = data[ndata-2] << 8 | data[ndata-1];
90             }
91             /* must check it here otherwise the mpi_read_xx would fail
92              * because the length das an abritary value */
93             if( sk->csum == csum ) {
94                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
95                     nbytes = ndata;
96                     sk->skey[i] = mpi_read_from_buffer(p, &nbytes, 1 );
97                     ndata -= nbytes;
98                     p += nbytes;
99                 }
100             }
101             m_free(data);
102         }
103         else {
104             for(i=pubkey_get_npkey(sk->pubkey_algo);
105                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
106                 buffer = mpi_get_secure_buffer( sk->skey[i], &nbytes, NULL );
107                 cipher_sync( cipher_hd );
108                 assert( mpi_is_protected(sk->skey[i]) );
109                 cipher_decrypt( cipher_hd, buffer, buffer, nbytes );
110                 mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
111                 mpi_clear_protect_flag( sk->skey[i] );
112                 csum += checksum_mpi( sk->skey[i] );
113                 m_free( buffer );
114             }
115             if( opt.emulate_bugs & EMUBUG_GPGCHKSUM ) {
116                csum = sk->csum;
117             }
118         }
119         cipher_close( cipher_hd );
120         /* now let's see whether we have used the right passphrase */
121         if( csum != sk->csum ) {
122             copy_secret_key( sk, save_sk );
123             free_secret_key( save_sk );
124             memcpy( sk->protect.iv, save_iv, 8 );
125             return G10ERR_BAD_PASS;
126         }
127         /* the checksum may fail, so we also check the key itself */
128         res = pubkey_check_secret_key( sk->pubkey_algo, sk->skey );
129         if( res ) {
130             copy_secret_key( sk, save_sk );
131             free_secret_key( save_sk );
132             memcpy( sk->protect.iv, save_iv, 8 );
133             return G10ERR_BAD_PASS;
134         }
135         free_secret_key( save_sk );
136         sk->is_protected = 0;
137     }
138     else { /* not protected, assume it is okay if the checksum is okay */
139         csum = 0;
140         for(i=pubkey_get_npkey(sk->pubkey_algo);
141                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
142             csum += checksum_mpi( sk->skey[i] );
143         }
144         if( csum != sk->csum )
145             return G10ERR_CHECKSUM;
146     }
147
148     return 0;
149 }
150
151
152
153 /****************
154  * Check the secret key
155  * Ask up to 3 times for a correct passphrase
156  */
157 int
158 check_secret_key( PKT_secret_key *sk )
159 {
160     int rc = G10ERR_BAD_PASS;
161     int i;
162
163     for(i=0; i < 3 && rc == G10ERR_BAD_PASS; i++ ) {
164         if( i )
165             log_error(_("Invalid passphrase; please try again ...\n"));
166         rc = do_check( sk );
167       #if 0 /* set to 1 to enable the workaround */
168         if( rc == G10ERR_BAD_PASS && sk->is_protected
169             && sk->protect.algo == CIPHER_ALGO_BLOWFISH
170             && sk->pubkey_algo != PUBKEY_ALGO_ELGAMAL ) {
171             /* Workaround for a bug in 0.2.16 which still used
172              * a 160 bit key for BLOWFISH. */
173             log_info("trying workaround for 0.2.16 passphrase bug ...\n");
174             log_info("If you don't need this, uncomment it in g10/seckey-cert.c\n\n");
175             sk->protect.algo = CIPHER_ALGO_BLOWFISH160;
176             rc = do_check( sk );
177             if( rc )
178                 rc = G10ERR_BAD_PASS;
179             sk->protect.algo = CIPHER_ALGO_BLOWFISH;
180         }
181       #endif
182         if( get_passphrase_fd() != -1 )
183             break;
184     }
185
186     return rc;
187 }
188
189 /****************
190  * check whether the secret key is protected.
191  * Returns: 0 not protected, -1 on error or the protection algorithm
192  */
193 int
194 is_secret_key_protected( PKT_secret_key *sk )
195 {
196     return sk->is_protected? sk->protect.algo : 0;
197 }
198
199
200
201 /****************
202  * Protect the secret key with the passphrase from DEK
203  */
204 int
205 protect_secret_key( PKT_secret_key *sk, DEK *dek )
206 {
207     int i,j, rc = 0;
208     byte *buffer;
209     unsigned nbytes;
210     u16 csum;
211
212     if( !dek )
213         return 0;
214
215     if( !sk->is_protected ) { /* okay, apply the protection */
216         CIPHER_HANDLE cipher_hd=NULL;
217
218         if( check_cipher_algo( sk->protect.algo ) )
219             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
220         else if( cipher_get_blocksize( sk->protect.algo ) != 8 )
221             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
222         else {
223             cipher_hd = cipher_open( sk->protect.algo,
224                                      CIPHER_MODE_AUTO_CFB, 1 );
225             cipher_setkey( cipher_hd, dek->key, dek->keylen );
226             cipher_setiv( cipher_hd, NULL );
227             cipher_encrypt( cipher_hd, sk->protect.iv, sk->protect.iv, 8 );
228             if( sk->version >= 4 ) {
229               #define NMPIS (PUBKEY_MAX_NSKEY - PUBKEY_MAX_NPKEY)
230                 byte *buffer[NMPIS];
231                 unsigned nbytes[NMPIS];
232                 unsigned nbits[NMPIS];
233                 int ndata=0;
234                 byte *p, *data;
235
236                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
237                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
238                     assert( !mpi_is_opaque( sk->skey[i] ) );
239                     buffer[j] = mpi_get_buffer( sk->skey[i], &nbytes[j], NULL );
240                     nbits[j]  = mpi_get_nbits( sk->skey[i] );
241                     ndata += nbytes[j] + 2;
242                 }
243                 for( ; j < NMPIS; j++ )
244                     buffer[j] = NULL;
245                 ndata += 2; /* for checksum */
246
247                 data = m_alloc_secure( ndata );
248                 p = data;
249                 for(j=0; j < NMPIS && buffer[j]; j++ ) {
250                     p[0] = nbits[j] >> 8 ;
251                     p[1] = nbits[j];
252                     p += 2;
253                     memcpy(p, buffer[j], nbytes[j] );
254                     p += nbytes[j];
255                     m_free(buffer[j]);
256                 }
257               #undef NMPIS
258                 csum = checksum( data, ndata-2);
259                 sk->csum = csum;
260                 *p++ =  csum >> 8;
261                 *p++ =  csum;
262                 assert( p == data+ndata );
263                 cipher_encrypt( cipher_hd, data, data, ndata );
264                 for(i = pubkey_get_npkey(sk->pubkey_algo);
265                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
266                     mpi_free( sk->skey[i] );
267                     sk->skey[i] = NULL;
268                 }
269                 i = pubkey_get_npkey(sk->pubkey_algo);
270                 sk->skey[i] = mpi_set_opaque(NULL, data, ndata );
271             }
272             else {
273                 /* NOTE: we always recalculate the checksum because there
274                  * are some test releases which calculated it wrong */
275                 csum = 0;
276                 for(i=pubkey_get_npkey(sk->pubkey_algo);
277                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
278                     csum += checksum_mpi_counted_nbits( sk->skey[i] );
279                     buffer = mpi_get_buffer( sk->skey[i], &nbytes, NULL );
280                     cipher_sync( cipher_hd );
281                     assert( !mpi_is_protected(sk->skey[i]) );
282                     cipher_encrypt( cipher_hd, buffer, buffer, nbytes );
283                     mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
284                     mpi_set_protect_flag( sk->skey[i] );
285                     m_free( buffer );
286                 }
287                 sk->csum = csum;
288             }
289             sk->is_protected = 1;
290             cipher_close( cipher_hd );
291         }
292     }
293     return rc;
294 }
295