* options.h (DBG_CIPHER): Reintroduced it.
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certificate packet handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2003 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <assert.h>
27
28 #include "gpg.h"
29 #include "util.h"
30 #include "memory.h"
31 #include "packet.h"
32 #include "mpi.h"
33 #include "keydb.h"
34 #include "cipher.h"
35 #include "main.h"
36 #include "options.h"
37 #include "i18n.h"
38 #include "status.h"
39 #include "pkglue.h"
40
41 static int
42 do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
43           int *canceled )
44 {
45     byte *buffer;
46     u16 csum=0;
47     int i, res;
48     unsigned nbytes;
49     gpg_error_t rc;
50
51     if( sk->is_protected ) { /* remove the protection */
52         DEK *dek = NULL;
53         u32 keyid[4]; /* 4! because we need two of them */
54         CIPHER_HANDLE cipher_hd=NULL;
55         PKT_secret_key *save_sk;
56
57         if( sk->protect.s2k.mode == 1001 ) {
58             log_info(_("secret key parts are not available\n"));
59             return GPG_ERR_GENERAL;
60         }
61         if( sk->protect.algo == CIPHER_ALGO_NONE )
62             BUG();
63         if( openpgp_cipher_test_algo( sk->protect.algo ) ) {
64             log_info(_("protection algorithm %d%s is not supported\n"),
65                         sk->protect.algo,sk->protect.algo==1?" (IDEA)":"" );
66             if (sk->protect.algo==CIPHER_ALGO_IDEA)
67               {
68                 write_status (STATUS_RSA_OR_IDEA);
69                 idea_cipher_warn (0);
70               }
71             return GPG_ERR_CIPHER_ALGO;
72         }
73         keyid_from_sk( sk, keyid );
74         keyid[2] = keyid[3] = 0;
75         if( !sk->is_primary ) {
76             keyid[2] = sk->main_keyid[0];
77             keyid[3] = sk->main_keyid[1];
78         }
79         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
80                                  &sk->protect.s2k, mode,
81                                  tryagain_text, canceled );
82         if (!dek && canceled && *canceled)
83             return GPG_ERR_GENERAL;
84
85         rc = gcry_cipher_open (&cipher_hd, sk->protect.algo,
86                                GCRY_CIPHER_MODE_CFB,
87                                GCRY_CIPHER_SECURE
88                                | (sk->protect.algo >= 100 ?
89                                   0 : GCRY_CIPHER_ENABLE_SYNC));
90         if (rc)
91           log_fatal ("cipher open failed: %s\n", gpg_strerror (rc) );
92
93         rc = gcry_cipher_setkey (cipher_hd, dek->key, dek->keylen);
94         if (rc)
95           log_fatal ("set key failed: %s\n", gpg_strerror (rc) );
96
97         xfree (dek);
98         save_sk = copy_secret_key( NULL, sk );
99         gcry_cipher_setiv (cipher_hd, sk->protect.iv, sk->protect.ivlen);
100         csum = 0;
101         if( sk->version >= 4 ) {
102             int ndata;
103             unsigned int ndatabits;
104             byte *p, *data;
105             u16 csumc = 0;
106
107             i = pubkey_get_npkey(sk->pubkey_algo);
108             assert( gcry_mpi_get_flag (sk->skey[i], GCRYMPI_FLAG_OPAQUE ));
109             p = gcry_mpi_get_opaque( sk->skey[i], &ndatabits );
110             ndata = (ndatabits+7)/8;
111             if ( ndata > 1 )
112                 csumc = p[ndata-2] << 8 | p[ndata-1];
113             data = gcry_xmalloc_secure ( ndata );
114             gcry_cipher_decrypt( cipher_hd, data, ndata, p, ndata );
115             gcry_mpi_release ( sk->skey[i] ); sk->skey[i] = NULL ;
116             p = data;
117             if (sk->protect.sha1chk) {
118                 /* This is the new SHA1 checksum method to detect
119                    tampering with the key as used by the Klima/Rosa
120                    attack */
121                 sk->csum = 0;
122                 csum = 1;
123                 if( ndata < 20 ) 
124                     log_error("not enough bytes for SHA-1 checksum\n");
125                 else {
126                     gcry_md_hd_t h;
127
128                     if ( gcry_md_open (&h, DIGEST_ALGO_SHA1, 1))
129                         BUG(); /* algo not available */
130                     gcry_md_write (h, data, ndata - 20);
131                     gcry_md_final (h);
132                     if (!memcmp (gcry_md_read (h, DIGEST_ALGO_SHA1),
133                                  data + ndata - 20, 20) ) {
134                         /* digest does match.  We have to keep the old
135                            style checksum in sk->csum, so that the
136                            test used for unprotected keys does work.
137                            This test gets used when we are adding new
138                            keys. */
139                         sk->csum = csum = checksum (data, ndata-20);
140                     }
141                     gcry_md_close (h);
142                 }
143             }
144             else {
145                 if( ndata < 2 ) {
146                     log_error("not enough bytes for checksum\n");
147                     sk->csum = 0;
148                     csum = 1;
149                 }
150                 else {
151                     csum = checksum( data, ndata-2);
152                     sk->csum = data[ndata-2] << 8 | data[ndata-1];
153                     if ( sk->csum != csum ) {
154                         /* This is a PGP 7.0.0 workaround */
155                         sk->csum = csumc; /* take the encrypted one */
156                     }
157                 }
158             }
159                 
160             /* must check it here otherwise the mpi_read_xx would fail
161                because the length may have an arbitrary value */
162             if( sk->csum == csum ) {
163                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
164                     nbytes = ndata;
165                     assert( gcry_is_secure( p ) );
166                     res = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_PGP,
167                                                              p, &nbytes);
168                     if( res )
169                         log_bug ("gcry_mpi_scan failed in do_check: %s\n",
170                                  gpg_strerror (res));
171                     ndata -= nbytes;
172                     p += nbytes;
173                 }
174                 /* Note: at this point ndata should be 2 for a simple
175                    checksum or 20 for the sha1 digest */
176             }
177             xfree (data);
178         }
179         else {
180             for(i=pubkey_get_npkey(sk->pubkey_algo);
181                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
182                 byte *p;
183                 int ndata;
184                 unsigned int ndatabits;
185
186                 assert( gcry_mpi_get_flag (sk->skey[i], GCRYMPI_FLAG_OPAQUE));
187                 p = gcry_mpi_get_opaque( sk->skey[i], &ndatabits );
188                 ndata = (ndatabits+7)/8;
189                 assert (ndata >= 2);
190                 assert (ndata == ((p[0] << 8 | p[1]) + 7)/8 + 2);
191                 buffer = gcry_xmalloc_secure (ndata);
192                 gcry_cipher_sync (cipher_hd);
193                 buffer[0] = p[0];
194                 buffer[1] = p[1];
195                 gcry_cipher_decrypt (cipher_hd, buffer+2, ndata-2,
196                                      p+2, ndata-2);
197                 csum += checksum (buffer, ndata);
198                 gcry_mpi_release (sk->skey[i]);
199                 res = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_USG,
200                                      buffer, &ndata );
201                 if( res )
202                     log_bug ("gcry_mpi_scan failed in do_check: %s\n", 
203                              gpg_strerror (res));
204
205                 assert (sk->skey[i]);
206                 xfree (buffer);
207 /*              csum += checksum_mpi (sk->skey[i]); */
208             }
209         }
210         gcry_cipher_close (cipher_hd);
211         /* now let's see whether we have used the right passphrase */
212         if( csum != sk->csum ) {
213             copy_secret_key( sk, save_sk );
214             passphrase_clear_cache ( keyid, sk->pubkey_algo );
215             free_secret_key( save_sk );
216             return gpg_error (GPG_ERR_BAD_PASSPHRASE);
217         }
218         /* the checksum may fail, so we also check the key itself */
219 #warning fixme - we need to reenable this
220 /*      res = pubkey_check_secret_key( sk->pubkey_algo, sk->skey ); */
221 /*      if( res ) { */
222 /*          copy_secret_key( sk, save_sk ); */
223 /*              passphrase_clear_cache ( keyid, sk->pubkey_algo ); */
224 /*          free_secret_key( save_sk ); */
225 /*          return gpg_error (GPG_ERR_BAD_PASSPHRASE); */
226 /*      } */
227         free_secret_key( save_sk );
228         sk->is_protected = 0;
229     }
230     else { /* not protected, assume it is okay if the checksum is okay */
231         csum = 0;
232         for(i=pubkey_get_npkey(sk->pubkey_algo);
233                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
234             csum += checksum_mpi( sk->skey[i] );
235         }
236         if( csum != sk->csum )
237             return GPG_ERR_CHECKSUM;
238     }
239
240     return 0;
241 }
242
243
244
245 /****************
246  * Check the secret key
247  * Ask up to 3 (or n) times for a correct passphrase
248  * If n is negative, disable the key info prompt and make n=abs(n)
249  */
250 int
251 check_secret_key( PKT_secret_key *sk, int n )
252 {
253     int rc = gpg_error (GPG_ERR_BAD_PASSPHRASE);
254     int i,mode;
255
256     if (sk && sk->is_protected && sk->protect.s2k.mode == 1002)
257       return 0; /* Let the scdaemon handle it. */
258
259     if(n<0)
260       {
261         n=abs(n);
262         mode=1;
263       }
264     else
265       mode=0;
266
267     if( n < 1 )
268         n = (opt.batch && !opt.use_agent)? 1 : 3; /* use the default value */
269
270     for(i=0; i < n && gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE; i++ ) {
271         int canceled = 0;
272         const char *tryagain = NULL;
273         if (i) {
274             tryagain = N_("Invalid passphrase; please try again");
275             log_info (_("%s ...\n"), _(tryagain));
276         }
277         rc = do_check( sk, tryagain, mode, &canceled );
278         if( gpg_err_code (rc) == GPG_ERR_BAD_PASSPHRASE
279             && is_status_enabled() ) {
280             u32 kid[2];
281             char buf[50];
282
283             keyid_from_sk( sk, kid );
284             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
285             write_status_text( STATUS_BAD_PASSPHRASE, buf );
286         }
287         if( have_static_passphrase() || canceled)
288             break;
289     }
290
291     if( !rc )
292         write_status( STATUS_GOOD_PASSPHRASE );
293
294     return rc;
295 }
296
297 /****************
298  * check whether the secret key is protected.
299  * Returns: 0 not protected, -1 on error or the protection algorithm
300  *                           -2 indicates a card stub.
301  */
302 int
303 is_secret_key_protected( PKT_secret_key *sk )
304 {
305     return sk->is_protected?
306                sk->protect.s2k.mode == 1002? -2
307                                            : sk->protect.algo : 0;
308 }
309
310
311
312 /****************
313  * Protect the secret key with the passphrase from DEK
314  */
315 int
316 protect_secret_key( PKT_secret_key *sk, DEK *dek )
317 {
318     int i,j, rc = 0;
319     byte *buffer;
320     unsigned nbytes;
321     u16 csum;
322
323     if( !dek )
324         return 0;
325
326     if( !sk->is_protected ) { /* okay, apply the protection */
327         CIPHER_HANDLE cipher_hd=NULL;
328
329         if( openpgp_cipher_test_algo( sk->protect.algo ) )
330           {
331             rc = gpg_error (GPG_ERR_CIPHER_ALGO); /* unsupport
332                                                      protection
333                                                      algorithm */
334           }
335         else {
336             print_cipher_algo_note( sk->protect.algo );
337             rc = gcry_cipher_open (&cipher_hd, sk->protect.algo,
338                                    GCRY_CIPHER_MODE_CFB,
339                                    GCRY_CIPHER_SECURE
340                                    | (sk->protect.algo >= 100 ?
341                                       0 : GCRY_CIPHER_ENABLE_SYNC) );
342             if (rc)
343               BUG();
344             if( gcry_cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
345                 log_info(_("WARNING: Weak key detected"
346                            " - please change passphrase again.\n"));
347             sk->protect.ivlen = gcry_cipher_get_algo_blklen(sk->protect.algo);
348             assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
349             if( sk->protect.ivlen != 8 && sk->protect.ivlen != 16 )
350                 BUG(); /* yes, we are very careful */
351             gcry_randomize (sk->protect.iv, sk->protect.ivlen,
352                             GCRY_STRONG_RANDOM);
353             gcry_cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
354             if( sk->version >= 4 ) {
355                 byte *bufarr[PUBKEY_MAX_NSKEY];
356                 unsigned narr[PUBKEY_MAX_NSKEY];
357                 unsigned nbits[PUBKEY_MAX_NSKEY];
358                 int ndata=0;
359                 byte *p, *data;
360
361                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
362                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
363                     assert( !gcry_mpi_get_flag( sk->skey[i],
364                                                 GCRYMPI_FLAG_OPAQUE ));
365
366                     if( gcry_mpi_aprint( GCRYMPI_FMT_USG, (void**)bufarr+j,
367                                          narr+j, sk->skey[i]))
368                         BUG();
369
370                     nbits[j]  = gcry_mpi_get_nbits( sk->skey[i] );
371                     ndata += narr[j] + 2;
372                 }
373                 for( ; j < PUBKEY_MAX_NSKEY; j++ )
374                     bufarr[j] = NULL;
375                 ndata += opt.simple_sk_checksum? 2 : 20; /* for checksum */
376
377                 data = xmalloc_secure ( ndata );
378                 p = data;
379                 for(j=0; j < PUBKEY_MAX_NSKEY && bufarr[j]; j++ ) {
380                     p[0] = nbits[j] >> 8 ;
381                     p[1] = nbits[j];
382                     p += 2;
383                     memcpy(p, bufarr[j], narr[j] );
384                     p += narr[j];
385                     xfree (bufarr[j]);
386                 }
387                 
388                 if (opt.simple_sk_checksum) {
389                     log_info (_("generating the deprecated 16-bit checksum"
390                               " for secret key protection\n")); 
391                     csum = checksum( data, ndata-2);
392                     sk->csum = csum;
393                     *p++ =      csum >> 8;
394                     *p++ =      csum;
395                     sk->protect.sha1chk = 0;
396                 }
397                 else {
398                     gcry_md_hd_t h;
399
400                     if (gcry_md_open (&h, GCRY_MD_SHA1, 1))
401                         BUG(); /* algo not available */
402                     gcry_md_write (h, data, ndata - 20);
403                     gcry_md_final (h);
404                     memcpy (p, gcry_md_read (h, GCRY_MD_SHA1), 20);
405                     p += 20;
406                     gcry_md_close (h);
407                     sk->csum = csum = 0;
408                     sk->protect.sha1chk = 1;
409                 }
410                 assert( p == data+ndata );
411
412                 gcry_cipher_encrypt( cipher_hd, data, ndata, NULL, 0 );
413                 for(i = pubkey_get_npkey(sk->pubkey_algo);
414                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
415                     gcry_mpi_release ( sk->skey[i] );
416                     sk->skey[i] = NULL;
417                 }
418                 i = pubkey_get_npkey(sk->pubkey_algo);
419                 sk->skey[i] = gcry_mpi_set_opaque(NULL, data, ndata*8);
420             }
421             else {
422                 csum = 0;
423                 for(i=pubkey_get_npkey(sk->pubkey_algo);
424                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
425                     byte *data;
426                     unsigned int nbits;
427
428                     csum += checksum_mpi (sk->skey[i]);
429                     if( gcry_mpi_aprint( GCRYMPI_FMT_USG, &buffer,
430                                          &nbytes, sk->skey[i] ) )
431                         BUG();
432                     gcry_cipher_sync (cipher_hd);
433                     assert (!gcry_mpi_get_flag( sk->skey[i],
434                                                 GCRYMPI_FLAG_OPAQUE ));
435                     data = xmalloc (nbytes+2);
436                     nbits  = gcry_mpi_get_nbits (sk->skey[i]);
437                     assert (nbytes == (nbits + 7)/8);
438                     data[0] = nbits >> 8;
439                     data[1] = nbits;
440                     gcry_cipher_encrypt (cipher_hd, data+2, nbytes,
441                                          buffer, nbytes);
442                     xfree ( buffer );
443                     
444                     gcry_mpi_release (sk->skey[i]);
445                     sk->skey[i] = gcry_mpi_set_opaque (NULL, data,
446                                                        (nbytes+2)*8);
447                 }
448                 sk->csum = csum;
449             }
450             sk->is_protected = 1;
451             gcry_cipher_close( cipher_hd );
452         }
453     }
454     return rc;
455 }