See ChangeLog: Fri Jul 14 19:38:23 CEST 2000 Werner Koch
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  *      Copyright (C) 1998, 1999, 2000 Free Software Foundation, Inc.
3  *
4  * This file is part of GnuPG.
5  *
6  * GnuPG 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  * GnuPG 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 GPG_KEYDB_H
22 #define GPG_KEYDB_H
23
24 #ifdef HAVE_LIBGDBM
25   #include <gdbm.h>
26 #endif
27
28 #include "types.h"
29 #include "basicdefs.h"
30 #include "packet.h"
31
32 #define MAX_FINGERPRINT_LEN 20
33
34 struct getkey_ctx_s;
35 typedef struct getkey_ctx_s *GETKEY_CTX;
36
37 /****************
38  * A Keyblock is all packets which form an entire certificate;
39  * i.e. the public key, certificate, trust packets, user ids,
40  * signatures, and subkey.
41  *
42  * This structure is also used to bind arbitrary packets together.
43  */
44
45 typedef struct kbnode_struct *KBNODE;
46 struct kbnode_struct {
47     KBNODE next;
48     PACKET *pkt;
49     int flag;
50     int private_flag;
51     ulong recno;  /* used while updating the trustdb */
52 };
53
54 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
55 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
56
57
58 enum resource_type {
59     rt_UNKNOWN = 0,
60     rt_RING = 1,
61     rt_GDBM = 2,
62     rt_KBXF = 3
63 };
64
65
66 /****************
67  * A data structre to hold information about the external position
68  * of a keyblock.
69  */
70 struct keyblock_pos_struct {
71     int   resno;     /* resource number */
72     enum resource_type rt;
73     ulong offset;    /* position information */
74     unsigned count;  /* length of the keyblock in packets */
75     IOBUF  fp;       /* used by enum_keyblocks */
76     int secret;      /* working on a secret keyring */
77   #ifdef HAVE_LIBGDBM
78     GDBM_FILE dbf;
79     byte keybuf[21];
80   #endif
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 struct pk_list {
88     PK_LIST next;
89     PKT_public_key *pk;
90     int mark;
91 };
92
93 /* structure to hold a couple of secret key certificates */
94 struct sk_list {
95     SK_LIST next;
96     PKT_secret_key *sk;
97     int mark;
98 };
99
100 /* structure to collect all information which can be used to
101  * identify a public key */
102 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
103 struct pubkey_find_info {
104     u32  keyid[2];
105     unsigned nbits;
106     byte pubkey_algo;
107     byte fingerprint[MAX_FINGERPRINT_LEN];
108     char userid[1];
109 };
110
111
112
113 /*-- pkclist.c --*/
114 int  check_signatures_trust( PKT_signature *sig );
115 void release_pk_list( PK_LIST pk_list );
116 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned use );
117 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
118
119 /*-- skclist.c --*/
120 void release_sk_list( SK_LIST sk_list );
121 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
122                                             int unlock, unsigned use );
123
124 /*-- passphrase.h --*/
125 int  have_static_passphrase(void);
126 void read_passphrase_from_fd( int fd );
127 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
128                         int cipher_algo, STRING2KEY *s2k, int mode);
129 void set_next_passphrase( const char *s );
130 char *get_last_passphrase(void);
131
132 /*-- getkey.c --*/
133 int classify_user_id( const char *name, u32 *keyid, byte *fprint,
134                       const char **retstr, size_t *retlen );
135 void getkey_disable_caches(void);
136 int get_pubkey( PKT_public_key *pk, u32 *keyid );
137 KBNODE get_pubkeyblock( u32 *keyid );
138 int get_pubkey_byname( GETKEY_CTX *rx, PKT_public_key *pk,
139                        const char *name, KBNODE *ret_keyblock );
140 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
141                         STRLIST names, KBNODE *ret_keyblock );
142 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
143 void get_pubkey_end( GETKEY_CTX ctx );
144 int get_seckey( PKT_secret_key *sk, u32 *keyid );
145 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
146 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
147                                                  size_t fprint_len );
148 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
149                                                  size_t fprint_len );
150 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
151 int seckey_available( u32 *keyid );
152 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
153 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
154                         STRLIST names, KBNODE *ret_keyblock );
155 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
156 void get_seckey_end( GETKEY_CTX ctx );
157 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
158 void merge_keys_and_selfsig( KBNODE keyblock );
159 char*get_user_id_string( u32 *keyid );
160 char*get_user_id_string_native( u32 *keyid );
161 char*get_long_user_id_string( u32 *keyid );
162 char*get_user_id( u32 *keyid, size_t *rn );
163
164 /*-- keyid.c --*/
165 int pubkey_letter( int algo );
166 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
167 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
168 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
169 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
170 unsigned nbits_from_pk( PKT_public_key *pk );
171 unsigned nbits_from_sk( PKT_secret_key *sk );
172 const char *datestr_from_pk( PKT_public_key *pk );
173 const char *datestr_from_sk( PKT_secret_key *sk );
174 const char *datestr_from_sig( PKT_signature *sig );
175 const char *expirestr_from_pk( PKT_public_key *pk );
176 const char *expirestr_from_sk( PKT_secret_key *sk );
177 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
178 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
179
180 /*-- kbnode.c --*/
181 KBNODE new_kbnode( PACKET *pkt );
182 KBNODE clone_kbnode( KBNODE node );
183 void release_kbnode( KBNODE n );
184 void delete_kbnode( KBNODE node );
185 void add_kbnode( KBNODE root, KBNODE node );
186 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
187 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
188 void remove_kbnode( KBNODE *root, KBNODE node );
189 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
190 KBNODE find_next_kbnode( KBNODE node, int pkttype );
191 KBNODE find_kbnode( KBNODE node, int pkttype );
192 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
193 void clear_kbnode_flags( KBNODE n );
194 int  commit_kbnode( KBNODE *root );
195 void dump_kbnode( KBNODE node );
196
197 /*-- ringedit.c --*/
198 const char *enum_keyblock_resources( int *sequence, int secret );
199 int add_keyblock_resource( const char *resname, int force, int secret );
200 const char *keyblock_resource_name( KBPOS *kbpos );
201 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
202 char *get_writable_keyblock_file( int secret );
203 int locate_keyblock_by_fpr( KBPOS *kbpos, const byte *fpr,
204                                             int fprlen, int secret );
205 int locate_keyblock_by_keyid( KBPOS *kbpos, u32 *keyid,
206                                             int shortkid, int secret );
207 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
208 int find_keyblock_byname( KBPOS *kbpos, const char *username );
209 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
210 int find_keyblock_bysk( KBPOS *kbpos, PKT_secret_key *sk );
211 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
212 int lock_keyblock( KBPOS *kbpos );
213 void unlock_keyblock( KBPOS *kbpos );
214 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
215 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
216 int insert_keyblock( KBPOS *kbpos, KBNODE root );
217 int delete_keyblock( KBPOS *kbpos );
218 int update_keyblock( KBPOS *kbpos, KBNODE root );
219
220
221 #endif /*GPG_KEYDB_H*/