X-Git-Url: https://git.sommitrealweird.co.uk/onak.git/blobdiff_plain/5913c95f2c7abf4c3cb06e27d384d80fb4c83547..e1385087ec060568a966a5305a9d88c24a2a0a55:/keydb.h diff --git a/keydb.h b/keydb.h index 647916c..4406223 100644 --- a/keydb.h +++ b/keydb.h @@ -3,13 +3,12 @@ * * Jonathan McDowell * - * Copyright 2002 Project Purple + * Copyright 2002-2004 Project Purple */ #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. @@ -97,6 +97,22 @@ int delete_key(uint64_t keyid, bool intrans); */ int fetch_key_text(const char *search, struct openpgp_publickey **publickey); +/** + * update_keys - Takes a list of public keys and updates them in the DB. + * @keys: The keys to update in the DB. + * @sendsync: If we should send a keysync mail. + * + * Takes a list of keys and adds them to the database, merging them with + * the key in the database if it's already present there. The key list is + * update to contain the minimum set of updates required to get from what + * we had before to what we have now (ie the set of data that was added to + * the DB). Returns the number of entirely new keys added. + * + * If sendsync is true then we send out a keysync mail to our sync peers + * with the update. + */ +int update_keys(struct openpgp_publickey **keys, bool sendsync); + /** * keyid2uid - Takes a keyid and returns the primary UID for it. * @keyid: The keyid to lookup. @@ -109,11 +125,13 @@ 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. @@ -133,4 +151,18 @@ struct ll *cached_getkeysigs(uint64_t keyid); */ uint64_t getfullkeyid(uint64_t keyid); +/** + * iterate_keys - call a function once for each key in the db. + * @iterfunc: The function to call. + * @ctx: A context pointer + * + * Calls iterfunc once for each key in the database. ctx is passed + * unaltered to iterfunc. This function is intended to aid database dumps + * and statistic calculations. + * + * Returns the number of keys we iterated over. + */ +int iterate_keys(void (*iterfunc)(void *ctx, struct openpgp_publickey *key), + void *ctx); + #endif /* __KEYDB_H__ */