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) \
39 #define IS_SIG(s) (!IS_CERT(s))
40 #define IS_KEY_SIG(s) ((s)->sig_class == 0x1f)
41 #define IS_UID_SIG(s) (((s)->sig_class & ~3) == 0x10)
42 #define IS_ATTST_SIGS(s) ((s)->sig_class == 0x16)
43 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
44 #define IS_BACK_SIG(s) ((s)->sig_class == 0x19)
45 #define IS_KEY_REV(s) ((s)->sig_class == 0x20)
46 #define IS_UID_REV(s) ((s)->sig_class == 0x30)
47 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
50 typedef struct getkey_ctx_s *GETKEY_CTX;
51 typedef struct getkey_ctx_s *getkey_ctx_t;
54 * A Keyblock is all packets which form an entire certificate;
55 * i.e. the public key, certificate, trust packets, user ids,
56 * signatures, and subkey.
58 * This structure is also used to bind arbitrary packets together.
65 int flag; /* Local use during keyblock processing (not cloned).*/
66 unsigned int tag; /* Ditto. */
70 #define is_deleted_kbnode(a) ((a)->private_flag & 1)
71 #define is_cloned_kbnode(a) ((a)->private_flag & 2)
75 * A structure to store key identification as well as some stuff
76 * needed for key validation.
79 struct key_item *next;
80 unsigned int ownertrust,min_ownertrust;
88 /* Bit flags used with build_pk_list. */
91 PK_LIST_ENCRYPT_TO = 1, /* This is an encrypt-to recipient. */
92 PK_LIST_HIDDEN = 2, /* This is a hidden recipient. */
93 PK_LIST_CONFIG = 4, /* Specified via config file. */
94 PK_LIST_FROM_FILE = 8 /* Take key from file with that name. */
97 /* To store private data in the flags the private data must be left
98 * shifted by this value. */
105 /* Structure to hold a couple of public key certificates. */
106 typedef struct pk_list *PK_LIST; /* Deprecated. */
107 typedef struct pk_list *pk_list_t;
112 int flags; /* See PK_LIST_ constants. */
115 /* Structure to hold a list of secret key certificates. */
116 typedef struct sk_list *SK_LIST;
121 int mark; /* not used */
124 /* structure to collect all information which can be used to
125 * identify a public key */
126 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
127 struct pubkey_find_info {
131 byte fingerprint[MAX_FINGERPRINT_LEN];
136 /* Helper type for preference functions. */
139 int digest_length; /* We want at least this digest length. */
140 int exact; /* We need to use exactly this length. */
144 /* Constants to describe from where a key was fetched or updated. */
148 KEYORG_KS = 1, /* Public keyserver. */
149 KEYORG_KS_PREF = 2, /* Preferred keysrver. */
150 KEYORG_DANE = 3, /* OpenPGP DANE. */
151 KEYORG_WKD = 4, /* Web Key Directory. */
152 KEYORG_URL = 5, /* Trusted URL. */
153 KEYORG_FILE = 6, /* Trusted file. */
154 KEYORG_SELF = 7 /* We generated it. */
159 * Check whether the signature SIG is in the klist K.
161 static inline struct key_item *
162 is_in_klist (struct key_item *k, PKT_signature *sig)
164 for (; k; k = k->next)
166 if (k->kid[0] == sig->keyid[0] && k->kid[1] == sig->keyid[1])
173 /*-- call-keyboxd.c --*/
175 /* Release all open contexts to the keyboxd. */
176 void gpg_keyboxd_deinit_session_data (ctrl_t ctrl);
178 /* Create a new database handle. Returns NULL on error, sets ERRNO,
179 * and prints an error diagnostic. */
180 KEYDB_HANDLE keydb_new (ctrl_t ctrl);
182 /* Release a keydb handle. */
183 void keydb_release (KEYDB_HANDLE hd);
185 /* Take a lock if we are not using the keyboxd. */
186 gpg_error_t keydb_lock (KEYDB_HANDLE hd);
188 /* Return the keyblock last found by keydb_search. */
189 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, kbnode_t *ret_kb);
191 /* Update the keyblock KB. */
192 gpg_error_t keydb_update_keyblock (ctrl_t ctrl, KEYDB_HANDLE hd, kbnode_t kb);
194 /* Insert a keyblock into one of the storage system. */
195 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
197 /* Delete the currently selected keyblock. */
198 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
200 /* Clears the current search result and resets the handle's position. */
201 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
203 /* Search the database for keys matching the search description. */
204 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
205 size_t ndesc, size_t *descindex);
211 #define KEYDB_RESOURCE_FLAG_PRIMARY 2 /* The primary resource. */
212 #define KEYDB_RESOURCE_FLAG_DEFAULT 4 /* The default one. */
213 #define KEYDB_RESOURCE_FLAG_READONLY 8 /* Open in read only mode. */
214 #define KEYDB_RESOURCE_FLAG_GPGVDEF 16 /* Default file for gpgv. */
216 /* Format a search term for debugging output. The caller must free
218 char *keydb_search_desc_dump (struct keydb_search_desc *desc);
220 /* Register a resource (keyring or keybox). */
221 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
223 /* Dump some statistics to the log. */
224 void keydb_dump_stats (void);
226 /* Set a flag on the handle to suppress use of cached results. This
227 is required for updating a keyring and for key listings. Fixme:
228 Using a new parameter for keydb_new might be a better solution. */
229 void keydb_disable_caching (KEYDB_HANDLE hd);
231 /* Save the last found state and invalidate the current selection. */
232 void keydb_push_found_state (KEYDB_HANDLE hd);
234 /* Restore the previous save state. */
235 void keydb_pop_found_state (KEYDB_HANDLE hd);
237 /* Return the file name of the resource. */
238 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
240 /* Find the first writable resource. */
241 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
243 /* Rebuild the on-disk caches of all key resources. */
244 void keydb_rebuild_caches (ctrl_t ctrl, int noisy);
246 /* Return the number of skipped blocks (because they were to large to
247 read from a keybox) since the last search reset. */
248 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
250 /* Return the first non-legacy key in the database. */
251 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
253 /* Return the next key (not the next matching key!). */
254 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
256 /* This is a convenience function for searching for keys with a long
258 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
260 /* This is a convenience function for searching for keys by
262 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr, size_t fprlen);
266 void show_revocation_reason (ctrl_t ctrl, PKT_public_key *pk, int mode );
267 gpg_error_t check_signatures_trust (ctrl_t ctrl, kbnode_t keyblock,
268 PKT_public_key *pk, PKT_signature *sig);
270 void release_pk_list (PK_LIST pk_list);
271 int expand_id (const char *id, strlist_t *into, unsigned int flags);
272 strlist_t expand_group (strlist_t input, int prepend_input);
273 int build_pk_list (ctrl_t ctrl, strlist_t rcpts, PK_LIST *ret_pk_list);
274 gpg_error_t find_and_check_key (ctrl_t ctrl,
275 const char *name, unsigned int use,
276 int mark_hidden, int from_file,
277 pk_list_t *pk_list_addr);
279 int algo_available( preftype_t preftype, int algo,
280 const struct pref_hint *hint );
281 int select_algo_from_prefs( PK_LIST pk_list, int preftype,
282 int request, const struct pref_hint *hint);
283 int select_mdc_from_pklist (PK_LIST pk_list);
284 aead_algo_t select_aead_from_pklist (pk_list_t pk_list);
285 void warn_missing_aead_from_pklist (PK_LIST pk_list);
286 void warn_missing_aes_from_pklist (PK_LIST pk_list);
289 int random_is_faked (void);
290 void release_sk_list( SK_LIST sk_list );
291 gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
292 SK_LIST *ret_sk_list, unsigned use);
294 /*-- passphrase.h --*/
296 /* Flags for passphrase_to_dek */
297 #define GETPASSWORD_FLAG_SYMDECRYPT 1
299 int have_static_passphrase(void);
300 const char *get_static_passphrase (void);
301 void set_passphrase_from_string(const char *pass);
302 void read_passphrase_from_fd( int fd );
303 void passphrase_clear_cache (const char *cacheid);
304 DEK *passphrase_to_dek (int cipher_algo, STRING2KEY *s2k,
305 int create, int nocache,
306 const char *tryagain_text, unsigned int flags,
308 void set_next_passphrase( const char *s );
309 char *get_last_passphrase(void);
310 void next_to_last_passphrase(void);
312 void emit_status_need_passphrase (ctrl_t ctrl, u32 *keyid,
313 u32 *mainkeyid, int pubkey_algo);
315 #define FORMAT_KEYDESC_NORMAL 0
316 #define FORMAT_KEYDESC_IMPORT 1
317 #define FORMAT_KEYDESC_EXPORT 2
318 #define FORMAT_KEYDESC_DELKEY 3
319 #define FORMAT_KEYDESC_KEYGRIP 4
320 char *gpg_format_keydesc (ctrl_t ctrl,
321 PKT_public_key *pk, int mode, int escaped);
326 /* Cache a copy of a public key in the public key cache. */
327 void cache_public_key( PKT_public_key *pk );
329 /* Disable and drop the public key cache. */
330 void getkey_disable_caches(void);
332 /* Return the public key used for signature SIG and store it at PK. */
333 gpg_error_t get_pubkey_for_sig (ctrl_t ctrl,
334 PKT_public_key *pk, PKT_signature *sig,
335 PKT_public_key *forced_pk);
337 /* Return the public key with the key id KEYID and store it at PK. */
338 int get_pubkey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
340 /* Same as get_pubkey but with auto LDAP fetch. */
341 gpg_error_t get_pubkey_with_ldap_fallback (ctrl_t ctrl,
342 PKT_public_key *pk, u32 * keyid);
344 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
345 account nor does it merge in the self-signed data. This function
346 also only considers primary keys. */
347 int get_pubkey_fast (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
349 /* Return the entire keyblock used to create SIG. This is a
350 * specialized version of get_pubkeyblock. */
351 kbnode_t get_pubkeyblock_for_sig (ctrl_t ctrl, PKT_signature *sig);
353 /* Return the key block for the key with KEYID. */
354 kbnode_t get_pubkeyblock (ctrl_t ctrl, u32 *keyid);
356 /* A list used by get_pubkeys to gather all of the matches. */
359 struct pubkey_s *next;
360 /* The key to use (either the public key or the subkey). */
364 typedef struct pubkey_s *pubkey_t;
366 /* Free a list of public keys. */
367 void pubkeys_free (pubkey_t keys);
370 /* Mode flags for get_pubkey_byname. */
371 enum get_pubkey_modes
373 GET_PUBKEY_NORMAL = 0,
374 GET_PUBKEY_NO_AKL = 1,
375 GET_PUBKEY_NO_LOCAL = 2
378 /* Find a public key identified by NAME. */
379 int get_pubkey_byname (ctrl_t ctrl, enum get_pubkey_modes mode,
380 GETKEY_CTX *retctx, PKT_public_key *pk,
382 KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
383 int include_unusable);
385 /* Likewise, but only return the best match if NAME resembles a mail
387 gpg_error_t get_best_pubkey_byname (ctrl_t ctrl, enum get_pubkey_modes mode,
388 GETKEY_CTX *retctx, PKT_public_key *pk,
389 const char *name, KBNODE *ret_keyblock,
390 int include_unusable);
392 /* Get a public key directly from file FNAME. */
393 gpg_error_t get_pubkey_fromfile (ctrl_t ctrl,
394 PKT_public_key *pk, const char *fname);
396 /* Get a public key from a buffer. */
397 gpg_error_t get_pubkey_from_buffer (ctrl_t ctrl, PKT_public_key *pkbuf,
398 const void *buffer, size_t buflen,
399 u32 *want_keyid, kbnode_t *r_keyblock);
401 /* Return the public key with the key id KEYID iff the secret key is
402 * available and store it at PK. */
403 gpg_error_t get_seckey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
405 /* Lookup a key with the specified fingerprint. */
406 int get_pubkey_byfprint (ctrl_t ctrl, PKT_public_key *pk, kbnode_t *r_keyblock,
407 const byte *fprint, size_t fprint_len);
409 /* This function is similar to get_pubkey_byfprint, but it doesn't
410 merge the self-signed data into the public key and subkeys or into
412 gpg_error_t get_pubkey_byfprint_fast (ctrl_t ctrl, PKT_public_key *pk,
413 const byte *fprint, size_t fprint_len);
415 /* This function is similar to get_pubkey_byfprint, but it doesn't
416 merge the self-signed data into the public key and subkeys or into
418 gpg_error_t get_keyblock_byfprint_fast (ctrl_t ctrl,
419 kbnode_t *r_keyblock,
421 const byte *fprint, size_t fprint_len,
425 /* Returns true if a secret key is available for the public key with
427 int have_secret_key_with_kid (ctrl_t ctrl, u32 *keyid);
429 /* Parse the --default-key parameter. Returns the last key (in terms
430 of when the option is given) that is available. */
431 const char *parse_def_secret_key (ctrl_t ctrl);
433 /* Look up a secret key. */
434 gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
435 gpg_error_t get_seckey_default_or_card (ctrl_t ctrl, PKT_public_key *pk,
436 const byte *fpr, size_t fpr_len);
438 /* Search for keys matching some criteria. */
439 gpg_error_t getkey_bynames (ctrl_t ctrl,
440 getkey_ctx_t *retctx, PKT_public_key *pk,
441 strlist_t names, int want_secret,
442 kbnode_t *ret_keyblock);
444 /* Search for one key matching some criteria. */
445 gpg_error_t getkey_byname (ctrl_t ctrl,
446 getkey_ctx_t *retctx, PKT_public_key *pk,
447 const char *name, int want_secret,
448 kbnode_t *ret_keyblock);
450 /* Return the next search result. */
451 gpg_error_t getkey_next (ctrl_t ctrl, getkey_ctx_t ctx,
452 PKT_public_key *pk, kbnode_t *ret_keyblock);
454 /* Release any resources used by a key listing context. */
455 void getkey_end (ctrl_t ctrl, getkey_ctx_t ctx);
457 /* Return the database handle used by this context. The context still
459 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
461 /* Enumerate some secret keys. */
462 gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
464 /* Set the mainkey_id fields for all keys in KEYBLOCK. */
465 void setup_main_keyids (kbnode_t keyblock);
467 /* This function merges information from the self-signed data into the
469 void merge_keys_and_selfsig (ctrl_t ctrl, kbnode_t keyblock);
471 char *get_user_id_string_native (ctrl_t ctrl, u32 *keyid);
472 char *get_long_user_id_string (ctrl_t ctrl, u32 *keyid);
473 char *get_user_id (ctrl_t ctrl, u32 *keyid, size_t *rn, int *r_nouid);
474 char *get_user_id_native (ctrl_t ctrl, u32 *keyid);
475 char *get_user_id_byfpr_native (ctrl_t ctrl, const byte *fpr, size_t fprlen);
477 void release_akl(void);
478 int akl_empty_or_only_local (void);
479 int parse_auto_key_locate(const char *options);
480 int parse_key_origin (char *string);
481 const char *key_origin_string (int origin);
484 int pubkey_letter( int algo );
485 char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
486 #define PUBKEY_STRING_SIZE 32
487 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
488 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
489 char *format_keyid (u32 *keyid, int format, char *buffer, int len);
491 /* Return PK's keyid. The memory is owned by PK. */
492 u32 *pk_keyid (PKT_public_key *pk);
494 /* Return the keyid of the primary key associated with PK. The memory
496 u32 *pk_main_keyid (PKT_public_key *pk);
498 /* Order A and B. If A < B then return -1, if A == B then return 0,
499 and if A > B then return 1. */
500 static int GPGRT_ATTR_UNUSED
501 keyid_cmp (const u32 *a, const u32 *b)
514 /* Return whether PK is a primary key. */
515 static int GPGRT_ATTR_UNUSED
516 pk_is_primary (PKT_public_key *pk)
518 return keyid_cmp (pk_keyid (pk), pk_main_keyid (pk)) == 0;
521 /* Copy the keyid in SRC to DEST and return DEST. */
522 u32 *keyid_copy (u32 *dest, const u32 *src);
524 size_t keystrlen(void);
525 const char *keystr(u32 *keyid);
526 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
527 const char *keystr_from_pk(PKT_public_key *pk);
528 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
529 PKT_public_key *sub_pk);
531 /* Return PK's key id as a string using the default format. PK owns
533 const char *pk_keyid_str (PKT_public_key *pk);
535 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
536 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
537 u32 keyid_from_sig (PKT_signature *sig, u32 *keyid );
538 u32 keyid_from_fingerprint (ctrl_t ctrl, const byte *fprint, size_t fprint_len,
540 byte *namehash_from_uid(PKT_user_id *uid);
541 unsigned nbits_from_pk( PKT_public_key *pk );
543 /* Convert an UTC TIMESTAMP into an UTC yyyy-mm-dd string. Return
544 * that string. The caller should pass a buffer with at least a size
545 * of MK_DATESTR_SIZE. */
546 char *mk_datestr (char *buffer, size_t bufsize, u32 timestamp);
547 #define MK_DATESTR_SIZE 11
549 const char *dateonlystr_from_pk (PKT_public_key *pk);
550 const char *datestr_from_pk( PKT_public_key *pk );
551 const char *dateonlystr_from_sig( PKT_signature *sig );
552 const char *datestr_from_sig( PKT_signature *sig );
553 const char *expirestr_from_pk( PKT_public_key *pk );
554 const char *expirestr_from_sig( PKT_signature *sig );
555 const char *revokestr_from_pk( PKT_public_key *pk );
556 const char *usagestr_from_pk (PKT_public_key *pk, int fill);
557 const char *colon_strtime (u32 t);
558 const char *colon_datestr_from_pk (PKT_public_key *pk);
559 const char *colon_datestr_from_sig (PKT_signature *sig);
560 const char *colon_expirestr_from_sig (PKT_signature *sig);
561 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
562 void fpr20_from_pk (PKT_public_key *pk, byte array[20]);
563 char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
564 char *format_hexfingerprint (const char *fingerprint,
565 char *buffer, size_t buflen);
566 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
567 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
571 KBNODE new_kbnode( PACKET *pkt );
572 KBNODE clone_kbnode( KBNODE node );
573 void release_kbnode( KBNODE n );
574 void delete_kbnode( KBNODE node );
575 void add_kbnode( KBNODE root, KBNODE node );
576 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
577 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
578 void remove_kbnode( KBNODE *root, KBNODE node );
579 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
580 KBNODE find_next_kbnode( KBNODE node, int pkttype );
581 KBNODE find_kbnode( KBNODE node, int pkttype );
582 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
583 void clear_kbnode_flags( KBNODE n );
584 int commit_kbnode( KBNODE *root );
585 void dump_kbnode( KBNODE node );
587 #endif /*G10_KEYDB_H*/