2 * keydb.c - Routines to store and fetch keys.
4 * Copyright 2002-2004 Jonathan McDowell <noodles@earth.li>
6 * This program is free software: you can redistribute it and/or modify it
7 * under the terms of the GNU General Public License as published by the Free
8 * Software Foundation; version 2 of the License.
10 * This program is distributed in the hope that it will be useful, but WITHOUT
11 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
12 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
15 * You should have received a copy of the GNU General Public License along with
16 * this program; if not, write to the Free Software Foundation, Inc., 51
17 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
20 #include <sys/types.h>
30 #include "charfuncs.h"
33 #include "keystructs.h"
37 #include "onak-conf.h"
41 * initdb - Initialize the key database.
43 * This is just a no-op for flat file access.
45 static void file_initdb(bool readonly)
50 * cleanupdb - De-initialize the key database.
52 * This is just a no-op for flat file access.
54 static void file_cleanupdb(void)
59 * starttrans - Start a transaction.
61 * This is just a no-op for flat file access.
63 static bool file_starttrans(void)
69 * endtrans - End a transaction.
71 * This is just a no-op for flat file access.
73 static void file_endtrans(void)
79 * fetch_key_id - Given a keyid fetch the key from storage.
80 * @keyid: The keyid to fetch.
81 * @publickey: A pointer to a structure to return the key in.
82 * @intrans: If we're already in a transaction.
84 * We use the hex representation of the keyid as the filename to fetch the
85 * key from. The key is stored in the file as a binary OpenPGP stream of
86 * packets, so we can just use read_openpgp_stream() to read the packets
87 * in and then parse_keys() to parse the packets into a publickey
90 static int file_fetch_key_id(uint64_t keyid,
91 struct openpgp_publickey **publickey,
94 struct openpgp_packet_list *packets = NULL;
98 snprintf(keyfile, 1023, "%s/0x%" PRIX64, config.db_dir,
100 fd = open(keyfile, O_RDONLY); // | O_SHLOCK);
103 read_openpgp_stream(file_fetchchar, &fd, &packets, 0);
104 parse_keys(packets, publickey);
105 free_packet_list(packets);
114 * store_key - Takes a key and stores it.
115 * @publickey: A pointer to the public key to store.
116 * @intrans: If we're already in a transaction.
117 * @update: If true the key exists and should be updated.
119 * Again we just use the hex representation of the keyid as the filename
120 * to store the key to. We flatten the public key to a list of OpenPGP
121 * packets and then use write_openpgp_stream() to write the stream out to
124 static int file_store_key(struct openpgp_publickey *publickey, bool intrans,
127 struct openpgp_packet_list *packets = NULL;
128 struct openpgp_packet_list *list_end = NULL;
129 struct openpgp_publickey *next = NULL;
134 if (get_keyid(publickey, &keyid) != ONAK_E_OK) {
135 logthing(LOGTHING_ERROR, "Couldn't find key ID for key.");
138 snprintf(keyfile, 1023, "%s/0x%" PRIX64, config.db_dir,
140 fd = open(keyfile, O_WRONLY | O_CREAT, 0664); // | O_EXLOCK);
143 next = publickey -> next;
144 publickey -> next = NULL;
145 flatten_publickey(publickey, &packets, &list_end);
146 publickey -> next = next;
148 write_openpgp_stream(file_putchar, &fd, packets);
150 free_packet_list(packets);
158 * delete_key - Given a keyid delete the key from storage.
159 * @keyid: The keyid to delete.
160 * @intrans: If we're already in a transaction.
162 * This function deletes a public key from whatever storage mechanism we
163 * are using. Returns 0 if the key existed.
165 static int file_delete_key(uint64_t keyid, bool intrans)
169 snprintf(keyfile, 1023, "%s/0x%" PRIX64, config.db_dir,
172 return unlink(keyfile);
176 * fetch_key_text - Trys to find the keys that contain the supplied text.
177 * @search: The text to search for.
178 * @publickey: A pointer to a structure to return the key in.
180 * This function searches for the supplied text and returns the keys that
183 * TODO: Write for flat file access. Some sort of grep?
185 static int file_fetch_key_text(const char *search,
186 struct openpgp_publickey **publickey)
192 * iterate_keys - call a function once for each key in the db.
193 * @iterfunc: The function to call.
194 * @ctx: A context pointer
196 * Calls iterfunc once for each key in the database. ctx is passed
197 * unaltered to iterfunc. This function is intended to aid database dumps
198 * and statistic calculations.
200 * Returns the number of keys we iterated over.
202 static int file_iterate_keys(void (*iterfunc)(void *ctx,
203 struct openpgp_publickey *key), void *ctx)
206 struct openpgp_packet_list *packets = NULL;
207 struct openpgp_publickey *key = NULL;
211 struct dirent *curfile = NULL;
213 dir = opendir(config.db_dir);
216 while ((curfile = readdir(dir)) != NULL) {
217 if (curfile->d_name[0] == '0' &&
218 curfile->d_name[1] == 'x') {
219 snprintf(keyfile, 1023, "%s/%s",
222 fd = open(keyfile, O_RDONLY);
225 read_openpgp_stream(file_fetchchar,
229 parse_keys(packets, &key);
235 free_packet_list(packets);
251 * Include the basic keydb routines.
253 #define NEED_KEYID2UID 1
254 #define NEED_GETKEYSIGS 1
255 #define NEED_GETFULLKEYID 1
256 #define NEED_UPDATEKEYS 1
257 #define NEED_GET_FP 1
260 struct dbfuncs keydb_file_funcs = {
261 .initdb = file_initdb,
262 .cleanupdb = file_cleanupdb,
263 .starttrans = file_starttrans,
264 .endtrans = file_endtrans,
265 .fetch_key_id = file_fetch_key_id,
266 .fetch_key_fp = generic_fetch_key_fp,
267 .fetch_key_text = file_fetch_key_text,
268 .store_key = file_store_key,
269 .update_keys = generic_update_keys,
270 .delete_key = file_delete_key,
271 .getkeysigs = generic_getkeysigs,
272 .cached_getkeysigs = generic_cached_getkeysigs,
273 .keyid2uid = generic_keyid2uid,
274 .getfullkeyid = generic_getfullkeyid,
275 .iterate_keys = file_iterate_keys,