Spelling fixes in docs and comments.
[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     KEYSRC_UNKNOWN = 0,
123     KEYSRC_FILE    = 1, /* Direct import from a file.  */
124     KEYSRC_KS      = 2, /* Public keyserver.    */
125     KEYSRC_PREF_KS = 3, /* Preferred keysrver.  */
126     KEYSRC_WKD     = 4, /* Web Key Directory.   */
127     KEYSRC_WKD_SD  = 5, /* Web Key Directory but from a sub domain.  */
128     KEYSRC_DANE    = 6  /* OpenPGP DANE.  */
129   };
130
131
132 /*-- keydb.c --*/
133
134 #define KEYDB_RESOURCE_FLAG_PRIMARY  2  /* The primary resource.  */
135 #define KEYDB_RESOURCE_FLAG_DEFAULT  4  /* The default one.  */
136 #define KEYDB_RESOURCE_FLAG_READONLY 8  /* Open in read only mode.  */
137 #define KEYDB_RESOURCE_FLAG_GPGVDEF 16  /* Default file for gpgv.  */
138
139 /* Format a search term for debugging output.  The caller must free
140    the result.  */
141 char *keydb_search_desc_dump (struct keydb_search_desc *desc);
142
143 /* Register a resource (keyring or keybox).  */
144 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
145
146 /* Dump some statistics to the log.  */
147 void keydb_dump_stats (void);
148
149 /* Create a new database handle.  Returns NULL on error, sets ERRNO,
150    and prints an error diagnostic. */
151 KEYDB_HANDLE keydb_new (void);
152
153 /* Free all resources owned by the database handle.  */
154 void keydb_release (KEYDB_HANDLE hd);
155
156 /* Set a flag on the handle to suppress use of cached results.  This
157    is required for updating a keyring and for key listings.  Fixme:
158    Using a new parameter for keydb_new might be a better solution.  */
159 void keydb_disable_caching (KEYDB_HANDLE hd);
160
161 /* Save the last found state and invalidate the current selection.  */
162 void keydb_push_found_state (KEYDB_HANDLE hd);
163
164 /* Restore the previous save state.  */
165 void keydb_pop_found_state (KEYDB_HANDLE hd);
166
167 /* Return the file name of the resource.  */
168 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
169
170 /* Return the keyblock last found by keydb_search.  */
171 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
172
173 /* Update the keyblock KB.  */
174 gpg_error_t keydb_update_keyblock (ctrl_t ctrl, KEYDB_HANDLE hd, kbnode_t kb);
175
176 /* Insert a keyblock into one of the underlying keyrings or keyboxes.  */
177 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
178
179 /* Delete the currently selected keyblock.  */
180 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
181
182 /* Find the first writable resource.  */
183 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
184
185 /* Rebuild the on-disk caches of all key resources.  */
186 void keydb_rebuild_caches (ctrl_t ctrl, int noisy);
187
188 /* Return the number of skipped blocks (because they were to large to
189    read from a keybox) since the last search reset.  */
190 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
191
192 /* Clears the current search result and resets the handle's position.  */
193 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
194
195 /* Search the database for keys matching the search description.  */
196 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
197                           size_t ndesc, size_t *descindex);
198
199 /* Return the first non-legacy key in the database.  */
200 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
201
202 /* Return the next key (not the next matching key!).  */
203 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
204
205 /* This is a convenience function for searching for keys with a long
206    key id.  */
207 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
208
209 /* This is a convenience function for searching for keys with a long
210    (20 byte) fingerprint.  */
211 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
212
213
214 /*-- pkclist.c --*/
215 void show_revocation_reason (ctrl_t ctrl, PKT_public_key *pk, int mode );
216 int  check_signatures_trust (ctrl_t ctrl, PKT_signature *sig);
217
218 void release_pk_list (PK_LIST pk_list);
219 int  build_pk_list (ctrl_t ctrl, strlist_t rcpts, PK_LIST *ret_pk_list);
220 gpg_error_t find_and_check_key (ctrl_t ctrl,
221                                 const char *name, unsigned int use,
222                                 int mark_hidden, int from_file,
223                                 pk_list_t *pk_list_addr);
224
225 int  algo_available( preftype_t preftype, int algo,
226                      const union pref_hint *hint );
227 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
228                              int request, const union pref_hint *hint);
229 int  select_mdc_from_pklist (PK_LIST pk_list);
230 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
231 void warn_missing_aes_from_pklist (PK_LIST pk_list);
232
233 /*-- skclist.c --*/
234 int  random_is_faked (void);
235 void release_sk_list( SK_LIST sk_list );
236 gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
237                            SK_LIST *ret_sk_list, unsigned use);
238
239 /*-- passphrase.h --*/
240 unsigned char encode_s2k_iterations (int iterations);
241 int  have_static_passphrase(void);
242 const char *get_static_passphrase (void);
243 void set_passphrase_from_string(const char *pass);
244 void read_passphrase_from_fd( int fd );
245 void passphrase_clear_cache (const char *cacheid);
246 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
247                            int cipher_algo, STRING2KEY *s2k, int mode,
248                            const char *tryagain_text,
249                            const char *custdesc, const char *custprompt,
250                            int *canceled);
251 DEK *passphrase_to_dek (int cipher_algo, STRING2KEY *s2k,
252                         int create, int nocache,
253                         const char *tryagain_text, int *canceled);
254 void set_next_passphrase( const char *s );
255 char *get_last_passphrase(void);
256 void next_to_last_passphrase(void);
257
258 void emit_status_need_passphrase (ctrl_t ctrl, u32 *keyid,
259                                   u32 *mainkeyid, int pubkey_algo);
260
261 #define FORMAT_KEYDESC_NORMAL  0
262 #define FORMAT_KEYDESC_IMPORT  1
263 #define FORMAT_KEYDESC_EXPORT  2
264 #define FORMAT_KEYDESC_DELKEY  3
265 char *gpg_format_keydesc (ctrl_t ctrl,
266                           PKT_public_key *pk, int mode, int escaped);
267
268
269 /*-- getkey.c --*/
270
271 /* Cache a copy of a public key in the public key cache.  */
272 void cache_public_key( PKT_public_key *pk );
273
274 /* Disable and drop the public key cache.  */
275 void getkey_disable_caches(void);
276
277 /* Return the public key with the key id KEYID and store it at PK.  */
278 int get_pubkey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
279
280 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
281    account nor does it merge in the self-signed data.  This function
282    also only considers primary keys.  */
283 int get_pubkey_fast (PKT_public_key *pk, u32 *keyid);
284
285 /* Return the key block for the key with KEYID.  */
286 kbnode_t get_pubkeyblock (ctrl_t ctrl, u32 *keyid);
287
288 /* A list used by get_pubkeys to gather all of the matches.  */
289 struct pubkey_s
290 {
291   struct pubkey_s *next;
292   /* The key to use (either the public key or the subkey).  */
293   PKT_public_key *pk;
294   kbnode_t keyblock;
295 };
296 typedef struct pubkey_s *pubkey_t;
297
298 /* Free a single key.  This does not remove key from any list!  */
299 void pubkey_free (pubkey_t key);
300
301 /* Free a list of public keys.  */
302 void pubkeys_free (pubkey_t keys);
303
304 /* Returns all keys that match the search specification SEARCH_TERMS.
305    The returned keys should be freed using pubkeys_free.  */
306 gpg_error_t
307 get_pubkeys (ctrl_t ctrl,
308              char *search_terms, int use, int include_unusable, char *source,
309              int warn_possibly_ambiguous,
310              pubkey_t *r_keys);
311
312 /* Find a public key identified by NAME.  */
313 int get_pubkey_byname (ctrl_t ctrl,
314                        GETKEY_CTX *retctx, PKT_public_key *pk,
315                        const char *name,
316                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
317                        int include_unusable, int no_akl );
318
319 /* Likewise, but only return the best match if NAME resembles a mail
320  * address.  */
321 int get_best_pubkey_byname (ctrl_t ctrl,
322                             GETKEY_CTX *retctx, PKT_public_key *pk,
323                             const char *name, KBNODE *ret_keyblock,
324                             int include_unusable, int no_akl);
325
326 /* Get a public key directly from file FNAME.  */
327 gpg_error_t get_pubkey_fromfile (ctrl_t ctrl,
328                                  PKT_public_key *pk, const char *fname);
329
330 /* Return the public key with the key id KEYID iff the secret key is
331  * available and store it at PK.  */
332 gpg_error_t get_seckey (ctrl_t ctrl, PKT_public_key *pk, u32 *keyid);
333
334 /* Lookup a key with the specified fingerprint.  */
335 int get_pubkey_byfprint (ctrl_t ctrl, PKT_public_key *pk, kbnode_t *r_keyblock,
336                          const byte *fprint, size_t fprint_len);
337
338 /* This function is similar to get_pubkey_byfprint, but it doesn't
339    merge the self-signed data into the public key and subkeys or into
340    the user ids.  */
341 int get_pubkey_byfprint_fast (PKT_public_key *pk,
342                               const byte *fprint, size_t fprint_len);
343
344 /* Returns true if a secret key is available for the public key with
345    key id KEYID.  */
346 int have_secret_key_with_kid (u32 *keyid);
347
348 /* Parse the --default-key parameter.  Returns the last key (in terms
349    of when the option is given) that is available.  */
350 const char *parse_def_secret_key (ctrl_t ctrl);
351
352 /* Look up a secret key.  */
353 gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
354
355 /* Search for keys matching some criteria.  */
356 gpg_error_t getkey_bynames (ctrl_t ctrl,
357                             getkey_ctx_t *retctx, PKT_public_key *pk,
358                             strlist_t names, int want_secret,
359                             kbnode_t *ret_keyblock);
360
361 /* Search for one key matching some criteria.  */
362 gpg_error_t getkey_byname (ctrl_t ctrl,
363                            getkey_ctx_t *retctx, PKT_public_key *pk,
364                            const char *name, int want_secret,
365                            kbnode_t *ret_keyblock);
366
367 /* Return the next search result.  */
368 gpg_error_t getkey_next (ctrl_t ctrl, getkey_ctx_t ctx,
369                          PKT_public_key *pk, kbnode_t *ret_keyblock);
370
371 /* Release any resources used by a key listing context.  */
372 void getkey_end (ctrl_t ctrl, getkey_ctx_t ctx);
373
374 /* Return the database handle used by this context.  The context still
375    owns the handle.  */
376 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
377
378 /* Enumerate some secret keys.  */
379 gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
380
381 /* Set the mainkey_id fields for all keys in KEYBLOCK.  */
382 void setup_main_keyids (kbnode_t keyblock);
383
384 /* This function merges information from the self-signed data into the
385    data structures.  */
386 void merge_keys_and_selfsig (ctrl_t ctrl, kbnode_t keyblock);
387
388 char*get_user_id_string_native (ctrl_t ctrl, u32 *keyid);
389 char*get_long_user_id_string (ctrl_t ctrl, u32 *keyid);
390 char*get_user_id (ctrl_t ctrl, u32 *keyid, size_t *rn);
391 char*get_user_id_native (ctrl_t ctrl, u32 *keyid);
392 char *get_user_id_byfpr (ctrl_t ctrl, const byte *fpr, size_t *rn);
393 char *get_user_id_byfpr_native (ctrl_t ctrl, const byte *fpr);
394
395 void release_akl(void);
396 int parse_auto_key_locate(char *options);
397
398 /*-- keyid.c --*/
399 int pubkey_letter( int algo );
400 char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
401 #define PUBKEY_STRING_SIZE 32
402 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
403 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
404 char *format_keyid (u32 *keyid, int format, char *buffer, int len);
405
406 /* Return PK's keyid.  The memory is owned by PK.  */
407 u32 *pk_keyid (PKT_public_key *pk);
408
409 /* Return the keyid of the primary key associated with PK.  The memory
410    is owned by PK.  */
411 u32 *pk_main_keyid (PKT_public_key *pk);
412
413 /* Order A and B.  If A < B then return -1, if A == B then return 0,
414    and if A > B then return 1.  */
415 static int GPGRT_ATTR_UNUSED
416 keyid_cmp (const u32 *a, const u32 *b)
417 {
418   if (a[0] < b[0])
419     return -1;
420   if (a[0] > b[0])
421     return 1;
422   if (a[1] < b[1])
423     return -1;
424   if (a[1] > b[1])
425     return 1;
426   return 0;
427 }
428
429 /* Return whether PK is a primary key.  */
430 static int GPGRT_ATTR_UNUSED
431 pk_is_primary (PKT_public_key *pk)
432 {
433   return keyid_cmp (pk_keyid (pk), pk_main_keyid (pk)) == 0;
434 }
435
436 /* Copy the keyid in SRC to DEST and return DEST.  */
437 u32 *keyid_copy (u32 *dest, const u32 *src);
438
439 size_t keystrlen(void);
440 const char *keystr(u32 *keyid);
441 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
442 const char *keystr_from_pk(PKT_public_key *pk);
443 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
444                                      PKT_public_key *sub_pk);
445
446 /* Return PK's key id as a string using the default format.  PK owns
447    the storage.  */
448 const char *pk_keyid_str (PKT_public_key *pk);
449
450 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
451 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
452 u32 keyid_from_sig (PKT_signature *sig, u32 *keyid );
453 u32 keyid_from_fingerprint (ctrl_t ctrl, const byte *fprint, size_t fprint_len,
454                             u32 *keyid);
455 byte *namehash_from_uid(PKT_user_id *uid);
456 unsigned nbits_from_pk( PKT_public_key *pk );
457 const char *datestr_from_pk( PKT_public_key *pk );
458 const char *datestr_from_sig( PKT_signature *sig );
459 const char *expirestr_from_pk( PKT_public_key *pk );
460 const char *expirestr_from_sig( PKT_signature *sig );
461 const char *revokestr_from_pk( PKT_public_key *pk );
462 const char *usagestr_from_pk (PKT_public_key *pk, int fill);
463 const char *colon_strtime (u32 t);
464 const char *colon_datestr_from_pk (PKT_public_key *pk);
465 const char *colon_datestr_from_sig (PKT_signature *sig);
466 const char *colon_expirestr_from_sig (PKT_signature *sig);
467 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
468 char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
469 char *format_hexfingerprint (const char *fingerprint,
470                              char *buffer, size_t buflen);
471 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
472 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
473
474
475 /*-- kbnode.c --*/
476 KBNODE new_kbnode( PACKET *pkt );
477 KBNODE clone_kbnode( KBNODE node );
478 void release_kbnode( KBNODE n );
479 void delete_kbnode( KBNODE node );
480 void add_kbnode( KBNODE root, KBNODE node );
481 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
482 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
483 void remove_kbnode( KBNODE *root, KBNODE node );
484 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
485 KBNODE find_next_kbnode( KBNODE node, int pkttype );
486 KBNODE find_kbnode( KBNODE node, int pkttype );
487 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
488 void clear_kbnode_flags( KBNODE n );
489 int  commit_kbnode( KBNODE *root );
490 void dump_kbnode( KBNODE node );
491
492 #endif /*G10_KEYDB_H*/