More agent support for gpg.
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
3  *               2006, 2010 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 "util.h"
28 #include "packet.h"
29 #include "cipher.h"
30
31 /* What qualifies as a certification (rather than a signature?) */
32 #define IS_CERT(s)       (IS_KEY_SIG(s) || IS_UID_SIG(s) || IS_SUBKEY_SIG(s) \
33                          || IS_KEY_REV(s) || IS_UID_REV(s) || IS_SUBKEY_REV(s))
34 #define IS_SIG(s)        (!IS_CERT(s))
35 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
36 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
37 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
38 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
39 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
40 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
41
42 struct getkey_ctx_s;
43 typedef struct getkey_ctx_s *GETKEY_CTX;
44 typedef struct getkey_ctx_s *getkey_ctx_t;
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;  /* Deprecated. */
90 typedef struct pk_list *pk_list_t;
91 struct pk_list 
92 {
93   PK_LIST next;
94   PKT_public_key *pk;
95   int flags; /* flag bit 1==throw_keyid */
96 };
97
98 /* Structure to hold a list of secret key certificates.  */
99 typedef struct sk_list *SK_LIST;
100 struct sk_list 
101 {
102   SK_LIST next;
103   PKT_public_key *pk;
104   int mark; /* not used */
105 };
106
107 /* structure to collect all information which can be used to
108  * identify a public key */
109 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
110 struct pubkey_find_info {
111     u32  keyid[2];
112     unsigned nbits;
113     byte pubkey_algo;
114     byte fingerprint[MAX_FINGERPRINT_LEN];
115     char userid[1];
116 };
117
118
119 typedef struct keydb_handle *KEYDB_HANDLE;
120
121
122 /* Helper type for preference fucntions. */
123 union pref_hint
124 {
125   int digest_length;
126 };
127
128
129 /*-- keydb.c --*/
130
131 /*
132   Flag 1 == force
133   Flag 2 == default
134 */
135 int keydb_add_resource (const char *url, int flags);
136 KEYDB_HANDLE keydb_new (void);
137 void keydb_release (KEYDB_HANDLE hd);
138 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
139 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
140 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
141 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
142 int keydb_delete_keyblock (KEYDB_HANDLE hd);
143 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
144 void keydb_rebuild_caches (int noisy);
145 int keydb_search_reset (KEYDB_HANDLE hd);
146 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
147 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
148                    size_t ndesc, size_t *descindex);
149 int keydb_search_first (KEYDB_HANDLE hd);
150 int keydb_search_next (KEYDB_HANDLE hd);
151 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
152 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
153
154
155 /*-- pkclist.c --*/
156 void show_revocation_reason( PKT_public_key *pk, int mode );
157 int  check_signatures_trust( PKT_signature *sig );
158
159 void release_pk_list (PK_LIST pk_list);
160 int  build_pk_list (ctrl_t ctrl,
161                     strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use);
162 gpg_error_t find_and_check_key (ctrl_t ctrl,
163                                 const char *name, unsigned int use, 
164                                 int mark_hidden, pk_list_t *pk_list_addr);
165
166 int  algo_available( preftype_t preftype, int algo,
167                      const union pref_hint *hint );
168 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
169                              int request, const union pref_hint *hint);
170 int  select_mdc_from_pklist (PK_LIST pk_list);
171 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
172 void warn_missing_aes_from_pklist (PK_LIST pk_list);
173
174 /*-- skclist.c --*/
175 int  random_is_faked (void);
176 void release_sk_list( SK_LIST sk_list );
177 gpg_error_t  build_sk_list (strlist_t locusr, SK_LIST *ret_sk_list,
178                             unsigned use);
179
180 /*-- passphrase.h --*/
181 unsigned char encode_s2k_iterations (int iterations);
182 assuan_context_t agent_open (int try, const char *orig_codeset);
183 void agent_close (assuan_context_t ctx);
184 int  have_static_passphrase(void);
185 void set_passphrase_from_string(const char *pass);
186 void read_passphrase_from_fd( int fd );
187 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
188 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
189                            int cipher_algo, STRING2KEY *s2k, int mode,
190                            const char *tryagain_text,
191                            const char *custdesc, const char *custprompt,
192                            int *canceled);
193 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
194                         int cipher_algo, STRING2KEY *s2k, int mode,
195                         const char *tryagain_text, int *canceled);
196 void set_next_passphrase( const char *s );
197 char *get_last_passphrase(void);
198 void next_to_last_passphrase(void);
199
200 char *gpg_format_keydesc (PKT_public_key *pk, int mode, int escaped);
201
202
203 /*-- getkey.c --*/
204 void cache_public_key( PKT_public_key *pk );
205 void getkey_disable_caches(void);
206 int get_pubkey( PKT_public_key *pk, u32 *keyid );
207 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
208 KBNODE get_pubkeyblock( u32 *keyid );
209 int get_pubkey_byname (ctrl_t ctrl,
210                        GETKEY_CTX *rx, PKT_public_key *pk,  const char *name,
211                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
212                        int include_unusable, int no_akl );
213 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
214                         strlist_t names, KBNODE *ret_keyblock );
215 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
216 void get_pubkey_end( GETKEY_CTX ctx );
217 gpg_error_t get_seckey (PKT_public_key *pk, u32 *keyid);
218 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
219                                                  size_t fprint_len );
220 int get_pubkey_byfprint_fast (PKT_public_key *pk,
221                               const byte *fprint, size_t fprint_len);
222 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
223                                                  size_t fprint_len );
224
225 int have_secret_key_with_kid (u32 *keyid);
226
227 gpg_error_t get_seckey_byname (PKT_public_key *pk, const char *name);
228
229 gpg_error_t get_seckey_byfprint (PKT_public_key *pk,
230                                  const byte *fprint, size_t fprint_len);
231 gpg_error_t get_seckeyblock_byfprint (kbnode_t *ret_keyblock, 
232                                       const byte *fprint, size_t fprint_len);
233
234 gpg_error_t getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
235                             strlist_t names, int want_secret,
236                             kbnode_t *ret_keyblock);
237 gpg_error_t getkey_byname (getkey_ctx_t *retctx, PKT_public_key *pk,
238                            const char *name, int want_secret,
239                            kbnode_t *ret_keyblock);
240 gpg_error_t getkey_next (getkey_ctx_t ctx, PKT_public_key *pk,
241                          kbnode_t *ret_keyblock);
242 void getkey_end (getkey_ctx_t ctx);
243
244 gpg_error_t enum_secret_keys (void **context, PKT_public_key *pk);
245
246 void merge_keys_and_selfsig( KBNODE keyblock );
247 char*get_user_id_string( u32 *keyid );
248 char*get_user_id_string_native( u32 *keyid );
249 char*get_long_user_id_string( u32 *keyid );
250 char*get_user_id( u32 *keyid, size_t *rn );
251 char*get_user_id_native( u32 *keyid );
252 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
253 void release_akl(void);
254 int parse_auto_key_locate(char *options);
255
256 /*-- keyid.c --*/
257 int pubkey_letter( int algo );
258 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
259 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
260 size_t keystrlen(void);
261 const char *keystr(u32 *keyid);
262 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
263 const char *keystr_from_pk(PKT_public_key *pk);
264 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
265                                      PKT_public_key *sub_pk);
266 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
267 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
268 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
269 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
270 byte *namehash_from_uid(PKT_user_id *uid);
271 unsigned nbits_from_pk( PKT_public_key *pk );
272 const char *datestr_from_pk( PKT_public_key *pk );
273 const char *datestr_from_sig( PKT_signature *sig );
274 const char *expirestr_from_pk( PKT_public_key *pk );
275 const char *expirestr_from_sig( PKT_signature *sig );
276 const char *revokestr_from_pk( PKT_public_key *pk );
277 const char *usagestr_from_pk( PKT_public_key *pk );
278 const char *colon_strtime (u32 t);
279 const char *colon_datestr_from_pk (PKT_public_key *pk);
280 const char *colon_datestr_from_sig (PKT_signature *sig);
281 const char *colon_expirestr_from_sig (PKT_signature *sig);
282 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
283 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
284 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
285
286
287 /*-- kbnode.c --*/
288 KBNODE new_kbnode( PACKET *pkt );
289 KBNODE clone_kbnode( KBNODE node );
290 void release_kbnode( KBNODE n );
291 void delete_kbnode( KBNODE node );
292 void add_kbnode( KBNODE root, KBNODE node );
293 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
294 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
295 void remove_kbnode( KBNODE *root, KBNODE node );
296 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
297 KBNODE find_next_kbnode( KBNODE node, int pkttype );
298 KBNODE find_kbnode( KBNODE node, int pkttype );
299 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
300 void clear_kbnode_flags( KBNODE n );
301 int  commit_kbnode( KBNODE *root );
302 void dump_kbnode( KBNODE node );
303
304 #endif /*G10_KEYDB_H*/