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