cscvs to tla changeset 107

[onak.git] / keydb.h

diff --git a/keydb.h b/keydb.h
index ca8fdf71f1fc97f49efb20dd52360c4f71582ba6..ea4a78999ce4b217f150ad22288f7c17ef27d29f 100644 (file)
--- a/keydb.h
+++ b/keydb.h
@@ -4,12 +4,13 @@
  * Jonathan McDowell <noodles@earth.li>
  *
  * Copyright 2002 Project Purple
  * Jonathan McDowell <noodles@earth.li>
  *
  * Copyright 2002 Project Purple

+ *
+ * $Id: keydb.h,v 1.9 2003/06/08 21:11:00 noodles Exp $

  */
 
 #ifndef __KEYDB_H__
 #define __KEYDB_H__
 
  */
 
 #ifndef __KEYDB_H__
 #define __KEYDB_H__
 

-// #include <stdint.h>

 #include <inttypes.h>
 
 #include "keystructs.h"
 #include <inttypes.h>
 
 #include "keystructs.h"


@@ -32,38 +33,70 @@ void initdb(void);
  */
 void cleanupdb(void);
 
  */
 void cleanupdb(void);
 

+/**
+ *     starttrans - Start a transaction.
+ *
+ *     Start a transaction. Intended to be used if we're about to perform many
+ *     operations on the database to help speed it all up, or if we want
+ *     something to only succeed if all relevant operations are successful.
+ */
+bool starttrans(void);
+
+/**
+ *     endtrans - End a transaction.
+ *
+ *     Ends a transaction.
+ */
+void endtrans(void);
+

 /**
  *     fetch_key - Given a keyid fetch the key from storage.
  *     @keyid: The keyid to fetch.
  *     @publickey: A pointer to a structure to return the key in.
 /**
  *     fetch_key - Given a keyid fetch the key from storage.
  *     @keyid: The keyid to fetch.
  *     @publickey: A pointer to a structure to return the key in.

+ *     @intrans: If we're already in a transaction.

  *
  *     This function returns a public key from whatever storage mechanism we
  *     are using.
  *
  *      TODO: What about keyid collisions? Should we use fingerprint instead?
  */
  *
  *     This function returns a public key from whatever storage mechanism we
  *     are using.
  *
  *      TODO: What about keyid collisions? Should we use fingerprint instead?
  */

-int fetch_key(uint64_t keyid, struct openpgp_publickey **publickey);
+int fetch_key(uint64_t keyid, struct openpgp_publickey **publickey, bool intrans);

 
 /**
  *     store_key - Takes a key and stores it.
  *     @publickey: A pointer to the public key to store.
 
 /**
  *     store_key - Takes a key and stores it.
  *     @publickey: A pointer to the public key to store.

+ *     @intrans: If we're already in a transaction.
+ *     @update: If true the key exists and should be updated.

  *
  *     This function stores a public key in whatever storage mechanism we are
  *
  *     This function stores a public key in whatever storage mechanism we are

- *     using.
+ *     using. intrans indicates if we're already in a transaction so don't
+ *     need to start one. update indicates if the key already exists and is
+ *     just being updated.

  *
  *     TODO: Do we store multiple keys of the same id? Or only one and replace
  *     it?
  */
  *
  *     TODO: Do we store multiple keys of the same id? Or only one and replace
  *     it?
  */

-int store_key(struct openpgp_publickey *publickey);
+int store_key(struct openpgp_publickey *publickey, bool intrans, bool update);

 
 /**
  *     delete_key - Given a keyid delete the key from storage.
  *     @keyid: The keyid to delete.
 
 /**
  *     delete_key - Given a keyid delete the key from storage.
  *     @keyid: The keyid to delete.

+ *     @intrans: If we're already in a transaction.

  *
  *     This function deletes a public key from whatever storage mechanism we
  *     are using. Returns 0 if the key existed.
  */
  *
  *     This function deletes a public key from whatever storage mechanism we
  *     are using. Returns 0 if the key existed.
  */

-int delete_key(uint64_t keyid);
+int delete_key(uint64_t keyid, bool intrans);
+
+/**
+ *     fetch_key_text - Trys to find the keys that contain the supplied text.
+ *     @search: The text to search for.
+ *     @publickey: A pointer to a structure to return the key in.
+ *
+ *     This function searches for the supplied text and returns the keys that
+ *     contain it.
+ */
+int fetch_key_text(const char *search, struct openpgp_publickey **publickey);

 
 /**
  *     keyid2uid - Takes a keyid and returns the primary UID for it.
 
 /**
  *     keyid2uid - Takes a keyid and returns the primary UID for it.


@@ -77,10 +110,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.
 /**
  *     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 
  *
  *     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, 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. 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.

  */
  */

-struct ll *getkeysigs(uint64_t keyid);
+int dumpdb(char *filenamebase);

 
 #endif /* __KEYDB_H__ */
 
 #endif /* __KEYDB_H__ */