gpg,gpgsm: Fix compliance check for DSA and avoid an assert.
[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 <https://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 #include "gpg.h"
27 #include "../common/util.h"
28 #include "packet.h"
29 #include "keydb.h"
30 #include "trustdb.h"
31 #include "../common/status.h"
32 #include "options.h"
33 #include "main.h"
34 #include "../common/i18n.h"
35 #include "pkglue.h"
36 #include "call-agent.h"
37 #include "../common/host2net.h"
38 #include "../common/compliance.h"
39
40
41 static gpg_error_t get_it (ctrl_t ctrl, 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->flags.revoked && !uid->flags.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 (ctrl_t ctrl, PKT_pubkey_enc * k, DEK * dek)
76 {
77   PKT_public_key *sk = NULL;
78   int rc;
79
80   if (DBG_CLOCK)
81     log_clock ("get_session_key enter");
82
83   rc = openpgp_pk_test_algo2 (k->pubkey_algo, PUBKEY_USAGE_ENC);
84   if (rc)
85     goto leave;
86
87   if ((k->keyid[0] || k->keyid[1]) && !opt.try_all_secrets)
88     {
89       sk = xmalloc_clear (sizeof *sk);
90       sk->pubkey_algo = k->pubkey_algo; /* We want a pubkey with this algo.  */
91       if (!(rc = get_seckey (ctrl, sk, k->keyid)))
92         {
93           /* Check compliance.  */
94           if (! gnupg_pk_is_allowed (opt.compliance, PK_USE_DECRYPTION,
95                                      sk->pubkey_algo,
96                                      sk->pkey, nbits_from_pk (sk), NULL))
97             {
98               log_info ("key %s not suitable for decryption while in %s mode\n",
99                         keystr_from_pk (sk), gnupg_compliance_option_string (opt.compliance));
100               free_public_key (sk);
101               return gpg_error (GPG_ERR_PUBKEY_ALGO);
102             }
103
104           rc = get_it (ctrl, k, dek, sk, k->keyid);
105         }
106     }
107   else if (opt.skip_hidden_recipients)
108     rc = gpg_error (GPG_ERR_NO_SECKEY);
109   else  /* Anonymous receiver: Try all available secret keys.  */
110     {
111       void *enum_context = NULL;
112       u32 keyid[2];
113
114       for (;;)
115         {
116           free_public_key (sk);
117           sk = xmalloc_clear (sizeof *sk);
118           rc = enum_secret_keys (ctrl, &enum_context, sk);
119           if (rc)
120             {
121               rc = GPG_ERR_NO_SECKEY;
122               break;
123             }
124           if (sk->pubkey_algo != k->pubkey_algo)
125             continue;
126           if (!(sk->pubkey_usage & PUBKEY_USAGE_ENC))
127             continue;
128           keyid_from_pk (sk, keyid);
129           if (!opt.quiet)
130             log_info (_("anonymous recipient; trying secret key %s ...\n"),
131                       keystr (keyid));
132
133           /* Check compliance.  */
134           if (! gnupg_pk_is_allowed (opt.compliance, PK_USE_DECRYPTION,
135                                      sk->pubkey_algo,
136                                      sk->pkey, nbits_from_pk (sk), NULL))
137             {
138               log_info ("key %s not suitable for decryption while in %s mode\n",
139                         keystr_from_pk (sk), gnupg_compliance_option_string (opt.compliance));
140               continue;
141             }
142
143           rc = get_it (ctrl, k, dek, sk, keyid);
144           if (!rc)
145             {
146               if (!opt.quiet)
147                 log_info (_("okay, we are the anonymous recipient.\n"));
148               break;
149             }
150           else if (gpg_err_code (rc) == GPG_ERR_FULLY_CANCELED)
151             break; /* Don't try any more secret keys.  */
152         }
153       enum_secret_keys (ctrl, &enum_context, NULL);  /* free context */
154     }
155
156 leave:
157   free_public_key (sk);
158   if (DBG_CLOCK)
159     log_clock ("get_session_key leave");
160   return rc;
161 }
162
163
164 static gpg_error_t
165 get_it (ctrl_t ctrl,
166         PKT_pubkey_enc *enc, DEK *dek, PKT_public_key *sk, u32 *keyid)
167 {
168   gpg_error_t err;
169   byte *frame = NULL;
170   unsigned int n;
171   size_t nframe;
172   u16 csum, csum2;
173   int padding;
174   gcry_sexp_t s_data;
175   char *desc;
176   char *keygrip;
177   byte fp[MAX_FINGERPRINT_LEN];
178   size_t fpn;
179
180   if (DBG_CLOCK)
181     log_clock ("decryption start");
182
183   /* Get the keygrip.  */
184   err = hexkeygrip_from_pk (sk, &keygrip);
185   if (err)
186     goto leave;
187
188   /* Convert the data to an S-expression.  */
189   if (sk->pubkey_algo == PUBKEY_ALGO_ELGAMAL
190       || sk->pubkey_algo == PUBKEY_ALGO_ELGAMAL_E)
191     {
192       if (!enc->data[0] || !enc->data[1])
193         err = gpg_error (GPG_ERR_BAD_MPI);
194       else
195         err = gcry_sexp_build (&s_data, NULL, "(enc-val(elg(a%m)(b%m)))",
196                                enc->data[0], enc->data[1]);
197     }
198   else if (sk->pubkey_algo == PUBKEY_ALGO_RSA
199            || sk->pubkey_algo == PUBKEY_ALGO_RSA_E)
200     {
201       if (!enc->data[0])
202         err = gpg_error (GPG_ERR_BAD_MPI);
203       else
204         err = gcry_sexp_build (&s_data, NULL, "(enc-val(rsa(a%m)))",
205                                enc->data[0]);
206     }
207   else if (sk->pubkey_algo == PUBKEY_ALGO_ECDH)
208     {
209       if (!enc->data[0] || !enc->data[1])
210         err = gpg_error (GPG_ERR_BAD_MPI);
211       else
212         err = gcry_sexp_build (&s_data, NULL, "(enc-val(ecdh(s%m)(e%m)))",
213                                enc->data[1], enc->data[0]);
214     }
215   else
216     err = gpg_error (GPG_ERR_BUG);
217
218   if (err)
219     goto leave;
220
221   if (sk->pubkey_algo == PUBKEY_ALGO_ECDH)
222     {
223       fingerprint_from_pk (sk, fp, &fpn);
224       log_assert (fpn == 20);
225     }
226
227   /* Decrypt. */
228   desc = gpg_format_keydesc (ctrl, sk, FORMAT_KEYDESC_NORMAL, 1);
229   err = agent_pkdecrypt (NULL, keygrip,
230                          desc, sk->keyid, sk->main_keyid, sk->pubkey_algo,
231                          s_data, &frame, &nframe, &padding);
232   xfree (desc);
233   gcry_sexp_release (s_data);
234   if (err)
235     goto leave;
236
237   /* Now get the DEK (data encryption key) from the frame
238    *
239    * Old versions encode the DEK in this format (msb is left):
240    *
241    *     0  1  DEK(16 bytes)  CSUM(2 bytes)  0  RND(n bytes) 2
242    *
243    * Later versions encode the DEK like this:
244    *
245    *     0  2  RND(n bytes)  0  A  DEK(k bytes)  CSUM(2 bytes)
246    *
247    * (mpi_get_buffer already removed the leading zero).
248    *
249    * RND are non-zero randow bytes.
250    * A   is the cipher algorithm
251    * DEK is the encryption key (session key) with length k
252    * CSUM
253    */
254   if (DBG_CRYPTO)
255     log_printhex ("DEK frame:", frame, nframe);
256   n = 0;
257
258   if (sk->pubkey_algo == PUBKEY_ALGO_ECDH)
259     {
260       gcry_mpi_t shared_mpi;
261       gcry_mpi_t decoded;
262
263       /* At the beginning the frame are the bytes of shared point MPI.  */
264       err = gcry_mpi_scan (&shared_mpi, GCRYMPI_FMT_USG, frame, nframe, NULL);
265       if (err)
266         {
267           err = gpg_error (GPG_ERR_WRONG_SECKEY);
268           goto leave;
269         }
270
271       err = pk_ecdh_decrypt (&decoded, fp, enc->data[1]/*encr data as an MPI*/,
272                              shared_mpi, sk->pkey);
273       mpi_release (shared_mpi);
274       if(err)
275         goto leave;
276
277       xfree (frame);
278       err = gcry_mpi_aprint (GCRYMPI_FMT_USG, &frame, &nframe, decoded);
279       mpi_release (decoded);
280       if (err)
281         goto leave;
282
283       /* Now the frame are the bytes decrypted but padded session key.  */
284
285       /* Allow double padding for the benefit of DEK size concealment.
286          Higher than this is wasteful. */
287       if (!nframe || frame[nframe-1] > 8*2 || nframe <= 8
288           || frame[nframe-1] > nframe)
289         {
290           err = gpg_error (GPG_ERR_WRONG_SECKEY);
291           goto leave;
292         }
293       nframe -= frame[nframe-1]; /* Remove padding.  */
294       log_assert (!n); /* (used just below) */
295     }
296   else
297     {
298       if (padding)
299         {
300           if (n + 7 > nframe)
301             {
302               err = gpg_error (GPG_ERR_WRONG_SECKEY);
303               goto leave;
304             }
305           if (frame[n] == 1 && frame[nframe - 1] == 2)
306             {
307               log_info (_("old encoding of the DEK is not supported\n"));
308               err = gpg_error (GPG_ERR_CIPHER_ALGO);
309               goto leave;
310             }
311           if (frame[n] != 2) /* Something went wrong.  */
312             {
313               err = gpg_error (GPG_ERR_WRONG_SECKEY);
314               goto leave;
315             }
316           for (n++; n < nframe && frame[n]; n++) /* Skip the random bytes.  */
317             ;
318           n++; /* Skip the zero byte.  */
319         }
320     }
321
322   if (n + 4 > nframe)
323     {
324       err = gpg_error (GPG_ERR_WRONG_SECKEY);
325       goto leave;
326     }
327
328   dek->keylen = nframe - (n + 1) - 2;
329   dek->algo = frame[n++];
330   err = openpgp_cipher_test_algo (dek->algo);
331   if (err)
332     {
333       if (!opt.quiet && gpg_err_code (err) == GPG_ERR_CIPHER_ALGO)
334         {
335           log_info (_("cipher algorithm %d%s is unknown or disabled\n"),
336                     dek->algo,
337                     dek->algo == CIPHER_ALGO_IDEA ? " (IDEA)" : "");
338         }
339       dek->algo = 0;
340       goto leave;
341     }
342   if (dek->keylen != openpgp_cipher_get_algo_keylen (dek->algo))
343     {
344       err = gpg_error (GPG_ERR_WRONG_SECKEY);
345       goto leave;
346     }
347
348   /* Copy the key to DEK and compare the checksum.  */
349   csum = buf16_to_u16 (frame+nframe-2);
350   memcpy (dek->key, frame + n, dek->keylen);
351   for (csum2 = 0, n = 0; n < dek->keylen; n++)
352     csum2 += dek->key[n];
353   if (csum != csum2)
354     {
355       err = gpg_error (GPG_ERR_WRONG_SECKEY);
356       goto leave;
357     }
358   if (DBG_CLOCK)
359     log_clock ("decryption ready");
360   if (DBG_CRYPTO)
361     log_printhex ("DEK is:", dek->key, dek->keylen);
362
363   /* Check that the algo is in the preferences and whether it has
364    * expired.  Also print a status line with the key's fingerprint.  */
365   {
366     PKT_public_key *pk = NULL;
367     PKT_public_key *mainpk = NULL;
368     KBNODE pkb = get_pubkeyblock (ctrl, keyid);
369
370     if (!pkb)
371       {
372         err = -1;
373         log_error ("oops: public key not found for preference check\n");
374       }
375     else if (pkb->pkt->pkt.public_key->selfsigversion > 3
376              && dek->algo != CIPHER_ALGO_3DES
377              && !opt.quiet
378              && !is_algo_in_prefs (pkb, PREFTYPE_SYM, dek->algo))
379       log_info (_("WARNING: cipher algorithm %s not found in recipient"
380                   " preferences\n"), openpgp_cipher_algo_name (dek->algo));
381
382     if (!err)
383       {
384         kbnode_t k;
385         int first = 1;
386
387         for (k = pkb; k; k = k->next)
388           {
389             if (k->pkt->pkttype == PKT_PUBLIC_KEY
390                 || k->pkt->pkttype == PKT_PUBLIC_SUBKEY)
391               {
392                 u32 aki[2];
393
394                 if (first)
395                   {
396                     first = 0;
397                     mainpk = k->pkt->pkt.public_key;
398                   }
399
400                 keyid_from_pk (k->pkt->pkt.public_key, aki);
401                 if (aki[0] == keyid[0] && aki[1] == keyid[1])
402                   {
403                     pk = k->pkt->pkt.public_key;
404                     break;
405                   }
406               }
407           }
408         if (!pk)
409           BUG ();
410         if (pk->expiredate && pk->expiredate <= make_timestamp ())
411           {
412             log_info (_("Note: secret key %s expired at %s\n"),
413                       keystr (keyid), asctimestamp (pk->expiredate));
414           }
415       }
416
417     if (pk && pk->flags.revoked)
418       {
419         log_info (_("Note: key has been revoked"));
420         log_printf ("\n");
421         show_revocation_reason (ctrl, pk, 1);
422       }
423
424     if (is_status_enabled () && pk && mainpk)
425       {
426         char pkhex[MAX_FINGERPRINT_LEN*2+1];
427         char mainpkhex[MAX_FINGERPRINT_LEN*2+1];
428
429         hexfingerprint (pk, pkhex, sizeof pkhex);
430         hexfingerprint (mainpk, mainpkhex, sizeof mainpkhex);
431
432         /* Note that we do not want to create a trustdb just for
433          * getting the ownertrust: If there is no trustdb there can't
434          * be ulitmately trusted key anyway and thus the ownertrust
435          * value is irrelevant.  */
436         write_status_printf (STATUS_DECRYPTION_KEY, "%s %s %c",
437                              pkhex, mainpkhex,
438                              get_ownertrust_info (ctrl, mainpk, 1));
439
440       }
441
442     release_kbnode (pkb);
443     err = 0;
444   }
445
446  leave:
447   xfree (frame);
448   xfree (keygrip);
449   return err;
450 }
451
452
453 /*
454  * Get the session key from the given string.
455  * String is supposed to be formatted as this:
456  *  <algo-id>:<even-number-of-hex-digits>
457  */
458 gpg_error_t
459 get_override_session_key (DEK *dek, const char *string)
460 {
461   const char *s;
462   int i;
463
464   if (!string)
465     return GPG_ERR_BAD_KEY;
466   dek->algo = atoi (string);
467   if (dek->algo < 1)
468     return GPG_ERR_BAD_KEY;
469   if (!(s = strchr (string, ':')))
470     return GPG_ERR_BAD_KEY;
471   s++;
472   for (i = 0; i < DIM (dek->key) && *s; i++, s += 2)
473     {
474       int c = hextobyte (s);
475       if (c == -1)
476         return GPG_ERR_BAD_KEY;
477       dek->key[i] = c;
478     }
479   if (*s)
480     return GPG_ERR_BAD_KEY;
481   dek->keylen = i;
482   return 0;
483 }