See ChangeLog: Sun Jan 17 11:04:33 CET 1999 Werner Koch
[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
66 #define SIGF_CHECKED  1 /* signature has been checked - bits 0..6 are valid */
67 #define SIGF_VALID    2 /* the signature is valid */
68 #define SIGF_EXPIRED  4 /* the key of this signature has expired */
69 #define SIGF_REVOKED  8 /* this signature has been revoked */
70 #define SIGF_NOPUBKEY 128 /* there is no pubkey for this sig */
71
72 struct trust_record {
73     int  rectype;
74     int  mark;
75     int  dirty;                 /* for now only used internal by functions */
76     struct trust_record *next;  /* help pointer to build lists in memory */
77     ulong recnum;
78     union {
79         struct {             /* version record: */
80             byte version;    /* should be 2 */
81             byte  marginals;
82             byte  completes;
83             byte  cert_depth;
84             ulong created;   /* timestamp of trustdb creation  */
85             ulong modified;  /* timestamp of last modification */
86             ulong validated; /* timestamp of last validation   */
87             ulong keyhashtbl;
88             ulong firstfree;
89             ulong sdirhashtbl;
90         } ver;
91         struct {            /* free record */
92             ulong next;
93         } free;
94         struct {            /* directory record */
95             ulong lid;
96             ulong keylist;  /* List of keys (the first is the primary key)*/
97             ulong uidlist;  /* list of uid records */
98             ulong cacherec; /* the cache record */
99             byte ownertrust;
100             byte dirflags;
101             byte validity; /* calculated trustlevel */
102         } dir;
103         struct {            /* primary public key record */
104             ulong lid;
105             ulong next;    /* next key */
106             byte keyflags;
107             byte pubkey_algo;
108             byte fingerprint_len;
109             byte fingerprint[20];
110         } key;
111         struct {            /* user id reord */
112             ulong lid;      /* point back to the directory record */
113             ulong next;    /* points to next user id record */
114             ulong prefrec;   /* recno of preference record */
115             ulong siglist;   /* list of valid signatures (w/o self-sig)*/
116             byte uidflags;
117             byte namehash[20]; /* ripemd hash of the username */
118         } uid;
119         struct {            /* preference record */
120             ulong lid;      /* point back to the directory record */
121                             /* or 0 for a glocal pref record */
122             ulong next;    /* points to next pref record */
123             byte  data[ITEMS_PER_PREF_RECORD];
124         } pref;
125         struct {            /* signature record */
126             ulong lid;
127             ulong next;   /* recnno of next record or NULL for last one */
128             struct {
129                 ulong lid;       /* of pubkey record of signator (0=unused) */
130                 byte flag;       /* SIGF_xxxxx */
131             } sig[SIGS_PER_RECORD];
132         } sig;
133         struct {
134             ulong lid;
135             u32  keyid[2];
136             byte pubkey_algo;
137             u32  hintlist;
138         } sdir;
139         struct {            /* cache record */
140             ulong lid;
141             byte blockhash[20];
142             byte trustlevel;   /* calculated trustlevel */
143         } cache;
144         struct {
145             ulong item[ITEMS_PER_HTBL_RECORD];
146         } htbl;
147         struct {
148             ulong next;
149             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of another record */
150         } hlst;
151     } r;
152 };
153 typedef struct trust_record TRUSTREC;
154
155 typedef struct {
156     ulong     lid;         /* localid */
157     ulong     sigrec;
158     ulong     sig_lid;     /* returned signatures LID */
159     unsigned  sig_flag;    /* returned signature record flag */
160     struct {               /* internal data */
161         int init_done;
162         int eof;
163         TRUSTREC rec;
164         ulong nextuid;
165         int index;
166     } ctl;
167 } SIGREC_CONTEXT;
168
169
170 /*-- tdbio.c --*/
171 int tdbio_set_dbname( const char *new_dbname, int create );
172 const char *tdbio_get_dbname(void);
173 void tdbio_dump_record( TRUSTREC *rec, FILE *fp );
174 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
175 int tdbio_write_record( TRUSTREC *rec );
176 int tdbio_db_matches_options(void);
177 int tdbio_is_dirty(void);
178 int tdbio_sync(void);
179 int tdbio_begin_transaction(void);
180 int tdbio_end_transaction(void);
181 int tdbio_cancel_transaction(void);
182 int tdbio_delete_record( ulong recnum );
183 ulong tdbio_new_recnum(void);
184 int tdbio_search_dir_bypk( PKT_public_key *pk, TRUSTREC *rec );
185 int tdbio_search_dir_byfpr( const byte *fingerprint, size_t fingerlen,
186                                         int pubkey_algo, TRUSTREC *rec );
187 int tdbio_search_sdir( u32 *keyid, int pubkey_algo, TRUSTREC *rec );
188
189
190 #endif /*G10_TDBIO_H*/