sync
[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
95 /*-- skclist.c --*/
96 void release_sk_list( SK_LIST sk_list );
97 int  build_sk_list( STRLIST locusr, SK_LIST *ret_sk_list,
98                                             int unlock, unsigned usage );
99
100 /*-- passphrase.h --*/
101 void set_passphrase_fd( int fd );
102 int  get_passphrase_fd(void);
103 DEK *passphrase_to_dek( u32 *keyid, int cipher_algo, STRING2KEY *s2k, int mode);
104 void set_next_passphrase( const char *s );
105 char *get_last_passphrase(void);
106
107 /*-- getkey.c --*/
108 void add_keyring( const char *name );
109 const char *get_keyring( int sequence );
110 const char *get_secret_keyring( int sequence );
111 void add_secret_keyring( const char *name );
112 int get_pubkey( PKT_public_key *pk, u32 *keyid );
113 int get_pubkey_byname( PKT_public_key *pk, const char *name );
114 int get_seckey( PKT_secret_key *sk, u32 *keyid );
115 int get_keyblock_byfprint( KBNODE *ret_keyblock, const byte *fprint,
116                                                  size_t fprint_len );
117 int seckey_available( u32 *keyid );
118 int get_seckey_byname( PKT_secret_key *sk, const char *name, int unlock );
119 int enum_secret_keys( void **context, PKT_secret_key *sk );
120 char*get_user_id_string( u32 *keyid );
121 char*get_user_id( u32 *keyid, size_t *rn );
122
123 /*-- keyid.c --*/
124 int pubkey_letter( int algo );
125 u32 keyid_from_sk( PKT_secret_key *sk, u32 *keyid );
126 u32 keyid_from_pk( PKT_public_key *pk, u32 *keyid );
127 u32 keyid_from_sig( PKT_signature *sig, u32 *keyid );
128 unsigned nbits_from_pk( PKT_public_key *pk );
129 unsigned nbits_from_sk( PKT_secret_key *sk );
130 const char *datestr_from_pk( PKT_public_key *pk );
131 const char *datestr_from_sk( PKT_secret_key *sk );
132 const char *datestr_from_sig( PKT_signature *sig );
133 byte *fingerprint_from_sk( PKT_secret_key *sk, byte *buf; size_t *ret_len );
134 byte *fingerprint_from_pk( PKT_public_key *pk, byte *buf, size_t *ret_len );
135
136 /*-- kbnode.c --*/
137 KBNODE new_kbnode( PACKET *pkt );
138 KBNODE clone_kbnode( KBNODE node );
139 void release_kbnode( KBNODE n );
140 void delete_kbnode( KBNODE node );
141 void add_kbnode( KBNODE root, KBNODE node );
142 void insert_kbnode( KBNODE root, KBNODE node, int pkttype );
143 KBNODE find_prev_kbnode( KBNODE root, KBNODE node, int pkttype );
144 KBNODE find_next_kbnode( KBNODE node, int pkttype );
145 KBNODE find_kbnode( KBNODE node, int pkttype );
146 KBNODE walk_kbnode( KBNODE root, KBNODE *context, int all );
147 void clear_kbnode_flags( KBNODE n );
148 int  commit_kbnode( KBNODE *root );
149
150 /*-- ringedit.c --*/
151 int add_keyblock_resource( const char *filename, int force, int secret );
152 const char *keyblock_resource_name( KBPOS *kbpos );
153 int get_keyblock_handle( const char *filename, int secret, KBPOS *kbpos );
154 int find_keyblock( PUBKEY_FIND_INFO info, KBPOS *kbpos );
155 int find_keyblock_byname( KBPOS *kbpos, const char *username );
156 int find_keyblock_bypk( KBPOS *kbpos, PKT_public_key *pk );
157 int find_secret_keyblock_byname( KBPOS *kbpos, const char *username );
158 int lock_keyblock( KBPOS *kbpos );
159 void unlock_keyblock( KBPOS *kbpos );
160 int read_keyblock( KBPOS *kbpos, KBNODE *ret_root );
161 int enum_keyblocks( int mode, KBPOS *kbpos, KBNODE *ret_root );
162 int insert_keyblock( KBPOS *kbpos, KBNODE root );
163 int delete_keyblock( KBPOS *kbpos );
164 int update_keyblock( KBPOS *kbpos, KBNODE root );
165
166
167 #endif /*G10_KEYDB_H*/