X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/e02c731dfbb288c736f2cd09a9b6df0507c59ddd..1dd29bb2bbc96e62fa2ba611d8871c7c4084ef75:/keydb.h?ds=sidebyside diff --git a/keydb.h b/keydb.h index e9bcb67..ae87ce3 100644 --- a/keydb.h +++ b/keydb.h @@ -9,7 +9,6 @@ #ifndef __KEYDB_H__ #define __KEYDB_H__ -// #include #include #include "keystructs.h" @@ -17,12 +16,13 @@ /** * initdb - Initialize the key database. + * @readonly: If we'll only be reading the DB, not writing to it. * * This function should be called before any of the other functions in * this file are called in order to allow the DB to be initialized ready * for access. */ -void initdb(void); +void initdb(bool readonly); /** * cleanupdb - De-initialize the key database. @@ -109,19 +109,42 @@ char *keyid2uid(uint64_t keyid); /** * getkeysigs - Gets a linked list of the signatures on a key. * @keyid: The keyid to get the sigs for. + * @revoked: Is the key revoked? * * This function gets the list of signatures on a key. Used for key - * indexing and doing stats bits. + * indexing and doing stats bits. If revoked is non-NULL then if the key + * is revoked it's set to true. */ -struct ll *getkeysigs(uint64_t keyid); +struct ll *getkeysigs(uint64_t keyid, bool *revoked); + +/** + * cached_getkeysigs - Gets the signatures on a key. + * @keyid: The key we want the signatures for. + * + * This function gets the signatures on a key. It's the same as the + * getkeysigs function above except we use the hash module to cache the + */ +struct ll *cached_getkeysigs(uint64_t keyid); /** * getfullkeyid - Maps a 32bit key id to a 64bit one. * @keyid: The 32bit keyid. * * This function maps a 32bit key id to the full 64bit one. It returns the - * full keyid. + * full keyid. If the key isn't found a keyid of 0 is returned. */ uint64_t getfullkeyid(uint64_t keyid); +/** + * dumpdb - dump the key database + * @filenamebase: The base filename to use for the dump. + * + * Dumps the database into one or more files, which contain pure OpenPGP + * that can be reimported into onak or gpg. filenamebase provides a base + * file name for the dump; several files may be created, all of which will + * begin with this string and then have a unique number and a .pgp + * extension. + */ +int dumpdb(char *filenamebase); + #endif /* __KEYDB_H__ */