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