build: Update config.{guess,sub} to {2016-05-15,2016-06-20}.
[gnupg.git] / g10 / keydb.h
index e160a87..4e8f3f2 100644 (file)
@@ -1,7 +1,7 @@
 /* keydb.h - Key database
  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
  *               2006, 2010 Free Software Foundation, Inc.
- * Copyright (C) 2015 g10 Code GmbH
+ * Copyright (C) 2015, 2016 g10 Code GmbH
  *
  * This file is part of GnuPG.
  *
@@ -22,8 +22,6 @@
 #ifndef G10_KEYDB_H
 #define G10_KEYDB_H
 
-#include <assuan.h>
-
 #include "types.h"
 #include "util.h"
 #include "packet.h"
@@ -69,8 +67,23 @@ enum resource_type {
 };
 
 
+/* Bit flags used with build_pk_list.  */
+enum
+  {
+    PK_LIST_ENCRYPT_TO = 1, /* This is an encrypt-to recipient.    */
+    PK_LIST_HIDDEN     = 2, /* This is a hidden recipient.         */
+    PK_LIST_CONFIG     = 4, /* Specified via config file.          */
+    PK_LIST_FROM_FILE  = 8  /* Take key from file with that name.  */
+  };
+/* To store private data in the flags the private data must be left
+   shifted by this value.  */
+enum
+  {
+    PK_LIST_SHIFT = 4
+  };
+
 /****************
- * A data structre to hold information about the external position
+ * A data structure to hold information about the external position
  * of a keyblock.
  */
 struct keyblock_pos_struct {
@@ -92,7 +105,7 @@ struct pk_list
 {
   PK_LIST next;
   PKT_public_key *pk;
-  int flags; /* flag bit 1==throw_keyid */
+  int flags;           /* See PK_LIST_ constants. */
 };
 
 /* Structure to hold a list of secret key certificates.  */
@@ -133,59 +146,18 @@ union pref_hint
 #define KEYDB_RESOURCE_FLAG_READONLY 8  /* Open in read only mode.  */
 #define KEYDB_RESOURCE_FLAG_GPGVDEF 16  /* Default file for gpgv.  */
 
-/* Register a resource (keyring or keybox).  The first keyring or
-   keybox that is added using this function is created if it does not
-   already exist and the KEYDB_RESOURCE_FLAG_READONLY is not set.
-
-   FLAGS are a combination of the KEYDB_RESOURCE_FLAG_* constants.
-
-   URL must have the following form:
-
-     gnupg-ring:filename  = plain keyring
-     gnupg-kbx:filename   = keybox file
-     filename             = check file's type (create as a plain keyring)
-
-   Note: on systems with drive letters (Windows) invalid URLs (i.e.,
-   those with an unrecognized part before the ':' such as "c:\...")
-   will silently be treated as bare filenames.  On other systems, such
-   URLs will cause this function to return GPG_ERR_GENERAL.
-
-   If KEYDB_RESOURCE_FLAG_DEFAULT is set, the resource is a keyring
-   and the file ends in ".gpg", then this function also checks if a
-   file with the same name, but the extension ".kbx" exists, is a
-   keybox and the OpenPGP flag is set.  If so, this function opens
-   that resource instead.
-
-   If the file is not found, KEYDB_RESOURCE_FLAG_GPGVDEF is set and
-   the URL ends in ".kbx", then this function will try opening the
-   same URL, but with the extension ".gpg".  If that file is a keybox
-   with the OpenPGP flag set or it is a keyring, then we use that
-   instead.
+/* Format a search term for debugging output.  The caller must free
+   the result.  */
+char *keydb_search_desc_dump (struct keydb_search_desc *desc);
 
-   If the file is not found, KEYDB_RESOURCE_FLAG_DEFAULT is set, the
-   file should be created and the file's extension is ".gpg" then we
-   replace the extension with ".kbx".
-
-
-   If the KEYDB_RESOURCE_FLAG_PRIMARY is set and the resource is a
-   keyring (not a keybox), then this resource is considered the
-   primary resource.  This is used by keydb_locate_writable().  If
-   another primary keyring is set, then that keyring is considered the
-   primary.
-
-   If KEYDB_RESOURCE_FLAG_READONLY is set and the resource is a
-   keyring (not a keybox), then the keyring is marked as read only and
-   operations just as keyring_insert_keyblock will return
-   GPG_ERR_ACCESS.  */
+/* Register a resource (keyring or keybox).  */
 gpg_error_t keydb_add_resource (const char *url, unsigned int flags);
 
 /* Dump some statistics to the log.  */
 void keydb_dump_stats (void);
 
-/* Create a new database handle.  A database handle is similar to a
-   file handle: it contains a local file position.  This is used when
-   searching: subsequent searches resume where the previous search
-   left off.  To rewind the position, use keydb_search_reset().  */
+/* Create a new database handle.  Returns NULL on error, sets ERRNO,
+   and prints an error diagnostic. */
 KEYDB_HANDLE keydb_new (void);
 
 /* Free all resources owned by the database handle.  */
@@ -196,85 +168,28 @@ void keydb_release (KEYDB_HANDLE hd);
    Using a new parameter for keydb_new might be a better solution.  */
 void keydb_disable_caching (KEYDB_HANDLE hd);
 
-/* Save the last found state and invalidate the current selection
-   (i.e., the entry selected by keydb_search() is invalidated and
-   something like keydb_get_keyblock() will return an error).  This
-   does not change the file position.  This makes it possible to do
-   something like:
-
-     keydb_search (hd, ...);  // Result 1.
-     keydb_push_found_state (hd);
-       keydb_search_reset (hd);
-       keydb_search (hd, ...);  // Result 2.
-     keydb_pop_found_state (hd);
-     keydb_get_keyblock (hd, ...);  // -> Result 1.
-
-   Note: it is only possible to save a single save state at a time.
-   In other words, the the save stack only has room for a single
-   instance of the state.  */
+/* Save the last found state and invalidate the current selection.  */
 void keydb_push_found_state (KEYDB_HANDLE hd);
 
-/* Restore the previous save state.  If the saved state is invalid,
-   this is equivalent to */
+/* Restore the previous save state.  */
 void keydb_pop_found_state (KEYDB_HANDLE hd);
 
-/* Return the file name of the resource in which the current search
-   result was found or, if there is no search result, the filename of
-   the current resource (i.e., the resource that the file position
-   points to).  Note: the filename is not necessarily the URL used to
-   open it!
-
-   This function only returns NULL if no handle is specified, in all
-   other error cases an empty string is returned.  */
+/* Return the file name of the resource.  */
 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
 
-/* Return the keyblock last found by keydb_search() in *RET_KB.
-
-   On success, the function returns 0 and the caller must free *RET_KB
-   using release_kbnode().  Otherwise, the function returns an error
-   code.
-
-   The returned keyblock has the kbnode flag bit 0 set for the node
-   with the public key used to locate the keyblock or flag bit 1 set
-   for the user ID node.  */
+/* Return the keyblock last found by keydb_search.  */
 gpg_error_t keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
 
-/* Replace the currently selected keyblock (i.e., the last result
-   returned by keydb_search) with the key block in KB.
-
-   This doesn't do anything if --dry-run was specified.
-
-   Returns 0 on success.  Otherwise, it returns an error code.  */
+/* Update the keyblock KB.  */
 gpg_error_t keydb_update_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
 
-/* Insert a keyblock into one of the underlying keyrings or keyboxes.
-
-   Be default, the keyring / keybox from which the last search result
-   came is used.  If there was no previous search result (or
-   keydb_search_reset was called), then the keyring / keybox where the
-   next search would start is used (i.e., the current file position).
-
-   Note: this doesn't do anything if --dry-run was specified.
-
-   Returns 0 on success.  Otherwise, it returns an error code.  */
+/* Insert a keyblock into one of the underlying keyrings or keyboxes.  */
 gpg_error_t keydb_insert_keyblock (KEYDB_HANDLE hd, kbnode_t kb);
 
-/* Delete the currently selected keyblock.  If you haven't done a
-   search yet on this database handle (or called keydb_search_reset),
-   then this will return an error.
-
-   Returns 0 on success or an error code, if an error occurs.  */
+/* Delete the currently selected keyblock.  */
 gpg_error_t keydb_delete_keyblock (KEYDB_HANDLE hd);
 
-/* A database may consists of multiple keyrings / key boxes.  This
-   sets the "file position" to the start of the first keyring / key
-   box that is writable (i.e., doesn't have the read-only flag set).
-
-   This first tries the primary keyring (the last keyring (not
-   keybox!) added using keydb_add_resource() and with
-   KEYDB_RESOURCE_FLAG_PRIMARY set).  If that is not writable, then it
-   tries the keyrings / keyboxes in the order in which they were
-   added.  */
+/* Find the first writable resource.  */
 gpg_error_t keydb_locate_writable (KEYDB_HANDLE hd);
 
 /* Rebuild the on-disk caches of all key resources.  */
@@ -284,74 +199,38 @@ void keydb_rebuild_caches (int noisy);
    read from a keybox) since the last search reset.  */
 unsigned long keydb_get_skipped_counter (KEYDB_HANDLE hd);
 
