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