Epxerimenta support for GDBM keyings.
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
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_KEYDB_H
22 #define G10_KEYDB_H
23
24 #ifdef HAVE_LIBGDBM
25   #include <gdbm.h>
26 #endif
27
28 #include "types.h"
29 #include "packet.h"
30 #include "cipher.h"
31
32 #define MAX_FINGERPRINT_LEN 20
33
34
35 /****************
36  * A Keyblock is all packets which form an entire certificate;
37  * i.e. the public key, certificate, trust packets, user ids,
38  * signatures, and subkey.
39  *
40  * This structure is also used to bind arbitrary packets together.
41  */
42
43 typedef struct kbnode_struct *KBNODE;
44 struct kbnode_struct {
45     KBNODE next;
46     PACKET *pkt;
47     int flag;
48     int private_flag;
49     ulong recno;  /* used while updating the trustdb */
50 };
51
52
53 enum resource_type {
54     rt_UNKNOWN = 0,
55     rt_RING = 1,
56     rt_GDBM = 2
57 };
58
59
60 /****************
61  * A data structre to hold information about the external position
62  * of a keyblock.
63  */
64 struct keyblock_pos_struct {
65     int   resno;     /* resource number */
66     enum resource_type rt;
67     ulong offset;    /* position information */
68     unsigned count;  /* length of the keyblock in packets */
69     IOBUF  fp;       /* used by enum_keyblocks */
70     int secret;      /* working on a secret keyring */
71   #ifdef HAVE_LIBGDBM
72     GDBM_FILE dbf;
73     byte keybuf[21];
74   #endif
75     PACKET *pkt;     /* ditto */
76 };
77 typedef struct keyblock_pos_struct KBPOS;
78
79 /* structure to hold a couple of public key certificates */
80 typedef struct pk_list *PK_LIST;
81 struct pk_list {
82     PK_LIST next;
83     PKT_public_key *pk;
84     int mark;
85 };
86
87 /* structure to hold a couple of secret key certificates */
88 typedef struct sk_list *SK_LIST;
89 struct sk_list {
90     SK_LIST next;
91     PKT_secret_key *sk;
92     int mark;
93 };
94
95 /* structure to collect all information which can be used to
96  * identify a public key */
97 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
98 struct pubkey_find_info {
99     u32  keyid[2];
100     unsigned nbits;
101     byte pubkey_algo;
102     byte fingerprint[MAX_FINGERPRINT_LEN];
103     char userid[1];
104 };
105
106
107
108 /*-- pkclist.c --*/
109 int  check_signatures_trust( PKT_signature *sig );
110 void release_pk_list( PK_LIST pk_list );
111 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned usage );
112 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
113
114 /*-- skclist.c --*/
115 void release_sk_list( SK_LIST sk_list );
116 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
117                                             int unlock, unsigned usage );
118
119 /*-- passphrase.h --*/
120 int  have_static_passphrase(void);
121 void read_passphrase_from_fd( int fd );
122 DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
123 void set_next_passphrase( const char *s );
124 char *get_last_passphrase(void);
125
126 /*-- getkey.c --*/
127 int get_pubkey( PKT_public_key *pk, u32 *keyid );
128 int get_pubkey_byname( PKT_public_key *pk, const char *name );
129 int get_seckey( PKT_secret_key *sk, u32 *keyid );
130 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
131                                                  size_t fprint_len );
132 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
133                                                  size_t fprint_len );
134 int seckey_available( u32 *keyid );
135 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
136 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
137 void merge_keys_and_selfsig( KBNODE keyblock );
138 char*get_user_id_string( u32 *keyid );
139 char*get_user_id( u32 *keyid, size_t *rn );
140
141 /*-- keyid.c --*/
142 int pubkey_letter( int algo );
143 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
144 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
145 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
146 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
147 unsigned nbits_from_pk( PKT_public_key *pk );
148 unsigned nbits_from_sk( PKT_secret_key *sk );
149 const char *datestr_from_pk( PKT_public_key *pk );
150 const char *datestr_from_sk( PKT_secret_key *sk );
151 const char *datestr_from_sig( PKT_signature *sig );
152 const char *expirestr_from_pk( PKT_public_key *pk );
153 const char *expirestr_from_sk( PKT_secret_key *sk );
154 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
155 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
156
157 /*-- kbnode.c --*/
158 KBNODE new_kbnode( PACKET *pkt );
159 KBNODE clone_kbnode( KBNODE node );
160 void release_kbnode( KBNODE n );
161 void delete_kbnode( KBNODE node );
162 void add_kbnode( KBNODE root, KBNODE node );
163 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
164 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
165 KBNODE find_next_kbnode( KBNODE node, int pkttype );
166 KBNODE find_kbnode( KBNODE node, int pkttype );
167 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
168 void clear_kbnode_flags( KBNODE n );
169 int  commit_kbnode( KBNODE *root );
170 void dump_kbnode( KBNODE node );
171
172 /*-- ringedit.c --*/
173 const char *enum_keyblock_resources( int *sequence, int secret );
174 int add_keyblock_resource( const char *resname, int force, int secret );
175 const char *keyblock_resource_name( KBPOS *kbpos );
176 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
177 int locate_keyblock_by_fpr( KBPOS *kbpos, const byte *fpr,
178                                             int fprlen, int secret );
179 int locate_keyblock_by_keyid( KBPOS *kbpos, u32 *keyid,
180                                             int shortkid, int secret );
181 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
182 int find_keyblock_byname( KBPOS *kbpos, const char *username );
183 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
184 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
185 int lock_keyblock( KBPOS *kbpos );
186 void unlock_keyblock( KBPOS *kbpos );
187 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
188 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
189 int insert_keyblock( KBPOS *kbpos, KBNODE root );
190 int delete_keyblock( KBPOS *kbpos );
191 int update_keyblock( KBPOS *kbpos, KBNODE root );
192
193
194 #endif /*G10_KEYDB_H*/