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