4a18b7ea05f2d4112e4f32791e7518b6f811560a
[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 typedef struct getkey_ctx_s *GETKEY_CTX;
35 #ifndef DEFINES_GETKEY_CTX
36 struct getkey_ctx_s { char hidden[1]; };
37 #endif
38
39 /****************
40  * A Keyblock is all packets which form an entire certificate;
41  * i.e. the public key, certificate, trust packets, user ids,
42  * signatures, and subkey.
43  *
44  * This structure is also used to bind arbitrary packets together.
45  */
46
47 typedef struct kbnode_struct *KBNODE;
48 struct kbnode_struct {
49     KBNODE next;
50     PACKET *pkt;
51     int flag;
52     int private_flag;
53     ulong recno;  /* used while updating the trustdb */
54 };
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 typedef struct pk_list *PK_LIST;
86 struct pk_list {
87     PK_LIST next;
88     PKT_public_key *pk;
89     int mark;
90 };
91
92 /* structure to hold a couple of secret key certificates */
93 typedef struct sk_list *SK_LIST;
94 struct sk_list {
95     SK_LIST next;
96     PKT_secret_key *sk;
97     int mark;
98 };
99
100 /* structure to collect all information which can be used to
101  * identify a public key */
102 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
103 struct pubkey_find_info {
104     u32  keyid[2];
105     unsigned nbits;
106     byte pubkey_algo;
107     byte fingerprint[MAX_FINGERPRINT_LEN];
108     char userid[1];
109 };
110
111
112
113 /*-- pkclist.c --*/
114 int  check_signatures_trust( PKT_signature *sig );
115 void release_pk_list( PK_LIST pk_list );
116 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned usage );
117 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
118
119 /*-- skclist.c --*/
120 void release_sk_list( SK_LIST sk_list );
121 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
122                                             int unlock, unsigned usage );
123
124 /*-- passphrase.h --*/
125 int  have_static_passphrase(void);
126 void read_passphrase_from_fd( int fd );
127 DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
128 void set_next_passphrase( const char *s );
129 char *get_last_passphrase(void);
130
131 /*-- getkey.c --*/
132 int classify_user_id( const char *name, u32 *keyid, byte *fprint,
133                       const char **retstr, size_t *retlen );
134 void getkey_disable_caches(void);
135 int get_pubkey( PKT_public_key *pk, 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_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 enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
149 void merge_keys_and_selfsig( KBNODE keyblock );
150 char*get_user_id_string( u32 *keyid );
151 char*get_long_user_id_string( u32 *keyid );
152 char*get_user_id( u32 *keyid, size_t *rn );
153
154 /*-- keyid.c --*/
155 int pubkey_letter( int algo );
156 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
157 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
158 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
159 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
160 unsigned nbits_from_pk( PKT_public_key *pk );
161 unsigned nbits_from_sk( PKT_secret_key *sk );
162 const char *datestr_from_pk( PKT_public_key *pk );
163 const char *datestr_from_sk( PKT_secret_key *sk );
164 const char *datestr_from_sig( PKT_signature *sig );
165 const char *expirestr_from_pk( PKT_public_key *pk );
166 const char *expirestr_from_sk( PKT_secret_key *sk );
167 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
168 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
169
170 /*-- kbnode.c --*/
171 KBNODE new_kbnode( PACKET *pkt );
172 KBNODE clone_kbnode( KBNODE node );
173 void release_kbnode( KBNODE n );
174 void delete_kbnode( KBNODE node );
175 void add_kbnode( KBNODE root, KBNODE node );
176 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
177 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
178 KBNODE find_next_kbnode( KBNODE node, int pkttype );
179 KBNODE find_kbnode( KBNODE node, int pkttype );
180 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
181 void clear_kbnode_flags( KBNODE n );
182 int  commit_kbnode( KBNODE *root );
183 void dump_kbnode( KBNODE node );
184
185 /*-- ringedit.c --*/
186 const char *enum_keyblock_resources( int *sequence, int secret );
187 int add_keyblock_resource( const char *resname, int force, int secret );
188 const char *keyblock_resource_name( KBPOS *kbpos );
189 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
190 int locate_keyblock_by_fpr( KBPOS *kbpos, const byte *fpr,
191                                             int fprlen, int secret );
192 int locate_keyblock_by_keyid( KBPOS *kbpos, u32 *keyid,
193                                             int shortkid, int secret );
194 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
195 int find_keyblock_byname( KBPOS *kbpos, const char *username );
196 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
197 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
198 int lock_keyblock( KBPOS *kbpos );
199 void unlock_keyblock( KBPOS *kbpos );
200 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
201 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
202 int insert_keyblock( KBPOS *kbpos, KBNODE root );
203 int delete_keyblock( KBPOS *kbpos );
204 int update_keyblock( KBPOS *kbpos, KBNODE root );
205
206
207 #endif /*G10_KEYDB_H*/