Use ngettext for some strings.
[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 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 <http://www.gnu.org/licenses/>.
20  */
21
22 #include <config.h>
23 #include <stdio.h>
24 #include <stdlib.h>
25 #include <string.h>
26 #include <assert.h>
27
28 #include "gpg.h"
29 #include "util.h"
30 #include "packet.h"
31 #include "keydb.h"
32 #include "main.h"
33 #include "status.h"
34 #include "i18n.h"
35 #include "options.h"
36 #include "pkglue.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 /* Check a signature.  This is shorthand for check_signature2 with
44    the unnamed arguments passed as NULL.  */
45 int
46 check_signature (PKT_signature *sig, gcry_md_hd_t digest)
47 {
48     return check_signature2 (sig, digest, NULL, NULL, NULL, NULL);
49 }
50
51
52 /* Check a signature.
53  *
54  * Looks up the public key that created the signature (SIG->KEYID)
55  * from the key db.  Makes sure that the signature is valid (it was
56  * not created prior to the key, the public key was created in the
57  * past, and the signature does not include any unsupported critical
58  * features), finishes computing the hash of the signature data, and
59  * checks that the signature verifies the digest.  If the key that
60  * generated the signature is a subkey, this function also verifies
61  * that there is a valid backsig from the subkey to the primary key.
62  * Finally, if status fd is enabled and the signature class is 0x00 or
63  * 0x01, then a STATUS_SIG_ID is emitted on the status fd.
64  *
65  * SIG is the signature to check.
66  *
67  * DIGEST contains a valid hash context that already includes the
68  * signed data.  This function adds the relevant meta-data from the
69  * signature packet to compute the final hash.  (See Section 5.2 of
70  * RFC 4880: "The concatenation of the data being signed and the
71  * signature data from the version number through the hashed subpacket
72  * data (inclusive) is hashed.")
73  *
74  * If R_EXPIREDATE is not NULL, R_EXPIREDATE is set to the key's
75  * expiry.
76  *
77  * If R_EXPIRED is not NULL, *R_EXPIRED is set to 1 if PK has expired
78  * (0 otherwise).  Note: PK being expired does not cause this function
79  * to fail.
80  *
81  * If R_REVOKED is not NULL, *R_REVOKED is set to 1 if PK has been
82  * revoked (0 otherwise).  Note: PK being revoked does not cause this
83  * function to fail.
84  *
85  * If PK is not NULL, the public key is saved in *PK on success.
86  *
87  * Returns 0 on success.  An error code otherwise.  */
88 int
89 check_signature2 (PKT_signature *sig, gcry_md_hd_t digest, u32 *r_expiredate,
90                   int *r_expired, int *r_revoked, PKT_public_key *pk )
91 {
92     int rc=0;
93     int pk_internal;
94
95     if (pk)
96       pk_internal = 0;
97     else
98       {
99         pk_internal = 1;
100         pk = xmalloc_clear( sizeof *pk );
101       }
102
103     if ( (rc=openpgp_md_test_algo(sig->digest_algo)) )
104       ; /* We don't have this digest. */
105     else if ((rc=openpgp_pk_test_algo(sig->pubkey_algo)))
106       ; /* We don't have this pubkey algo. */
107     else if (!gcry_md_is_enabled (digest,sig->digest_algo))
108       {
109         /* Sanity check that the md has a context for the hash that the
110            sig is expecting.  This can happen if a onepass sig header does
111            not match the actual sig, and also if the clearsign "Hash:"
112            header is missing or does not match the actual sig. */
113
114         log_info(_("WARNING: signature digest conflict in message\n"));
115         rc = GPG_ERR_GENERAL;
116       }
117     else if( get_pubkey( pk, sig->keyid ) )
118         rc = GPG_ERR_NO_PUBKEY;
119     else if(!pk->flags.valid && !pk->flags.primary)
120       {
121         /* You cannot have a good sig from an invalid subkey.  */
122         rc = GPG_ERR_BAD_PUBKEY;
123       }
124     else
125       {
126         if(r_expiredate)
127           *r_expiredate = pk->expiredate;
128
129         rc = check_signature_end (pk, sig, digest, r_expired, r_revoked, NULL);
130
131         /* Check the backsig.  This is a 0x19 signature from the
132            subkey on the primary key.  The idea here is that it should
133            not be possible for someone to "steal" subkeys and claim
134            them as their own.  The attacker couldn't actually use the
135            subkey, but they could try and claim ownership of any
136            signatures issued by it. */
137         if(rc==0 && !pk->flags.primary && pk->flags.backsig < 2)
138           {
139             if (!pk->flags.backsig)
140               {
141                 log_info(_("WARNING: signing subkey %s is not"
142                            " cross-certified\n"),keystr_from_pk(pk));
143                 log_info(_("please see %s for more information\n"),
144                          "https://gnupg.org/faq/subkey-cross-certify.html");
145                 /* --require-cross-certification makes this warning an
146                      error.  TODO: change the default to require this
147                      after more keys have backsigs. */
148                 if(opt.flags.require_cross_cert)
149                   rc = GPG_ERR_GENERAL;
150               }
151             else if(pk->flags.backsig == 1)
152               {
153                 log_info(_("WARNING: signing subkey %s has an invalid"
154                            " cross-certification\n"),keystr_from_pk(pk));
155                 rc = GPG_ERR_GENERAL;
156               }
157           }
158       }
159
160     if (pk_internal || rc)
161       {
162         release_public_key_parts (pk);
163         if (pk_internal)
164           xfree (pk);
165         else
166           /* Be very sure that the caller doesn't try to use *PK.  */
167           memset (pk, 0, sizeof (*pk));
168       }
169
170     if( !rc && sig->sig_class < 2 && is_status_enabled() ) {
171         /* This signature id works best with DLP algorithms because
172          * they use a random parameter for every signature.  Instead of
173          * this sig-id we could have also used the hash of the document
174          * and the timestamp, but the drawback of this is, that it is
175          * not possible to sign more than one identical document within
176          * one second.  Some remote batch processing applications might
177          * like this feature here.
178          *
179          * Note that before 2.0.10, we used RIPE-MD160 for the hash
180          * and accidentally didn't include the timestamp and algorithm
181          * information in the hash.  Given that this feature is not
182          * commonly used and that a replay attacks detection should
183          * not solely be based on this feature (because it does not
184          * work with RSA), we take the freedom and switch to SHA-1
185          * with 2.0.10 to take advantage of hardware supported SHA-1
186          * implementations.  We also include the missing information
187          * in the hash.  Note also the SIG_ID as computed by gpg 1.x
188          * and gpg 2.x didn't matched either because 2.x used to print
189          * MPIs not in PGP format.  */
190         u32 a = sig->timestamp;
191         int nsig = pubkey_get_nsig( sig->pubkey_algo );
192         unsigned char *p, *buffer;
193         size_t n, nbytes;
194         int i;
195         char hashbuf[20];
196
197         nbytes = 6;
198         for (i=0; i < nsig; i++ )
199           {
200             if (gcry_mpi_print (GCRYMPI_FMT_USG, NULL, 0, &n, sig->data[i]))
201               BUG();
202             nbytes += n;
203           }
204
205         /* Make buffer large enough to be later used as output buffer.  */
206         if (nbytes < 100)
207           nbytes = 100;
208         nbytes += 10;  /* Safety margin.  */
209
210         /* Fill and hash buffer.  */
211         buffer = p = xmalloc (nbytes);
212         *p++ = sig->pubkey_algo;
213         *p++ = sig->digest_algo;
214         *p++ = (a >> 24) & 0xff;
215         *p++ = (a >> 16) & 0xff;
216         *p++ = (a >>  8) & 0xff;
217         *p++ =  a & 0xff;
218         nbytes -= 6;
219         for (i=0; i < nsig; i++ )
220           {
221             if (gcry_mpi_print (GCRYMPI_FMT_PGP, p, nbytes, &n, sig->data[i]))
222               BUG();
223             p += n;
224             nbytes -= n;
225           }
226         gcry_md_hash_buffer (GCRY_MD_SHA1, hashbuf, buffer, p-buffer);
227
228         p = make_radix64_string (hashbuf, 20);
229         sprintf (buffer, "%s %s %lu",
230                  p, strtimestamp (sig->timestamp), (ulong)sig->timestamp);
231         xfree (p);
232         write_status_text (STATUS_SIG_ID, buffer);
233         xfree (buffer);
234     }
235
236     return rc;
237 }
238
239
240 /* The signature SIG was generated with the public key PK.  Check
241  * whether the signature is valid in the following sense:
242  *
243  *   - Make sure the public key was created before the signature was
244  *     generated.
245  *
246  *   - Make sure the public key was created in the past
247  *
248  *   - Check whether PK has expired (set *R_EXPIRED to 1 if so and 0
249  *     otherwise)
250  *
251  *   - Check whether PK has been revoked (set *R_REVOKED to 1 if so
252  *     and 0 otherwise).
253  *
254  * If either of the first two tests fail, returns an error code.
255  * Otherwise returns 0.  (Thus, this function doesn't fail if the
256  * public key is expired or revoked.)  */
257 static int
258 check_signature_metadata_validity (PKT_public_key *pk, PKT_signature *sig,
259                                    int *r_expired, int *r_revoked)
260 {
261     u32 cur_time;
262
263     if(r_expired)
264       *r_expired = 0;
265     if(r_revoked)
266       *r_revoked = 0;
267
268     if( pk->timestamp > sig->timestamp )
269       {
270         ulong d = pk->timestamp - sig->timestamp;
271         log_info
272           (ngettext("public key %s is %lu second newer than the signature\n",
273                     "public key %s is %lu seconds newer than the signature\n",
274                     d), keystr_from_pk (pk), d);
275         if (!opt.ignore_time_conflict)
276           return GPG_ERR_TIME_CONFLICT; /* pubkey newer than signature.  */
277       }
278
279     cur_time = make_timestamp();
280     if( pk->timestamp > cur_time )
281       {
282         ulong d = pk->timestamp - cur_time;
283         log_info (ngettext("key %s was created %lu second"
284                            " in the future (time warp or clock problem)\n",
285                            "key %s was created %lu seconds"
286                            " in the future (time warp or clock problem)\n",
287                            d), keystr_from_pk (pk), d);
288         if( !opt.ignore_time_conflict )
289           return GPG_ERR_TIME_CONFLICT;
290       }
291
292     /* Check whether the key has expired.  We check the has_expired
293        flag which is set after a full evaluation of the key (getkey.c)
294        as well as a simple compare to the current time in case the
295        merge has for whatever reasons not been done.  */
296     if( pk->has_expired || (pk->expiredate && pk->expiredate < cur_time)) {
297         char buf[11];
298         if (opt.verbose)
299           log_info(_("Note: signature key %s expired %s\n"),
300                    keystr_from_pk(pk), asctimestamp( pk->expiredate ) );
301         sprintf(buf,"%lu",(ulong)pk->expiredate);
302         write_status_text(STATUS_KEYEXPIRED,buf);
303         if(r_expired)
304           *r_expired = 1;
305     }
306
307     if (pk->flags.revoked)
308       {
309         if (opt.verbose)
310           log_info (_("Note: signature key %s has been revoked\n"),
311                     keystr_from_pk(pk));
312         if (r_revoked)
313           *r_revoked=1;
314       }
315
316     return 0;
317 }
318
319
320 /* Finish generating a signature and check it.  Concretely: make sure
321  * that the signature is valid (it was not created prior to the key,
322  * the public key was created in the past, and the signature does not
323  * include any unsupported critical features), finish computing the
324  * digest by adding the relevant data from the signature packet, and
325  * check that the signature verifies the digest.
326  *
327  * DIGEST contains a hash context, which has already hashed the signed
328  * data.  This function adds the relevant meta-data from the signature
329  * packet to compute the final hash.  (See Section 5.2 of RFC 4880:
330  * "The concatenation of the data being signed and the signature data
331  * from the version number through the hashed subpacket data
332  * (inclusive) is hashed.")
333  *
334  * SIG is the signature to check.
335  *
336  * PK is the public key used to generate the signature.
337  *
338  * If R_EXPIRED is not NULL, *R_EXPIRED is set to 1 if PK has expired
339  * (0 otherwise).  Note: PK being expired does not cause this function
340  * to fail.
341  *
342  * If R_REVOKED is not NULL, *R_REVOKED is set to 1 if PK has been
343  * revoked (0 otherwise).  Note: PK being revoked does not cause this
344  * function to fail.
345  *
346  * If RET_PK is not NULL, PK is copied into RET_PK on success.
347  *
348  * Returns 0 on success.  An error code other.  */
349 static int
350 check_signature_end (PKT_public_key *pk, PKT_signature *sig,
351                      gcry_md_hd_t digest,
352                      int *r_expired, int *r_revoked, PKT_public_key *ret_pk)
353 {
354     gcry_mpi_t result = NULL;
355     int rc = 0;
356     const struct weakhash *weak;
357
358     if ((rc = check_signature_metadata_validity (pk, sig,
359                                                  r_expired, r_revoked)))
360         return rc;
361
362     if (!opt.flags.allow_weak_digest_algos)
363       for (weak = opt.weak_digests; weak; weak = weak->next)
364         if (sig->digest_algo == weak->algo)
365           {
366             print_digest_rejected_note(sig->digest_algo);
367             return GPG_ERR_DIGEST_ALGO;
368           }
369
370     /* Make sure the digest algo is enabled (in case of a detached
371        signature).  */
372     gcry_md_enable (digest, sig->digest_algo);
373
374     /* Complete the digest. */
375     if( sig->version >= 4 )
376         gcry_md_putc( digest, sig->version );
377     gcry_md_putc( digest, sig->sig_class );
378     if( sig->version < 4 ) {
379         u32 a = sig->timestamp;
380         gcry_md_putc( digest, (a >> 24) & 0xff );
381         gcry_md_putc( digest, (a >> 16) & 0xff );
382         gcry_md_putc( digest, (a >>     8) & 0xff );
383         gcry_md_putc( digest,  a           & 0xff );
384     }
385     else {
386         byte buf[6];
387         size_t n;
388         gcry_md_putc( digest, sig->pubkey_algo );
389         gcry_md_putc( digest, sig->digest_algo );
390         if( sig->hashed ) {
391             n = sig->hashed->len;
392             gcry_md_putc (digest, (n >> 8) );
393             gcry_md_putc (digest,  n       );
394             gcry_md_write (digest, sig->hashed->data, n);
395             n += 6;
396         }
397         else {
398           /* Two octets for the (empty) length of the hashed
399              section. */
400           gcry_md_putc (digest, 0);
401           gcry_md_putc (digest, 0);
402           n = 6;
403         }
404         /* add some magic per Section 5.2.4 of RFC 4880.  */
405         buf[0] = sig->version;
406         buf[1] = 0xff;
407         buf[2] = n >> 24;
408         buf[3] = n >> 16;
409         buf[4] = n >>  8;
410         buf[5] = n;
411         gcry_md_write( digest, buf, 6 );
412     }
413     gcry_md_final( digest );
414
415     /* Convert the digest to an MPI.  */
416     result = encode_md_value (pk, digest, sig->digest_algo );
417     if (!result)
418         return GPG_ERR_GENERAL;
419
420     /* Verify the signature.  */
421     rc = pk_verify( pk->pubkey_algo, result, sig->data, pk->pkey );
422     gcry_mpi_release (result);
423
424     if( !rc && sig->flags.unknown_critical )
425       {
426         log_info(_("assuming bad signature from key %s"
427                    " due to an unknown critical bit\n"),keystr_from_pk(pk));
428         rc = GPG_ERR_BAD_SIGNATURE;
429       }
430
431     if(!rc && ret_pk)
432       copy_public_key(ret_pk,pk);
433
434     return rc;
435 }
436
437
438 /* Add a uid node to a hash context.  See section 5.2.4, paragraph 4
439    of RFC 4880.  */
440 static void
441 hash_uid_node( KBNODE unode, gcry_md_hd_t md, PKT_signature *sig )
442 {
443     PKT_user_id *uid = unode->pkt->pkt.user_id;
444
445     assert( unode->pkt->pkttype == PKT_USER_ID );
446     if( uid->attrib_data ) {
447         if( sig->version >=4 ) {
448             byte buf[5];
449             buf[0] = 0xd1;                   /* packet of type 17 */
450             buf[1] = uid->attrib_len >> 24;  /* always use 4 length bytes */
451             buf[2] = uid->attrib_len >> 16;
452             buf[3] = uid->attrib_len >>  8;
453             buf[4] = uid->attrib_len;
454             gcry_md_write( md, buf, 5 );
455         }
456         gcry_md_write( md, uid->attrib_data, uid->attrib_len );
457     }
458     else {
459         if( sig->version >=4 ) {
460             byte buf[5];
461             buf[0] = 0xb4;            /* indicates a userid packet */
462             buf[1] = uid->len >> 24;  /* always use 4 length bytes */
463             buf[2] = uid->len >> 16;
464             buf[3] = uid->len >>  8;
465             buf[4] = uid->len;
466             gcry_md_write( md, buf, 5 );
467         }
468         gcry_md_write( md, uid->name, uid->len );
469     }
470 }
471
472 static void
473 cache_sig_result ( PKT_signature *sig, int result )
474 {
475     if ( !result ) {
476         sig->flags.checked = 1;
477         sig->flags.valid = 1;
478     }
479     else if ( gpg_err_code (result) == GPG_ERR_BAD_SIGNATURE ) {
480         sig->flags.checked = 1;
481         sig->flags.valid = 0;
482     }
483     else {
484         sig->flags.checked = 0;
485         sig->flags.valid = 0;
486     }
487 }
488
489
490 /* SIG is a key revocation signature.  Check if this signature was
491  * generated by any of the public key PK's designated revokers.
492  *
493  *   PK is the public key that SIG allegedly revokes.
494  *
495  *   SIG is the revocation signature to check.
496  *
497  * This function avoids infinite recursion, which can happen if two
498  * keys are designed revokers for each other and they revoke each
499  * other.  This is done by observing that if a key A is revoked by key
500  * B we still consider the revocation to be valid even if B is
501  * revoked.  Thus, we don't need to determine whether B is revoked to
502  * determine whether A has been revoked by B, we just need to check
503  * the signature.
504  *
505  * Returns 0 if sig is valid (i.e. pk is revoked), non-0 if not
506  * revoked.  We are careful to make sure that GPG_ERR_NO_PUBKEY is
507  * only returned when a revocation signature is from a valid
508  * revocation key designated in a revkey subpacket, but the revocation
509  * key itself isn't present.
510  *
511  * XXX: This code will need to be modified if gpg ever becomes
512  * multi-threaded.  Note that this guarantees that a designated
513  * revocation sig will never be considered valid unless it is actually
514  * valid, as well as being issued by a revocation key in a valid
515  * direct signature.  Note also that this is written so that a revoked
516  * revoker can still issue revocations: i.e. If A revokes B, but A is
517  * revoked, B is still revoked.  I'm not completely convinced this is
518  * the proper behavior, but it matches how PGP does it. -dms */
519 int
520 check_revocation_keys (PKT_public_key *pk, PKT_signature *sig)
521 {
522   static int busy=0;
523   int i;
524   int rc = GPG_ERR_GENERAL;
525
526   assert(IS_KEY_REV(sig));
527   assert((sig->keyid[0]!=pk->keyid[0]) || (sig->keyid[0]!=pk->keyid[1]));
528
529   /* Avoid infinite recursion.  Consider the following:
530    *
531    *   - We want to check if A is revoked.
532    *
533    *   - C is a designated revoker for B and has revoked B.
534    *
535    *   - B is a designated revoker for A and has revoked A.
536    *
537    * When checking if A is revoked (in merge_selfsigs_main), we
538    * observe that A has a designed revoker.  As such, we call this
539    * function.  This function sees that there is a valid revocation
540    * signature, which is signed by B.  It then calls check_signature()
541    * to verify that the signature is good.  To check the sig, we need
542    * to lookup B.  Looking up B means calling merge_selfsigs_main,
543    * which checks whether B is revoked, which calls this function to
544    * see if B was revoked by some key.
545    *
546    * In this case, the added level of indirection doesn't hurt.  It
547    * just means a bit more work.  However, if C == A, then we'd end up
548    * in a loop.  But, it doesn't make sense to look up C anyways: even
549    * if B is revoked, we conservatively consider a valid revocation
550    * signed by B to revoke A.  Since this is the only place where this
551    * type of recursion can occur, we simply cause this function to
552    * fail if it is entered recursively.  */
553   if (busy)
554     {
555       /* Return an error (i.e. not revoked), but mark the pk as
556          uncacheable as we don't really know its revocation status
557          until it is checked directly.  */
558       pk->flags.dont_cache = 1;
559       return rc;
560     }
561
562   busy=1;
563
564   /*  es_printf("looking at %08lX with a sig from %08lX\n",(ulong)pk->keyid[1],
565       (ulong)sig->keyid[1]); */
566
567   /* is the issuer of the sig one of our revokers? */
568   if( !pk->revkey && pk->numrevkeys )
569      BUG();
570   else
571       for(i=0;i<pk->numrevkeys;i++)
572         {
573           /* The revoker's keyid.  */
574           u32 keyid[2];
575
576           keyid_from_fingerprint(pk->revkey[i].fpr,MAX_FINGERPRINT_LEN,keyid);
577
578           if(keyid[0]==sig->keyid[0] && keyid[1]==sig->keyid[1])
579             /* The signature was generated by a designated revoker.
580                Verify the signature.  */
581             {
582               gcry_md_hd_t md;
583
584               if (gcry_md_open (&md, sig->digest_algo, 0))
585                 BUG ();
586               hash_public_key(md,pk);
587               /* Note: check_signature only checks that the signature
588                  is good.  It does not fail if the key is revoked.  */
589               rc=check_signature(sig,md);
590               cache_sig_result(sig,rc);
591               gcry_md_close (md);
592               break;
593             }
594         }
595
596   busy=0;
597
598   return rc;
599 }
600
601 /* Check that the backsig BACKSIG from the subkey SUB_PK to its
602    primary key MAIN_PK is valid.
603
604    Backsigs (0x19) have the same format as binding sigs (0x18), but
605    this function is simpler than check_key_signature in a few ways.
606    For example, there is no support for expiring backsigs since it is
607    questionable what such a thing actually means.  Note also that the
608    sig cache check here, unlike other sig caches in GnuPG, is not
609    persistent. */
610 int
611 check_backsig (PKT_public_key *main_pk,PKT_public_key *sub_pk,
612                PKT_signature *backsig)
613 {
614   gcry_md_hd_t md;
615   int rc;
616
617   /* Always check whether the algorithm is available.  Although
618      gcry_md_open would throw an error, some libgcrypt versions will
619      print a debug message in that case too. */
620   if ((rc=openpgp_md_test_algo (backsig->digest_algo)))
621     return rc;
622
623   if(!opt.no_sig_cache && backsig->flags.checked)
624     return backsig->flags.valid? 0 : gpg_error (GPG_ERR_BAD_SIGNATURE);
625
626   rc = gcry_md_open (&md, backsig->digest_algo,0);
627   if (!rc)
628     {
629       hash_public_key(md,main_pk);
630       hash_public_key(md,sub_pk);
631       rc = check_signature_end (sub_pk, backsig, md, NULL, NULL, NULL);
632       cache_sig_result(backsig,rc);
633       gcry_md_close(md);
634     }
635
636   return rc;
637 }
638
639
640 /* Check that a signature over a key is valid.  This is a
641  * specialization of check_key_signature2 with the unnamed parameters
642  * passed as NULL.  See the documentation for that function for more
643  * details.  */
644 int
645 check_key_signature (KBNODE root, KBNODE node, int *is_selfsig)
646 {
647   return check_key_signature2 (root, node, NULL, NULL, is_selfsig, NULL, NULL);
648 }
649
650
651 /* Check that a signature over a key (e.g., a key revocation, key
652  * binding, user id certification, etc.) is valid.  If the function
653  * detects a self-signature, it uses the public key from the specified
654  * key block and does not bother looking up the key specified in the
655  * signature packet.
656  *
657  * ROOT is a keyblock.
658  *
659  * NODE references a signature packet that appears in the keyblock
660  * that should be verified.
661  *
662  * If CHECK_PK is set, the specified key is sometimes preferred for
663  * verifying signatures.  See the implementation for details.
664  *
665  * If RET_PK is not NULL, the public key that successfully verified
666  * the signature is copied into *RET_PK.
667  *
668  * If IS_SELFSIG is not NULL, *IS_SELFSIG is set to 1 if NODE is a
669  * self-signature.
670  *
671  * If R_EXPIREDATE is not NULL, *R_EXPIREDATE is set to the expiry
672  * date.
673  *
674  * If R_EXPIRED is not NULL, *R_EXPIRED is set to 1 if PK has been
675  * expired (0 otherwise).  Note: PK being revoked does not cause this
676  * function to fail.
677  *
678  *
679  * If OPT.NO_SIG_CACHE is not set, this function will first check if
680  * the result of a previous verification is already cached in the
681  * signature packet's data structure.
682  *
683  * TODO: add r_revoked here as well.  It has the same problems as
684  * r_expiredate and r_expired and the cache.  */
685 int
686 check_key_signature2 (kbnode_t root, kbnode_t node, PKT_public_key *check_pk,
687                       PKT_public_key *ret_pk, int *is_selfsig,
688                       u32 *r_expiredate, int *r_expired )
689 {
690   gcry_md_hd_t md;
691   PKT_public_key *pk;
692   PKT_signature *sig;
693   int algo;
694   int rc;
695
696   if (is_selfsig)
697     *is_selfsig = 0;
698   if (r_expiredate)
699     *r_expiredate = 0;
700   if (r_expired)
701     *r_expired = 0;
702   assert (node->pkt->pkttype == PKT_SIGNATURE);
703   assert (root->pkt->pkttype == PKT_PUBLIC_KEY);
704
705   pk = root->pkt->pkt.public_key;
706   sig = node->pkt->pkt.signature;
707   algo = sig->digest_algo;
708
709   /* Check whether we have cached the result of a previous signature
710      check.  Note that we may no longer have the pubkey or hash
711      needed to verify a sig, but can still use the cached value.  A
712      cache refresh detects and clears these cases. */
713   if ( !opt.no_sig_cache )
714     {
715       if (sig->flags.checked) /* Cached status available.  */
716         {
717           if (is_selfsig)
718             {
719               u32 keyid[2];
720
721               keyid_from_pk (pk, keyid);
722               if (keyid[0] == sig->keyid[0] && keyid[1] == sig->keyid[1])
723                 *is_selfsig = 1;
724             }
725           /* BUG: This is wrong for non-self-sigs... needs to be the
726              actual pk.  */
727           rc = check_signature_metadata_validity (pk, sig, r_expired, NULL);
728           if (rc)
729             return rc;
730           return sig->flags.valid? 0 : gpg_error (GPG_ERR_BAD_SIGNATURE);
731         }
732     }
733
734   rc = openpgp_pk_test_algo(sig->pubkey_algo);
735   if (rc)
736     return rc;
737   rc = openpgp_md_test_algo(algo);
738   if (rc)
739     return rc;
740
741   if (sig->sig_class == 0x20) /* key revocation */
742     {
743       u32 keyid[2];
744       keyid_from_pk( pk, keyid );
745
746       /* Is it a designated revoker? */
747       if (keyid[0] != sig->keyid[0] || keyid[1] != sig->keyid[1])
748         rc = check_revocation_keys (pk, sig);
749       else
750         {
751           if (gcry_md_open (&md, algo, 0))
752             BUG ();
753           hash_public_key (md, pk);
754           rc = check_signature_end (pk, sig, md, r_expired, NULL, ret_pk);
755           cache_sig_result (sig, rc);
756           gcry_md_close (md);
757         }
758     }
759   else if (sig->sig_class == 0x28) /* subkey revocation */
760     {
761       kbnode_t snode = find_prev_kbnode (root, node, PKT_PUBLIC_SUBKEY);
762
763       if (snode)
764         {
765           if (gcry_md_open (&md, algo, 0))
766             BUG ();
767           hash_public_key (md, pk);
768           hash_public_key (md, snode->pkt->pkt.public_key);
769           rc = check_signature_end (pk, sig, md, r_expired, NULL, ret_pk);
770           cache_sig_result (sig, rc);
771           gcry_md_close (md);
772         }
773       else
774         {
775           if (opt.verbose)
776             log_info (_("key %s: no subkey for subkey"
777                         " revocation signature\n"), keystr_from_pk(pk));
778           rc = GPG_ERR_SIG_CLASS;
779         }
780     }
781     else if (sig->sig_class == 0x18) /* key binding */
782       {
783         kbnode_t snode = find_prev_kbnode (root, node, PKT_PUBLIC_SUBKEY);
784
785         if (snode)
786           {
787             if (is_selfsig)
788               {
789                 /* Does this make sense?  It should always be a
790                    selfsig.  Yes: We can't be sure about this and we
791                    need to be able to indicate that it is a selfsig.
792                    FIXME: The question is whether we should reject
793                    such a signature if it is not a selfsig.  */
794                 u32 keyid[2];
795
796                 keyid_from_pk (pk, keyid);
797                 if (keyid[0] == sig->keyid[0] && keyid[1] == sig->keyid[1])
798                   *is_selfsig = 1;
799               }
800             if (gcry_md_open (&md, algo, 0))
801               BUG ();
802             hash_public_key (md, pk);
803             hash_public_key (md, snode->pkt->pkt.public_key);
804             rc = check_signature_end (pk, sig, md, r_expired, NULL, ret_pk);
805             cache_sig_result ( sig, rc );
806             gcry_md_close (md);
807           }
808         else
809           {
810             if (opt.verbose)
811               log_info(_("key %s: no subkey for subkey"
812                          " binding signature\n"), keystr_from_pk(pk));
813             rc = GPG_ERR_SIG_CLASS;
814           }
815       }
816     else if (sig->sig_class == 0x1f) /* direct key signature */
817       {
818         if (gcry_md_open (&md, algo, 0 ))
819           BUG ();
820         hash_public_key( md, pk );
821         rc = check_signature_end (pk, sig, md, r_expired, NULL, ret_pk);
822         cache_sig_result (sig, rc);
823         gcry_md_close (md);
824       }
825     else /* all other classes */
826       {
827         kbnode_t unode = find_prev_kbnode (root, node, PKT_USER_ID);
828
829         if (unode)
830           {
831             u32 keyid[2];
832
833             keyid_from_pk (pk, keyid);
834             if (gcry_md_open (&md, algo, 0))
835               BUG ();
836             hash_public_key (md, pk);
837             hash_uid_node (unode, md, sig);
838             if (keyid[0] == sig->keyid[0] && keyid[1] == sig->keyid[1])
839               { /* The primary key is the signing key.  */
840
841                 if (is_selfsig)
842                   *is_selfsig = 1;
843                 rc = check_signature_end (pk, sig, md, r_expired, NULL, ret_pk);
844               }
845             else if (check_pk)
846               { /* The caller specified a key.  Try that.  */
847
848                 rc = check_signature_end (check_pk, sig, md,
849                                           r_expired, NULL, ret_pk);
850               }
851             else
852               { /* Look up the key.  */
853                 rc = check_signature2 (sig, md, r_expiredate, r_expired,
854                                        NULL, ret_pk);
855               }
856
857             cache_sig_result  (sig, rc);
858             gcry_md_close (md);
859           }
860         else
861           {
862             if (!opt.quiet)
863               log_info ("key %s: no user ID for key signature packet"
864                         " of class %02x\n",keystr_from_pk(pk),sig->sig_class);
865             rc = GPG_ERR_SIG_CLASS;
866           }
867       }
868
869   return rc;
870 }