-/* Clears the current search result and resets the handle's position
-   so that the next search starts at the beginning of the database
-   (the start of the first resource).
-
-   Returns 0 on success and an error code if an error occured.
-   (Currently, this function always returns 0 if HD is valid.)  */
+/* Clears the current search result and resets the handle's position.  */
 gpg_error_t keydb_search_reset (KEYDB_HANDLE hd);
 
-/* Search the database for keys matching the search description.
-
-   DESC is an array of search terms with NDESC entries.  The search
-   terms are or'd together.  That is, the next entry in the DB that
-   matches any of the descriptions will be returned.
-
-   Note: this function resumes searching where the last search left
-   off (i.e., at the current file position).  If you want to search
-   from the start of the database, then you need to first call
-   keydb_search_reset().
-
-   If no key matches the search description, returns
-   GPG_ERR_NOT_FOUND.  If there was a match, returns 0.  If an error
-   occured, returns an error code.
-
-   The returned key is considered to be selected and the raw data can,
-   for instance, be returned by calling keydb_get_keyblock().  */
+/* Search the database for keys matching the search description.  */
 gpg_error_t keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
                           size_t ndesc, size_t *descindex);
 
-/* Return the first non-legacy key in the database.
-
-   If you want the very first key in the database, you can directly
-   call keydb_search with the search description
-   KEYDB_SEARCH_MODE_FIRST.  */
+/* Return the first non-legacy key in the database.  */
 gpg_error_t keydb_search_first (KEYDB_HANDLE hd);
 
