See ChangeLog: Mon Aug 21 17:59:17 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     byte *buffer;
79     u16 csum=0;
80     int i, res;
81     unsigned nbytes;
82
83     if( sk->is_protected ) { /* remove the protection */
84         DEK *dek = NULL;
85         u32 keyid[4]; /* 4! because we need two of them */
86         GCRY_CIPHER_HD cipher_hd=NULL;
87         PKT_secret_key *save_sk;
88
89         if( sk->protect.s2k.mode == 1001 ) {
90             log_info(_("secret key parts are not available\n"));
91             return GPGERR_GENERAL;
92         }
93         if( sk->protect.algo == GCRY_CIPHER_NONE )
94             BUG();
95         if( openpgp_cipher_test_algo( sk->protect.algo ) ) {
96             log_info(_("protection algorithm %d is not supported\n"),
97                         sk->protect.algo );
98             return GPGERR_CIPHER_ALGO;
99         }
100         keyid_from_sk( sk, keyid );
101         keyid[2] = keyid[3] = 0;
102         if( !sk->is_primary ) {
103             PKT_secret_key *sk2 = gcry_xcalloc( 1, sizeof *sk2 );
104             if( !get_primary_seckey( sk2, keyid ) )
105                 keyid_from_sk( sk2, keyid+2 );
106             free_secret_key( sk2 );
107         }
108         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
109                                  &sk->protect.s2k, 0 );
110         /* Hmmm: Do we use sync mode here even for Twofish? */
111         if( !(cipher_hd = gcry_cipher_open( sk->protect.algo,
112                                       GCRY_CIPHER_MODE_CFB,
113                                       GCRY_CIPHER_SECURE
114                                       | (sk->protect.algo >= 100 ?
115                                            0 : GCRY_CIPHER_ENABLE_SYNC) ) )
116                                     ) {
117             BUG();
118         }
119
120         if( gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
121             log_fatal("set key failed: %s\n", gcry_strerror(-1) );
122         gcry_free(dek);
123         save_sk = copy_secret_key( NULL, sk );
124         if( gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen ))
125             log_fatal("set IV failed: %s\n", gcry_strerror(-1) );
126         csum = 0;
127         if( sk->version >= 4 ) {
128             size_t ndata;
129             unsigned int ndatabits;
130             byte *p, *data;
131
132             i = pubkey_get_npkey(sk->pubkey_algo);
133             assert( gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
134             p = gcry_mpi_get_opaque( sk->skey[i], &ndatabits );
135             ndata = (ndatabits+7)/8;
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             }
149             /* must check it here otherwise the mpi_read_xx would fail
150              * because the length may have an arbitrary value */
151             if( sk->csum == csum ) {
152                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
153                     nbytes = ndata;
154                     assert( gcry_is_secure( p ) );
155                     res = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_PGP,
156                                                              p, &nbytes);
157                     if( res )
158                         log_bug("gcry_mpi_scan failed in do_check: rc=%d\n", res);
159
160                     ndata -= nbytes;
161                     p += nbytes;
162                 }
163             }
164             gcry_free(data);
165         }
166         else {
167             for(i=pubkey_get_npkey(sk->pubkey_algo);
168                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
169                 size_t ndata;
170                 unsigned int ndatabits;
171                 byte *p, *data;
172
173                 assert( gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
174                 p = gcry_mpi_get_opaque( sk->skey[i], &ndatabits );
175                 ndata = (ndatabits+7)/8;
176                 data = gcry_xmalloc_secure( ndata );
177                 gcry_cipher_sync( cipher_hd );
178                 gcry_cipher_decrypt( cipher_hd, data, ndata, p, ndata );
179                 mpi_release( sk->skey[i] ); sk->skey[i] = NULL ;
180
181                 res = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_USG,
182                                      data, &ndata );
183                 if( res )
184                     log_bug("gcry_mpi_scan failed in do_check: rc=%d\n", res);
185
186                 csum += checksum_mpi( sk->skey[i] );
187                 gcry_free( data );
188             }
189         }
190         gcry_cipher_close( cipher_hd );
191         /* now let's see whether we have used the right passphrase */
192         if( csum != sk->csum ) {
193             copy_secret_key( sk, save_sk );
194             passphrase_clear_cache ( keyid, sk->pubkey_algo );
195             free_secret_key( save_sk );
196             return GPGERR_BAD_PASS;
197         }
198         /* the checksum may be correct in some cases,
199          * so we also check the key itself */
200         res = pk_check_secret_key( sk->pubkey_algo, sk->skey );
201         if( res ) {
202             copy_secret_key( sk, save_sk );
203             passphrase_clear_cache ( keyid, sk->pubkey_algo );
204             free_secret_key( save_sk );
205             return GPGERR_BAD_PASS;
206         }
207         free_secret_key( save_sk );
208         sk->is_protected = 0;
209     }
210     else { /* not protected, assume it is okay if the checksum is okay */
211         csum = 0;
212         for(i=pubkey_get_npkey(sk->pubkey_algo);
213                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
214             assert( !gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
215             csum += checksum_mpi( sk->skey[i] );
216         }
217         if( csum != sk->csum )
218             return GPGERR_CHECKSUM;
219     }
220
221     return 0;
222 }
223
224
225
226 /****************
227  * Check the secret key
228  * Ask up to 3 (or n) times for a correct passphrase
229  */
230 int
231 check_secret_key( PKT_secret_key *sk, int n )
232 {
233     int rc = GPGERR_BAD_PASS;
234     int i;
235
236     if( n < 1 )
237         n = opt.batch? 1 : 3; /* use the default value */
238
239     for(i=0; i < n && rc == GPGERR_BAD_PASS; i++ ) {
240         if( i )
241             log_info(_("Invalid passphrase; please try again ...\n"));
242         rc = do_check( sk );
243         if( rc == GPGERR_BAD_PASS && is_status_enabled() ) {
244             u32 kid[2];
245             char buf[50];
246
247             keyid_from_sk( sk, kid );
248             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
249             write_status_text( STATUS_BAD_PASSPHRASE, buf );
250         }
251         if( have_static_passphrase() )
252             break;
253     }
254
255     if( !rc )
256         write_status( STATUS_GOOD_PASSPHRASE );
257
258     return rc;
259 }
260
261 /****************
262  * check whether the secret key is protected.
263  * Returns: 0 not protected, -1 on error or the protection algorithm
264  */
265 int
266 is_secret_key_protected( PKT_secret_key *sk )
267 {
268     return sk->is_protected? sk->protect.algo : 0;
269 }
270
271
272
273 /****************
274  * Protect the secret key with the passphrase from DEK
275  */
276 int
277 protect_secret_key( PKT_secret_key *sk, DEK *dek )
278 {
279     int i,j, rc = 0;
280     byte *buffer;
281     unsigned nbytes;
282     u16 csum;
283
284     if( !dek )
285         return 0;
286
287     if( !sk->is_protected ) { /* okay, apply the protection */
288         GCRY_CIPHER_HD cipher_hd=NULL;
289
290         if( openpgp_cipher_test_algo( sk->protect.algo ) )
291             rc = GPGERR_CIPHER_ALGO; /* unsupport protection algorithm */
292         else {
293             print_cipher_algo_note( sk->protect.algo );
294             if( !(cipher_hd = gcry_cipher_open( sk->protect.algo,
295                                           GCRY_CIPHER_MODE_CFB,
296                                           GCRY_CIPHER_SECURE
297                                           | (sk->protect.algo >= 100 ?
298                                               0 : GCRY_CIPHER_ENABLE_SYNC) ))
299                                          ) {
300                 BUG();
301             }
302             rc = gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen );
303             if( rc == GCRYERR_WEAK_KEY ) {
304                 log_info(_("WARNING: Weak key detected"
305                            " - please change passphrase again.\n"));
306                 rc = 0;
307             }
308             else if( rc )
309                 BUG();
310
311             /* set the IV length */
312             {   int blocksize = gcry_cipher_get_algo_blklen( sk->protect.algo );
313                 if( blocksize != 8 && blocksize != 16 )
314                     log_fatal("unsupported blocksize %d\n", blocksize );
315                 sk->protect.ivlen = blocksize;
316                 assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
317             }
318             gcry_randomize(sk->protect.iv, sk->protect.ivlen,
319                                                          GCRY_STRONG_RANDOM);
320             gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
321
322             #warning FIXME: replace set/get buffer
323             if( sk->version >= 4 ) {
324                 /* FIXME: There is a bug in this function for all algorithms
325                  * where the secret MPIs are more than 1 */
326                 byte *bufarr[GNUPG_MAX_NSKEY];
327                 unsigned narr[GNUPG_MAX_NSKEY];
328                 unsigned nbits[GNUPG_MAX_NSKEY];
329                 int ndata=0;
330                 byte *p, *data;
331
332                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
333                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
334                     assert( !gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
335
336                     if( gcry_mpi_aprint( GCRYMPI_FMT_USG, (char*)bufarr+j,
337                                                           narr+j, sk->skey[i]))
338                         BUG();
339
340                     nbits[j]  = gcry_mpi_get_nbits( sk->skey[i] );
341                     ndata += narr[j] + 2;
342                 }
343                 for( ; j < GNUPG_MAX_NSKEY; j++ )
344                     bufarr[j] = NULL;
345                 ndata += 2; /* for checksum */
346
347                 data = gcry_xmalloc_secure( ndata );
348                 p = data;
349                 for(j=0; j < GNUPG_MAX_NSKEY && bufarr[j]; j++ ) {
350                     p[0] = nbits[j] >> 8 ;
351                     p[1] = nbits[j];
352                     p += 2;
353                     memcpy(p, bufarr[j], narr[j] );
354                     p += narr[j];
355                     gcry_free(bufarr[j]);
356                 }
357                 csum = checksum( data, ndata-2);
358                 sk->csum = csum;
359                 *p++ =  csum >> 8;
360                 *p++ =  csum;
361                 assert( p == data+ndata );
362                 gcry_cipher_encrypt( cipher_hd, data, ndata, NULL, 0 );
363                 for(i = pubkey_get_npkey(sk->pubkey_algo);
364                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
365                     mpi_release( sk->skey[i] );
366                     sk->skey[i] = NULL;
367                 }
368                 i = pubkey_get_npkey(sk->pubkey_algo);
369                 sk->skey[i] = gcry_mpi_set_opaque(NULL, data, ndata*8 );
370             }
371             else {
372                 /* NOTE: we always recalculate the checksum because there
373                  * are some test releases which calculated it wrong */
374                #warning FIXME:  Replace this code
375                 csum = 0;
376                 for(i=pubkey_get_npkey(sk->pubkey_algo);
377                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
378                     csum += checksum_mpi( sk->skey[i] );
379
380                     if( gcry_mpi_aprint( GCRYMPI_FMT_USG,
381                                          &buffer, &nbytes, sk->skey[i] ) )
382                         BUG();
383
384                     gcry_cipher_sync( cipher_hd );
385                     assert( !gcry_mpi_get_flag( sk->skey[i], GCRYMPI_FLAG_OPAQUE ) );
386                     gcry_cipher_encrypt( cipher_hd, buffer, nbytes, NULL, 0 );
387                     gcry_mpi_release( sk->skey[i] );
388                     if( gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_USG,
389                                        buffer,&nbytes ) )
390                         BUG();
391
392                     gcry_free( buffer );
393                 }
394                 sk->csum = csum;
395             }
396             sk->is_protected = 1;
397             gcry_cipher_close( cipher_hd );
398         }
399     }
400     return rc;
401 }
402