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