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