g10/keydb.h

   1 /* keydb.h - Key database
   2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
   3  *               2006 Free Software Foundation, Inc.
   4  *
   5  * This file is part of GnuPG.
   6  *
   7  * GnuPG is free software; you can redistribute it and/or modify
   8  * it under the terms of the GNU General Public License as published by
   9  * the Free Software Foundation; either version 3 of the License, or
  10  * (at your option) any later version.
  11  *
  12  * GnuPG is distributed in the hope that it will be useful,
  13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  15  * GNU General Public License for more details.
  16  *
  17  * You should have received a copy of the GNU General Public License
  18  * along with this program; if not, see <http://www.gnu.org/licenses/>.
  19  */
  20
  21 #ifndef G10_KEYDB_H
  22 #define G10_KEYDB_H
  23
  24 #include <assuan.h>
  25
  26 #include "types.h"
  27 #include "packet.h"
  28 #include "cipher.h"
  29
  30 /* What qualifies as a certification (rather than a signature?) */
  31 #define IS_CERT(s)       (IS_KEY_SIG(s) || IS_UID_SIG(s) || IS_SUBKEY_SIG(s) \
  32                          || IS_KEY_REV(s) || IS_UID_REV(s) || IS_SUBKEY_REV(s))
  33 #define IS_SIG(s)        (!IS_CERT(s))
  34 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
  35 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
  36 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
  37 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
  38 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
  39 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
  40
  41 struct getkey_ctx_s;
  42 typedef struct getkey_ctx_s *GETKEY_CTX;
  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 /****************
  71  * A data structre to hold information about the external position
  72  * of a keyblock.
  73  */
  74 struct keyblock_pos_struct {
  75     int   resno;     /* resource number */
  76     enum resource_type rt;
  77     off_t offset;    /* position information */
  78     unsigned count;  /* length of the keyblock in packets */
  79     iobuf_t  fp;     /* Used by enum_keyblocks. */
  80     int secret;      /* working on a secret keyring */
  81     PACKET *pkt;     /* ditto */
  82     int valid;
  83 };
  84 typedef struct keyblock_pos_struct KBPOS;
  85
  86 /* Structure to hold a couple of public key certificates. */
  87 typedef struct pk_list *PK_LIST;  /* Deprecated. */
  88 typedef struct pk_list *pk_list_t;
  89 struct pk_list
  90 {
  91   PK_LIST next;
  92   PKT_public_key *pk;
  93   int flags; /* flag bit 1==throw_keyid */
  94 };
  95
  96 /* structure to hold a couple of secret key certificates */
  97 typedef struct sk_list *SK_LIST;
  98 struct sk_list {
  99     SK_LIST next;
 100     PKT_secret_key *sk;
 101     int mark; /* not used */
 102 };
 103
 104 /* structure to collect all information which can be used to
 105  * identify a public key */
 106 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
 107 struct pubkey_find_info {
 108     u32  keyid[2];
 109     unsigned nbits;
 110     byte pubkey_algo;
 111     byte fingerprint[MAX_FINGERPRINT_LEN];
 112     char userid[1];
 113 };
 114
 115
 116 typedef struct keydb_handle *KEYDB_HANDLE;
 117
 118 typedef enum {
 119     KEYDB_SEARCH_MODE_NONE,
 120     KEYDB_SEARCH_MODE_EXACT,
 121     KEYDB_SEARCH_MODE_SUBSTR,
 122     KEYDB_SEARCH_MODE_MAIL,
 123     KEYDB_SEARCH_MODE_MAILSUB,
 124     KEYDB_SEARCH_MODE_MAILEND,
 125     KEYDB_SEARCH_MODE_WORDS,
 126     KEYDB_SEARCH_MODE_SHORT_KID,
 127     KEYDB_SEARCH_MODE_LONG_KID,
 128     KEYDB_SEARCH_MODE_FPR16,
 129     KEYDB_SEARCH_MODE_FPR20,
 130     KEYDB_SEARCH_MODE_FPR,
 131     KEYDB_SEARCH_MODE_FIRST,
 132     KEYDB_SEARCH_MODE_NEXT
 133 } KeydbSearchMode;
 134
 135 struct keydb_search_desc {
 136     KeydbSearchMode mode;
 137     int (*skipfnc)(void *,u32*,PKT_user_id*);
 138     void *skipfncvalue;
 139     union {
 140         const char *name;
 141         byte fpr[MAX_FINGERPRINT_LEN];
 142         u32  kid[2];
 143     } u;
 144     int exact;
 145 };
 146
 147
 148 /* Helper type for preference fucntions. */
 149 union pref_hint
 150 {
 151   int digest_length;
 152 };
 153
 154
 155 /*-- keydb.c --*/
 156
 157 /*
 158   Flag 1 == force
 159   Flag 2 == default
 160 */
 161 int keydb_add_resource (const char *url, int flags, int secret);
 162 KEYDB_HANDLE keydb_new (int secret);
 163 void keydb_release (KEYDB_HANDLE hd);
 164 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
 165 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
 166 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
 167 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
 168 int keydb_delete_keyblock (KEYDB_HANDLE hd);
 169 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
 170 void keydb_rebuild_caches (int noisy);
 171 int keydb_search_reset (KEYDB_HANDLE hd);
 172 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
 173 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
 174                    size_t ndesc, size_t *descindex);
 175 int keydb_search_first (KEYDB_HANDLE hd);
 176 int keydb_search_next (KEYDB_HANDLE hd);
 177 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
 178 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
 179
 180
 181 /*-- pkclist.c --*/
 182 void show_revocation_reason( PKT_public_key *pk, int mode );
 183 int  check_signatures_trust( PKT_signature *sig );
 184
 185 void release_pk_list (PK_LIST pk_list);
 186 int  build_pk_list (strlist_t rcpts, PK_LIST *ret_pk_list, unsigned use);
 187 gpg_error_t find_and_check_key (const char *name, unsigned int use,
 188                                 int mark_hidden, pk_list_t *pk_list_addr);
 189
 190 int  algo_available( preftype_t preftype, int algo,
 191                      const union pref_hint *hint );
 192 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
 193                              int request, const union pref_hint *hint);
 194 int  select_mdc_from_pklist (PK_LIST pk_list);
 195 void warn_missing_mdc_from_pklist (PK_LIST pk_list);
 196 void warn_missing_aes_from_pklist (PK_LIST pk_list);
 197
 198 /*-- skclist.c --*/
 199 int  random_is_faked (void);
 200 void release_sk_list( SK_LIST sk_list );
 201 int  build_sk_list( strlist_t locusr, SK_LIST *ret_sk_list,
 202                                             int unlock, unsigned use );
 203
 204 /*-- passphrase.h --*/
 205 assuan_context_t agent_open (int try, const char *orig_codeset);
 206 void agent_close (assuan_context_t ctx);
 207 int  have_static_passphrase(void);
 208 void set_passphrase_from_string(const char *pass);
 209 void read_passphrase_from_fd( int fd );
 210 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
 211 DEK *passphrase_to_dek_ext(u32 *keyid, int pubkey_algo,
 212                            int cipher_algo, STRING2KEY *s2k, int mode,
 213                            const char *tryagain_text,
 214                            const char *custdesc, const char *custprompt,
 215                            int *canceled);
 216 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
 217                         int cipher_algo, STRING2KEY *s2k, int mode,
 218                         const char *tryagain_text, int *canceled);
 219 void set_next_passphrase( const char *s );
 220 char *get_last_passphrase(void);
 221 void next_to_last_passphrase(void);
 222
 223 /*-- getkey.c --*/
 224 int classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc);
 225 void cache_public_key( PKT_public_key *pk );
 226 void getkey_disable_caches(void);
 227 int get_pubkey( PKT_public_key *pk, u32 *keyid );
 228 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
 229 KBNODE get_pubkeyblock( u32 *keyid );
 230 int get_pubkey_byname (GETKEY_CTX *rx, PKT_public_key *pk,  const char *name,
 231                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
 232                        int include_unusable, int no_akl );
 233 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
 234                         strlist_t names, KBNODE *ret_keyblock );
 235 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
 236 void get_pubkey_end( GETKEY_CTX ctx );
 237 int get_seckey( PKT_secret_key *sk, u32 *keyid );
 238 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
 239 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
 240                                                  size_t fprint_len );
 241 int get_pubkey_byfprint_fast (PKT_public_key *pk,
 242                               const byte *fprint, size_t fprint_len);
 243 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
 244                                                  size_t fprint_len );
 245 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
 246 int seckey_available( u32 *keyid );
 247 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
 248 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
 249                         strlist_t names, KBNODE *ret_keyblock );
 250 int get_seckey_next (GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock);
 251 void get_seckey_end( GETKEY_CTX ctx );
 252
 253 int get_seckey_byfprint( PKT_secret_key *sk,
 254                          const byte *fprint, size_t fprint_len);
 255 int get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
 256                               size_t fprint_len );
 257
 258
 259 int enum_secret_keys( void **context, PKT_secret_key *sk,
 260                       int with_subkeys, int with_spm );
 261 void merge_keys_and_selfsig( KBNODE keyblock );
 262 char*get_user_id_string( u32 *keyid );
 263 char*get_user_id_string_native( u32 *keyid );
 264 char*get_long_user_id_string( u32 *keyid );
 265 char*get_user_id( u32 *keyid, size_t *rn );
 266 char*get_user_id_native( u32 *keyid );
 267 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
 268 void release_akl(void);
 269 int parse_auto_key_locate(char *options);
 270
 271 /*-- keyid.c --*/
 272 int pubkey_letter( int algo );
 273 u32 v3_keyid (gcry_mpi_t a, u32 *ki);
 274 void hash_public_key( gcry_md_hd_t md, PKT_public_key *pk );
 275 size_t keystrlen(void);
 276 const char *keystr(u32 *keyid);
 277 const char *keystr_from_pk(PKT_public_key *pk);
 278 const char *keystr_from_sk(PKT_secret_key *sk);
 279 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
 280 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
 281 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
 282 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
 283 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
 284 byte *namehash_from_uid(PKT_user_id *uid);
 285 unsigned nbits_from_pk( PKT_public_key *pk );
 286 unsigned nbits_from_sk( PKT_secret_key *sk );
 287 const char *datestr_from_pk( PKT_public_key *pk );
 288 const char *datestr_from_sk( PKT_secret_key *sk );
 289 const char *datestr_from_sig( PKT_signature *sig );
 290 const char *expirestr_from_pk( PKT_public_key *pk );
 291 const char *expirestr_from_sk( PKT_secret_key *sk );
 292 const char *expirestr_from_sig( PKT_signature *sig );
 293 const char *revokestr_from_pk( PKT_public_key *pk );
 294 const char *usagestr_from_pk( PKT_public_key *pk );
 295 const char *colon_strtime (u32 t);
 296 const char *colon_datestr_from_pk (PKT_public_key *pk);
 297 const char *colon_datestr_from_sk (PKT_secret_key *sk);
 298 const char *colon_datestr_from_sig (PKT_signature *sig);
 299 const char *colon_expirestr_from_sig (PKT_signature *sig);
 300 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
 301 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
 302 char *serialno_and_fpr_from_sk (const unsigned char *sn, size_t snlen,
 303                                 PKT_secret_key *sk);
 304
 305 /*-- kbnode.c --*/
 306 KBNODE new_kbnode( PACKET *pkt );
 307 KBNODE clone_kbnode( KBNODE node );
 308 void release_kbnode( KBNODE n );
 309 void delete_kbnode( KBNODE node );
 310 void add_kbnode( KBNODE root, KBNODE node );
 311 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
 312 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
 313 void remove_kbnode( KBNODE *root, KBNODE node );
 314 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
 315 KBNODE find_next_kbnode( KBNODE node, int pkttype );
 316 KBNODE find_kbnode( KBNODE node, int pkttype );
 317 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
 318 void clear_kbnode_flags( KBNODE n );
 319 int  commit_kbnode( KBNODE *root );
 320 void dump_kbnode( KBNODE node );
 321
 322 #endif /*G10_KEYDB_H*/