(add_notation_data): Check number of at-signs.
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  * Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003,
3  *               2004 Free Software Foundation, Inc.
4  *
5  * This file is part of GnuPG.
6  *
7  * GnuPG is free software; you can redistribute it and/or modify
8  * it under the terms of the GNU General Public License as published by
9  * the Free Software Foundation; either version 2 of the License, or
10  * (at your option) any later version.
11  *
12  * GnuPG is distributed in the hope that it will be useful,
13  * but WITHOUT ANY WARRANTY; without even the implied warranty of
14  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
15  * GNU General Public License for more details.
16  *
17  * You should have received a copy of the GNU General Public License
18  * along with this program; if not, write to the Free Software
19  * Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA
20  */
21
22 #ifndef G10_KEYDB_H
23 #define G10_KEYDB_H
24
25 #include "types.h"
26 #include "global.h"
27 #include "packet.h"
28 #include "cipher.h"
29 #ifdef ENABLE_AGENT_SUPPORT
30 #include "assuan.h"
31 #endif
32
33 /* What qualifies as a certification (rather than a signature?) */
34 #define IS_CERT(s)       (IS_KEY_SIG(s) || IS_UID_SIG(s) || IS_SUBKEY_SIG(s) \
35                          || IS_KEY_REV(s) || IS_UID_REV(s) || IS_SUBKEY_REV(s))
36 #define IS_SIG(s)        (!IS_CERT(s))
37 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
38 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
39 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
40 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
41 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
42 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
43
44 struct getkey_ctx_s;
45 typedef struct getkey_ctx_s *GETKEY_CTX;
46
47 /****************
48  * A Keyblock is all packets which form an entire certificate;
49  * i.e. the public key, certificate, trust packets, user ids,
50  * signatures, and subkey.
51  *
52  * This structure is also used to bind arbitrary packets together.
53  */
54
55 struct kbnode_struct {
56     KBNODE next;
57     PACKET *pkt;
58     int flag;
59     int private_flag;
60     ulong recno;  /* used while updating the trustdb */
61 };
62
63 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
64 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
65
66
67 enum resource_type {
68     rt_UNKNOWN = 0,
69     rt_RING = 1
70 };
71
72
73 /****************
74  * A data structre to hold information about the external position
75  * of a keyblock.
76  */
77 struct keyblock_pos_struct {
78     int   resno;     /* resource number */
79     enum resource_type rt;
80     off_t offset;    /* position information */
81     unsigned count;  /* length of the keyblock in packets */
82     IOBUF  fp;       /* used by enum_keyblocks */
83     int secret;      /* working on a secret keyring */
84     PACKET *pkt;     /* ditto */
85     int valid;
86 };
87 typedef struct keyblock_pos_struct KBPOS;
88
89 /* structure to hold a couple of public key certificates */
90 typedef struct pk_list *PK_LIST;
91 struct pk_list {
92     PK_LIST next;
93     PKT_public_key *pk;
94     int flags; /* flag bit 1==throw_keyid */
95 };
96
97 /* structure to hold a couple of secret key certificates */
98 typedef struct sk_list *SK_LIST;
99 struct sk_list {
100     SK_LIST next;
101     PKT_secret_key *sk;
102     int mark; /* not used */
103 };
104
105 /* structure to collect all information which can be used to
106  * identify a public key */
107 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
108 struct pubkey_find_info {
109     u32  keyid[2];
110     unsigned nbits;
111     byte pubkey_algo;
112     byte fingerprint[MAX_FINGERPRINT_LEN];
113     char userid[1];
114 };
115
116
117 typedef struct keydb_handle *KEYDB_HANDLE;
118
119 typedef enum {
120     KEYDB_SEARCH_MODE_NONE,
121     KEYDB_SEARCH_MODE_EXACT,
122     KEYDB_SEARCH_MODE_SUBSTR,
123     KEYDB_SEARCH_MODE_MAIL,
124     KEYDB_SEARCH_MODE_MAILSUB,
125     KEYDB_SEARCH_MODE_MAILEND,
126     KEYDB_SEARCH_MODE_WORDS,
127     KEYDB_SEARCH_MODE_SHORT_KID,
128     KEYDB_SEARCH_MODE_LONG_KID,
129     KEYDB_SEARCH_MODE_FPR16,
130     KEYDB_SEARCH_MODE_FPR20,
131     KEYDB_SEARCH_MODE_FPR,
132     KEYDB_SEARCH_MODE_FIRST,
133     KEYDB_SEARCH_MODE_NEXT
134 } KeydbSearchMode;
135
136 struct keydb_search_desc {
137     KeydbSearchMode mode;
138     int (*skipfnc)(void *,u32*,PKT_user_id*);
139     void *skipfncvalue;
140     union {
141         const char *name;
142         byte fpr[MAX_FINGERPRINT_LEN];
143         u32  kid[2];
144     } u;
145     int exact;
146 };
147
148 /*-- keydb.c --*/
149
150 /*
151   Flag 1 == force
152   Flag 2 == default
153 */
154 int keydb_add_resource (const char *url, int flags, int secret);
155 KEYDB_HANDLE keydb_new (int secret);
156 void keydb_release (KEYDB_HANDLE hd);
157 const char *keydb_get_resource_name (KEYDB_HANDLE hd);
158 int keydb_get_keyblock (KEYDB_HANDLE hd, KBNODE *ret_kb);
159 int keydb_update_keyblock (KEYDB_HANDLE hd, KBNODE kb);
160 int keydb_insert_keyblock (KEYDB_HANDLE hd, KBNODE kb);
161 int keydb_delete_keyblock (KEYDB_HANDLE hd);
162 int keydb_locate_writable (KEYDB_HANDLE hd, const char *reserved);
163 void keydb_rebuild_caches (int noisy);
164 int keydb_search_reset (KEYDB_HANDLE hd);
165 #define keydb_search(a,b,c) keydb_search2((a),(b),(c),NULL)
166 int keydb_search2 (KEYDB_HANDLE hd, KEYDB_SEARCH_DESC *desc,
167                    size_t ndesc, size_t *descindex);
168 int keydb_search_first (KEYDB_HANDLE hd);
169 int keydb_search_next (KEYDB_HANDLE hd);
170 int keydb_search_kid (KEYDB_HANDLE hd, u32 *kid);
171 int keydb_search_fpr (KEYDB_HANDLE hd, const byte *fpr);
172
173
174 /*-- pkclist.c --*/
175 void show_revocation_reason( PKT_public_key *pk, int mode );
176 int  check_signatures_trust( PKT_signature *sig );
177 void release_pk_list( PK_LIST pk_list );
178 int  build_pk_list( STRLIST rcpts, PK_LIST *ret_pk_list, unsigned use );
179 int  algo_available( preftype_t preftype, int algo, void *hint );
180 int  select_algo_from_prefs( PK_LIST pk_list, int preftype,
181                              int request, void *hint );
182 int  select_mdc_from_pklist (PK_LIST pk_list);
183
184 /*-- skclist.c --*/
185 void release_sk_list( SK_LIST sk_list );
186 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
187                                             int unlock, unsigned use );
188
189 /*-- passphrase.h --*/
190 #ifdef ENABLE_AGENT_SUPPORT
191 assuan_context_t agent_open (int try);
192 void agent_close (assuan_context_t ctx);
193 #endif
194 int  have_static_passphrase(void);
195 void read_passphrase_from_fd( int fd );
196 void passphrase_clear_cache ( u32 *keyid, const char *cacheid, int algo );
197 char *ask_passphrase (const char *description,
198                       const char *tryagain_text,
199                       const char *promptid,
200                       const char *prompt, 
201                       const char *cacheid, int *canceled);
202 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
203                         int cipher_algo, STRING2KEY *s2k, int mode,
204                         const char *tryagain_text, int *canceled);
205 void set_next_passphrase( const char *s );
206 char *get_last_passphrase(void);
207
208 /*-- getkey.c --*/
209 int classify_user_id( const char *name, KEYDB_SEARCH_DESC *desc);
210 void cache_public_key( PKT_public_key *pk );
211 void getkey_disable_caches(void);
212 int get_pubkey( PKT_public_key *pk, u32 *keyid );
213 int get_pubkey_fast ( PKT_public_key *pk, u32 *keyid );
214 KBNODE get_pubkeyblock( u32 *keyid );
215 int get_pubkey_byname( PKT_public_key *pk,  const char *name,
216                        KBNODE *ret_keyblock, KEYDB_HANDLE *ret_kdbhd,
217                        int include_unusable );
218 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
219                         STRLIST names, KBNODE *ret_keyblock );
220 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
221 void get_pubkey_end( GETKEY_CTX ctx );
222 int get_seckey( PKT_secret_key *sk, u32 *keyid );
223 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
224 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
225                                                  size_t fprint_len );
226 int get_pubkey_byfprint_fast (PKT_public_key *pk,
227                               const byte *fprint, size_t fprint_len);
228 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
229                                                  size_t fprint_len );
230 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
231 int seckey_available( u32 *keyid );
232 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
233 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
234                         STRLIST names, KBNODE *ret_keyblock );
235 int get_seckey_next (GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock);
236 void get_seckey_end( GETKEY_CTX ctx );
237
238 int get_seckey_byfprint( PKT_secret_key *sk,
239                          const byte *fprint, size_t fprint_len);
240 int get_seckeyblock_byfprint (KBNODE *ret_keyblock, const byte *fprint,
241                               size_t fprint_len );
242
243
244 int enum_secret_keys( void **context, PKT_secret_key *sk,
245                       int with_subkeys, int with_spm );
246 void merge_keys_and_selfsig( KBNODE keyblock );
247 char*get_user_id_string( u32 *keyid );
248 char*get_user_id_string_native( u32 *keyid );
249 char*get_long_user_id_string( u32 *keyid );
250 char*get_user_id( u32 *keyid, size_t *rn );
251 char*get_user_id_native( u32 *keyid );
252 KEYDB_HANDLE get_ctx_handle(GETKEY_CTX ctx);
253
254 /*-- keyid.c --*/
255 int pubkey_letter( int algo );
256 void hash_public_key( MD_HANDLE md, PKT_public_key *pk );
257 size_t keystrlen(void);
258 const char *keystr(u32 *keyid);
259 const char *keystr_from_pk(PKT_public_key *pk);
260 const char *keystr_from_sk(PKT_secret_key *sk);
261 const char *keystr_from_desc(KEYDB_SEARCH_DESC *desc);
262 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
263 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
264 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
265 u32 keyid_from_fingerprint(const byte *fprint, size_t fprint_len, u32 *keyid);
266 byte *namehash_from_uid(PKT_user_id *uid);
267 unsigned nbits_from_pk( PKT_public_key *pk );
268 unsigned nbits_from_sk( PKT_secret_key *sk );
269 const char *datestr_from_pk( PKT_public_key *pk );
270 const char *datestr_from_sk( PKT_secret_key *sk );
271 const char *datestr_from_sig( PKT_signature *sig );
272 const char *expirestr_from_pk( PKT_public_key *pk );
273 const char *expirestr_from_sk( PKT_secret_key *sk );
274 const char *expirestr_from_sig( PKT_signature *sig );
275 const char *revokestr_from_pk( PKT_public_key *pk );
276 const char *usagestr_from_pk( PKT_public_key *pk );
277 const char *colon_strtime (u32 t);
278 const char *colon_datestr_from_pk (PKT_public_key *pk);
279 const char *colon_datestr_from_sk (PKT_secret_key *sk);
280 const char *colon_datestr_from_sig (PKT_signature *sig);
281 const char *colon_expirestr_from_sig (PKT_signature *sig);
282 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
283 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
284
285 /*-- kbnode.c --*/
286 KBNODE new_kbnode( PACKET *pkt );
287 KBNODE clone_kbnode( KBNODE node );
288 void release_kbnode( KBNODE n );
289 void delete_kbnode( KBNODE node );
290 void add_kbnode( KBNODE root, KBNODE node );
291 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
292 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
293 void remove_kbnode( KBNODE *root, KBNODE node );
294 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
295 KBNODE find_next_kbnode( KBNODE node, int pkttype );
296 KBNODE find_kbnode( KBNODE node, int pkttype );
297 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
298 void clear_kbnode_flags( KBNODE n );
299 int  commit_kbnode( KBNODE *root );
300 void dump_kbnode( KBNODE node );
301
302 #endif /*G10_KEYDB_H*/