2 * keydb_fs.c - Routines to store and fetch keys in a filesystem hierarchy.
4 * Copyright 2004 Daniel Silverstone <dsilvers@digital-scurf.org>
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>
32 #include "charfuncs.h"
33 #include "decodekey.h"
36 #include "keystructs.h"
39 #include "onak-conf.h"
44 /* Hack: We should really dynamically allocate our path buffers */
49 static int keydb_lockfile_fd = -1;
50 static bool keydb_lockfile_readonly;
52 /*****************************************************************************/
54 /* Helper functions */
56 #define FNV_offset_basis 2166136261ul
57 #define FNV_mixing_prime 16777619ul
59 static uint32_t calchash(uint8_t * ptr)
61 register uint32_t h = FNV_offset_basis;
62 register uint32_t p = FNV_mixing_prime;
63 register uint32_t n = strlen((char *) ptr);
64 register uint8_t *c = ptr;
69 return h ? h : 1; /* prevent a hash of zero happening */
73 static void keypath(char *buffer, size_t length, uint64_t _keyid)
75 uint64_t keyid = _keyid << 32;
76 snprintf(buffer, length, "%s/key/%02X/%02X/%08X/%016" PRIX64,
77 config.db_dir, (uint8_t) ((keyid >> 56) & 0xFF),
78 (uint8_t) ((keyid >> 48) & 0xFF),
79 (uint32_t) (keyid >> 32), _keyid);
82 static void keydir(char *buffer, size_t length, uint64_t _keyid)
84 uint64_t keyid = _keyid << 32;
85 snprintf(buffer, length, "%s/key/%02X/%02X/%08X", config.db_dir,
86 (uint8_t) ((keyid >> 56) & 0xFF),
87 (uint8_t) ((keyid >> 48) & 0xFF),
88 (uint32_t) (keyid >> 32));
91 static void prove_path_to(uint64_t keyid, char *what)
93 static char buffer[PATH_MAX];
94 snprintf(buffer, sizeof(buffer), "%s/%s", config.db_dir, what);
97 snprintf(buffer, sizeof(buffer), "%s/%s/%02X", config.db_dir, what,
98 (uint8_t) ((keyid >> 24) & 0xFF));
101 snprintf(buffer, sizeof(buffer), "%s/%s/%02X/%02X", config.db_dir,
103 (uint8_t) ((keyid >> 24) & 0xFF),
104 (uint8_t) ((keyid >> 16) & 0xFF));
107 snprintf(buffer, sizeof(buffer), "%s/%s/%02X/%02X/%08X", config.db_dir,
109 (uint8_t) ((keyid >> 24) & 0xFF),
110 (uint8_t) ((keyid >> 16) & 0xFF), (uint32_t) (keyid));
114 static void wordpath(char *buffer, size_t length, char *word, uint32_t hash,
117 snprintf(buffer, length, "%s/words/%02X/%02X/%08X/%s/%016" PRIX64,
118 config.db_dir, (uint8_t) ((hash >> 24) & 0xFF),
119 (uint8_t) ((hash >> 16) & 0xFF), hash, word, keyid);
122 static void worddir(char *buffer, size_t length, char *word, uint32_t hash)
124 snprintf(buffer, length, "%s/words/%02X/%02X/%08X/%s", config.db_dir,
125 (uint8_t) ((hash >> 24) & 0xFF),
126 (uint8_t) ((hash >> 16) & 0xFF), hash, word);
129 static void subkeypath(char *buffer, size_t length, uint64_t subkey,
132 snprintf(buffer, length, "%s/subkeys/%02X/%02X/%08X/%016" PRIX64,
134 (uint8_t) ((subkey >> 24) & 0xFF),
135 (uint8_t) ((subkey >> 16) & 0xFF),
136 (uint32_t) (subkey & 0xFFFFFFFF),
140 static void skshashpath(char *buffer, size_t length,
141 const struct skshash *hash)
143 snprintf(buffer, length, "%s/skshash/%02X/%02X/%02X%02X%02X%02X/"
144 "%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X%02X",
146 hash->hash[0], hash->hash[1],
147 hash->hash[0], hash->hash[1], hash->hash[2], hash->hash[3],
148 hash->hash[4], hash->hash[5], hash->hash[6], hash->hash[7],
149 hash->hash[8], hash->hash[9], hash->hash[10], hash->hash[11],
150 hash->hash[12], hash->hash[13], hash->hash[14],
153 static void subkeydir(char *buffer, size_t length, uint64_t subkey)
155 snprintf(buffer, length, "%s/subkeys/%02X/%02X/%08X",
157 (uint8_t) ((subkey >> 24) & 0xFF),
158 (uint8_t) ((subkey >> 16) & 0xFF),
159 (uint32_t) (subkey & 0xFFFFFFFF));
162 /*****************************************************************************/
165 * initdb - Initialize the key database.
167 static void fs_initdb(bool readonly)
169 char buffer[PATH_MAX];
171 keydb_lockfile_readonly = readonly;
173 snprintf(buffer, sizeof(buffer), "%s/.lock", config.db_dir);
175 if (access(config.db_dir, R_OK | W_OK | X_OK) == -1) {
176 if (errno != ENOENT) {
177 logthing(LOGTHING_CRITICAL,
178 "Unable to access keydb_fs root of '%s'. (%s)",
179 config.db_dir, strerror(errno));
180 exit(1); /* Lacking rwx on the key dir */
182 mkdir(config.db_dir, 0777);
183 keydb_lockfile_fd = open(buffer, O_RDWR | O_CREAT, 0600);
185 chdir(config.db_dir);
186 if (keydb_lockfile_fd == -1)
187 keydb_lockfile_fd = open(buffer,
188 (keydb_lockfile_readonly) ?
190 if (keydb_lockfile_fd == -1)
191 keydb_lockfile_fd = open(buffer, O_RDWR | O_CREAT, 0600);
192 if (keydb_lockfile_fd == -1) {
193 logthing(LOGTHING_CRITICAL,
194 "Unable to open lockfile '%s'. (%s)",
195 buffer, strerror(errno));
196 exit(1); /* Lacking rwx on the key dir */
201 * cleanupdb - De-initialize the key database.
203 static void fs_cleanupdb(void)
205 /* Mmmm nothing to do here? */
206 close(keydb_lockfile_fd);
210 * starttrans - Start a transaction.
212 static bool fs_starttrans(void)
214 struct flock lockstruct;
217 F_RDLCK | ((keydb_lockfile_readonly) ? 0 : F_WRLCK);
218 lockstruct.l_whence = SEEK_SET;
219 lockstruct.l_start = 0;
220 lockstruct.l_len = 1;
222 while (fcntl(keydb_lockfile_fd, F_SETLK, &lockstruct) == -1) {
223 if (remaining-- == 0)
224 return false; /* Hope to hell that noodles DTRT */
231 * endtrans - End a transaction.
233 static void fs_endtrans(void)
235 struct flock lockstruct;
237 lockstruct.l_type = F_UNLCK;
238 lockstruct.l_whence = SEEK_SET;
239 lockstruct.l_start = 0;
240 lockstruct.l_len = 1;
241 fcntl(keydb_lockfile_fd, F_SETLK, &lockstruct);
244 static uint64_t fs_getfullkeyid(uint64_t keyid)
246 static char buffer[PATH_MAX];
248 struct dirent *de = NULL;
251 keydir(buffer, sizeof(buffer), keyid);
257 if (de && de->d_name[0] != '.') {
258 ret = strtoull(de->d_name, NULL, 16);
260 } while (de && de->d_name[0] == '.');
265 subkeydir(buffer, sizeof(buffer), keyid);
271 if (de && de->d_name[0] != '.') {
272 ret = strtoull(de->d_name, NULL, 16);
274 } while (de && de->d_name[0] == '.');
283 * fetch_key - Given a keyid fetch the key from storage.
284 * @keyid: The keyid to fetch.
285 * @publickey: A pointer to a structure to return the key in.
286 * @intrans: If we're already in a transaction.
288 static int fs_fetch_key_id(uint64_t keyid,
289 struct openpgp_publickey **publickey,
292 static char buffer[PATH_MAX];
294 struct openpgp_packet_list *packets = NULL;
299 if ((keyid >> 32) == 0)
300 keyid = fs_getfullkeyid(keyid);
302 keypath(buffer, sizeof(buffer), keyid);
303 if ((fd = open(buffer, O_RDONLY)) != -1) {
304 /* File is present, load it in... */
305 read_openpgp_stream(file_fetchchar, &fd, &packets, 0);
306 parse_keys(packets, publickey);
307 free_packet_list(packets);
319 * store_key - Takes a key and stores it.
320 * @publickey: A pointer to the public key to store.
321 * @intrans: If we're already in a transaction.
322 * @update: If true the key exists and should be updated.
324 static int fs_store_key(struct openpgp_publickey *publickey, bool intrans,
327 static char buffer[PATH_MAX];
328 static char wbuffer[PATH_MAX];
330 struct openpgp_packet_list *packets = NULL;
331 struct openpgp_packet_list *list_end = NULL;
332 struct openpgp_publickey *next = NULL;
334 struct ll *wordlist = NULL, *wl = NULL;
336 uint64_t *subkeyids = NULL;
340 if (get_keyid(publickey, &keyid) != ONAK_E_OK) {
341 logthing(LOGTHING_ERROR, "Couldn't find key ID for key.");
348 prove_path_to(keyid, "key");
349 keypath(buffer, sizeof(buffer), keyid);
352 open(buffer, O_WRONLY | (update ? O_TRUNC : O_CREAT),
354 next = publickey->next;
355 publickey->next = NULL;
356 flatten_publickey(publickey, &packets, &list_end);
357 publickey->next = next;
359 write_openpgp_stream(file_putchar, &fd, packets);
361 free_packet_list(packets);
367 wl = wordlist = makewordlistfromkey(wordlist, publickey);
369 uint32_t hash = calchash((uint8_t *) (wl->object));
370 prove_path_to(hash, "words");
372 worddir(wbuffer, sizeof(wbuffer), wl->object, hash);
373 mkdir(wbuffer, 0777);
374 wordpath(wbuffer, sizeof(wbuffer), wl->object, hash,
376 link(buffer, wbuffer);
380 llfree(wordlist, free);
382 subkeyids = keysubkeys(publickey);
384 while (subkeyids != NULL && subkeyids[i] != 0) {
385 prove_path_to(subkeyids[i], "subkeys");
387 subkeydir(wbuffer, sizeof(wbuffer), subkeyids[i]);
388 mkdir(wbuffer, 0777);
389 subkeypath(wbuffer, sizeof(wbuffer), subkeyids[i],
391 link(buffer, wbuffer);
395 if (subkeyids != NULL) {
400 get_skshash(publickey, &hash);
401 hashid = (hash.hash[0] << 24) + (hash.hash[1] << 16) +
402 (hash.hash[2] << 8) + hash.hash[3];
403 prove_path_to(hashid, "skshash");
404 skshashpath(wbuffer, sizeof(wbuffer), &hash);
405 link(buffer, wbuffer);
414 * delete_key - Given a keyid delete the key from storage.
415 * @keyid: The keyid to delete.
416 * @intrans: If we're already in a transaction.
418 static int fs_delete_key(uint64_t keyid, bool intrans)
420 static char buffer[PATH_MAX];
422 struct openpgp_publickey *pk = NULL;
424 struct ll *wordlist = NULL, *wl = NULL;
425 uint64_t *subkeyids = NULL;
428 if ((keyid >> 32) == 0)
429 keyid = fs_getfullkeyid(keyid);
434 ret = fs_fetch_key_id(keyid, &pk, true);
437 logthing(LOGTHING_DEBUG, "Wordlist for key %016" PRIX64,
439 wl = wordlist = makewordlistfromkey(wordlist, pk);
440 logthing(LOGTHING_DEBUG,
441 "Wordlist for key %016" PRIX64 " done", keyid);
443 uint32_t hash = calchash((uint8_t *) (wl->object));
444 prove_path_to(hash, "words");
446 wordpath(buffer, sizeof(buffer), wl->object, hash,
453 subkeyids = keysubkeys(pk);
455 while (subkeyids != NULL && subkeyids[i] != 0) {
456 prove_path_to(subkeyids[i], "subkeys");
458 subkeypath(buffer, sizeof(buffer), subkeyids[i],
464 if (subkeyids != NULL) {
469 get_skshash(pk, &hash);
470 skshashpath(buffer, sizeof(buffer), &hash);
474 keypath(buffer, sizeof(buffer), keyid);
482 static struct ll *internal_get_key_by_word(char *word, struct ll *mct)
484 struct ll *keys = NULL;
486 char buffer[PATH_MAX];
487 uint32_t hash = calchash((uint8_t *) (word));
490 worddir(buffer, sizeof(buffer), word, hash);
492 logthing(LOGTHING_DEBUG, "Scanning for word %s in dir %s", word,
497 if (de && de->d_name[0] != '.') {
499 || (llfind(mct, de->d_name,
500 (int (*)(const void *, const void *))
503 logthing(LOGTHING_DEBUG,
504 "Found %s // %s", word,
518 * fetch_key_text - Trys to find the keys that contain the supplied text.
519 * @search: The text to search for.
520 * @publickey: A pointer to a structure to return the key in.
522 static int fs_fetch_key_text(const char *search,
523 struct openpgp_publickey **publickey)
525 struct ll *wordlist = NULL, *wl = NULL;
526 struct ll *keylist = NULL;
527 char *searchtext = NULL;
530 logthing(LOGTHING_DEBUG, "Search was '%s'", search);
532 searchtext = strdup(search);
533 wl = wordlist = makewordlist(wordlist, searchtext);
535 keylist = internal_get_key_by_word(wordlist->object, NULL);
538 llfree(wordlist, NULL);
547 internal_get_key_by_word(wl->object, keylist);
549 llfree(wordlist, NULL);
550 llfree(keylist, free);
555 llfree(keylist, free);
560 llfree(wordlist, NULL);
562 /* Now add the keys... */
565 logthing(LOGTHING_DEBUG, "Adding key: %s", wl->object);
567 fs_fetch_key_id(strtoull(wl->object, NULL, 16), publickey,
569 if (addedkeys >= config.maxkeys)
574 llfree(keylist, free);
582 * fetch_key_skshash - Given an SKS hash fetch the key from storage.
583 * @hash: The hash to fetch.
584 * @publickey: A pointer to a structure to return the key in.
585 * @intrans: If we're already in a transaction.
587 static int fs_fetch_key_skshash(const struct skshash *hash,
588 struct openpgp_publickey **publickey)
590 static char buffer[PATH_MAX];
592 struct openpgp_packet_list *packets = NULL;
594 skshashpath(buffer, sizeof(buffer), hash);
595 if ((fd = open(buffer, O_RDONLY)) != -1) {
596 read_openpgp_stream(file_fetchchar, &fd, &packets, 0);
597 parse_keys(packets, publickey);
598 free_packet_list(packets);
608 * iterate_keys - call a function once for each key in the db.
609 * @iterfunc: The function to call.
610 * @ctx: A context pointer
612 * Calls iterfunc once for each key in the database. ctx is passed
613 * unaltered to iterfunc. This function is intended to aid database dumps
614 * and statistic calculations.
616 * Returns the number of keys we iterated over.
618 static int fs_iterate_keys(void (*iterfunc)(void *ctx,
619 struct openpgp_publickey *key), void *ctx)
625 * Include the basic keydb routines.
627 #define NEED_KEYID2UID 1
628 #define NEED_GETKEYSIGS 1
629 #define NEED_UPDATEKEYS 1
630 #define NEED_GET_FP 1
633 struct dbfuncs keydb_fs_funcs = {
635 .cleanupdb = fs_cleanupdb,
636 .starttrans = fs_starttrans,
637 .endtrans = fs_endtrans,
638 .fetch_key_id = fs_fetch_key_id,
639 .fetch_key_fp = generic_fetch_key_fp,
640 .fetch_key_text = fs_fetch_key_text,
641 .fetch_key_skshash = fs_fetch_key_skshash,
642 .store_key = fs_store_key,
643 .update_keys = generic_update_keys,
644 .delete_key = fs_delete_key,
645 .getkeysigs = generic_getkeysigs,
646 .cached_getkeysigs = generic_cached_getkeysigs,
647 .keyid2uid = generic_keyid2uid,
648 .getfullkeyid = fs_getfullkeyid,
649 .iterate_keys = fs_iterate_keys,