a couple of changes; but some parts are now broken
[gnupg.git] / g10 / keydb.h
1 /* keydb.h - Key database
2  *      Copyright (c) 1997 by Werner Koch (dd9jn)
3  *
4  * This file is part of G10.
5  *
6  * G10 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  * G10 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 };
55 typedef struct keyblock_pos_struct KBPOS;
56
57 /* structure to hold a couple of public key certificates */
58 typedef struct pkc_list *PKC_LIST;
59 struct pkc_list {
60     PKC_LIST next;
61     PKT_public_cert *pkc;
62     int mark;
63 };
64
65 /* structure to hold a couple of secret key certificates */
66 typedef struct skc_list *SKC_LIST;
67 struct skc_list {
68     SKC_LIST next;
69     PKT_secret_cert *skc;
70     int mark;
71 };
72
73 /* structure to collect all informations which can be used to
74  * identify a public key */
75 typedef struct pubkey_find_info *PUBKEY_FIND_INFO;
76 struct pubkey_find_info {
77     u32  keyid[2];
78     unsigned nbits;
79     byte pubkey_algo;
80     byte fingerprint[20];
81     char userid[1];
82 };
83
84
85 /*-- pkclist.c --*/
86 void release_pkc_list( PKC_LIST pkc_list );
87 int  build_pkc_list( STRLIST remusr, PKC_LIST *ret_pkc_list );
88
89 /*-- skclist.c --*/
90 void release_skc_list( SKC_LIST skc_list );
91 int  build_skc_list( STRLIST locusr, SKC_LIST *ret_skc_list, int unlock );
92
93 /*-- passphrase.h --*/
94 void set_passphrase_fd( int fd );
95 int  get_passphrase_fd(void);
96 DEK *get_passphrase_hash( u32 *keyid, char *text );
97 int make_dek_from_passphrase( DEK *dek, int mode );
98
99 /*-- getkey.c --*/
100 void add_keyring( const char *name );
101 const char *get_keyring( int sequence );
102 void add_secret_keyring( const char *name );
103 void cache_public_cert( PKT_public_cert *pkc );
104 void cache_user_id( PKT_user_id *uid, u32 *keyid );
105 int get_pubkey( PKT_public_cert *pkc, u32 *keyid );
106 int get_pubkey_byname( PKT_public_cert *pkc, const char *name );
107 int get_seckey( PKT_secret_cert *skc, u32 *keyid );
108 int get_seckey_byname( PKT_secret_cert *skc, const char *name, int unlock );
109 int enum_secret_keys( void **context, PKT_secret_cert *skc );
110 char*get_user_id_string( u32 *keyid );
111 char*get_user_id( u32 *keyid, size_t *rn );
112
113 /*-- keyid.c --*/
114 int pubkey_letter( int algo );
115 u32 keyid_from_skc( PKT_secret_cert *skc, u32 *keyid );
116 u32 keyid_from_pkc( PKT_public_cert *pkc, u32 *keyid );
117 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
118 unsigned nbits_from_pkc( PKT_public_cert *pkc );
119 unsigned nbits_from_skc( PKT_secret_cert *skc );
120 const char *datestr_from_pkc( PKT_public_cert *pkc );
121 const char *datestr_from_skc( PKT_secret_cert *skc );
122 const char *datestr_from_sig( PKT_signature *sig );
123 byte *fingerprint_from_skc( PKT_secret_cert *skc, size_t *ret_len );
124 byte *fingerprint_from_pkc( PKT_public_cert *pkc, size_t *ret_len );
125
126 /*-- kbnode.c --*/
127 KBNODE new_kbnode( PACKET *pkt );
128 void release_kbnode( KBNODE n );
129 void delete_kbnode( KBNODE root, KBNODE node );
130 void add_kbnode( KBNODE root, KBNODE node );
131 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
132 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
133 KBNODE find_next_kbnode( KBNODE node, int pkttype );
134 KBNODE find_kbnode( KBNODE node, int pkttype );
135 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
136 void clear_kbnode_flags( KBNODE n );
137
138 /*-- ringedit.c --*/
139 int add_keyblock_resource( const char *filename, int force, int secret );
140 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
141 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
142 int find_keyblock_byname( KBPOS *kbpos, const char *username );
143 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
144 int lock_keyblock( KBPOS *kbpos );
145 void unlock_keyblock( KBPOS *kbpos );
146 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
147 int insert_keyblock( KBPOS *kbpos, KBNODE root );
148 int delete_keyblock( KBPOS *kbpos );
149 int update_keyblock( KBPOS *kbpos, KBNODE root );
150
151
152 #endif /*G10_KEYDB_H*/