See ChangeLog: Tue Feb 16 14:10:02 CET 1999 Werner Koch
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  *      Copyright (C) 1998 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 #ifdef HAVE_LIBGDBM
25   #include <gdbm.h>
26 #endif
27
28 #include "types.h"
29 #include "packet.h"
30 #include "cipher.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
55 enum resource_type {
56     rt_UNKNOWN = 0,
57     rt_RING = 1,
58     rt_GDBM = 2
59 };
60
61
62 /****************
63  * A data structre to hold information about the external position
64  * of a keyblock.
65  */
66 struct keyblock_pos_struct {
67     int   resno;     /* resource number */
68     enum resource_type rt;
69     ulong offset;    /* position information */
70     unsigned count;  /* length of the keyblock in packets */
71     IOBUF  fp;       /* used by enum_keyblocks */
72     int secret;      /* working on a secret keyring */
73   #ifdef HAVE_LIBGDBM
74     GDBM_FILE dbf;
75     byte keybuf[21];
76   #endif
77     PACKET *pkt;     /* ditto */
78     int valid;
79 };
80 typedef struct keyblock_pos_struct KBPOS;
81
82 /* structure to hold a couple of public key certificates */
83 typedef struct pk_list *PK_LIST;
84 struct pk_list {
85     PK_LIST next;
86     PKT_public_key *pk;
87     int mark;
88 };
89
90 /* structure to hold a couple of secret key certificates */
91 typedef struct sk_list *SK_LIST;
92 struct sk_list {
93     SK_LIST next;
94     PKT_secret_key *sk;
95     int mark;
96 };
97
98 /* structure to collect all information which can be used to
99  * identify a public key */
100 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
101 struct pubkey_find_info {
102     u32  keyid[2];
103     unsigned nbits;
104     byte pubkey_algo;
105     byte fingerprint[MAX_FINGERPRINT_LEN];
106     char userid[1];
107 };
108
109
110
111 /*-- pkclist.c --*/
112 int  check_signatures_trust( PKT_signature *sig );
113 void release_pk_list( PK_LIST pk_list );
114 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned use );
115 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
116
117 /*-- skclist.c --*/
118 void release_sk_list( SK_LIST sk_list );
119 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
120                                             int unlock, unsigned use );
121
122 /*-- passphrase.h --*/
123 int  have_static_passphrase(void);
124 void read_passphrase_from_fd( int fd );
125 DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
126 void set_next_passphrase( const char *s );
127 char *get_last_passphrase(void);
128
129 /*-- getkey.c --*/
130 int classify_user_id( const char *name, u32 *keyid, byte *fprint,
131                       const char **retstr, size_t *retlen );
132 void getkey_disable_caches(void);
133 int get_pubkey( PKT_public_key *pk, u32 *keyid );
134 int get_pubkey_byname( GETKEY_CTX *rx, PKT_public_key *pk,
135                        const char *name, KBNODE *ret_keyblock );
136 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
137                         STRLIST names, KBNODE *ret_keyblock );
138 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
139 void get_pubkey_end( GETKEY_CTX ctx );
140 int get_seckey( PKT_secret_key *sk, u32 *keyid );
141 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
142 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
143                                                  size_t fprint_len );
144 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
145                                                  size_t fprint_len );
146 int seckey_available( u32 *keyid );
147 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
148 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
149                         STRLIST names, KBNODE *ret_keyblock );
150 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
151 void get_seckey_end( GETKEY_CTX ctx );
152 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
153 void merge_keys_and_selfsig( KBNODE keyblock );
154 char*get_user_id_string( u32 *keyid );
155 char*get_long_user_id_string( u32 *keyid );
156 char*get_user_id( u32 *keyid, size_t *rn );
157
158 /*-- keyid.c --*/
159 int pubkey_letter( int algo );
160 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
161 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
162 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
163 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
164 unsigned nbits_from_pk( PKT_public_key *pk );
165 unsigned nbits_from_sk( PKT_secret_key *sk );
166 const char *datestr_from_pk( PKT_public_key *pk );
167 const char *datestr_from_sk( PKT_secret_key *sk );
168 const char *datestr_from_sig( PKT_signature *sig );
169 const char *expirestr_from_pk( PKT_public_key *pk );
170 const char *expirestr_from_sk( PKT_secret_key *sk );
171 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
172 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
173
174 /*-- kbnode.c --*/
175 KBNODE new_kbnode( PACKET *pkt );
176 KBNODE clone_kbnode( KBNODE node );
177 void release_kbnode( KBNODE n );
178 void delete_kbnode( KBNODE node );
179 void add_kbnode( KBNODE root, KBNODE node );
180 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
181 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
182 KBNODE find_next_kbnode( KBNODE node, int pkttype );
183 KBNODE find_kbnode( KBNODE node, int pkttype );
184 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
185 void clear_kbnode_flags( KBNODE n );
186 int  commit_kbnode( KBNODE *root );
187 void dump_kbnode( KBNODE node );
188
189 /*-- ringedit.c --*/
190 const char *enum_keyblock_resources( int *sequence, int secret );
191 int add_keyblock_resource( const char *resname, int force, int secret );
192 const char *keyblock_resource_name( KBPOS *kbpos );
193 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
194 int locate_keyblock_by_fpr( KBPOS *kbpos, const byte *fpr,
195                                             int fprlen, int secret );
196 int locate_keyblock_by_keyid( KBPOS *kbpos, u32 *keyid,
197                                             int shortkid, int secret );
198 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
199 int find_keyblock_byname( KBPOS *kbpos, const char *username );
200 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
201 int find_keyblock_bysk( KBPOS *kbpos, PKT_secret_key *sk );
202 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
203 int lock_keyblock( KBPOS *kbpos );
204 void unlock_keyblock( KBPOS *kbpos );
205 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
206 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
207 int insert_keyblock( KBPOS *kbpos, KBNODE root );
208 int delete_keyblock( KBPOS *kbpos );
209 int update_keyblock( KBPOS *kbpos, KBNODE root );
210
211
212 #endif /*G10_KEYDB_H*/