See ChangeLog: Wed Oct 4 13:16:18 CEST 2000 Werner Koch
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  *      Copyright (C) 1998, 1999, 2000 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 GPG_KEYDB_H
22 #define GPG_KEYDB_H
23
24 #ifdef HAVE_LIBGDBM
25   #include <gdbm.h>
26 #endif
27
28 #include "types.h"
29 #include "basicdefs.h"
30 #include "packet.h"
31
32 #define MAX_FINGERPRINT_LEN 20
33
34 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
35 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
36 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
37 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
38 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
39 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
40
41
42
43 struct getkey_ctx_s;
44 typedef struct getkey_ctx_s *GETKEY_CTX;
45
46 /****************
47  * A Keyblock is all packets which form an entire certificate;
48  * i.e. the public key, certificate, trust packets, user ids,
49  * signatures, and subkey.
50  *
51  * This structure is also used to bind arbitrary packets together.
52  */
53
54 typedef struct kbnode_struct *KBNODE;
55 struct kbnode_struct {
56     KBNODE next;
57     PACKET *pkt;
58     int flag;
59     int private_flag;
60     ulong recno;  /* used while updating the trustdb */
61 };
62
63 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
64 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
65
66
67 enum resource_type {
68     rt_UNKNOWN = 0,
69     rt_RING = 1,
70     rt_GDBM = 2,
71     rt_KBXF = 3
72 };
73
74
75 /****************
76  * A data structre to hold information about the external position
77  * of a keyblock.
78  */
79 struct keyblock_pos_struct {
80     int   resno;     /* resource number */
81     enum resource_type rt;
82     ulong offset;    /* position information */
83     unsigned count;  /* length of the keyblock in packets */
84     IOBUF  fp;       /* used by enum_keyblocks */
85     int secret;      /* working on a secret keyring */
86   #ifdef HAVE_LIBGDBM
87     GDBM_FILE dbf;
88     byte keybuf[21];
89   #endif
90     PACKET *pkt;     /* ditto */
91     int valid;
92 };
93 typedef struct keyblock_pos_struct KBPOS;
94
95 /* structure to hold a couple of public key certificates */
96 struct pk_list {
97     PK_LIST next;
98     PKT_public_key *pk;
99     int mark;
100 };
101
102 /* structure to hold a couple of secret key certificates */
103 struct sk_list {
104     SK_LIST next;
105     PKT_secret_key *sk;
106     int mark;
107 };
108
109 /* structure to collect all information which can be used to
110  * identify a public key */
111 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
112 struct pubkey_find_info {
113     u32  keyid[2];
114     unsigned nbits;
115     byte pubkey_algo;
116     byte fingerprint[MAX_FINGERPRINT_LEN];
117     char userid[1];
118 };
119
120
121
122 /*-- pkclist.c --*/
123 int  check_signatures_trust( PKT_signature *sig );
124 void release_pk_list( PK_LIST pk_list );
125 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned use );
126 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
127
128 /*-- skclist.c --*/
129 void release_sk_list( SK_LIST sk_list );
130 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
131                                             int unlock, unsigned use );
132
133 /*-- passphrase.h --*/
134 int  have_static_passphrase(void);
135 void read_passphrase_from_fd( int fd );
136 void passphrase_clear_cache ( u32 *keyid, int algo );
137 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
138                         int cipher_algo, STRING2KEY *s2k, int mode);
139 void set_next_passphrase( const char *s );
140 char *get_last_passphrase(void);
141
142 /*-- getkey.c --*/
143 int classify_user_id( const char *name, u32 *keyid, byte *fprint,
144                       const char **retstr, size_t *retlen );
145 void getkey_disable_caches(void);
146 int get_pubkey( PKT_public_key *pk, u32 *keyid );
147 KBNODE get_pubkeyblock( u32 *keyid );
148 int get_pubkey_byname( GETKEY_CTX *rx, PKT_public_key *pk,
149                        const char *name, KBNODE *ret_keyblock );
150 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
151                         STRLIST names, KBNODE *ret_keyblock );
152 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
153 void get_pubkey_end( GETKEY_CTX ctx );
154 int get_seckey( PKT_secret_key *sk, u32 *keyid );
155 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
156 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
157                                                  size_t fprint_len );
158 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
159                                                  size_t fprint_len );
160 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
161 int seckey_available( u32 *keyid );
162 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
163 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
164                         STRLIST names, KBNODE *ret_keyblock );
165 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
166 void get_seckey_end( GETKEY_CTX ctx );
167 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
168 void merge_keys_and_selfsig( KBNODE keyblock );
169 void merge_public_with_secret ( KBNODE pubblock, KBNODE secblock );
170 char*get_user_id_string( u32 *keyid );
171 char*get_user_id_string_native( u32 *keyid );
172 char*get_long_user_id_string( u32 *keyid );
173 char*get_user_id( u32 *keyid, size_t *rn );
174
175 /*-- keyid.c --*/
176 int pubkey_letter( int algo );
177 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
178 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
179 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
180 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
181 unsigned nbits_from_pk( PKT_public_key *pk );
182 unsigned nbits_from_sk( PKT_secret_key *sk );
183 const char *datestr_from_pk( PKT_public_key *pk );
184 const char *datestr_from_sk( PKT_secret_key *sk );
185 const char *datestr_from_sig( PKT_signature *sig );
186 const char *expirestr_from_pk( PKT_public_key *pk );
187 const char *expirestr_from_sk( PKT_secret_key *sk );
188 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
189 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
190
191 /*-- kbnode.c --*/
192 KBNODE new_kbnode( PACKET *pkt );
193 KBNODE clone_kbnode( KBNODE node );
194 void release_kbnode( KBNODE n );
195 void delete_kbnode( KBNODE node );
196 void add_kbnode( KBNODE root, KBNODE node );
197 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
198 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
199 void remove_kbnode( KBNODE *root, KBNODE node );
200 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
201 KBNODE find_next_kbnode( KBNODE node, int pkttype );
202 KBNODE find_kbnode( KBNODE node, int pkttype );
203 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
204 void clear_kbnode_flags( KBNODE n );
205 int  commit_kbnode( KBNODE *root );
206 void dump_kbnode( KBNODE node );
207
208 /*-- ringedit.c --*/
209 const char *enum_keyblock_resources( int *sequence, int secret );
210 int add_keyblock_resource( const char *resname, int force, int secret );
211 const char *keyblock_resource_name( KBPOS *kbpos );
212 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
213 char *get_writable_keyblock_file( int secret );
214 int locate_keyblock_by_fpr( KBPOS *kbpos, const byte *fpr,
215                                             int fprlen, int secret );
216 int locate_keyblock_by_keyid( KBPOS *kbpos, u32 *keyid,
217                                             int shortkid, int secret );
218 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
219 int find_keyblock_byname( KBPOS *kbpos, const char *username );
220 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
221 int find_keyblock_bysk( KBPOS *kbpos, PKT_secret_key *sk );
222 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
223 int lock_keyblock( KBPOS *kbpos );
224 void unlock_keyblock( KBPOS *kbpos );
225 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
226 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
227 int insert_keyblock( KBPOS *kbpos, KBNODE root );
228 int delete_keyblock( KBPOS *kbpos );
229 int update_keyblock( KBPOS *kbpos, KBNODE root );
230
231
232 #endif /*GPG_KEYDB_H*/