last local commit
[gnupg.git] / g10 / keydb.h
index f3a42ca..efb371c 100644 (file)
@@ -1,14 +1,14 @@
 /* keydb.h - Key database
- *     Copyright (c) 1997 by Werner Koch (dd9jn)
+ *     Copyright (C) 1998 Free Software Foundation, Inc.
  *
- * This file is part of G10.
+ * This file is part of GNUPG.
  *
- * G10 is free software; you can redistribute it and/or modify
+ * GNUPG is free software; you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
  * the Free Software Foundation; either version 2 of the License, or
  * (at your option) any later version.
  *
- * G10 is distributed in the hope that it will be useful,
+ * GNUPG is distributed in the hope that it will be useful,
  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  * GNU General Public License for more details.
 #include "packet.h"
 #include "cipher.h"
 
+#define MAX_FINGERPRINT_LEN 20
 
 
 /****************
- * A Keyblock are all packets which form an entire certificate;
+ * A Keyblock is all packets which form an entire certificate;
  * i.e. the public key, certificate, trust packets, user ids,
  * signatures, and subkey.
  *
 
 typedef struct kbnode_struct *KBNODE;
 struct kbnode_struct {
+    KBNODE next;
     PACKET *pkt;
-    KBNODE next;   /* used to form a link list */
-    KBNODE child;
     int flag;
     int private_flag;
 };
 
 /****************
- * A data structre to hold informations about the external position
+ * A data structre to hold information about the external position
  * of a keyblock.
  */
 struct keyblock_pos_struct {
-    int   resno;  /* resource number */
-    ulong offset; /* position information */
-    ulong length; /* length of thge keyblock */
-    int last_block;
+    int   resno;     /* resource number */
+    ulong offset;    /* position information */
+    unsigned count;  /* length of the keyblock in packets */
+    IOBUF  fp;      /* used by enum_keyblocks */
+    int secret;      /* working on a secret keyring */
+    PACKET *pkt;     /* ditto */
 };
 typedef struct keyblock_pos_struct KBPOS;
 
 /* structure to hold a couple of public key certificates */
-typedef struct pkc_list *PKC_LIST;
-struct pkc_list {
-    PKC_LIST next;
-    PKT_public_cert *pkc;
+typedef struct pk_list *PK_LIST;
+struct pk_list {
+    PK_LIST next;
+    PKT_public_key *pk;
     int mark;
 };
 
 /* structure to hold a couple of secret key certificates */
-typedef struct skc_list *SKC_LIST;
-struct skc_list {
-    SKC_LIST next;
-    PKT_secret_cert *skc;
+typedef struct sk_list *SK_LIST;
+struct sk_list {
+    SK_LIST next;
+    PKT_secret_key *sk;
     int mark;
 };
 
+/* structure to collect all information which can be used to
+ * identify a public key */
+typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
+struct pubkey_find_info {
+    u32  keyid[2];
+    unsigned nbits;
+    byte pubkey_algo;
+    byte fingerprint[MAX_FINGERPRINT_LEN];
+    char userid[1];
+};
+
+
 
 /*-- pkclist.c --*/
-void release_pkc_list( PKC_LIST pkc_list );
-int  build_pkc_list( STRLIST remusr, PKC_LIST *ret_pkc_list );
+int  check_signatures_trust( PKT_signature *sig );
+void release_pk_list( PK_LIST pk_list );
+int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned usage );
+int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
 
 /*-- skclist.c --*/
-void release_skc_list( SKC_LIST skc_list );
-int  build_skc_list( STRLIST locusr, SKC_LIST *ret_skc_list, int unlock );
+void release_sk_list( SK_LIST sk_list );
+int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
+                                           int unlock, unsigned usage );
 
 /*-- passphrase.h --*/
-void set_passphrase_fd( int fd );
-int  get_passphrase_fd(void);
-DEK *get_passphrase_hash( u32 *keyid, char *text );
-int make_dek_from_passphrase( DEK *dek, int mode );
+int  have_static_passphrase(void);
+void read_passphrase_from_fd( int fd );
+DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
+void set_next_passphrase( const char *s );
+char *get_last_passphrase(void);
 
 /*-- getkey.c --*/
