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