95d369ed499448f927df21f9d4704bbf1b06cb57
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  *      Copyright (C) 1998, 1999, 2000 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 #include "types.h"
25 #include "basicdefs.h"
26 #include "packet.h"
27
28 #define MAX_FINGERPRINT_LEN 20
29
30 #define IS_KEY_SIG(s)    ((s)->sig_class == 0x1f)
31 #define IS_UID_SIG(s)    (((s)->sig_class & ~3) == 0x10)
32 #define IS_SUBKEY_SIG(s) ((s)->sig_class == 0x18)
33 #define IS_KEY_REV(s)    ((s)->sig_class == 0x20)
34 #define IS_UID_REV(s)    ((s)->sig_class == 0x30)
35 #define IS_SUBKEY_REV(s) ((s)->sig_class == 0x28)
36
37
38
39 struct getkey_ctx_s;
40 typedef struct getkey_ctx_s *GETKEY_CTX;
41
42 /****************
43  * A Keyblock is all packets which form an entire certificate;
44  * i.e. the public key, certificate, trust packets, user ids,
45  * signatures, and subkey.
46  *
47  * This structure is also used to bind arbitrary packets together.
48  */
49
50 typedef struct kbnode_struct *KBNODE;
51 struct kbnode_struct {
52     KBNODE next;
53     PACKET *pkt;
54     int flag;
55     int private_flag;
56     ulong recno;  /* used while updating the trustdb */
57 };
58
59 #define is_deleted_kbnode(a)  ((a)->private_flag & 1)
60 #define is_cloned_kbnode(a)   ((a)->private_flag & 2)
61
62
63 enum resource_type {
64     rt_UNKNOWN = 0,
65     rt_RING = 1,
66     rt_KBXF = 2
67 };
68
69
70 /****************
71  * A data structure to hold information about the external position
72  * of a keyblock.
73  */
74 struct keyblock_pos_struct;
75 typedef struct keyblock_pos_struct *KBPOS;
76
77 /* structure to hold a couple of public key certificates */
78 struct pk_list {
79     PK_LIST next;
80     PKT_public_key *pk;
81     int mark;
82 };
83
84 /* structure to hold a couple of secret key certificates */
85 struct sk_list {
86     SK_LIST next;
87     PKT_secret_key *sk;
88     int mark;
89 };
90
91
92 /*-- pkclist.c --*/
93 int  check_signatures_trust( PKT_signature *sig );
94 void release_pk_list( PK_LIST pk_list );
95 int  build_pk_list( STRLIST remusr, PK_LIST *ret_pk_list, unsigned use );
96 int  select_algo_from_prefs( PK_LIST pk_list, int preftype );
97
98 /*-- skclist.c --*/
99 void release_sk_list( SK_LIST sk_list );
100 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
101                                             int unlock, unsigned use );
102
103 /*-- passphrase.h --*/
104 int  have_static_passphrase(void);
105 void read_passphrase_from_fd( int fd );
106 void passphrase_clear_cache ( u32 *keyid, int algo );
107 DEK *passphrase_to_dek( u32 *keyid, int pubkey_algo,
108                         int cipher_algo, STRING2KEY *s2k, int mode);
109 void set_next_passphrase( const char *s );
110 char *get_last_passphrase(void);
111
112 /*-- getkey.c --*/
113 int classify_user_id( const char *name, u32 *keyid, byte *fprint,
114                       const char **retstr, size_t *retlen );
115 void getkey_disable_caches(void);
116 int get_pubkey( PKT_public_key *pk, u32 *keyid );
117 KBNODE get_pubkeyblock( u32 *keyid );
118 int get_pubkey_byname( GETKEY_CTX *rx, PKT_public_key *pk,
119                        const char *name, KBNODE *ret_keyblock );
120 int get_pubkey_bynames( GETKEY_CTX *rx, PKT_public_key *pk,
121                         STRLIST names, KBNODE *ret_keyblock );
122 int get_pubkey_next( GETKEY_CTX ctx, PKT_public_key *pk, KBNODE *ret_keyblock );
123 void get_pubkey_end( GETKEY_CTX ctx );
124 int get_seckey( PKT_secret_key *sk, u32 *keyid );
125 int get_primary_seckey( PKT_secret_key *sk, u32 *keyid );
126 int get_pubkey_byfprint( PKT_public_key *pk, const byte *fprint,
127                                                  size_t fprint_len );
128 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
129                                                  size_t fprint_len );
130 int get_keyblock_bylid( KBNODE *ret_keyblock, ulong lid );
131 int seckey_available( u32 *keyid );
132 int get_seckey_byname( GETKEY_CTX *rx,
133                        PKT_secret_key *sk, const char *name, int unlock,
134                        KBNODE *retblock );
135 int get_seckey_bynames( GETKEY_CTX *rx, PKT_secret_key *sk,
136                         STRLIST names, KBNODE *ret_keyblock );
137 int get_seckey_next( GETKEY_CTX ctx, PKT_secret_key *sk, KBNODE *ret_keyblock );
138 void get_seckey_end( GETKEY_CTX ctx );
139 int find_keyblock_byname( KBNODE *retblock, const char *username );
140 int find_secret_keyblock_byname( KBNODE *retblock, const char *username );
141 int find_keyblock_bypk( KBNODE *retblock, PKT_public_key *pk );
142 int find_keyblock_bysk( KBNODE *retblock, PKT_secret_key *sk );
143
144 int enum_secret_keys( void **context, PKT_secret_key *sk, int with_subkeys );
145 void merge_keys_and_selfsig( KBNODE keyblock );
146 void merge_public_with_secret ( KBNODE pubblock, KBNODE secblock );
147 char*get_user_id_string( u32 *keyid );
148 char*get_user_id_string_native( u32 *keyid );
149 char*get_long_user_id_string( u32 *keyid );
150 char*get_user_id( u32 *keyid, size_t *rn );
151
152 /*-- keyid.c --*/
153 int pubkey_letter( int algo );
154 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
155 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
156 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
157 u32 keyid_from_fingerprint( const byte *fprint, size_t fprint_len, u32 *keyid );
158 unsigned nbits_from_pk( PKT_public_key *pk );
159 unsigned nbits_from_sk( PKT_secret_key *sk );
160 const char *datestr_from_pk( PKT_public_key *pk );
161 const char *datestr_from_sk( PKT_secret_key *sk );
162 const char *datestr_from_sig( PKT_signature *sig );
163 const char *expirestr_from_pk( PKT_public_key *pk );
164 const char *expirestr_from_sk( PKT_secret_key *sk );
165 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf, size_t *ret_len );
166 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
167 char *unified_fingerprint_from_pk( PKT_public_key *pk,
168                                    char *buffer, size_t bufsize );
169 char *unified_fingerprint_from_sk( PKT_secret_key *sk,
170                                    char *buffer, size_t bufsize );
171
172 /*-- kbnode.c --*/
173 KBNODE new_kbnode( PACKET *pkt );
174 KBNODE clone_kbnode( KBNODE node );
175 void release_kbnode( KBNODE n );
176 void delete_kbnode( KBNODE node );
177 void add_kbnode( KBNODE root, KBNODE node );
178 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
179 void move_kbnode( KBNODE *root, KBNODE node, KBNODE where );
180 void remove_kbnode( KBNODE *root, KBNODE node );
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 char *get_writable_keyblock_file( int secret );
195 int enum_keyblocks( int mode, KBPOS kbpos, KBNODE *ret_root );
196 int insert_keyblock( KBNODE keyblock );
197 int delete_keyblock( KBNODE keyblock );
198 int update_keyblock( KBNODE keyblock );
199
200
201 #endif /*GPG_KEYDB_H*/