See ChangeLog: Tue Oct 26 14:10:21 CEST 1999 Werner Koch
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certificate packet handling
2  *      Copyright (C) 1998, 1999 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 "memory.h"
30 #include "packet.h"
31 #include "mpi.h"
32 #include "keydb.h"
33 #include "main.h"
34 #include "options.h"
35 #include "i18n.h"
36 #include "status.h"
37
38
39 static int
40 do_check( PKT_secret_key *sk )
41 {
42     byte *buffer;
43     u16 csum=0;
44     int i, res;
45     unsigned nbytes;
46
47     if( sk->is_protected ) { /* remove the protection */
48         DEK *dek = NULL;
49         u32 keyid[4]; /* 4! because we need two of them */
50         GCRY_CIPHER_HD cipher_hd=NULL;
51         PKT_secret_key *save_sk;
52
53         if( sk->protect.algo == GCRY_CIPHER_NONE )
54             BUG();
55         if( openpgp_cipher_test_algo( sk->protect.algo ) ) {
56             log_info(_("protection algorithm %d is not supported\n"),
57                         sk->protect.algo );
58             return G10ERR_CIPHER_ALGO;
59         }
60         keyid_from_sk( sk, keyid );
61         keyid[2] = keyid[3] = 0;
62         if( !sk->is_primary ) {
63             PKT_secret_key *sk2 = m_alloc_clear( sizeof *sk2 );
64             if( !get_primary_seckey( sk2, keyid ) )
65                 keyid_from_sk( sk2, keyid+2 );
66             free_secret_key( sk2 );
67         }
68         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
69                                  &sk->protect.s2k, 0 );
70         if( !(cipher_hd = gcry_cipher_open( sk->protect.algo,
71                                       GCRY_CIPHER_MODE_CFB,
72                                       GCRY_CIPHER_SECURE
73                                       | (sk->protect.algo >= 100 ?
74                                            0 : GCRY_CIPHER_ENABLE_SYNC) ) )
75                                     ) {
76             BUG();
77         }
78
79         if( gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
80             log_fatal("set key failed: %s\n", gcry_strerror(-1) );
81         m_free(dek);
82         save_sk = copy_secret_key( NULL, sk );
83         if( gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen ))
84             log_fatal("set IV failed: %s\n", gcry_strerror(-1) );
85         csum = 0;
86         if( sk->version >= 4 ) {
87             int ndata;
88             byte *p, *data;
89
90             i = pubkey_get_npkey(sk->pubkey_algo);
91             assert( mpi_is_opaque( sk->skey[i] ) );
92             p = mpi_get_opaque( sk->skey[i], &ndata );
93             data = m_alloc_secure( ndata );
94             gcry_cipher_decrypt( cipher_hd, data, ndata, p, ndata );
95             mpi_free( sk->skey[i] ); sk->skey[i] = NULL ;
96             p = data;
97             if( ndata < 2 ) {
98                 log_error("not enough bytes for checksum\n");
99                 sk->csum = 0;
100                 csum = 1;
101             }
102             else {
103                 csum = checksum( data, ndata-2);
104                 sk->csum = data[ndata-2] << 8 | data[ndata-1];
105             }
106             /* must check it here otherwise the mpi_read_xx would fail
107              * because the length das an abritary value */
108             if( sk->csum == csum ) {
109                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
110                     nbytes = ndata;
111                     sk->skey[i] = mpi_read_from_buffer(p, &nbytes, 1 );
112                     ndata -= nbytes;
113                     p += nbytes;
114                 }
115             }
116             m_free(data);
117         }
118         else {
119             for(i=pubkey_get_npkey(sk->pubkey_algo);
120                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
121                 buffer = mpi_get_secure_buffer( sk->skey[i], &nbytes, NULL );
122                 gcry_cipher_sync( cipher_hd );
123                 assert( mpi_is_protected(sk->skey[i]) );
124                 gcry_cipher_decrypt( cipher_hd, buffer, nbytes, NULL, 0 );
125                 mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
126                 mpi_clear_protect_flag( sk->skey[i] );
127                 csum += checksum_mpi( sk->skey[i] );
128                 m_free( buffer );
129             }
130             if( opt.emulate_bugs & EMUBUG_GPGCHKSUM ) {
131                csum = sk->csum;
132             }
133         }
134         gcry_cipher_close( cipher_hd );
135         /* now let's see whether we have used the right passphrase */
136         if( csum != sk->csum ) {
137             copy_secret_key( sk, save_sk );
138             free_secret_key( save_sk );
139             return G10ERR_BAD_PASS;
140         }
141         /* the checksum may fail, so we also check the key itself */
142         res = pubkey_check_secret_key( sk->pubkey_algo, sk->skey );
143         if( res ) {
144             copy_secret_key( sk, save_sk );
145             free_secret_key( save_sk );
146             return G10ERR_BAD_PASS;
147         }
148         free_secret_key( save_sk );
149         sk->is_protected = 0;
150     }
151     else { /* not protected, assume it is okay if the checksum is okay */
152         csum = 0;
153         for(i=pubkey_get_npkey(sk->pubkey_algo);
154                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
155             csum += checksum_mpi( sk->skey[i] );
156         }
157         if( csum != sk->csum )
158             return G10ERR_CHECKSUM;
159     }
160
161     return 0;
162 }
163
164
165
166 /****************
167  * Check the secret key
168  * Ask up to 3 (or n) times for a correct passphrase
169  */
170 int
171 check_secret_key( PKT_secret_key *sk, int n )
172 {
173     int rc = G10ERR_BAD_PASS;
174     int i;
175
176     if( n < 1 )
177         n = opt.batch? 1 : 3; /* use the default value */
178
179     for(i=0; i < n && rc == G10ERR_BAD_PASS; i++ ) {
180         if( i )
181             log_info(_("Invalid passphrase; please try again ...\n"));
182         rc = do_check( sk );
183         if( rc == G10ERR_BAD_PASS && is_status_enabled() ) {
184             u32 kid[2];
185             char buf[50];
186
187             keyid_from_sk( sk, kid );
188             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
189             write_status_text( STATUS_BAD_PASSPHRASE, buf );
190         }
191         if( have_static_passphrase() )
192             break;
193     }
194
195     if( !rc )
196         write_status( STATUS_GOOD_PASSPHRASE );
197
198     return rc;
199 }
200
201 /****************
202  * check whether the secret key is protected.
203  * Returns: 0 not protected, -1 on error or the protection algorithm
204  */
205 int
206 is_secret_key_protected( PKT_secret_key *sk )
207 {
208     return sk->is_protected? sk->protect.algo : 0;
209 }
210
211
212
213 /****************
214  * Protect the secret key with the passphrase from DEK
215  */
216 int
217 protect_secret_key( PKT_secret_key *sk, DEK *dek )
218 {
219     int i,j, rc = 0;
220     byte *buffer;
221     unsigned nbytes;
222     u16 csum;
223
224     if( !dek )
225         return 0;
226
227     if( !sk->is_protected ) { /* okay, apply the protection */
228         GCRY_CIPHER_HD cipher_hd=NULL;
229
230         if( openpgp_cipher_test_algo( sk->protect.algo ) )
231             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
232         else {
233             print_cipher_algo_note( sk->protect.algo );
234             if( !(cipher_hd = gcry_cipher_open( sk->protect.algo,
235                                           GCRY_CIPHER_MODE_CFB,
236                                           GCRY_CIPHER_SECURE
237                                           | (sk->protect.algo >= 100 ?
238                                               0 : GCRY_CIPHER_ENABLE_SYNC) ))
239                                          ) {
240                 BUG();
241             }
242
243
244             rc = gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen );
245             if( rc == GCRYERR_WEAK_KEY ) {
246                 log_info(_("WARNING: Weak key detected"
247                            " - please change passphrase again.\n"));
248                 rc = 0;
249             }
250             else if( rc )
251                 BUG();
252
253             /* set the IV length */
254             {   int blocksize = gcry_cipher_get_algo_blklen( sk->protect.algo );
255                 if( blocksize != 8 && blocksize != 16 )
256                     log_fatal("unsupported blocksize %d\n", blocksize );
257                 sk->protect.ivlen = blocksize;
258             }
259
260             assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
261             randomize_buffer(sk->protect.iv, sk->protect.ivlen, 1);
262             gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
263             if( sk->version >= 4 ) {
264               #define NMPIS (PUBKEY_MAX_NSKEY - PUBKEY_MAX_NPKEY)
265                 byte *bufarr[NMPIS];
266                 unsigned narr[NMPIS];
267                 unsigned nbits[NMPIS];
268                 int ndata=0;
269                 byte *p, *data;
270
271                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
272                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
273                     assert( !mpi_is_opaque( sk->skey[i] ) );
274                     bufarr[j] = mpi_get_buffer( sk->skey[i], &narr[j], NULL );
275                     nbits[j]  = mpi_get_nbits( sk->skey[i] );
276                     ndata += narr[j] + 2;
277                 }
278                 for( ; j < NMPIS; j++ )
279                     bufarr[j] = NULL;
280                 ndata += 2; /* for checksum */
281
282                 data = m_alloc_secure( ndata );
283                 p = data;
284                 for(j=0; j < NMPIS && bufarr[j]; j++ ) {
285                     p[0] = nbits[j] >> 8 ;
286                     p[1] = nbits[j];
287                     p += 2;
288                     memcpy(p, bufarr[j], narr[j] );
289                     p += narr[j];
290                     m_free(bufarr[j]);
291                 }
292               #undef NMPIS
293                 csum = checksum( data, ndata-2);
294                 sk->csum = csum;
295                 *p++ =  csum >> 8;
296                 *p++ =  csum;
297                 assert( p == data+ndata );
298                 gcry_cipher_encrypt( cipher_hd, data, ndata, NULL, 0 );
299                 for(i = pubkey_get_npkey(sk->pubkey_algo);
300                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
301                     mpi_free( sk->skey[i] );
302                     sk->skey[i] = NULL;
303                 }
304                 i = pubkey_get_npkey(sk->pubkey_algo);
305                 sk->skey[i] = mpi_set_opaque(NULL, data, ndata );
306             }
307             else {
308                 /* NOTE: we always recalculate the checksum because there
309                  * are some test releases which calculated it wrong */
310                 csum = 0;
311                 for(i=pubkey_get_npkey(sk->pubkey_algo);
312                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
313                     csum += checksum_mpi_counted_nbits( sk->skey[i] );
314                     buffer = mpi_get_buffer( sk->skey[i], &nbytes, NULL );
315                     gcry_cipher_sync( cipher_hd );
316                     assert( !mpi_is_protected(sk->skey[i]) );
317                     gcry_cipher_encrypt( cipher_hd, buffer, nbytes, NULL, 0 );
318                     mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
319                     mpi_set_protect_flag( sk->skey[i] );
320                     m_free( buffer );
321                 }
322                 sk->csum = csum;
323             }
324             sk->is_protected = 1;
325             gcry_cipher_close( cipher_hd );
326         }
327     }
328     return rc;
329 }
330