-void add_keyring( const char *name );
-const char *get_keyring( int sequence );
-void add_secret_keyring( const char *name );
-void cache_public_cert( PKT_public_cert *pkc );
-void cache_user_id( PKT_user_id *uid, u32 *keyid );
-int get_pubkey( PKT_public_cert *pkc, u32 *keyid );
-int get_pubkey_byname( PKT_public_cert *pkc, const char *name );
-int get_seckey( PKT_secret_cert *skc, u32 *keyid );
-int get_seckey_byname( PKT_secret_cert *skc, const char *name, int unlock );
+int get_pubkey( PKT_public_key *pk, u32 *keyid );
+int get_pubkey_byname( PKT_public_key *pk, const char *name );
+int get_seckey( PKT_secret_key *sk, u32 *keyid );
+int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
+                                                size_t fprint_len );
+int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
+                                                size_t fprint_len );
+int seckey_available( u32 *keyid );
+int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
+int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
+void merge_keys_and_selfsig( KBNODE keyblock );
 char*get_user_id_string( u32 *keyid );
 char*get_user_id( u32 *keyid, size_t *rn );
 
 /*-- keyid.c --*/
 int pubkey_letter( int algo );
-u32 keyid_from_skc( PKT_secret_cert *skc, u32 *keyid );
-u32 keyid_from_pkc( PKT_public_cert *pkc, u32 *keyid );
+u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
+u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
-unsigned nbits_from_pkc( PKT_public_cert *pkc );
-unsigned nbits_from_skc( PKT_secret_cert *skc );
-const char *datestr_from_pkc( PKT_public_cert *pkc );
-const char *datestr_from_skc( PKT_secret_cert *skc );
+u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
+unsigned nbits_from_pk( PKT_public_key *pk );
+unsigned nbits_from_sk( PKT_secret_key *sk );
+const char *datestr_from_pk( PKT_public_key *pk );
+const char *datestr_from_sk( PKT_secret_key *sk );
 const char *datestr_from_sig( PKT_signature *sig );
-byte *fingerprint_from_skc( PKT_secret_cert *skc, size_t *ret_len );
-byte *fingerprint_from_pkc( PKT_public_cert *pkc, size_t *ret_len );
+const char *expirestr_from_pk( PKT_public_key *pk );
+const char *expirestr_from_sk( PKT_secret_key *sk );
+byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
+byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
 
 /*-- kbnode.c --*/
 KBNODE new_kbnode( PACKET *pkt );
+KBNODE clone_kbnode( KBNODE node );
 void release_kbnode( KBNODE n );
-void delete_kbnode( KBNODE root, KBNODE node );
+void delete_kbnode( KBNODE node );
 void add_kbnode( KBNODE root, KBNODE node );
-void add_kbnode_as_child( KBNODE root, KBNODE node );
-KBNODE find_kbparent( KBNODE root, KBNODE node );
-KBNODE walk_kbtree( KBNODE root, KBNODE *context );
-KBNODE walk_kbtree2( KBNODE root, KBNODE *context, int all );
+void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
+KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
+KBNODE find_next_kbnode( KBNODE node, int pkttype );
+KBNODE find_kbnode( KBNODE node, int pkttype );
+KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
 void clear_kbnode_flags( KBNODE n );
+int  commit_kbnode( KBNODE *root );
+void dump_kbnode( KBNODE node );
 
 /*-- ringedit.c --*/
-int add_keyblock_resource( const char *filename, int force );
-int get_keyblock_handle( const char *filename, KBPOS *kbpos );
-int search_keyblock( PACKET *pkt, KBPOS *kbpos );
-int search_keyblock_byname( KBPOS *kbpos, const char *username );
+const char *enum_keyblock_resources( int *sequence, int secret );
+int add_keyblock_resource( const char *resname, int force, int secret );
+const char *keyblock_resource_name( KBPOS *kbpos );
+int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
+int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
+int find_keyblock_byname( KBPOS *kbpos, const char *username );
+int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
+int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
 int lock_keyblock( KBPOS *kbpos );
 void unlock_keyblock( KBPOS *kbpos );
 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
+int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
 int insert_keyblock( KBPOS *kbpos, KBNODE root );
 int delete_keyblock( KBPOS *kbpos );
 int update_keyblock( KBPOS *kbpos, KBNODE root );