62148d361cedc142f4f04f0212467aa1e214a3cc
[gnupg.git] / g10 / tdbio.h
1 /* tdbio.h - Trust database I/O functions
2  *      Copyright (C) 1998 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_DIR  2
39 #define RECTYPE_KEY  3
40 #define RECTYPE_UID  4
41 #define RECTYPE_PREF 5
42 #define RECTYPE_SIG  6
43 #define RECTYPE_SDIR 8
44 #define RECTYPE_CACH 9
45 #define RECTYPE_HTBL 10
46 #define RECTYPE_HLST 11
47 #define RECTYPE_FREE 254
48
49
50 #define DIRF_CHECKED  1 /* has been checked - bits 1,2,3 are valid */
51 #define DIRF_VALID    2 /* This key is valid:  There is at least */
52                         /* one uid with a selfsignature or an revocation */
53 #define DIRF_EXPIRED  4 /* the complete key has expired */
54 #define DIRF_REVOKED  8 /* the complete key has been revoked */
55 #define DIRF_VALVALID 16 /* The validity field is valid */
56
57 #define KEYF_CHECKED  1 /* This key has been checked */
58 #define KEYF_VALID    2 /* This is a valid (sub)key */
59 #define KEYF_EXPIRED  4 /* this key is expired */
60 #define KEYF_REVOKED  8 /* this key has been revoked */
61
62 #define UIDF_CHECKED  1  /* user id has been checked - other bits are valid */
63 #define UIDF_VALID    2  /* this is a valid user id */
64 #define UIDF_REVOKED  8  /* this user id has been revoked */
65 #define UIDF_VALVALID 16 /* the validity field is valid */
66
67 #define SIGF_CHECKED  1 /* signature has been checked - bits 0..6 are valid */
68 #define SIGF_VALID    2 /* the signature is valid */
69 #define SIGF_EXPIRED  4 /* the key of this signature has expired */
70 #define SIGF_REVOKED  8 /* this signature has been revoked */
71 #define SIGF_NOPUBKEY 128 /* there is no pubkey for this sig */
72
73 struct trust_record {
74     int  rectype;
75     int  mark;
76     int  dirty;                 /* for now only used internal by functions */
77     struct trust_record *next;  /* help pointer to build lists in memory */
78     ulong recnum;
79     union {
80         struct {             /* version record: */
81             byte version;    /* should be 2 */
82             byte  marginals;
83             byte  completes;
84             byte  cert_depth;
85             ulong created;   /* timestamp of trustdb creation  */
86             ulong modified;  /* timestamp of last modification */
87             ulong validated; /* timestamp of last validation   */
88             ulong keyhashtbl;
89             ulong firstfree;
90             ulong sdirhashtbl;
91         } ver;
92         struct {            /* free record */
93             ulong next;
94         } free;
95         struct {            /* directory record */
96             ulong lid;
97             ulong keylist;  /* List of keys (the first is the primary key)*/
98             ulong uidlist;  /* list of uid records */
99             ulong cacherec; /* the cache record */
100             byte ownertrust;
101             byte dirflags;
102             byte validity; /* calculated trustlevel over all uids */
103         } dir;
104         struct {            /* primary public key record */
105             ulong lid;
106             ulong next;    /* next key */
107             byte keyflags;
108             byte pubkey_algo;
109             byte fingerprint_len;
110             byte fingerprint[20];
111         } key;
112         struct {            /* user id reord */
113             ulong lid;      /* point back to the directory record */
114             ulong next;    /* points to next user id record */
115             ulong prefrec;   /* recno of preference record */
116             ulong siglist;   /* list of valid signatures (w/o self-sig)*/
117             byte uidflags;
118             byte validity;  /* calculated trustlevel of this uid */
119             byte namehash[20]; /* ripemd hash of the username */
120         } uid;
121         struct {            /* preference record */
122             ulong lid;      /* point back to the directory record */
123                             /* or 0 for a glocal pref record */
124             ulong next;    /* points to next pref record */
125             byte  data[ITEMS_PER_PREF_RECORD];
126         } pref;
127         struct {            /* signature record */
128             ulong lid;
129             ulong next;   /* recnno of next record or NULL for last one */
130             struct {
131                 ulong lid;       /* of pubkey record of signator (0=unused) */
132                 byte flag;       /* SIGF_xxxxx */
133             } sig[SIGS_PER_RECORD];
134         } sig;
135         struct {
136             ulong lid;
137             u32  keyid[2];
138             byte pubkey_algo;
139             u32  hintlist;
140         } sdir;
141         struct {            /* cache record */
142             ulong lid;
143             byte blockhash[20];
144             byte trustlevel;   /* calculated trustlevel */
145         } cache;
146         struct {
147             ulong item[ITEMS_PER_HTBL_RECORD];
148         } htbl;
149         struct {
150             ulong next;
151             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of another record */
152         } hlst;
153     } r;
154 };
155 typedef struct trust_record TRUSTREC;
156
157 typedef struct {
158     ulong     lid;         /* localid */
159     ulong     sigrec;
160     ulong     sig_lid;     /* returned signatures LID */
161     unsigned  sig_flag;    /* returned signature record flag */
162     struct {               /* internal data */
163         int init_done;
164         int eof;
165         TRUSTREC rec;
166         ulong nextuid;
167         int index;
168     } ctl;
169 } SIGREC_CONTEXT;
170
171
172 /*-- tdbio.c --*/
173 int tdbio_set_dbname( const char *new_dbname, int create );
174 const char *tdbio_get_dbname(void);
175 void tdbio_dump_record( TRUSTREC *rec, FILE *fp );
176 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
177 int tdbio_write_record( TRUSTREC *rec );
178 int tdbio_db_matches_options(void);
179 int tdbio_is_dirty(void);
180 int tdbio_sync(void);
181 int tdbio_begin_transaction(void);
182 int tdbio_end_transaction(void);
183 int tdbio_cancel_transaction(void);
184 int tdbio_delete_record( ulong recnum );
185 ulong tdbio_new_recnum(void);
186 int tdbio_search_dir_bypk( PKT_public_key *pk, TRUSTREC *rec );
187 int tdbio_search_dir_byfpr( const byte *fingerprint, size_t fingerlen,
188                                         int pubkey_algo, TRUSTREC *rec );
189 int tdbio_search_sdir( u32 *keyid, int pubkey_algo, TRUSTREC *rec );
190
191
192 #endif /*G10_TDBIO_H*/