* seckey-cert.c: Workaround to allow decryption of v3 keys created
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certificate packet handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 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 #include "util.h"
27 #include "memory.h"
28 #include "packet.h"
29 #include "mpi.h"
30 #include "keydb.h"
31 #include "cipher.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, const char *tryagain_text )
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         CIPHER_HANDLE cipher_hd=NULL;
50         PKT_secret_key *save_sk;
51
52         if( sk->protect.s2k.mode == 1001 ) {
53             log_info(_("secret key parts are not available\n"));
54             return G10ERR_GENERAL;
55         }
56         if( sk->protect.algo == CIPHER_ALGO_NONE )
57             BUG();
58         if( check_cipher_algo( sk->protect.algo ) ) {
59             log_info(_("protection algorithm %d%s is not supported\n"),
60                         sk->protect.algo,sk->protect.algo==1?" (IDEA)":"" );
61             idea_cipher_warn(0);
62             return G10ERR_CIPHER_ALGO;
63         }
64         keyid_from_sk( sk, keyid );
65         keyid[2] = keyid[3] = 0;
66         if( !sk->is_primary ) {
67             keyid[2] = sk->main_keyid[0];
68             keyid[3] = sk->main_keyid[1];
69         }
70         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
71                                  &sk->protect.s2k, 0, tryagain_text );
72         cipher_hd = cipher_open( sk->protect.algo,
73                                  CIPHER_MODE_AUTO_CFB, 1);
74         cipher_setkey( cipher_hd, dek->key, dek->keylen );
75         m_free(dek);
76         save_sk = copy_secret_key( NULL, sk );
77         cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
78         csum = 0;
79         if( sk->version >= 4 ) {
80             int ndata;
81             byte *p, *data;
82             u16 csumc = 0;
83
84             i = pubkey_get_npkey(sk->pubkey_algo);
85             assert( mpi_is_opaque( sk->skey[i] ) );
86             p = mpi_get_opaque( sk->skey[i], &ndata );
87             if ( ndata > 1 )
88                 csumc = p[ndata-2] << 8 | p[ndata-1];
89             data = m_alloc_secure( ndata );
90             cipher_decrypt( cipher_hd, data, p, ndata );
91             mpi_free( sk->skey[i] ); sk->skey[i] = NULL ;
92             p = data;
93             if (sk->protect.sha1chk) {
94                 /* This is the new SHA1 checksum method to detect
95                    tampering with the key as used by the Klima/Rosa
96                    attack */
97                 sk->csum = 0;
98                 csum = 1;
99                 if( ndata < 20 ) 
100                     log_error("not enough bytes for SHA-1 checksum\n");
101                 else {
102                     MD_HANDLE h = md_open (DIGEST_ALGO_SHA1, 1);
103                     if (!h)
104                         BUG(); /* algo not available */
105                     md_write (h, data, ndata - 20);
106                     md_final (h);
107                     if (!memcmp (md_read (h, DIGEST_ALGO_SHA1),
108                                  data + ndata - 20, 20) ) {
109                         /* digest does match.  We have to keep the old
110                            style checksum in sk->csum, so that the
111                            test used for unprotected keys does work.
112                            This test gets used when we are adding new
113                            keys. */
114                         sk->csum = csum = checksum (data, ndata-20);
115                     }
116                     md_close (h);
117                 }
118             }
119             else {
120                 if( ndata < 2 ) {
121                     log_error("not enough bytes for checksum\n");
122                     sk->csum = 0;
123                     csum = 1;
124                 }
125                 else {
126                     csum = checksum( data, ndata-2);
127                     sk->csum = data[ndata-2] << 8 | data[ndata-1];
128                     if ( sk->csum != csum ) {
129                         /* This is a PGP 7.0.0 workaround */
130                         sk->csum = csumc; /* take the encrypted one */
131                     }
132                 }
133             }
134                 
135             /* must check it here otherwise the mpi_read_xx would fail
136                because the length may have an arbitrary value */
137             if( sk->csum == csum ) {
138                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
139                     nbytes = ndata;
140                     sk->skey[i] = mpi_read_from_buffer(p, &nbytes, 1 );
141                     ndata -= nbytes;
142                     p += nbytes;
143                 }
144                 /* Note: at this point ndata should be 2 for a simple
145                    checksum or 20 for the sha1 digest */
146             }
147             m_free(data);
148         }
149         else {
150             for(i=pubkey_get_npkey(sk->pubkey_algo);
151                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
152                 buffer = mpi_get_secure_buffer( sk->skey[i], &nbytes, NULL );
153                 cipher_sync( cipher_hd );
154                 assert( mpi_is_protected(sk->skey[i]) );
155                 cipher_decrypt( cipher_hd, buffer, buffer, nbytes );
156                 mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
157                 mpi_clear_protect_flag( sk->skey[i] );
158                 csum += checksum_mpi( sk->skey[i] );
159                 m_free( buffer );
160             }
161             if( csum != sk->csum ) {
162               /* Due to a fix of a bug in mpi_get_secure_buffer we
163                  might encounter seceret keys which are not correctly
164                  encrypted.  We fix this by a second try, this time
165                  with a reversed bug fix (the memmove below). */
166                 byte *p;
167               
168                 copy_secret_key( sk, save_sk );
169                 cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
170                 csum = 0;
171                 for(i=pubkey_get_npkey (sk->pubkey_algo);
172                     i < pubkey_get_nskey (sk->pubkey_algo); i++ ) {
173                     buffer = mpi_get_secure_buffer (sk->skey[i], &nbytes,NULL);
174                     for (p=buffer; !*p && nbytes; p++, --nbytes )
175                       ;
176                     if (p != buffer)
177                       memmove (buffer, p, nbytes);
178                     cipher_sync (cipher_hd);
179                     assert (mpi_is_protected(sk->skey[i]));
180                     cipher_decrypt (cipher_hd, buffer, buffer, nbytes);
181                     mpi_set_buffer (sk->skey[i], buffer, nbytes, 0);
182                     mpi_clear_protect_flag (sk->skey[i]);
183                     csum += checksum_mpi (sk->skey[i]);
184                     m_free (buffer);
185                 }
186             }
187             if( opt.emulate_bugs & EMUBUG_GPGCHKSUM ) {
188                csum = sk->csum;
189             }
190         }
191         cipher_close( cipher_hd );
192         /* now let's see whether we have used the right passphrase */
193         if( csum != sk->csum ) {
194             copy_secret_key( sk, save_sk );
195             passphrase_clear_cache ( keyid, sk->pubkey_algo );
196             free_secret_key( save_sk );
197             return G10ERR_BAD_PASS;
198         }
199         /* the checksum may fail, so we also check the key itself */
200         res = pubkey_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 G10ERR_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             csum += checksum_mpi( sk->skey[i] );
215         }
216         if( csum != sk->csum )
217             return G10ERR_CHECKSUM;
218     }
219
220     return 0;
221 }
222
223
224
225 /****************
226  * Check the secret key
227  * Ask up to 3 (or n) times for a correct passphrase
228  */
229 int
230 check_secret_key( PKT_secret_key *sk, int n )
231 {
232     int rc = G10ERR_BAD_PASS;
233     int i;
234
235     if( n < 1 )
236         n = (opt.batch && !opt.use_agent)? 1 : 3; /* use the default value */
237
238     for(i=0; i < n && rc == G10ERR_BAD_PASS; i++ ) {
239         const char *tryagain = NULL;
240         if (i) {
241             tryagain = _("Invalid passphrase; please try again");
242             log_info (_("%s ...\n"), tryagain);
243         }
244         rc = do_check( sk, tryagain );
245         if( rc == G10ERR_BAD_PASS && is_status_enabled() ) {
246             u32 kid[2];
247             char buf[50];
248
249             keyid_from_sk( sk, kid );
250             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
251             write_status_text( STATUS_BAD_PASSPHRASE, buf );
252         }
253         if( have_static_passphrase() )
254             break;
255     }
256
257     if( !rc )
258         write_status( STATUS_GOOD_PASSPHRASE );
259
260     return rc;
261 }
262
263 /****************
264  * check whether the secret key is protected.
265  * Returns: 0 not protected, -1 on error or the protection algorithm
266  */
267 int
268 is_secret_key_protected( PKT_secret_key *sk )
269 {
270     return sk->is_protected? sk->protect.algo : 0;
271 }
272
273
274
275 /****************
276  * Protect the secret key with the passphrase from DEK
277  */
278 int
279 protect_secret_key( PKT_secret_key *sk, DEK *dek )
280 {
281     int i,j, rc = 0;
282     byte *buffer;
283     unsigned nbytes;
284     u16 csum;
285
286     if( !dek )
287         return 0;
288
289     if( !sk->is_protected ) { /* okay, apply the protection */
290         CIPHER_HANDLE cipher_hd=NULL;
291
292         if( check_cipher_algo( sk->protect.algo ) )
293             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
294         else {
295             print_cipher_algo_note( sk->protect.algo );
296             cipher_hd = cipher_open( sk->protect.algo,
297                                      CIPHER_MODE_AUTO_CFB, 1 );
298             if( cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
299                 log_info(_("WARNING: Weak key detected"
300                            " - please change passphrase again.\n"));
301             sk->protect.ivlen = cipher_get_blocksize( sk->protect.algo );
302             assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
303             if( sk->protect.ivlen != 8 && sk->protect.ivlen != 16 )
304                 BUG(); /* yes, we are very careful */
305             randomize_buffer(sk->protect.iv, sk->protect.ivlen, 1);
306             cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
307             if( sk->version >= 4 ) {
308                 byte *bufarr[PUBKEY_MAX_NSKEY];
309                 unsigned narr[PUBKEY_MAX_NSKEY];
310                 unsigned nbits[PUBKEY_MAX_NSKEY];
311                 int ndata=0;
312                 byte *p, *data;
313
314                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
315                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
316                     assert( !mpi_is_opaque( sk->skey[i] ) );
317                     bufarr[j] = mpi_get_buffer( sk->skey[i], &narr[j], NULL );
318                     nbits[j]  = mpi_get_nbits( sk->skey[i] );
319                     ndata += narr[j] + 2;
320                 }
321                 for( ; j < PUBKEY_MAX_NSKEY; j++ )
322                     bufarr[j] = NULL;
323                 ndata += opt.simple_sk_checksum? 2 : 20; /* for checksum */
324
325                 data = m_alloc_secure( ndata );
326                 p = data;
327                 for(j=0; j < PUBKEY_MAX_NSKEY && bufarr[j]; j++ ) {
328                     p[0] = nbits[j] >> 8 ;
329                     p[1] = nbits[j];
330                     p += 2;
331                     memcpy(p, bufarr[j], narr[j] );
332                     p += narr[j];
333                     m_free(bufarr[j]);
334                 }
335                 
336                 if (opt.simple_sk_checksum) {
337                     log_info (_("generating the deprecated 16-bit checksum"
338                               " for secret key protection\n")); 
339                     csum = checksum( data, ndata-2);
340                     sk->csum = csum;
341                     *p++ =      csum >> 8;
342                     *p++ =      csum;
343                     sk->protect.sha1chk = 0;
344                 }
345                 else {
346                     MD_HANDLE h = md_open (DIGEST_ALGO_SHA1, 1);
347                     if (!h)
348                         BUG(); /* algo not available */
349                     md_write (h, data, ndata - 20);
350                     md_final (h);
351                     memcpy (p, md_read (h, DIGEST_ALGO_SHA1), 20);
352                     p += 20;
353                     md_close (h);
354                     sk->csum = csum = 0;
355                     sk->protect.sha1chk = 1;
356                 }
357                 assert( p == data+ndata );
358
359                 cipher_encrypt( cipher_hd, data, data, ndata );
360                 for(i = pubkey_get_npkey(sk->pubkey_algo);
361                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
362                     mpi_free( sk->skey[i] );
363                     sk->skey[i] = NULL;
364                 }
365                 i = pubkey_get_npkey(sk->pubkey_algo);
366                 sk->skey[i] = mpi_set_opaque(NULL, data, ndata );
367             }
368             else {
369                 /* NOTE: we always recalculate the checksum because there
370                  * are some test releases which calculated it wrong */
371                 csum = 0;
372                 for(i=pubkey_get_npkey(sk->pubkey_algo);
373                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
374                     csum += checksum_mpi_counted_nbits( sk->skey[i] );
375                     buffer = mpi_get_buffer( sk->skey[i], &nbytes, NULL );
376                     cipher_sync( cipher_hd );
377                     assert( !mpi_is_protected(sk->skey[i]) );
378                     cipher_encrypt( cipher_hd, buffer, buffer, nbytes );
379                     mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
380                     mpi_set_protect_flag( sk->skey[i] );
381                     m_free( buffer );
382                 }
383                 sk->csum = csum;
384             }
385             sk->is_protected = 1;
386             cipher_close( cipher_hd );
387         }
388     }
389     return rc;
390 }
391