gpg: Fix format_keyid when dynamically allocating the buffer.
[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  * Copyright (C) 2015 g10 Code GmbH
5  *
6  * This file is part of GnuPG.
7  *
8  * GnuPG is free software; you can redistribute it and/or modify
9  * it under the terms of the GNU General Public License as published by
10  * the Free Software Foundation; either version 3 of the License, or
11  * (at your option) any later version.
12  *
13  * GnuPG is distributed in the hope that it will be useful,
14  * but WITHOUT ANY WARRANTY; without even the implied warranty of
15  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
16  * GNU General Public License for more details.
17  *
18  * You should have received a copy of the GNU General Public License
19  * along with this program; if not, see <http://www.gnu.org/licenses/>.
20  */
21
22 #ifndef G10_KEYDB_H
23 #define G10_KEYDB_H
24
25 #include <assuan.h>
26
27 #include "types.h"
28 #include "util.h"
29 #include "packet.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 /* Bit flags used with build_pk_list.  */
73 enum
74   {
75     PK_LIST_ENCRYPT_TO=1,   /* This is an encrypt-to recipient.  */
76     PK_LIST_HIDDEN=2,       /* This is a hidden recipient.       */
77     PK_LIST_CONFIG=4        /* Specified via config file.        */
78   };
79 /* To store private data in the flags they must be left shifted by
80    this value.  */
81 enum
82   {
83     PK_LIST_SHIFT=3
84   };
85
86 /****************
87  * A data structure to hold information about the external position
88  * of a keyblock.
89  */
90 struct keyblock_pos_struct {
91     int   resno;     /* resource number */
92     enum resource_type rt;
93     off_t offset;    /* position information */
94     unsigned count;  /* length of the keyblock in packets */
95     iobuf_t  fp;     /* Used by enum_keyblocks. */
96     int secret;      /* working on a secret keyring */
97     PACKET *pkt;     /* ditto */
98     int valid;
99 };
100 typedef struct keyblock_pos_struct KBPOS;
101
102 /* Structure to hold a couple of public key certificates. */
103 typedef struct pk_list *PK_LIST;  /* Deprecated. */
104 typedef struct pk_list *pk_list_t;
105 struct pk_list
106 {
107   PK_LIST next;
108   PKT_public_key *pk;
109   int flags; /* flag bit 1==throw_keyid */
110 };
111
112 /* Structure to hold a list of secret key certificates.  */
113 typedef struct sk_list *SK_LIST;
114 struct sk_list
115 {
116   SK_LIST next;
117   PKT_public_key *pk;
118   int mark; /* not used */
119 };
120
121 /* structure to collect all information which can be used to
122  * identify a public key */
123 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
124 struct pubkey_find_info {
125     u32  keyid[2];
126     unsigned nbits;
127     byte pubkey_algo;
128     byte fingerprint[MAX_FINGERPRINT_LEN];
129     char userid[1];
130 };
131
132
133 typedef struct keydb_handle *KEYDB_HANDLE;
134
135
136 /* Helper type for preference fucntions. */
137 union pref_hint
138 {
139   int digest_length;
140 };
141
142
143 /*-- keydb.c --*/
144
145 #define KEYDB_RESOURCE_FLAG_PRIMARY  2  /* The primary resource.  */
146 #define KEYDB_RESOURCE_FLAG_DEFAULT  4  /* The default one.  */
147 #define KEYDB_RESOURCE_FLAG_READONLY 8  /* Open in read only mode.  */
148 #define KEYDB_RESOURCE_FLAG_GPGVDEF 16  /* Default file for gpgv.  */
149
150 /* Format a search term for debugging output.  The caller must free
151    the result.  */
152 char *keydb_search_desc_dump (struct keydb_search_desc *desc);
153
154 /* Register a resource (keyring or keybox).  */
155 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
156
157 /* Dump some statistics to the log.  */
158 void keydb_dump_stats (void);
159
160 /* Create a new database handle.  Returns NULL on error, sets ERRNO,
161    and prints an error diagnostic. */
162 KEYDB_HANDLE keydb_new (void);
163
164 /* Free all resources owned by the database handle.  */
165 void keydb_release (KEYDB_HANDLE hd);
166
167 /* Set a flag on the handle to suppress use of cached results.  This
168    is required for updating a keyring and for key listings.  Fixme:
169    Using a new parameter for keydb_new might be a better solution.  */
170 void keydb_disable_caching (KEYDB_HANDLE hd);
171
172 /* Save the last found state and invalidate the current selection.  */
173 void keydb_push_found_state (KEYDB_HANDLE hd);
174
175 /* Restore the previous save state.  */
176 void keydb_pop_found_state (KEYDB_HANDLE hd);
177
178 /* Return the file name of the resource.  */
179 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
180
181 /* Return the keyblock last found by keydb_search.  */
182 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
183
184 /* Update the keyblock KB.  */
185 gpg_error_t keydb_update_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
186
187 /* Insert a keyblock into one of the underlying keyrings or keyboxes.  */
188 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
189
190 /* Delete the currently selected keyblock.  */
191 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
192
193 /* Find the first writable resource.  */
194 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
195
196 /* Rebuild the on-disk caches of all key resources.  */
197 void keydb_rebuild_caches (int noisy);
198
199 /* Return the number of skipped blocks (because they were to large to
200    read from a keybox) since the last search reset.  */
201 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
202
203 /* Clears the current search result and resets the handle's position.  */
204 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
205
206 /* Search the database for keys matching the search description.  */
207 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
208                           size_t ndesc, size_t *descindex);
209
210 /* Return the first non-legacy key in the database.  */
211 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
212
213 /* Return the next key (not the next matching key!).  */
214 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
215
216 /* This is a convenience function for searching for keys with a long
217    key id.  */
218 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
219
220 /* This is a convenience function for searching for keys with a long
221    (20 byte) fingerprint.  */
222 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
223
224
225 /*-- pkclist.c --*/
226 void show_revocation_reason( PKT_public_key *pk, int mode );
227 int  check_signatures_trust( PKT_signature *sig );
228
229 void release_pk_list (PK_LIST pk_list);
230 int  build_pk_list (ctrl_t ctrl, strlist_t rcpts, PK_LIST *ret_pk_list);
231 gpg_error_t find_and_check_key (ctrl_t ctrl,
232                                 const char *name, unsigned int use,
233                                 int mark_hidden, pk_list_t *pk_list_addr);
234
235 int  algo_available( preftype_t preftype, int algo,
236                      const union pref_hint *hint );
237 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
238                              int request, const union pref_hint *hint);
239 int  select_mdc_from_pklist (PK_LIST pk_list);
240 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
241 void warn_missing_aes_from_pklist (PK_LIST pk_list);
242
243 /*-- skclist.c --*/
244 int  random_is_faked (void);
245 void release_sk_list( SK_LIST sk_list );
246 gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
247                            SK_LIST *ret_sk_list, unsigned use);
248
249 /*-- passphrase.h --*/
250 unsigned char encode_s2k_iterations (int iterations);
251 assuan_context_t agent_open (int try, const char *orig_codeset);
252 void agent_close (assuan_context_t ctx);
253 int  have_static_passphrase(void);
254 const char *get_static_passphrase (void);
255 void set_passphrase_from_string(const char *pass);
256 void read_passphrase_from_fd( int fd );
257 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
258 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
259                            int cipher_algo, STRING2KEY *s2k, int mode,
260                            const char *tryagain_text,
261                            const char *custdesc, const char *custprompt,
262                            int *canceled);
263 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
264                         int cipher_algo, STRING2KEY *s2k, int mode,
265                         const char *tryagain_text, int *canceled);
266 void set_next_passphrase( const char *s );
267 char *get_last_passphrase(void);
268 void next_to_last_passphrase(void);
269
270 void emit_status_need_passphrase (u32 *keyid, u32 *mainkeyid, int pubkey_algo);
271
272 #define FORMAT_KEYDESC_NORMAL  0
273 #define FORMAT_KEYDESC_IMPORT  1
274 #define FORMAT_KEYDESC_EXPORT  2
275 #define FORMAT_KEYDESC_DELKEY  3
276 char *gpg_format_keydesc (PKT_public_key *pk, int mode, int escaped);
277
278
279 /*-- getkey.c --*/
280
281 /* Cache a copy of a public key in the public key cache.  */
282 void cache_public_key( PKT_public_key *pk );
283
284 /* Disable and drop the public key cache.  */
285 void getkey_disable_caches(void);
286
287 /* Return the public key with the key id KEYID and store it at PK.  */
288 int get_pubkey( PKT_public_key *pk, u32 *keyid );
289
290 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
291    account nor does it merge in the self-signed data.  This function
292    also only considers primary keys.  */
293 int get_pubkey_fast (PKT_public_key *pk, u32 *keyid);
294
295 /* Return the key block for the key with KEYID.  */
296 kbnode_t get_pubkeyblock (u32 *keyid);
297
298 /* A list used by get_pubkeys to gather all of the matches.  */
299 struct pubkey_s
300 {
301   struct pubkey_s *next;
302   /* The key to use (either the public key or the subkey).  */
303   PKT_public_key *pk;
304   kbnode_t keyblock;
305 };
306 typedef struct pubkey_s *pubkey_t;
307
308 /* Free a single key.  This does not remove key from any list!  */
309 void pubkey_free (pubkey_t key);
310
311 /* Free a list of public keys.  */
312 void pubkeys_free (pubkey_t keys);
313
314 /* Returns all keys that match the search specfication SEARCH_TERMS.
315    The returned keys should be freed using pubkeys_free.  */
316 gpg_error_t
317 get_pubkeys (ctrl_t ctrl,
318              char *search_terms, int use, int include_unusable, char *source,
319              int warn_possibly_ambiguous,
320              pubkey_t *r_keys);
321
322 /* Find a public key identified by NAME.  */
323 int get_pubkey_byname (ctrl_t ctrl,
324                        GETKEY_CTX *retctx, PKT_public_key *pk,
325                        const char *name,
326                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
327                        int include_unusable, int no_akl );
328
329 /* Return the public key with the key id KEYID iff the secret key is
330  * available and store it at PK.  */
331 gpg_error_t get_seckey (PKT_public_key *pk, u32 *keyid);
332
333 /* Lookup a key with the specified fingerprint.  */
334 int get_pubkey_byfprint (PKT_public_key *pk,  kbnode_t *r_keyblock,
335                          const byte *fprint, size_t fprint_len);
336
337 /* This function is similar to get_pubkey_byfprint, but it doesn't
338    merge the self-signed data into the public key and subkeys or into
339    the user ids.  */
340 int get_pubkey_byfprint_fast (PKT_public_key *pk,
341                               const byte *fprint, size_t fprint_len);
342
343 /* Returns true if a secret key is available for the public key with
344    key id KEYID.  */
345 int have_secret_key_with_kid (u32 *keyid);
346
347 /* Parse the --default-key parameter.  Returns the last key (in terms
348    of when the option is given) that is available.  */
349 const char *parse_def_secret_key (ctrl_t ctrl);
350
351 /* Look up a secret key.  */
352 gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
353
354 /* Search for keys matching some criteria.  */
355 gpg_error_t getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
356                             strlist_t names, int want_secret,
357                             kbnode_t *ret_keyblock);
358
359 /* Search for one key matching some criteria.  */
360 gpg_error_t getkey_byname (ctrl_t ctrl,
361                            getkey_ctx_t *retctx, PKT_public_key *pk,
362                            const char *name, int want_secret,
363                            kbnode_t *ret_keyblock);
364
365 /* Return the next search result.  */
366 gpg_error_t getkey_next (getkey_ctx_t ctx, PKT_public_key *pk,
367                          kbnode_t *ret_keyblock);
368
369 /* Release any resources used by a key listing context.  */
370 void getkey_end (getkey_ctx_t ctx);
371
372 /* Return the database handle used by this context.  The context still
373    owns the handle.  */
374 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
375
376 /* Enumerate some secret keys.  */
377 gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
378
379 /* Set the mainkey_id fields for all keys in KEYBLOCK.  */
380 void setup_main_keyids (kbnode_t keyblock);
381
382 /* This function merges information from the self-signed data into the
383    data structures.  */
384 void merge_keys_and_selfsig (kbnode_t keyblock);
385
386 char*get_user_id_string_native( u32 *keyid );
387 char*get_long_user_id_string( u32 *keyid );
388 char*get_user_id( u32 *keyid, size_t *rn );
389 char*get_user_id_native( u32 *keyid );
390 char *get_user_id_byfpr (const byte *fpr, size_t *rn);
391 char *get_user_id_byfpr_native (const byte *fpr);
392
393 void release_akl(void);
394 int parse_auto_key_locate(char *options);
395
396 /*-- keyid.c --*/
397 int pubkey_letter( int algo );
398 char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
399 #define PUBKEY_STRING_SIZE 32
400 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
401 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
402 char *format_keyid (u32 *keyid, int format, char *buffer, int len);
403 size_t keystrlen(void);
404 const char *keystr(u32 *keyid);
405 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
406 const char *keystr_from_pk(PKT_public_key *pk);
407 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
408                                      PKT_public_key *sub_pk);
409 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
410 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
411 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
412 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
413 byte *namehash_from_uid(PKT_user_id *uid);
414 unsigned nbits_from_pk( PKT_public_key *pk );
415 const char *datestr_from_pk( PKT_public_key *pk );
416 const char *datestr_from_sig( PKT_signature *sig );
417 const char *expirestr_from_pk( PKT_public_key *pk );
418 const char *expirestr_from_sig( PKT_signature *sig );
419 const char *revokestr_from_pk( PKT_public_key *pk );
420 const char *usagestr_from_pk (PKT_public_key *pk, int fill);
421 const char *colon_strtime (u32 t);
422 const char *colon_datestr_from_pk (PKT_public_key *pk);
423 const char *colon_datestr_from_sig (PKT_signature *sig);
424 const char *colon_expirestr_from_sig (PKT_signature *sig);
425 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
426 char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
427 char *format_hexfingerprint (const char *fingerprint,
428                              char *buffer, size_t buflen);
429 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
430 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
431
432
433 /*-- kbnode.c --*/
434 KBNODE new_kbnode( PACKET *pkt );
435 KBNODE clone_kbnode( KBNODE node );
436 void release_kbnode( KBNODE n );
437 void delete_kbnode( KBNODE node );
438 void add_kbnode( KBNODE root, KBNODE node );
439 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
440 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
441 void remove_kbnode( KBNODE *root, KBNODE node );
442 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
443 KBNODE find_next_kbnode( KBNODE node, int pkttype );
444 KBNODE find_kbnode( KBNODE node, int pkttype );
445 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
446 void clear_kbnode_flags( KBNODE n );
447 int  commit_kbnode( KBNODE *root );
448 void dump_kbnode( KBNODE node );
449
450 #endif /*G10_KEYDB_H*/