See ChangeLog: Mon Jul 26 09:34:46 CEST 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
56 #define KEYF_CHECKED  1 /* This key has been checked */
57 #define KEYF_VALID    2 /* This is a valid (sub)key */
58 #define KEYF_EXPIRED  4 /* this key is expired */
59 #define KEYF_REVOKED  8 /* this key has been revoked */
60
61 #define UIDF_CHECKED  1  /* user id has been checked - other bits are valid */
62 #define UIDF_VALID    2  /* this is a valid user id */
63 #define UIDF_REVOKED  8  /* this user id has been revoked */
64
65 #define SIGF_CHECKED  1 /* signature has been checked - bits 0..6 are valid */
66 #define SIGF_VALID    2 /* the signature is valid */
67 #define SIGF_EXPIRED  4 /* the key of this signature has expired */
68 #define SIGF_REVOKED  8 /* this signature has been revoked */
69 #define SIGF_IGNORED  64  /* this signature is ignored by the system */
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 mod_down;  /* timestamp of last modification downward */
86             ulong mod_up;    /* timestamp of last modification upward */
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 over all uids */
102             ulong valcheck;  /* timestamp of last validation check */
103             ulong checkat;   /* Check key when this time has been reached*/
104         } dir;
105         struct {            /* primary public key record */
106             ulong lid;
107             ulong next;    /* next key */
108             byte keyflags;
109             byte pubkey_algo;
110             byte fingerprint_len;
111             byte fingerprint[20];
112         } key;
113         struct {            /* user id reord */
114             ulong lid;      /* point back to the directory record */
115             ulong next;    /* points to next user id record */
116             ulong prefrec;   /* recno of preference record */
117             ulong siglist;   /* list of valid signatures (w/o self-sig)*/
118             byte uidflags;
119             byte validity;  /* calculated trustlevel of this uid */
120             byte namehash[20]; /* ripemd hash of the username */
121         } uid;
122         struct {            /* preference record */
123             ulong lid;      /* point back to the directory record */
124                             /* or 0 for a glocal pref record */
125             ulong next;    /* points to next pref record */
126             byte  data[ITEMS_PER_PREF_RECORD];
127         } pref;
128         struct {            /* signature record */
129             ulong lid;
130             ulong next;   /* recnno of next record or NULL for last one */
131             struct {
132                 ulong lid;       /* of pubkey record of signator (0=unused) */
133                 byte flag;       /* SIGF_xxxxx */
134             } sig[SIGS_PER_RECORD];
135         } sig;
136         struct {
137             ulong lid;
138             u32  keyid[2];
139             byte pubkey_algo;
140             u32  hintlist;
141         } sdir;
142         struct {            /* cache record */
143             ulong lid;
144             byte blockhash[20];
145             byte trustlevel;   /* calculated trustlevel */
146         } cache;
147         struct {
148             ulong item[ITEMS_PER_HTBL_RECORD];
149         } htbl;
150         struct {
151             ulong next;
152             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of another record */
153         } hlst;
154     } r;
155 };
156 typedef struct trust_record TRUSTREC;
157
158 typedef struct {
159     ulong     lid;         /* localid */
160     ulong     sigrec;
161     ulong     sig_lid;     /* returned signatures LID */
162     unsigned  sig_flag;    /* returned signature record flag */
163     struct {               /* internal data */
164         int init_done;
165         int eof;
166         TRUSTREC rec;
167         ulong nextuid;
168         int index;
169     } ctl;
170 } SIGREC_CONTEXT;
171
172
173 /*-- tdbio.c --*/
174 int tdbio_set_dbname( const char *new_dbname, int create );
175 const char *tdbio_get_dbname(void);
176 void tdbio_dump_record( TRUSTREC *rec, FILE *fp );
177 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
178 int tdbio_write_record( TRUSTREC *rec );
179 int tdbio_db_matches_options(void);
180 ulong tdbio_read_modify_stamp( int modify_down );
181 void tdbio_write_modify_stamp( int up, int down );
182 int tdbio_is_dirty(void);
183 int tdbio_sync(void);
184 int tdbio_begin_transaction(void);
185 int tdbio_end_transaction(void);
186 int tdbio_cancel_transaction(void);
187 int tdbio_delete_record( ulong recnum );
188 ulong tdbio_new_recnum(void);
189 int tdbio_search_dir_bypk( PKT_public_key *pk, TRUSTREC *rec );
190 int tdbio_search_dir_byfpr( const byte *fingerprint, size_t fingerlen,
191                                         int pubkey_algo, TRUSTREC *rec );
192 int tdbio_search_dir(  u32 *keyid, int pubkey_algo, TRUSTREC *rec );
193 int tdbio_search_sdir( u32 *keyid, int pubkey_algo, TRUSTREC *rec );
194
195 void tdbio_invalid(void);
196
197 #endif /*G10_TDBIO_H*/