test release
[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 are 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 informations 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 informations 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 *get_passphrase_hash( u32 *keyid, char *text, byte *salt );
101 int make_dek_from_passphrase( DEK *dek, int mode, byte *salt );
102
103 /*-- getkey.c --*/
104 void add_keyring( const char *name );
105 const char *get_keyring( int sequence );
106 void add_secret_keyring( const char *name );
107 int get_pubkey( PKT_public_cert *pkc, u32 *keyid );
108 int get_pubkey_byname( PKT_public_cert *pkc, const char *name );
109 int get_seckey( PKT_secret_cert *skc, u32 *keyid );
110 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint );
111 int seckey_available( u32 *keyid );
112 int get_seckey_byname( PKT_secret_cert *skc, const char *name, int unlock );
113 int enum_secret_keys( void **context, PKT_secret_cert *skc );
114 char*get_user_id_string( u32 *keyid );
115 char*get_user_id( u32 *keyid, size_t *rn );
116
117 /*-- keyid.c --*/
118 int pubkey_letter( int algo );
119 u32 keyid_from_skc( PKT_secret_cert *skc, u32 *keyid );
120 u32 keyid_from_pkc( PKT_public_cert *pkc, u32 *keyid );
121 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
122 unsigned nbits_from_pkc( PKT_public_cert *pkc );
123 unsigned nbits_from_skc( PKT_secret_cert *skc );
124 const char *datestr_from_pkc( PKT_public_cert *pkc );
125 const char *datestr_from_skc( PKT_secret_cert *skc );
126 const char *datestr_from_sig( PKT_signature *sig );
127 byte *fingerprint_from_skc( PKT_secret_cert *skc, size_t *ret_len );
128 byte *fingerprint_from_pkc( PKT_public_cert *pkc, size_t *ret_len );
129
130 /*-- kbnode.c --*/
131 KBNODE new_kbnode( PACKET *pkt );
132 KBNODE clone_kbnode( KBNODE node );
133 void release_kbnode( KBNODE n );
134 void delete_kbnode( KBNODE node );
135 void add_kbnode( KBNODE root, KBNODE node );
136 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
137 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
138 KBNODE find_next_kbnode( KBNODE node, int pkttype );
139 KBNODE find_kbnode( KBNODE node, int pkttype );
140 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
141 void clear_kbnode_flags( KBNODE n );
142 int  commit_kbnode( KBNODE *root );
143
144 /*-- ringedit.c --*/
145 int add_keyblock_resource( const char *filename, int force, int secret );
146 const char *keyblock_resource_name( KBPOS *kbpos );
147 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
148 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
149 int find_keyblock_byname( KBPOS *kbpos, const char *username );
150 int find_keyblock_bypkc( KBPOS *kbpos, PKT_public_cert *pkc );
151 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
152 int lock_keyblock( KBPOS *kbpos );
153 void unlock_keyblock( KBPOS *kbpos );
154 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
155 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
156 int insert_keyblock( KBPOS *kbpos, KBNODE root );
157 int delete_keyblock( KBPOS *kbpos );
158 int update_keyblock( KBPOS *kbpos, KBNODE root );
159
160
161 #endif /*G10_KEYDB_H*/