-/* Return the next key (not the next matching key!).
-
-   Unlike calling keydb_search with KEYDB_SEARCH_MODE_NEXT, this
-   function silently skips legacy keys.  */
+/* Return the next key (not the next matching key!).  */
 gpg_error_t keydb_search_next (KEYDB_HANDLE hd);
 
 /* This is a convenience function for searching for keys with a long
-   key id.
-
-   Note: this function resumes searching where the last search left
-   off.  If you want to search the whole database, then you need to
-   first call keydb_search_reset().  */
+   key id.  */
 gpg_error_t keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
 
 /* This is a convenience function for searching for keys with a long
-   (20 byte) fingerprint.  This function ignores legacy keys.
-
-   Note: this function resumes searching where the last search left
-   off.  If you want to search the whole database, then you need to
-   first call keydb_search_reset().  */
+   (20 byte) fingerprint.  */
 gpg_error_t keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
 
 
 /*-- pkclist.c --*/
 void show_revocation_reason( PKT_public_key *pk, int mode );
-int  check_signatures_trust( PKT_signature *sig );
+int  check_signatures_trust (ctrl_t ctrl, PKT_signature *sig);
 
 void release_pk_list (PK_LIST pk_list);
-int  build_pk_list (ctrl_t ctrl,
-                    strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use);
+int  build_pk_list (ctrl_t ctrl, strlist_t rcpts, PK_LIST *ret_pk_list);
 gpg_error_t find_and_check_key (ctrl_t ctrl,
                                 const char *name, unsigned int use,
-                                int mark_hidden, pk_list_t *pk_list_addr);
+                                int mark_hidden, int from_file,
+                                pk_list_t *pk_list_addr);
 
 int  algo_available( preftype_t preftype, int algo,
                     const union pref_hint *hint );
@@ -364,13 +243,11 @@ void warn_missing_aes_from_pklist (PK_LIST pk_list);
 /*-- skclist.c --*/
 int  random_is_faked (void);
 void release_sk_list( SK_LIST sk_list );
-gpg_error_t  build_sk_list (strlist_t locusr, SK_LIST *ret_sk_list,
-                            unsigned use);
+gpg_error_t build_sk_list (ctrl_t ctrl, strlist_t locusr,
+                           SK_LIST *ret_sk_list, unsigned use);
 
 /*-- passphrase.h --*/
 unsigned char encode_s2k_iterations (int iterations);
