Removed some trash
[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
35 /****************
36  * A Keyblock is all packets which form an entire certificate;
37  * i.e. the public key, certificate, trust packets, user ids,
38  * signatures, and subkey.
39  *
40  * This structure is also used to bind arbitrary packets together.
41  */
42
43 typedef struct kbnode_struct *KBNODE;
44 struct kbnode_struct {
45     KBNODE next;
46     PACKET *pkt;
47     int flag;
48     int private_flag;
49 };
50
51
52 enum resource_type {
53     rt_UNKNOWN = 0,
54     rt_RING = 1,
55     rt_GDBM = 2
56 };
57
58
59 /****************
60  * A data structre to hold information about the external position
61  * of a keyblock.
62  */
63 struct keyblock_pos_struct {
64     int   resno;     /* resource number */
65     enum resource_type rt;
66     ulong offset;    /* position information */
67     unsigned count;  /* length of the keyblock in packets */
68     IOBUF  fp;       /* used by enum_keyblocks */
69     int secret;      /* working on a secret keyring */
70   #ifdef HAVE_LIBGDBM
71     GDBM_FILE dbf;
72   #endif
73     PACKET *pkt;     /* ditto */
74 };
75 typedef struct keyblock_pos_struct KBPOS;
76
77 /* structure to hold a couple of public key certificates */
78 typedef struct pk_list *PK_LIST;
79 struct pk_list {
80     PK_LIST next;
81     PKT_public_key *pk;
82     int mark;
83 };
84
85 /* structure to hold a couple of secret key certificates */
86 typedef struct sk_list *SK_LIST;
87 struct sk_list {
88     SK_LIST next;
89     PKT_secret_key *sk;
90     int mark;
91 };
92
93 /* structure to collect all information which can be used to
94  * identify a public key */
95 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
96 struct pubkey_find_info {
97     u32  keyid[2];
98     unsigned nbits;
99     byte pubkey_algo;
100     byte fingerprint[MAX_FINGERPRINT_LEN];
101     char userid[1];
102 };
103
104
105
106 /*-- pkclist.c --*/
107 int  check_signatures_trust( PKT_signature *sig );
108 void release_pk_list( PK_LIST pk_list );
109 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned usage );
110 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
111
112 /*-- skclist.c --*/
113 void release_sk_list( SK_LIST sk_list );
114 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
115                                             int unlock, unsigned usage );
116
117 /*-- passphrase.h --*/
118 int  have_static_passphrase(void);
119 void read_passphrase_from_fd( int fd );
120 DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
121 void set_next_passphrase( const char *s );
122 char *get_last_passphrase(void);
123
124 /*-- getkey.c --*/
125 int get_pubkey( PKT_public_key *pk, u32 *keyid );
126 int get_pubkey_byname( PKT_public_key *pk, const char *name );
127 int get_seckey( PKT_secret_key *sk, u32 *keyid );
128 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
129                                                  size_t fprint_len );
130 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
131                                                  size_t fprint_len );
132 int seckey_available( u32 *keyid );
133 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
134 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
135 void merge_keys_and_selfsig( KBNODE keyblock );
136 char*get_user_id_string( u32 *keyid );
137 char*get_user_id( u32 *keyid, size_t *rn );
138
139 /*-- keyid.c --*/
140 int pubkey_letter( int algo );
141 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
142 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
143 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
144 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
145 unsigned nbits_from_pk( PKT_public_key *pk );
146 unsigned nbits_from_sk( PKT_secret_key *sk );
147 const char *datestr_from_pk( PKT_public_key *pk );
148 const char *datestr_from_sk( PKT_secret_key *sk );
149 const char *datestr_from_sig( PKT_signature *sig );
150 const char *expirestr_from_pk( PKT_public_key *pk );
151 const char *expirestr_from_sk( PKT_secret_key *sk );
152 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
153 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
154
155 /*-- kbnode.c --*/
156 KBNODE new_kbnode( PACKET *pkt );
157 KBNODE clone_kbnode( KBNODE node );
158 void release_kbnode( KBNODE n );
159 void delete_kbnode( KBNODE node );
160 void add_kbnode( KBNODE root, KBNODE node );
161 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
162 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
163 KBNODE find_next_kbnode( KBNODE node, int pkttype );
164 KBNODE find_kbnode( KBNODE node, int pkttype );
165 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
166 void clear_kbnode_flags( KBNODE n );
167 int  commit_kbnode( KBNODE *root );
168 void dump_kbnode( KBNODE node );
169
170 /*-- ringedit.c --*/
171 const char *enum_keyblock_resources( int *sequence, int secret );
172 int add_keyblock_resource( const char *resname, int force, int secret );
173 const char *keyblock_resource_name( KBPOS *kbpos );
174 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
175 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
176 int find_keyblock_byname( KBPOS *kbpos, const char *username );
177 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
178 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
179 int lock_keyblock( KBPOS *kbpos );
180 void unlock_keyblock( KBPOS *kbpos );
181 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
182 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
183 int insert_keyblock( KBPOS *kbpos, KBNODE root );
184 int delete_keyblock( KBPOS *kbpos );
185 int update_keyblock( KBPOS *kbpos, KBNODE root );
186
187
188 #endif /*G10_KEYDB_H*/