* passphrase.c (agent_get_passphrase): Add new arg CACHEID.
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004 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., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #ifndef G10_KEYDB_H
23 #define G10_KEYDB_H
24
25 #include "types.h"
26 #include "global.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  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;
88 struct pk_list {
89     PK_LIST next;
90     PKT_public_key *pk;
91     int flags; /* flag bit 1==throw_keyid */
92 };
93
94 /* structure to hold a couple of secret key certificates */
95 typedef struct sk_list *SK_LIST;
96 struct sk_list {
97     SK_LIST next;
98     PKT_secret_key *sk;
99     int mark; /* not used */
100 };
101
102 /* structure to collect all information which can be used to
103  * identify a public key */
104 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
105 struct pubkey_find_info {
106     u32  keyid[2];
107     unsigned nbits;
108     byte pubkey_algo;
109     byte fingerprint[MAX_FINGERPRINT_LEN];
110     char userid[1];
111 };
112
113
114 typedef struct keydb_handle *KEYDB_HANDLE;
115
116 typedef enum {
117     KEYDB_SEARCH_MODE_NONE,
118     KEYDB_SEARCH_MODE_EXACT,
119     KEYDB_SEARCH_MODE_SUBSTR,
120     KEYDB_SEARCH_MODE_MAIL,
121     KEYDB_SEARCH_MODE_MAILSUB,
122     KEYDB_SEARCH_MODE_MAILEND,
123     KEYDB_SEARCH_MODE_WORDS,
124     KEYDB_SEARCH_MODE_SHORT_KID,
125     KEYDB_SEARCH_MODE_LONG_KID,
126     KEYDB_SEARCH_MODE_FPR16,
127     KEYDB_SEARCH_MODE_FPR20,
128     KEYDB_SEARCH_MODE_FPR,
129     KEYDB_SEARCH_MODE_FIRST,
130     KEYDB_SEARCH_MODE_NEXT
131 } KeydbSearchMode;
132
133 struct keydb_search_desc {
134     KeydbSearchMode mode;
135     int (*skipfnc)(void *,u32*,PKT_user_id*);
136     void *skipfncvalue;
137     union {
138         const char *name;
139         byte fpr[MAX_FINGERPRINT_LEN];
140         u32  kid[2];
141     } u;
142     int exact;
143 };
144
145 /*-- keydb.c --*/
146
147 /*
148   Flag 1 == force
149   Flag 2 == default
150 */
151 int keydb_add_resource (const char *url, int flags, int secret);
152 KEYDB_HANDLE keydb_new (int secret);
153 void keydb_release (KEYDB_HANDLE hd);
154 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
155 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
156 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
157 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
158 int keydb_delete_keyblock (KEYDB_HANDLE hd);
159 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
160 void keydb_rebuild_caches (int noisy);
161 int keydb_search_reset (KEYDB_HANDLE hd);
162 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
163 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
164                    size_t ndesc, size_t *descindex);
165 int keydb_search_first (KEYDB_HANDLE hd);
166 int keydb_search_next (KEYDB_HANDLE hd);
167 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
168 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
169
170
171 /*-- pkclist.c --*/
172 void show_revocation_reason( PKT_public_key *pk, int mode );
173 int  check_signatures_trust( PKT_signature *sig );
174 void release_pk_list( PK_LIST pk_list );
175 int  build_pk_list( STRLIST rcpts, PK_LIST *ret_pk_list, unsigned use );
176 int  algo_available( preftype_t preftype, int algo, void *hint );
177 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
178                              int request, void *hint );
179 int  select_mdc_from_pklist (PK_LIST pk_list);
180
181 /*-- skclist.c --*/
182 void release_sk_list( SK_LIST sk_list );
183 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
184                                             int unlock, unsigned use );
185
186 /*-- passphrase.h --*/
187 int  have_static_passphrase(void);
188 void read_passphrase_from_fd( int fd );
189 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
190 char *ask_passphrase (const char *description,
191                       const char *tryagain_text,
192                       const char *promptid,
193                       const char *prompt, 
194                       const char *cacheid, int *canceled);
195 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
196                         int cipher_algo, STRING2KEY *s2k, int mode,
197                         const char *tryagain_text, int *canceled);
198 void set_next_passphrase( const char *s );
199 char *get_last_passphrase(void);
200
201 /*-- getkey.c --*/
202 int classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc);
203 void cache_public_key( PKT_public_key *pk );
204 void getkey_disable_caches(void);
205 int get_pubkey( PKT_public_key *pk, u32 *keyid );
206 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
207 KBNODE get_pubkeyblock( u32 *keyid );
208 int get_pubkey_byname( PKT_public_key *pk,  const char *name,
209                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
210                        int include_unusable );
211 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
212                         STRLIST names, KBNODE *ret_keyblock );
213 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
214 void get_pubkey_end( GETKEY_CTX ctx );
215 int get_seckey( PKT_secret_key *sk, u32 *keyid );
216 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
217 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
218                                                  size_t fprint_len );
219 int get_pubkey_byfprint_fast (PKT_public_key *pk,
220                               const byte *fprint, size_t fprint_len);
221 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
222                                                  size_t fprint_len );
223 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
224 int seckey_available( u32 *keyid );
225 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
226 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
227                         STRLIST names, KBNODE *ret_keyblock );
228 int get_seckey_next (GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock);
229 void get_seckey_end( GETKEY_CTX ctx );
230
231 int get_seckey_byfprint( PKT_secret_key *sk,
232                          const byte *fprint, size_t fprint_len);
233 int get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
234                               size_t fprint_len );
235
236
237 int enum_secret_keys( void **context, PKT_secret_key *sk,
238                       int with_subkeys, int with_spm );
239 void merge_keys_and_selfsig( KBNODE keyblock );
240 char*get_user_id_string( u32 *keyid );
241 char*get_user_id_string_native( u32 *keyid );
242 char*get_long_user_id_string( u32 *keyid );
243 char*get_user_id( u32 *keyid, size_t *rn );
244 char*get_user_id_native( u32 *keyid );
245 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
246
247 /*-- keyid.c --*/
248 int pubkey_letter( int algo );
249 void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
250 size_t keystrlen(void);
251 const char *keystr(u32 *keyid);
252 const char *keystr_from_pk(PKT_public_key *pk);
253 const char *keystr_from_sk(PKT_secret_key *sk);
254 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
255 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
256 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
257 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
258 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
259 byte *namehash_from_uid(PKT_user_id *uid);
260 unsigned nbits_from_pk( PKT_public_key *pk );
261 unsigned nbits_from_sk( PKT_secret_key *sk );
262 const char *datestr_from_pk( PKT_public_key *pk );
263 const char *datestr_from_sk( PKT_secret_key *sk );
264 const char *datestr_from_sig( PKT_signature *sig );
265 const char *expirestr_from_pk( PKT_public_key *pk );
266 const char *expirestr_from_sk( PKT_secret_key *sk );
267 const char *expirestr_from_sig( PKT_signature *sig );
268 const char *revokestr_from_pk( PKT_public_key *pk );
269 const char *usagestr_from_pk( PKT_public_key *pk );
270 const char *colon_strtime (u32 t);
271 const char *colon_datestr_from_pk (PKT_public_key *pk);
272 const char *colon_datestr_from_sk (PKT_secret_key *sk);
273 const char *colon_datestr_from_sig (PKT_signature *sig);
274 const char *colon_expirestr_from_sig (PKT_signature *sig);
275 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
276 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
277
278 /*-- kbnode.c --*/
279 KBNODE new_kbnode( PACKET *pkt );
280 KBNODE clone_kbnode( KBNODE node );
281 void release_kbnode( KBNODE n );
282 void delete_kbnode( KBNODE node );
283 void add_kbnode( KBNODE root, KBNODE node );
284 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
285 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
286 void remove_kbnode( KBNODE *root, KBNODE node );
287 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
288 KBNODE find_next_kbnode( KBNODE node, int pkttype );
289 KBNODE find_kbnode( KBNODE node, int pkttype );
290 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
291 void clear_kbnode_flags( KBNODE n );
292 int  commit_kbnode( KBNODE *root );
293 void dump_kbnode( KBNODE node );
294
295 #endif /*G10_KEYDB_H*/