gpg: Use enums instead of defines.
[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).  The first keyring or
155    keybox that is added using this function is created if it does not
156    already exist and the KEYDB_RESOURCE_FLAG_READONLY is not set.
157
158    FLAGS are a combination of the KEYDB_RESOURCE_FLAG_* constants.
159
160    URL must have the following form:
161
162      gnupg-ring:filename  = plain keyring
163      gnupg-kbx:filename   = keybox file
164      filename             = check file's type (create as a plain keyring)
165
166    Note: on systems with drive letters (Windows) invalid URLs (i.e.,
167    those with an unrecognized part before the ':' such as "c:\...")
168    will silently be treated as bare filenames.  On other systems, such
169    URLs will cause this function to return GPG_ERR_GENERAL.
170
171    If KEYDB_RESOURCE_FLAG_DEFAULT is set, the resource is a keyring
172    and the file ends in ".gpg", then this function also checks if a
173    file with the same name, but the extension ".kbx" exists, is a
174    keybox and the OpenPGP flag is set.  If so, this function opens
175    that resource instead.
176
177    If the file is not found, KEYDB_RESOURCE_FLAG_GPGVDEF is set and
178    the URL ends in ".kbx", then this function will try opening the
179    same URL, but with the extension ".gpg".  If that file is a keybox
180    with the OpenPGP flag set or it is a keyring, then we use that
181    instead.
182
183    If the file is not found, KEYDB_RESOURCE_FLAG_DEFAULT is set, the
184    file should be created and the file's extension is ".gpg" then we
185    replace the extension with ".kbx".
186
187
188    If the KEYDB_RESOURCE_FLAG_PRIMARY is set and the resource is a
189    keyring (not a keybox), then this resource is considered the
190    primary resource.  This is used by keydb_locate_writable().  If
191    another primary keyring is set, then that keyring is considered the
192    primary.
193
194    If KEYDB_RESOURCE_FLAG_READONLY is set and the resource is a
195    keyring (not a keybox), then the keyring is marked as read only and
196    operations just as keyring_insert_keyblock will return
197    GPG_ERR_ACCESS.  */
198 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
199
200 /* Dump some statistics to the log.  */
201 void keydb_dump_stats (void);
202
203 /* Create a new database handle.  Returns NULL on error, sets ERRNO,
204    and prints an error diagnostic. */
205 KEYDB_HANDLE keydb_new (void);
206
207 /* Free all resources owned by the database handle.  */
208 void keydb_release (KEYDB_HANDLE hd);
209
210 /* Set a flag on the handle to suppress use of cached results.  This
211    is required for updating a keyring and for key listings.  Fixme:
212    Using a new parameter for keydb_new might be a better solution.  */
213 void keydb_disable_caching (KEYDB_HANDLE hd);
214
215 /* Save the last found state and invalidate the current selection
216    (i.e., the entry selected by keydb_search() is invalidated and
217    something like keydb_get_keyblock() will return an error).  This
218    does not change the file position.  This makes it possible to do
219    something like:
220
221      keydb_search (hd, ...);  // Result 1.
222      keydb_push_found_state (hd);
223        keydb_search_reset (hd);
224        keydb_search (hd, ...);  // Result 2.
225      keydb_pop_found_state (hd);
226      keydb_get_keyblock (hd, ...);  // -> Result 1.
227
228    Note: it is only possible to save a single save state at a time.
229    In other words, the the save stack only has room for a single
230    instance of the state.  */
231 void keydb_push_found_state (KEYDB_HANDLE hd);
232
233 /* Restore the previous save state.  If the saved state is invalid,
234    this is equivalent to */
235 void keydb_pop_found_state (KEYDB_HANDLE hd);
236
237 /* Return the file name of the resource in which the current search
238    result was found or, if there is no search result, the filename of
239    the current resource (i.e., the resource that the file position
240    points to).  Note: the filename is not necessarily the URL used to
241    open it!
242
243    This function only returns NULL if no handle is specified, in all
244    other error cases an empty string is returned.  */
245 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
246
247 /* Return the keyblock last found by keydb_search() in *RET_KB.
248
249    On success, the function returns 0 and the caller must free *RET_KB
250    using release_kbnode().  Otherwise, the function returns an error
251    code.
252
253    The returned keyblock has the kbnode flag bit 0 set for the node
254    with the public key used to locate the keyblock or flag bit 1 set
255    for the user ID node.  */
256 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
257
258 /* Replace the currently selected keyblock (i.e., the last result
259    returned by keydb_search) with the key block in KB.
260
261    This doesn't do anything if --dry-run was specified.
262
263    Returns 0 on success.  Otherwise, it returns an error code.  */
264 gpg_error_t keydb_update_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
265
266 /* Insert a keyblock into one of the underlying keyrings or keyboxes.
267
268    Be default, the keyring / keybox from which the last search result
269    came is used.  If there was no previous search result (or
270    keydb_search_reset was called), then the keyring / keybox where the
271    next search would start is used (i.e., the current file position).
272
273    Note: this doesn't do anything if --dry-run was specified.
274
275    Returns 0 on success.  Otherwise, it returns an error code.  */
276 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
277
278 /* Delete the currently selected keyblock.  If you haven't done a
279    search yet on this database handle (or called keydb_search_reset),
280    then this will return an error.
281
282    Returns 0 on success or an error code, if an error occurs.  */
283 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
284
285 /* A database may consists of multiple keyrings / key boxes.  This
286    sets the "file position" to the start of the first keyring / key
287    box that is writable (i.e., doesn't have the read-only flag set).
288
289    This first tries the primary keyring (the last keyring (not
290    keybox!) added using keydb_add_resource() and with
291    KEYDB_RESOURCE_FLAG_PRIMARY set).  If that is not writable, then it
292    tries the keyrings / keyboxes in the order in which they were
293    added.  */
294 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
295
296 /* Rebuild the on-disk caches of all key resources.  */
297 void keydb_rebuild_caches (int noisy);
298
299 /* Return the number of skipped blocks (because they were to large to
300    read from a keybox) since the last search reset.  */
301 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
302
303 /* Clears the current search result and resets the handle's position
304    so that the next search starts at the beginning of the database
305    (the start of the first resource).
306
307    Returns 0 on success and an error code if an error occurred.
308    (Currently, this function always returns 0 if HD is valid.)  */
309 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
310
311 /* Search the database for keys matching the search description.  If
312    the DB contains any legacy keys, these are silently ignored.
313
314    DESC is an array of search terms with NDESC entries.  The search
315    terms are or'd together.  That is, the next entry in the DB that
316    matches any of the descriptions will be returned.
317
318    Note: this function resumes searching where the last search left
319    off (i.e., at the current file position).  If you want to search
320    from the start of the database, then you need to first call
321    keydb_search_reset().
322
323    If no key matches the search description, returns
324    GPG_ERR_NOT_FOUND.  If there was a match, returns 0.  If an error
325    occurred, returns an error code.
326
327    The returned key is considered to be selected and the raw data can,
328    for instance, be returned by calling keydb_get_keyblock().  */
329 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
330                           size_t ndesc, size_t *descindex);
331
332 /* Return the first non-legacy key in the database.
333
334    If you want the very first key in the database, you can directly
335    call keydb_search with the search description
336    KEYDB_SEARCH_MODE_FIRST.  */
337 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
338
339 /* Return the next key (not the next matching key!).
340
341    Unlike calling keydb_search with KEYDB_SEARCH_MODE_NEXT, this
342    function silently skips legacy keys.  */
343 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
344
345 /* This is a convenience function for searching for keys with a long
346    key id.
347
348    Note: this function resumes searching where the last search left
349    off.  If you want to search the whole database, then you need to
350    first call keydb_search_reset().  */
351 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
352
353 /* This is a convenience function for searching for keys with a long
354    (20 byte) fingerprint.
355
356    Note: this function resumes searching where the last search left
357    off.  If you want to search the whole database, then you need to
358    first call keydb_search_reset().  */
359 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
360
361
362 /*-- pkclist.c --*/
363 void show_revocation_reason( PKT_public_key *pk, int mode );
364 int  check_signatures_trust( PKT_signature *sig );
365
366 void release_pk_list (PK_LIST pk_list);
367 int  build_pk_list (ctrl_t ctrl,
368                     strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use);
369 gpg_error_t find_and_check_key (ctrl_t ctrl,
370                                 const char *name, unsigned int use,
371                                 int mark_hidden, pk_list_t *pk_list_addr);
372
373 int  algo_available( preftype_t preftype, int algo,
374                      const union pref_hint *hint );
375 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
376                              int request, const union pref_hint *hint);
377 int  select_mdc_from_pklist (PK_LIST pk_list);
378 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
379 void warn_missing_aes_from_pklist (PK_LIST pk_list);
380
381 /*-- skclist.c --*/
382 int  random_is_faked (void);
383 void release_sk_list( SK_LIST sk_list );
384 gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
385                            SK_LIST *ret_sk_list, unsigned use);
386
387 /*-- passphrase.h --*/
388 unsigned char encode_s2k_iterations (int iterations);
389 assuan_context_t agent_open (int try, const char *orig_codeset);
390 void agent_close (assuan_context_t ctx);
391 int  have_static_passphrase(void);
392 const char *get_static_passphrase (void);
393 void set_passphrase_from_string(const char *pass);
394 void read_passphrase_from_fd( int fd );
395 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
396 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
397                            int cipher_algo, STRING2KEY *s2k, int mode,
398                            const char *tryagain_text,
399                            const char *custdesc, const char *custprompt,
400                            int *canceled);
401 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
402                         int cipher_algo, STRING2KEY *s2k, int mode,
403                         const char *tryagain_text, int *canceled);
404 void set_next_passphrase( const char *s );
405 char *get_last_passphrase(void);
406 void next_to_last_passphrase(void);
407
408 void emit_status_need_passphrase (u32 *keyid, u32 *mainkeyid, int pubkey_algo);
409
410 #define FORMAT_KEYDESC_NORMAL  0
411 #define FORMAT_KEYDESC_IMPORT  1
412 #define FORMAT_KEYDESC_EXPORT  2
413 #define FORMAT_KEYDESC_DELKEY  3
414 char *gpg_format_keydesc (PKT_public_key *pk, int mode, int escaped);
415
416
417 /*-- getkey.c --*/
418
419 /* Cache a copy of a public key in the public key cache.  PK is not
420    cached if caching is disabled (via getkey_disable_caches), if
421    PK->FLAGS.DONT_CACHE is set, we don't know how to derive a key id
422    from the public key (e.g., unsupported algorithm), or a key with
423    the key id is already in the cache.
424
425    The public key packet is copied into the cache using
426    copy_public_key.  Thus, any secret parts are not copied, for
427    instance.
428
429    This cache is filled by get_pubkey and is read by get_pubkey and
430    get_pubkey_fast.  */
431 void cache_public_key( PKT_public_key *pk );
432
433 /* Disable and drop the public key cache (which is filled by
434    cache_public_key and get_pubkey).  Note: there is currently no way
435    to reenable this cache.  */
436 void getkey_disable_caches(void);
437
438 /* Return the public key with the key id KEYID and store it in *PK.
439    The resources in *PK should be released using
440    release_public_key_parts().  This function also stores a copy of
441    the public key in the user id cache (see cache_public_key).
442
443    If PK is NULL, this function just stores the public key in the
444    cache and returns the usual return code.
445
446    PK->REQ_USAGE (which is a mask of PUBKEY_USAGE_SIG,
447    PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT) is passed through to the
448    lookup function.  If this is non-zero, only keys with the specified
449    usage will be returned.  As such, it is essential that
450    PK->REQ_USAGE be correctly initialized!
451
452    Returns 0 on success, GPG_ERR_NO_PUBKEY if there is no public key
453    with the specified key id, or another error code if an error
454    occurs.
455
456    If the data was not read from the cache, then the self-signed data
457    has definitely been merged into the public key using
458    merge_selfsigs.  */
459 int get_pubkey( PKT_public_key *pk, u32 *keyid );
460
461 /* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
462    account nor does it merge in the self-signed data.  This function
463    also only considers primary keys.  It is intended to be used as a
464    quick check of the key to avoid recursion.  It should only be used
465    in very certain cases.  Like get_pubkey and unlike any of the other
466    lookup functions, this function also consults the user id cache
467    (see cache_public_key).
468
469    Return the public key in *PK.  The resources in *PK should be
470    released using release_public_key_parts().  */
471 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
472
473 /* Return the key block for the key with key id KEYID or NULL, if an
474    error occurs.  Use release_kbnode() to release the key block.
475
476    The self-signed data has already been merged into the public key
477    using merge_selfsigs.  */
478 KBNODE get_pubkeyblock( u32 *keyid );
479
480 /* Find a public key identified by the name NAME.
481
482    If name appears to be a valid valid RFC822 mailbox (i.e., email
483    address) and auto key lookup is enabled (no_akl == 0), then the
484    specified auto key lookup methods (--auto-key-lookup) are used to
485    import the key into the local keyring.  Otherwise, just the local
486    keyring is consulted.
487
488
489    If RETCTX is not NULL, then the constructed context is returned in
490    *RETCTX so that getpubkey_next can be used to get subsequent
491    results.  In this case, getkey_end() must be used to free the
492    search context.  If RETCTX is not NULL, then RET_KDBHD must be
493    NULL.
494
495    If PK is not NULL, the public key of the first result is returned
496    in *PK.  Note: PK->REQ_USAGE must be valid!!!  PK->REQ_USAGE is
497    passed through to the lookup function and is a mask of
498    PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.  If this
499    is non-zero, only keys with the specified usage will be returned.
500    Note: The self-signed data has already been merged into the public
501    key using merge_selfsigs.  Free *PK by calling
502    release_public_key_parts (or, if PK was allocated using xfree, you
503    can use free_public_key, which calls release_public_key_parts(PK)
504    and then xfree(PK)).
505
506    NAME is a string, which is turned into a search query using
507    classify_user_id.
508
509    If RET_KEYBLOCK is not NULL, the keyblock is returned in
510    *RET_KEYBLOCK.  This should be freed using release_kbnode().
511
512    If RET_KDBHD is not NULL, then the new database handle used to
513    conduct the search is returned in *RET_KDBHD.  This can be used to
514    get subsequent results using keydb_search_next or to modify the
515    returned record.  Note: in this case, no advanced filtering is done
516    for subsequent results (e.g., PK->REQ_USAGE is not respected).
517    Unlike RETCTX, this is always returned.
518
519    If INCLUDE_UNUSABLE is set, then unusable keys (see the
520    documentation for skip_unusable for an exact definition) are
521    skipped unless they are looked up by key id or by fingerprint.
522
523    If NO_AKL is set, then the auto key locate functionality is
524    disabled and only the local key ring is considered.  Note: the
525    local key ring is consulted even if local is not in the
526    --auto-key-locate option list!
527
528    This function returns 0 on success.  Otherwise, an error code is
529    returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
530    (if want_secret is set) is returned if the key is not found.  */
531 int get_pubkey_byname (ctrl_t ctrl,
532                        GETKEY_CTX *retctx, PKT_public_key *pk,
533                        const char *name,
534                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
535                        int include_unusable, int no_akl );
536
537 /* Return the public key with the key id KEYID and store it in *PK.
538    The resources should be released using release_public_key_parts().
539
540    Unlike other lookup functions, PK may not be NULL.  PK->REQ_USAGE
541    is passed through to the lookup function and is a mask of
542    PUBKEY_USAGE_SIG, PUBKEY_USAGE_ENC and PUBKEY_USAGE_CERT.  Thus, it
543    must be valid!  If this is non-zero, only keys with the specified
544    usage will be returned.
545
546    Returns 0 on success.  If a public key with the specified key id is
547    not found or a secret key is not available for that public key, an
548    error code is returned.  Note: this function ignores legacy keys.
549    An error code is also return if an error occurs.
550
551    The self-signed data has already been merged into the public key
552    using merge_selfsigs.  */
553 gpg_error_t get_seckey (PKT_public_key *pk, u32 *keyid);
554
555 /* Lookup a key with the specified fingerprint.
556
557    If PK is not NULL, the public key of the first result is returned
558    in *PK.  Note: this function does an exact search and thus the
559    returned public key may be a subkey rather than the primary key.
560    Note: The self-signed data has already been merged into the public
561    key using merge_selfsigs.  Free *PK by calling
562    release_public_key_parts (or, if PK was allocated using xfree, you
563    can use free_public_key, which calls release_public_key_parts(PK)
564    and then xfree(PK)).
565
566    If PK->REQ_USAGE is set, it is used to filter the search results.
567    (Thus, if PK is not NULL, PK->REQ_USAGE must be valid!!!)  See the
568    documentation for finish_lookup to understand exactly how this is
569    used.
570
571    If R_KEYBLOCK is not NULL, then the first result's keyblock is
572    returned in *R_KEYBLOCK.  This should be freed using
573    release_kbnode().
574
575    FPRINT is a byte array whose contents is the fingerprint to use as
576    the search term.  FPRINT_LEN specifies the length of the
577    fingerprint (in bytes).  Currently, only 16 and 20-byte
578    fingerprints are supported.  */
579 int get_pubkey_byfprint (PKT_public_key *pk,  kbnode_t *r_keyblock,
580                          const byte *fprint, size_t fprint_len);
581
582 /* This function is similar to get_pubkey_byfprint, but it doesn't
583    merge the self-signed data into the public key and subkeys or into
584    the user ids.  It also doesn't add the key to the user id cache.
585    Further, this function ignores PK->REQ_USAGE.
586
587    This function is intended to avoid recursion and, as such, should
588    only be used in very specific situations.
589
590    Like get_pubkey_byfprint, PK may be NULL.  In that case, this
591    function effectively just checks for the existence of the key.  */
592 int get_pubkey_byfprint_fast (PKT_public_key *pk,
593                               const byte *fprint, size_t fprint_len);
594
595 /* Returns true if a secret key is available for the public key with
596    key id KEYID.  */
597 int have_secret_key_with_kid (u32 *keyid);
598
599 /* Parse the --default-key parameter.  Returns the last key (in terms
600    of when the option is given) that is available.  */
601 const char *parse_def_secret_key (ctrl_t ctrl);
602
603 /* Look up a secret key.
604
605    If PK is not NULL, the public key of the first result is returned
606    in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
607    set, it is used to filter the search results.  See the
608    documentation for finish_lookup to understand exactly how this is
609    used.  Note: The self-signed data has already been merged into the
610    public key using merge_selfsigs.  Free *PK by calling
611    release_public_key_parts (or, if PK was allocated using xfree, you
612    can use free_public_key, which calls release_public_key_parts(PK)
613    and then xfree(PK)).
614
615    If --default-key was set, then the specified key is looked up.  (In
616    this case, the default key is returned even if it is considered
617    unusable.  See the documentation for skip_unusable for exactly what
618    this means.)
619
620    Otherwise, this initiates a DB scan that returns all keys that are
621    usable (see previous paragraph for exactly what usable means) and
622    for which a secret key is available.
623
624    This function returns the first match.  Additional results can be
625    returned using getkey_next.  */
626 gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
627
628 /* Search for keys matching some criteria.
629
630    If RETCTX is not NULL, then the constructed context is returned in
631    *RETCTX so that getpubkey_next can be used to get subsequent
632    results.  In this case, getkey_end() must be used to free the
633    search context.  If RETCTX is not NULL, then RET_KDBHD must be
634    NULL.
635
636    If PK is not NULL, the public key of the first result is returned
637    in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
638    set, it is used to filter the search results.  See the
639    documentation for finish_lookup to understand exactly how this is
640    used.  Note: The self-signed data has already been merged into the
641    public key using merge_selfsigs.  Free *PK by calling
642    release_public_key_parts (or, if PK was allocated using xfree, you
643    can use free_public_key, which calls release_public_key_parts(PK)
644    and then xfree(PK)).
645
646    If NAMES is not NULL, then a search query is constructed using
647    classify_user_id on each of the strings in the list.  (Recall: the
648    database does an OR of the terms, not an AND.)  If NAMES is
649    NULL, then all results are returned.
650
651    If WANT_SECRET is set, then only keys with an available secret key
652    (either locally or via key registered on a smartcard) are returned.
653
654    This function does not skip unusable keys (see the documentation
655    for skip_unusable for an exact definition).
656
657    If RET_KEYBLOCK is not NULL, the keyblock is returned in
658    *RET_KEYBLOCK.  This should be freed using release_kbnode().
659
660    This function returns 0 on success.  Otherwise, an error code is
661    returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
662    (if want_secret is set) is returned if the key is not found.  */
663 gpg_error_t getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
664                             strlist_t names, int want_secret,
665                             kbnode_t *ret_keyblock);
666
667 /* Search for keys matching some criteria.
668
669    If RETCTX is not NULL, then the constructed context is returned in
670    *RETCTX so that getpubkey_next can be used to get subsequent
671    results.  In this case, getkey_end() must be used to free the
672    search context.  If RETCTX is not NULL, then RET_KDBHD must be
673    NULL.
674
675    If PK is not NULL, the public key of the first result is returned
676    in *PK.  Note: PK->REQ_USAGE must be valid!!!  If PK->REQ_USAGE is
677    set, it is used to filter the search results.  See the
678    documentation for finish_lookup to understand exactly how this is
679    used.  Note: The self-signed data has already been merged into the
680    public key using merge_selfsigs.  Free *PK by calling
681    release_public_key_parts (or, if PK was allocated using xfree, you
682    can use free_public_key, which calls release_public_key_parts(PK)
683    and then xfree(PK)).
684
685    If NAME is not NULL, then a search query is constructed using
686    classify_user_id on the string.  In this case, even unusable keys
687    (see the documentation for skip_unusable for an exact definition of
688    unusable) are returned.  Otherwise, if --default-key was set, then
689    that key is returned (even if it is unusable).  If neither of these
690    conditions holds, then the first usable key is returned.
691
692    If WANT_SECRET is set, then only keys with an available secret key
693    (either locally or via key registered on a smartcard) are returned.
694
695    This function does not skip unusable keys (see the documentation
696    for skip_unusable for an exact definition).
697
698    If RET_KEYBLOCK is not NULL, the keyblock is returned in
699    *RET_KEYBLOCK.  This should be freed using release_kbnode().
700
701    This function returns 0 on success.  Otherwise, an error code is
702    returned.  In particular, GPG_ERR_NO_PUBKEY or GPG_ERR_NO_SECKEY
703    (if want_secret is set) is returned if the key is not found.
704
705    FIXME: We also have the get_pubkey_byname function which has a
706    different semantic.  Should be merged with this one.  */
707 gpg_error_t getkey_byname (ctrl_t ctrl,
708                            getkey_ctx_t *retctx, PKT_public_key *pk,
709                            const char *name, int want_secret,
710                            kbnode_t *ret_keyblock);
711
712 /* Return the next search result.
713
714    If PK is not NULL, the public key of the next result is returned in
715    *PK.  Note: The self-signed data has already been merged into the
716    public key using merge_selfsigs.  Free *PK by calling
717    release_public_key_parts (or, if PK was allocated using xfree, you
718    can use free_public_key, which calls release_public_key_parts(PK)
719    and then xfree(PK)).
720
721    The self-signed data has already been merged into the public key
722    using merge_selfsigs.  */
723 gpg_error_t getkey_next (getkey_ctx_t ctx, PKT_public_key *pk,
724                          kbnode_t *ret_keyblock);
725
726 /* Release any resources used by a key listing content.  This must be
727    called on the context returned by, e.g., getkey_byname.  */
728 void getkey_end (getkey_ctx_t ctx);
729
730 /* Return the database handle used by this context.  The context still
731    owns the handle.  */
732 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
733
734 /* Enumerate some secret keys (specifically, those specified with
735    --default-key and --try-secret-key).  Use the following procedure:
736
737     1) Initialize a void pointer to NULL
738     2) Pass a reference to this pointer to this function (content)
739        and provide space for the secret key (sk)
740     3) Call this function as long as it does not return an error (or
741        until you are done).  The error code GPG_ERR_EOF indicates the
742        end of the listing.
743     4) Call this function a last time with SK set to NULL,
744        so that can free it's context.
745
746    In pseudo-code:
747
748      void *ctx = NULL;
749      PKT_public_key *sk = xmalloc_clear (sizeof (*sk));
750      gpg_error_t err;
751
752      while ((err = enum_secret_keys (&ctx, sk)))
753        {
754          // Process SK.
755
756          if (done)
757            break;
758
759          free_public_key (sk);
760          sk = xmalloc_clear (sizeof (*sk));
761        }
762
763      // Release any resources used by CTX.
764      enum_secret_keys (&ctx, NULL);
765      free_public_key (sk);
766
767      if (gpg_err_code (err) != GPG_ERR_EOF)
768        ; // An error occurred.
769  */
770 gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
771
772 /* Set the mainkey_id fields for all keys in KEYBLOCK.  This is
773    usually done by merge_selfsigs but at some places we only need the
774    main_kid not a full merge.  The function also guarantees that all
775    pk->keyids are computed. */
776 void setup_main_keyids (kbnode_t keyblock);
777
778 /* KEYBLOCK corresponds to a public key block.  This function merges
779    much of the information from the self-signed data into the public
780    key, public subkey and user id data structures.  If you use the
781    high-level search API (e.g., get_pubkey) for looking up key blocks,
782    then you don't need to call this function.  This function is
783    useful, however, if you change the keyblock, e.g., by adding or
784    removing a self-signed data packet.  */
785 void merge_keys_and_selfsig( KBNODE keyblock );
786
787 char*get_user_id_string_native( u32 *keyid );
788 char*get_long_user_id_string( u32 *keyid );
789 char*get_user_id( u32 *keyid, size_t *rn );
790 char*get_user_id_native( u32 *keyid );
791 char *get_user_id_byfpr (const byte *fpr, size_t *rn);
792 char *get_user_id_byfpr_native (const byte *fpr);
793
794 void release_akl(void);
795 int parse_auto_key_locate(char *options);
796
797 /*-- keyid.c --*/
798 int pubkey_letter( int algo );
799 char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
800 #define PUBKEY_STRING_SIZE 32
801 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
802 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
803 const char *format_keyid (u32 *keyid, int format, char *buffer, int len);
804 size_t keystrlen(void);
805 const char *keystr(u32 *keyid);
806 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
807 const char *keystr_from_pk(PKT_public_key *pk);
808 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
809                                      PKT_public_key *sub_pk);
810 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
811 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
812 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
813 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
814 byte *namehash_from_uid(PKT_user_id *uid);
815 unsigned nbits_from_pk( PKT_public_key *pk );
816 const char *datestr_from_pk( PKT_public_key *pk );
817 const char *datestr_from_sig( PKT_signature *sig );
818 const char *expirestr_from_pk( PKT_public_key *pk );
819 const char *expirestr_from_sig( PKT_signature *sig );
820 const char *revokestr_from_pk( PKT_public_key *pk );
821 const char *usagestr_from_pk (PKT_public_key *pk, int fill);
822 const char *colon_strtime (u32 t);
823 const char *colon_datestr_from_pk (PKT_public_key *pk);
824 const char *colon_datestr_from_sig (PKT_signature *sig);
825 const char *colon_expirestr_from_sig (PKT_signature *sig);
826 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
827 char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
828 char *format_hexfingerprint (const char *fingerprint,
829                              char *buffer, size_t buflen);
830 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
831 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);
832
833
834 /*-- kbnode.c --*/
835 KBNODE new_kbnode( PACKET *pkt );
836 KBNODE clone_kbnode( KBNODE node );
837 void release_kbnode( KBNODE n );
838 void delete_kbnode( KBNODE node );
839 void add_kbnode( KBNODE root, KBNODE node );
840 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
841 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
842 void remove_kbnode( KBNODE *root, KBNODE node );
843 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
844 KBNODE find_next_kbnode( KBNODE node, int pkttype );
845 KBNODE find_kbnode( KBNODE node, int pkttype );
846 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
847 void clear_kbnode_flags( KBNODE n );
848 int  commit_kbnode( KBNODE *root );
849 void dump_kbnode( KBNODE node );
850
851 #endif /*G10_KEYDB_H*/