gpg: Minor rework for better readibility of get_best_pubkey_byname.
[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, 2016 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 <https://www.gnu.org/licenses/>.
20  */
21
22 #ifndef G10_KEYDB_H
23 #define G10_KEYDB_H
24
25 #include "../common/types.h"
26 #include "../common/util.h"
27 #include "packet.h"
28
29 /* What qualifies as a certification (rather than a signature?) */
30 #define IS_CERT(s)       (IS_KEY_SIG(s) || IS_UID_SIG(s) || IS_SUBKEY_SIG(s) \
31                          || IS_KEY_REV(s) || IS_UID_REV(s) || IS_SUBKEY_REV(s))
32 #define IS_SIG(s)        (!IS_CERT(s))
33 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
34 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
35 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
36 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
37 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
38 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
39
40 struct getkey_ctx_s;
41 typedef struct getkey_ctx_s *GETKEY_CTX;
42 typedef struct getkey_ctx_s *getkey_ctx_t;
43
44 /****************
45  * A Keyblock is all packets which form an entire certificate;
46  * i.e. the public key, certificate, trust packets, user ids,
47  * signatures, and subkey.
48  *
49  * This structure is also used to bind arbitrary packets together.
50  */
51
52 struct kbnode_struct {
53     KBNODE next;
54     PACKET *pkt;
55     int flag;
56     int private_flag;
57     ulong recno;  /* used while updating the trustdb */
58 };
59
60 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
61 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
62
63
64 /* Bit flags used with build_pk_list.  */
65 enum
66   {
67     PK_LIST_ENCRYPT_TO = 1, /* This is an encrypt-to recipient.    */
68     PK_LIST_HIDDEN     = 2, /* This is a hidden recipient.         */
69     PK_LIST_CONFIG     = 4, /* Specified via config file.          */
70     PK_LIST_FROM_FILE  = 8  /* Take key from file with that name.  */
71   };
72
73 /* To store private data in the flags the private data must be left
74  * shifted by this value.  */
75 enum
76   {
77     PK_LIST_SHIFT = 4
78   };
79
80
81 /* Structure to hold a couple of public key certificates. */
82 typedef struct pk_list *PK_LIST;  /* Deprecated. */
83 typedef struct pk_list *pk_list_t;
84 struct pk_list
85 {
86   PK_LIST next;
87   PKT_public_key *pk;
88   int flags;           /* See PK_LIST_ constants. */
89 };
90
91 /* Structure to hold a list of secret key certificates.  */
92 typedef struct sk_list *SK_LIST;
93 struct sk_list
94 {
95   SK_LIST next;
96   PKT_public_key *pk;
97   int mark; /* not used */
98 };
99
100 /* structure to collect all information which can be used to
101  * identify a public key */
102 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
103 struct pubkey_find_info {
104     u32  keyid[2];
105     unsigned nbits;
106     byte pubkey_algo;
107     byte fingerprint[MAX_FINGERPRINT_LEN];
108     char userid[1];
109 };
110
111
112 /* Helper type for preference functions. */
113 union pref_hint
114 {
115   int digest_length;
116 };
117
118
119 /* Constants to describe from where a key was fetched or updated.  */
120 enum
121   {
122     KEYORG_UNKNOWN = 0,
123     KEYORG_KS      = 1, /* Public keyserver.    */
124     KEYORG_KS_PREF = 2, /* Preferred keysrver.  */
125     KEYORG_DANE    = 3, /* OpenPGP DANE.        */
126     KEYORG_WKD     = 4, /* Web Key Directory.   */
127     KEYORG_URL     = 5, /* Trusted URL.         */
128     KEYORG_FILE    = 6, /* Trusted file.        */
129     KEYORG_SELF    = 7  /* We generated it.     */
130   };
131
132
133 /*-- keydb.c --*/
134
135 #define KEYDB_RESOURCE_FLAG_PRIMARY  2  /* The primary resource.  */
136 #define KEYDB_RESOURCE_FLAG_DEFAULT  4  /* The default one.  */
137 #define KEYDB_RESOURCE_FLAG_READONLY 8  /* Open in read only mode.  */
138 #define KEYDB_RESOURCE_FLAG_GPGVDEF 16  /* Default file for gpgv.  */
139
140 /* Format a search term for debugging output.  The caller must free
141    the result.  */
142 char *keydb_search_desc_dump (struct keydb_search_desc *desc);
143
144 /* Register a resource (keyring or keybox).  */
145 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
146
147 /* Dump some statistics to the log.  */
148 void keydb_dump_stats (void);
149
150 /* Create a new database handle.  Returns NULL on error, sets ERRNO,
151    and prints an error diagnostic. */
152 KEYDB_HANDLE keydb_new (void);
153
154 /* Free all resources owned by the database handle.  */
155 void keydb_release (KEYDB_HANDLE hd);
156
157 /* Set a flag on the handle to suppress use of cached results.  This
158    is required for updating a keyring and for key listings.  Fixme:
159    Using a new parameter for keydb_new might be a better solution.  */
160 void keydb_disable_caching (KEYDB_HANDLE hd);
161
162 /* Save the last found state and invalidate the current selection.  */
163 void keydb_push_found_state (KEYDB_HANDLE hd);
164
165 /* Restore the previous save state.  */
166 void keydb_pop_found_state (KEYDB_HANDLE hd);
167
168 /* Return the file name of the resource.  */
169 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
170
171 /* Return the keyblock last found by keydb_search.  */
172 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
173
174 /* Update the keyblock KB.  */
175 gpg_error_t keydb_update_keyblock (ctrl_t ctrl, KEYDB_HANDLE hd, kbnode_t kb);
176
177 /* Insert a keyblock into one of the underlying keyrings or keyboxes.  */
178 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
179
180 /* Delete the currently selected keyblock.  */
181 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
182
183 /* Find the first writable resource.  */
184 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
185
186 /* Rebuild the on-disk caches of all key resources.  */
187 void keydb_rebuild_caches (ctrl_t ctrl, int noisy);
188
189 /* Return the number of skipped blocks (because they were to large to
190    read from a keybox) since the last search reset.  */
191 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
192
193 /* Clears the current search result and resets the handle's position.  */
194 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
195
196 /* Search the database for keys matching the search description.  */
197 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
198                           size_t ndesc, size_t *descindex);
199
200 /* Return the first non-legacy key in the database.  */
201 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
202
203 /* Return the next key (not the next matching key!).  */
204 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
205
206 /* This is a convenience function for searching for keys with a long
207    key id.  */
208 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
209
210 /* This is a convenience function for searching for keys with a long
211    (20 byte) fingerprint.  */
212 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
213
214
215 /*-- pkclist.c --*/
216 void show_revocation_reason (ctrl_t ctrl, PKT_public_key *pk, int mode );
217 int  check_signatures_trust (ctrl_t ctrl, PKT_signature *sig);
218
219 void release_pk_list (PK_LIST pk_list);
220 int  build_pk_list (ctrl_t ctrl, strlist_t rcpts, PK_LIST *ret_pk_list);
221 gpg_error_t find_and_check_key (ctrl_t ctrl,
222                                 const char *name, unsigned int use,
223                                 int mark_hidden, int from_file,
224                                 pk_list_t *pk_list_addr);
225
226 int  algo_available( preftype_t preftype, int algo,
227                      const union pref_hint *hint );
228 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
229                              int request, const union pref_hint *hint);
230 int  select_mdc_from_pklist (PK_LIST pk_list);
231 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
232 void warn_missing_aes_from_pklist (PK_LIST pk_list);
233
234 /*-- skclist.c --*/
235 int  random_is_faked (void);
236 void release_sk_list( SK_LIST sk_list );
237 gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
238                            SK_LIST *ret_sk_list, unsigned use);
239
240 /*-- passphrase.h --*/
241 unsigned char encode_s2k_iterations (int iterations);
242 int  have_static_passphrase(void);
243 const char *get_static_passphrase (void);
244 void set_passphrase_from_string(const char *pass);
245 void read_passphrase_from_fd( int fd );
246 void passphrase_clear_cache (const char *cacheid);
247 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
248                            int cipher_algo, STRING2KEY *s2k, int mode,
249                            const char *tryagain_text,
250                            const char *custdesc, const char *custprompt,
251                            int *canceled);
252 DEK *passphrase_to_dek (int cipher_algo, STRING2KEY *s2k,
253                         int create, int nocache,
254                         const char *tryagain_text, int *canceled);
255 void set_next_passphrase( const char *s );
256 char *get_last_passphrase(void);
257 void next_to_last_passphrase(void);
258
259 void emit_status_need_passphrase (ctrl_t ctrl, u32 *keyid,
260                                   u32 *mainkeyid, int pubkey_algo);
261
262 #define FORMAT_KEYDESC_NORMAL  0
263 #define FORMAT_KEYDESC_IMPORT  1
264 #define FORMAT_KEYDESC_EXPORT  2
265 #define FORMAT_KEYDESC_DELKEY  3
266 char *gpg_format_keydesc (ctrl_t ctrl,
267                           PKT_public_key *pk, int mode, int escaped);
268
269
270 /*-- getkey.c --*/
271
272 /* Cache a copy of a public key in the public key cache.  */
273 void cache_public_key( PKT_public_key *pk );
274
275 /* Disable and drop the public key cache.  */
276 void getkey_disable_caches(void);
277
278 /* Return the public key with the key id KEYID and store it at PK.  */
279 int get_pubkey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
280
281 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
282    account nor does it merge in the self-signed data.  This function
283    also only considers primary keys.  */
284 int get_pubkey_fast (PKT_public_key *pk, u32 *keyid);
285
286 /* Return the key block for the key with KEYID.  */
287 kbnode_t get_pubkeyblock (ctrl_t ctrl, u32 *keyid);
288
289 /* A list used by get_pubkeys to gather all of the matches.  */
290 struct pubkey_s
291 {
292   struct pubkey_s *next;
293   /* The key to use (either the public key or the subkey).  */
294   PKT_public_key *pk;
295   kbnode_t keyblock;
296 };
297 typedef struct pubkey_s *pubkey_t;
298
299 /* Free a single key.  This does not remove key from any list!  */
300 void pubkey_free (pubkey_t key);
301
302 /* Free a list of public keys.  */
303 void pubkeys_free (pubkey_t keys);
304
305 /* Returns all keys that match the search specification SEARCH_TERMS.
306    The returned keys should be freed using pubkeys_free.  */
307 gpg_error_t
308 get_pubkeys (ctrl_t ctrl,
309              char *search_terms, int use, int include_unusable, char *source,
310              int warn_possibly_ambiguous,
311              pubkey_t *r_keys);
312
313 /* Find a public key identified by NAME.  */
314 int get_pubkey_byname (ctrl_t ctrl,
315                        GETKEY_CTX *retctx, PKT_public_key *pk,
316                        const char *name,
317                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
318                        int include_unusable, int no_akl );
319
320 /* Likewise, but only return the best match if NAME resembles a mail
321  * address.  */
322 gpg_error_t get_best_pubkey_byname (ctrl_t ctrl,
323                                     GETKEY_CTX *retctx, PKT_public_key *pk,
324                                     const char *name, KBNODE *ret_keyblock,
325                                     int include_unusable, int no_akl);
326
327 /* Get a public key directly from file FNAME.  */
328 gpg_error_t get_pubkey_fromfile (ctrl_t ctrl,
329                                  PKT_public_key *pk, const char *fname);
330
331 /* Return the public key with the key id KEYID iff the secret key is
332  * available and store it at PK.  */
333 gpg_error_t get_seckey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
334
335 /* Lookup a key with the specified fingerprint.  */
336 int get_pubkey_byfprint (ctrl_t ctrl, PKT_public_key *pk, kbnode_t *r_keyblock,
337                          const byte *fprint, size_t fprint_len);
338
339 /* This function is similar to get_pubkey_byfprint, but it doesn't
340    merge the self-signed data into the public key and subkeys or into
341    the user ids.  */
342 int get_pubkey_byfprint_fast (PKT_public_key *pk,
343                               const byte *fprint, size_t fprint_len);
344
345 /* Returns true if a secret key is available for the public key with
346    key id KEYID.  */
347 int have_secret_key_with_kid (u32 *keyid);
348
349 /* Parse the --default-key parameter.  Returns the last key (in terms
350    of when the option is given) that is available.  */
351 const char *parse_def_secret_key (ctrl_t ctrl);
352
353 /* Look up a secret key.  */
354 gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
355 gpg_error_t get_seckey_default_or_card (ctrl_t ctrl, PKT_public_key *pk,
356                                         const byte *fpr, size_t fpr_len);
357
358 /* Search for keys matching some criteria.  */
359 gpg_error_t getkey_bynames (ctrl_t ctrl,
360                             getkey_ctx_t *retctx, PKT_public_key *pk,
361                             strlist_t names, int want_secret,
362                             kbnode_t *ret_keyblock);
363
364 /* Search for one key matching some criteria.  */
365 gpg_error_t getkey_byname (ctrl_t ctrl,
366                            getkey_ctx_t *retctx, PKT_public_key *pk,
367                            const char *name, int want_secret,
368                            kbnode_t *ret_keyblock);
369
370 /* Return the next search result.  */
371 gpg_error_t getkey_next (ctrl_t ctrl, getkey_ctx_t ctx,
372                          PKT_public_key *pk, kbnode_t *ret_keyblock);
373
374 /* Release any resources used by a key listing context.  */
375 void getkey_end (ctrl_t ctrl, getkey_ctx_t ctx);
376
377 /* Return the database handle used by this context.  The context still
378    owns the handle.  */
379 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
380
381 /* Enumerate some secret keys.  */
382 gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
383
384 /* Set the mainkey_id fields for all keys in KEYBLOCK.  */
385 void setup_main_keyids (kbnode_t keyblock);
386
387 /* This function merges information from the self-signed data into the
388    data structures.  */
389 void merge_keys_and_selfsig (ctrl_t ctrl, kbnode_t keyblock);
390
391 char*get_user_id_string_native (ctrl_t ctrl, u32 *keyid);
392 char*get_long_user_id_string (ctrl_t ctrl, u32 *keyid);
393 char*get_user_id (ctrl_t ctrl, u32 *keyid, size_t *rn);
394 char*get_user_id_native (ctrl_t ctrl, u32 *keyid);
395 char *get_user_id_byfpr (ctrl_t ctrl, const byte *fpr, size_t *rn);
396 char *get_user_id_byfpr_native (ctrl_t ctrl, const byte *fpr);
397
398 void release_akl(void);
399 int parse_auto_key_locate(char *options);
400 int parse_key_origin (char *string);
401 const char *key_origin_string (int origin);
402
403 /*-- keyid.c --*/
404 int pubkey_letter( int algo );
405 char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
406 #define PUBKEY_STRING_SIZE 32
407 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
408 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
409 char *format_keyid (u32 *keyid, int format, char *buffer, int len);
410
411 /* Return PK's keyid.  The memory is owned by PK.  */
412 u32 *pk_keyid (PKT_public_key *pk);
413
414 /* Return the keyid of the primary key associated with PK.  The memory
415    is owned by PK.  */
416 u32 *pk_main_keyid (PKT_public_key *pk);
417
418 /* Order A and B.  If A < B then return -1, if A == B then return 0,
419    and if A > B then return 1.  */
420 static int GPGRT_ATTR_UNUSED
421 keyid_cmp (const u32 *a, const u32 *b)
422 {
423   if (a[0] < b[0])
424     return -1;
425   if (a[0] > b[0])
426     return 1;
427   if (a[1] < b[1])
428     return -1;
429   if (a[1] > b[1])
430     return 1;
431   return 0;
432 }
433
434 /* Return whether PK is a primary key.  */
435 static int GPGRT_ATTR_UNUSED
436 pk_is_primary (PKT_public_key *pk)
437 {
438   return keyid_cmp (pk_keyid (pk), pk_main_keyid (pk)) == 0;
439 }
440
441 /* Copy the keyid in SRC to DEST and return DEST.  */
442 u32 *keyid_copy (u32 *dest, const u32 *src);
443
444 size_t keystrlen(void);
445 const char *keystr(u32 *keyid);
446 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
447 const char *keystr_from_pk(PKT_public_key *pk);
448 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
449                                      PKT_public_key *sub_pk);
450
451 /* Return PK's key id as a string using the default format.  PK owns
452    the storage.  */
453 const char *pk_keyid_str (PKT_public_key *pk);
454
455 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
456 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
457 u32 keyid_from_sig (PKT_signature *sig, u32 *keyid );
458 u32 keyid_from_fingerprint (ctrl_t ctrl, const byte *fprint, size_t fprint_len,
459                             u32 *keyid);
460 byte *namehash_from_uid(PKT_user_id *uid);
461 unsigned nbits_from_pk( PKT_public_key *pk );
462
463 /* Convert an UTC TIMESTAMP into an UTC yyyy-mm-dd string.  Return
464  * that string.  The caller should pass a buffer with at least a size
465  * of MK_DATESTR_SIZE.  */
466 char *mk_datestr (char *buffer, size_t bufsize, u32 timestamp);
467 #define MK_DATESTR_SIZE 11
468
469 const char *datestr_from_pk( PKT_public_key *pk );
470 const char *datestr_from_sig( PKT_signature *sig );
471 const char *expirestr_from_pk( PKT_public_key *pk );
472 const char *expirestr_from_sig( PKT_signature *sig );
473 const char *revokestr_from_pk( PKT_public_key *pk );
474 const char *usagestr_from_pk (PKT_public_key *pk, int fill);
475 const char *colon_strtime (u32 t);
476 const char *colon_datestr_from_pk (PKT_public_key *pk);
477 const char *colon_datestr_from_sig (PKT_signature *sig);
478 const char *colon_expirestr_from_sig (PKT_signature *sig);
479 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
480 char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
481 char *format_hexfingerprint (const char *fingerprint,
482                              char *buffer, size_t buflen);
483 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
484 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
485
486
487 /*-- kbnode.c --*/
488 KBNODE new_kbnode( PACKET *pkt );
489 KBNODE clone_kbnode( KBNODE node );
490 void release_kbnode( KBNODE n );
491 void delete_kbnode( KBNODE node );
492 void add_kbnode( KBNODE root, KBNODE node );
493 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
494 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
495 void remove_kbnode( KBNODE *root, KBNODE node );
496 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
497 KBNODE find_next_kbnode( KBNODE node, int pkttype );
498 KBNODE find_kbnode( KBNODE node, int pkttype );
499 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
500 void clear_kbnode_flags( KBNODE n );
501 int  commit_kbnode( KBNODE *root );
502 void dump_kbnode( KBNODE node );
503
504 #endif /*G10_KEYDB_H*/