gnupg extension are now working
[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
29
30 /****************
31  * A Keyblock is all packets which form an entire certificate;
32  * i.e. the public key, certificate, trust packets, user ids,
33  * signatures, and subkey.
34  *
35  * This structure is also used to bind arbitrary packets together.
36  */
37
38 typedef struct kbnode_struct *KBNODE;
39 struct kbnode_struct {
40     KBNODE next;
41     PACKET *pkt;
42     int flag;
43     int private_flag;
44 };
45
46 /****************
47  * A data structre to hold information about the external position
48  * of a keyblock.
49  */
50 struct keyblock_pos_struct {
51     int   resno;     /* resource number */
52     ulong offset;    /* position information */
53     unsigned count;  /* length of the keyblock in packets */
54     IOBUF  fp;       /* used by enum_keyblocks */
55     int secret;      /* working on a secret keyring */
56     PACKET *pkt;     /* ditto */
57 };
58 typedef struct keyblock_pos_struct KBPOS;
59
60 /* structure to hold a couple of public key certificates */
61 typedef struct pkc_list *PKC_LIST;
62 struct pkc_list {
63     PKC_LIST next;
64     PKT_public_cert *pkc;
65     int mark;
66 };
67
68 /* structure to hold a couple of secret key certificates */
69 typedef struct skc_list *SKC_LIST;
70 struct skc_list {
71     SKC_LIST next;
72     PKT_secret_cert *skc;
73     int mark;
74 };
75
76 /* structure to collect all information which can be used to
77  * identify a public key */
78 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
79 struct pubkey_find_info {
80     u32  keyid[2];
81     unsigned nbits;
82     byte pubkey_algo;
83     byte fingerprint[20];
84     char userid[1];
85 };
86
87
88 /*-- pkclist.c --*/
89 void release_pkc_list( PKC_LIST pkc_list );
90 int  build_pkc_list( STRLIST remusr, PKC_LIST *ret_pkc_list, unsigned usage );
91
92 /*-- skclist.c --*/
93 void release_skc_list( SKC_LIST skc_list );
94 int  build_skc_list( STRLIST locusr, SKC_LIST *ret_skc_list,
95                                             int unlock, unsigned usage );
96
97 /*-- passphrase.h --*/
98 void set_passphrase_fd( int fd );
99 int  get_passphrase_fd(void);
100 DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
101 void set_next_passphrase( const char *s );
102 char *get_last_passphrase(void);
103
104 /*-- getkey.c --*/
105 void add_keyring( const char *name );
106 const char *get_keyring( int sequence );
107 const char *get_secret_keyring( int sequence );
108 void add_secret_keyring( const char *name );
109 int get_pubkey( PKT_public_cert *pkc, u32 *keyid );
110 int get_pubkey_byname( PKT_public_cert *pkc, const char *name );
111 int get_seckey( PKT_secret_cert *skc, u32 *keyid );
112 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
113                                                  size_t fprint_len );
114 int seckey_available( u32 *keyid );
115 int get_seckey_byname( PKT_secret_cert *skc, const char *name, int unlock );
116 int enum_secret_keys( void **context, PKT_secret_cert *skc );
117 char*get_user_id_string( u32 *keyid );
118 char*get_user_id( u32 *keyid, size_t *rn );
119
120 /*-- keyid.c --*/
121 int pubkey_letter( int algo );
122 u32 keyid_from_skc( PKT_secret_cert *skc, u32 *keyid );
123 u32 keyid_from_pkc( PKT_public_cert *pkc, u32 *keyid );
124 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
125 unsigned nbits_from_pkc( PKT_public_cert *pkc );
126 unsigned nbits_from_skc( PKT_secret_cert *skc );
127 const char *datestr_from_pkc( PKT_public_cert *pkc );
128 const char *datestr_from_skc( PKT_secret_cert *skc );
129 const char *datestr_from_sig( PKT_signature *sig );
130 byte *fingerprint_from_skc( PKT_secret_cert *skc, size_t *ret_len );
131 byte *fingerprint_from_pkc( PKT_public_cert *pkc, size_t *ret_len );
132
133 /*-- kbnode.c --*/
134 KBNODE new_kbnode( PACKET *pkt );
135 KBNODE clone_kbnode( KBNODE node );
136 void release_kbnode( KBNODE n );
137 void delete_kbnode( KBNODE node );
138 void add_kbnode( KBNODE root, KBNODE node );
139 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
140 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
141 KBNODE find_next_kbnode( KBNODE node, int pkttype );
142 KBNODE find_kbnode( KBNODE node, int pkttype );
143 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
144 void clear_kbnode_flags( KBNODE n );
145 int  commit_kbnode( KBNODE *root );
146
147 /*-- ringedit.c --*/
148 int add_keyblock_resource( const char *filename, int force, int secret );
149 const char *keyblock_resource_name( KBPOS *kbpos );
150 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
151 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
152 int find_keyblock_byname( KBPOS *kbpos, const char *username );
153 int find_keyblock_bypkc( KBPOS *kbpos, PKT_public_cert *pkc );
154 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
155 int lock_keyblock( KBPOS *kbpos );
156 void unlock_keyblock( KBPOS *kbpos );
157 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
158 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
159 int insert_keyblock( KBPOS *kbpos, KBNODE root );
160 int delete_keyblock( KBPOS *kbpos );
161 int update_keyblock( KBPOS *kbpos, KBNODE root );
162
163
164 #endif /*G10_KEYDB_H*/