Uprating of the passphrase pixie.

[u/mdw/catacomb] / key.h

diff --git a/key.h b/key.h
index 09bcad5..aad448b 100644 (file)
--- a/key.h
+++ b/key.h
@@ -1,6 +1,6 @@
 /* -*-c-*-
  *
- * $Id: key.h,v 1.8 2001/02/03 11:57:38 mdw Exp $
+ * $Id$
  *
  * Simple key management
  *
@@ -27,36 +27,6 @@
  * MA 02111-1307, USA.
  */
 
-/*----- Revision history --------------------------------------------------* 
- *
- * $Log: key.h,v $
- * Revision 1.8  2001/02/03 11:57:38  mdw
- * Allow creating keyfiles with no file attached.
- *
- * Revision 1.7  2000/12/06 20:33:27  mdw
- * Make flags be macros rather than enumerations, to ensure that they're
- * unsigned.
- *
- * Revision 1.6  2000/06/17 11:27:43  mdw
- * Add key fetching interface.
- *
- * Revision 1.5  2000/02/12 18:55:40  mdw
- * Make it all compile properly.
- *
- * Revision 1.4  2000/02/12 18:21:02  mdw
- * Overhaul of key management (again).
- *
- * Revision 1.3  1999/12/22 15:47:48  mdw
- * Major key-management revision.
- *
- * Revision 1.2  1999/12/10 23:29:48  mdw
- * Change header file guard names.
- *
- * Revision 1.1  1999/09/03 08:41:12  mdw
- * Initial import.
- *
- */
-
 #ifndef CATACOMB_KEY_H
 #define CATACOMB_KEY_H
 
@@ -74,10 +44,18 @@
 #include <mLib/hash.h>
 #include <mLib/sym.h>
 
+#ifndef CATACOMB_KEY_ERROR_H
+#  include "key-error.h"
+#endif
+
 #ifndef CATACOMB_KEY_DATA_H
 #  include "key-data.h"
 #endif
 
+#ifndef CATACOMB_GHASH_H
+#  include "ghash.h"
+#endif
+
 #ifndef CATACOMB_MP_H
 #  include "mp.h"
 #endif
@@ -181,25 +159,6 @@ typedef struct key_fetchdef {
 #define KEXP_FOREVER ((time_t)-1)      /* Never expire this key */
 #define KEXP_EXPIRE ((time_t)-2)       /* Expire this key when unused */
 
-/* --- Key error codes --- */
-
-enum {
-  KERR_OK = 0,                         /* No error */
-  KERR_BADTAG = -1,                    /* Malformed tag string */
-  KERR_BADTYPE = -2,                   /* Malformed type string */
-  KERR_BADCOMMENT = -3,                        /* Malformed comment string */
-  KERR_DUPID = -4,                     /* Duplicate keyid */
-  KERR_DUPTAG = -5,                    /* Duplicate key tag string */
-  KERR_READONLY = -6,                  /* Key file is read-only */
-  KERR_WILLEXPIRE = -7,                        /* Key will eventually expire */
-  KERR_EXPIRED = -8,                   /* Key has already expired */
-  KERR_BADFLAGS = -9,                  /* Error in flags string */
-  KERR_BADPASS = -10,                  /* Error decrypting locked key */
-  KERR_WRONGTYPE = -11,                        /* Key has incorrect type */
-  KERR_NOTFOUND = -12,                 /* Key couldn't be found */
-  KERR_MAX                             /* Largest possible error */
-};
-
 /* --- Write error codes --- */
 
 enum {
@@ -272,6 +231,17 @@ extern int key_extract(key_file */*f*/, key */*k*/, FILE */*fp*/,
 extern int key_open(key_file */*f*/, const char */*file*/, unsigned /*how*/,
                    key_reporter */*rep*/, void */*arg*/);
 
+/* --- @key_discard@ --- *
+ *
+ * Arguments:  @key_file *f@ = pointer to key file block
+ *
+ * Returns:    ---
+ *
+ * Use:                Frees all the key data, without writing changes.
+ */
+
+extern int key_discard(key_file */*f*/);
+
 /* --- @key_close@ --- *
  *
  * Arguments:  @key_file *f@ = pointer to key file block
@@ -374,6 +344,15 @@ extern key *key_new(key_file */*f*/, uint32 /*id*/, const char */*type*/,
 
 extern int key_delete(key_file */*f*/, key */*k*/);
 
+/* --- @key_expired@ --- *
+ *
+ * Arguments:  @key *k@ = pointer to key block
+ *
+ * Returns:    Zero if the key is OK, nonzero if it's expired.
+ */
+
+int key_expired(key */*k*/);
+
 /* --- @key_expire@ --- *
  *
  * Arguments:  @key_file *f@ = pointer to file block
@@ -408,6 +387,20 @@ extern int key_expire(key_file */*f*/, key */*k*/);
 
 extern int key_used(key_file */*f*/, key */*k*/, time_t /*t*/);
 
+/* --- @key_fingerprint@ --- *
+ *
+ * Arguments:  @key *k@ = the key to fingerprint
+ *             @ghash *h@ = the hash to use
+ *             @const key_filter *kf@ = filter to apply
+ *
+ * Returns:    Nonzero if the key slightly matched the filter.
+ *
+ * Use:                Updates the hash context with the key contents.
+ */
+
+extern int key_fingerprint(key */*k*/, ghash */*h*/,
+                          const key_filter */*kf*/);
+
 /*----- Setting and reading attributes ------------------------------------*/
 
 /* --- @key_chkident@ --- *
@@ -688,17 +681,6 @@ extern void key_fetchdone(key_packdef */*kp*/);
 extern void key_moan(const char */*file*/, int /*line*/,
                     const char */*msg*/, void */*p*/);
 
-/* --- @key_strerror@ --- *
- *
- * Arguments:  @int err@ = error code from @key_new@
- *
- * Returns:    Pointer to error string.
- *
- * Use:                Translates a @KERR@ error code into a human-readable string.
- */
-
-extern const char *key_strerror(int /*err*/);
-
 /*----- That's all, folks -------------------------------------------------*/
 
 #ifdef __cplusplus