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