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