2 * keydb_keyring.c - Routines to fetch keys from a PGP keyring file.
4 * Copyright 2019 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, see <https://www.gnu.org/licenses/>.
21 #include <sys/types.h>
32 #include "charfuncs.h"
36 #include "keystructs.h"
40 #include "onak-conf.h"
43 struct onak_keyring_dbctx {
49 struct openpgp_fingerprint fp;
56 * starttrans - Start a transaction.
58 * This is just a no-op for keyring file access.
60 static bool keyring_starttrans(struct onak_dbctx *dbctx)
66 * endtrans - End a transaction.
68 * This is just a no-op for keyring file access.
70 static void keyring_endtrans(struct onak_dbctx *dbctx)
76 * keyring_fetch_key - fetch a key given its index
78 static int keyring_fetch_key_idx(struct onak_keyring_dbctx *privctx,
80 struct openpgp_publickey **publickey)
82 struct openpgp_packet_list *packets = NULL;
83 struct buffer_ctx buf;
85 if (index > privctx->count)
88 buf.buffer = (char *) privctx->keys[index].start;
89 buf.size = privctx->keys[index].len;
92 read_openpgp_stream(buffer_fetchchar, &buf, &packets, 0);
93 parse_keys(packets, publickey);
94 free_packet_list(packets);
101 * We only index the primary fingerprint of the key, so will only return one
102 * key at most from this function.
104 static int keyring_fetch_key(struct onak_dbctx *dbctx,
105 struct openpgp_fingerprint *fingerprint,
106 struct openpgp_publickey **publickey,
109 struct onak_keyring_dbctx *privctx =
110 (struct onak_keyring_dbctx *) dbctx->priv;
113 for (i = 0; i < privctx->count; i++) {
114 if (fingerprint_cmp(fingerprint, &privctx->keys[i].fp) == 0)
118 if (i < privctx->count) {
119 return keyring_fetch_key_idx(privctx, i, publickey);
126 * fetch_key_id - Given a keyid fetch the key from storage.
127 * @keyid: The keyid to fetch.
128 * @publickey: A pointer to a structure to return the key in.
129 * @intrans: If we're already in a transaction.
131 static int keyring_fetch_key_id(struct onak_dbctx *dbctx,
133 struct openpgp_publickey **publickey,
136 struct onak_keyring_dbctx *privctx =
137 (struct onak_keyring_dbctx *) dbctx->priv;
141 for (i = 0; i < privctx->count; i++) {
142 if (fingerprint2keyid(&privctx->keys[i].fp) == keyid) {
143 if (keyring_fetch_key_idx(privctx, i, publickey))
152 * store_key - Takes a key and stores it.
153 * @publickey: A pointer to the public key to store.
154 * @intrans: If we're already in a transaction.
155 * @update: If true the key exists and should be updated.
157 * We don't support storing keys into a keyring file.
159 static int keyring_store_key(struct onak_dbctx *dbctx,
160 struct openpgp_publickey *publickey, bool intrans,
167 * delete_key - Given a keyid delete the key from storage.
168 * @fp: The fingerprint of the key to delete.
169 * @intrans: If we're already in a transaction.
171 * We don't support removing keys from a keyring file.
173 static int keyring_delete_key(struct onak_dbctx *dbctx,
174 struct openpgp_fingerprint *fp, bool intrans)
180 * fetch_key_text - Trys to find the keys that contain the supplied text.
181 * @search: The text to search for.
182 * @publickey: A pointer to a structure to return the key in.
184 * This function searches for the supplied text and returns the keys that
187 * TODO: Write for flat file access. Some sort of grep?
189 static int keyring_fetch_key_text(struct onak_dbctx *dbctx,
191 struct openpgp_publickey **publickey)
197 * iterate_keys - call a function once for each key in the db.
198 * @iterfunc: The function to call.
199 * @ctx: A context pointer
201 * Calls iterfunc once for each key in the database. ctx is passed
202 * unaltered to iterfunc. This function is intended to aid database dumps
203 * and statistic calculations.
205 * Returns the number of keys we iterated over.
207 static int keyring_iterate_keys(struct onak_dbctx *dbctx,
208 void (*iterfunc)(void *ctx, struct openpgp_publickey *key),
211 struct onak_keyring_dbctx *privctx =
212 (struct onak_keyring_dbctx *) dbctx->priv;
213 struct openpgp_publickey *key = NULL;
217 for (i = 0; i < privctx->count; i++) {
218 if (keyring_fetch_key_idx(privctx, i, &key)) {
228 static int keyring_update_keys(struct onak_dbctx *dbctx,
229 struct openpgp_publickey **keys,
230 struct keyarray *blacklist,
238 * Include the basic keydb routines.
240 #define NEED_KEYID2UID 1
241 #define NEED_GETKEYSIGS 1
244 static int keyring_parse_keys(struct onak_keyring_dbctx *privctx)
246 size_t len, pos, start, totlen;
247 struct openpgp_publickey *key;
250 if (privctx == NULL) {
254 if (privctx->file == NULL) {
259 * Walk the keyring file, noting the start of each public key and the
260 * total length of packets associated with it.
262 len = pos = start = totlen = 0;
263 while (((privctx->length - pos) > 5) && (privctx->file[pos] & 0x80)) {
264 if (privctx->file[pos] & 0x40) {
265 tag = privctx->file[pos] & 0x3F;
266 len = privctx->file[pos + 1];
267 if (len > 191 && len < 224) {
270 len += privctx->file[pos + 2];
272 len += 1; /* Header */
273 } else if (len > 223 && len < 255) {
275 } else if (len == 255) {
276 len = privctx->file[pos + 2];
278 len += privctx->file[pos + 3];
280 len += privctx->file[pos + 4];
282 len += privctx->file[pos + 5];
283 len += 4; /* Header */
285 len += 2; /* Header */
287 tag = (privctx->file[pos] & 0x3C) >> 2;
288 switch (privctx->file[pos] & 3) {
290 len = privctx->file[pos + 1];
291 len += 2; /* Header */
294 len = privctx->file[pos + 1];
296 len += privctx->file[pos + 2];
297 len += 3; /* Header */
300 len = privctx->file[pos + 1];
302 len += privctx->file[pos + 2];
304 len += privctx->file[pos + 3];
306 len += privctx->file[pos + 4];
307 len += 5; /* Header */
314 if (tag == OPENPGP_PACKET_PUBLICKEY) {
316 /* Expand the array of keys if necessary */
317 if (privctx->count == privctx->space) {
319 privctx->keys = realloc(privctx->keys,
321 sizeof(*privctx->keys));
324 /* TODO: Sort by fingerprint? */
325 privctx->keys[privctx->count].start =
326 &privctx->file[start];
327 privctx->keys[privctx->count].len = totlen;
331 * We need to fetch the key to calculate the
334 keyring_fetch_key_idx(privctx,
337 get_fingerprint(key->publickey,
338 &privctx->keys[privctx->count - 1].fp);
349 return privctx->count;
353 * cleanupdb - De-initialize the key database.
355 * This is just a no-op for flat file access.
357 static void keyring_cleanupdb(struct onak_dbctx *dbctx)
359 struct onak_keyring_dbctx *privctx =
360 (struct onak_keyring_dbctx *) dbctx->priv;
362 if (dbctx->priv != NULL) {
363 if (privctx->file != NULL) {
364 munmap(privctx->file, privctx->length);
377 * initdb - Initialize the key database.
379 * This is just a no-op for flat file access.
381 struct onak_dbctx *keydb_keyring_init(struct onak_db_config *dbcfg,
384 struct onak_keyring_dbctx *privctx;
385 struct onak_dbctx *dbctx;
389 dbctx = malloc(sizeof(struct onak_dbctx));
393 dbctx->config = dbcfg;
394 dbctx->priv = privctx = calloc(1, sizeof(*privctx));
395 if (privctx == NULL) {
400 privctx->keys = calloc(privctx->space, sizeof(*privctx->keys));
402 fd = open(dbcfg->location, O_RDONLY);
404 logthing(LOGTHING_CRITICAL,
405 "Couldn't open keyring file %s: %s (%d)",
409 keyring_cleanupdb(dbctx);
412 if (fstat(fd, &sb) < 0) {
413 logthing(LOGTHING_CRITICAL,
414 "Couldn't stat keyring file %s: %s (%d)",
419 keyring_cleanupdb(dbctx);
422 privctx->file = mmap(NULL, sb.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
423 if (privctx->file == MAP_FAILED) {
424 logthing(LOGTHING_CRITICAL,
425 "Couldn't mmap keyring file %s: %s (%d)",
429 privctx->file = NULL;
431 keyring_cleanupdb(dbctx);
434 privctx->length = sb.st_size;
437 if (keyring_parse_keys(privctx) == 0) {
438 logthing(LOGTHING_CRITICAL,
439 "Failed to load any keys from keyring file %s",
441 keyring_cleanupdb(dbctx);
445 dbctx->cleanupdb = keyring_cleanupdb;
446 dbctx->starttrans = keyring_starttrans;
447 dbctx->endtrans = keyring_endtrans;
448 dbctx->fetch_key = keyring_fetch_key;
449 /* We don't index by subkey fingerprint, so fallback to fetch_key */
450 dbctx->fetch_key_fp = keyring_fetch_key;
451 dbctx->fetch_key_id = keyring_fetch_key_id;
452 dbctx->fetch_key_text = keyring_fetch_key_text;
453 dbctx->store_key = keyring_store_key;
454 dbctx->update_keys = keyring_update_keys;
455 dbctx->delete_key = keyring_delete_key;
456 dbctx->getkeysigs = generic_getkeysigs;
457 dbctx->cached_getkeysigs = generic_cached_getkeysigs;
458 dbctx->keyid2uid = generic_keyid2uid;
459 dbctx->iterate_keys = keyring_iterate_keys;