* getkey.c (get_user_id_native): Renamed to ..
[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 mark;
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;
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 };
144
145 /*-- keydb.c --*/
146 int keydb_add_resource (const char *url, int force, int secret);
147 KEYDB_HANDLE keydb_new (int secret);
148 void keydb_release (KEYDB_HANDLE hd);
149 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
150 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
151 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
152 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
153 int keydb_delete_keyblock (KEYDB_HANDLE hd);
154 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
155 void keydb_rebuild_caches (void);
156 int keydb_search_reset (KEYDB_HANDLE hd);
157 int keydb_search (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc, size_t ndesc);
158 int keydb_search_first (KEYDB_HANDLE hd);
159 int keydb_search_next (KEYDB_HANDLE hd);
160 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
161 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
162
163
164 /*-- pkclist.c --*/
165 void show_revocation_reason( PKT_public_key *pk, int mode );
166 int  check_signatures_trust( PKT_signature *sig );
167 void release_pk_list( PK_LIST pk_list );
168 int  build_pk_list( STRLIST rcpts, PK_LIST *ret_pk_list, unsigned use );
169 int select_algo_from_prefs( PK_LIST pk_list, int preftype,
170                             int request, void *hint );
171 int  select_mdc_from_pklist (PK_LIST pk_list);
172
173 /*-- skclist.c --*/
174 void release_sk_list( SK_LIST sk_list );
175 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
176                                             int unlock, unsigned use );
177
178 /*-- passphrase.h --*/
179 int  have_static_passphrase(void);
180 void read_passphrase_from_fd( int fd );
181 void passphrase_clear_cache ( u32 *keyid, int algo );
182 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
183                         int cipher_algo, STRING2KEY *s2k, int mode,
184                         const char *tryagain_text);
185 void set_next_passphrase( const char *s );
186 char *get_last_passphrase(void);
187
188 /*-- getkey.c --*/
189 int classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc);
190 void cache_public_key( PKT_public_key *pk );
191 void getkey_disable_caches(void);
192 int get_pubkey( PKT_public_key *pk, u32 *keyid );
193 KBNODE get_pubkeyblock( u32 *keyid );
194 int get_pubkey_byname( PKT_public_key *pk,  const char *name,
195                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd);
196 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
197                         STRLIST names, KBNODE *ret_keyblock );
198 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
199 void get_pubkey_end( GETKEY_CTX ctx );
200 int get_seckey( PKT_secret_key *sk, u32 *keyid );
201 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
202 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
203                                                  size_t fprint_len );
204 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
205                                                  size_t fprint_len );
206 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
207 int seckey_available( u32 *keyid );
208 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
209 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
210                         STRLIST names, KBNODE *ret_keyblock );
211 int get_seckey_byfprint( PKT_secret_key *sk,
212                          const byte *fprint, size_t fprint_len);
213 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
214 void get_seckey_end( GETKEY_CTX ctx );
215 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
216 void merge_keys_and_selfsig( KBNODE keyblock );
217 char*get_user_id_string( u32 *keyid );
218 char*get_user_id_string_printable( u32 *keyid );
219 char*get_long_user_id_string( u32 *keyid );
220 char*get_user_id( u32 *keyid, size_t *rn );
221 char*get_user_id_printable( u32 *keyid );
222 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
223
224 /*-- keyid.c --*/
225 int pubkey_letter( int algo );
226 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
227 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
228 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
229 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
230 unsigned nbits_from_pk( PKT_public_key *pk );
231 unsigned nbits_from_sk( PKT_secret_key *sk );
232 const char *datestr_from_pk( PKT_public_key *pk );
233 const char *datestr_from_sk( PKT_secret_key *sk );
234 const char *datestr_from_sig( PKT_signature *sig );
235 const char *expirestr_from_pk( PKT_public_key *pk );
236 const char *expirestr_from_sk( PKT_secret_key *sk );
237 const char *expirestr_from_sig( PKT_signature *sig );
238
239 const char *colon_strtime (u32 t);
240 const char *colon_datestr_from_pk (PKT_public_key *pk);
241 const char *colon_datestr_from_sk (PKT_secret_key *sk);
242 const char *colon_datestr_from_sig (PKT_signature *sig);
243 const char *colon_expirestr_from_sig (PKT_signature *sig);
244
245 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
246 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
247
248 /*-- kbnode.c --*/
249 KBNODE new_kbnode( PACKET *pkt );
250 KBNODE clone_kbnode( KBNODE node );
251 void release_kbnode( KBNODE n );
252 void delete_kbnode( KBNODE node );
253 void add_kbnode( KBNODE root, KBNODE node );
254 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
255 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
256 void remove_kbnode( KBNODE *root, KBNODE node );
257 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
258 KBNODE find_next_kbnode( KBNODE node, int pkttype );
259 KBNODE find_kbnode( KBNODE node, int pkttype );
260 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
261 void clear_kbnode_flags( KBNODE n );
262 int  commit_kbnode( KBNODE *root );
263 void dump_kbnode( KBNODE node );
264
265 #endif /*G10_KEYDB_H*/