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