added some stuff for signing keys
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 is free software; you can redistribute it and/or modify
7  * it under the terms of the GNU General Public License as published by
8  * the Free Software Foundation; either version 2 of the License, or
9  * (at your option) any later version.
10  *
11  * G10 is distributed in the hope that it will be useful,
12  * but WITHOUT ANY WARRANTY; without even the implied warranty of
13  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14  * GNU General Public License for more details.
15  *
16  * You should have received a copy of the GNU General Public License
17  * along with this program; if not, write to the Free Software
18  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
19  */
20
21 #ifndef G10_KEYDB_H
22 #define G10_KEYDB_H
23
24 #include "types.h"
25 #include "packet.h"
26 #include "cipher.h"
27
28
29
30 /****************
31  * A Keyblock are all packets which form an entire certificate;
32  * i.e. the public key, certificate, trust packets, user ids,
33  * signatures, and subkey.
34  *
35  * This structure is also used to bind arbitrary packets together.
36  */
37
38 typedef struct kbnode_struct *KBNODE;
39 struct kbnode_struct {
40     PACKET *pkt;
41     KBNODE next;   /* used to form a link list */
42     KBNODE child;
43 };
44
45 /****************
46  * A data structre to hold informations about the external position
47  * of a keyblock.
48  */
49 struct keyblock_pos_struct {
50     int   resno;  /* resource number */
51     ulong offset; /* position information */
52     ulong length; /* length of thge keyblock */
53     int last_block;
54 };
55 typedef struct keyblock_pos_struct KBPOS;
56
57
58
59 /*-- passphrase.h --*/
60 DEK *get_passphrase_hash( u32 *keyid, char *text );
61 int make_dek_from_passphrase( DEK *dek, int mode );
62
63 /*-- getkey.c --*/
64 void add_keyring( const char *name );
65 void add_secret_keyring( const char *name );
66 void cache_public_cert( PKT_public_cert *pkc );
67 void cache_user_id( PKT_user_id *uid, u32 *keyid );
68 int get_pubkey( PKT_public_cert *pkc, u32 *keyid );
69 int get_pubkey_byname( PKT_public_cert *pkc, const char *name );
70 int get_seckey( PKT_secret_cert *skc, u32 *keyid );
71 int get_seckey_byname( PKT_secret_cert *skc, const char *name, int unlock );
72 char*get_user_id_string( u32 *keyid );
73 char*get_user_id( u32 *keyid, size_t *rn );
74
75 /*-- keyid.c --*/
76 int pubkey_letter( int algo );
77 u32 keyid_from_skc( PKT_secret_cert *skc, u32 *keyid );
78 u32 keyid_from_pkc( PKT_public_cert *pkc, u32 *keyid );
79 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
80 unsigned nbits_from_pkc( PKT_public_cert *pkc );
81 unsigned nbits_from_skc( PKT_secret_cert *skc );
82 const char *datestr_from_pkc( PKT_public_cert *pkc );
83 const char *datestr_from_skc( PKT_secret_cert *skc );
84 const char *datestr_from_sig( PKT_signature *sig );
85 byte *fingerprint_from_skc( PKT_secret_cert *skc, size_t *ret_len );
86 byte *fingerprint_from_pkc( PKT_public_cert *pkc, size_t *ret_len );
87
88 /*-- kbnode.c --*/
89 KBNODE new_kbnode( PACKET *pkt );
90 void release_kbnode( KBNODE n );
91 void add_kbnode( KBNODE root, KBNODE node );
92 void add_kbnode_as_child( KBNODE root, KBNODE node );
93 KBNODE find_kbparent( KBNODE root, KBNODE node );
94 KBNODE walk_kbtree( KBNODE root, KBNODE *context );
95
96 /*-- ringedit.c --*/
97 int add_keyblock_resource( const char *filename, int force );
98 int get_keyblock_handle( const char *filename, KBPOS *kbpos );
99 int search_keyblock( PACKET *pkt, KBPOS *kbpos );
100 int search_keyblock_byname( KBPOS *kbpos, const char *username );
101 int lock_keyblock( KBPOS *kbpos );
102 void unlock_keyblock( KBPOS *kbpos );
103 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
104 int insert_keyblock( KBPOS *kbpos, KBNODE root );
105 int delete_keyblock( KBPOS *kbpos );
106 int update_keyblock( KBPOS *kbpos, KBNODE root );
107
108
109 #endif /*G10_KEYDB_H*/