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, 2016 g10 Code GmbH
6 * This file is part of GnuPG.
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.
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.
18 * You should have received a copy of the GNU General Public License
19 * along with this program; if not, see <https://www.gnu.org/licenses/>.
25 #include "../common/types.h"
26 #include "../common/util.h"
29 /* What qualifies as a certification (key-signature in contrast to a
30 * data signature)? Note that a back signature is special and can be
31 * made by key and data signatures capable subkeys.) */
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_BACK_SIG(s) ((s)->sig_class == 0x19)
39 #define IS_KEY_REV(s) ((s)->sig_class == 0x20)
40 #define IS_UID_REV(s) ((s)->sig_class == 0x30)
41 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
44 typedef struct getkey_ctx_s *GETKEY_CTX;
45 typedef struct getkey_ctx_s *getkey_ctx_t;
48 * A Keyblock is all packets which form an entire certificate;
49 * i.e. the public key, certificate, trust packets, user ids,
50 * signatures, and subkey.
52 * This structure is also used to bind arbitrary packets together.
55 struct kbnode_struct {
60 ulong recno; /* used while updating the trustdb */
63 #define is_deleted_kbnode(a) ((a)->private_flag & 1)
64 #define is_cloned_kbnode(a) ((a)->private_flag & 2)
68 * A structure to store key identification as well as some stuff
69 * needed for key validation.
72 struct key_item *next;
73 unsigned int ownertrust,min_ownertrust;
81 /* Bit flags used with build_pk_list. */
84 PK_LIST_ENCRYPT_TO = 1, /* This is an encrypt-to recipient. */
85 PK_LIST_HIDDEN = 2, /* This is a hidden recipient. */
86 PK_LIST_CONFIG = 4, /* Specified via config file. */
87 PK_LIST_FROM_FILE = 8 /* Take key from file with that name. */
90 /* To store private data in the flags the private data must be left
91 * shifted by this value. */
98 /* Structure to hold a couple of public key certificates. */
99 typedef struct pk_list *PK_LIST; /* Deprecated. */
100 typedef struct pk_list *pk_list_t;
105 int flags; /* See PK_LIST_ constants. */
108 /* Structure to hold a list of secret key certificates. */
109 typedef struct sk_list *SK_LIST;
114 int mark; /* not used */
117 /* structure to collect all information which can be used to
118 * identify a public key */
119 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
120 struct pubkey_find_info {
124 byte fingerprint[MAX_FINGERPRINT_LEN];
129 /* Helper type for preference functions. */
136 /* Constants to describe from where a key was fetched or updated. */
140 KEYORG_KS = 1, /* Public keyserver. */
141 KEYORG_KS_PREF = 2, /* Preferred keysrver. */
142 KEYORG_DANE = 3, /* OpenPGP DANE. */
143 KEYORG_WKD = 4, /* Web Key Directory. */
144 KEYORG_URL = 5, /* Trusted URL. */
145 KEYORG_FILE = 6, /* Trusted file. */
146 KEYORG_SELF = 7 /* We generated it. */
151 * Check whether the signature SIG is in the klist K.
153 static inline struct key_item *
154 is_in_klist (struct key_item *k, PKT_signature *sig)
156 for (; k; k = k->next)
158 if (k->kid[0] == sig->keyid[0] && k->kid[1] == sig->keyid[1])
168 #define KEYDB_RESOURCE_FLAG_PRIMARY 2 /* The primary resource. */
169 #define KEYDB_RESOURCE_FLAG_DEFAULT 4 /* The default one. */
170 #define KEYDB_RESOURCE_FLAG_READONLY 8 /* Open in read only mode. */
171 #define KEYDB_RESOURCE_FLAG_GPGVDEF 16 /* Default file for gpgv. */
173 /* Format a search term for debugging output. The caller must free
175 char *keydb_search_desc_dump (struct keydb_search_desc *desc);
177 /* Register a resource (keyring or keybox). */
178 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
180 /* Dump some statistics to the log. */
181 void keydb_dump_stats (void);
183 /* Create a new database handle. Returns NULL on error, sets ERRNO,
184 and prints an error diagnostic. */
185 KEYDB_HANDLE keydb_new (void);
187 /* Free all resources owned by the database handle. */
188 void keydb_release (KEYDB_HANDLE hd);
190 /* Take a lock on the files immediately and not only during insert or
191 * update. This lock is released with keydb_release. */
192 gpg_error_t keydb_lock (KEYDB_HANDLE hd);
194 /* Set a flag on the handle to suppress use of cached results. This
195 is required for updating a keyring and for key listings. Fixme:
196 Using a new parameter for keydb_new might be a better solution. */
197 void keydb_disable_caching (KEYDB_HANDLE hd);
199 /* Save the last found state and invalidate the current selection. */
200 void keydb_push_found_state (KEYDB_HANDLE hd);
202 /* Restore the previous save state. */
203 void keydb_pop_found_state (KEYDB_HANDLE hd);
205 /* Return the file name of the resource. */
206 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
208 /* Return the keyblock last found by keydb_search. */
209 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
211 /* Update the keyblock KB. */
212 gpg_error_t keydb_update_keyblock (ctrl_t ctrl, KEYDB_HANDLE hd, kbnode_t kb);
214 /* Insert a keyblock into one of the underlying keyrings or keyboxes. */
215 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
217 /* Delete the currently selected keyblock. */
218 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
220 /* Find the first writable resource. */
221 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
223 /* Rebuild the on-disk caches of all key resources. */
224 void keydb_rebuild_caches (ctrl_t ctrl, int noisy);
226 /* Return the number of skipped blocks (because they were to large to
227 read from a keybox) since the last search reset. */
228 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
230 /* Clears the current search result and resets the handle's position. */
231 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
233 /* Search the database for keys matching the search description. */
234 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
235 size_t ndesc, size_t *descindex);
237 /* Return the first non-legacy key in the database. */
238 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
240 /* Return the next key (not the next matching key!). */
241 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
243 /* This is a convenience function for searching for keys with a long
245 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
247 /* This is a convenience function for searching for keys with a long
248 (20 byte) fingerprint. */
249 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
253 void show_revocation_reason (ctrl_t ctrl, PKT_public_key *pk, int mode );
254 int check_signatures_trust (ctrl_t ctrl, PKT_signature *sig);
256 void release_pk_list (PK_LIST pk_list);
257 int build_pk_list (ctrl_t ctrl, strlist_t rcpts, PK_LIST *ret_pk_list);
258 gpg_error_t find_and_check_key (ctrl_t ctrl,
259 const char *name, unsigned int use,
260 int mark_hidden, int from_file,
261 pk_list_t *pk_list_addr);
263 int algo_available( preftype_t preftype, int algo,
264 const union pref_hint *hint );
265 int select_algo_from_prefs( PK_LIST pk_list, int preftype,
266 int request, const union pref_hint *hint);
267 int select_mdc_from_pklist (PK_LIST pk_list);
268 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
269 void warn_missing_aes_from_pklist (PK_LIST pk_list);
272 int random_is_faked (void);
273 void release_sk_list( SK_LIST sk_list );
274 gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
275 SK_LIST *ret_sk_list, unsigned use);
277 /*-- passphrase.h --*/
278 unsigned char encode_s2k_iterations (int iterations);
279 int have_static_passphrase(void);
280 const char *get_static_passphrase (void);
281 void set_passphrase_from_string(const char *pass);
282 void read_passphrase_from_fd( int fd );
283 void passphrase_clear_cache (const char *cacheid);
284 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
285 int cipher_algo, STRING2KEY *s2k, int mode,
286 const char *tryagain_text,
287 const char *custdesc, const char *custprompt,
289 DEK *passphrase_to_dek (int cipher_algo, STRING2KEY *s2k,
290 int create, int nocache,
291 const char *tryagain_text, int *canceled);
292 void set_next_passphrase( const char *s );
293 char *get_last_passphrase(void);
294 void next_to_last_passphrase(void);
296 void emit_status_need_passphrase (ctrl_t ctrl, u32 *keyid,
297 u32 *mainkeyid, int pubkey_algo);
299 #define FORMAT_KEYDESC_NORMAL 0
300 #define FORMAT_KEYDESC_IMPORT 1
301 #define FORMAT_KEYDESC_EXPORT 2
302 #define FORMAT_KEYDESC_DELKEY 3
303 char *gpg_format_keydesc (ctrl_t ctrl,
304 PKT_public_key *pk, int mode, int escaped);
309 /* Cache a copy of a public key in the public key cache. */
310 void cache_public_key( PKT_public_key *pk );
312 /* Disable and drop the public key cache. */
313 void getkey_disable_caches(void);
315 /* Return the public key used for signature SIG and store it at PK. */
316 gpg_error_t get_pubkey_for_sig (ctrl_t ctrl,
317 PKT_public_key *pk, PKT_signature *sig);
319 /* Return the public key with the key id KEYID and store it at PK. */
320 int get_pubkey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
322 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
323 account nor does it merge in the self-signed data. This function
324 also only considers primary keys. */
325 int get_pubkey_fast (PKT_public_key *pk, u32 *keyid);
327 /* Return the entire keyblock used to create SIG. This is a
328 * specialized version of get_pubkeyblock. */
329 kbnode_t get_pubkeyblock_for_sig (ctrl_t ctrl, PKT_signature *sig);
331 /* Return the key block for the key with KEYID. */
332 kbnode_t get_pubkeyblock (ctrl_t ctrl, u32 *keyid);
334 /* A list used by get_pubkeys to gather all of the matches. */
337 struct pubkey_s *next;
338 /* The key to use (either the public key or the subkey). */
342 typedef struct pubkey_s *pubkey_t;
344 /* Free a single key. This does not remove key from any list! */
345 void pubkey_free (pubkey_t key);
347 /* Free a list of public keys. */
348 void pubkeys_free (pubkey_t keys);
350 /* Returns all keys that match the search specification SEARCH_TERMS.
351 The returned keys should be freed using pubkeys_free. */
353 get_pubkeys (ctrl_t ctrl,
354 char *search_terms, int use, int include_unusable, char *source,
355 int warn_possibly_ambiguous,
358 /* Find a public key identified by NAME. */
359 int get_pubkey_byname (ctrl_t ctrl,
360 GETKEY_CTX *retctx, PKT_public_key *pk,
362 KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
363 int include_unusable, int no_akl );
365 /* Likewise, but only return the best match if NAME resembles a mail
367 gpg_error_t get_best_pubkey_byname (ctrl_t ctrl,
368 GETKEY_CTX *retctx, PKT_public_key *pk,
369 const char *name, KBNODE *ret_keyblock,
370 int include_unusable, int no_akl);
372 /* Get a public key directly from file FNAME. */
373 gpg_error_t get_pubkey_fromfile (ctrl_t ctrl,
374 PKT_public_key *pk, const char *fname);
376 /* Return the public key with the key id KEYID iff the secret key is
377 * available and store it at PK. */
378 gpg_error_t get_seckey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
380 /* Lookup a key with the specified fingerprint. */
381 int get_pubkey_byfprint (ctrl_t ctrl, PKT_public_key *pk, kbnode_t *r_keyblock,
382 const byte *fprint, size_t fprint_len);
384 /* This function is similar to get_pubkey_byfprint, but it doesn't
385 merge the self-signed data into the public key and subkeys or into
387 gpg_error_t get_pubkey_byfprint_fast (PKT_public_key *pk,
388 const byte *fprint, size_t fprint_len);
390 /* This function is similar to get_pubkey_byfprint, but it doesn't
391 merge the self-signed data into the public key and subkeys or into
393 gpg_error_t get_keyblock_byfprint_fast (kbnode_t *r_keyblock,
395 const byte *fprint, size_t fprint_len,
399 /* Returns true if a secret key is available for the public key with
401 int have_secret_key_with_kid (u32 *keyid);
403 /* Parse the --default-key parameter. Returns the last key (in terms
404 of when the option is given) that is available. */
405 const char *parse_def_secret_key (ctrl_t ctrl);
407 /* Look up a secret key. */
408 gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
409 gpg_error_t get_seckey_default_or_card (ctrl_t ctrl, PKT_public_key *pk,
410 const byte *fpr, size_t fpr_len);
412 /* Search for keys matching some criteria. */
413 gpg_error_t getkey_bynames (ctrl_t ctrl,
414 getkey_ctx_t *retctx, PKT_public_key *pk,
415 strlist_t names, int want_secret,
416 kbnode_t *ret_keyblock);
418 /* Search for one key matching some criteria. */
419 gpg_error_t getkey_byname (ctrl_t ctrl,
420 getkey_ctx_t *retctx, PKT_public_key *pk,
421 const char *name, int want_secret,
422 kbnode_t *ret_keyblock);
424 /* Return the next search result. */
425 gpg_error_t getkey_next (ctrl_t ctrl, getkey_ctx_t ctx,
426 PKT_public_key *pk, kbnode_t *ret_keyblock);
428 /* Release any resources used by a key listing context. */
429 void getkey_end (ctrl_t ctrl, getkey_ctx_t ctx);
431 /* Return the database handle used by this context. The context still
433 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
435 /* Enumerate some secret keys. */
436 gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
438 /* Set the mainkey_id fields for all keys in KEYBLOCK. */
439 void setup_main_keyids (kbnode_t keyblock);
441 /* This function merges information from the self-signed data into the
443 void merge_keys_and_selfsig (ctrl_t ctrl, kbnode_t keyblock);
445 char *get_user_id_string_native (ctrl_t ctrl, u32 *keyid);
446 char *get_long_user_id_string (ctrl_t ctrl, u32 *keyid);
447 char *get_user_id (ctrl_t ctrl, u32 *keyid, size_t *rn, int *r_nouid);
448 char *get_user_id_native (ctrl_t ctrl, u32 *keyid);
449 char *get_user_id_byfpr (ctrl_t ctrl, const byte *fpr, size_t *rn);
450 char *get_user_id_byfpr_native (ctrl_t ctrl, const byte *fpr);
452 void release_akl(void);
453 int parse_auto_key_locate(const char *options);
454 int parse_key_origin (char *string);
455 const char *key_origin_string (int origin);
458 int pubkey_letter( int algo );
459 char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
460 #define PUBKEY_STRING_SIZE 32
461 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
462 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
463 char *format_keyid (u32 *keyid, int format, char *buffer, int len);
465 /* Return PK's keyid. The memory is owned by PK. */
466 u32 *pk_keyid (PKT_public_key *pk);
468 /* Return the keyid of the primary key associated with PK. The memory
470 u32 *pk_main_keyid (PKT_public_key *pk);
472 /* Order A and B. If A < B then return -1, if A == B then return 0,
473 and if A > B then return 1. */
474 static int GPGRT_ATTR_UNUSED
475 keyid_cmp (const u32 *a, const u32 *b)
488 /* Return whether PK is a primary key. */
489 static int GPGRT_ATTR_UNUSED
490 pk_is_primary (PKT_public_key *pk)
492 return keyid_cmp (pk_keyid (pk), pk_main_keyid (pk)) == 0;
495 /* Copy the keyid in SRC to DEST and return DEST. */
496 u32 *keyid_copy (u32 *dest, const u32 *src);
498 size_t keystrlen(void);
499 const char *keystr(u32 *keyid);
500 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
501 const char *keystr_from_pk(PKT_public_key *pk);
502 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
503 PKT_public_key *sub_pk);
505 /* Return PK's key id as a string using the default format. PK owns
507 const char *pk_keyid_str (PKT_public_key *pk);
509 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
510 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
511 u32 keyid_from_sig (PKT_signature *sig, u32 *keyid );
512 u32 keyid_from_fingerprint (ctrl_t ctrl, const byte *fprint, size_t fprint_len,
514 byte *namehash_from_uid(PKT_user_id *uid);
515 unsigned nbits_from_pk( PKT_public_key *pk );
517 /* Convert an UTC TIMESTAMP into an UTC yyyy-mm-dd string. Return
518 * that string. The caller should pass a buffer with at least a size
519 * of MK_DATESTR_SIZE. */
520 char *mk_datestr (char *buffer, size_t bufsize, u32 timestamp);
521 #define MK_DATESTR_SIZE 11
523 const char *datestr_from_pk( PKT_public_key *pk );
524 const char *datestr_from_sig( PKT_signature *sig );
525 const char *expirestr_from_pk( PKT_public_key *pk );
526 const char *expirestr_from_sig( PKT_signature *sig );
527 const char *revokestr_from_pk( PKT_public_key *pk );
528 const char *usagestr_from_pk (PKT_public_key *pk, int fill);
529 const char *colon_strtime (u32 t);
530 const char *colon_datestr_from_pk (PKT_public_key *pk);
531 const char *colon_datestr_from_sig (PKT_signature *sig);
532 const char *colon_expirestr_from_sig (PKT_signature *sig);
533 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
534 char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
535 char *format_hexfingerprint (const char *fingerprint,
536 char *buffer, size_t buflen);
537 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
538 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
542 KBNODE new_kbnode( PACKET *pkt );
543 KBNODE clone_kbnode( KBNODE node );
544 void release_kbnode( KBNODE n );
545 void delete_kbnode( KBNODE node );
546 void add_kbnode( KBNODE root, KBNODE node );
547 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
548 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
549 void remove_kbnode( KBNODE *root, KBNODE node );
550 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
551 KBNODE find_next_kbnode( KBNODE node, int pkttype );
552 KBNODE find_kbnode( KBNODE node, int pkttype );
553 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
554 void clear_kbnode_flags( KBNODE n );
555 int commit_kbnode( KBNODE *root );
556 void dump_kbnode( KBNODE node );
558 #endif /*G10_KEYDB_H*/