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