d2d39dacf86813bec12c7756be1db271a655100c
[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                 byte *p;
153                 int ndata;
154                 unsigned int dummy;
155
156                 assert (mpi_is_opaque (sk->skey[i]));
157                 p = mpi_get_opaque (sk->skey[i], &ndata);
158                 assert (ndata >= 2);
159                 assert (ndata == ((p[0] << 8 | p[1]) + 7)/8 + 2);
160                 buffer = m_alloc_secure (ndata);
161                 cipher_sync (cipher_hd);
162                 buffer[0] = p[0];
163                 buffer[1] = p[1];
164                 cipher_decrypt (cipher_hd, buffer+2, p+2, ndata-2);
165                 csum += checksum (buffer, ndata);
166                 mpi_free (sk->skey[i]);
167                 dummy = ndata;
168                 sk->skey[i] = mpi_read_from_buffer (buffer, &dummy, 1);
169                 assert (sk->skey[i]);
170                 m_free (buffer);
171 /*              csum += checksum_mpi (sk->skey[i]); */
172             }
173         }
174         cipher_close( cipher_hd );
175         /* now let's see whether we have used the right passphrase */
176         if( csum != sk->csum ) {
177             copy_secret_key( sk, save_sk );
178             passphrase_clear_cache ( keyid, sk->pubkey_algo );
179             free_secret_key( save_sk );
180             return G10ERR_BAD_PASS;
181         }
182         /* the checksum may fail, so we also check the key itself */
183         res = pubkey_check_secret_key( sk->pubkey_algo, sk->skey );
184         if( res ) {
185             copy_secret_key( sk, save_sk );
186             passphrase_clear_cache ( keyid, sk->pubkey_algo );
187             free_secret_key( save_sk );
188             return G10ERR_BAD_PASS;
189         }
190         free_secret_key( save_sk );
191         sk->is_protected = 0;
192     }
193     else { /* not protected, assume it is okay if the checksum is okay */
194         csum = 0;
195         for(i=pubkey_get_npkey(sk->pubkey_algo);
196                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
197             csum += checksum_mpi( sk->skey[i] );
198         }
199         if( csum != sk->csum )
200             return G10ERR_CHECKSUM;
201     }
202
203     return 0;
204 }
205
206
207
208 /****************
209  * Check the secret key
210  * Ask up to 3 (or n) times for a correct passphrase
211  */
212 int
213 check_secret_key( PKT_secret_key *sk, int n )
214 {
215     int rc = G10ERR_BAD_PASS;
216     int i;
217
218     if( n < 1 )
219         n = (opt.batch && !opt.use_agent)? 1 : 3; /* use the default value */
220
221     for(i=0; i < n && rc == G10ERR_BAD_PASS; i++ ) {
222         const char *tryagain = NULL;
223         if (i) {
224             tryagain = _("Invalid passphrase; please try again");
225             log_info (_("%s ...\n"), tryagain);
226         }
227         rc = do_check( sk, tryagain );
228         if( rc == G10ERR_BAD_PASS && is_status_enabled() ) {
229             u32 kid[2];
230             char buf[50];
231
232             keyid_from_sk( sk, kid );
233             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
234             write_status_text( STATUS_BAD_PASSPHRASE, buf );
235         }
236         if( have_static_passphrase() )
237             break;
238     }
239
240     if( !rc )
241         write_status( STATUS_GOOD_PASSPHRASE );
242
243     return rc;
244 }
245
246 /****************
247  * check whether the secret key is protected.
248  * Returns: 0 not protected, -1 on error or the protection algorithm
249  */
250 int
251 is_secret_key_protected( PKT_secret_key *sk )
252 {
253     return sk->is_protected? sk->protect.algo : 0;
254 }
255
256
257
258 /****************
259  * Protect the secret key with the passphrase from DEK
260  */
261 int
262 protect_secret_key( PKT_secret_key *sk, DEK *dek )
263 {
264     int i,j, rc = 0;
265     byte *buffer;
266     unsigned nbytes;
267     u16 csum;
268
269     if( !dek )
270         return 0;
271
272     if( !sk->is_protected ) { /* okay, apply the protection */
273         CIPHER_HANDLE cipher_hd=NULL;
274
275         if( check_cipher_algo( sk->protect.algo ) )
276             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
277         else {
278             print_cipher_algo_note( sk->protect.algo );
279             cipher_hd = cipher_open( sk->protect.algo,
280                                      CIPHER_MODE_AUTO_CFB, 1 );
281             if( cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
282                 log_info(_("WARNING: Weak key detected"
283                            " - please change passphrase again.\n"));
284             sk->protect.ivlen = cipher_get_blocksize( sk->protect.algo );
285             assert( sk->protect.ivlen <= DIM(sk->protect.iv) );
286             if( sk->protect.ivlen != 8 && sk->protect.ivlen != 16 )
287                 BUG(); /* yes, we are very careful */
288             randomize_buffer(sk->protect.iv, sk->protect.ivlen, 1);
289             cipher_setiv( cipher_hd, sk->protect.iv, sk->protect.ivlen );
290             if( sk->version >= 4 ) {
291                 byte *bufarr[PUBKEY_MAX_NSKEY];
292                 unsigned narr[PUBKEY_MAX_NSKEY];
293                 unsigned nbits[PUBKEY_MAX_NSKEY];
294                 int ndata=0;
295                 byte *p, *data;
296
297                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
298                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
299                     assert( !mpi_is_opaque( sk->skey[i] ) );
300                     bufarr[j] = mpi_get_buffer( sk->skey[i], &narr[j], NULL );
301                     nbits[j]  = mpi_get_nbits( sk->skey[i] );
302                     ndata += narr[j] + 2;
303                 }
304                 for( ; j < PUBKEY_MAX_NSKEY; j++ )
305                     bufarr[j] = NULL;
306                 ndata += opt.simple_sk_checksum? 2 : 20; /* for checksum */
307
308                 data = m_alloc_secure( ndata );
309                 p = data;
310                 for(j=0; j < PUBKEY_MAX_NSKEY && bufarr[j]; j++ ) {
311                     p[0] = nbits[j] >> 8 ;
312                     p[1] = nbits[j];
313                     p += 2;
314                     memcpy(p, bufarr[j], narr[j] );
315                     p += narr[j];
316                     m_free(bufarr[j]);
317                 }
318                 
319                 if (opt.simple_sk_checksum) {
320                     log_info (_("generating the deprecated 16-bit checksum"
321                               " for secret key protection\n")); 
322                     csum = checksum( data, ndata-2);
323                     sk->csum = csum;
324                     *p++ =      csum >> 8;
325                     *p++ =      csum;
326                     sk->protect.sha1chk = 0;
327                 }
328                 else {
329                     MD_HANDLE h = md_open (DIGEST_ALGO_SHA1, 1);
330                     if (!h)
331                         BUG(); /* algo not available */
332                     md_write (h, data, ndata - 20);
333                     md_final (h);
334                     memcpy (p, md_read (h, DIGEST_ALGO_SHA1), 20);
335                     p += 20;
336                     md_close (h);
337                     sk->csum = csum = 0;
338                     sk->protect.sha1chk = 1;
339                 }
340                 assert( p == data+ndata );
341
342                 cipher_encrypt( cipher_hd, data, data, ndata );
343                 for(i = pubkey_get_npkey(sk->pubkey_algo);
344                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
345                     mpi_free( sk->skey[i] );
346                     sk->skey[i] = NULL;
347                 }
348                 i = pubkey_get_npkey(sk->pubkey_algo);
349                 sk->skey[i] = mpi_set_opaque(NULL, data, ndata );
350             }
351             else {
352                 csum = 0;
353                 for(i=pubkey_get_npkey(sk->pubkey_algo);
354                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
355                     byte *data;
356                     unsigned int nbits;
357
358                     csum += checksum_mpi (sk->skey[i]);
359                     buffer = mpi_get_buffer( sk->skey[i], &nbytes, NULL );
360                     cipher_sync (cipher_hd);
361                     assert ( !mpi_is_opaque (sk->skey[i]) );
362                     data = m_alloc (nbytes+2);
363                     nbits  = mpi_get_nbits (sk->skey[i]);
364                     assert (nbytes == (nbits + 7)/8);
365                     data[0] = nbits >> 8;
366                     data[1] = nbits;
367                     cipher_encrypt (cipher_hd, data+2, buffer, nbytes);
368                     m_free( buffer );
369                     
370                     mpi_free (sk->skey[i]);
371                     sk->skey[i] = mpi_set_opaque (NULL, data, nbytes+2);
372                 }
373                 sk->csum = csum;
374             }
375             sk->is_protected = 1;
376             cipher_close( cipher_hd );
377         }
378     }
379     return rc;
380 }
381