More agent support for gpg.
[gnupg.git] / g10 / pubkey-enc.c
1 /* pubkey-enc.c - Process a public key encoded packet.
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2006, 2009,
3  *               2010 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 "trustdb.h"
32 #include "cipher.h"
33 #include "status.h"
34 #include "options.h"
35 #include "main.h"
36 #include "i18n.h"
37 #include "pkglue.h"
38 #include "call-agent.h"
39
40
41 static gpg_error_t get_it (PKT_pubkey_enc *k,
42                            DEK *dek, PKT_public_key *sk, u32 *keyid);
43
44
45 /* Check that the given algo is mentioned in one of the valid user-ids. */
46 static int
47 is_algo_in_prefs (kbnode_t keyblock, preftype_t type, int algo)
48 {
49   kbnode_t k;
50
51   for (k = keyblock; k; k = k->next)
52     {
53       if (k->pkt->pkttype == PKT_USER_ID)
54         {
55           PKT_user_id *uid = k->pkt->pkt.user_id;
56           prefitem_t *prefs = uid->prefs;
57
58           if (uid->created && prefs && !uid->is_revoked && !uid->is_expired)
59             {
60               for (; prefs->type; prefs++)
61                 if (prefs->type == type && prefs->value == algo)
62                   return 1;
63             }
64         }
65     }
66   return 0;
67 }
68
69
70 /*
71  * Get the session key from a pubkey enc packet and return it in DEK,
72  * which should have been allocated in secure memory by the caller.
73  */
74 gpg_error_t
75 get_session_key (PKT_pubkey_enc * k, DEK * dek)
76 {
77   PKT_public_key *sk = NULL;
78   int rc;
79
80   rc = openpgp_pk_test_algo2 (k->pubkey_algo, PUBKEY_USAGE_ENC);
81   if (rc)
82     goto leave;
83
84   if ((k->keyid[0] || k->keyid[1]) && !opt.try_all_secrets)
85     {
86       sk = xmalloc_clear (sizeof *sk);
87       sk->pubkey_algo = k->pubkey_algo; /* We want a pubkey with this algo.  */
88       if (!(rc = get_seckey (sk, k->keyid)))
89         rc = get_it (k, dek, sk, k->keyid);
90     }
91   else if (opt.skip_hidden_recipients)
92     rc = gpg_error (GPG_ERR_NO_SECKEY);
93   else  /* Anonymous receiver: Try all available secret keys.  */
94     {
95       void *enum_context = NULL;
96       u32 keyid[2];
97
98       for (;;)
99         {
100           if (sk)
101             free_public_key (sk);
102           sk = xmalloc_clear (sizeof *sk);
103           rc = enum_secret_keys (&enum_context, sk);
104           if (rc)
105             {
106               rc = G10ERR_NO_SECKEY;
107               break;
108             }
109           if (sk->pubkey_algo != k->pubkey_algo)
110             continue;
111           if (!(sk->pubkey_usage & PUBKEY_USAGE_ENC))
112             continue;
113           keyid_from_pk (sk, keyid);
114           log_info (_("anonymous recipient; trying secret key %s ...\n"),
115                     keystr (keyid));
116
117           rc = get_it (k, dek, sk, keyid);
118           if (!rc)
119             {
120               log_info (_("okay, we are the anonymous recipient.\n"));
121               break;
122             }
123           else if (gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
124             break; /* Don't try any more secret keys.  */
125         }
126       enum_secret_keys (&enum_context, NULL);  /* free context */
127     }
128
129 leave:
130   if (sk)
131     free_public_key (sk);
132   return rc;
133 }
134
135
136 static gpg_error_t
137 get_it (PKT_pubkey_enc *enc, DEK *dek, PKT_public_key *sk, u32 *keyid)
138 {
139   gpg_error_t err;
140   byte *frame = NULL;
141   unsigned int n;
142   size_t nframe;
143   u16 csum, csum2;
144   int card = 0;
145   gcry_sexp_t s_data;
146   char *desc;
147   char *keygrip;
148
149   /* Get the keygrip.  */
150   err = hexkeygrip_from_pk (sk, &keygrip);
151   if (err)
152     goto leave;
153
154   /* Convert the data to an S-expression.  */
155   if (sk->pubkey_algo == GCRY_PK_ELG || sk->pubkey_algo == GCRY_PK_ELG_E)
156     {
157       if (!enc->data[0] || !enc->data[1])
158         err = gpg_error (GPG_ERR_BAD_MPI);
159       else
160         err = gcry_sexp_build (&s_data, NULL, "(enc-val(elg(a%m)(b%m)))", 
161                                enc->data[0], enc->data[1]);
162     }
163   else if (sk->pubkey_algo == GCRY_PK_RSA || sk->pubkey_algo == GCRY_PK_RSA_E)
164     {
165       if (!enc->data[0])
166         err = gpg_error (GPG_ERR_BAD_MPI);
167       else
168         err = gcry_sexp_build (&s_data, NULL, "(enc-val(rsa(a%m)))",
169                                enc->data[0]);
170     }
171   else
172     err = gpg_error (GPG_ERR_BUG);
173
174   if (err)
175     goto leave;
176
177   /* Decrypt. */
178   desc = gpg_format_keydesc (sk, 0, 1);
179   err = agent_pkdecrypt (NULL, keygrip, desc, s_data, &frame, &nframe);
180   xfree (desc);
181   gcry_sexp_release (s_data);
182   if (err)
183     goto leave;
184
185   /* Now get the DEK (data encryption key) from the frame
186    *
187    * Old versions encode the DEK in in this format (msb is left):
188    *
189    *     0  1  DEK(16 bytes)  CSUM(2 bytes)  0  RND(n bytes) 2
190    *
191    * Later versions encode the DEK like this:
192    *
193    *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
194    *
195    * (mpi_get_buffer already removed the leading zero).
196    *
197    * RND are non-zero randow bytes.
198    * A   is the cipher algorithm
199    * DEK is the encryption key (session key) with length k
200    * CSUM
201    */
202   if (DBG_CIPHER)
203     log_printhex ("DEK frame:", frame, nframe);
204   n = 0;
205   if (!card)
206     {
207       if (n + 7 > nframe)
208         {
209           err = gpg_error (G10ERR_WRONG_SECKEY);
210           goto leave;
211         }
212       if (frame[n] == 1 && frame[nframe - 1] == 2)
213         {
214           log_info (_("old encoding of the DEK is not supported\n"));
215           err = gpg_error (G10ERR_CIPHER_ALGO);
216           goto leave;
217         }
218       if (frame[n] != 2) /* Something went wrong.  */
219         {
220           err = gpg_error (G10ERR_WRONG_SECKEY);
221           goto leave;
222         }
223       for (n++; n < nframe && frame[n]; n++) /* Skip the random bytes.  */
224         ;
225       n++; /* Skip the zero byte.  */
226     }
227
228   if (n + 4 > nframe)
229     {
230       err = gpg_error (G10ERR_WRONG_SECKEY);
231       goto leave;
232     }
233
234   dek->keylen = nframe - (n + 1) - 2;
235   dek->algo = frame[n++];
236   if (dek->algo == CIPHER_ALGO_IDEA)
237     write_status (STATUS_RSA_OR_IDEA);
238   err = openpgp_cipher_test_algo (dek->algo);
239   if (err)
240     {
241       if (!opt.quiet && gpg_err_code (err) == GPG_ERR_CIPHER_ALGO)
242         {
243           log_info (_("cipher algorithm %d%s is unknown or disabled\n"),
244                     dek->algo,
245                     dek->algo == CIPHER_ALGO_IDEA ? " (IDEA)" : "");
246           if (dek->algo == CIPHER_ALGO_IDEA)
247             idea_cipher_warn (0);
248         }
249       dek->algo = 0;
250       goto leave;
251     }
252   if (dek->keylen != openpgp_cipher_get_algo_keylen (dek->algo))
253     {
254       err = gpg_error (GPG_ERR_WRONG_SECKEY);
255       goto leave;
256     }
257
258   /* Copy the key to DEK and compare the checksum.  */
259   csum = frame[nframe - 2] << 8;
260   csum |= frame[nframe - 1];
261   memcpy (dek->key, frame + n, dek->keylen);
262   for (csum2 = 0, n = 0; n < dek->keylen; n++)
263     csum2 += dek->key[n];
264   if (csum != csum2)
265     {
266       err = gpg_error (GPG_ERR_WRONG_SECKEY);
267       goto leave;
268     }
269   if (DBG_CIPHER)
270     log_printhex ("DEK is:", dek->key, dek->keylen);
271
272   /* Check that the algo is in the preferences and whether it has expired.  */
273   {
274     PKT_public_key *pk = NULL;
275     KBNODE pkb = get_pubkeyblock (keyid);
276
277     if (!pkb)
278       {
279         err = -1;
280         log_error ("oops: public key not found for preference check\n");
281       }
282     else if (pkb->pkt->pkt.public_key->selfsigversion > 3
283              && dek->algo != CIPHER_ALGO_3DES
284              && !opt.quiet
285              && !is_algo_in_prefs (pkb, PREFTYPE_SYM, dek->algo))
286       log_info (_("WARNING: cipher algorithm %s not found in recipient"
287                   " preferences\n"), openpgp_cipher_algo_name (dek->algo));
288     if (!err)
289       {
290         KBNODE k;
291
292         for (k = pkb; k; k = k->next)
293           {
294             if (k->pkt->pkttype == PKT_PUBLIC_KEY
295                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
296               {
297                 u32 aki[2];
298                 keyid_from_pk (k->pkt->pkt.public_key, aki);
299
300                 if (aki[0] == keyid[0] && aki[1] == keyid[1])
301                   {
302                     pk = k->pkt->pkt.public_key;
303                     break;
304                   }
305               }
306           }
307         if (!pk)
308           BUG ();
309         if (pk->expiredate && pk->expiredate <= make_timestamp ())
310           {
311             log_info (_("NOTE: secret key %s expired at %s\n"),
312                       keystr (keyid), asctimestamp (pk->expiredate));
313           }
314       }
315
316     if (pk && pk->is_revoked)
317       {
318         log_info (_("NOTE: key has been revoked"));
319         log_printf ("\n");
320         show_revocation_reason (pk, 1);
321       }
322
323     release_kbnode (pkb);
324     err = 0;
325   }
326
327  leave:
328   xfree (frame);
329   xfree (keygrip);
330   return err;
331 }
332
333
334 /*
335  * Get the session key from the given string.
336  * String is supposed to be formatted as this:
337  *  <algo-id>:<even-number-of-hex-digits>
338  */
339 gpg_error_t
340 get_override_session_key (DEK *dek, const char *string)
341 {
342   const char *s;
343   int i;
344
345   if (!string)
346     return G10ERR_BAD_KEY;
347   dek->algo = atoi (string);
348   if (dek->algo < 1)
349     return G10ERR_BAD_KEY;
350   if (!(s = strchr (string, ':')))
351     return G10ERR_BAD_KEY;
352   s++;
353   for (i = 0; i < DIM (dek->key) && *s; i++, s += 2)
354     {
355       int c = hextobyte (s);
356       if (c == -1)
357         return G10ERR_BAD_KEY;
358       dek->key[i] = c;
359     }
360   if (*s)
361     return G10ERR_BAD_KEY;
362   dek->keylen = i;
363   return 0;
364 }