cb0e04087776401f4b215af8473ba73ec8016239
[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 "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 typedef struct getkey_ctx_s *getkey_ctx_t;
44
45 /****************
46  * A Keyblock is all packets which form an entire certificate;
47  * i.e. the public key, certificate, trust packets, user ids,
48  * signatures, and subkey.
49  *
50  * This structure is also used to bind arbitrary packets together.
51  */
52
53 struct kbnode_struct {
54     KBNODE next;
55     PACKET *pkt;
56     int flag;
57     int private_flag;
58     ulong recno;  /* used while updating the trustdb */
59 };
60
61 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
62 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
63
64
65 enum resource_type {
66     rt_UNKNOWN = 0,
67     rt_RING = 1
68 };
69
70
71 /****************
72  * A data structre to hold information about the external position
73  * of a keyblock.
74  */
75 struct keyblock_pos_struct {
76     int   resno;     /* resource number */
77     enum resource_type rt;
78     off_t offset;    /* position information */
79     unsigned count;  /* length of the keyblock in packets */
80     iobuf_t  fp;     /* Used by enum_keyblocks. */
81     int secret;      /* working on a secret keyring */
82     PACKET *pkt;     /* ditto */
83     int valid;
84 };
85 typedef struct keyblock_pos_struct KBPOS;
86
87 /* Structure to hold a couple of public key certificates. */
88 typedef struct pk_list *PK_LIST;  /* Deprecated. */
89 typedef struct pk_list *pk_list_t;
90 struct pk_list 
91 {
92   PK_LIST next;
93   PKT_public_key *pk;
94   int flags; /* flag bit 1==throw_keyid */
95 };
96
97 /* Structure to hold a list of secret key certificates.  */
98 typedef struct sk_list *SK_LIST;
99 struct sk_list 
100 {
101   SK_LIST next;
102   PKT_public_key *pk;
103   int mark; /* not used */
104 };
105
106 /* structure to collect all information which can be used to
107  * identify a public key */
108 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
109 struct pubkey_find_info {
110     u32  keyid[2];
111     unsigned nbits;
112     byte pubkey_algo;
113     byte fingerprint[MAX_FINGERPRINT_LEN];
114     char userid[1];
115 };
116
117
118 typedef struct keydb_handle *KEYDB_HANDLE;
119
120
121 /* Helper type for preference fucntions. */
122 union pref_hint
123 {
124   int digest_length;
125 };
126
127
128 /*-- keydb.c --*/
129
130 /*
131   Flag 1 == force
132   Flag 2 == default
133 */
134 int keydb_add_resource (const char *url, int flags, int secret);
135 KEYDB_HANDLE keydb_new (int secret);
136 void keydb_release (KEYDB_HANDLE hd);
137 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
138 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
139 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
140 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
141 int keydb_delete_keyblock (KEYDB_HANDLE hd);
142 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
143 void keydb_rebuild_caches (int noisy);
144 int keydb_search_reset (KEYDB_HANDLE hd);
145 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
146 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
147                    size_t ndesc, size_t *descindex);
148 int keydb_search_first (KEYDB_HANDLE hd);
149 int keydb_search_next (KEYDB_HANDLE hd);
150 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
151 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
152
153
154 /*-- pkclist.c --*/
155 void show_revocation_reason( PKT_public_key *pk, int mode );
156 int  check_signatures_trust( PKT_signature *sig );
157
158 void release_pk_list (PK_LIST pk_list);
159 int  build_pk_list (strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use);
160 gpg_error_t find_and_check_key (const char *name, unsigned int use, 
161                                 int mark_hidden, pk_list_t *pk_list_addr);
162
163 int  algo_available( preftype_t preftype, int algo,
164                      const union pref_hint *hint );
165 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
166                              int request, const union pref_hint *hint);
167 int  select_mdc_from_pklist (PK_LIST pk_list);
168 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
169 void warn_missing_aes_from_pklist (PK_LIST pk_list);
170
171 /*-- skclist.c --*/
172 int  random_is_faked (void);
173 void release_sk_list( SK_LIST sk_list );
174 gpg_error_t  build_sk_list (strlist_t locusr, SK_LIST *ret_sk_list,
175                             int unlock, unsigned use);
176
177 /*-- passphrase.h --*/
178 unsigned char encode_s2k_iterations (int iterations);
179 assuan_context_t agent_open (int try, const char *orig_codeset);
180 void agent_close (assuan_context_t ctx);
181 int  have_static_passphrase(void);
182 void set_passphrase_from_string(const char *pass);
183 void read_passphrase_from_fd( int fd );
184 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
185 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
186                            int cipher_algo, STRING2KEY *s2k, int mode,
187                            const char *tryagain_text,
188                            const char *custdesc, const char *custprompt,
189                            int *canceled);
190 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
191                         int cipher_algo, STRING2KEY *s2k, int mode,
192                         const char *tryagain_text, int *canceled);
193 void set_next_passphrase( const char *s );
194 char *get_last_passphrase(void);
195 void next_to_last_passphrase(void);
196
197 /*-- getkey.c --*/
198 void cache_public_key( PKT_public_key *pk );
199 void getkey_disable_caches(void);
200 int get_pubkey( PKT_public_key *pk, u32 *keyid );
201 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
202 KBNODE get_pubkeyblock( u32 *keyid );
203 int get_pubkey_byname (GETKEY_CTX *rx, PKT_public_key *pk,  const char *name,
204                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
205                        int include_unusable, int no_akl );
206 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
207                         strlist_t names, KBNODE *ret_keyblock );
208 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
209 void get_pubkey_end( GETKEY_CTX ctx );
210 int get_seckey( PKT_secret_key *sk, u32 *keyid );
211 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
212 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
213                                                  size_t fprint_len );
214 int get_pubkey_byfprint_fast (PKT_public_key *pk,
215                               const byte *fprint, size_t fprint_len);
216 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
217                                                  size_t fprint_len );
218 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
219 int seckey_available( u32 *keyid );
220 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
221 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
222                         strlist_t names, KBNODE *ret_keyblock );
223 int get_seckey_next (GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock);
224 void get_seckey_end( GETKEY_CTX ctx );
225
226 int get_seckey_byfprint( PKT_secret_key *sk,
227                          const byte *fprint, size_t fprint_len);
228 int get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
229                               size_t fprint_len );
230
231 gpg_error_t getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
232                             strlist_t names, int want_secret,
233                             kbnode_t *ret_keyblock);
234 gpg_error_t getkey_byname (getkey_ctx_t *retctx, PKT_public_key *pk,
235                            const char *name, int want_secret,
236                            kbnode_t *ret_keyblock);
237 gpg_error_t getkey_next (getkey_ctx_t ctx, PKT_public_key *pk,
238                          kbnode_t *ret_keyblock);
239 void getkey_end (getkey_ctx_t ctx);
240
241 gpg_error_t have_secret_key (kbnode_t keyblock);
242
243
244 int enum_secret_keys( void **context, PKT_secret_key *sk,
245                       int with_subkeys, int with_spm );
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_from_pk(PKT_public_key *pk);
263 const char *keystr_from_sk(PKT_secret_key *sk);
264 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
265 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
266 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
267 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
268 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
269 byte *namehash_from_uid(PKT_user_id *uid);
270 unsigned nbits_from_pk( PKT_public_key *pk );
271 unsigned nbits_from_sk( PKT_secret_key *sk );
272 const char *datestr_from_pk( PKT_public_key *pk );
273 const char *datestr_from_sk( PKT_secret_key *sk );
274 const char *datestr_from_sig( PKT_signature *sig );
275 const char *expirestr_from_pk( PKT_public_key *pk );
276 const char *expirestr_from_sk( PKT_secret_key *sk );
277 const char *expirestr_from_sig( PKT_signature *sig );
278 const char *revokestr_from_pk( PKT_public_key *pk );
279 const char *usagestr_from_pk( PKT_public_key *pk );
280 const char *colon_strtime (u32 t);
281 const char *colon_datestr_from_pk (PKT_public_key *pk);
282 const char *colon_datestr_from_sk (PKT_secret_key *sk);
283 const char *colon_datestr_from_sig (PKT_signature *sig);
284 const char *colon_expirestr_from_sig (PKT_signature *sig);
285 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
286 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
287 char *serialno_and_fpr_from_sk (const unsigned char *sn, size_t snlen,
288                                 PKT_secret_key *sk);
289
290 /*-- kbnode.c --*/
291 KBNODE new_kbnode( PACKET *pkt );
292 KBNODE clone_kbnode( KBNODE node );
293 void release_kbnode( KBNODE n );
294 void delete_kbnode( KBNODE node );
295 void add_kbnode( KBNODE root, KBNODE node );
296 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
297 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
298 void remove_kbnode( KBNODE *root, KBNODE node );
299 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
300 KBNODE find_next_kbnode( KBNODE node, int pkttype );
301 KBNODE find_kbnode( KBNODE node, int pkttype );
302 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
303 void clear_kbnode_flags( KBNODE n );
304 int  commit_kbnode( KBNODE *root );
305 void dump_kbnode( KBNODE node );
306
307 #endif /*G10_KEYDB_H*/