* pubkey-enc.c (get_session_key): With hidden recipients or try a given
[gnupg.git] / g10 / pubkey-enc.c
1 /* pubkey-enc.c -  public key encoded packet handling
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 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 "trustdb.h"
32 #include "cipher.h"
33 #include "status.h"
34 #include "options.h"
35 #include "main.h"
36 #include "i18n.h"
37
38 static int get_it( PKT_pubkey_enc *k,
39                    DEK *dek, PKT_secret_key *sk, u32 *keyid );
40
41
42 /* check that the given algo is mentioned in one of the valid user IDs */
43 static int
44 is_algo_in_prefs ( KBNODE keyblock, preftype_t type, int algo )
45 {
46     KBNODE k;
47
48     for (k=keyblock; k; k=k->next) {
49         if (k->pkt->pkttype == PKT_USER_ID) {
50             PKT_user_id *uid = k->pkt->pkt.user_id;
51             prefitem_t *prefs = uid->prefs;
52             
53             if (uid->created && prefs &&
54                 !uid->is_revoked && !uid->is_expired ) {
55                 for (; prefs->type; prefs++ )
56                     if (prefs->type == type && prefs->value == algo)
57                         return 1;
58             }
59         }
60     }
61     return 0;
62 }
63
64
65 /****************
66  * Get the session key from a pubkey enc packet and return
67  * it in DEK, which should have been allocated in secure memory.
68  */
69 int
70 get_session_key( PKT_pubkey_enc *k, DEK *dek )
71 {
72     PKT_secret_key *sk = NULL;
73     int rc;
74
75     rc = check_pubkey_algo2 (k->pubkey_algo, PUBKEY_USAGE_ENC);
76     if( rc )
77         goto leave;
78
79     if( (k->keyid[0] || k->keyid[1]) && !opt.try_all_secrets ) {
80         sk = m_alloc_clear( sizeof *sk );
81         sk->pubkey_algo = k->pubkey_algo; /* we want a pubkey with this algo*/
82         if( !(rc = get_seckey( sk, k->keyid )) )
83             rc = get_it( k, dek, sk, k->keyid );
84     }
85     else { /* anonymous receiver: Try all available secret keys */
86         void *enum_context = NULL;
87         u32 keyid[2];
88         char *p;
89
90         for(;;) {
91             if( sk )
92                 free_secret_key( sk );
93             sk = m_alloc_clear( sizeof *sk );
94             rc=enum_secret_keys( &enum_context, sk, 1, 0);
95             if( rc ) {
96                 rc = G10ERR_NO_SECKEY;
97                 break;
98             }
99             if( sk->pubkey_algo != k->pubkey_algo )
100                 continue;
101             keyid_from_sk( sk, keyid );
102             log_info(_("anonymous recipient; trying secret key %08lX ...\n"),
103                      (ulong)keyid[1] );
104
105             if(!opt.try_all_secrets && !is_status_enabled())
106               {
107                 p=get_last_passphrase();
108                 set_next_passphrase(p);
109                 m_free(p);
110               }
111
112             rc = check_secret_key( sk, opt.try_all_secrets?1:-1 ); /* ask
113                                                                       only
114                                                                       once */
115             if( !rc )
116                 rc = get_it( k, dek, sk, keyid );
117             if( !rc ) {
118                 log_info(_("okay, we are the anonymous recipient.\n") );
119                 break;
120             }
121         }
122         enum_secret_keys( &enum_context, NULL, 0, 0 ); /* free context */
123     }
124
125   leave:
126     if( sk )
127         free_secret_key( sk );
128     return rc;
129 }
130
131
132 static int
133 get_it( PKT_pubkey_enc *enc, DEK *dek, PKT_secret_key *sk, u32 *keyid )
134 {
135     int rc;
136     MPI plain_dek  = NULL;
137     byte *frame = NULL;
138     unsigned n, nframe;
139     u16 csum, csum2;
140
141     rc = pubkey_decrypt(sk->pubkey_algo, &plain_dek, enc->data, sk->skey );
142     if( rc )
143         goto leave;
144     frame = mpi_get_buffer( plain_dek, &nframe, NULL );
145     mpi_free( plain_dek ); plain_dek = NULL;
146
147     /* Now get the DEK (data encryption key) from the frame
148      *
149      * Old versions encode the DEK in in this format (msb is left):
150      *
151      *     0  1  DEK(16 bytes)  CSUM(2 bytes)  0  RND(n bytes) 2
152      *
153      * Later versions encode the DEK like this:
154      *
155      *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
156      *
157      * (mpi_get_buffer already removed the leading zero).
158      *
159      * RND are non-zero randow bytes.
160      * A   is the cipher algorithm
161      * DEK is the encryption key (session key) with length k
162      * CSUM
163      */
164     if( DBG_CIPHER )
165         log_hexdump("DEK frame:", frame, nframe );
166     n=0;
167     if( n + 7 > nframe )
168         { rc = G10ERR_WRONG_SECKEY; goto leave; }
169     if( frame[n] == 1 && frame[nframe-1] == 2 ) {
170         log_info(_("old encoding of the DEK is not supported\n"));
171         rc = G10ERR_CIPHER_ALGO;
172         goto leave;
173     }
174     if( frame[n] != 2 )  /* somethink is wrong */
175         { rc = G10ERR_WRONG_SECKEY; goto leave; }
176     for(n++; n < nframe && frame[n]; n++ ) /* skip the random bytes */
177         ;
178     n++; /* and the zero byte */
179     if( n + 4 > nframe )
180         { rc = G10ERR_WRONG_SECKEY; goto leave; }
181
182     dek->keylen = nframe - (n+1) - 2;
183     dek->algo = frame[n++];
184     if( dek->algo ==  CIPHER_ALGO_IDEA )
185         write_status(STATUS_RSA_OR_IDEA);
186     rc = check_cipher_algo( dek->algo );
187     if( rc ) {
188         if( !opt.quiet && rc == G10ERR_CIPHER_ALGO ) {
189             log_info(_("cipher algorithm %d%s is unknown or disabled\n"),
190                      dek->algo, dek->algo == CIPHER_ALGO_IDEA? " (IDEA)":"");
191             if(dek->algo==CIPHER_ALGO_IDEA)
192               idea_cipher_warn(0);
193         }
194         dek->algo = 0;
195         goto leave;
196     }
197     if( (dek->keylen*8) != cipher_get_keylen( dek->algo ) ) {
198         rc = G10ERR_WRONG_SECKEY;
199         goto leave;
200     }
201
202     /* copy the key to DEK and compare the checksum */
203     csum  = frame[nframe-2] << 8;
204     csum |= frame[nframe-1];
205     memcpy( dek->key, frame+n, dek->keylen );
206     for( csum2=0, n=0; n < dek->keylen; n++ )
207         csum2 += dek->key[n];
208     if( csum != csum2 ) {
209         rc = G10ERR_WRONG_SECKEY;
210         goto leave;
211     }
212     if( DBG_CIPHER )
213         log_hexdump("DEK is:", dek->key, dek->keylen );
214     /* check that the algo is in the preferences and whether it has expired */
215     {
216         PKT_public_key *pk = NULL;
217         KBNODE pkb = get_pubkeyblock (keyid);
218
219         if( !pkb ) {
220             rc = -1;
221             log_error("oops: public key not found for preference check\n");
222         }
223         else if( pkb->pkt->pkt.public_key->selfsigversion > 3
224             && dek->algo != CIPHER_ALGO_3DES
225             && !is_algo_in_prefs( pkb, PREFTYPE_SYM, dek->algo ) ) {
226             /* Don't print a note while we are not on verbose mode,
227              * the cipher is blowfish and the preferences have twofish
228              * listed */
229             if( opt.verbose || dek->algo != CIPHER_ALGO_BLOWFISH
230                 || !is_algo_in_prefs( pkb, PREFTYPE_SYM, CIPHER_ALGO_TWOFISH))
231                 log_info(_(
232                     "NOTE: cipher algorithm %d not found in preferences\n"),
233                                                                  dek->algo );
234         }
235
236         if (!rc) {
237             KBNODE k;
238             
239             for (k=pkb; k; k = k->next) {
240                 if (k->pkt->pkttype == PKT_PUBLIC_KEY 
241                     || k->pkt->pkttype == PKT_PUBLIC_SUBKEY){
242                     u32 aki[2];
243                     keyid_from_pk(k->pkt->pkt.public_key, aki);
244
245                     if (aki[0]==keyid[0] && aki[1]==keyid[1]) {
246                         pk = k->pkt->pkt.public_key;
247                         break;
248                     }
249                 }
250             }
251             if (!pk)
252                 BUG ();
253             if ( pk->expiredate && pk->expiredate <= make_timestamp() ) {
254                 log_info(_("NOTE: secret key %08lX expired at %s\n"),
255                          (ulong)keyid[1], asctimestamp( pk->expiredate) );
256             }
257         }
258
259         if ( pk &&  pk->is_revoked ) {
260             log_info( _("NOTE: key has been revoked") );
261             putc( '\n', log_stream() );
262             show_revocation_reason( pk, 1 );
263         }
264
265         release_kbnode (pkb);
266         rc = 0;
267     }
268
269
270   leave:
271     mpi_free(plain_dek);
272     m_free(frame);
273     return rc;
274 }
275
276
277 /****************
278  * Get the session key from the given string.
279  * String is supposed to be formatted as this:
280  *  <algo-id>:<even-number-of-hex-digits>
281  */
282 int
283 get_override_session_key( DEK *dek, const char *string )
284 {
285     const char *s;
286     int i;
287
288     if ( !string )
289         return G10ERR_BAD_KEY;
290     dek->algo = atoi(string);
291     if ( dek->algo < 1 )
292         return G10ERR_BAD_KEY;
293     if ( !(s = strchr ( string, ':' )) )
294         return G10ERR_BAD_KEY;
295     s++;
296     for(i=0; i < DIM(dek->key) && *s; i++, s +=2 ) {
297         int c = hextobyte ( s );
298         if (c == -1)
299             return G10ERR_BAD_KEY;
300         dek->key[i] = c;
301     }
302     if ( *s )
303         return G10ERR_BAD_KEY;
304     dek->keylen = i;
305     return 0;
306 }
307