Make public key data structure easier to read.
[gnupg.git] / g10 / seckey-cert.c
1 /* seckey-cert.c -  secret key certificate packet handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002,
3  *               2006, 2009 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 3 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25 #include <assert.h>
26
27 #include "gpg.h"
28 #include "util.h"
29 #include "packet.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 #include "pkglue.h"
37
38 #if 0 /* Not anymore used - kept for reference.  */
39 static int
40 do_check( PKT_secret_key *sk, const char *tryagain_text, int mode,
41           int *canceled )
42 {
43     gpg_error_t err;
44     byte *buffer;
45     u16 csum=0;
46     int i, res;
47     size_t nbytes;
48
49     if( sk->is_protected ) { /* remove the protection */
50         DEK *dek = NULL;
51         u32 keyid[4]; /* 4! because we need two of them */
52         gcry_cipher_hd_t cipher_hd=NULL;
53         PKT_secret_key *save_sk;
54
55         if( sk->protect.s2k.mode == 1001 ) {
56             log_info(_("secret key parts are not available\n"));
57             return G10ERR_UNU_SECKEY;
58         }
59         if( sk->protect.algo == CIPHER_ALGO_NONE )
60             BUG();
61         if( openpgp_cipher_test_algo( sk->protect.algo ) ) {
62             log_info(_("protection algorithm %d%s is not supported\n"),
63                         sk->protect.algo,sk->protect.algo==1?" (IDEA)":"" );
64             if (sk->protect.algo==CIPHER_ALGO_IDEA)
65               {
66                 write_status (STATUS_RSA_OR_IDEA);
67                 idea_cipher_warn (0);
68               }
69             return G10ERR_CIPHER_ALGO;
70         }
71         if(gcry_md_test_algo (sk->protect.s2k.hash_algo))
72           {
73             log_info(_("protection digest %d is not supported\n"),
74                      sk->protect.s2k.hash_algo);
75             return G10ERR_DIGEST_ALGO;
76           }
77         keyid_from_sk( sk, keyid );
78         keyid[2] = keyid[3] = 0;
79         if (!sk->flags.primary)
80           {
81             keyid[2] = sk->main_keyid[0];
82             keyid[3] = sk->main_keyid[1];
83           }
84         dek = passphrase_to_dek( keyid, sk->pubkey_algo, sk->protect.algo,
85                                  &sk->protect.s2k, mode,
86                                  tryagain_text, canceled );
87         if (!dek && canceled && *canceled)
88             return GPG_ERR_CANCELED;
89
90
91         err = openpgp_cipher_open (&cipher_hd, sk->protect.algo,
92                                    GCRY_CIPHER_MODE_CFB,
93                                    (GCRY_CIPHER_SECURE
94                                     | (sk->protect.algo >= 100 ?
95                                        0 : GCRY_CIPHER_ENABLE_SYNC)));
96         if (err)
97           log_fatal ("cipher open failed: %s\n", gpg_strerror (err) );
98
99         err = gcry_cipher_setkey (cipher_hd, dek->key, dek->keylen);
100         if (err)
101           log_fatal ("set key failed: %s\n", gpg_strerror (err) );
102
103         xfree(dek);
104         save_sk = copy_secret_key( NULL, sk );
105
106         gcry_cipher_setiv ( cipher_hd, sk->protect.iv, sk->protect.ivlen );
107
108         csum = 0;
109         if( sk->version >= 4 ) {
110             int ndata;
111             unsigned int ndatabits;
112             byte *p, *data;
113             u16 csumc = 0;
114
115             i = pubkey_get_npkey(sk->pubkey_algo);
116
117             assert ( gcry_mpi_get_flag (sk->skey[i], GCRYMPI_FLAG_OPAQUE ));
118             p = gcry_mpi_get_opaque ( sk->skey[i], &ndatabits );
119             ndata = (ndatabits+7)/8;
120
121             if ( ndata > 1 )
122                 csumc = p[ndata-2] << 8 | p[ndata-1];
123             data = xmalloc_secure ( ndata );
124             gcry_cipher_decrypt ( cipher_hd, data, ndata, p, ndata );
125             gcry_mpi_release (sk->skey[i]); sk->skey[i] = NULL ;
126
127             p = data;
128             if (sk->protect.sha1chk) {
129                 /* This is the new SHA1 checksum method to detect
130                    tampering with the key as used by the Klima/Rosa
131                    attack */
132                 sk->csum = 0;
133                 csum = 1;
134                 if( ndata < 20 ) 
135                     log_error("not enough bytes for SHA-1 checksum\n");
136                 else {
137                     gcry_md_hd_t h;
138
139                     if ( gcry_md_open (&h, DIGEST_ALGO_SHA1, 1))
140                         BUG(); /* Algo not available. */
141                     gcry_md_write (h, data, ndata - 20);
142                     gcry_md_final (h);
143                     if (!memcmp (gcry_md_read (h, DIGEST_ALGO_SHA1),
144                                  data + ndata - 20, 20) ) 
145                       {
146                         /* Digest does match.  We have to keep the old
147                            style checksum in sk->csum, so that the
148                            test used for unprotected keys does work.
149                            This test gets used when we are adding new
150                            keys. */
151                         sk->csum = csum = checksum (data, ndata-20);
152                       } 
153                     gcry_md_close (h);
154                 }
155             }
156             else {
157                 if( ndata < 2 ) {
158                     log_error("not enough bytes for checksum\n");
159                     sk->csum = 0;
160                     csum = 1;
161                 }
162                 else {
163                     csum = checksum( data, ndata-2);
164                     sk->csum = data[ndata-2] << 8 | data[ndata-1];
165                     if ( sk->csum != csum ) {
166                         /* This is a PGP 7.0.0 workaround */
167                         sk->csum = csumc; /* take the encrypted one */
168                     }
169                 }
170             }
171
172             /* Must check it here otherwise the mpi_read_xx would fail
173                because the length may have an arbitrary value */
174             if( sk->csum == csum ) {
175                 for( ; i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
176                     if ( gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_PGP,
177                                         p, ndata, &nbytes))
178                       {
179                         /* Checksum was okay, but not correctly
180                            decrypted.  */
181                         sk->csum = 0;
182                         csum = 1;
183                         break;
184                       }
185                     ndata -= nbytes;
186                     p += nbytes;
187                 }
188                 /* Note: at this point ndata should be 2 for a simple
189                    checksum or 20 for the sha1 digest */
190             }
191             xfree(data);
192         }
193         else {
194             for(i=pubkey_get_npkey(sk->pubkey_algo);
195                     i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
196                 byte *p;
197                 size_t ndata;
198                 unsigned int ndatabits;
199
200                 assert (gcry_mpi_get_flag (sk->skey[i], GCRYMPI_FLAG_OPAQUE));
201                 p = gcry_mpi_get_opaque (sk->skey[i], &ndatabits);
202                 ndata = (ndatabits+7)/8;
203                 assert (ndata >= 2);
204                 assert (ndata == ((p[0] << 8 | p[1]) + 7)/8 + 2);
205                 buffer = xmalloc_secure (ndata);
206                 gcry_cipher_sync (cipher_hd);
207                 buffer[0] = p[0];
208                 buffer[1] = p[1];
209                 gcry_cipher_decrypt (cipher_hd, buffer+2, ndata-2,
210                                      p+2, ndata-2);
211                 csum += checksum (buffer, ndata);
212                 gcry_mpi_release (sk->skey[i]);
213
214                 err = gcry_mpi_scan( &sk->skey[i], GCRYMPI_FMT_PGP,
215                                      buffer, ndata, &ndata );
216                 xfree (buffer);
217                 if (err)
218                   {
219                     /* Checksum was okay, but not correctly
220                        decrypted.  */
221                     sk->csum = 0;
222                     csum = 1;
223                     break;
224                   }
225 /*              csum += checksum_mpi (sk->skey[i]); */
226             }
227         }
228         gcry_cipher_close ( cipher_hd );
229
230         /* Now let's see whether we have used the correct passphrase. */
231         if( csum != sk->csum ) {
232             copy_secret_key( sk, save_sk );
233             passphrase_clear_cache ( keyid, NULL, sk->pubkey_algo );
234             free_secret_key( save_sk );
235             return gpg_error (GPG_ERR_BAD_PASSPHRASE);
236         }
237
238         /* The checksum may fail, so we also check the key itself. */
239         res = pk_check_secret_key ( sk->pubkey_algo, sk->skey );
240         if( res ) {
241             copy_secret_key( sk, save_sk );
242             passphrase_clear_cache ( keyid, NULL, sk->pubkey_algo );
243             free_secret_key( save_sk );
244             return gpg_error (GPG_ERR_BAD_PASSPHRASE);
245         }
246         free_secret_key( save_sk );
247         sk->is_protected = 0;
248     }
249     else { /* not protected, assume it is okay if the checksum is okay */
250         csum = 0;
251         for(i=pubkey_get_npkey(sk->pubkey_algo);
252                 i < pubkey_get_nskey(sk->pubkey_algo); i++ ) {
253             csum += checksum_mpi( sk->skey[i] );
254         }
255         if( csum != sk->csum )
256             return G10ERR_CHECKSUM;
257     }
258
259     return 0;
260 }
261 #endif /*0*/
262
263
264 /****************
265  * check whether the secret key is protected.
266  * Returns: 0 not protected, -1 on error or the protection algorithm
267  *                           -2 indicates a card stub.
268  *                           -3 indicates a not-online stub.
269  */
270 int
271 is_secret_key_protected (PKT_public_key *pk)
272 {
273 #warning do we need this
274   return 0; /* FIXME:  use agent_get_keyinfo?*/
275     /* return sk->is_protected? */
276     /*            sk->protect.s2k.mode == 1002? -2 : */
277     /*            sk->protect.s2k.mode == 1001? -3 : sk->protect.algo : 0; */
278 }