Add some libgcrypt dox
[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 GPG_KEYDB_H
22 #define GPG_KEYDB_H
23
24 #ifdef HAVE_LIBGDBM
25   #include <gdbm.h>
26 #endif
27
28 #include "basicdefs.h"
29 #include "packet.h"
30
31 #define MAX_FINGERPRINT_LEN 20
32
33 struct getkey_ctx_s;
34 typedef struct getkey_ctx_s *GETKEY_CTX;
35
36 /****************
37  * A Keyblock is all packets which form an entire certificate;
38  * i.e. the public key, certificate, trust packets, user ids,
39  * signatures, and subkey.
40  *
41  * This structure is also used to bind arbitrary packets together.
42  */
43
44 typedef struct kbnode_struct *KBNODE;
45 struct kbnode_struct {
46     KBNODE next;
47     PACKET *pkt;
48     int flag;
49     int private_flag;
50     ulong recno;  /* used while updating the trustdb */
51 };
52
53 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
54 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
55
56
57 enum resource_type {
58     rt_UNKNOWN = 0,
59     rt_RING = 1,
60     rt_GDBM = 2
61 };
62
63
64 /****************
65  * A data structre to hold information about the external position
66  * of a keyblock.
67  */
68 struct keyblock_pos_struct {
69     int   resno;     /* resource number */
70     enum resource_type rt;
71     ulong offset;    /* position information */
72     unsigned count;  /* length of the keyblock in packets */
73     IOBUF  fp;       /* used by enum_keyblocks */
74     int secret;      /* working on a secret keyring */
75   #ifdef HAVE_LIBGDBM
76     GDBM_FILE dbf;
77     byte keybuf[21];
78   #endif
79     PACKET *pkt;     /* ditto */
80     int valid;
81 };
82 typedef struct keyblock_pos_struct KBPOS;
83
84 /* structure to hold a couple of public key certificates */
85 struct pk_list {
86     PK_LIST next;
87     PKT_public_key *pk;
88     int mark;
89 };
90
91 /* structure to hold a couple of secret key certificates */
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 pubkey_algo,
126                         int cipher_algo, STRING2KEY *s2k, int mode);
127 void set_next_passphrase( const char *s );
128 char *get_last_passphrase(void);
129
130 /*-- getkey.c --*/
131 int classify_user_id( const char *name, u32 *keyid, byte *fprint,
132                       const char **retstr, size_t *retlen );
133 void getkey_disable_caches(void);
134 int get_pubkey( PKT_public_key *pk, u32 *keyid );
135 KBNODE get_pubkeyblock( u32 *keyid );
136 int get_pubkey_byname( GETKEY_CTX *rx, PKT_public_key *pk,
137                        const char *name, KBNODE *ret_keyblock );
138 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
139                         STRLIST names, KBNODE *ret_keyblock );
140 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
141 void get_pubkey_end( GETKEY_CTX ctx );
142 int get_seckey( PKT_secret_key *sk, u32 *keyid );
143 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
144 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
145                                                  size_t fprint_len );
146 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
147                                                  size_t fprint_len );
148 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
149 int seckey_available( u32 *keyid );
150 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
151 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
152                         STRLIST names, KBNODE *ret_keyblock );
153 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
154 void get_seckey_end( GETKEY_CTX ctx );
155 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
156 void merge_keys_and_selfsig( KBNODE keyblock );
157 char*get_user_id_string( u32 *keyid );
158 char*get_long_user_id_string( u32 *keyid );
159 char*get_user_id( u32 *keyid, size_t *rn );
160
161 /*-- keyid.c --*/
162 int pubkey_letter( int algo );
163 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
164 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
165 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
166 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
167 unsigned nbits_from_pk( PKT_public_key *pk );
168 unsigned nbits_from_sk( PKT_secret_key *sk );
169 const char *datestr_from_pk( PKT_public_key *pk );
170 const char *datestr_from_sk( PKT_secret_key *sk );
171 const char *datestr_from_sig( PKT_signature *sig );
172 const char *expirestr_from_pk( PKT_public_key *pk );
173 const char *expirestr_from_sk( PKT_secret_key *sk );
174 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
175 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
176
177 /*-- kbnode.c --*/
178 KBNODE new_kbnode( PACKET *pkt );
179 KBNODE clone_kbnode( KBNODE node );
180 void release_kbnode( KBNODE n );
181 void delete_kbnode( KBNODE node );
182 void add_kbnode( KBNODE root, KBNODE node );
183 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
184 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
185 void remove_kbnode( KBNODE *root, KBNODE node );
186 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
187 KBNODE find_next_kbnode( KBNODE node, int pkttype );
188 KBNODE find_kbnode( KBNODE node, int pkttype );
189 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
190 void clear_kbnode_flags( KBNODE n );
191 int  commit_kbnode( KBNODE *root );
192 void dump_kbnode( KBNODE node );
193
194 /*-- ringedit.c --*/
195 const char *enum_keyblock_resources( int *sequence, int secret );
196 int add_keyblock_resource( const char *resname, int force, int secret );
197 const char *keyblock_resource_name( KBPOS *kbpos );
198 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
199 int locate_keyblock_by_fpr( KBPOS *kbpos, const byte *fpr,
200                                             int fprlen, int secret );
201 int locate_keyblock_by_keyid( KBPOS *kbpos, u32 *keyid,
202                                             int shortkid, int secret );
203 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
204 int find_keyblock_byname( KBPOS *kbpos, const char *username );
205 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
206 int find_keyblock_bysk( KBPOS *kbpos, PKT_secret_key *sk );
207 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
208 int lock_keyblock( KBPOS *kbpos );
209 void unlock_keyblock( KBPOS *kbpos );
210 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
211 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
212 int insert_keyblock( KBPOS *kbpos, KBNODE root );
213 int delete_keyblock( KBPOS *kbpos );
214 int update_keyblock( KBPOS *kbpos, KBNODE root );
215
216
217 #endif /*GPG_KEYDB_H*/