See ChangeLog: Wed Oct 4 13:16:18 CEST 2000 Werner Koch
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certificate packet handling
2  *      Copyright (C) 1998, 1999, 2000 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 /****************
38  * Emulate our old PK interface here - sometime in the future we might
39  * change the internal design to directly fit to libgcrypt.
40  */
41 static int
42 pk_check_secret_key( int algo, MPI *skey )
43 {
44     GCRY_SEXP s_skey;
45     int rc;
46
47     /* make a sexp from skey */
48     if( algo == GCRY_PK_DSA ) {
49         rc = gcry_sexp_build ( &s_skey, NULL,
50                               "(private-key(dsa(p%m)(q%m)(g%m)(y%m)(x%m)))",
51                                   skey[0], skey[1], skey[2], skey[3], skey[4] );
52     }
53     else if( algo == GCRY_PK_ELG || algo == GCRY_PK_ELG_E ) {
54         rc = gcry_sexp_build ( &s_skey, NULL,
55                               "(private-key(elg(p%m)(g%m)(y%m)(x%m)))",
56                                   skey[0], skey[1], skey[2], skey[3] );
57     }
58     else if( algo == GCRY_PK_RSA ) {
59         rc = gcry_sexp_build ( &s_skey, NULL,
60                      "(private-key(rsa(n%m)(e%m)(d%m)(p%m)(q%m)(u%m)))",
61                        skey[0], skey[1], skey[2], skey[3], skey[4], skey[5] );
62     }
63     else
64         return GPGERR_PUBKEY_ALGO;
65
66     if ( rc )
67         BUG ();
68
69     rc = gcry_pk_testkey( s_skey );
70     gcry_sexp_release( s_skey );
71     return rc;
72 }
73
74
75 static int
76 do_check( PKT_secret_key *sk )
77 {
78     u16 csum=0;
79     int i, res;
80     unsigned nbytes;
81
82     if( sk->is_protected ) { /* remove the protection */
83         DEK *dek = NULL;
84         u32 keyid[4]; /* 4! because we need two of them */
85         GCRY_CIPHER_HD cipher_hd=NULL;
86         PKT_secret_key *save_sk;
87
88         if( sk->protect.s2k.mode == 1001 ) {
89             log_info(_("secret key parts are not available\n"));
90             return GPGERR_GENERAL;
91         }
92         if( sk->protect.algo == GCRY_CIPHER_NONE )
93             BUG();
94         if( openpgp_cipher_test_algo( sk->protect.algo ) ) {
95             log_info(_("protection algorithm %d is not supported\n"),
96                         sk->protect.algo );
97             return GPGERR_CIPHER_ALGO;
98         }
99         keyid_from_sk( sk, keyid );
100         keyid[2] = keyid[3] = 0;
101         if( !sk->is_primary ) {
102             keyid[2] = sk->main_keyid[0];
103             keyid[3] = sk->main_keyid[1];
104         }
105         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
106                                  &sk->protect.s2k, 0 );
107         /* Hmmm: Do we use sync mode here even for Twofish? */
108         if( !(cipher_hd = gcry_cipher_open( sk->protect.algo,
109                                       GCRY_CIPHER_MODE_CFB,
110                                       GCRY_CIPHER_SECURE
111                                       | (sk->protect.algo >= 100 ?
112                                            0 : GCRY_CIPHER_ENABLE_SYNC) ) )
113                                     ) {
114             BUG();
115         }
116
117         if( gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
118             log_fatal("set key failed: %s\n", gcry_strerror(-1) );
119         gcry_free(dek);
120         save_sk = copy_secret_key( NULL, sk );
121         if( gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen ))
122             log_fatal("set IV failed: %s\n", gcry_strerror(-1) );
123         csum = 0;
124         if( sk->version >= 4 ) {
125             size_t ndata;
126             unsigned int ndatabits;
127             byte *p, *data;
128             u16 csumc = 0;
129
130             i = pubkey_get_npkey(sk->pubkey_algo);
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             if ( ndata > 1 )
135                 csumc = p[ndata-2] << 8 | p[ndata-1];
136             data = gcry_xmalloc_secure( ndata );
137             gcry_cipher_decrypt( cipher_hd, data, ndata, p, ndata );
138             mpi_release( sk->skey[i] ); sk->skey[i] = NULL ;
139             p = data;
140             if( ndata < 2 ) {
141                 log_error("not enough bytes for checksum\n");
142                 sk->csum = 0;
143                 csum = 1;
144             }
145             else {
146                 csum = checksum( data, ndata-2);
147                 sk->csum = data[ndata-2] << 8 | data[ndata-1];
148                 if ( sk->csum != csum ) {
149                     /* This is a PGP 7.0.0 workaround */
150                     sk->csum = csumc; /* take the encrypted one */
151                 }
152             }
153             /* must check it here otherwise the mpi_read_xx would fail
154              * because the length may have an arbitrary value */
155             if( sk->csum == csum ) {
156                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
157                     nbytes = ndata;
158                     assert( gcry_is_secure( p ) );
159                     res = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_PGP,
160                                                              p, &nbytes);
161                     if( res )
162                         log_bug("gcry_mpi_scan failed in do_check: rc=%d\n", res);
163
164                     ndata -= nbytes;
165                     p += nbytes;
166                 }
167             }
168             gcry_free(data);
169         }
170         else {
171             for(i=pubkey_get_npkey(sk->pubkey_algo);
172                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
173                 size_t ndata;
174                 unsigned int ndatabits;
175                 byte *p, *data;
176
177                 assert( gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
178                 p = gcry_mpi_get_opaque( sk->skey[i], &ndatabits );
179                 ndata = (ndatabits+7)/8;
180                 data = gcry_xmalloc_secure( ndata );
181                 gcry_cipher_sync( cipher_hd );
182                 gcry_cipher_decrypt( cipher_hd, data, ndata, p, ndata );
183                 mpi_release( sk->skey[i] ); sk->skey[i] = NULL ;
184
185                 res = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_USG,
186                                      data, &ndata );
187                 if( res )
188                     log_bug("gcry_mpi_scan failed in do_check: rc=%d\n", res);
189
190                 csum += checksum_mpi( sk->skey[i] );
191                 gcry_free( data );
192             }
193         }
194         gcry_cipher_close( cipher_hd );
195         /* now let's see whether we have used the right passphrase */
196         if( csum != sk->csum ) {
197             copy_secret_key( sk, save_sk );
198             passphrase_clear_cache ( keyid, sk->pubkey_algo );
199             free_secret_key( save_sk );
200             return GPGERR_BAD_PASS;
201         }
202         /* the checksum may be correct in some cases,
203          * so we also check the key itself */
204         res = pk_check_secret_key( sk->pubkey_algo, sk->skey );
205         if( res ) {
206             copy_secret_key( sk, save_sk );
207             passphrase_clear_cache ( keyid, sk->pubkey_algo );
208             free_secret_key( save_sk );
209             return GPGERR_BAD_PASS;
210         }
211         free_secret_key( save_sk );
212         sk->is_protected = 0;
213     }
214     else { /* not protected, assume it is okay if the checksum is okay */
215         csum = 0;
216         for(i=pubkey_get_npkey(sk->pubkey_algo);
217                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
218             assert( !gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
219             csum += checksum_mpi( sk->skey[i] );
220         }
221         if( csum != sk->csum )
222             return GPGERR_CHECKSUM;
223     }
224
225     return 0;
226 }
227
228
229
230 /****************
231  * Check the secret key
232  * Ask up to 3 (or n) times for a correct passphrase
233  */
234 int
235 check_secret_key( PKT_secret_key *sk, int n )
236 {
237     int rc = GPGERR_BAD_PASS;
238     int i;
239
240     if( n < 1 )
241         n = opt.batch? 1 : 3; /* use the default value */
242
243     for(i=0; i < n && rc == GPGERR_BAD_PASS; i++ ) {
244         if( i )
245             log_info(_("Invalid passphrase; please try again ...\n"));
246         rc = do_check( sk );
247         if( rc == GPGERR_BAD_PASS && is_status_enabled() ) {
248             u32 kid[2];
249             char buf[50];
250
251             keyid_from_sk( sk, kid );
252             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
253             write_status_text( STATUS_BAD_PASSPHRASE, buf );
254         }
255         if( have_static_passphrase() )
256             break;
257     }
258
259     if( !rc )
260         write_status( STATUS_GOOD_PASSPHRASE );
261
262     return rc;
263 }
264
265 /****************
266  * check whether the secret key is protected.
267  * Returns: 0 not protected, -1 on error or the protection algorithm
268  */
269 int
270 is_secret_key_protected( PKT_secret_key *sk )
271 {
272     return sk->is_protected? sk->protect.algo : 0;
273 }
274
275
276
277 /****************
278  * Protect the secret key with the passphrase from DEK
279  */
280 int
281 protect_secret_key( PKT_secret_key *sk, DEK *dek )
282 {
283     int i,j, rc = 0;
284     byte *buffer;
285     unsigned nbytes;
286     u16 csum;
287
288     if( !dek )
289         return 0;
290
291     if( !sk->is_protected ) { /* okay, apply the protection */
292         GCRY_CIPHER_HD cipher_hd=NULL;
293
294         if( openpgp_cipher_test_algo( sk->protect.algo ) )
295             rc = GPGERR_CIPHER_ALGO; /* unsupport protection algorithm */
296         else {
297             print_cipher_algo_note( sk->protect.algo );
298             if( !(cipher_hd = gcry_cipher_open( sk->protect.algo,
299                                           GCRY_CIPHER_MODE_CFB,
300                                           GCRY_CIPHER_SECURE
301                                           | (sk->protect.algo >= 100 ?
302                                               0 : GCRY_CIPHER_ENABLE_SYNC) ))
303                                          ) {
304                 BUG();
305             }
306             rc = gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen );
307             if( rc == GCRYERR_WEAK_KEY ) {
308                 log_info(_("WARNING: Weak key detected"
309                            " - please change passphrase again.\n"));
310                 rc = 0;
311             }
312             else if( rc )
313                 BUG();
314
315             /* set the IV length */
316             {   int blocksize = gcry_cipher_get_algo_blklen( sk->protect.algo );
317                 if( blocksize != 8 && blocksize != 16 )
318                     log_fatal("unsupported blocksize %d\n", blocksize );
319                 sk->protect.ivlen = blocksize;
320                 assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
321             }
322             gcry_randomize(sk->protect.iv, sk->protect.ivlen,
323                                                          GCRY_STRONG_RANDOM);
324             gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
325
326             /* FIXME: replace set/get buffer */
327             if( sk->version >= 4 ) {
328                 byte *bufarr[GNUPG_MAX_NSKEY];
329                 unsigned narr[GNUPG_MAX_NSKEY];
330                 unsigned nbits[GNUPG_MAX_NSKEY];
331                 int ndata=0;
332                 byte *p, *data;
333
334                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
335                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
336                     assert( !gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
337
338                     if( gcry_mpi_aprint( GCRYMPI_FMT_USG, (void**)bufarr+j,
339                                                           narr+j, sk->skey[i]))
340                         BUG();
341
342                     nbits[j]  = gcry_mpi_get_nbits( sk->skey[i] );
343                     ndata += narr[j] + 2;
344                 }
345                 for( ; j < GNUPG_MAX_NSKEY; j++ )
346                     bufarr[j] = NULL;
347                 ndata += 2; /* for checksum */
348
349                 data = gcry_xmalloc_secure( ndata );
350                 p = data;
351                 for(j=0; j < GNUPG_MAX_NSKEY && bufarr[j]; j++ ) {
352                     p[0] = nbits[j] >> 8 ;
353                     p[1] = nbits[j];
354                     p += 2;
355                     memcpy(p, bufarr[j], narr[j] );
356                     p += narr[j];
357                     gcry_free(bufarr[j]);
358                 }
359                 csum = checksum( data, ndata-2);
360                 sk->csum = csum;
361                 *p++ =  csum >> 8;
362                 *p++ =  csum;
363                 assert( p == data+ndata );
364                 gcry_cipher_encrypt( cipher_hd, data, ndata, NULL, 0 );
365                 for(i = pubkey_get_npkey(sk->pubkey_algo);
366                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
367                     mpi_release( sk->skey[i] );
368                     sk->skey[i] = NULL;
369                 }
370                 i = pubkey_get_npkey(sk->pubkey_algo);
371                 sk->skey[i] = gcry_mpi_set_opaque(NULL, data, ndata*8 );
372             }
373             else {
374                 /* NOTE: we always recalculate the checksum because there
375                  * are some test releases which calculated it wrong */
376                 /* FIXME: Replace this code -- Hmmm: why */
377                 csum = 0;
378                 for(i=pubkey_get_npkey(sk->pubkey_algo);
379                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
380                     csum += checksum_mpi( sk->skey[i] );
381
382                     if( gcry_mpi_aprint( GCRYMPI_FMT_USG,
383                                          &buffer, &nbytes, sk->skey[i] ) )
384                         BUG();
385
386                     gcry_cipher_sync( cipher_hd );
387                     assert( !gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
388                     gcry_cipher_encrypt( cipher_hd, buffer, nbytes, NULL, 0 );
389                     gcry_mpi_release( sk->skey[i] );
390                     if( gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_USG,
391                                        buffer,&nbytes ) )
392                         BUG();
393
394                     gcry_free( buffer );
395                 }
396                 sk->csum = csum;
397             }
398             sk->is_protected = 1;
399             gcry_cipher_close( cipher_hd );
400         }
401     }
402     return rc;
403 }
404