* g10.c (main): Default {export|import}-unusable-sigs to off until the
[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, int mode,
40           int *canceled )
41 {
42     byte *buffer;
43     u16 csum=0;
44     int i, res;
45     unsigned nbytes;
46
47     if( sk->is_protected ) { /* remove the protection */
48         DEK *dek = NULL;
49         u32 keyid[4]; /* 4! because we need two of them */
50         CIPHER_HANDLE cipher_hd=NULL;
51         PKT_secret_key *save_sk;
52
53         if( sk->protect.s2k.mode == 1001 ) {
54             log_info(_("secret key parts are not available\n"));
55             return G10ERR_GENERAL;
56         }
57         if( sk->protect.algo == CIPHER_ALGO_NONE )
58             BUG();
59         if( check_cipher_algo( sk->protect.algo ) ) {
60             log_info(_("protection algorithm %d%s is not supported\n"),
61                         sk->protect.algo,sk->protect.algo==1?" (IDEA)":"" );
62             if (sk->protect.algo==CIPHER_ALGO_IDEA)
63               {
64                 write_status (STATUS_RSA_OR_IDEA);
65                 idea_cipher_warn (0);
66               }
67             return G10ERR_CIPHER_ALGO;
68         }
69         if(check_digest_algo(sk->protect.s2k.hash_algo))
70           {
71             log_info(_("protection digest %d is not supported\n"),
72                      sk->protect.s2k.hash_algo);
73             return G10ERR_DIGEST_ALGO;
74           }
75         keyid_from_sk( sk, keyid );
76         keyid[2] = keyid[3] = 0;
77         if( !sk->is_primary ) {
78             keyid[2] = sk->main_keyid[0];
79             keyid[3] = sk->main_keyid[1];
80         }
81         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
82                                  &sk->protect.s2k, mode,
83                                  tryagain_text, canceled );
84         if (!dek && canceled && *canceled)
85             return G10ERR_GENERAL;
86
87         cipher_hd = cipher_open( sk->protect.algo,
88                                  CIPHER_MODE_AUTO_CFB, 1);
89         cipher_setkey( cipher_hd, dek->key, dek->keylen );
90         m_free(dek);
91         save_sk = copy_secret_key( NULL, sk );
92         cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
93         csum = 0;
94         if( sk->version >= 4 ) {
95             unsigned int ndata;
96             byte *p, *data;
97             u16 csumc = 0;
98
99             i = pubkey_get_npkey(sk->pubkey_algo);
100             assert( mpi_is_opaque( sk->skey[i] ) );
101             p = mpi_get_opaque( sk->skey[i], &ndata );
102             if ( ndata > 1 )
103                 csumc = p[ndata-2] << 8 | p[ndata-1];
104             data = m_alloc_secure( ndata );
105             cipher_decrypt( cipher_hd, data, p, ndata );
106             mpi_free( sk->skey[i] ); sk->skey[i] = NULL ;
107             p = data;
108             if (sk->protect.sha1chk) {
109                 /* This is the new SHA1 checksum method to detect
110                    tampering with the key as used by the Klima/Rosa
111                    attack */
112                 sk->csum = 0;
113                 csum = 1;
114                 if( ndata < 20 ) 
115                     log_error("not enough bytes for SHA-1 checksum\n");
116                 else {
117                     MD_HANDLE h = md_open (DIGEST_ALGO_SHA1, 1);
118                     if (!h)
119                         BUG(); /* algo not available */
120                     md_write (h, data, ndata - 20);
121                     md_final (h);
122                     if (!memcmp (md_read (h, DIGEST_ALGO_SHA1),
123                                  data + ndata - 20, 20) ) {
124                         /* digest does match.  We have to keep the old
125                            style checksum in sk->csum, so that the
126                            test used for unprotected keys does work.
127                            This test gets used when we are adding new
128                            keys. */
129                         sk->csum = csum = checksum (data, ndata-20);
130                     }
131                     md_close (h);
132                 }
133             }
134             else {
135                 if( ndata < 2 ) {
136                     log_error("not enough bytes for checksum\n");
137                     sk->csum = 0;
138                     csum = 1;
139                 }
140                 else {
141                     csum = checksum( data, ndata-2);
142                     sk->csum = data[ndata-2] << 8 | data[ndata-1];
143                     if ( sk->csum != csum ) {
144                         /* This is a PGP 7.0.0 workaround */
145                         sk->csum = csumc; /* take the encrypted one */
146                     }
147                 }
148             }
149
150             /* Must check it here otherwise the mpi_read_xx would fail
151                because the length may have an arbitrary value */
152             if( sk->csum == csum ) {
153                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
154                     nbytes = ndata;
155                     sk->skey[i] = mpi_read_from_buffer(p, &nbytes, 1 );
156                     if (!sk->skey[i])
157                       {
158                         /* Checksum was okay, but not correctly
159                            decrypted.  */
160                         sk->csum = 0;
161                         csum = 1;
162                         break;
163                       }
164                     ndata -= nbytes;
165                     p += nbytes;
166                 }
167                 /* Note: at this point ndata should be 2 for a simple
168                    checksum or 20 for the sha1 digest */
169             }
170             m_free(data);
171         }
172         else {
173             for(i=pubkey_get_npkey(sk->pubkey_algo);
174                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
175                 byte *p;
176                 unsigned int ndata;
177
178                 assert (mpi_is_opaque (sk->skey[i]));
179                 p = mpi_get_opaque (sk->skey[i], &ndata);
180                 assert (ndata >= 2);
181                 assert (ndata == ((p[0] << 8 | p[1]) + 7)/8 + 2);
182                 buffer = m_alloc_secure (ndata);
183                 cipher_sync (cipher_hd);
184                 buffer[0] = p[0];
185                 buffer[1] = p[1];
186                 cipher_decrypt (cipher_hd, buffer+2, p+2, ndata-2);
187                 csum += checksum (buffer, ndata);
188                 mpi_free (sk->skey[i]);
189                 sk->skey[i] = mpi_read_from_buffer (buffer, &ndata, 1);
190                 m_free (buffer);
191                 if (!sk->skey[i])
192                   {
193                     /* Checksum was okay, but not correctly
194                        decrypted.  */
195                     sk->csum = 0;
196                     csum = 1;
197                     break;
198                   }
199 /*              csum += checksum_mpi (sk->skey[i]); */
200             }
201         }
202         cipher_close( cipher_hd );
203         /* now let's see whether we have used the right passphrase */
204         if( csum != sk->csum ) {
205             copy_secret_key( sk, save_sk );
206             passphrase_clear_cache ( keyid, NULL, sk->pubkey_algo );
207             free_secret_key( save_sk );
208             return G10ERR_BAD_PASS;
209         }
210         /* the checksum may fail, so we also check the key itself */
211         res = pubkey_check_secret_key( sk->pubkey_algo, sk->skey );
212         if( res ) {
213             copy_secret_key( sk, save_sk );
214             passphrase_clear_cache ( keyid, NULL, sk->pubkey_algo );
215             free_secret_key( save_sk );
216             return G10ERR_BAD_PASS;
217         }
218         free_secret_key( save_sk );
219         sk->is_protected = 0;
220     }
221     else { /* not protected, assume it is okay if the checksum is okay */
222         csum = 0;
223         for(i=pubkey_get_npkey(sk->pubkey_algo);
224                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
225             csum += checksum_mpi( sk->skey[i] );
226         }
227         if( csum != sk->csum )
228             return G10ERR_CHECKSUM;
229     }
230
231     return 0;
232 }
233
234
235
236 /****************
237  * Check the secret key
238  * Ask up to 3 (or n) times for a correct passphrase
239  * If n is negative, disable the key info prompt and make n=abs(n)
240  */
241 int
242 check_secret_key( PKT_secret_key *sk, int n )
243 {
244     int rc = G10ERR_BAD_PASS;
245     int i,mode;
246
247     if (sk && sk->is_protected && sk->protect.s2k.mode == 1002)
248       return 0; /* Let the card support stuff handle this. */
249
250     if(n<0)
251       {
252         n=abs(n);
253         mode=1;
254       }
255     else
256       mode=0;
257
258     if( n < 1 )
259         n = (opt.batch && !opt.use_agent)? 1 : 3; /* use the default value */
260
261     for(i=0; i < n && rc == G10ERR_BAD_PASS; i++ ) {
262         int canceled = 0;
263         const char *tryagain = NULL;
264         if (i) {
265             tryagain = N_("Invalid passphrase; please try again");
266             log_info (_("%s ...\n"), _(tryagain));
267         }
268         rc = do_check( sk, tryagain, mode, &canceled );
269         if( rc == G10ERR_BAD_PASS && is_status_enabled() ) {
270             u32 kid[2];
271             char buf[50];
272
273             keyid_from_sk( sk, kid );
274             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
275             write_status_text( STATUS_BAD_PASSPHRASE, buf );
276         }
277         if( have_static_passphrase() || canceled)
278             break;
279     }
280
281     if( !rc )
282         write_status( STATUS_GOOD_PASSPHRASE );
283
284     return rc;
285 }
286
287 /****************
288  * check whether the secret key is protected.
289  * Returns: 0 not protected, -1 on error or the protection algorithm
290  *                           -2 indicates a card stub.
291  */
292 int
293 is_secret_key_protected( PKT_secret_key *sk )
294 {
295     return sk->is_protected?
296                sk->protect.s2k.mode == 1002? -2
297                                            : sk->protect.algo : 0;
298 }
299
300
301
302 /****************
303  * Protect the secret key with the passphrase from DEK
304  */
305 int
306 protect_secret_key( PKT_secret_key *sk, DEK *dek )
307 {
308     int i,j, rc = 0;
309     byte *buffer;
310     unsigned nbytes;
311     u16 csum;
312
313     if( !dek )
314         return 0;
315
316     if( !sk->is_protected ) { /* okay, apply the protection */
317         CIPHER_HANDLE cipher_hd=NULL;
318
319         if( check_cipher_algo( sk->protect.algo ) )
320             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
321         else {
322             print_cipher_algo_note( sk->protect.algo );
323             cipher_hd = cipher_open( sk->protect.algo,
324                                      CIPHER_MODE_AUTO_CFB, 1 );
325             if( cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
326                 log_info(_("WARNING: Weak key detected"
327                            " - please change passphrase again.\n"));
328             sk->protect.ivlen = cipher_get_blocksize( sk->protect.algo );
329             assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
330             if( sk->protect.ivlen != 8 && sk->protect.ivlen != 16 )
331                 BUG(); /* yes, we are very careful */
332             randomize_buffer(sk->protect.iv, sk->protect.ivlen, 1);
333             cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
334             if( sk->version >= 4 ) {
335                 byte *bufarr[PUBKEY_MAX_NSKEY];
336                 unsigned narr[PUBKEY_MAX_NSKEY];
337                 unsigned nbits[PUBKEY_MAX_NSKEY];
338                 int ndata=0;
339                 byte *p, *data;
340
341                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
342                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
343                     assert( !mpi_is_opaque( sk->skey[i] ) );
344                     bufarr[j] = mpi_get_buffer( sk->skey[i], &narr[j], NULL );
345                     nbits[j]  = mpi_get_nbits( sk->skey[i] );
346                     ndata += narr[j] + 2;
347                 }
348                 for( ; j < PUBKEY_MAX_NSKEY; j++ )
349                     bufarr[j] = NULL;
350                 ndata += opt.simple_sk_checksum? 2 : 20; /* for checksum */
351
352                 data = m_alloc_secure( ndata );
353                 p = data;
354                 for(j=0; j < PUBKEY_MAX_NSKEY && bufarr[j]; j++ ) {
355                     p[0] = nbits[j] >> 8 ;
356                     p[1] = nbits[j];
357                     p += 2;
358                     memcpy(p, bufarr[j], narr[j] );
359                     p += narr[j];
360                     m_free(bufarr[j]);
361                 }
362                 
363                 if (opt.simple_sk_checksum) {
364                     log_info (_("generating the deprecated 16-bit checksum"
365                               " for secret key protection\n")); 
366                     csum = checksum( data, ndata-2);
367                     sk->csum = csum;
368                     *p++ =      csum >> 8;
369                     *p++ =      csum;
370                     sk->protect.sha1chk = 0;
371                 }
372                 else {
373                     MD_HANDLE h = md_open (DIGEST_ALGO_SHA1, 1);
374                     if (!h)
375                         BUG(); /* algo not available */
376                     md_write (h, data, ndata - 20);
377                     md_final (h);
378                     memcpy (p, md_read (h, DIGEST_ALGO_SHA1), 20);
379                     p += 20;
380                     md_close (h);
381                     sk->csum = csum = 0;
382                     sk->protect.sha1chk = 1;
383                 }
384                 assert( p == data+ndata );
385
386                 cipher_encrypt( cipher_hd, data, data, ndata );
387                 for(i = pubkey_get_npkey(sk->pubkey_algo);
388                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
389                     mpi_free( sk->skey[i] );
390                     sk->skey[i] = NULL;
391                 }
392                 i = pubkey_get_npkey(sk->pubkey_algo);
393                 sk->skey[i] = mpi_set_opaque(NULL, data, ndata );
394             }
395             else {
396                 csum = 0;
397                 for(i=pubkey_get_npkey(sk->pubkey_algo);
398                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
399                     byte *data;
400                     unsigned int nbits;
401
402                     csum += checksum_mpi (sk->skey[i]);
403                     buffer = mpi_get_buffer( sk->skey[i], &nbytes, NULL );
404                     cipher_sync (cipher_hd);
405                     assert ( !mpi_is_opaque (sk->skey[i]) );
406                     data = m_alloc (nbytes+2);
407                     nbits  = mpi_get_nbits (sk->skey[i]);
408                     assert (nbytes == (nbits + 7)/8);
409                     data[0] = nbits >> 8;
410                     data[1] = nbits;
411                     cipher_encrypt (cipher_hd, data+2, buffer, nbytes);
412                     m_free( buffer );
413                     
414                     mpi_free (sk->skey[i]);
415                     sk->skey[i] = mpi_set_opaque (NULL, data, nbytes+2);
416                 }
417                 sk->csum = csum;
418             }
419             sk->is_protected = 1;
420             cipher_close( cipher_hd );
421         }
422     }
423     return rc;
424 }
425