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