b01a4f0ddef6af05109382a2edc9b8bf068b3140
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  * Copyright (C) 1998, 1999, 2000, 2001 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 G10_KEYDB_H
22 #define G10_KEYDB_H
23
24 #include "types.h"
25 #include "global.h"
26 #include "packet.h"
27 #include "cipher.h"
28
29 /* What qualifies as a certification (rather than a signature?) */
30 #define IS_SIG(s) (((s)->sig_class==0x00) || ((s)->sig_class==0x01) || \
31                    ((s)->sig_class==0x02) || ((s)->sig_class==0x40))
32 #define IS_CERT(s) (!IS_SIG(s))
33
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
42 struct getkey_ctx_s;
43 typedef struct getkey_ctx_s *GETKEY_CTX;
44
45 /****************
46  * A Keyblock is all packets which form an entire certificate;
47  * i.e. the public key, certificate, trust packets, user ids,
48  * signatures, and subkey.
49  *
50  * This structure is also used to bind arbitrary packets together.
51  */
52
53 struct kbnode_struct {
54     KBNODE next;
55     PACKET *pkt;
56     int flag;
57     int private_flag;
58     ulong recno;  /* used while updating the trustdb */
59 };
60
61 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
62 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
63
64
65 enum resource_type {
66     rt_UNKNOWN = 0,
67     rt_RING = 1
68 };
69
70
71 /****************
72  * A data structre to hold information about the external position
73  * of a keyblock.
74  */
75 struct keyblock_pos_struct {
76     int   resno;     /* resource number */
77     enum resource_type rt;
78     off_t offset;    /* position information */
79     unsigned count;  /* length of the keyblock in packets */
80     IOBUF  fp;       /* used by enum_keyblocks */
81     int secret;      /* working on a secret keyring */
82     PACKET *pkt;     /* ditto */
83     int valid;
84 };
85 typedef struct keyblock_pos_struct KBPOS;
86
87 /* structure to hold a couple of public key certificates */
88 typedef struct pk_list *PK_LIST;
89 struct pk_list {
90     PK_LIST next;
91     PKT_public_key *pk;
92     int flags; /* flag bit 1==throw_keyid */
93 };
94
95 /* structure to hold a couple of secret key certificates */
96 typedef struct sk_list *SK_LIST;
97 struct sk_list {
98     SK_LIST next;
99     PKT_secret_key *sk;
100     int mark; /* not used */
101 };
102
103 /* structure to collect all information which can be used to
104  * identify a public key */
105 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
106 struct pubkey_find_info {
107     u32  keyid[2];
108     unsigned nbits;
109     byte pubkey_algo;
110     byte fingerprint[MAX_FINGERPRINT_LEN];
111     char userid[1];
112 };
113
114
115 typedef struct keydb_handle *KEYDB_HANDLE;
116
117 typedef enum {
118     KEYDB_SEARCH_MODE_NONE,
119     KEYDB_SEARCH_MODE_EXACT,
120     KEYDB_SEARCH_MODE_SUBSTR,
121     KEYDB_SEARCH_MODE_MAIL,
122     KEYDB_SEARCH_MODE_MAILSUB,
123     KEYDB_SEARCH_MODE_MAILEND,
124     KEYDB_SEARCH_MODE_WORDS,
125     KEYDB_SEARCH_MODE_SHORT_KID,
126     KEYDB_SEARCH_MODE_LONG_KID,
127     KEYDB_SEARCH_MODE_FPR16,
128     KEYDB_SEARCH_MODE_FPR20,
129     KEYDB_SEARCH_MODE_FPR,
130     KEYDB_SEARCH_MODE_FIRST,
131     KEYDB_SEARCH_MODE_NEXT
132 } KeydbSearchMode;
133
134 struct keydb_search_desc {
135     KeydbSearchMode mode;
136     int (*skipfnc)(void *,u32*);
137     void *skipfncvalue;
138     union {
139         const char *name;
140         char fpr[MAX_FINGERPRINT_LEN];
141         u32  kid[2];
142     } u;
143     int exact;
144 };
145
146 /*-- keydb.c --*/
147
148 /*
149   Flag 1 == force
150   Flag 2 == default
151 */
152 int keydb_add_resource (const char *url, int flags, int secret);
153 KEYDB_HANDLE keydb_new (int secret);
154 void keydb_release (KEYDB_HANDLE hd);
155 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
156 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
157 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
158 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
159 int keydb_delete_keyblock (KEYDB_HANDLE hd);
160 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
161 void keydb_rebuild_caches (void);
162 int keydb_search_reset (KEYDB_HANDLE hd);
163 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
164 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
165                    size_t ndesc, size_t *descindex);
166 int keydb_search_first (KEYDB_HANDLE hd);
167 int keydb_search_next (KEYDB_HANDLE hd);
168 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
169 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
170
171
172 /*-- pkclist.c --*/
173 void show_revocation_reason( PKT_public_key *pk, int mode );
174 int  check_signatures_trust( PKT_signature *sig );
175 void release_pk_list( PK_LIST pk_list );
176 int  build_pk_list( STRLIST rcpts, PK_LIST *ret_pk_list, unsigned use );
177 int select_algo_from_prefs( PK_LIST pk_list, int preftype,
178                             int request, void *hint );
179 int  select_mdc_from_pklist (PK_LIST pk_list);
180
181 /*-- skclist.c --*/
182 void release_sk_list( SK_LIST sk_list );
183 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
184                                             int unlock, unsigned use );
185
186 /*-- passphrase.h --*/
187 int  have_static_passphrase(void);
188 void read_passphrase_from_fd( int fd );
189 void passphrase_clear_cache ( u32 *keyid, int algo );
190 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
191                         int cipher_algo, STRING2KEY *s2k, int mode,
192                         const char *tryagain_text);
193 void set_next_passphrase( const char *s );
194 char *get_last_passphrase(void);
195
196 /*-- getkey.c --*/
197 int classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc);
198 void cache_public_key( PKT_public_key *pk );
199 void getkey_disable_caches(void);
200 int get_pubkey( PKT_public_key *pk, u32 *keyid );
201 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
202 KBNODE get_pubkeyblock( u32 *keyid );
203 int get_pubkey_byname( PKT_public_key *pk,  const char *name,
204                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
205                        int include_disabled );
206 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
207                         STRLIST names, KBNODE *ret_keyblock );
208 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
209 void get_pubkey_end( GETKEY_CTX ctx );
210 int get_seckey( PKT_secret_key *sk, u32 *keyid );
211 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
212 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
213                                                  size_t fprint_len );
214 int get_pubkey_byfprint_fast (PKT_public_key *pk,
215                               const byte *fprint, size_t fprint_len);
216 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
217                                                  size_t fprint_len );
218 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
219 int seckey_available( u32 *keyid );
220 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
221 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
222                         STRLIST names, KBNODE *ret_keyblock );
223 int get_seckey_byfprint( PKT_secret_key *sk,
224                          const byte *fprint, size_t fprint_len);
225 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
226 void get_seckey_end( GETKEY_CTX ctx );
227 int enum_secret_keys( void **context, PKT_secret_key *sk,
228                       int with_subkeys, int with_spm );
229 void merge_keys_and_selfsig( KBNODE keyblock );
230 char*get_user_id_string( u32 *keyid );
231 char*get_user_id_string_printable( u32 *keyid );
232 char*get_long_user_id_string( u32 *keyid );
233 char*get_user_id( u32 *keyid, size_t *rn );
234 char*get_user_id_printable( u32 *keyid );
235 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
236
237 /*-- keyid.c --*/
238 int pubkey_letter( int algo );
239 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
240 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
241 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
242 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
243 byte *namehash_from_uid(PKT_user_id *uid);
244 unsigned nbits_from_pk( PKT_public_key *pk );
245 unsigned nbits_from_sk( PKT_secret_key *sk );
246 const char *datestr_from_pk( PKT_public_key *pk );
247 const char *datestr_from_sk( PKT_secret_key *sk );
248 const char *datestr_from_sig( PKT_signature *sig );
249 const char *expirestr_from_pk( PKT_public_key *pk );
250 const char *expirestr_from_sk( PKT_secret_key *sk );
251 const char *expirestr_from_sig( PKT_signature *sig );
252
253 const char *colon_strtime (u32 t);
254 const char *colon_datestr_from_pk (PKT_public_key *pk);
255 const char *colon_datestr_from_sk (PKT_secret_key *sk);
256 const char *colon_datestr_from_sig (PKT_signature *sig);
257 const char *colon_expirestr_from_sig (PKT_signature *sig);
258
259 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
260 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
261
262 /*-- kbnode.c --*/
263 KBNODE new_kbnode( PACKET *pkt );
264 KBNODE clone_kbnode( KBNODE node );
265 void release_kbnode( KBNODE n );
266 void delete_kbnode( KBNODE node );
267 void add_kbnode( KBNODE root, KBNODE node );
268 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
269 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
270 void remove_kbnode( KBNODE *root, KBNODE node );
271 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
272 KBNODE find_next_kbnode( KBNODE node, int pkttype );
273 KBNODE find_kbnode( KBNODE node, int pkttype );
274 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
275 void clear_kbnode_flags( KBNODE n );
276 int  commit_kbnode( KBNODE *root );
277 void dump_kbnode( KBNODE node );
278
279 #endif /*G10_KEYDB_H*/