Unification of the search descriptor usage.
[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 3 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, see <http://www.gnu.org/licenses/>.
19  */
20
21 #ifndef G10_KEYDB_H
22 #define G10_KEYDB_H
23
24 #include <assuan.h>
25
26 #include "types.h"
27 #include "packet.h"
28 #include "cipher.h"
29
30 /* What qualifies as a certification (rather than a signature?) */
31 #define IS_CERT(s)       (IS_KEY_SIG(s) || IS_UID_SIG(s) || IS_SUBKEY_SIG(s) \
32                          || IS_KEY_REV(s) || IS_UID_REV(s) || IS_SUBKEY_REV(s))
33 #define IS_SIG(s)        (!IS_CERT(s))
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 struct getkey_ctx_s;
42 typedef struct getkey_ctx_s *GETKEY_CTX;
43
44 /****************
45  * A Keyblock is all packets which form an entire certificate;
46  * i.e. the public key, certificate, trust packets, user ids,
47  * signatures, and subkey.
48  *
49  * This structure is also used to bind arbitrary packets together.
50  */
51
52 struct kbnode_struct {
53     KBNODE next;
54     PACKET *pkt;
55     int flag;
56     int private_flag;
57     ulong recno;  /* used while updating the trustdb */
58 };
59
60 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
61 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
62
63
64 enum resource_type {
65     rt_UNKNOWN = 0,
66     rt_RING = 1
67 };
68
69
70 /****************
71  * A data structre to hold information about the external position
72  * of a keyblock.
73  */
74 struct keyblock_pos_struct {
75     int   resno;     /* resource number */
76     enum resource_type rt;
77     off_t offset;    /* position information */
78     unsigned count;  /* length of the keyblock in packets */
79     iobuf_t  fp;     /* Used by enum_keyblocks. */
80     int secret;      /* working on a secret keyring */
81     PACKET *pkt;     /* ditto */
82     int valid;
83 };
84 typedef struct keyblock_pos_struct KBPOS;
85
86 /* Structure to hold a couple of public key certificates. */
87 typedef struct pk_list *PK_LIST;  /* Deprecated. */
88 typedef struct pk_list *pk_list_t;
89 struct pk_list 
90 {
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
119 /* Helper type for preference fucntions. */
120 union pref_hint
121 {
122   int digest_length;
123 };
124
125
126 /*-- keydb.c --*/
127
128 /*
129   Flag 1 == force
130   Flag 2 == default
131 */
132 int keydb_add_resource (const char *url, int flags, int secret);
133 KEYDB_HANDLE keydb_new (int secret);
134 void keydb_release (KEYDB_HANDLE hd);
135 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
136 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
137 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
138 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
139 int keydb_delete_keyblock (KEYDB_HANDLE hd);
140 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
141 void keydb_rebuild_caches (int noisy);
142 int keydb_search_reset (KEYDB_HANDLE hd);
143 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
144 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
145                    size_t ndesc, size_t *descindex);
146 int keydb_search_first (KEYDB_HANDLE hd);
147 int keydb_search_next (KEYDB_HANDLE hd);
148 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
149 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
150
151
152 /*-- pkclist.c --*/
153 void show_revocation_reason( PKT_public_key *pk, int mode );
154 int  check_signatures_trust( PKT_signature *sig );
155
156 void release_pk_list (PK_LIST pk_list);
157 int  build_pk_list (strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use);
158 gpg_error_t find_and_check_key (const char *name, unsigned int use, 
159                                 int mark_hidden, pk_list_t *pk_list_addr);
160
161 int  algo_available( preftype_t preftype, int algo,
162                      const union pref_hint *hint );
163 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
164                              int request, const union pref_hint *hint);
165 int  select_mdc_from_pklist (PK_LIST pk_list);
166 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
167 void warn_missing_aes_from_pklist (PK_LIST pk_list);
168
169 /*-- skclist.c --*/
170 int  random_is_faked (void);
171 void release_sk_list( SK_LIST sk_list );
172 int  build_sk_list( strlist_t locusr, SK_LIST *ret_sk_list,
173                                             int unlock, unsigned use );
174
175 /*-- passphrase.h --*/
176 assuan_context_t agent_open (int try, const char *orig_codeset);
177 void agent_close (assuan_context_t ctx);
178 int  have_static_passphrase(void);
179 void set_passphrase_from_string(const char *pass);
180 void read_passphrase_from_fd( int fd );
181 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
182 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
183                            int cipher_algo, STRING2KEY *s2k, int mode,
184                            const char *tryagain_text,
185                            const char *custdesc, const char *custprompt,
186                            int *canceled);
187 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
188                         int cipher_algo, STRING2KEY *s2k, int mode,
189                         const char *tryagain_text, int *canceled);
190 void set_next_passphrase( const char *s );
191 char *get_last_passphrase(void);
192 void next_to_last_passphrase(void);
193
194 /*-- getkey.c --*/
195 void cache_public_key( PKT_public_key *pk );
196 void getkey_disable_caches(void);
197 int get_pubkey( PKT_public_key *pk, u32 *keyid );
198 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
199 KBNODE get_pubkeyblock( u32 *keyid );
200 int get_pubkey_byname (GETKEY_CTX *rx, PKT_public_key *pk,  const char *name,
201                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
202                        int include_unusable, int no_akl );
203 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
204                         strlist_t names, KBNODE *ret_keyblock );
205 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
206 void get_pubkey_end( GETKEY_CTX ctx );
207 int get_seckey( PKT_secret_key *sk, u32 *keyid );
208 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
209 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
210                                                  size_t fprint_len );
211 int get_pubkey_byfprint_fast (PKT_public_key *pk,
212                               const byte *fprint, size_t fprint_len);
213 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
214                                                  size_t fprint_len );
215 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
216 int seckey_available( u32 *keyid );
217 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
218 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
219                         strlist_t names, KBNODE *ret_keyblock );
220 int get_seckey_next (GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock);
221 void get_seckey_end( GETKEY_CTX ctx );
222
223 int get_seckey_byfprint( PKT_secret_key *sk,
224                          const byte *fprint, size_t fprint_len);
225 int get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
226                               size_t fprint_len );
227
228
229 int enum_secret_keys( void **context, PKT_secret_key *sk,
230                       int with_subkeys, int with_spm );
231 void merge_keys_and_selfsig( KBNODE keyblock );
232 char*get_user_id_string( u32 *keyid );
233 char*get_user_id_string_native( u32 *keyid );
234 char*get_long_user_id_string( u32 *keyid );
235 char*get_user_id( u32 *keyid, size_t *rn );
236 char*get_user_id_native( u32 *keyid );
237 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
238 void release_akl(void);
239 int parse_auto_key_locate(char *options);
240
241 /*-- keyid.c --*/
242 int pubkey_letter( int algo );
243 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
244 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
245 size_t keystrlen(void);
246 const char *keystr(u32 *keyid);
247 const char *keystr_from_pk(PKT_public_key *pk);
248 const char *keystr_from_sk(PKT_secret_key *sk);
249 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
250 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
251 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
252 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
253 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
254 byte *namehash_from_uid(PKT_user_id *uid);
255 unsigned nbits_from_pk( PKT_public_key *pk );
256 unsigned nbits_from_sk( PKT_secret_key *sk );
257 const char *datestr_from_pk( PKT_public_key *pk );
258 const char *datestr_from_sk( PKT_secret_key *sk );
259 const char *datestr_from_sig( PKT_signature *sig );
260 const char *expirestr_from_pk( PKT_public_key *pk );
261 const char *expirestr_from_sk( PKT_secret_key *sk );
262 const char *expirestr_from_sig( PKT_signature *sig );
263 const char *revokestr_from_pk( PKT_public_key *pk );
264 const char *usagestr_from_pk( PKT_public_key *pk );
265 const char *colon_strtime (u32 t);
266 const char *colon_datestr_from_pk (PKT_public_key *pk);
267 const char *colon_datestr_from_sk (PKT_secret_key *sk);
268 const char *colon_datestr_from_sig (PKT_signature *sig);
269 const char *colon_expirestr_from_sig (PKT_signature *sig);
270 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
271 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
272 char *serialno_and_fpr_from_sk (const unsigned char *sn, size_t snlen,
273                                 PKT_secret_key *sk);
274
275 /*-- kbnode.c --*/
276 KBNODE new_kbnode( PACKET *pkt );
277 KBNODE clone_kbnode( KBNODE node );
278 void release_kbnode( KBNODE n );
279 void delete_kbnode( KBNODE node );
280 void add_kbnode( KBNODE root, KBNODE node );
281 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
282 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
283 void remove_kbnode( KBNODE *root, KBNODE node );
284 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
285 KBNODE find_next_kbnode( KBNODE node, int pkttype );
286 KBNODE find_kbnode( KBNODE node, int pkttype );
287 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
288 void clear_kbnode_flags( KBNODE n );
289 int  commit_kbnode( KBNODE *root );
290 void dump_kbnode( KBNODE node );
291
292 #endif /*G10_KEYDB_H*/