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(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);
100 static int keyring_fetch_key_fp(struct onak_dbctx *dbctx,
101 struct openpgp_fingerprint *fingerprint,
102 struct openpgp_publickey **publickey,
105 struct onak_keyring_dbctx *privctx =
106 (struct onak_keyring_dbctx *) dbctx->priv;
109 for (i = 0; i < privctx->count; i++) {
110 if (fingerprint_cmp(fingerprint, &privctx->keys[i].fp) == 0)
114 if (i < privctx->count) {
115 return keyring_fetch_key(privctx, i, publickey);
122 * fetch_key_id - Given a keyid fetch the key from storage.
123 * @keyid: The keyid to fetch.
124 * @publickey: A pointer to a structure to return the key in.
125 * @intrans: If we're already in a transaction.
127 static int keyring_fetch_key_id(struct onak_dbctx *dbctx,
129 struct openpgp_publickey **publickey,
132 struct onak_keyring_dbctx *privctx =
133 (struct onak_keyring_dbctx *) dbctx->priv;
137 for (i = 0; i < privctx->count; i++) {
138 if (fingerprint2keyid(&privctx->keys[i].fp) == keyid) {
139 if (keyring_fetch_key(privctx, i, publickey))
148 * store_key - Takes a key and stores it.
149 * @publickey: A pointer to the public key to store.
150 * @intrans: If we're already in a transaction.
151 * @update: If true the key exists and should be updated.
153 * We don't support storing keys into a keyring file.
155 static int keyring_store_key(struct onak_dbctx *dbctx,
156 struct openpgp_publickey *publickey, bool intrans,
163 * delete_key - Given a keyid delete the key from storage.
164 * @fp: The fingerprint of the key to delete.
165 * @intrans: If we're already in a transaction.
167 * We don't support removing keys from a keyring file.
169 static int keyring_delete_key(struct onak_dbctx *dbctx,
170 struct openpgp_fingerprint *fp, bool intrans)
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 keyring_fetch_key_text(struct onak_dbctx *dbctx,
187 struct openpgp_publickey **publickey)
193 * iterate_keys - call a function once for each key in the db.
194 * @iterfunc: The function to call.
195 * @ctx: A context pointer
197 * Calls iterfunc once for each key in the database. ctx is passed
198 * unaltered to iterfunc. This function is intended to aid database dumps
199 * and statistic calculations.
201 * Returns the number of keys we iterated over.
203 static int keyring_iterate_keys(struct onak_dbctx *dbctx,
204 void (*iterfunc)(void *ctx, struct openpgp_publickey *key),
207 struct onak_keyring_dbctx *privctx =
208 (struct onak_keyring_dbctx *) dbctx->priv;
209 struct openpgp_publickey *key = NULL;
213 for (i = 0; i < privctx->count; i++) {
214 if (keyring_fetch_key(privctx, i, &key)) {
224 static int keyring_update_keys(struct onak_dbctx *dbctx,
225 struct openpgp_publickey **keys,
226 struct keyarray *blacklist,
234 * Include the basic keydb routines.
236 #define NEED_KEYID2UID 1
237 #define NEED_GETKEYSIGS 1
240 static int keyring_parse_keys(struct onak_keyring_dbctx *privctx)
242 size_t len, pos, start, totlen;
243 struct openpgp_publickey *key;
246 if (privctx == NULL) {
250 if (privctx->file == NULL) {
255 * Walk the keyring file, noting the start of each public key and the
256 * total length of packets associated with it.
258 len = pos = start = totlen = 0;
259 while (((privctx->length - pos) > 5) && (privctx->file[pos] & 0x80)) {
260 if (privctx->file[pos] & 0x40) {
261 tag = privctx->file[pos] & 0x3F;
262 len = privctx->file[pos + 1];
263 if (len > 191 && len < 224) {
266 len += privctx->file[pos + 2];
268 len += 1; /* Header */
269 } else if (len > 223 && len < 255) {
271 } else if (len == 255) {
272 len = privctx->file[pos + 2];
274 len += privctx->file[pos + 3];
276 len += privctx->file[pos + 4];
278 len += privctx->file[pos + 5];
279 len += 4; /* Header */
281 len += 2; /* Header */
283 tag = (privctx->file[pos] & 0x3C) >> 2;
284 switch (privctx->file[pos] & 3) {
286 len = privctx->file[pos + 1];
287 len += 2; /* Header */
290 len = privctx->file[pos + 1];
292 len += privctx->file[pos + 2];
293 len += 3; /* Header */
296 len = privctx->file[pos + 1];
298 len += privctx->file[pos + 2];
300 len += privctx->file[pos + 3];
302 len += privctx->file[pos + 4];
303 len += 5; /* Header */
310 if (tag == OPENPGP_PACKET_PUBLICKEY) {
312 /* Expand the array of keys if necessary */
313 if (privctx->count == privctx->space) {
315 privctx->keys = realloc(privctx->keys,
317 sizeof(*privctx->keys));
320 /* TODO: Sort by fingerprint? */
321 privctx->keys[privctx->count].start =
322 &privctx->file[start];
323 privctx->keys[privctx->count].len = totlen;
327 * We need to fetch the key to calculate the
330 keyring_fetch_key(privctx, privctx->count - 1,
332 get_fingerprint(key->publickey,
333 &privctx->keys[privctx->count - 1].fp);
344 return privctx->count;
348 * cleanupdb - De-initialize the key database.
350 * This is just a no-op for flat file access.
352 static void keyring_cleanupdb(struct onak_dbctx *dbctx)
354 struct onak_keyring_dbctx *privctx =
355 (struct onak_keyring_dbctx *) dbctx->priv;
357 if (dbctx->priv != NULL) {
358 if (privctx->file != NULL) {
359 munmap(privctx->file, privctx->length);
372 * initdb - Initialize the key database.
374 * This is just a no-op for flat file access.
376 struct onak_dbctx *keydb_keyring_init(struct onak_db_config *dbcfg,
379 struct onak_keyring_dbctx *privctx;
380 struct onak_dbctx *dbctx;
384 dbctx = malloc(sizeof(struct onak_dbctx));
388 dbctx->config = dbcfg;
389 dbctx->priv = privctx = calloc(1, sizeof(*privctx));
390 if (privctx == NULL) {
395 privctx->keys = calloc(privctx->space, sizeof(*privctx->keys));
397 fd = open(dbcfg->location, O_RDONLY);
399 logthing(LOGTHING_CRITICAL,
400 "Couldn't open keyring file %s: %s (%d)",
404 keyring_cleanupdb(dbctx);
407 if (fstat(fd, &sb) < 0) {
408 logthing(LOGTHING_CRITICAL,
409 "Couldn't stat keyring file %s: %s (%d)",
414 keyring_cleanupdb(dbctx);
417 privctx->file = mmap(NULL, sb.st_size, PROT_READ, MAP_PRIVATE, fd, 0);
418 if (privctx->file == MAP_FAILED) {
419 logthing(LOGTHING_CRITICAL,
420 "Couldn't mmap keyring file %s: %s (%d)",
424 privctx->file = NULL;
426 keyring_cleanupdb(dbctx);
429 privctx->length = sb.st_size;
432 if (keyring_parse_keys(privctx) == 0) {
433 logthing(LOGTHING_CRITICAL,
434 "Failed to load any keys from keyring file %s",
436 keyring_cleanupdb(dbctx);
440 dbctx->cleanupdb = keyring_cleanupdb;
441 dbctx->starttrans = keyring_starttrans;
442 dbctx->endtrans = keyring_endtrans;
443 dbctx->fetch_key_id = keyring_fetch_key_id;
444 dbctx->fetch_key_fp = keyring_fetch_key_fp;
445 dbctx->fetch_key_text = keyring_fetch_key_text;
446 dbctx->store_key = keyring_store_key;
447 dbctx->update_keys = keyring_update_keys;
448 dbctx->delete_key = keyring_delete_key;
449 dbctx->getkeysigs = generic_getkeysigs;
450 dbctx->cached_getkeysigs = generic_cached_getkeysigs;
451 dbctx->keyid2uid = generic_keyid2uid;
452 dbctx->iterate_keys = keyring_iterate_keys;