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