-assuan_context_t agent_open (int try, const char *orig_codeset);
-void agent_close (assuan_context_t ctx);
 int  have_static_passphrase(void);
 const char *get_static_passphrase (void);
 void set_passphrase_from_string(const char *pass);
@@ -398,55 +275,123 @@ char *gpg_format_keydesc (PKT_public_key *pk, int mode, int escaped);
 
 
 /*-- getkey.c --*/
+
+/* Cache a copy of a public key in the public key cache.  */
 void cache_public_key( PKT_public_key *pk );
+
+/* Disable and drop the public key cache.  */
 void getkey_disable_caches(void);
+
+/* Return the public key with the key id KEYID and store it at PK.  */
 int get_pubkey( PKT_public_key *pk, u32 *keyid );
-int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
-KBNODE get_pubkeyblock( u32 *keyid );
+
+/* Similar to get_pubkey, but it does not take PK->REQ_USAGE into
+   account nor does it merge in the self-signed data.  This function
+   also only considers primary keys.  */
+int get_pubkey_fast (PKT_public_key *pk, u32 *keyid);
+
+/* Return the key block for the key with KEYID.  */
+kbnode_t get_pubkeyblock (u32 *keyid);
+
+/* A list used by get_pubkeys to gather all of the matches.  */
+struct pubkey_s
+{
+  struct pubkey_s *next;
+  /* The key to use (either the public key or the subkey).  */
+  PKT_public_key *pk;
+  kbnode_t keyblock;
+};
+typedef struct pubkey_s *pubkey_t;
+
+/* Free a single key.  This does not remove key from any list!  */
+void pubkey_free (pubkey_t key);
+
+/* Free a list of public keys.  */
+void pubkeys_free (pubkey_t keys);
+
+/* Returns all keys that match the search specfication SEARCH_TERMS.
+   The returned keys should be freed using pubkeys_free.  */
+gpg_error_t
+get_pubkeys (ctrl_t ctrl,
+             char *search_terms, int use, int include_unusable, char *source,
+             int warn_possibly_ambiguous,
+             pubkey_t *r_keys);
+
+/* Find a public key identified by NAME.  */
 int get_pubkey_byname (ctrl_t ctrl,
-                       GETKEY_CTX *rx, PKT_public_key *pk,  const char *name,
+                       GETKEY_CTX *retctx, PKT_public_key *pk,
+                      const char *name,
                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
                       int include_unusable, int no_akl );
+
+/* Get a public key directly from file FNAME.  */
+gpg_error_t get_pubkey_fromfile (ctrl_t ctrl,
+                                 PKT_public_key *pk, const char *fname);
+
+/* Return the public key with the key id KEYID iff the secret key is
+ * available and store it at PK.  */
 gpg_error_t get_seckey (PKT_public_key *pk, u32 *keyid);
+
+/* Lookup a key with the specified fingerprint.  */
 int get_pubkey_byfprint (PKT_public_key *pk,  kbnode_t *r_keyblock,
                          const byte *fprint, size_t fprint_len);
+
+/* This function is similar to get_pubkey_byfprint, but it doesn't
+   merge the self-signed data into the public key and subkeys or into
+   the user ids.  */
 int get_pubkey_byfprint_fast (PKT_public_key *pk,
                               const byte *fprint, size_t fprint_len);
 
-/* Return whether a secret key is available for the public key with
-   key id KEYID.  Note: this is just a fast check and does not tell us
-   whether the secret key is valid; this check merely indicates
-   whether there is some secret key with the specified key id.  */
+/* Returns true if a secret key is available for the public key with
+   key id KEYID.  */
 int have_secret_key_with_kid (u32 *keyid);
 
-gpg_error_t get_seckey_default (PKT_public_key *pk);
+/* Parse the --default-key parameter.  Returns the last key (in terms
+   of when the option is given) that is available.  */
+const char *parse_def_secret_key (ctrl_t ctrl);
 
-gpg_error_t get_seckey_byfprint (PKT_public_key *pk,
-                                 const byte *fprint, size_t fprint_len);
-gpg_error_t get_seckeyblock_byfprint (kbnode_t *ret_keyblock,
-                                      const byte *fprint, size_t fprint_len);
+/* Look up a secret key.  */
+gpg_error_t get_seckey_default (ctrl_t ctrl, PKT_public_key *pk);
 
