* photoid.c (get_default_photo_command, show_photos): Honor
[gnupg.git] / g10 / tdbio.h
1 /* tdbio.h - Trust database I/O functions
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002 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 2 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, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef G10_TDBIO_H
22 #define G10_TDBIO_H
23
24 #include "host2net.h"
25
26 #define TRUST_RECORD_LEN 40
27 #define SIGS_PER_RECORD         ((TRUST_RECORD_LEN-10)/5)
28 #define ITEMS_PER_HTBL_RECORD   ((TRUST_RECORD_LEN-2)/4)
29 #define ITEMS_PER_HLST_RECORD   ((TRUST_RECORD_LEN-6)/5)
30 #define ITEMS_PER_PREF_RECORD   (TRUST_RECORD_LEN-10)
31 #if ITEMS_PER_PREF_RECORD % 2
32   #error ITEMS_PER_PREF_RECORD must be even
33 #endif
34 #define MAX_LIST_SIGS_DEPTH  20
35
36
37 #define RECTYPE_VER  1
38 #define RECTYPE_HTBL 10
39 #define RECTYPE_HLST 11
40 #define RECTYPE_TRUST 12
41 #define RECTYPE_VALID 13
42 #define RECTYPE_FREE 254
43
44
45 struct trust_record {
46     int  rectype;
47     int  mark;
48     int  dirty;                 /* for now only used internal by functions */
49     struct trust_record *next;  /* help pointer to build lists in memory */
50     ulong recnum;
51     union {
52         struct {             /* version record: */
53             byte version;    /* should be 3 */
54             byte  marginals;
55             byte  completes;
56             byte  cert_depth;
57             ulong created;   /* timestamp of trustdb creation  */
58             ulong nextcheck; /* timestamp of next scheduled check */
59             ulong reserved;  
60             ulong reserved2;
61             ulong firstfree;
62             ulong reserved3;
63             ulong trusthashtbl;
64         } ver;
65         struct {            /* free record */
66             ulong next;
67         } free;
68         struct {
69             ulong item[ITEMS_PER_HTBL_RECORD];
70         } htbl;
71         struct {
72             ulong next;
73             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of another record */
74         } hlst;
75       struct {
76         byte fingerprint[20];
77         byte ownertrust;
78         byte depth;
79         ulong validlist;
80       } trust;
81       struct {
82         byte namehash[20];
83         ulong next;  
84         byte validity;
85       } valid;
86     } r;
87 };
88 typedef struct trust_record TRUSTREC;
89
90 /*-- tdbio.c --*/
91 int tdbio_set_dbname( const char *new_dbname, int create );
92 const char *tdbio_get_dbname(void);
93 void tdbio_dump_record( TRUSTREC *rec, FILE *fp );
94 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
95 int tdbio_write_record( TRUSTREC *rec );
96 int tdbio_db_matches_options(void);
97 ulong tdbio_read_nextcheck (void);
98 int tdbio_write_nextcheck (ulong stamp);
99 int tdbio_is_dirty(void);
100 int tdbio_sync(void);
101 int tdbio_begin_transaction(void);
102 int tdbio_end_transaction(void);
103 int tdbio_cancel_transaction(void);
104 int tdbio_delete_record( ulong recnum );
105 ulong tdbio_new_recnum(void);
106 int tdbio_search_trust_byfpr(const byte *fingerprint, TRUSTREC *rec );
107 int tdbio_search_trust_bypk(PKT_public_key *pk, TRUSTREC *rec );
108
109 void tdbio_invalid(void);
110
111 #endif /*G10_TDBIO_H*/