applied Mathews typo and grammar fixes
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certifucate 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
35
36 static int
37 do_check( PKT_secret_cert *cert )
38 {
39     byte *buffer;
40     u16 csum=0;
41     int res;
42     unsigned nbytes;
43
44     if( cert->is_protected ) { /* remove the protection */
45         DEK *dek = NULL;
46         u32 keyid[2];
47         CIPHER_HANDLE cipher_hd=NULL;
48         PKT_secret_cert *save_cert;
49         char save_iv[8];
50
51         switch( cert->protect.algo ) {
52           case CIPHER_ALGO_NONE: BUG(); break;
53           case CIPHER_ALGO_BLOWFISH:
54           case CIPHER_ALGO_CAST:
55             keyid_from_skc( cert, keyid );
56             if( cert->protect.s2k == 1 || cert->protect.s2k == 3 )
57                 dek = get_passphrase_hash( keyid, NULL,
58                                                  cert->protect.salt );
59             else
60                 dek = get_passphrase_hash( keyid, NULL, NULL );
61
62             cipher_hd = cipher_open( cert->protect.algo,
63                                      CIPHER_MODE_AUTO_CFB, 1);
64             cipher_setkey( cipher_hd, dek->key, dek->keylen );
65             cipher_setiv( cipher_hd, NULL );
66             m_free(dek); /* pw is in secure memory, so m_free() burns it */
67             save_cert = copy_secret_cert( NULL, cert );
68             memcpy(save_iv, cert->protect.iv, 8 );
69             cipher_decrypt( cipher_hd, cert->protect.iv, cert->protect.iv, 8 );
70             switch( cert->pubkey_algo ) {
71               case PUBKEY_ALGO_ELGAMAL:
72                 buffer = mpi_get_secure_buffer( cert->d.elg.x, &nbytes, NULL );
73                 cipher_decrypt( cipher_hd, buffer, buffer, nbytes );
74                 mpi_set_buffer( cert->d.elg.x, buffer, nbytes, 0 );
75                 csum = checksum_mpi( cert->d.elg.x );
76                 m_free( buffer );
77                 break;
78               case PUBKEY_ALGO_DSA:
79                 buffer = mpi_get_secure_buffer( cert->d.dsa.x, &nbytes, NULL );
80                 cipher_decrypt( cipher_hd, buffer, buffer, nbytes );
81                 mpi_set_buffer( cert->d.dsa.x, buffer, nbytes, 0 );
82                 csum = checksum_mpi( cert->d.dsa.x );
83                 m_free( buffer );
84                 break;
85             #ifdef HAVE_RSA_CIPHER
86               case PUBKEY_ALGO_RSA:
87                 csum = 0;
88                 #define X(a) do { \
89                     buffer = mpi_get_secure_buffer( cert->d.rsa.##a,     \
90                                                     &nbytes, NULL );     \
91                     csum += checksum_u16( nbytes*8 );                    \
92                     cipher_decrypt( cipher_hd, buffer, buffer, nbytes ); \
93                     csum += checksum( buffer, nbytes );                  \
94                     mpi_set_buffer(cert->d.rsa.##a, buffer, nbytes, 0 ); \
95                     m_free( buffer );                                    \
96                    } while(0)
97                 X(d);
98                 X(p);
99                 X(q);
100                 X(u);
101                 #undef X
102                 break;
103             #endif /* HAVE_RSA_CIPHER */
104
105               default: BUG();
106             }
107             cipher_close( cipher_hd );
108             /* now let's see whether we have used the right passphrase */
109             if( csum != cert->csum ) {
110                 if( cert->pubkey_algo == PUBKEY_ALGO_ELGAMAL ) {
111                     /* very bad kludge to work around an early bug */
112                     csum -= checksum_u16( mpi_get_nbits(cert->d.elg.x) );
113                     nbytes = mpi_get_nlimbs(cert->d.elg.x) * 4;
114                     csum += checksum_u16( nbytes*8 );
115                     if( !opt.batch && csum == cert->csum )
116                         log_info("Probably you have an old key - use "
117                              "\"--change-passphrase\" to convert.\n");
118                 }
119                 if( csum != cert->csum ) {
120                     copy_secret_cert( cert, save_cert );
121                     free_secret_cert( save_cert );
122                     memcpy( cert->protect.iv, save_iv, 8 );
123                     return G10ERR_BAD_PASS;
124                 }
125             }
126
127             switch( cert->pubkey_algo ) {
128               case PUBKEY_ALGO_ELGAMAL:
129                 res = elg_check_secret_key( &cert->d.elg );
130                 break;
131               case PUBKEY_ALGO_DSA:
132                 res = dsa_check_secret_key( &cert->d.dsa );
133                 break;
134             #ifdef HAVE_RSA_CIPHER
135               case PUBKEY_ALGO_RSA:
136                 res = rsa_check_secret_key( &cert->d.rsa );
137                 break;
138             #endif
139               default: BUG();
140             }
141             if( !res ) {
142                 copy_secret_cert( cert, save_cert );
143                 free_secret_cert( save_cert );
144                 memcpy( cert->protect.iv, save_iv, 8 );
145                 return G10ERR_BAD_PASS;
146             }
147             free_secret_cert( save_cert );
148             cert->is_protected = 0;
149             break;
150
151           default:
152             return G10ERR_CIPHER_ALGO; /* unsupported protection algorithm */
153         }
154     }
155     else { /* not protected */
156         switch( cert->pubkey_algo ) {
157           case PUBKEY_ALGO_ELGAMAL:
158             csum = checksum_mpi( cert->d.elg.x );
159             break;
160           case PUBKEY_ALGO_DSA:
161             csum = checksum_mpi( cert->d.dsa.x );
162             break;
163         #ifdef HAVE_RSA_CIPHER
164           case PUBKEY_ALGO_RSA:
165             csum =0;
166             buffer = mpi_get_buffer( cert->d.rsa.rsa_d, &nbytes, NULL );
167             csum += checksum_u16( nbytes*8 );
168             csum += checksum( buffer, nbytes );
169             m_free( buffer );
170             buffer = mpi_get_buffer( cert->d.rsa.rsa_p, &nbytes, NULL );
171             csum += checksum_u16( nbytes*8 );
172             csum += checksum( buffer, nbytes );
173             m_free( buffer );
174             buffer = mpi_get_buffer( cert->d.rsa.rsa_q, &nbytes, NULL );
175             csum += checksum_u16( nbytes*8 );
176             csum += checksum( buffer, nbytes );
177             m_free( buffer );
178             buffer = mpi_get_buffer( cert->d.rsa.rsa_u, &nbytes, NULL );
179             csum += checksum_u16( nbytes*8 );
180             csum += checksum( buffer, nbytes );
181             m_free( buffer );
182             break;
183         #endif
184           default: BUG();
185         }
186         if( csum != cert->csum ) {
187             if( cert->pubkey_algo == PUBKEY_ALGO_ELGAMAL ) {
188                 /* very bad kludge to work around an early bug */
189                 csum -= checksum_u16( mpi_get_nbits(cert->d.elg.x) );
190                 nbytes = mpi_get_nlimbs(cert->d.elg.x) * 4;
191                 csum += checksum_u16( nbytes*8 );
192                 if( !opt.batch && csum == cert->csum )
193                     log_info("Probably you have an old key - use "
194                          "\"--change-passphrase\" to convert.\n");
195             }
196             if( csum != cert->csum )
197                 return G10ERR_CHECKSUM;
198         }
199     }
200
201     return 0;
202 }
203
204
205
206 /****************
207  * Check the secret key certificate
208  * Ask up to 3 times for a correct passphrase
209  */
210 int
211 check_secret_key( PKT_secret_cert *cert )
212 {
213     int rc = G10ERR_BAD_PASS;
214     int i;
215
216     for(i=0; i < 3 && rc == G10ERR_BAD_PASS; i++ ) {
217         if( i )
218             log_error("Invalid passphrase; please try again ...\n");
219         switch( cert->pubkey_algo ) {
220           case PUBKEY_ALGO_ELGAMAL:
221           case PUBKEY_ALGO_DSA:
222             rc = do_check( cert );
223             break;
224           default: rc = G10ERR_PUBKEY_ALGO;
225         }
226         if( get_passphrase_fd() != -1 )
227             break;
228     }
229     return rc;
230 }
231
232 /****************
233  * check whether the secret key is protected.
234  * Returns: 0 not protected, -1 on error or the protection algorithm
235  */
236 int
237 is_secret_key_protected( PKT_secret_cert *cert )
238 {
239     return cert->is_protected? cert->protect.algo : 0;
240 }
241
242
243 static int
244 do_protect( void (*fnc)(CIPHER_HANDLE, byte *, byte *, unsigned),
245             CIPHER_HANDLE fnc_hd, PKT_secret_cert *cert )
246 {
247     byte *buffer;
248     unsigned nbytes;
249
250     switch( cert->pubkey_algo ) {
251       case PUBKEY_ALGO_ELGAMAL:
252         /* recalculate the checksum, so that --change-passphrase
253          * can be used to convert from the faulty to the correct one
254          * wk 06.04.98:
255          * fixme: remove this some time in the future.
256          */
257         cert->csum = checksum_mpi( cert->d.elg.x );
258         buffer = mpi_get_buffer( cert->d.elg.x, &nbytes, NULL );
259         (*fnc)( fnc_hd, buffer, buffer, nbytes );
260         mpi_set_buffer( cert->d.elg.x, buffer, nbytes, 0 );
261         m_free( buffer );
262         break;
263
264       case PUBKEY_ALGO_DSA:
265         buffer = mpi_get_buffer( cert->d.dsa.x, &nbytes, NULL );
266         (*fnc)( fnc_hd, buffer, buffer, nbytes );
267         mpi_set_buffer( cert->d.dsa.x, buffer, nbytes, 0 );
268         m_free( buffer );
269         break;
270
271       default: return G10ERR_PUBKEY_ALGO;
272     }
273     return 0;
274 }
275
276
277 /****************
278  * Protect the secret key certificate with the passphrase from DEK
279  */
280 int
281 protect_secret_key( PKT_secret_cert *cert, DEK *dek )
282 {
283     int rc=0;
284
285     if( !dek )
286         return 0;
287
288     if( !cert->is_protected ) { /* okay, apply the protection */
289         CIPHER_HANDLE cipher_hd=NULL;
290
291         switch( cert->protect.algo ) {
292           case CIPHER_ALGO_NONE: BUG(); break;
293           case CIPHER_ALGO_BLOWFISH:
294           case CIPHER_ALGO_CAST:
295             cipher_hd = cipher_open( cert->protect.algo,
296                                      CIPHER_MODE_AUTO_CFB, 1 );
297             cipher_setkey( cipher_hd, dek->key, dek->keylen );
298             cipher_setiv( cipher_hd, NULL );
299             cipher_encrypt( cipher_hd, cert->protect.iv, cert->protect.iv, 8 );
300             if( !do_protect( &cipher_encrypt, cipher_hd, cert ) )
301                 cert->is_protected = 1;
302             cipher_close( cipher_hd );
303             break;
304
305           default:
306             rc = G10ERR_CIPHER_ALGO; /* unsupport protection algorithm */
307             break;
308         }
309     }
310     return rc;
311 }
312