gpg: Add pinentry-mode feature.
[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           free_public_key (sk);
101           sk = xmalloc_clear (sizeof *sk);
102           rc = enum_secret_keys (&enum_context, sk);
103           if (rc)
104             {
105               rc = G10ERR_NO_SECKEY;
106               break;
107             }
108           if (sk->pubkey_algo != k->pubkey_algo)
109             continue;
110           if (!(sk->pubkey_usage & PUBKEY_USAGE_ENC))
111             continue;
112           keyid_from_pk (sk, keyid);
113           if (!opt.quiet)
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               if (!opt.quiet)
121                 log_info (_("okay, we are the anonymous recipient.\n"));
122               break;
123             }
124           else if (gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
125             break; /* Don't try any more secret keys.  */
126         }
127       enum_secret_keys (&enum_context, NULL);  /* free context */
128     }
129
130 leave:
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   byte fp[MAX_FINGERPRINT_LEN];
149   size_t fpn;
150   const int pkalgo = map_pk_openpgp_to_gcry (sk->pubkey_algo);
151
152   /* Get the keygrip.  */
153   err = hexkeygrip_from_pk (sk, &keygrip);
154   if (err)
155     goto leave;
156
157   /* Convert the data to an S-expression.  */
158   if (pkalgo == GCRY_PK_ELG || pkalgo == GCRY_PK_ELG_E)
159     {
160       if (!enc->data[0] || !enc->data[1])
161         err = gpg_error (GPG_ERR_BAD_MPI);
162       else
163         err = gcry_sexp_build (&s_data, NULL, "(enc-val(elg(a%m)(b%m)))",
164                                enc->data[0], enc->data[1]);
165     }
166   else if (pkalgo == GCRY_PK_RSA || pkalgo == GCRY_PK_RSA_E)
167     {
168       if (!enc->data[0])
169         err = gpg_error (GPG_ERR_BAD_MPI);
170       else
171         err = gcry_sexp_build (&s_data, NULL, "(enc-val(rsa(a%m)))",
172                                enc->data[0]);
173     }
174   else if (pkalgo == GCRY_PK_ECDH)
175     {
176       if (!enc->data[0] || !enc->data[1])
177         err = gpg_error (GPG_ERR_BAD_MPI);
178       else
179         err = gcry_sexp_build (&s_data, NULL, "(enc-val(ecdh(s%m)(e%m)))",
180                                enc->data[0], enc->data[1]);
181     }
182   else
183     err = gpg_error (GPG_ERR_BUG);
184
185   if (err)
186     goto leave;
187
188   if (sk->pubkey_algo == PUBKEY_ALGO_ECDH)
189     {
190       fingerprint_from_pk (sk, fp, &fpn);
191       assert (fpn == 20);
192     }
193
194   /* Decrypt. */
195   desc = gpg_format_keydesc (sk, 0, 1);
196   err = agent_pkdecrypt (NULL, keygrip,
197                          desc, sk->keyid, sk->main_keyid, sk->pubkey_algo,
198                          s_data, &frame, &nframe);
199   xfree (desc);
200   gcry_sexp_release (s_data);
201   if (err)
202     goto leave;
203
204   /* Now get the DEK (data encryption key) from the frame
205    *
206    * Old versions encode the DEK in in this format (msb is left):
207    *
208    *     0  1  DEK(16 bytes)  CSUM(2 bytes)  0  RND(n bytes) 2
209    *
210    * Later versions encode the DEK like this:
211    *
212    *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
213    *
214    * (mpi_get_buffer already removed the leading zero).
215    *
216    * RND are non-zero randow bytes.
217    * A   is the cipher algorithm
218    * DEK is the encryption key (session key) with length k
219    * CSUM
220    */
221   if (DBG_CIPHER)
222     log_printhex ("DEK frame:", frame, nframe);
223   n = 0;
224
225   if (sk->pubkey_algo == PUBKEY_ALGO_ECDH)
226     {
227       gcry_mpi_t shared_mpi;
228       gcry_mpi_t decoded;
229
230       /* At the beginning the frame are the bytes of shared point MPI.  */
231       err = gcry_mpi_scan (&shared_mpi, GCRYMPI_FMT_USG, frame, nframe, NULL);
232       if (err)
233         {
234           err = gpg_error (GPG_ERR_WRONG_SECKEY);
235           goto leave;
236         }
237
238       err = pk_ecdh_decrypt (&decoded, fp, enc->data[1]/*encr data as an MPI*/,
239                              shared_mpi, sk->pkey);
240       mpi_release (shared_mpi);
241       if(err)
242         goto leave;
243
244       /* Reuse NFRAME, which size is sufficient to include the session key.  */
245       err = gcry_mpi_print (GCRYMPI_FMT_USG, frame, nframe, &nframe, decoded);
246       mpi_release (decoded);
247       if (err)
248         goto leave;
249
250       /* Now the frame are the bytes decrypted but padded session key.  */
251
252       /* Allow double padding for the benefit of DEK size concealment.
253          Higher than this is wasteful. */
254       if (!nframe || frame[nframe-1] > 8*2 || nframe <= 8
255           || frame[nframe-1] > nframe)
256         {
257           err = gpg_error (GPG_ERR_WRONG_SECKEY);
258           goto leave;
259         }
260       nframe -= frame[nframe-1]; /* Remove padding.  */
261       assert (!n); /* (used just below) */
262     }
263   else
264     {
265       if (!card)
266         {
267           if (n + 7 > nframe)
268             {
269               err = gpg_error (GPG_ERR_WRONG_SECKEY);
270               goto leave;
271             }
272           if (frame[n] == 1 && frame[nframe - 1] == 2)
273             {
274               log_info (_("old encoding of the DEK is not supported\n"));
275               err = gpg_error (GPG_ERR_CIPHER_ALGO);
276               goto leave;
277             }
278           if (frame[n] != 2) /* Something went wrong.  */
279             {
280               err = gpg_error (GPG_ERR_WRONG_SECKEY);
281               goto leave;
282             }
283           for (n++; n < nframe && frame[n]; n++) /* Skip the random bytes.  */
284             ;
285           n++; /* Skip the zero byte.  */
286         }
287     }
288
289   if (n + 4 > nframe)
290     {
291       err = gpg_error (GPG_ERR_WRONG_SECKEY);
292       goto leave;
293     }
294
295   dek->keylen = nframe - (n + 1) - 2;
296   dek->algo = frame[n++];
297   err = openpgp_cipher_test_algo (dek->algo);
298   if (err)
299     {
300       if (!opt.quiet && gpg_err_code (err) == GPG_ERR_CIPHER_ALGO)
301         {
302           log_info (_("cipher algorithm %d%s is unknown or disabled\n"),
303                     dek->algo,
304                     dek->algo == CIPHER_ALGO_IDEA ? " (IDEA)" : "");
305         }
306       dek->algo = 0;
307       goto leave;
308     }
309   if (dek->keylen != openpgp_cipher_get_algo_keylen (dek->algo))
310     {
311       err = gpg_error (GPG_ERR_WRONG_SECKEY);
312       goto leave;
313     }
314
315   /* Copy the key to DEK and compare the checksum.  */
316   csum = frame[nframe - 2] << 8;
317   csum |= frame[nframe - 1];
318   memcpy (dek->key, frame + n, dek->keylen);
319   for (csum2 = 0, n = 0; n < dek->keylen; n++)
320     csum2 += dek->key[n];
321   if (csum != csum2)
322     {
323       err = gpg_error (GPG_ERR_WRONG_SECKEY);
324       goto leave;
325     }
326   if (DBG_CIPHER)
327     log_printhex ("DEK is:", dek->key, dek->keylen);
328
329   /* Check that the algo is in the preferences and whether it has expired.  */
330   {
331     PKT_public_key *pk = NULL;
332     KBNODE pkb = get_pubkeyblock (keyid);
333
334     if (!pkb)
335       {
336         err = -1;
337         log_error ("oops: public key not found for preference check\n");
338       }
339     else if (pkb->pkt->pkt.public_key->selfsigversion > 3
340              && dek->algo != CIPHER_ALGO_3DES
341              && !opt.quiet
342              && !is_algo_in_prefs (pkb, PREFTYPE_SYM, dek->algo))
343       log_info (_("WARNING: cipher algorithm %s not found in recipient"
344                   " preferences\n"), openpgp_cipher_algo_name (dek->algo));
345     if (!err)
346       {
347         KBNODE k;
348
349         for (k = pkb; k; k = k->next)
350           {
351             if (k->pkt->pkttype == PKT_PUBLIC_KEY
352                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
353               {
354                 u32 aki[2];
355                 keyid_from_pk (k->pkt->pkt.public_key, aki);
356
357                 if (aki[0] == keyid[0] && aki[1] == keyid[1])
358                   {
359                     pk = k->pkt->pkt.public_key;
360                     break;
361                   }
362               }
363           }
364         if (!pk)
365           BUG ();
366         if (pk->expiredate && pk->expiredate <= make_timestamp ())
367           {
368             log_info (_("NOTE: secret key %s expired at %s\n"),
369                       keystr (keyid), asctimestamp (pk->expiredate));
370           }
371       }
372
373     if (pk && pk->flags.revoked)
374       {
375         log_info (_("NOTE: key has been revoked"));
376         log_printf ("\n");
377         show_revocation_reason (pk, 1);
378       }
379
380     release_kbnode (pkb);
381     err = 0;
382   }
383
384  leave:
385   xfree (frame);
386   xfree (keygrip);
387   return err;
388 }
389
390
391 /*
392  * Get the session key from the given string.
393  * String is supposed to be formatted as this:
394  *  <algo-id>:<even-number-of-hex-digits>
395  */
396 gpg_error_t
397 get_override_session_key (DEK *dek, const char *string)
398 {
399   const char *s;
400   int i;
401
402   if (!string)
403     return G10ERR_BAD_KEY;
404   dek->algo = atoi (string);
405   if (dek->algo < 1)
406     return G10ERR_BAD_KEY;
407   if (!(s = strchr (string, ':')))
408     return G10ERR_BAD_KEY;
409   s++;
410   for (i = 0; i < DIM (dek->key) && *s; i++, s += 2)
411     {
412       int c = hextobyte (s);
413       if (c == -1)
414         return G10ERR_BAD_KEY;
415       dek->key[i] = c;
416     }
417   if (*s)
418     return G10ERR_BAD_KEY;
419   dek->keylen = i;
420   return 0;
421 }