f3a42caba5f9d87128e60799e830cb23dd0d57bd
[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     int flag;
44     int private_flag;
45 };
46
47 /****************
48  * A data structre to hold informations about the external position
49  * of a keyblock.
50  */
51 struct keyblock_pos_struct {
52     int   resno;  /* resource number */
53     ulong offset; /* position information */
54     ulong length; /* length of thge keyblock */
55     int last_block;
56 };
57 typedef struct keyblock_pos_struct KBPOS;
58
59 /* structure to hold a couple of public key certificates */
60 typedef struct pkc_list *PKC_LIST;
61 struct pkc_list {
62     PKC_LIST next;
63     PKT_public_cert *pkc;
64     int mark;
65 };
66
67 /* structure to hold a couple of secret key certificates */
68 typedef struct skc_list *SKC_LIST;
69 struct skc_list {
70     SKC_LIST next;
71     PKT_secret_cert *skc;
72     int mark;
73 };
74
75
76 /*-- pkclist.c --*/
77 void release_pkc_list( PKC_LIST pkc_list );
78 int  build_pkc_list( STRLIST remusr, PKC_LIST *ret_pkc_list );
79
80 /*-- skclist.c --*/
81 void release_skc_list( SKC_LIST skc_list );
82 int  build_skc_list( STRLIST locusr, SKC_LIST *ret_skc_list, int unlock );
83
84 /*-- passphrase.h --*/
85 void set_passphrase_fd( int fd );
86 int  get_passphrase_fd(void);
87 DEK *get_passphrase_hash( u32 *keyid, char *text );
88 int make_dek_from_passphrase( DEK *dek, int mode );
89
90 /*-- getkey.c --*/
91 void add_keyring( const char *name );
92 const char *get_keyring( int sequence );
93 void add_secret_keyring( const char *name );
94 void cache_public_cert( PKT_public_cert *pkc );
95 void cache_user_id( PKT_user_id *uid, u32 *keyid );
96 int get_pubkey( PKT_public_cert *pkc, u32 *keyid );
97 int get_pubkey_byname( PKT_public_cert *pkc, const char *name );
98 int get_seckey( PKT_secret_cert *skc, u32 *keyid );
99 int get_seckey_byname( PKT_secret_cert *skc, const char *name, int unlock );
100 char*get_user_id_string( u32 *keyid );
101 char*get_user_id( u32 *keyid, size_t *rn );
102
103 /*-- keyid.c --*/
104 int pubkey_letter( int algo );
105 u32 keyid_from_skc( PKT_secret_cert *skc, u32 *keyid );
106 u32 keyid_from_pkc( PKT_public_cert *pkc, u32 *keyid );
107 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
108 unsigned nbits_from_pkc( PKT_public_cert *pkc );
109 unsigned nbits_from_skc( PKT_secret_cert *skc );
110 const char *datestr_from_pkc( PKT_public_cert *pkc );
111 const char *datestr_from_skc( PKT_secret_cert *skc );
112 const char *datestr_from_sig( PKT_signature *sig );
113 byte *fingerprint_from_skc( PKT_secret_cert *skc, size_t *ret_len );
114 byte *fingerprint_from_pkc( PKT_public_cert *pkc, size_t *ret_len );
115
116 /*-- kbnode.c --*/
117 KBNODE new_kbnode( PACKET *pkt );
118 void release_kbnode( KBNODE n );
119 void delete_kbnode( KBNODE root, KBNODE node );
120 void add_kbnode( KBNODE root, KBNODE node );
121 void add_kbnode_as_child( KBNODE root, KBNODE node );
122 KBNODE find_kbparent( KBNODE root, KBNODE node );
123 KBNODE walk_kbtree( KBNODE root, KBNODE *context );
124 KBNODE walk_kbtree2( KBNODE root, KBNODE *context, int all );
125 void clear_kbnode_flags( KBNODE n );
126
127 /*-- ringedit.c --*/
128 int add_keyblock_resource( const char *filename, int force );
129 int get_keyblock_handle( const char *filename, KBPOS *kbpos );
130 int search_keyblock( PACKET *pkt, KBPOS *kbpos );
131 int search_keyblock_byname( KBPOS *kbpos, const char *username );
132 int lock_keyblock( KBPOS *kbpos );
133 void unlock_keyblock( KBPOS *kbpos );
134 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
135 int insert_keyblock( KBPOS *kbpos, KBNODE root );
136 int delete_keyblock( KBPOS *kbpos );
137 int update_keyblock( KBPOS *kbpos, KBNODE root );
138
139
140 #endif /*G10_KEYDB_H*/