Add man page for keyd, even though it's not currently recommended for

[onak.git] / keydb_pg.c

diff --git a/keydb_pg.c b/keydb_pg.c
index b424b7f9814fd4b170c7ccf0ec95f2ec50303506..25881c0820e1c09d8992b88d6947edd0e260e274 100644 (file)
--- a/keydb_pg.c
+++ b/keydb_pg.c
@@ -3,16 +3,12 @@
  *
  * Jonathan McDowell <noodles@earth.li>
  *
  *
  * Jonathan McDowell <noodles@earth.li>
  *

- * Copyright 2002 Project Purple
- *
- * $Id: keydb_pg.c,v 1.13 2003/09/30 20:40:11 noodles Exp $
+ * Copyright 2002-2004 Project Purple

  */
 
 #include <postgresql/libpq-fe.h>
 #include <postgresql/libpq/libpq-fs.h>
 
  */
 
 #include <postgresql/libpq-fe.h>
 #include <postgresql/libpq/libpq-fs.h>
 

-//#include <libpq-fe.h>
-//#include <libpq/libpq-fs.h>

 #include <sys/types.h>
 #include <sys/uio.h>
 #include <errno.h>
 #include <sys/types.h>
 #include <sys/uio.h>
 #include <errno.h>


@@ -42,7 +38,7 @@ static PGconn *dbconn = NULL;
  */
 static int keydb_fetchchar(void *fd, size_t count, unsigned char *c)
 {
  */
 static int keydb_fetchchar(void *fd, size_t count, unsigned char *c)
 {

-       return (!lo_read(dbconn, *(int *) fd, c, count));
+       return (!lo_read(dbconn, *(int *) fd, (char *) c, count));

 }
 
 /**
 }
 
 /**


@@ -50,7 +46,7 @@ static int keydb_fetchchar(void *fd, size_t count, unsigned char *c)
  */
 static int keydb_putchar(void *fd, size_t count, unsigned char *c)
 {
  */
 static int keydb_putchar(void *fd, size_t count, unsigned char *c)
 {

-       return !(lo_write(dbconn, *(int *) fd, c, count));
+       return !(lo_write(dbconn, *(int *) fd, (char *) c, count));

 }
 
 /**
 }
 
 /**


@@ -60,7 +56,7 @@ static int keydb_putchar(void *fd, size_t count, unsigned char *c)
  *     this file are called in order to allow the DB to be initialized ready
  *     for access.
  */
  *     this file are called in order to allow the DB to be initialized ready
  *     for access.
  */

-void initdb(void)
+static void pg_initdb(bool readonly)

 {
        dbconn = PQsetdbLogin(config.pg_dbhost, // host
                        NULL, // port
 {
        dbconn = PQsetdbLogin(config.pg_dbhost, // host
                        NULL, // port


@@ -85,7 +81,7 @@ void initdb(void)
  *     This function should be called upon program exit to allow the DB to
  *     cleanup after itself.
  */
  *     This function should be called upon program exit to allow the DB to
  *     cleanup after itself.
  */

-void cleanupdb(void)
+static void pg_cleanupdb(void)

 {
        PQfinish(dbconn);
        dbconn = NULL;
 {
        PQfinish(dbconn);
        dbconn = NULL;


@@ -98,7 +94,7 @@ void cleanupdb(void)
  *     operations on the database to help speed it all up, or if we want
  *     something to only succeed if all relevant operations are successful.
  */
  *     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)
+static bool pg_starttrans(void)

 {
        PGresult *result = NULL;
        
 {
        PGresult *result = NULL;
        


@@ -113,7 +109,7 @@ bool starttrans(void)
  *
  *     Ends a transaction.
  */
  *
  *     Ends a transaction.
  */

-void endtrans(void)
+static void pg_endtrans(void)

 {
        PGresult *result = NULL;
 
 {
        PGresult *result = NULL;
 


@@ -135,7 +131,7 @@ void endtrans(void)
  *     in and then parse_keys() to parse the packets into a publickey
  *     structure.
  */
  *     in and then parse_keys() to parse the packets into a publickey
  *     structure.
  */

-int fetch_key(uint64_t keyid, struct openpgp_publickey **publickey,
+static int pg_fetch_key(uint64_t keyid, struct openpgp_publickey **publickey,

                bool intrans)
 {
        struct openpgp_packet_list *packets = NULL;
                bool intrans)
 {
        struct openpgp_packet_list *packets = NULL;


@@ -204,7 +200,8 @@ int fetch_key(uint64_t keyid, struct openpgp_publickey **publickey,
  *     This function searches for the supplied text and returns the keys that
  *     contain it.
  */
  *     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)
+static int pg_fetch_key_text(const char *search,
+               struct openpgp_publickey **publickey)

 {
        struct openpgp_packet_list *packets = NULL;
        PGresult *result = NULL;
 {
        struct openpgp_packet_list *packets = NULL;
        PGresult *result = NULL;


@@ -243,7 +240,8 @@ int fetch_key_text(const char *search, struct openpgp_publickey **publickey)
                                                "Can't open large object.");
                        } else {
                                read_openpgp_stream(keydb_fetchchar, &fd,
                                                "Can't open large object.");
                        } else {
                                read_openpgp_stream(keydb_fetchchar, &fd,

-                                               &packets);
+                                               &packets,
+                                               0);

                                parse_keys(packets, publickey);
                                lo_close(dbconn, fd);
                                free_packet_list(packets);
                                parse_keys(packets, publickey);
                                lo_close(dbconn, fd);
                                free_packet_list(packets);


@@ -261,6 +259,75 @@ int fetch_key_text(const char *search, struct openpgp_publickey **publickey)
        return (numkeys);
 }
 
        return (numkeys);
 }
 

+/**
+ *     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.
+ */
+static int pg_delete_key(uint64_t keyid, bool intrans)
+{
+       PGresult *result = NULL;
+       char *oids = NULL;
+       char statement[1024];
+       int found = 1;
+       int i;
+       Oid key_oid;
+
+       if (!intrans) {
+               result = PQexec(dbconn, "BEGIN");
+               PQclear(result);
+       }
+       
+       snprintf(statement, 1023,
+                       "SELECT keydata FROM onak_keys WHERE keyid = '%llX'",
+                       keyid);
+       result = PQexec(dbconn, statement);
+
+       if (PQresultStatus(result) == PGRES_TUPLES_OK) {
+               found = 0;
+               i = PQntuples(result);
+               while (i > 0) {
+                       oids = PQgetvalue(result, i-1, 0);
+                       key_oid = (Oid) atoi(oids);
+                       lo_unlink(dbconn, key_oid);
+                       i--;
+               }
+               PQclear(result);
+
+               snprintf(statement, 1023,
+                       "DELETE FROM onak_keys WHERE keyid = '%llX'",
+                       keyid);
+               result = PQexec(dbconn, statement);
+               PQclear(result);
+
+               snprintf(statement, 1023,
+                       "DELETE FROM onak_sigs WHERE signee = '%llX'",
+                       keyid);
+               result = PQexec(dbconn, statement);
+               PQclear(result);
+
+               snprintf(statement, 1023,
+                       "DELETE FROM onak_uids WHERE keyid = '%llX'",
+                       keyid);
+               result = PQexec(dbconn, statement);
+       } else if (PQresultStatus(result) != PGRES_TUPLES_OK) {
+               logthing(LOGTHING_ERROR,
+                               "Problem retrieving key (%llX) from DB.",
+                               keyid);
+       }
+
+       PQclear(result);
+
+       if (!intrans) {
+               result = PQexec(dbconn, "COMMIT");
+               PQclear(result);
+       }
+       return (found);
+}
+

 /**
  *     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.


@@ -273,7 +340,8 @@ int fetch_key_text(const char *search, struct openpgp_publickey **publickey)
  *     the file. If update is true then we delete the old key first, otherwise
  *     we trust that it doesn't exist.
  */
  *     the file. If update is true then we delete the old key first, otherwise
  *     we trust that it doesn't exist.
  */

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

 {
        struct openpgp_packet_list *packets = NULL;
        struct openpgp_packet_list *list_end = NULL;
 {
        struct openpgp_packet_list *packets = NULL;
        struct openpgp_packet_list *list_end = NULL;


@@ -302,7 +370,7 @@ int store_key(struct openpgp_publickey *publickey, bool intrans, bool update)
         * it definitely needs updated.
         */
        if (update) {
         * it definitely needs updated.
         */
        if (update) {

-               delete_key(get_keyid(publickey), true);
+               pg_delete_key(get_keyid(publickey), true);

        }
 
        next = publickey->next;
        }
 
        next = publickey->next;


@@ -396,80 +464,11 @@ int store_key(struct openpgp_publickey *publickey, bool intrans, bool update)
        return 0;
 }
 
        return 0;
 }
 

-/**
- *     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.
- */
-int delete_key(uint64_t keyid, bool intrans)
-{
-       PGresult *result = NULL;
-       char *oids = NULL;
-       char statement[1024];
-       int found = 1;
-       int i;
-       Oid key_oid;
-
-       if (!intrans) {
-               result = PQexec(dbconn, "BEGIN");
-               PQclear(result);
-       }
-       
-       snprintf(statement, 1023,
-                       "SELECT keydata FROM onak_keys WHERE keyid = '%llX'",
-                       keyid);
-       result = PQexec(dbconn, statement);
-
-       if (PQresultStatus(result) == PGRES_TUPLES_OK) {
-               found = 0;
-               i = PQntuples(result);
-               while (i > 0) {
-                       oids = PQgetvalue(result, i-1, 0);
-                       key_oid = (Oid) atoi(oids);
-                       lo_unlink(dbconn, key_oid);
-                       i--;
-               }
-               PQclear(result);
-
-               snprintf(statement, 1023,
-                       "DELETE FROM onak_keys WHERE keyid = '%llX'",
-                       keyid);
-               result = PQexec(dbconn, statement);
-               PQclear(result);
-
-               snprintf(statement, 1023,
-                       "DELETE FROM onak_sigs WHERE signee = '%llX'",
-                       keyid);
-               result = PQexec(dbconn, statement);
-               PQclear(result);
-
-               snprintf(statement, 1023,
-                       "DELETE FROM onak_uids WHERE keyid = '%llX'",
-                       keyid);
-               result = PQexec(dbconn, statement);
-       } else if (PQresultStatus(result) != PGRES_TUPLES_OK) {
-               logthing(LOGTHING_ERROR,
-                               "Problem retrieving key (%llX) from DB.",
-                               keyid);
-       }
-
-       PQclear(result);
-
-       if (!intrans) {
-               result = PQexec(dbconn, "COMMIT");
-               PQclear(result);
-       }
-       return (found);
-}
-

 /**
  *     keyid2uid - Takes a keyid and returns the primary UID for it.
  *     @keyid: The keyid to lookup.
  */
 /**
  *     keyid2uid - Takes a keyid and returns the primary UID for it.
  *     @keyid: The keyid to lookup.
  */

-char *keyid2uid(uint64_t keyid)
+static char *pg_keyid2uid(uint64_t keyid)

 {
        PGresult *result = NULL;
        char statement[1024];
 {
        PGresult *result = NULL;
        char statement[1024];


@@ -509,7 +508,7 @@ char *keyid2uid(uint64_t keyid)
  *     This function gets the list of signatures on a key. Used for key 
  *     indexing and doing stats bits.
  */
  *     This function gets the list of signatures on a key. Used for key 
  *     indexing and doing stats bits.
  */

-struct ll *getkeysigs(uint64_t keyid, bool *revoked)
+static struct ll *pg_getkeysigs(uint64_t keyid, bool *revoked)

 {
        struct ll *sigs = NULL;
        PGresult *result = NULL;
 {
        struct ll *sigs = NULL;
        PGresult *result = NULL;


@@ -571,22 +570,84 @@ struct ll *getkeysigs(uint64_t keyid, bool *revoked)
 }
 
 /**
 }
 
 /**

- *     dumpdb - dump the key database
- *     @filenamebase: The base filename to use for the dump.
+ *     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.

  *
  *

- *     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)
+ *     Returns the number of keys we iterated over.
+ */
+static int pg_iterate_keys(void (*iterfunc)(void *ctx,
+               struct openpgp_publickey *key), void *ctx)

 {
 {

-       return 0;
+       struct openpgp_packet_list *packets = NULL;
+       struct openpgp_publickey *key = NULL;
+       PGresult *result = NULL;
+       char *oids = NULL;
+       char statement[1024];
+       int fd = -1;
+       int i = 0;
+       int numkeys = 0;
+       Oid key_oid;
+
+       result = PQexec(dbconn, "SELECT keydata FROM onak_keys;");
+
+       if (PQresultStatus(result) == PGRES_TUPLES_OK) {
+               numkeys = PQntuples(result);
+               for (i = 0; i < numkeys; i++) {
+                       oids = PQgetvalue(result, i, 0);
+                       key_oid = (Oid) atoi(oids);
+
+                       fd = lo_open(dbconn, key_oid, INV_READ);
+                       if (fd < 0) {
+                               logthing(LOGTHING_ERROR,
+                                               "Can't open large object.");
+                       } else {
+                               read_openpgp_stream(keydb_fetchchar, &fd,
+                                               &packets, 0);
+                               parse_keys(packets, key);
+                               lo_close(dbconn, fd);
+
+                               iterfunc(ctx, key);
+                                       
+                               free_publickey(key);
+                               key = NULL;
+                               free_packet_list(packets);
+                               packets = NULL;
+                       }
+               }
+       } else if (PQresultStatus(result) != PGRES_TUPLES_OK) {
+               logthing(LOGTHING_ERROR, "Problem retrieving key from DB.");
+       }
+
+       PQclear(result);
+
+       return (numkeys);

 }
 
 /*
  * Include the basic keydb routines.
  */
 #define NEED_GETFULLKEYID 1
 }
 
 /*
  * Include the basic keydb routines.
  */
 #define NEED_GETFULLKEYID 1

+#define NEED_UPDATEKEYS 1

 #include "keydb.c"
 #include "keydb.c"

+
+struct dbfuncs keydb_pg_funcs = {
+       .initdb                 = pg_initdb,
+       .cleanupdb              = pg_cleanupdb,
+       .starttrans             = pg_starttrans,
+       .endtrans               = pg_endtrans,
+       .fetch_key              = pg_fetch_key,
+       .fetch_key_text         = pg_fetch_key_text,
+       .store_key              = pg_store_key,
+       .update_keys            = generic_update_keys,
+       .delete_key             = pg_delete_key,
+       .getkeysigs             = pg_getkeysigs,
+       .cached_getkeysigs      = generic_cached_getkeysigs,
+       .keyid2uid              = pg_keyid2uid,
+       .getfullkeyid           = generic_getfullkeyid,
+       .iterate_keys           = pg_iterate_keys,
+};