See ChangeLog: Wed Mar 17 13:09:03 CET 1999 Werner Koch
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certificate packet handling
2  *      Copyright (C) 1998 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 )
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         char save_iv[8];
52
53         if( sk->protect.algo == CIPHER_ALGO_NONE )
54             BUG();
55         if( check_cipher_algo( sk->protect.algo )
56             || cipher_get_blocksize( sk->protect.algo  ) != 8 ) {
57             log_info(_("protection algorithm %d is not supported\n"),
58                         sk->protect.algo );
59             return G10ERR_CIPHER_ALGO;
60         }
61         keyid_from_sk( sk, keyid );
62         keyid[2] = keyid[3] = 0;
63         if( !sk->is_primary ) {
64             PKT_secret_key *sk2 = m_alloc_clear( sizeof *sk2 );
65             if( !get_primary_seckey( sk2, keyid ) )
66                 keyid_from_sk( sk2, keyid+2 );
67             free_secret_key( sk2 );
68         }
69         dek = passphrase_to_dek( keyid, sk->protect.algo,
70                                  &sk->protect.s2k, 0 );
71         cipher_hd = cipher_open( sk->protect.algo,
72                                  CIPHER_MODE_AUTO_CFB, 1);
73         cipher_setkey( cipher_hd, dek->key, dek->keylen );
74         cipher_setiv( cipher_hd, NULL );
75         m_free(dek);
76         save_sk = copy_secret_key( NULL, sk );
77         memcpy(save_iv, sk->protect.iv, 8 );
78         cipher_decrypt( cipher_hd, sk->protect.iv, sk->protect.iv, 8 );
79         csum = 0;
80         if( sk->version >= 4 ) {
81             int ndata;
82             byte *p, *data;
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             data = m_alloc_secure( ndata );
88             cipher_decrypt( cipher_hd, data, p, ndata );
89             mpi_free( sk->skey[i] ); sk->skey[i] = NULL ;
90             p = data;
91             if( ndata < 2 ) {
92                 log_error("not enough bytes for checksum\n");
93                 sk->csum = 0;
94                 csum = 1;
95             }
96             else {
97                 csum = checksum( data, ndata-2);
98                 sk->csum = data[ndata-2] << 8 | data[ndata-1];
99             }
100             /* must check it here otherwise the mpi_read_xx would fail
101              * because the length das an abritary value */
102             if( sk->csum == csum ) {
103                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
104                     nbytes = ndata;
105                     sk->skey[i] = mpi_read_from_buffer(p, &nbytes, 1 );
106                     ndata -= nbytes;
107                     p += nbytes;
108                 }
109             }
110             m_free(data);
111         }
112         else {
113             for(i=pubkey_get_npkey(sk->pubkey_algo);
114                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
115                 buffer = mpi_get_secure_buffer( sk->skey[i], &nbytes, NULL );
116                 cipher_sync( cipher_hd );
117                 assert( mpi_is_protected(sk->skey[i]) );
118                 cipher_decrypt( cipher_hd, buffer, buffer, nbytes );
119                 mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
120                 mpi_clear_protect_flag( sk->skey[i] );
121                 csum += checksum_mpi( sk->skey[i] );
122                 m_free( buffer );
123             }
124             if( opt.emulate_bugs & EMUBUG_GPGCHKSUM ) {
125                csum = sk->csum;
126             }
127         }
128         cipher_close( cipher_hd );
129         /* now let's see whether we have used the right passphrase */
130         if( csum != sk->csum ) {
131             copy_secret_key( sk, save_sk );
132             free_secret_key( save_sk );
133             memcpy( sk->protect.iv, save_iv, 8 );
134             return G10ERR_BAD_PASS;
135         }
136         /* the checksum may fail, so we also check the key itself */
137         res = pubkey_check_secret_key( sk->pubkey_algo, sk->skey );
138         if( res ) {
139             copy_secret_key( sk, save_sk );
140             free_secret_key( save_sk );
141             memcpy( sk->protect.iv, save_iv, 8 );
142             return G10ERR_BAD_PASS;
143         }
144         free_secret_key( save_sk );
145         sk->is_protected = 0;
146     }
147     else { /* not protected, assume it is okay if the checksum is okay */
148         csum = 0;
149         for(i=pubkey_get_npkey(sk->pubkey_algo);
150                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
151             csum += checksum_mpi( sk->skey[i] );
152         }
153         if( csum != sk->csum )
154             return G10ERR_CHECKSUM;
155     }
156
157     return 0;
158 }
159
160
161
162 /****************
163  * Check the secret key
164  * Ask up to 3 (or n) times for a correct passphrase
165  */
166 int
167 check_secret_key( PKT_secret_key *sk, int n )
168 {
169     int rc = G10ERR_BAD_PASS;
170     int i;
171
172     if( n < 1 )
173         n = 3; /* use the default value */
174
175     for(i=0; i < n && rc == G10ERR_BAD_PASS; i++ ) {
176         if( i )
177             log_info(_("Invalid passphrase; please try again ...\n"));
178         rc = do_check( sk );
179         if( rc == G10ERR_BAD_PASS && is_status_enabled() ) {
180             u32 kid[2];
181             char buf[50];
182
183             keyid_from_sk( sk, kid );
184             sprintf(buf, "%08lX%08lX", (ulong)kid[0], (ulong)kid[1]);
185             write_status_text( STATUS_BAD_PASSPHRASE, buf );
186         }
187         if( have_static_passphrase() )
188             break;
189     }
190
191     return rc;
192 }
193
194 /****************
195  * check whether the secret key is protected.
196  * Returns: 0 not protected, -1 on error or the protection algorithm
197  */
198 int
199 is_secret_key_protected( PKT_secret_key *sk )
200 {
201     return sk->is_protected? sk->protect.algo : 0;
202 }
203
204
205
206 /****************
207  * Protect the secret key with the passphrase from DEK
208  */
209 int
210 protect_secret_key( PKT_secret_key *sk, DEK *dek )
211 {
212     int i,j, rc = 0;
213     byte *buffer;
214     unsigned nbytes;
215     u16 csum;
216
217     if( !dek )
218         return 0;
219
220     if( !sk->is_protected ) { /* okay, apply the protection */
221         CIPHER_HANDLE cipher_hd=NULL;
222
223         if( check_cipher_algo( sk->protect.algo ) )
224             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
225         else if( cipher_get_blocksize( sk->protect.algo ) != 8 )
226             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
227         else {
228             print_cipher_algo_note( sk->protect.algo );
229             cipher_hd = cipher_open( sk->protect.algo,
230                                      CIPHER_MODE_AUTO_CFB, 1 );
231             if( cipher_setkey( cipher_hd, dek->key, dek->keylen ) )
232                 log_info(_("WARNING: Weak key detected"
233                            " - please change passphrase again.\n"));
234             cipher_setiv( cipher_hd, NULL );
235             cipher_encrypt( cipher_hd, sk->protect.iv, sk->protect.iv, 8 );
236             if( sk->version >= 4 ) {
237               #define NMPIS (PUBKEY_MAX_NSKEY - PUBKEY_MAX_NPKEY)
238                 byte *bufarr[NMPIS];
239                 unsigned narr[NMPIS];
240                 unsigned nbits[NMPIS];
241                 int ndata=0;
242                 byte *p, *data;
243
244                 for(j=0, i = pubkey_get_npkey(sk->pubkey_algo);
245                         i < pubkey_get_nskey(sk->pubkey_algo); i++, j++ ) {
246                     assert( !mpi_is_opaque( sk->skey[i] ) );
247                     bufarr[j] = mpi_get_buffer( sk->skey[i], &narr[j], NULL );
248                     nbits[j]  = mpi_get_nbits( sk->skey[i] );
249                     ndata += narr[j] + 2;
250                 }
251                 for( ; j < NMPIS; j++ )
252                     bufarr[j] = NULL;
253                 ndata += 2; /* for checksum */
254
255                 data = m_alloc_secure( ndata );
256                 p = data;
257                 for(j=0; j < NMPIS && bufarr[j]; j++ ) {
258                     p[0] = nbits[j] >> 8 ;
259                     p[1] = nbits[j];
260                     p += 2;
261                     memcpy(p, bufarr[j], narr[j] );
262                     p += narr[j];
263                     m_free(bufarr[j]);
264                 }
265               #undef NMPIS
266                 csum = checksum( data, ndata-2);
267                 sk->csum = csum;
268                 *p++ =  csum >> 8;
269                 *p++ =  csum;
270                 assert( p == data+ndata );
271                 cipher_encrypt( cipher_hd, data, data, ndata );
272                 for(i = pubkey_get_npkey(sk->pubkey_algo);
273                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
274                     mpi_free( sk->skey[i] );
275                     sk->skey[i] = NULL;
276                 }
277                 i = pubkey_get_npkey(sk->pubkey_algo);
278                 sk->skey[i] = mpi_set_opaque(NULL, data, ndata );
279             }
280             else {
281                 /* NOTE: we always recalculate the checksum because there
282                  * are some test releases which calculated it wrong */
283                 csum = 0;
284                 for(i=pubkey_get_npkey(sk->pubkey_algo);
285                         i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
286                     csum += checksum_mpi_counted_nbits( sk->skey[i] );
287                     buffer = mpi_get_buffer( sk->skey[i], &nbytes, NULL );
288                     cipher_sync( cipher_hd );
289                     assert( !mpi_is_protected(sk->skey[i]) );
290                     cipher_encrypt( cipher_hd, buffer, buffer, nbytes );
291                     mpi_set_buffer( sk->skey[i], buffer, nbytes, 0 );
292                     mpi_set_protect_flag( sk->skey[i] );
293                     m_free( buffer );
294                 }
295                 sk->csum = csum;
296             }
297             sk->is_protected = 1;
298             cipher_close( cipher_hd );
299         }
300     }
301     return rc;
302 }
303