+/* Search for keys matching some criteria.  */
 gpg_error_t getkey_bynames (getkey_ctx_t *retctx, PKT_public_key *pk,
                             strlist_t names, int want_secret,
                             kbnode_t *ret_keyblock);
-gpg_error_t getkey_byname (getkey_ctx_t *retctx, PKT_public_key *pk,
+
+/* Search for one key matching some criteria.  */
+gpg_error_t getkey_byname (ctrl_t ctrl,
+                           getkey_ctx_t *retctx, PKT_public_key *pk,
                            const char *name, int want_secret,
                            kbnode_t *ret_keyblock);
+
+/* Return the next search result.  */
 gpg_error_t getkey_next (getkey_ctx_t ctx, PKT_public_key *pk,
                          kbnode_t *ret_keyblock);
+
+/* Release any resources used by a key listing context.  */
 void getkey_end (getkey_ctx_t ctx);
 
-gpg_error_t enum_secret_keys (void **context, PKT_public_key *pk);
+/* Return the database handle used by this context.  The context still
+   owns the handle.  */
+KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
+
+/* Enumerate some secret keys.  */
+gpg_error_t enum_secret_keys (ctrl_t ctrl, void **context, PKT_public_key *pk);
 
+/* Set the mainkey_id fields for all keys in KEYBLOCK.  */
 void setup_main_keyids (kbnode_t keyblock);
-void merge_keys_and_selfsig( KBNODE keyblock );
+
+/* This function merges information from the self-signed data into the
+   data structures.  */
+void merge_keys_and_selfsig (kbnode_t keyblock);
+
 char*get_user_id_string_native( u32 *keyid );
 char*get_long_user_id_string( u32 *keyid );
 char*get_user_id( u32 *keyid, size_t *rn );
 char*get_user_id_native( u32 *keyid );
 char *get_user_id_byfpr (const byte *fpr, size_t *rn);
 char *get_user_id_byfpr_native (const byte *fpr);
-KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
+
 void release_akl(void);
 int parse_auto_key_locate(char *options);
 
@@ -456,12 +401,45 @@ char *pubkey_string (PKT_public_key *pk, char *buffer, size_t bufsize);
 #define PUBKEY_STRING_SIZE 32
 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
+char *format_keyid (u32 *keyid, int format, char *buffer, int len);
+
+/* Return PK's keyid.  The memory is owned by PK.  */
+u32 *pk_keyid (PKT_public_key *pk);
+
+/* Return the keyid of the primary key associated with PK.  The memory
+   is owned by PK.  */
+u32 *pk_main_keyid (PKT_public_key *pk);
+
+/* Order A and B.  If A < B then return -1, if A == B then return 0,
+   and if A > B then return 1.  */
+static int GPGRT_ATTR_UNUSED
+keyid_cmp (const u32 *a, const u32 *b)
+{
+  if (a[0] < b[0])
+    return -1;
+  if (a[0] > b[0])
+    return 1;
+  if (a[1] < b[1])
+    return -1;
+  if (a[1] > b[1])
+    return 1;
+  return 0;
+}
+
+/* Copy the keyid in SRC to DEST and return DEST.  */
+u32 *keyid_copy (u32 *dest, const u32 *src);
+
 size_t keystrlen(void);
 const char *keystr(u32 *keyid);
 const char *keystr_with_sub (u32 *main_kid, u32 *sub_kid);
 const char *keystr_from_pk(PKT_public_key *pk);
 const char *keystr_from_pk_with_sub (PKT_public_key *main_pk,
                                      PKT_public_key *sub_pk);
+
+/* Return PK's key id as a string using the default format.  PK owns
+   the storage.  */
+const char *pk_keyid_str (PKT_public_key *pk);
+
 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
@@ -479,7 +457,9 @@ const char *colon_datestr_from_pk (PKT_public_key *pk);
 const char *colon_datestr_from_sig (PKT_signature *sig);
 const char *colon_expirestr_from_sig (PKT_signature *sig);
 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
-char *hexfingerprint (PKT_public_key *pk);
+char *hexfingerprint (PKT_public_key *pk, char *buffer, size_t buflen);
+char *format_hexfingerprint (const char *fingerprint,
+                             char *buffer, size_t buflen);
 gpg_error_t keygrip_from_pk (PKT_public_key *pk, unsigned char *array);
 gpg_error_t hexkeygrip_from_pk (PKT_public_key *pk, char **r_grip);