2 * keydb_db4.c - Routines to store and fetch keys in a DB4 database.
4 * Jonathan McDowell <noodles@earth.li>
6 * Copyright 2002-2004 Project Purple
21 #include "charfuncs.h"
25 #include "decodekey.h"
26 #include "keystructs.h"
29 #include "onak-conf.h"
34 * dbenv - our database environment.
36 static DB_ENV *dbenv = NULL;
39 * numdb - The number of database files we have.
41 static int numdbs = 16;
44 * dbconn - our connections to the key database files.
46 static DB **dbconns = NULL;
49 * worddb - our connection to the word database.
51 static DB *worddb = NULL;
54 * id32db - our connection to the 32bit ID database.
56 static DB *id32db = NULL;
59 * txn - our current transaction id.
61 static DB_TXN *txn = NULL;
63 DB *keydb(uint64_t keyid)
69 return(dbconns[keytrun % numdbs]);
73 * starttrans - Start a transaction.
75 * Start a transaction. Intended to be used if we're about to perform many
76 * operations on the database to help speed it all up, or if we want
77 * something to only succeed if all relevant operations are successful.
79 static bool db4_starttrans(void)
83 log_assert(dbenv != NULL);
84 log_assert(txn == NULL);
86 ret = dbenv->txn_begin(dbenv,
87 NULL, /* No parent transaction */
91 logthing(LOGTHING_CRITICAL,
92 "Error starting transaction: %s",
101 * endtrans - End a transaction.
103 * Ends a transaction.
105 static void db4_endtrans(void)
109 log_assert(dbenv != NULL);
110 log_assert(txn != NULL);
112 ret = txn->commit(txn,
115 logthing(LOGTHING_CRITICAL,
116 "Error ending transaction: %s",
126 * cleanupdb - De-initialize the key database.
128 * This function should be called upon program exit to allow the DB to
129 * cleanup after itself.
131 static void db4_cleanupdb(void)
136 dbenv->txn_checkpoint(dbenv, 0, 0, 0);
137 if (id32db != NULL) {
138 id32db->close(id32db, 0);
141 if (worddb != NULL) {
142 worddb->close(worddb, 0);
145 for (i = 0; i < numdbs; i++) {
146 if (dbconns[i] != NULL) {
147 dbconns[i]->close(dbconns[i], 0);
153 dbenv->close(dbenv, 0);
159 * initdb - Initialize the key database.
161 * This function should be called before any of the other functions in
162 * this file are called in order to allow the DB to be initialized ready
165 static void db4_initdb(bool readonly)
173 snprintf(buf, sizeof(buf) - 1, "%s/num_keydb", config.db_dir);
174 numdb = fopen(buf, "r");
176 if (fgets(buf, sizeof(buf), numdb) != NULL) {
180 } else if (!readonly) {
181 logthing(LOGTHING_ERROR, "Couldn't open num_keydb: %s",
183 numdb = fopen(buf, "w");
185 fprintf(numdb, "%d", numdbs);
188 logthing(LOGTHING_ERROR,
189 "Couldn't write num_keydb: %s",
194 dbconns = malloc(sizeof (DB *) * numdbs);
195 if (dbconns == NULL) {
196 logthing(LOGTHING_CRITICAL,
197 "Couldn't allocate memory for dbconns");
202 ret = db_env_create(&dbenv, 0);
204 logthing(LOGTHING_CRITICAL,
205 "db_env_create: %s", db_strerror(ret));
210 * Enable deadlock detection so that we don't block indefinitely on
211 * anything. What we really want is simple 2 state locks, but I'm not
212 * sure how to make the standard DB functions do that yet.
215 ret = dbenv->set_lk_detect(dbenv, DB_LOCK_DEFAULT);
217 logthing(LOGTHING_CRITICAL,
218 "db_env_create: %s", db_strerror(ret));
223 ret = dbenv->open(dbenv, config.db_dir,
224 DB_INIT_LOG | DB_INIT_MPOOL | DB_INIT_LOCK |
229 logthing(LOGTHING_CRITICAL,
230 "Error opening db environment: %s (%s)",
233 dbenv->close(dbenv, 0);
241 for (i = 0; !ret && i < numdbs; i++) {
242 ret = db_create(&dbconns[i], dbenv, 0);
244 logthing(LOGTHING_CRITICAL,
245 "db_create: %s", db_strerror(ret));
249 snprintf(buf, 1023, "keydb.%d.db", i);
254 ret = dbconns[i]->open(dbconns[i],
262 logthing(LOGTHING_CRITICAL,
263 "Error opening key database:"
274 ret = db_create(&worddb, dbenv, 0);
276 logthing(LOGTHING_CRITICAL, "db_create: %s",
282 ret = worddb->set_flags(worddb, DB_DUP);
286 ret = worddb->open(worddb, txn, "worddb", "worddb", DB_BTREE,
290 logthing(LOGTHING_CRITICAL,
291 "Error opening word database: %s (%s)",
298 ret = db_create(&id32db, dbenv, 0);
300 logthing(LOGTHING_CRITICAL, "db_create: %s",
306 ret = id32db->set_flags(id32db, DB_DUP);
310 ret = id32db->open(id32db, txn, "id32db", "id32db", DB_HASH,
314 logthing(LOGTHING_CRITICAL,
315 "Error opening id32 database: %s (%s)",
327 logthing(LOGTHING_CRITICAL,
328 "Error opening database; exiting");
336 * getfullkeyid - Maps a 32bit key id to a 64bit one.
337 * @keyid: The 32bit keyid.
339 * This function maps a 32bit key id to the full 64bit one. It returns the
340 * full keyid. If the key isn't found a keyid of 0 is returned.
342 static uint64_t db4_getfullkeyid(uint64_t keyid)
346 uint32_t shortkeyid = 0;
349 if (keyid < 0x100000000LL) {
350 ret = id32db->cursor(id32db,
355 shortkeyid = keyid & 0xFFFFFFFF;
357 memset(&key, 0, sizeof(key));
358 memset(&data, 0, sizeof(data));
359 key.data = &shortkeyid;
360 key.size = sizeof(shortkeyid);
361 data.flags = DB_DBT_MALLOC;
363 ret = cursor->c_get(cursor,
369 keyid = *(uint64_t *) data.data;
371 if (data.data != NULL) {
377 ret = cursor->c_close(cursor);
385 * fetch_key - Given a keyid fetch the key from storage.
386 * @keyid: The keyid to fetch.
387 * @publickey: A pointer to a structure to return the key in.
388 * @intrans: If we're already in a transaction.
390 * We use the hex representation of the keyid as the filename to fetch the
391 * key from. The key is stored in the file as a binary OpenPGP stream of
392 * packets, so we can just use read_openpgp_stream() to read the packets
393 * in and then parse_keys() to parse the packets into a publickey
396 static int db4_fetch_key(uint64_t keyid, struct openpgp_publickey **publickey,
399 struct openpgp_packet_list *packets = NULL;
403 struct buffer_ctx fetchbuf;
405 if (keyid < 0x100000000LL) {
406 keyid = db4_getfullkeyid(keyid);
409 memset(&key, 0, sizeof(key));
410 memset(&data, 0, sizeof(data));
415 key.size = sizeof(keyid);
422 ret = keydb(keyid)->get(keydb(keyid),
429 fetchbuf.buffer = data.data;
431 fetchbuf.size = data.size;
432 read_openpgp_stream(buffer_fetchchar, &fetchbuf,
434 parse_keys(packets, publickey);
435 free_packet_list(packets);
438 } else if (ret != DB_NOTFOUND) {
439 logthing(LOGTHING_ERROR,
440 "Problem retrieving key: %s",
451 int worddb_cmp(const void *d1, const void *d2)
453 return memcmp(d1, d2, 12);
457 * fetch_key_text - Trys to find the keys that contain the supplied text.
458 * @search: The text to search for.
459 * @publickey: A pointer to a structure to return the key in.
461 * This function searches for the supplied text and returns the keys that
464 static int db4_fetch_key_text(const char *search,
465 struct openpgp_publickey **publickey)
473 char *searchtext = NULL;
474 struct ll *wordlist = NULL;
475 struct ll *curword = NULL;
476 struct keyarray keylist = { NULL, 0, 0 };
477 struct keyarray newkeylist = { NULL, 0, 0 };
481 searchtext = strdup(search);
482 wordlist = makewordlist(wordlist, searchtext);
484 for (curword = wordlist; curword != NULL; curword = curword->next) {
487 ret = worddb->cursor(worddb,
492 memset(&key, 0, sizeof(key));
493 memset(&data, 0, sizeof(data));
494 key.data = curword->object;
495 key.size = strlen(curword->object);
496 data.flags = DB_DBT_MALLOC;
497 ret = cursor->c_get(cursor,
501 while (ret == 0 && strncmp(key.data, curword->object,
503 ((char *) curword->object)[key.size] == 0) {
505 for (i = 4; i < 12; i++) {
507 keyid += ((unsigned char *)
512 * Only add the keys containing this word if this is
513 * our first pass (ie we have no existing key list),
514 * or the key contained a previous word.
516 if (firstpass || array_find(&keylist, keyid)) {
517 array_add(&newkeylist, keyid);
523 ret = cursor->c_get(cursor,
528 array_free(&keylist);
529 keylist = newkeylist;
530 newkeylist.keys = NULL;
531 newkeylist.count = newkeylist.size = 0;
532 if (data.data != NULL) {
536 ret = cursor->c_close(cursor);
541 llfree(wordlist, NULL);
545 for (i = 0; i < keylist.count; i++) {
546 numkeys += db4_fetch_key(keylist.keys[i],
550 array_free(&keylist);
560 * delete_key - Given a keyid delete the key from storage.
561 * @keyid: The keyid to delete.
562 * @intrans: If we're already in a transaction.
564 * This function deletes a public key from whatever storage mechanism we
565 * are using. Returns 0 if the key existed.
567 static int db4_delete_key(uint64_t keyid, bool intrans)
569 struct openpgp_publickey *publickey = NULL;
572 uint32_t shortkeyid = 0;
573 uint64_t *subkeyids = NULL;
577 char *primary = NULL;
578 unsigned char worddb_data[12];
579 struct ll *wordlist = NULL;
580 struct ll *curword = NULL;
581 bool deadlock = false;
587 db4_fetch_key(keyid, &publickey, true);
590 * Walk through the uids removing the words from the worddb.
592 if (publickey != NULL) {
593 uids = keyuids(publickey, &primary);
596 for (i = 0; ret == 0 && uids[i] != NULL; i++) {
597 wordlist = makewordlist(wordlist, uids[i]);
600 ret = worddb->cursor(worddb,
605 for (curword = wordlist; curword != NULL && !deadlock;
606 curword = curword->next) {
607 memset(&key, 0, sizeof(key));
608 memset(&data, 0, sizeof(data));
609 key.data = curword->object;
610 key.size = strlen(key.data);
611 data.data = worddb_data;
612 data.size = sizeof(worddb_data);
615 * Our data is the key creation time followed by the
618 worddb_data[ 0] = publickey->publickey->data[1];
619 worddb_data[ 1] = publickey->publickey->data[2];
620 worddb_data[ 2] = publickey->publickey->data[3];
621 worddb_data[ 3] = publickey->publickey->data[4];
622 worddb_data[ 4] = (keyid >> 56) & 0xFF;
623 worddb_data[ 5] = (keyid >> 48) & 0xFF;
624 worddb_data[ 6] = (keyid >> 40) & 0xFF;
625 worddb_data[ 7] = (keyid >> 32) & 0xFF;
626 worddb_data[ 8] = (keyid >> 24) & 0xFF;
627 worddb_data[ 9] = (keyid >> 16) & 0xFF;
628 worddb_data[10] = (keyid >> 8) & 0xFF;
629 worddb_data[11] = keyid & 0xFF;
631 ret = cursor->c_get(cursor,
637 ret = cursor->c_del(cursor, 0);
639 logthing(LOGTHING_ERROR,
640 "Problem deleting word: %s",
646 logthing(LOGTHING_ERROR,
647 "Problem deleting word: %s",
649 if (ret == DB_LOCK_DEADLOCK) {
654 ret = cursor->c_close(cursor);
658 * Free our UID and word lists.
660 llfree(wordlist, NULL);
661 for (i = 0; uids[i] != NULL; i++) {
667 free_publickey(publickey);
672 ret = id32db->cursor(id32db,
677 shortkeyid = keyid & 0xFFFFFFFF;
679 memset(&key, 0, sizeof(key));
680 memset(&data, 0, sizeof(data));
681 key.data = &shortkeyid;
682 key.size = sizeof(shortkeyid);
684 data.size = sizeof(keyid);
686 ret = cursor->c_get(cursor,
692 ret = cursor->c_del(cursor, 0);
694 logthing(LOGTHING_ERROR,
695 "Problem deleting short keyid: %s",
701 logthing(LOGTHING_ERROR,
702 "Problem deleting short keyid: %s",
704 if (ret == DB_LOCK_DEADLOCK) {
709 subkeyids = keysubkeys(publickey);
711 while (subkeyids != NULL && subkeyids[i] != 0) {
712 shortkeyid = subkeyids[i++] & 0xFFFFFFFF;
714 memset(&key, 0, sizeof(key));
715 memset(&data, 0, sizeof(data));
716 key.data = &shortkeyid;
717 key.size = sizeof(shortkeyid);
719 data.size = sizeof(keyid);
721 ret = cursor->c_get(cursor,
727 ret = cursor->c_del(cursor, 0);
729 logthing(LOGTHING_ERROR,
730 "Problem deleting short"
737 logthing(LOGTHING_ERROR,
738 "Problem deleting short keyid: %s",
740 if (ret == DB_LOCK_DEADLOCK) {
745 if (subkeyids != NULL) {
750 ret = cursor->c_close(cursor);
756 key.size = sizeof(keyid);
758 keydb(keyid)->del(keydb(keyid),
768 return deadlock ? (-1) : (ret == DB_NOTFOUND);
772 * store_key - Takes a key and stores it.
773 * @publickey: A pointer to the public key to store.
774 * @intrans: If we're already in a transaction.
775 * @update: If true the key exists and should be updated.
777 * Again we just use the hex representation of the keyid as the filename
778 * to store the key to. We flatten the public key to a list of OpenPGP
779 * packets and then use write_openpgp_stream() to write the stream out to
780 * the file. If update is true then we delete the old key first, otherwise
781 * we trust that it doesn't exist.
783 static int db4_store_key(struct openpgp_publickey *publickey, bool intrans,
786 struct openpgp_packet_list *packets = NULL;
787 struct openpgp_packet_list *list_end = NULL;
788 struct openpgp_publickey *next = NULL;
791 struct buffer_ctx storebuf;
795 uint32_t shortkeyid = 0;
796 uint64_t *subkeyids = NULL;
798 char *primary = NULL;
799 unsigned char worddb_data[12];
800 struct ll *wordlist = NULL;
801 struct ll *curword = NULL;
802 bool deadlock = false;
804 keyid = get_keyid(publickey);
811 * Delete the key if we already have it.
813 * TODO: Can we optimize this perhaps? Possibly when other data is
814 * involved as well? I suspect this is easiest and doesn't make a lot
815 * of difference though - the largest chunk of data is the keydata and
816 * it definitely needs updated.
819 deadlock = (db4_delete_key(keyid, true) == -1);
823 * Convert the key to a flat set of binary data.
826 next = publickey->next;
827 publickey->next = NULL;
828 flatten_publickey(publickey, &packets, &list_end);
829 publickey->next = next;
832 storebuf.size = 8192;
833 storebuf.buffer = malloc(8192);
835 write_openpgp_stream(buffer_putchar, &storebuf, packets);
838 * Now we have the key data store it in the DB; the keyid is
841 memset(&key, 0, sizeof(key));
842 memset(&data, 0, sizeof(data));
844 key.size = sizeof(keyid);
845 data.size = storebuf.offset;
846 data.data = storebuf.buffer;
848 ret = keydb(keyid)->put(keydb(keyid),
854 logthing(LOGTHING_ERROR,
855 "Problem storing key: %s",
857 if (ret == DB_LOCK_DEADLOCK) {
862 free(storebuf.buffer);
863 storebuf.buffer = NULL;
867 free_packet_list(packets);
872 * Walk through our uids storing the words into the db with the keyid.
875 uids = keyuids(publickey, &primary);
878 for (i = 0; ret == 0 && uids[i] != NULL; i++) {
879 wordlist = makewordlist(wordlist, uids[i]);
882 for (curword = wordlist; curword != NULL && !deadlock;
883 curword = curword->next) {
884 memset(&key, 0, sizeof(key));
885 memset(&data, 0, sizeof(data));
886 key.data = curword->object;
887 key.size = strlen(key.data);
888 data.data = worddb_data;
889 data.size = sizeof(worddb_data);
892 * Our data is the key creation time followed by the
895 worddb_data[ 0] = publickey->publickey->data[1];
896 worddb_data[ 1] = publickey->publickey->data[2];
897 worddb_data[ 2] = publickey->publickey->data[3];
898 worddb_data[ 3] = publickey->publickey->data[4];
899 worddb_data[ 4] = (keyid >> 56) & 0xFF;
900 worddb_data[ 5] = (keyid >> 48) & 0xFF;
901 worddb_data[ 6] = (keyid >> 40) & 0xFF;
902 worddb_data[ 7] = (keyid >> 32) & 0xFF;
903 worddb_data[ 8] = (keyid >> 24) & 0xFF;
904 worddb_data[ 9] = (keyid >> 16) & 0xFF;
905 worddb_data[10] = (keyid >> 8) & 0xFF;
906 worddb_data[11] = keyid & 0xFF;
907 ret = worddb->put(worddb,
913 logthing(LOGTHING_ERROR,
914 "Problem storing word: %s",
916 if (ret == DB_LOCK_DEADLOCK) {
923 * Free our UID and word lists.
925 llfree(wordlist, NULL);
926 for (i = 0; uids[i] != NULL; i++) {
935 * Write the truncated 32 bit keyid so we can lookup the full id for
939 shortkeyid = keyid & 0xFFFFFFFF;
941 memset(&key, 0, sizeof(key));
942 memset(&data, 0, sizeof(data));
943 key.data = &shortkeyid;
944 key.size = sizeof(shortkeyid);
946 data.size = sizeof(keyid);
948 ret = id32db->put(id32db,
954 logthing(LOGTHING_ERROR,
955 "Problem storing short keyid: %s",
957 if (ret == DB_LOCK_DEADLOCK) {
964 subkeyids = keysubkeys(publickey);
966 while (subkeyids != NULL && subkeyids[i] != 0) {
967 shortkeyid = subkeyids[i++] & 0xFFFFFFFF;
969 memset(&key, 0, sizeof(key));
970 memset(&data, 0, sizeof(data));
971 key.data = &shortkeyid;
972 key.size = sizeof(shortkeyid);
974 data.size = sizeof(keyid);
976 ret = id32db->put(id32db,
982 logthing(LOGTHING_ERROR,
983 "Problem storing short keyid: %s",
985 if (ret == DB_LOCK_DEADLOCK) {
990 if (subkeyids != NULL) {
1000 return deadlock ? -1 : 0 ;
1004 * iterate_keys - call a function once for each key in the db.
1005 * @iterfunc: The function to call.
1006 * @ctx: A context pointer
1008 * Calls iterfunc once for each key in the database. ctx is passed
1009 * unaltered to iterfunc. This function is intended to aid database dumps
1010 * and statistic calculations.
1012 * Returns the number of keys we iterated over.
1014 static int db4_iterate_keys(void (*iterfunc)(void *ctx,
1015 struct openpgp_publickey *key), void *ctx)
1022 struct buffer_ctx fetchbuf;
1023 struct openpgp_packet_list *packets = NULL;
1024 struct openpgp_publickey *key = NULL;
1026 for (i = 0; i < numdbs; i++) {
1027 ret = dbconns[i]->cursor(dbconns[i],
1032 memset(&dbkey, 0, sizeof(dbkey));
1033 memset(&data, 0, sizeof(data));
1034 ret = cursor->c_get(cursor, &dbkey, &data, DB_NEXT);
1036 fetchbuf.buffer = data.data;
1037 fetchbuf.offset = 0;
1038 fetchbuf.size = data.size;
1039 read_openpgp_stream(buffer_fetchchar, &fetchbuf,
1041 parse_keys(packets, &key);
1045 free_publickey(key);
1047 free_packet_list(packets);
1050 memset(&dbkey, 0, sizeof(dbkey));
1051 memset(&data, 0, sizeof(data));
1052 ret = cursor->c_get(cursor, &dbkey, &data,
1056 if (ret != DB_NOTFOUND) {
1057 logthing(LOGTHING_ERROR,
1058 "Problem reading key: %s",
1062 ret = cursor->c_close(cursor);
1070 * Include the basic keydb routines.
1072 #define NEED_GETKEYSIGS 1
1073 #define NEED_KEYID2UID 1
1074 #define NEED_UPDATEKEYS 1
1077 struct dbfuncs keydb_db4_funcs = {
1078 .initdb = db4_initdb,
1079 .cleanupdb = db4_cleanupdb,
1080 .starttrans = db4_starttrans,
1081 .endtrans = db4_endtrans,
1082 .fetch_key = db4_fetch_key,
1083 .fetch_key_text = db4_fetch_key_text,
1084 .store_key = db4_store_key,
1085 .update_keys = generic_update_keys,
1086 .delete_key = db4_delete_key,
1087 .getkeysigs = generic_getkeysigs,
1088 .cached_getkeysigs = generic_cached_getkeysigs,
1089 .keyid2uid = generic_keyid2uid,
1090 .getfullkeyid = db4_getfullkeyid,
1091 .iterate_keys = db4_iterate_keys,