Snapshot release 0.4.2
[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
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_DIR  2
38 #define RECTYPE_KEY  3
39 #define RECTYPE_UID  4
40 #define RECTYPE_PREF 5
41 #define RECTYPE_SIG  6
42 #define RECTYPE_SDIR 8
43 #define RECTYPE_CACH 9
44 #define RECTYPE_HTBL 10
45 #define RECTYPE_HLST 11
46 #define RECTYPE_FREE 254
47
48
49 #define DIRF_CHECKED  1 /* everything has been checked, the other bits are
50                            valid */
51 #define DIRF_MISKEY   2 /* not all signatures are checked */
52                         /* this flag is used as a quick hint, that we */
53                         /* do not need to look at the sig records */
54 #define DIRF_ERROR    4 /* severe errors: the key is not valid for some reasons
55                            but we mark it to avoid duplicate checks */
56 #define DIRF_REVOKED  8 /* the complete key has been revoked */
57
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_REVOKED  8 /* this signature has been revoked */
68 #define SIGF_NOPUBKEY 128 /* there is no pubkey for this sig */
69
70 struct trust_record {
71     int  rectype;
72     int  mark;
73     int  dirty;                 /* for now only used internal by functions */
74     struct trust_record *next;  /* help pointer to build lists in memory */
75     ulong recnum;
76     union {
77         struct {             /* version record: */
78             byte version;    /* should be 2 */
79             ulong created;   /* timestamp of trustdb creation  */
80             ulong modified;  /* timestamp of last modification */
81             ulong validated; /* timestamp of last validation   */
82             ulong keyhashtbl;
83             ulong firstfree;
84             ulong sdirhashtbl;
85         } ver;
86         struct {            /* free record */
87             ulong next;
88         } free;
89         struct {            /* directory record */
90             ulong lid;
91             ulong keylist;  /* List of keys (the first is the primary key)*/
92             ulong uidlist;  /* list of uid records */
93             ulong cacherec; /* the cache record */
94             byte ownertrust;
95             byte dirflags;
96         } dir;
97         struct {            /* primary public key record */
98             ulong lid;
99             ulong next;    /* next key */
100             byte keyflags;
101             byte pubkey_algo;
102             byte fingerprint_len;
103             byte fingerprint[20];
104         } key;
105         struct {            /* user id reord */
106             ulong lid;      /* point back to the directory record */
107             ulong next;    /* points to next user id record */
108             ulong prefrec;   /* recno of preference record */
109             ulong siglist;   /* list of valid signatures (w/o self-sig)*/
110             byte uidflags;
111             byte namehash[20]; /* ripemd hash of the username */
112         } uid;
113         struct {            /* preference record */
114             ulong lid;      /* point back to the directory record */
115                             /* or 0 for a glocal pref record */
116             ulong next;    /* points to next pref record */
117             byte  data[ITEMS_PER_PREF_RECORD];
118         } pref;
119         struct {            /* signature record */
120             ulong lid;
121             ulong next;   /* recnno of next record or NULL for last one */
122             struct {
123                 ulong lid;       /* of pubkey record of signator (0=unused) */
124                 byte flag;       /* SIGF_xxxxx */
125             } sig[SIGS_PER_RECORD];
126         } sig;
127         struct {
128             ulong lid;
129             u32  keyid[2];
130             byte pubkey_algo;
131             u32  hintlist;
132         } sdir;
133         struct {            /* cache record */
134             ulong lid;
135             byte blockhash[20];
136             byte trustlevel;   /* calculated trustlevel */
137         } cache;
138         struct {
139             ulong item[ITEMS_PER_HTBL_RECORD];
140         } htbl;
141         struct {
142             ulong next;
143             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of another record */
144         } hlst;
145     } r;
146 };
147 typedef struct trust_record TRUSTREC;
148
149 typedef struct {
150     ulong     lid;         /* localid */
151     ulong     sigrec;
152     ulong     sig_lid;     /* returned signatures LID */
153     unsigned  sig_flag;    /* returned signature record flag */
154     struct {               /* internal data */
155         int init_done;
156         int eof;
157         TRUSTREC rec;
158         ulong nextuid;
159         int index;
160     } ctl;
161 } SIGREC_CONTEXT;
162
163
164 /*-- tdbio.c --*/
165 int tdbio_set_dbname( const char *new_dbname, int create );
166 const char *tdbio_get_dbname(void);
167 void tdbio_dump_record( TRUSTREC *rec, FILE *fp );
168 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
169 int tdbio_write_record( TRUSTREC *rec );
170 int tdbio_sync(void);
171 int tdbio_delete_record( ulong recnum );
172 ulong tdbio_new_recnum(void);
173 int tdbio_search_dir_bypk( PKT_public_key *pk, TRUSTREC *rec );
174 int tdbio_search_dir_byfpr( const byte *fingerprint, size_t fingerlen,
175                                         int pubkey_algo, TRUSTREC *rec );
176 int tdbio_search_sdir( u32 *keyid, int pubkey_algo, TRUSTREC *rec );
177
178
179 #define buftoulong( p )  ((*(byte*)(p) << 24) | (*((byte*)(p)+1)<< 16) | \
180                        (*((byte*)(p)+2) << 8) | (*((byte*)(p)+3)))
181 #define buftoushort( p )  ((*((byte*)(p)) << 8) | (*((byte*)(p)+1)))
182 #define ulongtobuf( p, a ) do {                           \
183                             ((byte*)p)[0] = a >> 24;    \
184                             ((byte*)p)[1] = a >> 16;    \
185                             ((byte*)p)[2] = a >>  8;    \
186                             ((byte*)p)[3] = a      ;    \
187                         } while(0)
188 #define ushorttobuf( p, a ) do {                           \
189                             ((byte*)p)[0] = a >>  8;    \
190                             ((byte*)p)[1] = a      ;    \
191                         } while(0)
192 #define buftou32( p)    buftoulong( (p) )
193 #define u32tobuf( p, a) ulongtobuf( (p), (a) )
194
195
196
197 #endif /*G10_TDBIO_H*/