g10/tdbio.h

   1 /* tdbio.h - Trust database I/O functions
   2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2012 Free Software Foundation, Inc.
   3  *
   4  * This file is part of GnuPG.
   5  *
   6  * GnuPG is free software; you can redistribute it and/or modify
   7  * it under the terms of the GNU General Public License as published by
   8  * the Free Software Foundation; either version 3 of the License, or
   9  * (at your option) any later version.
  10  *
  11  * GnuPG is distributed in the hope that it will be useful,
  12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  14  * GNU General Public License for more details.
  15  *
  16  * You should have received a copy of the GNU General Public License
  17  * along with this program; if not, see <https://www.gnu.org/licenses/>.
  18  */
  19
  20 #ifndef G10_TDBIO_H
  21 #define G10_TDBIO_H
  22
  23 #include "host2net.h"
  24
  25 #define TRUST_RECORD_LEN 40
  26 #define SIGS_PER_RECORD         ((TRUST_RECORD_LEN-10)/5)
  27 #define ITEMS_PER_HTBL_RECORD   ((TRUST_RECORD_LEN-2)/4)
  28 #define ITEMS_PER_HLST_RECORD   ((TRUST_RECORD_LEN-6)/5)
  29 #define ITEMS_PER_PREF_RECORD   (TRUST_RECORD_LEN-10)
  30 #if ITEMS_PER_PREF_RECORD % 2
  31 #error ITEMS_PER_PREF_RECORD must be even
  32 #endif
  33 #define MAX_LIST_SIGS_DEPTH  20
  34
  35
  36 #define RECTYPE_VER  1
  37 #define RECTYPE_HTBL 10
  38 #define RECTYPE_HLST 11
  39 #define RECTYPE_TRUST 12
  40 #define RECTYPE_VALID 13
  41 #define RECTYPE_FREE 254
  42
  43
  44 struct trust_record {
  45     int  rectype;
  46     int  mark;
  47     int  dirty;                 /* for now only used internal by functions */
  48     struct trust_record *next;  /* help pointer to build lists in memory */
  49     ulong recnum;
  50     union {
  51         struct {             /* version record: */
  52             byte  version;   /* should be 3 */
  53             byte  marginals;
  54             byte  completes;
  55             byte  cert_depth;
  56             byte  trust_model;
  57             byte  min_cert_level;
  58             ulong created;   /* timestamp of trustdb creation  */
  59             ulong nextcheck; /* timestamp of next scheduled check */
  60             ulong reserved;
  61             ulong reserved2;
  62             ulong firstfree;
  63             ulong reserved3;
  64             ulong trusthashtbl;
  65         } ver;
  66         struct {            /* free record */
  67             ulong next;
  68         } free;
  69         struct {
  70             ulong item[ITEMS_PER_HTBL_RECORD];
  71         } htbl;
  72         struct {
  73             ulong next;
  74             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of another record */
  75         } hlst;
  76       struct {
  77         byte fingerprint[20];
  78         byte ownertrust;
  79         byte depth;
  80         ulong validlist;
  81         byte min_ownertrust;
  82       } trust;
  83       struct {
  84         byte namehash[20];
  85         ulong next;
  86         byte validity;
  87         byte full_count;
  88         byte marginal_count;
  89       } valid;
  90     } r;
  91 };
  92 typedef struct trust_record TRUSTREC;
  93
  94 /*-- tdbio.c --*/
  95 int tdbio_update_version_record(void);
  96 int tdbio_set_dbname( const char *new_dbname, int create, int *r_nofile);
  97 const char *tdbio_get_dbname(void);
  98 void tdbio_dump_record( TRUSTREC *rec, estream_t fp );
  99 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
 100 int tdbio_write_record( TRUSTREC *rec );
 101 int tdbio_db_matches_options(void);
 102 byte tdbio_read_model(void);
 103 ulong tdbio_read_nextcheck (void);
 104 int tdbio_write_nextcheck (ulong stamp);
 105 int tdbio_is_dirty(void);
 106 int tdbio_sync(void);
 107 int tdbio_begin_transaction(void);
 108 int tdbio_end_transaction(void);
 109 int tdbio_cancel_transaction(void);
 110 int tdbio_delete_record( ulong recnum );
 111 ulong tdbio_new_recnum(void);
 112 gpg_error_t tdbio_search_trust_byfpr (const byte *fingerprint, TRUSTREC *rec);
 113 gpg_error_t tdbio_search_trust_bypk (PKT_public_key *pk, TRUSTREC *rec);
 114
 115 void tdbio_how_to_fix (void);
 116 void tdbio_invalid(void);
 117
 118 #endif /*G10_TDBIO_H*/