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