gpg: Extend TRUST_foo status lines with the trust model.
[gnupg.git] / g10 / trustdb.c
1 /* trustdb.c
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005, 2006, 2007,
3  *               2008, 2012 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 <http://www.gnu.org/licenses/>.
19  */
20
21 #include <config.h>
22 #include <stdio.h>
23 #include <stdlib.h>
24 #include <string.h>
25
26 #ifndef DISABLE_REGEX
27 #include <sys/types.h>
28 #include <regex.h>
29 #endif /* !DISABLE_REGEX */
30
31 #include "gpg.h"
32 #include "status.h"
33 #include "iobuf.h"
34 #include "keydb.h"
35 #include "util.h"
36 #include "options.h"
37 #include "packet.h"
38 #include "main.h"
39 #include "i18n.h"
40 #include "tdbio.h"
41 #include "trustdb.h"
42 #include "tofu.h"
43
44
45 typedef struct key_item **KeyHashTable; /* see new_key_hash_table() */
46
47 /*
48  * Structure to keep track of keys, this is used as an array wherre
49  * the item right after the last one has a keyblock set to NULL.
50  * Maybe we can drop this thing and replace it by key_item
51  */
52 struct key_array
53 {
54   KBNODE keyblock;
55 };
56
57
58 /* Control information for the trust DB.  */
59 static struct
60 {
61   int init;
62   int level;
63   char *dbname;
64   int no_trustdb;
65 } trustdb_args;
66
67 /* Some globals.  */
68 static struct key_item *user_utk_list; /* temp. used to store --trusted-keys */
69 static struct key_item *utk_list;      /* all ultimately trusted keys */
70
71 static int pending_check_trustdb;
72
73 static int validate_keys (int interactive);
74
75 \f
76 /**********************************************
77  ************* some helpers *******************
78  **********************************************/
79
80 static struct key_item *
81 new_key_item (void)
82 {
83   struct key_item *k;
84
85   k = xmalloc_clear (sizeof *k);
86   return k;
87 }
88
89 static void
90 release_key_items (struct key_item *k)
91 {
92   struct key_item *k2;
93
94   for (; k; k = k2)
95     {
96       k2 = k->next;
97       xfree (k->trust_regexp);
98       xfree (k);
99     }
100 }
101
102 #define KEY_HASH_TABLE_SIZE 1024
103
104 /*
105  * For fast keylook up we need a hash table.  Each byte of a KeyID
106  * should be distributed equally over the 256 possible values (except
107  * for v3 keyIDs but we consider them as not important here). So we
108  * can just use 10 bits to index a table of KEY_HASH_TABLE_SIZE key items.
109  * Possible optimization: Do not use key_items but other hash_table when the
110  * duplicates lists get too large.
111  */
112 static KeyHashTable
113 new_key_hash_table (void)
114 {
115   struct key_item **tbl;
116
117   tbl = xmalloc_clear (KEY_HASH_TABLE_SIZE * sizeof *tbl);
118   return tbl;
119 }
120
121 static void
122 release_key_hash_table (KeyHashTable tbl)
123 {
124   int i;
125
126   if (!tbl)
127     return;
128   for (i=0; i < KEY_HASH_TABLE_SIZE; i++)
129     release_key_items (tbl[i]);
130   xfree (tbl);
131 }
132
133 /*
134  * Returns: True if the keyID is in the given hash table
135  */
136 static int
137 test_key_hash_table (KeyHashTable tbl, u32 *kid)
138 {
139   struct key_item *k;
140
141   for (k = tbl[(kid[1] % KEY_HASH_TABLE_SIZE)]; k; k = k->next)
142     if (k->kid[0] == kid[0] && k->kid[1] == kid[1])
143       return 1;
144   return 0;
145 }
146
147 /*
148  * Add a new key to the hash table.  The key is identified by its key ID.
149  */
150 static void
151 add_key_hash_table (KeyHashTable tbl, u32 *kid)
152 {
153   int i = kid[1] % KEY_HASH_TABLE_SIZE;
154   struct key_item *k, *kk;
155
156   for (k = tbl[i]; k; k = k->next)
157     if (k->kid[0] == kid[0] && k->kid[1] == kid[1])
158       return; /* already in table */
159
160   kk = new_key_item ();
161   kk->kid[0] = kid[0];
162   kk->kid[1] = kid[1];
163   kk->next = tbl[i];
164   tbl[i] = kk;
165 }
166
167 /*
168  * Release a key_array
169  */
170 static void
171 release_key_array ( struct key_array *keys )
172 {
173     struct key_array *k;
174
175     if (keys) {
176         for (k=keys; k->keyblock; k++)
177             release_kbnode (k->keyblock);
178         xfree (keys);
179     }
180 }
181
182 \f
183 /*********************************************
184  **********  Initialization  *****************
185  *********************************************/
186
187
188
189 /*
190  * Used to register extra ultimately trusted keys - this has to be done
191  * before initializing the validation module.
192  * FIXME: Should be replaced by a function to add those keys to the trustdb.
193  */
194 void
195 tdb_register_trusted_keyid (u32 *keyid)
196 {
197   struct key_item *k;
198
199   k = new_key_item ();
200   k->kid[0] = keyid[0];
201   k->kid[1] = keyid[1];
202   k->next = user_utk_list;
203   user_utk_list = k;
204 }
205
206 void
207 tdb_register_trusted_key( const char *string )
208 {
209   gpg_error_t err;
210   KEYDB_SEARCH_DESC desc;
211
212   err = classify_user_id (string, &desc, 1);
213   if (err || desc.mode != KEYDB_SEARCH_MODE_LONG_KID )
214     {
215       log_error(_("'%s' is not a valid long keyID\n"), string );
216       return;
217     }
218
219   register_trusted_keyid(desc.u.kid);
220 }
221
222 /*
223  * Helper to add a key to the global list of ultimately trusted keys.
224  * Retruns: true = inserted, false = already in in list.
225  */
226 static int
227 add_utk (u32 *kid)
228 {
229   struct key_item *k;
230
231   if (tdb_keyid_is_utk (kid))
232     return 0;
233
234   k = new_key_item ();
235   k->kid[0] = kid[0];
236   k->kid[1] = kid[1];
237   k->ownertrust = TRUST_ULTIMATE;
238   k->next = utk_list;
239   utk_list = k;
240   if( opt.verbose > 1 )
241     log_info(_("key %s: accepted as trusted key\n"), keystr(kid));
242   return 1;
243 }
244
245
246 /****************
247  * Verify that all our secret keys are usable and put them into the utk_list.
248  */
249 static void
250 verify_own_keys(void)
251 {
252   TRUSTREC rec;
253   ulong recnum;
254   int rc;
255   struct key_item *k;
256
257   if (utk_list)
258     return;
259
260   /* scan the trustdb to find all ultimately trusted keys */
261   for (recnum=1; !tdbio_read_record (recnum, &rec, 0); recnum++ )
262     {
263       if ( rec.rectype == RECTYPE_TRUST
264            && (rec.r.trust.ownertrust & TRUST_MASK) == TRUST_ULTIMATE)
265         {
266             byte *fpr = rec.r.trust.fingerprint;
267             int fprlen;
268             u32 kid[2];
269
270             /* Problem: We do only use fingerprints in the trustdb but
271              * we need the keyID here to indetify the key; we can only
272              * use that ugly hack to distinguish between 16 and 20
273              * butes fpr - it does not work always so we better change
274              * the whole validation code to only work with
275              * fingerprints */
276             fprlen = (!fpr[16] && !fpr[17] && !fpr[18] && !fpr[19])? 16:20;
277             keyid_from_fingerprint (fpr, fprlen, kid);
278             if (!add_utk (kid))
279               log_info(_("key %s occurs more than once in the trustdb\n"),
280                        keystr(kid));
281         }
282     }
283
284   /* Put any --trusted-key keys into the trustdb */
285   for (k = user_utk_list; k; k = k->next)
286     {
287       if ( add_utk (k->kid) )
288         { /* not yet in trustDB as ultimately trusted */
289           PKT_public_key pk;
290
291           memset (&pk, 0, sizeof pk);
292           rc = get_pubkey (&pk, k->kid);
293           if (rc)
294             log_info(_("key %s: no public key for trusted key - skipped\n"),
295                      keystr(k->kid));
296           else
297             {
298               tdb_update_ownertrust (&pk,
299                                      ((tdb_get_ownertrust (&pk) & ~TRUST_MASK)
300                                       | TRUST_ULTIMATE ));
301               release_public_key_parts (&pk);
302             }
303
304           log_info (_("key %s marked as ultimately trusted\n"),keystr(k->kid));
305         }
306     }
307
308   /* release the helper table table */
309   release_key_items (user_utk_list);
310   user_utk_list = NULL;
311   return;
312 }
313
314 /* Returns whether KID is on the list of ultimately trusted keys.  */
315 int
316 tdb_keyid_is_utk (u32 *kid)
317 {
318   struct key_item *k;
319
320   for (k = utk_list; k; k = k->next)
321     if (k->kid[0] == kid[0] && k->kid[1] == kid[1])
322       return 1;
323
324   return 0;
325 }
326 \f
327 /*********************************************
328  *********** TrustDB stuff *******************
329  *********************************************/
330
331 /*
332  * Read a record but die if it does not exist
333  */
334 static void
335 read_record (ulong recno, TRUSTREC *rec, int rectype )
336 {
337   int rc = tdbio_read_record (recno, rec, rectype);
338   if (rc)
339     {
340       log_error(_("trust record %lu, req type %d: read failed: %s\n"),
341                 recno, rec->rectype, gpg_strerror (rc) );
342       tdbio_invalid();
343     }
344   if (rectype != rec->rectype)
345     {
346       log_error(_("trust record %lu is not of requested type %d\n"),
347                 rec->recnum, rectype);
348       tdbio_invalid();
349     }
350 }
351
352 /*
353  * Write a record and die on error
354  */
355 static void
356 write_record (TRUSTREC *rec)
357 {
358   int rc = tdbio_write_record (rec);
359   if (rc)
360     {
361       log_error(_("trust record %lu, type %d: write failed: %s\n"),
362                             rec->recnum, rec->rectype, gpg_strerror (rc) );
363       tdbio_invalid();
364     }
365 }
366
367 /*
368  * sync the TrustDb and die on error
369  */
370 static void
371 do_sync(void)
372 {
373     int rc = tdbio_sync ();
374     if(rc)
375       {
376         log_error (_("trustdb: sync failed: %s\n"), gpg_strerror (rc) );
377         g10_exit(2);
378       }
379 }
380
381 const char *
382 trust_model_string (int model)
383 {
384   switch (model)
385     {
386     case TM_CLASSIC:  return "classic";
387     case TM_PGP:      return "pgp";
388     case TM_EXTERNAL: return "external";
389     case TM_TOFU:     return "tofu";
390     case TM_TOFU_PGP: return "tofu+pgp";
391     case TM_ALWAYS:   return "always";
392     case TM_DIRECT:   return "direct";
393     default:          return "unknown";
394     }
395 }
396
397 /****************
398  * Perform some checks over the trustdb
399  *  level 0: only open the db
400  *        1: used for initial program startup
401  */
402 int
403 setup_trustdb( int level, const char *dbname )
404 {
405     /* just store the args */
406     if( trustdb_args.init )
407         return 0;
408     trustdb_args.level = level;
409     trustdb_args.dbname = dbname? xstrdup(dbname): NULL;
410     return 0;
411 }
412
413 void
414 how_to_fix_the_trustdb ()
415 {
416   const char *name = trustdb_args.dbname;
417
418   if (!name)
419     name = "trustdb.gpg";
420
421   log_info (_("You may try to re-create the trustdb using the commands:\n"));
422   log_info ("  cd %s\n", default_homedir ());
423   log_info ("  %s --export-ownertrust > otrust.tmp\n", GPG_NAME);
424 #ifdef HAVE_W32_SYSTEM
425   log_info ("  del %s\n", name);
426 #else
427   log_info ("  rm %s\n", name);
428 #endif
429   log_info ("  %s --import-ownertrust < otrust.tmp\n", GPG_NAME);
430   log_info (_("If that does not work, please consult the manual\n"));
431 }
432
433
434 void
435 init_trustdb ()
436 {
437   int level = trustdb_args.level;
438   const char* dbname = trustdb_args.dbname;
439
440   if( trustdb_args.init )
441     return;
442
443   trustdb_args.init = 1;
444
445   if(level==0 || level==1)
446     {
447       int rc = tdbio_set_dbname( dbname, !!level, &trustdb_args.no_trustdb);
448       if( rc )
449         log_fatal("can't init trustdb: %s\n", gpg_strerror (rc) );
450     }
451   else
452     BUG();
453
454   if(opt.trust_model==TM_AUTO)
455     {
456       /* Try and set the trust model off of whatever the trustdb says
457          it is. */
458       opt.trust_model=tdbio_read_model();
459
460       /* Sanity check this ;) */
461       if(opt.trust_model != TM_CLASSIC
462          && opt.trust_model != TM_PGP
463          && opt.trust_model != TM_TOFU_PGP
464          && opt.trust_model != TM_TOFU
465          && opt.trust_model != TM_EXTERNAL)
466         {
467           log_info(_("unable to use unknown trust model (%d) - "
468                      "assuming %s trust model\n"),opt.trust_model,"pgp");
469           opt.trust_model = TM_PGP;
470         }
471
472       if(opt.verbose)
473         log_info(_("using %s trust model\n"),
474                  trust_model_string (opt.trust_model));
475     }
476
477   if (opt.trust_model==TM_PGP || opt.trust_model==TM_CLASSIC
478       || opt.trust_model == TM_TOFU || opt.trust_model == TM_TOFU_PGP)
479     {
480       /* Verify the list of ultimately trusted keys and move the
481          --trusted-keys list there as well. */
482       if(level==1)
483         verify_own_keys();
484
485       if(!tdbio_db_matches_options())
486         pending_check_trustdb=1;
487     }
488 }
489
490
491 /****************
492  * Recreate the WoT but do not ask for new ownertrusts.  Special
493  * feature: In batch mode and without a forced yes, this is only done
494  * when a check is due.  This can be used to run the check from a crontab
495  */
496 void
497 check_trustdb ()
498 {
499   init_trustdb();
500   if (opt.trust_model == TM_PGP || opt.trust_model == TM_CLASSIC
501       || opt.trust_model == TM_TOFU_PGP || opt.trust_model == TM_TOFU)
502     {
503       if (opt.batch && !opt.answer_yes)
504         {
505           ulong scheduled;
506
507           scheduled = tdbio_read_nextcheck ();
508           if (!scheduled)
509             {
510               log_info (_("no need for a trustdb check\n"));
511               return;
512             }
513
514           if (scheduled > make_timestamp ())
515             {
516               log_info (_("next trustdb check due at %s\n"),
517                         strtimestamp (scheduled));
518               return;
519             }
520         }
521
522       validate_keys (0);
523     }
524   else
525     log_info (_("no need for a trustdb check with '%s' trust model\n"),
526               trust_model_string(opt.trust_model));
527 }
528
529
530 /*
531  * Recreate the WoT.
532  */
533 void
534 update_trustdb()
535 {
536   init_trustdb();
537   if (opt.trust_model == TM_PGP || opt.trust_model == TM_CLASSIC
538       || opt.trust_model == TM_TOFU_PGP || opt.trust_model == TM_TOFU)
539     validate_keys (1);
540   else
541     log_info (_("no need for a trustdb update with '%s' trust model\n"),
542               trust_model_string(opt.trust_model));
543 }
544
545 void
546 tdb_revalidation_mark (void)
547 {
548   init_trustdb();
549   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
550     return;
551
552   /* We simply set the time for the next check to 1 (far back in 1970)
553      so that a --update-trustdb will be scheduled.  */
554   if (tdbio_write_nextcheck (1))
555     do_sync ();
556   pending_check_trustdb = 1;
557 }
558
559 int
560 trustdb_pending_check(void)
561 {
562   return pending_check_trustdb;
563 }
564
565 /* If the trustdb is dirty, and we're interactive, update it.
566    Otherwise, check it unless no-auto-check-trustdb is set. */
567 void
568 tdb_check_or_update (void)
569 {
570   if(trustdb_pending_check())
571     {
572       if(opt.interactive)
573         update_trustdb();
574       else if(!opt.no_auto_check_trustdb)
575         check_trustdb();
576     }
577 }
578
579 void
580 read_trust_options(byte *trust_model,ulong *created,ulong *nextcheck,
581                    byte *marginals,byte *completes,byte *cert_depth,
582                    byte *min_cert_level)
583 {
584   TRUSTREC opts;
585
586   init_trustdb();
587   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
588     memset (&opts, 0, sizeof opts);
589   else
590     read_record (0, &opts, RECTYPE_VER);
591
592   if(trust_model)
593     *trust_model=opts.r.ver.trust_model;
594   if(created)
595     *created=opts.r.ver.created;
596   if(nextcheck)
597     *nextcheck=opts.r.ver.nextcheck;
598   if(marginals)
599     *marginals=opts.r.ver.marginals;
600   if(completes)
601     *completes=opts.r.ver.completes;
602   if(cert_depth)
603     *cert_depth=opts.r.ver.cert_depth;
604   if(min_cert_level)
605     *min_cert_level=opts.r.ver.min_cert_level;
606 }
607
608 /***********************************************
609  ***********  Ownertrust et al. ****************
610  ***********************************************/
611
612 static int
613 read_trust_record (PKT_public_key *pk, TRUSTREC *rec)
614 {
615   int rc;
616
617   init_trustdb();
618   rc = tdbio_search_trust_bypk (pk, rec);
619   if (rc)
620     {
621       if (gpg_err_code (rc) != GPG_ERR_NOT_FOUND)
622         log_error ("trustdb: searching trust record failed: %s\n",
623                    gpg_strerror (rc));
624       return rc;
625     }
626
627   if (rec->rectype != RECTYPE_TRUST)
628     {
629       log_error ("trustdb: record %lu is not a trust record\n",
630                  rec->recnum);
631       return GPG_ERR_TRUSTDB;
632     }
633
634   return 0;
635 }
636
637 /****************
638  * Return the assigned ownertrust value for the given public key.
639  * The key should be the primary key.
640  */
641 unsigned int
642 tdb_get_ownertrust ( PKT_public_key *pk)
643 {
644   TRUSTREC rec;
645   gpg_error_t err;
646
647   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
648     return TRUST_UNKNOWN;
649
650   err = read_trust_record (pk, &rec);
651   if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
652     return TRUST_UNKNOWN; /* no record yet */
653   if (err)
654     {
655       tdbio_invalid ();
656       return TRUST_UNKNOWN; /* actually never reached */
657     }
658
659   return rec.r.trust.ownertrust;
660 }
661
662
663 unsigned int
664 tdb_get_min_ownertrust (PKT_public_key *pk)
665 {
666   TRUSTREC rec;
667   gpg_error_t err;
668
669   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
670     return TRUST_UNKNOWN;
671
672   err = read_trust_record (pk, &rec);
673   if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
674     return TRUST_UNKNOWN; /* no record yet */
675   if (err)
676     {
677       tdbio_invalid ();
678       return TRUST_UNKNOWN; /* actually never reached */
679     }
680
681   return rec.r.trust.min_ownertrust;
682 }
683
684
685 /*
686  * Set the trust value of the given public key to the new value.
687  * The key should be a primary one.
688  */
689 void
690 tdb_update_ownertrust (PKT_public_key *pk, unsigned int new_trust )
691 {
692   TRUSTREC rec;
693   gpg_error_t err;
694
695   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
696     return;
697
698   err = read_trust_record (pk, &rec);
699   if (!err)
700     {
701       if (DBG_TRUST)
702         log_debug ("update ownertrust from %u to %u\n",
703                    (unsigned int)rec.r.trust.ownertrust, new_trust );
704       if (rec.r.trust.ownertrust != new_trust)
705         {
706           rec.r.trust.ownertrust = new_trust;
707           write_record( &rec );
708           tdb_revalidation_mark ();
709           do_sync ();
710         }
711     }
712   else if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
713     { /* no record yet - create a new one */
714       size_t dummy;
715
716       if (DBG_TRUST)
717         log_debug ("insert ownertrust %u\n", new_trust );
718
719       memset (&rec, 0, sizeof rec);
720       rec.recnum = tdbio_new_recnum ();
721       rec.rectype = RECTYPE_TRUST;
722       fingerprint_from_pk (pk, rec.r.trust.fingerprint, &dummy);
723       rec.r.trust.ownertrust = new_trust;
724       write_record (&rec);
725       tdb_revalidation_mark ();
726       do_sync ();
727     }
728   else
729     {
730       tdbio_invalid ();
731     }
732 }
733
734 static void
735 update_min_ownertrust (u32 *kid, unsigned int new_trust )
736 {
737   PKT_public_key *pk;
738   TRUSTREC rec;
739   gpg_error_t err;
740
741   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
742     return;
743
744   pk = xmalloc_clear (sizeof *pk);
745   err = get_pubkey (pk, kid);
746   if (err)
747     {
748       log_error (_("public key %s not found: %s\n"),
749                  keystr (kid), gpg_strerror (err));
750       return;
751     }
752
753   err = read_trust_record (pk, &rec);
754   if (!err)
755     {
756       if (DBG_TRUST)
757         log_debug ("key %08lX%08lX: update min_ownertrust from %u to %u\n",
758                    (ulong)kid[0],(ulong)kid[1],
759                    (unsigned int)rec.r.trust.min_ownertrust,
760                    new_trust );
761       if (rec.r.trust.min_ownertrust != new_trust)
762         {
763           rec.r.trust.min_ownertrust = new_trust;
764           write_record( &rec );
765           tdb_revalidation_mark ();
766           do_sync ();
767         }
768     }
769   else if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
770     { /* no record yet - create a new one */
771       size_t dummy;
772
773       if (DBG_TRUST)
774         log_debug ("insert min_ownertrust %u\n", new_trust );
775
776       memset (&rec, 0, sizeof rec);
777       rec.recnum = tdbio_new_recnum ();
778       rec.rectype = RECTYPE_TRUST;
779       fingerprint_from_pk (pk, rec.r.trust.fingerprint, &dummy);
780       rec.r.trust.min_ownertrust = new_trust;
781       write_record (&rec);
782       tdb_revalidation_mark ();
783       do_sync ();
784     }
785   else
786     {
787       tdbio_invalid ();
788     }
789 }
790
791
792 /*
793  * Clear the ownertrust and min_ownertrust values.
794  *
795  * Return: True if a change actually happened.
796  */
797 int
798 tdb_clear_ownertrusts (PKT_public_key *pk)
799 {
800   TRUSTREC rec;
801   gpg_error_t err;
802
803   init_trustdb ();
804
805   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
806     return 0;
807
808   err = read_trust_record (pk, &rec);
809   if (!err)
810     {
811       if (DBG_TRUST)
812         {
813           log_debug ("clearing ownertrust (old value %u)\n",
814                      (unsigned int)rec.r.trust.ownertrust);
815           log_debug ("clearing min_ownertrust (old value %u)\n",
816                      (unsigned int)rec.r.trust.min_ownertrust);
817         }
818       if (rec.r.trust.ownertrust || rec.r.trust.min_ownertrust)
819         {
820           rec.r.trust.ownertrust = 0;
821           rec.r.trust.min_ownertrust = 0;
822           write_record( &rec );
823           tdb_revalidation_mark ();
824           do_sync ();
825           return 1;
826         }
827     }
828   else if (gpg_err_code (err) != GPG_ERR_NOT_FOUND)
829     {
830       tdbio_invalid ();
831     }
832   return 0;
833 }
834
835 /*
836  * Note: Caller has to do a sync
837  */
838 static void
839 update_validity (PKT_public_key *pk, PKT_user_id *uid,
840                  int depth, int validity)
841 {
842   TRUSTREC trec, vrec;
843   gpg_error_t err;
844   ulong recno;
845
846   namehash_from_uid(uid);
847
848   err = read_trust_record (pk, &trec);
849   if (err && gpg_err_code (err) != GPG_ERR_NOT_FOUND)
850     {
851       tdbio_invalid ();
852       return;
853     }
854   if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
855     {
856       /* No record yet - create a new one. */
857       size_t dummy;
858
859       memset (&trec, 0, sizeof trec);
860       trec.recnum = tdbio_new_recnum ();
861       trec.rectype = RECTYPE_TRUST;
862       fingerprint_from_pk (pk, trec.r.trust.fingerprint, &dummy);
863       trec.r.trust.ownertrust = 0;
864       }
865
866   /* locate an existing one */
867   recno = trec.r.trust.validlist;
868   while (recno)
869     {
870       read_record (recno, &vrec, RECTYPE_VALID);
871       if ( !memcmp (vrec.r.valid.namehash, uid->namehash, 20) )
872         break;
873       recno = vrec.r.valid.next;
874     }
875
876   if (!recno) /* insert a new validity record */
877     {
878       memset (&vrec, 0, sizeof vrec);
879       vrec.recnum = tdbio_new_recnum ();
880       vrec.rectype = RECTYPE_VALID;
881       memcpy (vrec.r.valid.namehash, uid->namehash, 20);
882       vrec.r.valid.next = trec.r.trust.validlist;
883       trec.r.trust.validlist = vrec.recnum;
884     }
885   vrec.r.valid.validity = validity;
886   vrec.r.valid.full_count = uid->help_full_count;
887   vrec.r.valid.marginal_count = uid->help_marginal_count;
888   write_record (&vrec);
889   trec.r.trust.depth = depth;
890   write_record (&trec);
891 }
892
893
894 /***********************************************
895  *********  Query trustdb values  **************
896  ***********************************************/
897
898 /* Return true if key is disabled.  Note that this is usually used via
899    the pk_is_disabled macro.  */
900 int
901 tdb_cache_disabled_value (PKT_public_key *pk)
902 {
903   gpg_error_t err;
904   TRUSTREC trec;
905   int disabled = 0;
906
907   if (pk->flags.disabled_valid)
908     return pk->flags.disabled;
909
910   init_trustdb();
911
912   if (trustdb_args.no_trustdb)
913     return 0;  /* No trustdb => not disabled.  */
914
915   err = read_trust_record (pk, &trec);
916   if (err && gpg_err_code (err) != GPG_ERR_NOT_FOUND)
917     {
918       tdbio_invalid ();
919       goto leave;
920     }
921   if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
922     {
923       /* No record found, so assume not disabled.  */
924       goto leave;
925     }
926
927   if ((trec.r.trust.ownertrust & TRUST_FLAG_DISABLED))
928     disabled = 1;
929
930   /* Cache it for later so we don't need to look at the trustdb every
931      time */
932   pk->flags.disabled = disabled;
933   pk->flags.disabled_valid = 1;
934
935  leave:
936   return disabled;
937 }
938
939
940 void
941 tdb_check_trustdb_stale (void)
942 {
943   static int did_nextcheck=0;
944
945   init_trustdb ();
946
947   if (trustdb_args.no_trustdb)
948     return;  /* No trustdb => can't be stale.  */
949
950   if (!did_nextcheck
951       && (opt.trust_model == TM_PGP || opt.trust_model == TM_CLASSIC
952           || opt.trust_model == TM_TOFU_PGP || opt.trust_model == TM_TOFU))
953     {
954       ulong scheduled;
955
956       did_nextcheck = 1;
957       scheduled = tdbio_read_nextcheck ();
958       if ((scheduled && scheduled <= make_timestamp ())
959           || pending_check_trustdb)
960         {
961           if (opt.no_auto_check_trustdb)
962             {
963               pending_check_trustdb = 1;
964               if (!opt.quiet)
965                 log_info (_("please do a --check-trustdb\n"));
966             }
967           else
968             {
969               if (!opt.quiet)
970                 log_info (_("checking the trustdb\n"));
971               validate_keys (0);
972             }
973         }
974     }
975 }
976
977 /*
978  * Return the validity information for PK.  This is the core of
979  * get_validity.  If SIG is not NULL, then the trust is being
980  * evaluated in the context of the provided signature.  This is used
981  * by the TOFU code to record statistics.
982  */
983 unsigned int
984 tdb_get_validity_core (PKT_public_key *pk, PKT_user_id *uid,
985                        PKT_public_key *main_pk,
986                        PKT_signature *sig,
987                        int may_ask)
988 {
989   TRUSTREC trec, vrec;
990   gpg_error_t err;
991   ulong recno;
992 #ifdef USE_TOFU
993   unsigned int tofu_validity = TRUST_UNKNOWN;
994 #endif
995   unsigned int validity = TRUST_UNKNOWN;
996
997 #ifndef USE_TOFU
998   (void)sig;
999   (void)may_ask;
1000 #endif
1001
1002   init_trustdb ();
1003
1004   /* If we have no trustdb (which also means it has not been created)
1005      and the trust-model is always, we don't know the validity -
1006      return immediately.  If we won't do that the tdbio code would try
1007      to open the trustdb and run into a fatal error.  */
1008   if (trustdb_args.no_trustdb && opt.trust_model == TM_ALWAYS)
1009     return TRUST_UNKNOWN;
1010
1011   check_trustdb_stale();
1012
1013   if(opt.trust_model==TM_DIRECT)
1014     {
1015       /* Note that this happens BEFORE any user ID stuff is checked.
1016          The direct trust model applies to keys as a whole. */
1017       validity = tdb_get_ownertrust (main_pk);
1018       goto leave;
1019     }
1020
1021 #ifdef USE_TOFU
1022   if (opt.trust_model == TM_TOFU || opt.trust_model == TM_TOFU_PGP)
1023     {
1024       kbnode_t user_id_node = NULL; /* Silence -Wmaybe-uninitialized.  */
1025       int user_ids = 0;
1026       int user_ids_expired = 0;
1027
1028       /* If the caller didn't supply a user id then iterate over all
1029          uids.  */
1030       if (! uid)
1031         user_id_node = get_pubkeyblock (main_pk->keyid);
1032
1033       while (uid
1034              || (user_id_node = find_next_kbnode (user_id_node, PKT_USER_ID)))
1035         {
1036           unsigned int tl;
1037           PKT_user_id *user_id;
1038
1039           if (uid)
1040             user_id = uid;
1041           else
1042             user_id = user_id_node->pkt->pkt.user_id;
1043
1044           /* If the user id is revoked or expired, then skip it.  */
1045           if (user_id->is_revoked || user_id->is_expired)
1046             {
1047               if (DBG_TRUST)
1048                 {
1049                   char *s;
1050                   if (user_id->is_revoked && user_id->is_expired)
1051                     s = "revoked and expired";
1052                   else if (user_id->is_revoked)
1053                     s = "revoked";
1054                   else
1055                     s = "expire";
1056
1057                   log_debug ("TOFU: Ignoring %s user id (%s)\n",
1058                              s, user_id->name);
1059                 }
1060
1061               continue;
1062             }
1063
1064           user_ids ++;
1065
1066           if (sig)
1067             tl = tofu_register (main_pk, user_id->name,
1068                                 sig->digest, sig->digest_len,
1069                                 sig->timestamp, "unknown",
1070                                 may_ask);
1071           else
1072             tl = tofu_get_validity (main_pk, user_id->name, may_ask);
1073
1074           if (tl == TRUST_EXPIRED)
1075             user_ids_expired ++;
1076           else if (tl == TRUST_UNDEFINED || tl == TRUST_UNKNOWN)
1077             ;
1078           else if (tl == TRUST_NEVER)
1079             tofu_validity = TRUST_NEVER;
1080           else
1081             {
1082               log_assert (tl == TRUST_MARGINAL
1083                           || tl == TRUST_FULLY
1084                           || tl == TRUST_ULTIMATE);
1085
1086               if (tl > tofu_validity)
1087                 /* XXX: We we really want the max?  */
1088                 tofu_validity = tl;
1089             }
1090
1091           if (uid)
1092             /* If the caller specified a user id, then we stop
1093                now.  */
1094             break;
1095         }
1096     }
1097 #endif /*USE_TOFU*/
1098
1099   if (opt.trust_model == TM_TOFU_PGP
1100       || opt.trust_model == TM_CLASSIC
1101       || opt.trust_model == TM_PGP)
1102     {
1103       err = read_trust_record (main_pk, &trec);
1104       if (err && gpg_err_code (err) != GPG_ERR_NOT_FOUND)
1105         {
1106           tdbio_invalid ();
1107           return 0;
1108         }
1109       if (gpg_err_code (err) == GPG_ERR_NOT_FOUND)
1110         {
1111           /* No record found.  */
1112           validity = TRUST_UNKNOWN;
1113           goto leave;
1114         }
1115
1116       /* Loop over all user IDs */
1117       recno = trec.r.trust.validlist;
1118       validity = 0;
1119       while (recno)
1120         {
1121           read_record (recno, &vrec, RECTYPE_VALID);
1122
1123           if(uid)
1124             {
1125               /* If a user ID is given we return the validity for that
1126                  user ID ONLY.  If the namehash is not found, then
1127                  there is no validity at all (i.e. the user ID wasn't
1128                  signed). */
1129               if(memcmp(vrec.r.valid.namehash,uid->namehash,20)==0)
1130                 {
1131                   validity=(vrec.r.valid.validity & TRUST_MASK);
1132                   break;
1133                 }
1134             }
1135           else
1136             {
1137               /* If no user ID is given, we take the maximum validity
1138                  over all user IDs */
1139               if (validity < (vrec.r.valid.validity & TRUST_MASK))
1140                 validity = (vrec.r.valid.validity & TRUST_MASK);
1141             }
1142
1143           recno = vrec.r.valid.next;
1144         }
1145
1146       if ((trec.r.trust.ownertrust & TRUST_FLAG_DISABLED))
1147         {
1148           validity |= TRUST_FLAG_DISABLED;
1149           pk->flags.disabled = 1;
1150         }
1151       else
1152         pk->flags.disabled = 0;
1153       pk->flags.disabled_valid = 1;
1154     }
1155
1156  leave:
1157 #ifdef USE_TOFU
1158   validity = tofu_wot_trust_combine (tofu_validity, validity);
1159 #else /*!USE_TOFU*/
1160   validity &= TRUST_MASK;
1161
1162   if (validity == TRUST_NEVER)
1163     /* TRUST_NEVER trumps everything else.  */
1164     validity |= TRUST_NEVER;
1165   if (validity == TRUST_EXPIRED)
1166     /* TRUST_EXPIRED trumps everything but TRUST_NEVER.  */
1167     validity |= TRUST_EXPIRED;
1168 #endif /*!USE_TOFU*/
1169
1170   if (opt.trust_model != TM_TOFU
1171       && pending_check_trustdb)
1172     validity |= TRUST_FLAG_PENDING_CHECK;
1173
1174   return validity;
1175 }
1176
1177
1178 static void
1179 get_validity_counts (PKT_public_key *pk, PKT_user_id *uid)
1180 {
1181   TRUSTREC trec, vrec;
1182   ulong recno;
1183
1184   if(pk==NULL || uid==NULL)
1185     BUG();
1186
1187   namehash_from_uid(uid);
1188
1189   uid->help_marginal_count=uid->help_full_count=0;
1190
1191   init_trustdb ();
1192
1193   if(read_trust_record (pk, &trec))
1194     return;
1195
1196   /* loop over all user IDs */
1197   recno = trec.r.trust.validlist;
1198   while (recno)
1199     {
1200       read_record (recno, &vrec, RECTYPE_VALID);
1201
1202       if(memcmp(vrec.r.valid.namehash,uid->namehash,20)==0)
1203         {
1204           uid->help_marginal_count=vrec.r.valid.marginal_count;
1205           uid->help_full_count=vrec.r.valid.full_count;
1206           /*  es_printf("Fetched marginal %d, full %d\n",uid->help_marginal_count,uid->help_full_count); */
1207           break;
1208         }
1209
1210       recno = vrec.r.valid.next;
1211     }
1212 }
1213
1214 void
1215 list_trust_path( const char *username )
1216 {
1217   (void)username;
1218 }
1219
1220 /****************
1221  * Enumerate all keys, which are needed to build all trust paths for
1222  * the given key.  This function does not return the key itself or
1223  * the ultimate key (the last point in cerificate chain).  Only
1224  * certificate chains which ends up at an ultimately trusted key
1225  * are listed.  If ownertrust or validity is not NULL, the corresponding
1226  * value for the returned LID is also returned in these variable(s).
1227  *
1228  *  1) create a void pointer and initialize it to NULL
1229  *  2) pass this void pointer by reference to this function.
1230  *     Set lid to the key you want to enumerate and pass it by reference.
1231  *  3) call this function as long as it does not return -1
1232  *     to indicate EOF. LID does contain the next key used to build the web
1233  *  4) Always call this function a last time with LID set to NULL,
1234  *     so that it can free its context.
1235  *
1236  * Returns: -1 on EOF or the level of the returned LID
1237  */
1238 int
1239 enum_cert_paths( void **context, ulong *lid,
1240                  unsigned *ownertrust, unsigned *validity )
1241 {
1242   (void)context;
1243   (void)lid;
1244   (void)ownertrust;
1245   (void)validity;
1246   return -1;
1247 }
1248
1249
1250 /****************
1251  * Print the current path
1252  */
1253 void
1254 enum_cert_paths_print (void **context, FILE *fp,
1255                        int refresh, ulong selected_lid)
1256 {
1257   (void)context;
1258   (void)fp;
1259   (void)refresh;
1260   (void)selected_lid;
1261 }
1262
1263
1264 \f
1265 /****************************************
1266  *********** NEW NEW NEW ****************
1267  ****************************************/
1268
1269 static int
1270 ask_ownertrust (u32 *kid,int minimum)
1271 {
1272   PKT_public_key *pk;
1273   int rc;
1274   int ot;
1275
1276   pk = xmalloc_clear (sizeof *pk);
1277   rc = get_pubkey (pk, kid);
1278   if (rc)
1279     {
1280       log_error (_("public key %s not found: %s\n"),
1281                  keystr(kid), gpg_strerror (rc) );
1282       return TRUST_UNKNOWN;
1283     }
1284
1285   if(opt.force_ownertrust)
1286     {
1287       log_info("force trust for key %s to %s\n",
1288                keystr(kid),trust_value_to_string(opt.force_ownertrust));
1289       tdb_update_ownertrust (pk, opt.force_ownertrust);
1290       ot=opt.force_ownertrust;
1291     }
1292   else
1293     {
1294       ot=edit_ownertrust(pk,0);
1295       if(ot>0)
1296         ot = tdb_get_ownertrust (pk);
1297       else if(ot==0)
1298         ot = minimum?minimum:TRUST_UNDEFINED;
1299       else
1300         ot = -1; /* quit */
1301     }
1302
1303   free_public_key( pk );
1304
1305   return ot;
1306 }
1307
1308
1309 static void
1310 mark_keyblock_seen (KeyHashTable tbl, KBNODE node)
1311 {
1312   for ( ;node; node = node->next )
1313     if (node->pkt->pkttype == PKT_PUBLIC_KEY
1314         || node->pkt->pkttype == PKT_PUBLIC_SUBKEY)
1315       {
1316         u32 aki[2];
1317
1318         keyid_from_pk (node->pkt->pkt.public_key, aki);
1319         add_key_hash_table (tbl, aki);
1320       }
1321 }
1322
1323
1324 static void
1325 dump_key_array (int depth, struct key_array *keys)
1326 {
1327   struct key_array *kar;
1328
1329   for (kar=keys; kar->keyblock; kar++)
1330     {
1331       KBNODE node = kar->keyblock;
1332       u32 kid[2];
1333
1334       keyid_from_pk(node->pkt->pkt.public_key, kid);
1335       es_printf ("%d:%08lX%08lX:K::%c::::\n",
1336                  depth, (ulong)kid[0], (ulong)kid[1], '?');
1337
1338       for (; node; node = node->next)
1339         {
1340           if (node->pkt->pkttype == PKT_USER_ID)
1341             {
1342               int len = node->pkt->pkt.user_id->len;
1343
1344               if (len > 30)
1345                 len = 30;
1346               es_printf ("%d:%08lX%08lX:U:::%c:::",
1347                          depth, (ulong)kid[0], (ulong)kid[1],
1348                          (node->flag & 4)? 'f':
1349                          (node->flag & 2)? 'm':
1350                          (node->flag & 1)? 'q':'-');
1351               es_write_sanitized (es_stdout, node->pkt->pkt.user_id->name,
1352                                   len, ":", NULL);
1353               es_putc (':', es_stdout);
1354               es_putc ('\n', es_stdout);
1355             }
1356         }
1357     }
1358 }
1359
1360
1361 static void
1362 store_validation_status (int depth, KBNODE keyblock, KeyHashTable stored)
1363 {
1364   KBNODE node;
1365   int status;
1366   int any = 0;
1367
1368   for (node=keyblock; node; node = node->next)
1369     {
1370       if (node->pkt->pkttype == PKT_USER_ID)
1371         {
1372           PKT_user_id *uid = node->pkt->pkt.user_id;
1373           if (node->flag & 4)
1374             status = TRUST_FULLY;
1375           else if (node->flag & 2)
1376             status = TRUST_MARGINAL;
1377           else if (node->flag & 1)
1378             status = TRUST_UNDEFINED;
1379           else
1380             status = 0;
1381
1382           if (status)
1383             {
1384               update_validity (keyblock->pkt->pkt.public_key,
1385                                uid, depth, status);
1386
1387               mark_keyblock_seen(stored,keyblock);
1388
1389               any = 1;
1390             }
1391         }
1392     }
1393
1394   if (any)
1395     do_sync ();
1396 }
1397
1398
1399 /* Returns a sanitized copy of the regexp (which might be "", but not
1400    NULL). */
1401 #ifndef DISABLE_REGEX
1402 static char *
1403 sanitize_regexp(const char *old)
1404 {
1405   size_t start=0,len=strlen(old),idx=0;
1406   int escaped=0,standard_bracket=0;
1407   char *new=xmalloc((len*2)+1); /* enough to \-escape everything if we
1408                                    have to */
1409
1410   /* There are basically two commonly-used regexps here.  GPG and most
1411      versions of PGP use "<[^>]+[@.]example\.com>$" and PGP (9)
1412      command line uses "example.com" (i.e. whatever the user specfies,
1413      and we can't expect users know to use "\." instead of ".").  So
1414      here are the rules: we're allowed to start with "<[^>]+[@.]" and
1415      end with ">$" or start and end with nothing.  In between, the
1416      only legal regex character is ".", and everything else gets
1417      escaped.  Part of the gotcha here is that some regex packages
1418      allow more than RFC-4880 requires.  For example, 4880 has no "{}"
1419      operator, but GNU regex does.  Commenting removes these operators
1420      from consideration.  A possible future enhancement is to use
1421      commenting to effectively back off a given regex to the Henry
1422      Spencer syntax in 4880. -dshaw */
1423
1424   /* Are we bracketed between "<[^>]+[@.]" and ">$" ? */
1425   if(len>=12 && strncmp(old,"<[^>]+[@.]",10)==0
1426      && old[len-2]=='>' && old[len-1]=='$')
1427     {
1428       strcpy(new,"<[^>]+[@.]");
1429       idx=strlen(new);
1430       standard_bracket=1;
1431       start+=10;
1432       len-=2;
1433     }
1434
1435   /* Walk the remaining characters and ensure that everything that is
1436      left is not an operational regex character. */
1437   for(;start<len;start++)
1438     {
1439       if(!escaped && old[start]=='\\')
1440         escaped=1;
1441       else if(!escaped && old[start]!='.')
1442         new[idx++]='\\';
1443       else
1444         escaped=0;
1445
1446       new[idx++]=old[start];
1447     }
1448
1449   new[idx]='\0';
1450
1451   /* Note that the (sub)string we look at might end with a bare "\".
1452      If it does, leave it that way.  If the regexp actually ended with
1453      ">$", then it was escaping the ">" and is fine.  If the regexp
1454      actually ended with the bare "\", then it's an illegal regexp and
1455      regcomp should kick it out. */
1456
1457   if(standard_bracket)
1458     strcat(new,">$");
1459
1460   return new;
1461 }
1462 #endif /*!DISABLE_REGEX*/
1463
1464 /* Used by validate_one_keyblock to confirm a regexp within a trust
1465    signature.  Returns 1 for match, and 0 for no match or regex
1466    error. */
1467 static int
1468 check_regexp(const char *expr,const char *string)
1469 {
1470 #ifdef DISABLE_REGEX
1471   (void)expr;
1472   (void)string;
1473   /* When DISABLE_REGEX is defined, assume all regexps do not
1474      match. */
1475   return 0;
1476 #else
1477   int ret;
1478   char *regexp;
1479
1480   regexp=sanitize_regexp(expr);
1481
1482 #ifdef __riscos__
1483   ret=riscos_check_regexp(expr, string, DBG_TRUST);
1484 #else
1485   {
1486     regex_t pat;
1487
1488     ret=regcomp(&pat,regexp,REG_ICASE|REG_NOSUB|REG_EXTENDED);
1489     if(ret==0)
1490       {
1491         ret=regexec(&pat,string,0,NULL,0);
1492         regfree(&pat);
1493         ret=(ret==0);
1494       }
1495   }
1496 #endif
1497
1498   if(DBG_TRUST)
1499     log_debug("regexp '%s' ('%s') on '%s': %s\n",
1500               regexp,expr,string,ret==0?"YES":"NO");
1501
1502   xfree(regexp);
1503
1504   return ret;
1505 #endif
1506 }
1507
1508 /*
1509  * Return true if the key is signed by one of the keys in the given
1510  * key ID list.  User IDs with a valid signature are marked by node
1511  * flags as follows:
1512  *  flag bit 0: There is at least one signature
1513  *           1: There is marginal confidence that this is a legitimate uid
1514  *           2: There is full confidence that this is a legitimate uid.
1515  *           8: Used for internal purposes.
1516  *           9: Ditto (in mark_usable_uid_certs())
1517  *          10: Ditto (ditto)
1518  * This function assumes that all kbnode flags are cleared on entry.
1519  */
1520 static int
1521 validate_one_keyblock (KBNODE kb, struct key_item *klist,
1522                        u32 curtime, u32 *next_expire)
1523 {
1524   struct key_item *kr;
1525   KBNODE node, uidnode=NULL;
1526   PKT_user_id *uid=NULL;
1527   PKT_public_key *pk = kb->pkt->pkt.public_key;
1528   u32 main_kid[2];
1529   int issigned=0, any_signed = 0;
1530
1531   keyid_from_pk(pk, main_kid);
1532   for (node=kb; node; node = node->next)
1533     {
1534       /* A bit of discussion here: is it better for the web of trust
1535          to be built among only self-signed uids?  On the one hand, a
1536          self-signed uid is a statement that the key owner definitely
1537          intended that uid to be there, but on the other hand, a
1538          signed (but not self-signed) uid does carry trust, of a sort,
1539          even if it is a statement being made by people other than the
1540          key owner "through" the uids on the key owner's key.  I'm
1541          going with the latter.  However, if the user ID was
1542          explicitly revoked, or passively allowed to expire, that
1543          should stop validity through the user ID until it is
1544          resigned.  -dshaw */
1545
1546       if (node->pkt->pkttype == PKT_USER_ID
1547           && !node->pkt->pkt.user_id->is_revoked
1548           && !node->pkt->pkt.user_id->is_expired)
1549         {
1550           if (uidnode && issigned)
1551             {
1552               if (uid->help_full_count >= opt.completes_needed
1553                   || uid->help_marginal_count >= opt.marginals_needed )
1554                 uidnode->flag |= 4;
1555               else if (uid->help_full_count || uid->help_marginal_count)
1556                 uidnode->flag |= 2;
1557               uidnode->flag |= 1;
1558               any_signed = 1;
1559             }
1560           uidnode = node;
1561           uid=uidnode->pkt->pkt.user_id;
1562
1563           /* If the selfsig is going to expire... */
1564           if(uid->expiredate && uid->expiredate<*next_expire)
1565             *next_expire = uid->expiredate;
1566
1567           issigned = 0;
1568           get_validity_counts(pk,uid);
1569           mark_usable_uid_certs (kb, uidnode, main_kid, klist,
1570                                  curtime, next_expire);
1571         }
1572       else if (node->pkt->pkttype == PKT_SIGNATURE
1573                && (node->flag & (1<<8)) && uid)
1574         {
1575           /* Note that we are only seeing unrevoked sigs here */
1576           PKT_signature *sig = node->pkt->pkt.signature;
1577
1578           kr = is_in_klist (klist, sig);
1579           /* If the trust_regexp does not match, it's as if the sig
1580              did not exist.  This is safe for non-trust sigs as well
1581              since we don't accept a regexp on the sig unless it's a
1582              trust sig. */
1583           if (kr && (!kr->trust_regexp
1584                      || !(opt.trust_model == TM_PGP
1585                           || opt.trust_model == TM_TOFU_PGP)
1586                      || (uidnode
1587                          && check_regexp(kr->trust_regexp,
1588                                          uidnode->pkt->pkt.user_id->name))))
1589             {
1590               /* Are we part of a trust sig chain?  We always favor
1591                  the latest trust sig, rather than the greater or
1592                  lesser trust sig or value.  I could make a decent
1593                  argument for any of these cases, but this seems to be
1594                  what PGP does, and I'd like to be compatible. -dms */
1595               if ((opt.trust_model == TM_PGP
1596                    || opt.trust_model == TM_TOFU_PGP)
1597                   && sig->trust_depth
1598                   && pk->trust_timestamp <= sig->timestamp)
1599                 {
1600                   unsigned char depth;
1601
1602                   /* If the depth on the signature is less than the
1603                      chain currently has, then use the signature depth
1604                      so we don't increase the depth beyond what the
1605                      signer wanted.  If the depth on the signature is
1606                      more than the chain currently has, then use the
1607                      chain depth so we use as much of the signature
1608                      depth as the chain will permit.  An ultimately
1609                      trusted signature can restart the depth to
1610                      whatever level it likes. */
1611
1612                   if (sig->trust_depth < kr->trust_depth
1613                       || kr->ownertrust == TRUST_ULTIMATE)
1614                     depth = sig->trust_depth;
1615                   else
1616                     depth = kr->trust_depth;
1617
1618                   if (depth)
1619                     {
1620                       if(DBG_TRUST)
1621                         log_debug ("trust sig on %s, sig depth is %d,"
1622                                    " kr depth is %d\n",
1623                                    uidnode->pkt->pkt.user_id->name,
1624                                    sig->trust_depth,
1625                                    kr->trust_depth);
1626
1627                       /* If we got here, we know that:
1628
1629                          this is a trust sig.
1630
1631                          it's a newer trust sig than any previous trust
1632                          sig on this key (not uid).
1633
1634                          it is legal in that it was either generated by an
1635                          ultimate key, or a key that was part of a trust
1636                          chain, and the depth does not violate the
1637                          original trust sig.
1638
1639                          if there is a regexp attached, it matched
1640                          successfully.
1641                       */
1642
1643                       if (DBG_TRUST)
1644                         log_debug ("replacing trust value %d with %d and "
1645                                    "depth %d with %d\n",
1646                                    pk->trust_value,sig->trust_value,
1647                                    pk->trust_depth,depth);
1648
1649                       pk->trust_value = sig->trust_value;
1650                       pk->trust_depth = depth-1;
1651
1652                       /* If the trust sig contains a regexp, record it
1653                          on the pk for the next round. */
1654                       if (sig->trust_regexp)
1655                         pk->trust_regexp = sig->trust_regexp;
1656                     }
1657                 }
1658
1659               if (kr->ownertrust == TRUST_ULTIMATE)
1660                 uid->help_full_count = opt.completes_needed;
1661               else if (kr->ownertrust == TRUST_FULLY)
1662                 uid->help_full_count++;
1663               else if (kr->ownertrust == TRUST_MARGINAL)
1664                 uid->help_marginal_count++;
1665               issigned = 1;
1666             }
1667         }
1668     }
1669
1670   if (uidnode && issigned)
1671     {
1672       if (uid->help_full_count >= opt.completes_needed
1673           || uid->help_marginal_count >= opt.marginals_needed )
1674         uidnode->flag |= 4;
1675       else if (uid->help_full_count || uid->help_marginal_count)
1676         uidnode->flag |= 2;
1677       uidnode->flag |= 1;
1678       any_signed = 1;
1679     }
1680
1681   return any_signed;
1682 }
1683
1684
1685 static int
1686 search_skipfnc (void *opaque, u32 *kid, int dummy_uid_no)
1687 {
1688   (void)dummy_uid_no;
1689   return test_key_hash_table ((KeyHashTable)opaque, kid);
1690 }
1691
1692
1693 /*
1694  * Scan all keys and return a key_array of all suitable keys from
1695  * kllist.  The caller has to pass keydb handle so that we don't use
1696  * to create our own.  Returns either a key_array or NULL in case of
1697  * an error.  No results found are indicated by an empty array.
1698  * Caller hast to release the returned array.
1699  */
1700 static struct key_array *
1701 validate_key_list (KEYDB_HANDLE hd, KeyHashTable full_trust,
1702                    struct key_item *klist, u32 curtime, u32 *next_expire)
1703 {
1704   KBNODE keyblock = NULL;
1705   struct key_array *keys = NULL;
1706   size_t nkeys, maxkeys;
1707   int rc;
1708   KEYDB_SEARCH_DESC desc;
1709
1710   maxkeys = 1000;
1711   keys = xmalloc ((maxkeys+1) * sizeof *keys);
1712   nkeys = 0;
1713
1714   rc = keydb_search_reset (hd);
1715   if (rc)
1716     {
1717       log_error ("keydb_search_reset failed: %s\n", gpg_strerror (rc));
1718       xfree (keys);
1719       return NULL;
1720     }
1721
1722   memset (&desc, 0, sizeof desc);
1723   desc.mode = KEYDB_SEARCH_MODE_FIRST;
1724   desc.skipfnc = search_skipfnc;
1725   desc.skipfncvalue = full_trust;
1726   rc = keydb_search (hd, &desc, 1, NULL);
1727   if (gpg_err_code (rc) == GPG_ERR_NOT_FOUND)
1728     {
1729       keys[nkeys].keyblock = NULL;
1730       return keys;
1731     }
1732   if (rc)
1733     {
1734       log_error ("keydb_search(first) failed: %s\n", gpg_strerror (rc));
1735       goto die;
1736     }
1737
1738   desc.mode = KEYDB_SEARCH_MODE_NEXT; /* change mode */
1739   do
1740     {
1741       PKT_public_key *pk;
1742
1743       rc = keydb_get_keyblock (hd, &keyblock);
1744       if (rc)
1745         {
1746           log_error ("keydb_get_keyblock failed: %s\n", gpg_strerror (rc));
1747           goto die;
1748         }
1749
1750       if ( keyblock->pkt->pkttype != PKT_PUBLIC_KEY)
1751         {
1752           log_debug ("ooops: invalid pkttype %d encountered\n",
1753                      keyblock->pkt->pkttype);
1754           dump_kbnode (keyblock);
1755           release_kbnode(keyblock);
1756           continue;
1757         }
1758
1759       /* prepare the keyblock for further processing */
1760       merge_keys_and_selfsig (keyblock);
1761       clear_kbnode_flags (keyblock);
1762       pk = keyblock->pkt->pkt.public_key;
1763       if (pk->has_expired || pk->flags.revoked)
1764         {
1765           /* it does not make sense to look further at those keys */
1766           mark_keyblock_seen (full_trust, keyblock);
1767         }
1768       else if (validate_one_keyblock (keyblock, klist, curtime, next_expire))
1769         {
1770           KBNODE node;
1771
1772           if (pk->expiredate && pk->expiredate >= curtime
1773               && pk->expiredate < *next_expire)
1774             *next_expire = pk->expiredate;
1775
1776           if (nkeys == maxkeys) {
1777             maxkeys += 1000;
1778             keys = xrealloc (keys, (maxkeys+1) * sizeof *keys);
1779           }
1780           keys[nkeys++].keyblock = keyblock;
1781
1782           /* Optimization - if all uids are fully trusted, then we
1783              never need to consider this key as a candidate again. */
1784
1785           for (node=keyblock; node; node = node->next)
1786             if (node->pkt->pkttype == PKT_USER_ID && !(node->flag & 4))
1787               break;
1788
1789           if(node==NULL)
1790             mark_keyblock_seen (full_trust, keyblock);
1791
1792           keyblock = NULL;
1793         }
1794
1795       release_kbnode (keyblock);
1796       keyblock = NULL;
1797     }
1798   while (!(rc = keydb_search (hd, &desc, 1, NULL)));
1799
1800   if (rc && gpg_err_code (rc) != GPG_ERR_NOT_FOUND)
1801     {
1802       log_error ("keydb_search_next failed: %s\n", gpg_strerror (rc));
1803       goto die;
1804     }
1805
1806   keys[nkeys].keyblock = NULL;
1807   return keys;
1808
1809  die:
1810   keys[nkeys].keyblock = NULL;
1811   release_key_array (keys);
1812   return NULL;
1813 }
1814
1815 /* Caller must sync */
1816 static void
1817 reset_trust_records(void)
1818 {
1819   TRUSTREC rec;
1820   ulong recnum;
1821   int count = 0, nreset = 0;
1822
1823   for (recnum=1; !tdbio_read_record (recnum, &rec, 0); recnum++ )
1824     {
1825       if(rec.rectype==RECTYPE_TRUST)
1826         {
1827           count++;
1828           if(rec.r.trust.min_ownertrust)
1829             {
1830               rec.r.trust.min_ownertrust=0;
1831               write_record(&rec);
1832             }
1833
1834         }
1835       else if(rec.rectype==RECTYPE_VALID
1836               && ((rec.r.valid.validity&TRUST_MASK)
1837                   || rec.r.valid.marginal_count
1838                   || rec.r.valid.full_count))
1839         {
1840           rec.r.valid.validity &= ~TRUST_MASK;
1841           rec.r.valid.marginal_count=rec.r.valid.full_count=0;
1842           nreset++;
1843           write_record(&rec);
1844         }
1845
1846     }
1847
1848   if (opt.verbose)
1849     {
1850       log_info (ngettext("%d key processed",
1851                          "%d keys processed",
1852                          count), count);
1853       log_printf (ngettext(" (%d validity count cleared)\n",
1854                            " (%d validity counts cleared)\n",
1855                            nreset), nreset);
1856     }
1857 }
1858
1859 /*
1860  * Run the key validation procedure.
1861  *
1862  * This works this way:
1863  * Step 1: Find all ultimately trusted keys (UTK).
1864  *         mark them all as seen and put them into klist.
1865  * Step 2: loop max_cert_times
1866  * Step 3:   if OWNERTRUST of any key in klist is undefined
1867  *             ask user to assign ownertrust
1868  * Step 4:   Loop over all keys in the keyDB which are not marked seen
1869  * Step 5:     if key is revoked or expired
1870  *                mark key as seen
1871  *                continue loop at Step 4
1872  * Step 6:     For each user ID of that key signed by a key in klist
1873  *                Calculate validity by counting trusted signatures.
1874  *                Set validity of user ID
1875  * Step 7:     If any signed user ID was found
1876  *                mark key as seen
1877  *             End Loop
1878  * Step 8:   Build a new klist from all fully trusted keys from step 6
1879  *           End Loop
1880  *         Ready
1881  *
1882  */
1883 static int
1884 validate_keys (int interactive)
1885 {
1886   int rc = 0;
1887   int quit=0;
1888   struct key_item *klist = NULL;
1889   struct key_item *k;
1890   struct key_array *keys = NULL;
1891   struct key_array *kar;
1892   KEYDB_HANDLE kdb = NULL;
1893   KBNODE node;
1894   int depth;
1895   int ot_unknown, ot_undefined, ot_never, ot_marginal, ot_full, ot_ultimate;
1896   KeyHashTable stored,used,full_trust;
1897   u32 start_time, next_expire;
1898
1899   /* Make sure we have all sigs cached.  TODO: This is going to
1900      require some architectural re-thinking, as it is agonizingly slow.
1901      Perhaps combine this with reset_trust_records(), or only check
1902      the caches on keys that are actually involved in the web of
1903      trust. */
1904   keydb_rebuild_caches(0);
1905
1906   kdb = keydb_new ();
1907   if (!kdb)
1908     return gpg_error_from_syserror ();
1909
1910   start_time = make_timestamp ();
1911   next_expire = 0xffffffff; /* set next expire to the year 2106 */
1912   stored = new_key_hash_table ();
1913   used = new_key_hash_table ();
1914   full_trust = new_key_hash_table ();
1915
1916   reset_trust_records();
1917
1918   /* Fixme: Instead of always building a UTK list, we could just build it
1919    * here when needed */
1920   if (!utk_list)
1921     {
1922       if (!opt.quiet)
1923         log_info (_("no ultimately trusted keys found\n"));
1924       goto leave;
1925     }
1926
1927   /* mark all UTKs as used and fully_trusted and set validity to
1928      ultimate */
1929   for (k=utk_list; k; k = k->next)
1930     {
1931       KBNODE keyblock;
1932       PKT_public_key *pk;
1933
1934       keyblock = get_pubkeyblock (k->kid);
1935       if (!keyblock)
1936         {
1937           log_error (_("public key of ultimately"
1938                        " trusted key %s not found\n"), keystr(k->kid));
1939           continue;
1940         }
1941       mark_keyblock_seen (used, keyblock);
1942       mark_keyblock_seen (stored, keyblock);
1943       mark_keyblock_seen (full_trust, keyblock);
1944       pk = keyblock->pkt->pkt.public_key;
1945       for (node=keyblock; node; node = node->next)
1946         {
1947           if (node->pkt->pkttype == PKT_USER_ID)
1948             update_validity (pk, node->pkt->pkt.user_id, 0, TRUST_ULTIMATE);
1949         }
1950       if ( pk->expiredate && pk->expiredate >= start_time
1951            && pk->expiredate < next_expire)
1952         next_expire = pk->expiredate;
1953
1954       release_kbnode (keyblock);
1955       do_sync ();
1956     }
1957
1958   if (opt.trust_model == TM_TOFU)
1959     /* In the TOFU trust model, we only need to save the ultimately
1960        trusted keys.  */
1961     goto leave;
1962
1963   klist = utk_list;
1964
1965   if (!opt.quiet)
1966     log_info ("marginals needed: %d  completes needed: %d  trust model: %s\n",
1967               opt.marginals_needed, opt.completes_needed,
1968               trust_model_string (opt.trust_model));
1969
1970   for (depth=0; depth < opt.max_cert_depth; depth++)
1971     {
1972       int valids=0,key_count;
1973       /* See whether we should assign ownertrust values to the keys in
1974          klist.  */
1975       ot_unknown = ot_undefined = ot_never = 0;
1976       ot_marginal = ot_full = ot_ultimate = 0;
1977       for (k=klist; k; k = k->next)
1978         {
1979           int min=0;
1980
1981           /* 120 and 60 are as per RFC2440 */
1982           if(k->trust_value>=120)
1983             min=TRUST_FULLY;
1984           else if(k->trust_value>=60)
1985             min=TRUST_MARGINAL;
1986
1987           if(min!=k->min_ownertrust)
1988             update_min_ownertrust(k->kid,min);
1989
1990           if (interactive && k->ownertrust == TRUST_UNKNOWN)
1991             {
1992               k->ownertrust = ask_ownertrust (k->kid,min);
1993
1994               if (k->ownertrust == (unsigned int)(-1))
1995                 {
1996                   quit=1;
1997                   goto leave;
1998                 }
1999             }
2000
2001           /* This can happen during transition from an old trustdb
2002              before trust sigs.  It can also happen if a user uses two
2003              different versions of GnuPG or changes the --trust-model
2004              setting. */
2005           if(k->ownertrust<min)
2006             {
2007               if(DBG_TRUST)
2008                 log_debug("key %08lX%08lX:"
2009                           " overriding ownertrust '%s' with '%s'\n",
2010                           (ulong)k->kid[0],(ulong)k->kid[1],
2011                           trust_value_to_string(k->ownertrust),
2012                           trust_value_to_string(min));
2013
2014               k->ownertrust=min;
2015             }
2016
2017           if (k->ownertrust == TRUST_UNKNOWN)
2018             ot_unknown++;
2019           else if (k->ownertrust == TRUST_UNDEFINED)
2020             ot_undefined++;
2021           else if (k->ownertrust == TRUST_NEVER)
2022             ot_never++;
2023           else if (k->ownertrust == TRUST_MARGINAL)
2024             ot_marginal++;
2025           else if (k->ownertrust == TRUST_FULLY)
2026             ot_full++;
2027           else if (k->ownertrust == TRUST_ULTIMATE)
2028             ot_ultimate++;
2029
2030           valids++;
2031         }
2032
2033       /* Find all keys which are signed by a key in kdlist */
2034       keys = validate_key_list (kdb, full_trust, klist,
2035                                 start_time, &next_expire);
2036       if (!keys)
2037         {
2038           log_error ("validate_key_list failed\n");
2039           rc = GPG_ERR_GENERAL;
2040           goto leave;
2041         }
2042
2043       for (key_count=0, kar=keys; kar->keyblock; kar++, key_count++)
2044         ;
2045
2046       /* Store the calculated valididation status somewhere */
2047       if (opt.verbose > 1 && DBG_TRUST)
2048         dump_key_array (depth, keys);
2049
2050       for (kar=keys; kar->keyblock; kar++)
2051           store_validation_status (depth, kar->keyblock, stored);
2052
2053       if (!opt.quiet)
2054         log_info (_("depth: %d  valid: %3d  signed: %3d"
2055                     "  trust: %d-, %dq, %dn, %dm, %df, %du\n"),
2056                   depth, valids, key_count, ot_unknown, ot_undefined,
2057                   ot_never, ot_marginal, ot_full, ot_ultimate );
2058
2059       /* Build a new kdlist from all fully valid keys in KEYS */
2060       if (klist != utk_list)
2061         release_key_items (klist);
2062       klist = NULL;
2063       for (kar=keys; kar->keyblock; kar++)
2064         {
2065           for (node=kar->keyblock; node; node = node->next)
2066             {
2067               if (node->pkt->pkttype == PKT_USER_ID && (node->flag & 4))
2068                 {
2069                   u32 kid[2];
2070
2071                   /* have we used this key already? */
2072                   keyid_from_pk (kar->keyblock->pkt->pkt.public_key, kid);
2073                   if(test_key_hash_table(used,kid)==0)
2074                     {
2075                       /* Normally we add both the primary and subkey
2076                          ids to the hash via mark_keyblock_seen, but
2077                          since we aren't using this hash as a skipfnc,
2078                          that doesn't matter here. */
2079                       add_key_hash_table (used,kid);
2080                       k = new_key_item ();
2081                       k->kid[0]=kid[0];
2082                       k->kid[1]=kid[1];
2083                       k->ownertrust =
2084                         (tdb_get_ownertrust
2085                          (kar->keyblock->pkt->pkt.public_key) & TRUST_MASK);
2086                       k->min_ownertrust = tdb_get_min_ownertrust
2087                         (kar->keyblock->pkt->pkt.public_key);
2088                       k->trust_depth=
2089                         kar->keyblock->pkt->pkt.public_key->trust_depth;
2090                       k->trust_value=
2091                         kar->keyblock->pkt->pkt.public_key->trust_value;
2092                       if(kar->keyblock->pkt->pkt.public_key->trust_regexp)
2093                         k->trust_regexp=
2094                           xstrdup(kar->keyblock->pkt->
2095                                    pkt.public_key->trust_regexp);
2096                       k->next = klist;
2097                       klist = k;
2098                       break;
2099                     }
2100                 }
2101             }
2102         }
2103       release_key_array (keys);
2104       keys = NULL;
2105       if (!klist)
2106         break; /* no need to dive in deeper */
2107     }
2108
2109  leave:
2110   keydb_release (kdb);
2111   release_key_array (keys);
2112   if (klist != utk_list)
2113     release_key_items (klist);
2114   release_key_hash_table (full_trust);
2115   release_key_hash_table (used);
2116   release_key_hash_table (stored);
2117   if (!rc && !quit) /* mark trustDB as checked */
2118     {
2119       int rc2;
2120
2121       if (next_expire == 0xffffffff || next_expire < start_time )
2122         tdbio_write_nextcheck (0);
2123       else
2124         {
2125           tdbio_write_nextcheck (next_expire);
2126           if (!opt.quiet)
2127             log_info (_("next trustdb check due at %s\n"),
2128                       strtimestamp (next_expire));
2129         }
2130
2131       rc2 = tdbio_update_version_record ();
2132       if (rc2)
2133         {
2134           log_error (_("unable to update trustdb version record: "
2135                        "write failed: %s\n"), gpg_strerror (rc2));
2136           tdbio_invalid ();
2137         }
2138
2139       do_sync ();
2140       pending_check_trustdb = 0;
2141     }
2142
2143   return rc;
2144 }