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 };
480 searchtext = strdup(search);
481 wordlist = makewordlist(wordlist, searchtext);
483 for (curword = wordlist; curword != NULL; curword = curword->next) {
486 ret = worddb->cursor(worddb,
491 memset(&key, 0, sizeof(key));
492 memset(&data, 0, sizeof(data));
493 key.data = curword->object;
494 key.size = strlen(curword->object);
495 data.flags = DB_DBT_MALLOC;
496 ret = cursor->c_get(cursor,
500 while (ret == 0 && strncmp(key.data, curword->object,
502 ((char *) curword->object)[key.size] == 0) {
504 for (i = 4; i < 12; i++) {
506 keyid += ((unsigned char *)
510 if (keylist.count == 0 ||
511 array_find(&keylist, keyid)) {
512 array_add(&newkeylist, keyid);
518 ret = cursor->c_get(cursor,
523 array_free(&keylist);
524 keylist = newkeylist;
525 newkeylist.keys = NULL;
526 newkeylist.count = newkeylist.size = 0;
527 if (data.data != NULL) {
531 ret = cursor->c_close(cursor);
535 llfree(wordlist, NULL);
539 for (i = 0; i < keylist.count; i++) {
540 numkeys += db4_fetch_key(keylist.keys[i],
544 array_free(&keylist);
554 * delete_key - Given a keyid delete the key from storage.
555 * @keyid: The keyid to delete.
556 * @intrans: If we're already in a transaction.
558 * This function deletes a public key from whatever storage mechanism we
559 * are using. Returns 0 if the key existed.
561 static int db4_delete_key(uint64_t keyid, bool intrans)
563 struct openpgp_publickey *publickey = NULL;
566 uint32_t shortkeyid = 0;
567 uint64_t *subkeyids = NULL;
571 char *primary = NULL;
572 unsigned char worddb_data[12];
573 struct ll *wordlist = NULL;
574 struct ll *curword = NULL;
575 bool deadlock = false;
581 db4_fetch_key(keyid, &publickey, true);
584 * Walk through the uids removing the words from the worddb.
586 if (publickey != NULL) {
587 uids = keyuids(publickey, &primary);
590 for (i = 0; ret == 0 && uids[i] != NULL; i++) {
591 wordlist = makewordlist(wordlist, uids[i]);
594 ret = worddb->cursor(worddb,
599 for (curword = wordlist; curword != NULL && !deadlock;
600 curword = curword->next) {
601 memset(&key, 0, sizeof(key));
602 memset(&data, 0, sizeof(data));
603 key.data = curword->object;
604 key.size = strlen(key.data);
605 data.data = worddb_data;
606 data.size = sizeof(worddb_data);
609 * Our data is the key creation time followed by the
612 worddb_data[ 0] = publickey->publickey->data[1];
613 worddb_data[ 1] = publickey->publickey->data[2];
614 worddb_data[ 2] = publickey->publickey->data[3];
615 worddb_data[ 3] = publickey->publickey->data[4];
616 worddb_data[ 4] = (keyid >> 56) & 0xFF;
617 worddb_data[ 5] = (keyid >> 48) & 0xFF;
618 worddb_data[ 6] = (keyid >> 40) & 0xFF;
619 worddb_data[ 7] = (keyid >> 32) & 0xFF;
620 worddb_data[ 8] = (keyid >> 24) & 0xFF;
621 worddb_data[ 9] = (keyid >> 16) & 0xFF;
622 worddb_data[10] = (keyid >> 8) & 0xFF;
623 worddb_data[11] = keyid & 0xFF;
625 ret = cursor->c_get(cursor,
631 ret = cursor->c_del(cursor, 0);
633 logthing(LOGTHING_ERROR,
634 "Problem deleting word: %s",
640 logthing(LOGTHING_ERROR,
641 "Problem deleting word: %s",
643 if (ret == DB_LOCK_DEADLOCK) {
648 ret = cursor->c_close(cursor);
652 * Free our UID and word lists.
654 llfree(wordlist, NULL);
655 for (i = 0; uids[i] != NULL; i++) {
661 free_publickey(publickey);
666 ret = id32db->cursor(id32db,
671 shortkeyid = keyid & 0xFFFFFFFF;
673 memset(&key, 0, sizeof(key));
674 memset(&data, 0, sizeof(data));
675 key.data = &shortkeyid;
676 key.size = sizeof(shortkeyid);
678 data.size = sizeof(keyid);
680 ret = cursor->c_get(cursor,
686 ret = cursor->c_del(cursor, 0);
688 logthing(LOGTHING_ERROR,
689 "Problem deleting short keyid: %s",
695 logthing(LOGTHING_ERROR,
696 "Problem deleting short keyid: %s",
698 if (ret == DB_LOCK_DEADLOCK) {
703 subkeyids = keysubkeys(publickey);
705 while (subkeyids != NULL && subkeyids[i] != 0) {
706 shortkeyid = subkeyids[i++] & 0xFFFFFFFF;
708 memset(&key, 0, sizeof(key));
709 memset(&data, 0, sizeof(data));
710 key.data = &shortkeyid;
711 key.size = sizeof(shortkeyid);
713 data.size = sizeof(keyid);
715 ret = cursor->c_get(cursor,
721 ret = cursor->c_del(cursor, 0);
723 logthing(LOGTHING_ERROR,
724 "Problem deleting short"
731 logthing(LOGTHING_ERROR,
732 "Problem deleting short keyid: %s",
734 if (ret == DB_LOCK_DEADLOCK) {
739 if (subkeyids != NULL) {
744 ret = cursor->c_close(cursor);
750 key.size = sizeof(keyid);
752 keydb(keyid)->del(keydb(keyid),
762 return deadlock ? (-1) : (ret == DB_NOTFOUND);
766 * store_key - Takes a key and stores it.
767 * @publickey: A pointer to the public key to store.
768 * @intrans: If we're already in a transaction.
769 * @update: If true the key exists and should be updated.
771 * Again we just use the hex representation of the keyid as the filename
772 * to store the key to. We flatten the public key to a list of OpenPGP
773 * packets and then use write_openpgp_stream() to write the stream out to
774 * the file. If update is true then we delete the old key first, otherwise
775 * we trust that it doesn't exist.
777 static int db4_store_key(struct openpgp_publickey *publickey, bool intrans,
780 struct openpgp_packet_list *packets = NULL;
781 struct openpgp_packet_list *list_end = NULL;
782 struct openpgp_publickey *next = NULL;
785 struct buffer_ctx storebuf;
789 uint32_t shortkeyid = 0;
790 uint64_t *subkeyids = NULL;
792 char *primary = NULL;
793 unsigned char worddb_data[12];
794 struct ll *wordlist = NULL;
795 struct ll *curword = NULL;
796 bool deadlock = false;
798 keyid = get_keyid(publickey);
805 * Delete the key if we already have it.
807 * TODO: Can we optimize this perhaps? Possibly when other data is
808 * involved as well? I suspect this is easiest and doesn't make a lot
809 * of difference though - the largest chunk of data is the keydata and
810 * it definitely needs updated.
813 deadlock = (db4_delete_key(keyid, true) == -1);
817 * Convert the key to a flat set of binary data.
820 next = publickey->next;
821 publickey->next = NULL;
822 flatten_publickey(publickey, &packets, &list_end);
823 publickey->next = next;
826 storebuf.size = 8192;
827 storebuf.buffer = malloc(8192);
829 write_openpgp_stream(buffer_putchar, &storebuf, packets);
832 * Now we have the key data store it in the DB; the keyid is
835 memset(&key, 0, sizeof(key));
836 memset(&data, 0, sizeof(data));
838 key.size = sizeof(keyid);
839 data.size = storebuf.offset;
840 data.data = storebuf.buffer;
842 ret = keydb(keyid)->put(keydb(keyid),
848 logthing(LOGTHING_ERROR,
849 "Problem storing key: %s",
851 if (ret == DB_LOCK_DEADLOCK) {
856 free(storebuf.buffer);
857 storebuf.buffer = NULL;
861 free_packet_list(packets);
866 * Walk through our uids storing the words into the db with the keyid.
869 uids = keyuids(publickey, &primary);
872 for (i = 0; ret == 0 && uids[i] != NULL; i++) {
873 wordlist = makewordlist(wordlist, uids[i]);
876 for (curword = wordlist; curword != NULL && !deadlock;
877 curword = curword->next) {
878 memset(&key, 0, sizeof(key));
879 memset(&data, 0, sizeof(data));
880 key.data = curword->object;
881 key.size = strlen(key.data);
882 data.data = worddb_data;
883 data.size = sizeof(worddb_data);
886 * Our data is the key creation time followed by the
889 worddb_data[ 0] = publickey->publickey->data[1];
890 worddb_data[ 1] = publickey->publickey->data[2];
891 worddb_data[ 2] = publickey->publickey->data[3];
892 worddb_data[ 3] = publickey->publickey->data[4];
893 worddb_data[ 4] = (keyid >> 56) & 0xFF;
894 worddb_data[ 5] = (keyid >> 48) & 0xFF;
895 worddb_data[ 6] = (keyid >> 40) & 0xFF;
896 worddb_data[ 7] = (keyid >> 32) & 0xFF;
897 worddb_data[ 8] = (keyid >> 24) & 0xFF;
898 worddb_data[ 9] = (keyid >> 16) & 0xFF;
899 worddb_data[10] = (keyid >> 8) & 0xFF;
900 worddb_data[11] = keyid & 0xFF;
901 ret = worddb->put(worddb,
907 logthing(LOGTHING_ERROR,
908 "Problem storing word: %s",
910 if (ret == DB_LOCK_DEADLOCK) {
917 * Free our UID and word lists.
919 llfree(wordlist, NULL);
920 for (i = 0; uids[i] != NULL; i++) {
929 * Write the truncated 32 bit keyid so we can lookup the full id for
933 shortkeyid = keyid & 0xFFFFFFFF;
935 memset(&key, 0, sizeof(key));
936 memset(&data, 0, sizeof(data));
937 key.data = &shortkeyid;
938 key.size = sizeof(shortkeyid);
940 data.size = sizeof(keyid);
942 ret = id32db->put(id32db,
948 logthing(LOGTHING_ERROR,
949 "Problem storing short keyid: %s",
951 if (ret == DB_LOCK_DEADLOCK) {
958 subkeyids = keysubkeys(publickey);
960 while (subkeyids != NULL && subkeyids[i] != 0) {
961 shortkeyid = subkeyids[i++] & 0xFFFFFFFF;
963 memset(&key, 0, sizeof(key));
964 memset(&data, 0, sizeof(data));
965 key.data = &shortkeyid;
966 key.size = sizeof(shortkeyid);
968 data.size = sizeof(keyid);
970 ret = id32db->put(id32db,
976 logthing(LOGTHING_ERROR,
977 "Problem storing short keyid: %s",
979 if (ret == DB_LOCK_DEADLOCK) {
984 if (subkeyids != NULL) {
994 return deadlock ? -1 : 0 ;
998 * iterate_keys - call a function once for each key in the db.
999 * @iterfunc: The function to call.
1000 * @ctx: A context pointer
1002 * Calls iterfunc once for each key in the database. ctx is passed
1003 * unaltered to iterfunc. This function is intended to aid database dumps
1004 * and statistic calculations.
1006 * Returns the number of keys we iterated over.
1008 static int db4_iterate_keys(void (*iterfunc)(void *ctx,
1009 struct openpgp_publickey *key), void *ctx)
1016 struct buffer_ctx fetchbuf;
1017 struct openpgp_packet_list *packets = NULL;
1018 struct openpgp_publickey *key = NULL;
1020 for (i = 0; i < numdbs; i++) {
1021 ret = dbconns[i]->cursor(dbconns[i],
1026 memset(&dbkey, 0, sizeof(dbkey));
1027 memset(&data, 0, sizeof(data));
1028 ret = cursor->c_get(cursor, &dbkey, &data, DB_NEXT);
1030 fetchbuf.buffer = data.data;
1031 fetchbuf.offset = 0;
1032 fetchbuf.size = data.size;
1033 read_openpgp_stream(buffer_fetchchar, &fetchbuf,
1035 parse_keys(packets, &key);
1039 free_publickey(key);
1041 free_packet_list(packets);
1044 memset(&dbkey, 0, sizeof(dbkey));
1045 memset(&data, 0, sizeof(data));
1046 ret = cursor->c_get(cursor, &dbkey, &data,
1050 if (ret != DB_NOTFOUND) {
1051 logthing(LOGTHING_ERROR,
1052 "Problem reading key: %s",
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,