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 * fetch_key - Given a keyid fetch the key from storage.
337 * @keyid: The keyid to fetch.
338 * @publickey: A pointer to a structure to return the key in.
339 * @intrans: If we're already in a transaction.
341 * We use the hex representation of the keyid as the filename to fetch the
342 * key from. The key is stored in the file as a binary OpenPGP stream of
343 * packets, so we can just use read_openpgp_stream() to read the packets
344 * in and then parse_keys() to parse the packets into a publickey
347 static int db4_fetch_key(uint64_t keyid, struct openpgp_publickey **publickey,
350 struct openpgp_packet_list *packets = NULL;
354 struct buffer_ctx fetchbuf;
356 if (keyid < 0x100000000LL) {
357 keyid = getfullkeyid(keyid);
360 memset(&key, 0, sizeof(key));
361 memset(&data, 0, sizeof(data));
366 key.size = sizeof(keyid);
373 ret = keydb(keyid)->get(keydb(keyid),
380 fetchbuf.buffer = data.data;
382 fetchbuf.size = data.size;
383 read_openpgp_stream(buffer_fetchchar, &fetchbuf,
385 parse_keys(packets, publickey);
386 free_packet_list(packets);
389 } else if (ret != DB_NOTFOUND) {
390 logthing(LOGTHING_ERROR,
391 "Problem retrieving key: %s",
402 int worddb_cmp(const void *d1, const void *d2)
404 return memcmp(d1, d2, 12);
408 * fetch_key_text - Trys to find the keys that contain the supplied text.
409 * @search: The text to search for.
410 * @publickey: A pointer to a structure to return the key in.
412 * This function searches for the supplied text and returns the keys that
415 static int db4_fetch_key_text(const char *search,
416 struct openpgp_publickey **publickey)
424 char *searchtext = NULL;
425 struct ll *wordlist = NULL;
426 struct ll *curword = NULL;
427 struct keyarray keylist = { NULL, 0, 0 };
428 struct keyarray newkeylist = { NULL, 0, 0 };
431 searchtext = strdup(search);
432 wordlist = makewordlist(wordlist, searchtext);
434 for (curword = wordlist; curword != NULL; curword = curword->next) {
437 ret = worddb->cursor(worddb,
442 memset(&key, 0, sizeof(key));
443 memset(&data, 0, sizeof(data));
444 key.data = curword->object;
445 key.size = strlen(curword->object);
446 data.flags = DB_DBT_MALLOC;
447 ret = cursor->c_get(cursor,
451 while (ret == 0 && strncmp(key.data, curword->object,
453 ((char *) curword->object)[key.size] == 0) {
455 for (i = 4; i < 12; i++) {
457 keyid += ((unsigned char *)
461 if (keylist.count == 0 ||
462 array_find(&keylist, keyid)) {
463 array_add(&newkeylist, keyid);
469 ret = cursor->c_get(cursor,
474 array_free(&keylist);
475 keylist = newkeylist;
476 newkeylist.keys = NULL;
477 newkeylist.count = newkeylist.size = 0;
478 if (data.data != NULL) {
482 ret = cursor->c_close(cursor);
486 llfree(wordlist, NULL);
490 for (i = 0; i < keylist.count; i++) {
491 numkeys += db4_fetch_key(keylist.keys[i],
495 array_free(&keylist);
505 * delete_key - Given a keyid delete the key from storage.
506 * @keyid: The keyid to delete.
507 * @intrans: If we're already in a transaction.
509 * This function deletes a public key from whatever storage mechanism we
510 * are using. Returns 0 if the key existed.
512 static int db4_delete_key(uint64_t keyid, bool intrans)
514 struct openpgp_publickey *publickey = NULL;
517 uint32_t shortkeyid = 0;
518 uint64_t *subkeyids = NULL;
522 char *primary = NULL;
523 unsigned char worddb_data[12];
524 struct ll *wordlist = NULL;
525 struct ll *curword = NULL;
526 bool deadlock = false;
532 db4_fetch_key(keyid, &publickey, true);
535 * Walk through the uids removing the words from the worddb.
537 if (publickey != NULL) {
538 uids = keyuids(publickey, &primary);
541 for (i = 0; ret == 0 && uids[i] != NULL; i++) {
542 wordlist = makewordlist(wordlist, uids[i]);
545 ret = worddb->cursor(worddb,
550 for (curword = wordlist; curword != NULL && !deadlock;
551 curword = curword->next) {
552 memset(&key, 0, sizeof(key));
553 memset(&data, 0, sizeof(data));
554 key.data = curword->object;
555 key.size = strlen(key.data);
556 data.data = worddb_data;
557 data.size = sizeof(worddb_data);
560 * Our data is the key creation time followed by the
563 worddb_data[ 0] = publickey->publickey->data[1];
564 worddb_data[ 1] = publickey->publickey->data[2];
565 worddb_data[ 2] = publickey->publickey->data[3];
566 worddb_data[ 3] = publickey->publickey->data[4];
567 worddb_data[ 4] = (keyid >> 56) & 0xFF;
568 worddb_data[ 5] = (keyid >> 48) & 0xFF;
569 worddb_data[ 6] = (keyid >> 40) & 0xFF;
570 worddb_data[ 7] = (keyid >> 32) & 0xFF;
571 worddb_data[ 8] = (keyid >> 24) & 0xFF;
572 worddb_data[ 9] = (keyid >> 16) & 0xFF;
573 worddb_data[10] = (keyid >> 8) & 0xFF;
574 worddb_data[11] = keyid & 0xFF;
576 ret = cursor->c_get(cursor,
582 ret = cursor->c_del(cursor, 0);
584 logthing(LOGTHING_ERROR,
585 "Problem deleting word: %s",
591 logthing(LOGTHING_ERROR,
592 "Problem deleting word: %s",
594 if (ret == DB_LOCK_DEADLOCK) {
599 ret = cursor->c_close(cursor);
603 * Free our UID and word lists.
605 llfree(wordlist, NULL);
606 for (i = 0; uids[i] != NULL; i++) {
612 free_publickey(publickey);
617 ret = id32db->cursor(id32db,
622 shortkeyid = keyid & 0xFFFFFFFF;
624 memset(&key, 0, sizeof(key));
625 memset(&data, 0, sizeof(data));
626 key.data = &shortkeyid;
627 key.size = sizeof(shortkeyid);
629 data.size = sizeof(keyid);
631 ret = cursor->c_get(cursor,
637 ret = cursor->c_del(cursor, 0);
639 logthing(LOGTHING_ERROR,
640 "Problem deleting short keyid: %s",
646 logthing(LOGTHING_ERROR,
647 "Problem deleting short keyid: %s",
649 if (ret == DB_LOCK_DEADLOCK) {
654 subkeyids = keysubkeys(publickey);
656 while (subkeyids != NULL && subkeyids[i] != 0) {
657 shortkeyid = subkeyids[i++] & 0xFFFFFFFF;
659 memset(&key, 0, sizeof(key));
660 memset(&data, 0, sizeof(data));
661 key.data = &shortkeyid;
662 key.size = sizeof(shortkeyid);
664 data.size = sizeof(keyid);
666 ret = cursor->c_get(cursor,
672 ret = cursor->c_del(cursor, 0);
674 logthing(LOGTHING_ERROR,
675 "Problem deleting short"
682 logthing(LOGTHING_ERROR,
683 "Problem deleting short keyid: %s",
685 if (ret == DB_LOCK_DEADLOCK) {
690 if (subkeyids != NULL) {
695 ret = cursor->c_close(cursor);
701 key.size = sizeof(keyid);
703 keydb(keyid)->del(keydb(keyid),
713 return deadlock ? (-1) : (ret == DB_NOTFOUND);
717 * store_key - Takes a key and stores it.
718 * @publickey: A pointer to the public key to store.
719 * @intrans: If we're already in a transaction.
720 * @update: If true the key exists and should be updated.
722 * Again we just use the hex representation of the keyid as the filename
723 * to store the key to. We flatten the public key to a list of OpenPGP
724 * packets and then use write_openpgp_stream() to write the stream out to
725 * the file. If update is true then we delete the old key first, otherwise
726 * we trust that it doesn't exist.
728 static int db4_store_key(struct openpgp_publickey *publickey, bool intrans,
731 struct openpgp_packet_list *packets = NULL;
732 struct openpgp_packet_list *list_end = NULL;
733 struct openpgp_publickey *next = NULL;
736 struct buffer_ctx storebuf;
740 uint32_t shortkeyid = 0;
741 uint64_t *subkeyids = NULL;
743 char *primary = NULL;
744 unsigned char worddb_data[12];
745 struct ll *wordlist = NULL;
746 struct ll *curword = NULL;
747 bool deadlock = false;
749 keyid = get_keyid(publickey);
756 * Delete the key if we already have it.
758 * TODO: Can we optimize this perhaps? Possibly when other data is
759 * involved as well? I suspect this is easiest and doesn't make a lot
760 * of difference though - the largest chunk of data is the keydata and
761 * it definitely needs updated.
764 deadlock = (db4_delete_key(keyid, true) == -1);
768 * Convert the key to a flat set of binary data.
771 next = publickey->next;
772 publickey->next = NULL;
773 flatten_publickey(publickey, &packets, &list_end);
774 publickey->next = next;
777 storebuf.size = 8192;
778 storebuf.buffer = malloc(8192);
780 write_openpgp_stream(buffer_putchar, &storebuf, packets);
783 * Now we have the key data store it in the DB; the keyid is
786 memset(&key, 0, sizeof(key));
787 memset(&data, 0, sizeof(data));
789 key.size = sizeof(keyid);
790 data.size = storebuf.offset;
791 data.data = storebuf.buffer;
793 ret = keydb(keyid)->put(keydb(keyid),
799 logthing(LOGTHING_ERROR,
800 "Problem storing key: %s",
802 if (ret == DB_LOCK_DEADLOCK) {
807 free(storebuf.buffer);
808 storebuf.buffer = NULL;
812 free_packet_list(packets);
817 * Walk through our uids storing the words into the db with the keyid.
820 uids = keyuids(publickey, &primary);
823 for (i = 0; ret == 0 && uids[i] != NULL; i++) {
824 wordlist = makewordlist(wordlist, uids[i]);
827 for (curword = wordlist; curword != NULL && !deadlock;
828 curword = curword->next) {
829 memset(&key, 0, sizeof(key));
830 memset(&data, 0, sizeof(data));
831 key.data = curword->object;
832 key.size = strlen(key.data);
833 data.data = worddb_data;
834 data.size = sizeof(worddb_data);
837 * Our data is the key creation time followed by the
840 worddb_data[ 0] = publickey->publickey->data[1];
841 worddb_data[ 1] = publickey->publickey->data[2];
842 worddb_data[ 2] = publickey->publickey->data[3];
843 worddb_data[ 3] = publickey->publickey->data[4];
844 worddb_data[ 4] = (keyid >> 56) & 0xFF;
845 worddb_data[ 5] = (keyid >> 48) & 0xFF;
846 worddb_data[ 6] = (keyid >> 40) & 0xFF;
847 worddb_data[ 7] = (keyid >> 32) & 0xFF;
848 worddb_data[ 8] = (keyid >> 24) & 0xFF;
849 worddb_data[ 9] = (keyid >> 16) & 0xFF;
850 worddb_data[10] = (keyid >> 8) & 0xFF;
851 worddb_data[11] = keyid & 0xFF;
852 ret = worddb->put(worddb,
858 logthing(LOGTHING_ERROR,
859 "Problem storing word: %s",
861 if (ret == DB_LOCK_DEADLOCK) {
868 * Free our UID and word lists.
870 llfree(wordlist, NULL);
871 for (i = 0; uids[i] != NULL; i++) {
880 * Write the truncated 32 bit keyid so we can lookup the full id for
884 shortkeyid = keyid & 0xFFFFFFFF;
886 memset(&key, 0, sizeof(key));
887 memset(&data, 0, sizeof(data));
888 key.data = &shortkeyid;
889 key.size = sizeof(shortkeyid);
891 data.size = sizeof(keyid);
893 ret = id32db->put(id32db,
899 logthing(LOGTHING_ERROR,
900 "Problem storing short keyid: %s",
902 if (ret == DB_LOCK_DEADLOCK) {
909 subkeyids = keysubkeys(publickey);
911 while (subkeyids != NULL && subkeyids[i] != 0) {
912 shortkeyid = subkeyids[i++] & 0xFFFFFFFF;
914 memset(&key, 0, sizeof(key));
915 memset(&data, 0, sizeof(data));
916 key.data = &shortkeyid;
917 key.size = sizeof(shortkeyid);
919 data.size = sizeof(keyid);
921 ret = id32db->put(id32db,
927 logthing(LOGTHING_ERROR,
928 "Problem storing short keyid: %s",
930 if (ret == DB_LOCK_DEADLOCK) {
935 if (subkeyids != NULL) {
945 return deadlock ? -1 : 0 ;
949 * iterate_keys - call a function once for each key in the db.
950 * @iterfunc: The function to call.
951 * @ctx: A context pointer
953 * Calls iterfunc once for each key in the database. ctx is passed
954 * unaltered to iterfunc. This function is intended to aid database dumps
955 * and statistic calculations.
957 * Returns the number of keys we iterated over.
959 static int db4_iterate_keys(void (*iterfunc)(void *ctx,
960 struct openpgp_publickey *key), void *ctx)
967 struct buffer_ctx fetchbuf;
968 struct openpgp_packet_list *packets = NULL;
969 struct openpgp_publickey *key = NULL;
971 for (i = 0; i < numdbs; i++) {
972 ret = dbconns[i]->cursor(dbconns[i],
977 memset(&dbkey, 0, sizeof(dbkey));
978 memset(&data, 0, sizeof(data));
979 ret = cursor->c_get(cursor, &dbkey, &data, DB_NEXT);
981 fetchbuf.buffer = data.data;
983 fetchbuf.size = data.size;
984 read_openpgp_stream(buffer_fetchchar, &fetchbuf,
986 parse_keys(packets, &key);
992 free_packet_list(packets);
995 memset(&dbkey, 0, sizeof(dbkey));
996 memset(&data, 0, sizeof(data));
997 ret = cursor->c_get(cursor, &dbkey, &data,
1001 if (ret != DB_NOTFOUND) {
1002 logthing(LOGTHING_ERROR,
1003 "Problem reading key: %s",
1007 ret = cursor->c_close(cursor);
1015 * getfullkeyid - Maps a 32bit key id to a 64bit one.
1016 * @keyid: The 32bit keyid.
1018 * This function maps a 32bit key id to the full 64bit one. It returns the
1019 * full keyid. If the key isn't found a keyid of 0 is returned.
1021 static uint64_t db4_getfullkeyid(uint64_t keyid)
1025 uint32_t shortkeyid = 0;
1028 if (keyid < 0x100000000LL) {
1029 ret = id32db->cursor(id32db,
1034 shortkeyid = keyid & 0xFFFFFFFF;
1036 memset(&key, 0, sizeof(key));
1037 memset(&data, 0, sizeof(data));
1038 key.data = &shortkeyid;
1039 key.size = sizeof(shortkeyid);
1040 data.flags = DB_DBT_MALLOC;
1042 ret = cursor->c_get(cursor,
1048 keyid = *(uint64_t *) data.data;
1050 if (data.data != NULL) {
1056 ret = cursor->c_close(cursor);
1064 * Include the basic keydb routines.
1066 #define NEED_GETKEYSIGS 1
1067 #define NEED_KEYID2UID 1
1068 #define NEED_UPDATEKEYS 1
1071 struct dbfuncs keydb_db4_funcs = {
1072 .initdb = db4_initdb,
1073 .cleanupdb = db4_cleanupdb,
1074 .starttrans = db4_starttrans,
1075 .endtrans = db4_endtrans,
1076 .fetch_key = db4_fetch_key,
1077 .fetch_key_text = db4_fetch_key_text,
1078 .store_key = db4_store_key,
1079 .update_keys = generic_update_keys,
1080 .delete_key = db4_delete_key,
1081 .getkeysigs = generic_getkeysigs,
1082 .cached_getkeysigs = generic_cached_getkeysigs,
1083 .keyid2uid = generic_keyid2uid,
1084 .getfullkeyid = db4_getfullkeyid,
1085 .iterate_keys = db4_iterate_keys,