Fix for bug 537
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3  *               2006 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301,
20  * USA.
21  */
22
23 #ifndef G10_KEYDB_H
24 #define G10_KEYDB_H
25
26 #include <assuan.h>
27
28 #include "types.h"
29 #include "packet.h"
30 #include "cipher.h"
31
32 /* What qualifies as a certification (rather than a signature?) */
33 #define IS_CERT(s)       (IS_KEY_SIG(s) || IS_UID_SIG(s) || IS_SUBKEY_SIG(s) \
34                          || IS_KEY_REV(s) || IS_UID_REV(s) || IS_SUBKEY_REV(s))
35 #define IS_SIG(s)        (!IS_CERT(s))
36 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
37 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
38 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
39 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
40 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
41 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
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 struct kbnode_struct {
55     KBNODE next;
56     PACKET *pkt;
57     int flag;
58     int private_flag;
59     ulong recno;  /* used while updating the trustdb */
60 };
61
62 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
63 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
64
65
66 enum resource_type {
67     rt_UNKNOWN = 0,
68     rt_RING = 1
69 };
70
71
72 /****************
73  * A data structre to hold information about the external position
74  * of a keyblock.
75  */
76 struct keyblock_pos_struct {
77     int   resno;     /* resource number */
78     enum resource_type rt;
79     off_t offset;    /* position information */
80     unsigned count;  /* length of the keyblock in packets */
81     iobuf_t  fp;     /* Used by enum_keyblocks. */
82     int secret;      /* working on a secret keyring */
83     PACKET *pkt;     /* ditto */
84     int valid;
85 };
86 typedef struct keyblock_pos_struct KBPOS;
87
88 /* structure to hold a couple of public key certificates */
89 typedef struct pk_list *PK_LIST;
90 struct pk_list {
91     PK_LIST next;
92     PKT_public_key *pk;
93     int flags; /* flag bit 1==throw_keyid */
94 };
95
96 /* structure to hold a couple of secret key certificates */
97 typedef struct sk_list *SK_LIST;
98 struct sk_list {
99     SK_LIST next;
100     PKT_secret_key *sk;
101     int mark; /* not used */
102 };
103
104 /* structure to collect all information which can be used to
105  * identify a public key */
106 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
107 struct pubkey_find_info {
108     u32  keyid[2];
109     unsigned nbits;
110     byte pubkey_algo;
111     byte fingerprint[MAX_FINGERPRINT_LEN];
112     char userid[1];
113 };
114
115
116 typedef struct keydb_handle *KEYDB_HANDLE;
117
118 typedef enum {
119     KEYDB_SEARCH_MODE_NONE,
120     KEYDB_SEARCH_MODE_EXACT,
121     KEYDB_SEARCH_MODE_SUBSTR,
122     KEYDB_SEARCH_MODE_MAIL,
123     KEYDB_SEARCH_MODE_MAILSUB,
124     KEYDB_SEARCH_MODE_MAILEND,
125     KEYDB_SEARCH_MODE_WORDS,
126     KEYDB_SEARCH_MODE_SHORT_KID,
127     KEYDB_SEARCH_MODE_LONG_KID,
128     KEYDB_SEARCH_MODE_FPR16,
129     KEYDB_SEARCH_MODE_FPR20,
130     KEYDB_SEARCH_MODE_FPR,
131     KEYDB_SEARCH_MODE_FIRST,
132     KEYDB_SEARCH_MODE_NEXT
133 } KeydbSearchMode;
134
135 struct keydb_search_desc {
136     KeydbSearchMode mode;
137     int (*skipfnc)(void *,u32*,PKT_user_id*);
138     void *skipfncvalue;
139     union {
140         const char *name;
141         byte fpr[MAX_FINGERPRINT_LEN];
142         u32  kid[2];
143     } u;
144     int exact;
145 };
146
147
148 /* Helper type for preference fucntions. */
149 union pref_hint
150 {
151   int digest_length;
152 };
153
154
155 /*-- keydb.c --*/
156
157 /*
158   Flag 1 == force
159   Flag 2 == default
160 */
161 int keydb_add_resource (const char *url, int flags, int secret);
162 KEYDB_HANDLE keydb_new (int secret);
163 void keydb_release (KEYDB_HANDLE hd);
164 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
165 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
166 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
167 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
168 int keydb_delete_keyblock (KEYDB_HANDLE hd);
169 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
170 void keydb_rebuild_caches (int noisy);
171 int keydb_search_reset (KEYDB_HANDLE hd);
172 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
173 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
174                    size_t ndesc, size_t *descindex);
175 int keydb_search_first (KEYDB_HANDLE hd);
176 int keydb_search_next (KEYDB_HANDLE hd);
177 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
178 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
179
180
181 /*-- pkclist.c --*/
182 void show_revocation_reason( PKT_public_key *pk, int mode );
183 int  check_signatures_trust( PKT_signature *sig );
184 void release_pk_list( PK_LIST pk_list );
185 int  build_pk_list( strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use );
186 int  algo_available( preftype_t preftype, int algo,
187                      const union pref_hint *hint );
188 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
189                              int request, const union pref_hint *hint);
190 int  select_mdc_from_pklist (PK_LIST pk_list);
191
192 /*-- skclist.c --*/
193 int  random_is_faked (void);
194 void release_sk_list( SK_LIST sk_list );
195 int  build_sk_list( strlist_t locusr, SK_LIST *ret_sk_list,
196                                             int unlock, unsigned use );
197
198 /*-- passphrase.h --*/
199 assuan_context_t agent_open (int try, const char *orig_codeset);
200 void agent_close (assuan_context_t ctx);
201 int  have_static_passphrase(void);
202 void set_passphrase_from_string(const char *pass);
203 void read_passphrase_from_fd( int fd );
204 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
205 char *ask_passphrase (const char *description,
206                       const char *tryagain_text,
207                       const char *promptid,
208                       const char *prompt, 
209                       const char *cacheid, int *canceled);
210 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
211                         int cipher_algo, STRING2KEY *s2k, int mode,
212                         const char *tryagain_text, int *canceled);
213 void set_next_passphrase( const char *s );
214 char *get_last_passphrase(void);
215 void next_to_last_passphrase(void);
216
217 /*-- getkey.c --*/
218 int classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc);
219 void cache_public_key( PKT_public_key *pk );
220 void getkey_disable_caches(void);
221 int get_pubkey( PKT_public_key *pk, u32 *keyid );
222 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
223 KBNODE get_pubkeyblock( u32 *keyid );
224 int get_pubkey_byname( PKT_public_key *pk,  const char *name,
225                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
226                        int include_unusable );
227 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
228                         strlist_t names, KBNODE *ret_keyblock );
229 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
230 void get_pubkey_end( GETKEY_CTX ctx );
231 int get_seckey( PKT_secret_key *sk, u32 *keyid );
232 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
233 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
234                                                  size_t fprint_len );
235 int get_pubkey_byfprint_fast (PKT_public_key *pk,
236                               const byte *fprint, size_t fprint_len);
237 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
238                                                  size_t fprint_len );
239 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
240 int seckey_available( u32 *keyid );
241 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
242 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
243                         strlist_t names, KBNODE *ret_keyblock );
244 int get_seckey_next (GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock);
245 void get_seckey_end( GETKEY_CTX ctx );
246
247 int get_seckey_byfprint( PKT_secret_key *sk,
248                          const byte *fprint, size_t fprint_len);
249 int get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
250                               size_t fprint_len );
251
252
253 int enum_secret_keys( void **context, PKT_secret_key *sk,
254                       int with_subkeys, int with_spm );
255 void merge_keys_and_selfsig( KBNODE keyblock );
256 char*get_user_id_string( u32 *keyid );
257 char*get_user_id_string_native( u32 *keyid );
258 char*get_long_user_id_string( u32 *keyid );
259 char*get_user_id( u32 *keyid, size_t *rn );
260 char*get_user_id_native( u32 *keyid );
261 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
262 void release_akl(void);
263 int parse_auto_key_locate(char *options);
264
265 /*-- keyid.c --*/
266 int pubkey_letter( int algo );
267 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
268 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
269 size_t keystrlen(void);
270 const char *keystr(u32 *keyid);
271 const char *keystr_from_pk(PKT_public_key *pk);
272 const char *keystr_from_sk(PKT_secret_key *sk);
273 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
274 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
275 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
276 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
277 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
278 byte *namehash_from_uid(PKT_user_id *uid);
279 unsigned nbits_from_pk( PKT_public_key *pk );
280 unsigned nbits_from_sk( PKT_secret_key *sk );
281 const char *datestr_from_pk( PKT_public_key *pk );
282 const char *datestr_from_sk( PKT_secret_key *sk );
283 const char *datestr_from_sig( PKT_signature *sig );
284 const char *expirestr_from_pk( PKT_public_key *pk );
285 const char *expirestr_from_sk( PKT_secret_key *sk );
286 const char *expirestr_from_sig( PKT_signature *sig );
287 const char *revokestr_from_pk( PKT_public_key *pk );
288 const char *usagestr_from_pk( PKT_public_key *pk );
289 const char *colon_strtime (u32 t);
290 const char *colon_datestr_from_pk (PKT_public_key *pk);
291 const char *colon_datestr_from_sk (PKT_secret_key *sk);
292 const char *colon_datestr_from_sig (PKT_signature *sig);
293 const char *colon_expirestr_from_sig (PKT_signature *sig);
294 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
295 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
296 char *serialno_and_fpr_from_sk (const unsigned char *sn, size_t snlen,
297                                 PKT_secret_key *sk);
298
299 /*-- kbnode.c --*/
300 KBNODE new_kbnode( PACKET *pkt );
301 KBNODE clone_kbnode( KBNODE node );
302 void release_kbnode( KBNODE n );
303 void delete_kbnode( KBNODE node );
304 void add_kbnode( KBNODE root, KBNODE node );
305 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
306 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
307 void remove_kbnode( KBNODE *root, KBNODE node );
308 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
309 KBNODE find_next_kbnode( KBNODE node, int pkttype );
310 KBNODE find_kbnode( KBNODE node, int pkttype );
311 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
312 void clear_kbnode_flags( KBNODE n );
313 int  commit_kbnode( KBNODE *root );
314 void dump_kbnode( KBNODE node );
315
316 #endif /*G10_KEYDB_H*/