intermediate check in
[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_CACH 9
43 #define RECTYPE_HTBL 10
44 #define RECTYPE_HLST 11
45
46
47 #define DIRF_CHECKED  1 /* everything has been checked, the other bits are
48                            valid */
49 #define DIRF_MISKEY   2 /* some keys are missing, so they could not be checked*/
50 #define DIRF_ERROR    4 /* severe errors: the key is not valid for some reasons
51                            but we mark it to avoid duplicate checks */
52 #define DIRF_REVOKED  8 /* the complete key has been revoked */
53
54 #define KEYF_REVOKED DIRF_REVOKED   /* this key has been revoked
55                                        (only useful on subkeys)*/
56 #define UIDF_REVOKED DIRF_REVOKED   /* this user id has been revoked */
57
58
59 struct trust_record {
60     int  rectype;
61     struct trust_record *next;  /* help pointer to build lists in memory */
62     struct trust_record *help_pref;
63     int  mark;
64     ulong recnum;
65     union {
66         struct {             /* version record: */
67             byte version;    /* should be 2 */
68             ulong created;   /* timestamp of trustdb creation  */
69             ulong modified;  /* timestamp of last modification */
70             ulong validated; /* timestamp of last validation   */
71             ulong keyhashtbl;
72         } ver;
73         struct {            /* directory record */
74             ulong lid;
75             ulong keylist;  /* List of keys (the first is the primary key)*/
76             ulong uidlist;  /* list of uid records */
77             ulong cacherec; /* the cache record */
78             byte ownertrust;
79             byte dirflags;
80         } dir;
81         struct {            /* primary public key record */
82             ulong lid;
83             ulong next;    /* next key */
84             byte keyflags;
85             byte pubkey_algo;
86             byte fingerprint_len;
87             byte fingerprint[20];
88         } key;
89         struct {            /* user id reord */
90             ulong lid;      /* point back to the directory record */
91             ulong next;    /* points to next user id record */
92             ulong prefrec;   /* recno of preference record */
93             ulong siglist;   /* list of valid signatures (w/o self-sig)*/
94             byte uidflags;
95             byte namehash[20]; /* ripemd hash of the username */
96         } uid;
97         struct {            /* preference record */
98             ulong lid;      /* point back to the directory record */
99                             /* or 0 for a glocal pref record */
100             ulong next;    /* points to next pref record */
101             byte  data[ITEMS_PER_PREF_RECORD];
102         } pref;
103         struct {            /* signature record */
104             ulong lid;
105             ulong next;   /* recnno of next record or NULL for last one */
106             struct {
107                 ulong lid;       /* of pubkey record of signator (0=unused) */
108                 byte flag;       /* SIGRF_xxxxx */
109             } sig[SIGS_PER_RECORD];
110         } sig;
111         struct {            /* cache record */
112             ulong lid;
113             byte blockhash[20];
114             byte trustlevel;   /* calculated trustlevel */
115         } cache;
116         struct {
117             ulong item[ITEMS_PER_HTBL_RECORD];
118         } htbl;
119         struct {
120             ulong next;
121             ulong rnum[ITEMS_PER_HLST_RECORD]; /* of a key record */
122         } hlst;
123     } r;
124 };
125 typedef struct trust_record TRUSTREC;
126
127 typedef struct {
128     ulong     lid;         /* localid */
129     ulong     sigrec;
130     ulong     sig_lid;     /* returned signatures LID */
131     unsigned  sig_flag;    /* returned signature record flag */
132     struct {               /* internal data */
133         int init_done;
134         int eof;
135         TRUSTREC rec;
136         ulong nextuid;
137         int index;
138     } ctl;
139 } SIGREC_CONTEXT;
140
141
142 /*-- tdbio.c --*/
143 int tdbio_set_dbname( const char *new_dbname, int create );
144 const char *tdbio_get_dbname(void);
145 void tdbio_dump_record( TRUSTREC *rec, FILE *fp );
146 int tdbio_read_record( ulong recnum, TRUSTREC *rec, int expected );
147 int tdbio_write_record( TRUSTREC *rec );
148 int tdbio_delete_record( ulong recnum );
149 ulong tdbio_new_recnum(void);
150 int tdbio_search_dir_bypk( PKT_public_key *pk, TRUSTREC *rec );
151 int tdbio_search_dir_byfpr( const byte *fingerprint, size_t fingerlen,
152                                         int pubkey_algo, TRUSTREC *rec );
153 int tdbio_delete_uidrec( ulong dirlid, ulong uidlid );
154
155
156 #define buftoulong( p )  ((*(byte*)(p) << 24) | (*((byte*)(p)+1)<< 16) | \
157                        (*((byte*)(p)+2) << 8) | (*((byte*)(p)+3)))
158 #define buftoushort( p )  ((*((byte*)(p)) << 8) | (*((byte*)(p)+1)))
159 #define ulongtobuf( p, a ) do {                           \
160                             ((byte*)p)[0] = a >> 24;    \
161                             ((byte*)p)[1] = a >> 16;    \
162                             ((byte*)p)[2] = a >>  8;    \
163                             ((byte*)p)[3] = a      ;    \
164                         } while(0)
165 #define ushorttobuf( p, a ) do {                           \
166                             ((byte*)p)[0] = a >>  8;    \
167                             ((byte*)p)[1] = a      ;    \
168                         } while(0)
169 #define buftou32( p)    buftoulong( (p) )
170 #define u32tobuf( p, a) ulongtobuf( (p), (a) )
171
172
173
174 #endif /*G10_TDBIO_H*/