gpg: Extra check for sign usage when verifying a data signature.
[gnupg.git] / g10 / sig-check.c
1 /* sig-check.c -  Check a signature
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004, 2006 Free Software Foundation, Inc.
4  * Copyright (C) 2015, 2016 g10 Code GmbH
5  *
6  * This file is part of GnuPG.
7  *
8  * GnuPG is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * GnuPG is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, see <https://www.gnu.org/licenses/>.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26
27 #include "gpg.h"
28 #include "../common/util.h"
29 #include "packet.h"
30 #include "keydb.h"
31 #include "main.h"
32 #include "../common/status.h"
33 #include "../common/i18n.h"
34 #include "options.h"
35 #include "pkglue.h"
36 #include "../common/compliance.h"
37
38 static int check_signature_end (PKT_public_key *pk, PKT_signature *sig,
39                                 gcry_md_hd_t digest,
40                                 int *r_expired, int *r_revoked,
41                                 PKT_public_key *ret_pk);
42
43 static int check_signature_end_simple (PKT_public_key *pk, PKT_signature *sig,
44                                        gcry_md_hd_t digest);
45
46
47 /* Statistics for signature verification.  */
48 struct
49 {
50   unsigned int total;  /* Total number of verifications.  */
51   unsigned int cached; /* Number of seen cache entries.  */
52   unsigned int goodsig;/* Number of good verifications from the cache.  */
53   unsigned int badsig; /* Number of bad verifications from the cache.  */
54 } cache_stats;
55
56
57 /* Dump verification stats.  */
58 void
59 sig_check_dump_stats (void)
60 {
61   log_info ("sig_cache: total=%u cached=%u good=%u bad=%u\n",
62             cache_stats.total, cache_stats.cached,
63             cache_stats.goodsig, cache_stats.badsig);
64 }
65
66
67 /* Check a signature.  This is shorthand for check_signature2 with
68    the unnamed arguments passed as NULL.  */
69 int
70 check_signature (ctrl_t ctrl, PKT_signature *sig, gcry_md_hd_t digest)
71 {
72   return check_signature2 (ctrl, sig, digest, NULL, NULL, NULL, NULL);
73 }
74
75
76 /* Check a signature.
77  *
78  * Looks up the public key that created the signature (SIG->KEYID)
79  * from the key db.  Makes sure that the signature is valid (it was
80  * not created prior to the key, the public key was created in the
81  * past, and the signature does not include any unsupported critical
82  * features), finishes computing the hash of the signature data, and
83  * checks that the signature verifies the digest.  If the key that
84  * generated the signature is a subkey, this function also verifies
85  * that there is a valid backsig from the subkey to the primary key.
86  * Finally, if status fd is enabled and the signature class is 0x00 or
87  * 0x01, then a STATUS_SIG_ID is emitted on the status fd.
88  *
89  * SIG is the signature to check.
90  *
91  * DIGEST contains a valid hash context that already includes the
92  * signed data.  This function adds the relevant meta-data from the
93  * signature packet to compute the final hash.  (See Section 5.2 of
94  * RFC 4880: "The concatenation of the data being signed and the
95  * signature data from the version number through the hashed subpacket
96  * data (inclusive) is hashed.")
97  *
98  * If R_EXPIREDATE is not NULL, R_EXPIREDATE is set to the key's
99  * expiry.
100  *
101  * If R_EXPIRED is not NULL, *R_EXPIRED is set to 1 if PK has expired
102  * (0 otherwise).  Note: PK being expired does not cause this function
103  * to fail.
104  *
105  * If R_REVOKED is not NULL, *R_REVOKED is set to 1 if PK has been
106  * revoked (0 otherwise).  Note: PK being revoked does not cause this
107  * function to fail.
108  *
109  * If R_PK is not NULL, the public key is stored at that address if it
110  * was found; other wise NULL is stored.
111  *
112  * Returns 0 on success.  An error code otherwise.  */
113 gpg_error_t
114 check_signature2 (ctrl_t ctrl,
115                   PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
116                   int *r_expired, int *r_revoked, PKT_public_key **r_pk)
117 {
118   int rc=0;
119   PKT_public_key *pk;
120
121   if (r_expiredate)
122     *r_expiredate = 0;
123   if (r_expired)
124     *r_expired = 0;
125   if (r_revoked)
126     *r_revoked = 0;
127   if (r_pk)
128     *r_pk = NULL;
129
130   pk = xtrycalloc (1, sizeof *pk);
131   if (!pk)
132     return gpg_error_from_syserror ();
133
134   if  ((rc=openpgp_md_test_algo(sig->digest_algo)))
135     {
136       /* We don't have this digest. */
137     }
138   else if (!gnupg_digest_is_allowed (opt.compliance, 0, sig->digest_algo))
139     {
140       /* Compliance failure.  */
141       log_info (_("digest algorithm '%s' may not be used in %s mode\n"),
142                 gcry_md_algo_name (sig->digest_algo),
143                 gnupg_compliance_option_string (opt.compliance));
144       rc = gpg_error (GPG_ERR_DIGEST_ALGO);
145     }
146   else if ((rc=openpgp_pk_test_algo(sig->pubkey_algo)))
147     {
148       /* We don't have this pubkey algo. */
149     }
150   else if (!gcry_md_is_enabled (digest,sig->digest_algo))
151     {
152       /* Sanity check that the md has a context for the hash that the
153        * sig is expecting.  This can happen if a onepass sig header
154        * does not match the actual sig, and also if the clearsign
155        * "Hash:" header is missing or does not match the actual sig. */
156       log_info(_("WARNING: signature digest conflict in message\n"));
157       rc = gpg_error (GPG_ERR_GENERAL);
158     }
159   else if (get_pubkey (ctrl, pk, sig->keyid))
160     rc = gpg_error (GPG_ERR_NO_PUBKEY);
161   else if (!gnupg_pk_is_allowed (opt.compliance, PK_USE_VERIFICATION,
162                                  pk->pubkey_algo, pk->pkey,
163                                  nbits_from_pk (pk),
164                                  NULL))
165     {
166       /* Compliance failure.  */
167       log_error (_("key %s may not be used for signing in %s mode\n"),
168                  keystr_from_pk (pk),
169                  gnupg_compliance_option_string (opt.compliance));
170       rc = gpg_error (GPG_ERR_PUBKEY_ALGO);
171     }
172   else if (!pk->flags.valid)
173     {
174       /* You cannot have a good sig from an invalid key.  */
175       rc = gpg_error (GPG_ERR_BAD_PUBKEY);
176     }
177   else
178     {
179       if (r_expiredate)
180         *r_expiredate = pk->expiredate;
181
182       rc = check_signature_end (pk, sig, digest, r_expired, r_revoked, NULL);
183
184       /* Check the backsig.  This is a back signature (0x19) from
185        * the subkey on the primary key.  The idea here is that it
186        * should not be possible for someone to "steal" subkeys and
187        * claim them as their own.  The attacker couldn't actually
188        * use the subkey, but they could try and claim ownership of
189        * any signatures issued by it.  */
190       if (!rc && !pk->flags.primary && pk->flags.backsig < 2)
191         {
192           if (!pk->flags.backsig)
193             {
194               log_info (_("WARNING: signing subkey %s is not"
195                           " cross-certified\n"),keystr_from_pk(pk));
196               log_info (_("please see %s for more information\n"),
197                         "https://gnupg.org/faq/subkey-cross-certify.html");
198               /* The default option --require-cross-certification
199                * makes this warning an error.  */
200               if (opt.flags.require_cross_cert)
201                 rc = gpg_error (GPG_ERR_GENERAL);
202             }
203           else if(pk->flags.backsig == 1)
204             {
205               log_info (_("WARNING: signing subkey %s has an invalid"
206                           " cross-certification\n"), keystr_from_pk(pk));
207               rc = gpg_error (GPG_ERR_GENERAL);
208             }
209         }
210
211     }
212
213   if (!rc && sig->sig_class < 2 && is_status_enabled ())
214     {
215       /* This signature id works best with DLP algorithms because
216        * they use a random parameter for every signature.  Instead of
217        * this sig-id we could have also used the hash of the document
218        * and the timestamp, but the drawback of this is, that it is
219        * not possible to sign more than one identical document within
220        * one second.    Some remote batch processing applications might
221        * like this feature here.
222        *
223        * Note that before 2.0.10, we used RIPE-MD160 for the hash
224        * and accidentally didn't include the timestamp and algorithm
225        * information in the hash.  Given that this feature is not
226        * commonly used and that a replay attacks detection should
227        * not solely be based on this feature (because it does not
228        * work with RSA), we take the freedom and switch to SHA-1
229        * with 2.0.10 to take advantage of hardware supported SHA-1
230        * implementations.  We also include the missing information
231        * in the hash.  Note also the SIG_ID as computed by gpg 1.x
232        * and gpg 2.x didn't matched either because 2.x used to print
233        * MPIs not in PGP format.  */
234       u32 a = sig->timestamp;
235       int nsig = pubkey_get_nsig (sig->pubkey_algo);
236       unsigned char *p, *buffer;
237       size_t n, nbytes;
238       int i;
239       char hashbuf[20];
240
241       nbytes = 6;
242       for (i=0; i < nsig; i++ )
243         {
244           if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, &n, sig->data[i]))
245             BUG();
246           nbytes += n;
247         }
248
249       /* Make buffer large enough to be later used as output buffer.  */
250       if (nbytes < 100)
251         nbytes = 100;
252       nbytes += 10;  /* Safety margin.  */
253
254       /* Fill and hash buffer.  */
255       buffer = p = xmalloc (nbytes);
256       *p++ = sig->pubkey_algo;
257       *p++ = sig->digest_algo;
258       *p++ = (a >> 24) & 0xff;
259       *p++ = (a >> 16) & 0xff;
260       *p++ = (a >>  8) & 0xff;
261       *p++ =  a & 0xff;
262       nbytes -= 6;
263       for (i=0; i < nsig; i++ )
264         {
265           if (gcry_mpi_print (GCRYMPI_FMT_PGP, p, nbytes, &n, sig->data[i]))
266             BUG();
267           p += n;
268           nbytes -= n;
269         }
270       gcry_md_hash_buffer (GCRY_MD_SHA1, hashbuf, buffer, p-buffer);
271
272       p = make_radix64_string (hashbuf, 20);
273       sprintf (buffer, "%s %s %lu",
274                p, strtimestamp (sig->timestamp), (ulong)sig->timestamp);
275       xfree (p);
276       write_status_text (STATUS_SIG_ID, buffer);
277       xfree (buffer);
278     }
279
280   if (r_pk)
281     *r_pk = pk;
282   else
283     {
284       release_public_key_parts (pk);
285       xfree (pk);
286     }
287
288   return rc;
289 }
290
291
292 /* The signature SIG was generated with the public key PK.  Check
293  * whether the signature is valid in the following sense:
294  *
295  *   - Make sure the public key was created before the signature was
296  *     generated.
297  *
298  *   - Make sure the public key was created in the past
299  *
300  *   - Check whether PK has expired (set *R_EXPIRED to 1 if so and 0
301  *     otherwise)
302  *
303  *   - Check whether PK has been revoked (set *R_REVOKED to 1 if so
304  *     and 0 otherwise).
305  *
306  * If either of the first two tests fail, returns an error code.
307  * Otherwise returns 0.  (Thus, this function doesn't fail if the
308  * public key is expired or revoked.)  */
309 static int
310 check_signature_metadata_validity (PKT_public_key *pk, PKT_signature *sig,
311                                    int *r_expired, int *r_revoked)
312 {
313   u32 cur_time;
314
315   if (r_expired)
316     *r_expired = 0;
317   if (r_revoked)
318     *r_revoked = 0;
319
320   if (pk->timestamp > sig->timestamp )
321     {
322       ulong d = pk->timestamp - sig->timestamp;
323       if ( d < 86400 )
324         {
325           log_info (ngettext
326                     ("public key %s is %lu second newer than the signature\n",
327                      "public key %s is %lu seconds newer than the signature\n",
328                      d), keystr_from_pk (pk), d);
329         }
330       else
331         {
332           d /= 86400;
333           log_info (ngettext
334                     ("public key %s is %lu day newer than the signature\n",
335                      "public key %s is %lu days newer than the signature\n",
336                      d), keystr_from_pk (pk), d);
337         }
338       if (!opt.ignore_time_conflict)
339         return GPG_ERR_TIME_CONFLICT; /* pubkey newer than signature.  */
340     }
341
342   cur_time = make_timestamp ();
343   if (pk->timestamp > cur_time)
344     {
345       ulong d = pk->timestamp - cur_time;
346       if (d < 86400)
347         {
348           log_info (ngettext("key %s was created %lu second"
349                              " in the future (time warp or clock problem)\n",
350                              "key %s was created %lu seconds"
351                              " in the future (time warp or clock problem)\n",
352                              d), keystr_from_pk (pk), d);
353         }
354       else
355         {
356           d /= 86400;
357           log_info (ngettext("key %s was created %lu day"
358                              " in the future (time warp or clock problem)\n",
359                              "key %s was created %lu days"
360                              " in the future (time warp or clock problem)\n",
361                              d), keystr_from_pk (pk), d);
362         }
363       if (!opt.ignore_time_conflict)
364         return GPG_ERR_TIME_CONFLICT;
365     }
366
367   /* Check whether the key has expired.  We check the has_expired
368    * flag which is set after a full evaluation of the key (getkey.c)
369    * as well as a simple compare to the current time in case the
370    * merge has for whatever reasons not been done.  */
371   if (pk->has_expired || (pk->expiredate && pk->expiredate < cur_time))
372     {
373       char buf[11];
374       if (opt.verbose)
375         log_info (_("Note: signature key %s expired %s\n"),
376                   keystr_from_pk(pk), asctimestamp( pk->expiredate ) );
377       snprintf (buf, sizeof buf, "%lu",(ulong)pk->expiredate);
378       write_status_text (STATUS_KEYEXPIRED, buf);
379       if (r_expired)
380         *r_expired = 1;
381     }
382
383   if (pk->flags.revoked)
384     {
385       if (opt.verbose)
386         log_info (_("Note: signature key %s has been revoked\n"),
387                   keystr_from_pk(pk));
388       if (r_revoked)
389         *r_revoked=1;
390     }
391
392   return 0;
393 }
394
395
396 /* Finish generating a signature and check it.  Concretely: make sure
397  * that the signature is valid (it was not created prior to the key,
398  * the public key was created in the past, and the signature does not
399  * include any unsupported critical features), finish computing the
400  * digest by adding the relevant data from the signature packet, and
401  * check that the signature verifies the digest.
402  *
403  * DIGEST contains a hash context, which has already hashed the signed
404  * data.  This function adds the relevant meta-data from the signature
405  * packet to compute the final hash.  (See Section 5.2 of RFC 4880:
406  * "The concatenation of the data being signed and the signature data
407  * from the version number through the hashed subpacket data
408  * (inclusive) is hashed.")
409  *
410  * SIG is the signature to check.
411  *
412  * PK is the public key used to generate the signature.
413  *
414  * If R_EXPIRED is not NULL, *R_EXPIRED is set to 1 if PK has expired
415  * (0 otherwise).  Note: PK being expired does not cause this function
416  * to fail.
417  *
418  * If R_REVOKED is not NULL, *R_REVOKED is set to 1 if PK has been
419  * revoked (0 otherwise).  Note: PK being revoked does not cause this
420  * function to fail.
421  *
422  * If RET_PK is not NULL, PK is copied into RET_PK on success.
423  *
424  * Returns 0 on success.  An error code other.  */
425 static int
426 check_signature_end (PKT_public_key *pk, PKT_signature *sig,
427                      gcry_md_hd_t digest,
428                      int *r_expired, int *r_revoked, PKT_public_key *ret_pk)
429 {
430   int rc = 0;
431
432   if ((rc = check_signature_metadata_validity (pk, sig,
433                                                r_expired, r_revoked)))
434     return rc;
435
436   if ((rc = check_signature_end_simple (pk, sig, digest)))
437     return rc;
438
439   if (!rc && ret_pk)
440     copy_public_key(ret_pk,pk);
441
442   return rc;
443 }
444
445
446 /* This function is similar to check_signature_end, but it only checks
447  * whether the signature was generated by PK.  It does not check
448  * expiration, revocation, etc.  */
449 static int
450 check_signature_end_simple (PKT_public_key *pk, PKT_signature *sig,
451                             gcry_md_hd_t digest)
452 {
453   gcry_mpi_t result = NULL;
454   int rc = 0;
455   const struct weakhash *weak;
456
457   if (!opt.flags.allow_weak_digest_algos)
458     {
459       for (weak = opt.weak_digests; weak; weak = weak->next)
460         if (sig->digest_algo == weak->algo)
461           {
462             print_digest_rejected_note(sig->digest_algo);
463             return GPG_ERR_DIGEST_ALGO;
464           }
465     }
466
467   /* For key signatures check that the key has a cert usage.  We may
468    * do this only for subkeys because the primary may always issue key
469    * signature.  The latter may not be reflected in the pubkey_usage
470    * field because we need to check the key signatures to extract the
471    * key usage.  */
472   if (!pk->flags.primary
473       && IS_CERT (sig) && !(pk->pubkey_usage & PUBKEY_USAGE_CERT))
474     {
475       rc = gpg_error (GPG_ERR_WRONG_KEY_USAGE);
476       if (!opt.quiet)
477         log_info (_("bad key signature from key %s: %s (0x%02x, 0x%x)\n"),
478                   keystr_from_pk (pk), gpg_strerror (rc),
479                   sig->sig_class, pk->pubkey_usage);
480       return rc;
481     }
482
483   /* For data signatures check that the key has sign usage.  */
484   if (IS_SIG (sig) && !(pk->pubkey_usage & PUBKEY_USAGE_SIG))
485     {
486       rc = gpg_error (GPG_ERR_WRONG_KEY_USAGE);
487       if (!opt.quiet)
488         log_info (_("bad data signature from key %s: %s (0x%02x, 0x%x)\n"),
489                   keystr_from_pk (pk), gpg_strerror (rc),
490                   sig->sig_class, pk->pubkey_usage);
491       return rc;
492     }
493
494   /* Make sure the digest algo is enabled (in case of a detached
495    * signature).  */
496   gcry_md_enable (digest, sig->digest_algo);
497
498   /* Complete the digest. */
499   if (sig->version >= 4)
500     gcry_md_putc (digest, sig->version);
501
502   gcry_md_putc( digest, sig->sig_class );
503   if (sig->version < 4)
504     {
505       u32 a = sig->timestamp;
506       gcry_md_putc (digest, ((a >> 24) & 0xff));
507       gcry_md_putc (digest, ((a >> 16) & 0xff));
508       gcry_md_putc (digest, ((a >>  8) & 0xff));
509       gcry_md_putc (digest, ( a        & 0xff));
510     }
511   else
512     {
513       byte buf[6];
514       size_t n;
515       gcry_md_putc (digest, sig->pubkey_algo);
516       gcry_md_putc (digest, sig->digest_algo);
517       if (sig->hashed)
518         {
519           n = sig->hashed->len;
520           gcry_md_putc (digest, (n >> 8) );
521           gcry_md_putc (digest,  n       );
522           gcry_md_write (digest, sig->hashed->data, n);
523           n += 6;
524         }
525       else
526         {
527           /* Two octets for the (empty) length of the hashed
528            * section. */
529           gcry_md_putc (digest, 0);
530           gcry_md_putc (digest, 0);
531           n = 6;
532         }
533       /* Add some magic per Section 5.2.4 of RFC 4880.  */
534       buf[0] = sig->version;
535       buf[1] = 0xff;
536       buf[2] = n >> 24;
537       buf[3] = n >> 16;
538       buf[4] = n >>  8;
539       buf[5] = n;
540       gcry_md_write( digest, buf, 6 );
541     }
542   gcry_md_final( digest );
543
544   /* Convert the digest to an MPI.  */
545   result = encode_md_value (pk, digest, sig->digest_algo );
546   if (!result)
547     return GPG_ERR_GENERAL;
548
549   /* Verify the signature.  */
550   rc = pk_verify (pk->pubkey_algo, result, sig->data, pk->pkey);
551   gcry_mpi_release (result);
552
553   if (!rc && sig->flags.unknown_critical)
554     {
555       log_info(_("assuming bad signature from key %s"
556                  " due to an unknown critical bit\n"),keystr_from_pk(pk));
557       rc = GPG_ERR_BAD_SIGNATURE;
558     }
559
560   return rc;
561 }
562
563
564 /* Add a uid node to a hash context.  See section 5.2.4, paragraph 4
565  * of RFC 4880.  */
566 static void
567 hash_uid_packet (PKT_user_id *uid, gcry_md_hd_t md, PKT_signature *sig )
568 {
569   if (uid->attrib_data)
570     {
571       if (sig->version >=4)
572         {
573           byte buf[5];
574           buf[0] = 0xd1;                   /* packet of type 17 */
575           buf[1] = uid->attrib_len >> 24;  /* always use 4 length bytes */
576           buf[2] = uid->attrib_len >> 16;
577           buf[3] = uid->attrib_len >>  8;
578           buf[4] = uid->attrib_len;
579           gcry_md_write( md, buf, 5 );
580         }
581       gcry_md_write( md, uid->attrib_data, uid->attrib_len );
582     }
583   else
584     {
585       if (sig->version >=4)
586         {
587           byte buf[5];
588           buf[0] = 0xb4;              /* indicates a userid packet */
589           buf[1] = uid->len >> 24;    /* always use 4 length bytes */
590           buf[2] = uid->len >> 16;
591           buf[3] = uid->len >>  8;
592           buf[4] = uid->len;
593           gcry_md_write( md, buf, 5 );
594         }
595       gcry_md_write( md, uid->name, uid->len );
596     }
597 }
598
599 static void
600 cache_sig_result ( PKT_signature *sig, int result )
601 {
602   if (!result)
603     {
604       sig->flags.checked = 1;
605       sig->flags.valid = 1;
606     }
607   else if  (gpg_err_code (result) == GPG_ERR_BAD_SIGNATURE)
608     {
609       sig->flags.checked = 1;
610       sig->flags.valid = 0;
611     }
612   else
613     {
614       sig->flags.checked = 0;
615       sig->flags.valid = 0;
616     }
617 }
618
619
620 /* SIG is a key revocation signature.  Check if this signature was
621  * generated by any of the public key PK's designated revokers.
622  *
623  *   PK is the public key that SIG allegedly revokes.
624  *
625  *   SIG is the revocation signature to check.
626  *
627  * This function avoids infinite recursion, which can happen if two
628  * keys are designed revokers for each other and they revoke each
629  * other.  This is done by observing that if a key A is revoked by key
630  * B we still consider the revocation to be valid even if B is
631  * revoked.  Thus, we don't need to determine whether B is revoked to
632  * determine whether A has been revoked by B, we just need to check
633  * the signature.
634  *
635  * Returns 0 if sig is valid (i.e. pk is revoked), non-0 if not
636  * revoked.  We are careful to make sure that GPG_ERR_NO_PUBKEY is
637  * only returned when a revocation signature is from a valid
638  * revocation key designated in a revkey subpacket, but the revocation
639  * key itself isn't present.
640  *
641  * XXX: This code will need to be modified if gpg ever becomes
642  * multi-threaded.  Note that this guarantees that a designated
643  * revocation sig will never be considered valid unless it is actually
644  * valid, as well as being issued by a revocation key in a valid
645  * direct signature.  Note also that this is written so that a revoked
646  * revoker can still issue revocations: i.e. If A revokes B, but A is
647  * revoked, B is still revoked.  I'm not completely convinced this is
648  * the proper behavior, but it matches how PGP does it. -dms */
649 int
650 check_revocation_keys (ctrl_t ctrl, PKT_public_key *pk, PKT_signature *sig)
651 {
652   static int busy=0;
653   int i;
654   int rc = GPG_ERR_GENERAL;
655
656   log_assert (IS_KEY_REV(sig));
657   log_assert ((sig->keyid[0]!=pk->keyid[0]) || (sig->keyid[0]!=pk->keyid[1]));
658
659   /* Avoid infinite recursion.  Consider the following:
660    *
661    *   - We want to check if A is revoked.
662    *
663    *   - C is a designated revoker for B and has revoked B.
664    *
665    *   - B is a designated revoker for A and has revoked A.
666    *
667    * When checking if A is revoked (in merge_selfsigs_main), we
668    * observe that A has a designed revoker.  As such, we call this
669    * function.  This function sees that there is a valid revocation
670    * signature, which is signed by B.  It then calls check_signature()
671    * to verify that the signature is good.  To check the sig, we need
672    * to lookup B.  Looking up B means calling merge_selfsigs_main,
673    * which checks whether B is revoked, which calls this function to
674    * see if B was revoked by some key.
675    *
676    * In this case, the added level of indirection doesn't hurt.  It
677    * just means a bit more work.  However, if C == A, then we'd end up
678    * in a loop.  But, it doesn't make sense to look up C anyways: even
679    * if B is revoked, we conservatively consider a valid revocation
680    * signed by B to revoke A.  Since this is the only place where this
681    * type of recursion can occur, we simply cause this function to
682    * fail if it is entered recursively.  */
683   if (busy)
684     {
685       /* Return an error (i.e. not revoked), but mark the pk as
686          uncacheable as we don't really know its revocation status
687          until it is checked directly.  */
688       pk->flags.dont_cache = 1;
689       return rc;
690     }
691
692   busy=1;
693
694   /*  es_printf("looking at %08lX with a sig from %08lX\n",(ulong)pk->keyid[1],
695       (ulong)sig->keyid[1]); */
696
697   /* is the issuer of the sig one of our revokers? */
698   if( !pk->revkey && pk->numrevkeys )
699      BUG();
700   else
701       for(i=0;i<pk->numrevkeys;i++)
702         {
703           /* The revoker's keyid.  */
704           u32 keyid[2];
705
706           keyid_from_fingerprint (ctrl, pk->revkey[i].fpr,
707                                   MAX_FINGERPRINT_LEN, keyid);
708
709           if(keyid[0]==sig->keyid[0] && keyid[1]==sig->keyid[1])
710             /* The signature was generated by a designated revoker.
711                Verify the signature.  */
712             {
713               gcry_md_hd_t md;
714
715               if (gcry_md_open (&md, sig->digest_algo, 0))
716                 BUG ();
717               hash_public_key(md,pk);
718               /* Note: check_signature only checks that the signature
719                  is good.  It does not fail if the key is revoked.  */
720               rc = check_signature (ctrl, sig, md);
721               cache_sig_result(sig,rc);
722               gcry_md_close (md);
723               break;
724             }
725         }
726
727   busy=0;
728
729   return rc;
730 }
731
732 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
733  * primary key MAIN_PK is valid.
734  *
735  * Backsigs (0x19) have the same format as binding sigs (0x18), but
736  * this function is simpler than check_key_signature in a few ways.
737  * For example, there is no support for expiring backsigs since it is
738  * questionable what such a thing actually means.  Note also that the
739  * sig cache check here, unlike other sig caches in GnuPG, is not
740  * persistent.  */
741 int
742 check_backsig (PKT_public_key *main_pk,PKT_public_key *sub_pk,
743                PKT_signature *backsig)
744 {
745   gcry_md_hd_t md;
746   int rc;
747
748   /* Always check whether the algorithm is available.  Although
749      gcry_md_open would throw an error, some libgcrypt versions will
750      print a debug message in that case too. */
751   if ((rc=openpgp_md_test_algo (backsig->digest_algo)))
752     return rc;
753
754   if(!opt.no_sig_cache && backsig->flags.checked)
755     return backsig->flags.valid? 0 : gpg_error (GPG_ERR_BAD_SIGNATURE);
756
757   rc = gcry_md_open (&md, backsig->digest_algo,0);
758   if (!rc)
759     {
760       hash_public_key(md,main_pk);
761       hash_public_key(md,sub_pk);
762       rc = check_signature_end (sub_pk, backsig, md, NULL, NULL, NULL);
763       cache_sig_result(backsig,rc);
764       gcry_md_close(md);
765     }
766
767   return rc;
768 }
769
770
771 /* Check that a signature over a key is valid.  This is a
772  * specialization of check_key_signature2 with the unnamed parameters
773  * passed as NULL.  See the documentation for that function for more
774  * details.  */
775 int
776 check_key_signature (ctrl_t ctrl, kbnode_t root, kbnode_t node,
777                      int *is_selfsig)
778 {
779   return check_key_signature2 (ctrl, root, node, NULL, NULL,
780                                is_selfsig, NULL, NULL);
781 }
782
783
784 /* Returns whether SIGNER generated the signature SIG over the packet
785  * PACKET, which is a key, subkey or uid, and comes from the key block
786  * KB.  (KB is PACKET's corresponding keyblock; we don't assume that
787  * SIG has been added to the keyblock.)
788  *
789  * If SIGNER is set, then checks whether SIGNER generated the
790  * signature.  Otherwise, uses SIG->KEYID to find the alleged signer.
791  * This parameter can be used to effectively override the alleged
792  * signer that is stored in SIG.
793  *
794  * KB may be NULL if SIGNER is set.
795  *
796  * Unlike check_key_signature, this function ignores any cached
797  * results!  That is, it does not consider SIG->FLAGS.CHECKED and
798  * SIG->FLAGS.VALID nor does it set them.
799  *
800  * This doesn't check the signature's semantic mean.  Concretely, it
801  * doesn't check whether a non-self signed revocation signature was
802  * created by a designated revoker.  In fact, it doesn't return an
803  * error for a binding generated by a completely different key!
804  *
805  * Returns 0 if the signature is valid.  Returns GPG_ERR_SIG_CLASS if
806  * this signature can't be over PACKET.  Returns GPG_ERR_NOT_FOUND if
807  * the key that generated the signature (according to SIG) could not
808  * be found.  Returns GPG_ERR_BAD_SIGNATURE if the signature is bad.
809  * Other errors codes may be returned if something else goes wrong.
810  *
811  * IF IS_SELFSIG is not NULL, sets *IS_SELFSIG to 1 if this is a
812  * self-signature (by the key's primary key) or 0 if not.
813  *
814  * If RET_PK is not NULL, returns a copy of the public key that
815  * generated the signature (i.e., the signer) on success.  This must
816  * be released by the caller using release_public_key_parts ().  */
817 gpg_error_t
818 check_signature_over_key_or_uid (ctrl_t ctrl, PKT_public_key *signer,
819                                  PKT_signature *sig, KBNODE kb, PACKET *packet,
820                                  int *is_selfsig, PKT_public_key *ret_pk)
821 {
822   int rc;
823   PKT_public_key *pripk = kb->pkt->pkt.public_key;
824   gcry_md_hd_t md;
825   int signer_alloced = 0;
826
827   rc = openpgp_pk_test_algo (sig->pubkey_algo);
828   if (rc)
829     return rc;
830   rc = openpgp_md_test_algo (sig->digest_algo);
831   if (rc)
832     return rc;
833
834   /* A signature's class indicates the type of packet that it
835      signs.  */
836   if (IS_BACK_SIG (sig) || IS_KEY_SIG (sig) || IS_KEY_REV (sig))
837     {
838       /* Key revocations can only be over primary keys.  */
839       if (packet->pkttype != PKT_PUBLIC_KEY)
840         return gpg_error (GPG_ERR_SIG_CLASS);
841     }
842   else if (IS_SUBKEY_SIG (sig) || IS_SUBKEY_REV (sig))
843     {
844       if (packet->pkttype != PKT_PUBLIC_SUBKEY)
845         return gpg_error (GPG_ERR_SIG_CLASS);
846     }
847   else if (IS_UID_SIG (sig) || IS_UID_REV (sig))
848     {
849       if (packet->pkttype != PKT_USER_ID)
850         return gpg_error (GPG_ERR_SIG_CLASS);
851     }
852   else
853     return gpg_error (GPG_ERR_SIG_CLASS);
854
855   /* PACKET is the right type for SIG.  */
856
857   if (signer)
858     {
859       if (is_selfsig)
860         {
861           if (signer->keyid[0] == pripk->keyid[0]
862               && signer->keyid[1] == pripk->keyid[1])
863             *is_selfsig = 1;
864           else
865             *is_selfsig = 0;
866         }
867     }
868   else
869     {
870       /* Get the signer.  If possible, avoid a look up.  */
871       if (sig->keyid[0] == pripk->keyid[0]
872           && sig->keyid[1] == pripk->keyid[1])
873         {
874           /* Issued by the primary key.  */
875           signer = pripk;
876           if (is_selfsig)
877             *is_selfsig = 1;
878         }
879       else
880         {
881           /* See if one of the subkeys was the signer (although this
882            * is extremely unlikely).  */
883           kbnode_t ctx = NULL;
884           kbnode_t n;
885
886           while ((n = walk_kbnode (kb, &ctx, 0)))
887             {
888               PKT_public_key *subk;
889
890               if (n->pkt->pkttype != PKT_PUBLIC_SUBKEY)
891                 continue;
892
893               subk = n->pkt->pkt.public_key;
894               if (sig->keyid[0] == subk->keyid[0]
895                   && sig->keyid[1] == subk->keyid[1])
896                 {
897                   /* Issued by a subkey.  */
898                   signer = subk;
899                   break;
900                 }
901             }
902
903           if (! signer)
904             {
905               /* Signer by some other key.  */
906               if (is_selfsig)
907                 *is_selfsig = 0;
908               if (ret_pk)
909                 {
910                   signer = ret_pk;
911                   /* FIXME: Using memset here is probematic because it
912                    * assumes that there are no allocated fields in
913                    * SIGNER.  */
914                   memset (signer, 0, sizeof (*signer));
915                   signer_alloced = 1;
916                 }
917               else
918                 {
919                   signer = xmalloc_clear (sizeof (*signer));
920                   signer_alloced = 2;
921                 }
922
923               if (IS_CERT (sig))
924                 signer->req_usage = PUBKEY_USAGE_CERT;
925
926               rc = get_pubkey (ctrl, signer, sig->keyid);
927               if (rc)
928                 {
929                   xfree (signer);
930                   signer = NULL;
931                   signer_alloced = 0;
932                   goto leave;
933                 }
934             }
935         }
936     }
937
938   /* We checked above that we supported this algo, so an error here is
939    * a bug.  */
940   if (gcry_md_open (&md, sig->digest_algo, 0))
941     BUG ();
942
943   /* Hash the relevant data.  */
944
945   if (IS_KEY_SIG (sig) || IS_KEY_REV (sig))
946     {
947       log_assert (packet->pkttype == PKT_PUBLIC_KEY);
948       hash_public_key (md, packet->pkt.public_key);
949       rc = check_signature_end_simple (signer, sig, md);
950     }
951   else if (IS_BACK_SIG (sig))
952     {
953       log_assert (packet->pkttype == PKT_PUBLIC_KEY);
954       hash_public_key (md, packet->pkt.public_key);
955       hash_public_key (md, signer);
956       rc = check_signature_end_simple (signer, sig, md);
957     }
958   else if (IS_SUBKEY_SIG (sig) || IS_SUBKEY_REV (sig))
959     {
960       log_assert (packet->pkttype == PKT_PUBLIC_SUBKEY);
961       hash_public_key (md, pripk);
962       hash_public_key (md, packet->pkt.public_key);
963       rc = check_signature_end_simple (signer, sig, md);
964     }
965   else if (IS_UID_SIG (sig) || IS_UID_REV (sig))
966     {
967       log_assert (packet->pkttype == PKT_USER_ID);
968       hash_public_key (md, pripk);
969       hash_uid_packet (packet->pkt.user_id, md, sig);
970       rc = check_signature_end_simple (signer, sig, md);
971     }
972   else
973     {
974       /* We should never get here.  (The first if above should have
975        * already caught this error.)  */
976       BUG ();
977     }
978
979   gcry_md_close (md);
980
981  leave:
982   if (! rc && ret_pk && ret_pk != signer)
983     copy_public_key (ret_pk, signer);
984
985   if (signer_alloced)
986     {
987       /* We looked up SIGNER; it is not a pointer into KB.  */
988       release_public_key_parts (signer);
989       /* Free if we also allocated the memory.  */
990       if (signer_alloced == 2)
991         xfree (signer);
992     }
993
994   return rc;
995 }
996
997
998 /* Check that a signature over a key (e.g., a key revocation, key
999  * binding, user id certification, etc.) is valid.  If the function
1000  * detects a self-signature, it uses the public key from the specified
1001  * key block and does not bother looking up the key specified in the
1002  * signature packet.
1003  *
1004  * ROOT is a keyblock.
1005  *
1006  * NODE references a signature packet that appears in the keyblock
1007  * that should be verified.
1008  *
1009  * If CHECK_PK is set, the specified key is sometimes preferred for
1010  * verifying signatures.  See the implementation for details.
1011  *
1012  * If RET_PK is not NULL, the public key that successfully verified
1013  * the signature is copied into *RET_PK.
1014  *
1015  * If IS_SELFSIG is not NULL, *IS_SELFSIG is set to 1 if NODE is a
1016  * self-signature.
1017  *
1018  * If R_EXPIREDATE is not NULL, *R_EXPIREDATE is set to the expiry
1019  * date.
1020  *
1021  * If R_EXPIRED is not NULL, *R_EXPIRED is set to 1 if PK has been
1022  * expired (0 otherwise).  Note: PK being revoked does not cause this
1023  * function to fail.
1024  *
1025  *
1026  * If OPT.NO_SIG_CACHE is not set, this function will first check if
1027  * the result of a previous verification is already cached in the
1028  * signature packet's data structure.
1029  *
1030  * TODO: add r_revoked here as well.  It has the same problems as
1031  * r_expiredate and r_expired and the cache.  */
1032 int
1033 check_key_signature2 (ctrl_t ctrl,
1034                       kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
1035                       PKT_public_key *ret_pk, int *is_selfsig,
1036                       u32 *r_expiredate, int *r_expired )
1037 {
1038   PKT_public_key *pk;
1039   PKT_signature *sig;
1040   int algo;
1041   int rc;
1042
1043   if (is_selfsig)
1044     *is_selfsig = 0;
1045   if (r_expiredate)
1046     *r_expiredate = 0;
1047   if (r_expired)
1048     *r_expired = 0;
1049   log_assert (node->pkt->pkttype == PKT_SIGNATURE);
1050   log_assert (root->pkt->pkttype == PKT_PUBLIC_KEY);
1051
1052   pk = root->pkt->pkt.public_key;
1053   sig = node->pkt->pkt.signature;
1054   algo = sig->digest_algo;
1055
1056   /* Check whether we have cached the result of a previous signature
1057    * check.  Note that we may no longer have the pubkey or hash
1058    * needed to verify a sig, but can still use the cached value.  A
1059    * cache refresh detects and clears these cases. */
1060   if ( !opt.no_sig_cache )
1061     {
1062       cache_stats.total++;
1063       if (sig->flags.checked) /* Cached status available.  */
1064         {
1065           cache_stats.cached++;
1066           if (is_selfsig)
1067             {
1068               u32 keyid[2];
1069
1070               keyid_from_pk (pk, keyid);
1071               if (keyid[0] == sig->keyid[0] && keyid[1] == sig->keyid[1])
1072                 *is_selfsig = 1;
1073             }
1074           /* BUG: This is wrong for non-self-sigs... needs to be the
1075            * actual pk.  */
1076           rc = check_signature_metadata_validity (pk, sig, r_expired, NULL);
1077           if (rc)
1078             return rc;
1079           if (sig->flags.valid)
1080             {
1081               cache_stats.goodsig++;
1082               return 0;
1083             }
1084           cache_stats.badsig++;
1085           return gpg_error (GPG_ERR_BAD_SIGNATURE);
1086         }
1087     }
1088
1089   rc = openpgp_pk_test_algo(sig->pubkey_algo);
1090   if (rc)
1091     return rc;
1092   rc = openpgp_md_test_algo(algo);
1093   if (rc)
1094     return rc;
1095
1096   if (IS_KEY_REV (sig))
1097     {
1098       u32 keyid[2];
1099       keyid_from_pk( pk, keyid );
1100
1101       /* Is it a designated revoker? */
1102       if (keyid[0] != sig->keyid[0] || keyid[1] != sig->keyid[1])
1103         rc = check_revocation_keys (ctrl, pk, sig);
1104       else
1105         {
1106           rc = check_signature_metadata_validity (pk, sig,
1107                                                   r_expired, NULL);
1108           if (! rc)
1109             rc = check_signature_over_key_or_uid (ctrl, pk, sig,
1110                                                   root, root->pkt,
1111                                                   is_selfsig, ret_pk);
1112         }
1113     }
1114   else if (IS_SUBKEY_REV (sig) || IS_SUBKEY_SIG (sig))
1115     {
1116       kbnode_t snode = find_prev_kbnode (root, node, PKT_PUBLIC_SUBKEY);
1117
1118       if (snode)
1119         {
1120           rc = check_signature_metadata_validity (pk, sig,
1121                                                   r_expired, NULL);
1122           if (! rc)
1123             {
1124               /* A subkey revocation (0x28) must be a self-sig, but a
1125                * subkey signature (0x18) needn't be.  */
1126               rc = check_signature_over_key_or_uid (ctrl,
1127                                                     IS_SUBKEY_SIG (sig)
1128                                                     ? NULL : pk,
1129                                                     sig, root, snode->pkt,
1130                                                     is_selfsig, ret_pk);
1131             }
1132         }
1133       else
1134         {
1135           if (opt.verbose)
1136             {
1137               if (IS_SUBKEY_REV (sig))
1138                 log_info (_("key %s: no subkey for subkey"
1139                             " revocation signature\n"), keystr_from_pk(pk));
1140               else if (sig->sig_class == 0x18)
1141                 log_info(_("key %s: no subkey for subkey"
1142                            " binding signature\n"), keystr_from_pk(pk));
1143             }
1144           rc = GPG_ERR_SIG_CLASS;
1145         }
1146     }
1147   else if (IS_KEY_SIG (sig)) /* direct key signature */
1148       {
1149         rc = check_signature_metadata_validity (pk, sig,
1150                                                 r_expired, NULL);
1151         if (! rc)
1152           rc = check_signature_over_key_or_uid (ctrl, pk, sig, root, root->pkt,
1153                                                 is_selfsig, ret_pk);
1154       }
1155     else if (IS_UID_SIG (sig) || IS_UID_REV (sig))
1156       {
1157         kbnode_t unode = find_prev_kbnode (root, node, PKT_USER_ID);
1158
1159         if (unode)
1160           {
1161             rc = check_signature_metadata_validity (pk, sig, r_expired, NULL);
1162             if (! rc)
1163               {
1164                 /* If this is a self-sig, ignore check_pk.  */
1165                 rc = check_signature_over_key_or_uid
1166                   (ctrl,
1167                    keyid_cmp (pk_keyid (pk), sig->keyid) == 0 ? pk : check_pk,
1168                    sig, root, unode->pkt, NULL, ret_pk);
1169               }
1170           }
1171         else
1172           {
1173             if (!opt.quiet)
1174               log_info ("key %s: no user ID for key signature packet"
1175                         " of class %02x\n",keystr_from_pk(pk),sig->sig_class);
1176             rc = GPG_ERR_SIG_CLASS;
1177           }
1178       }
1179   else
1180     {
1181       log_info ("sig issued by %s with class %d (digest: %02x %02x)"
1182                 " is not valid over a user id or a key id, ignoring.\n",
1183                 keystr (sig->keyid), sig->sig_class,
1184                 sig->digest_start[0], sig->digest_start[1]);
1185       rc = gpg_error (GPG_ERR_BAD_SIGNATURE);
1186     }
1187
1188   cache_sig_result  (sig, rc);
1189
1190   return rc;
1191 }