/* -*-c-*-
*
- * $Id: key.h,v 1.9 2001/06/22 19:37:59 mdw Exp $
+ * $Id$
*
* Simple key management
*
* (c) 1999 Straylight/Edgeware
*/
-/*----- Licensing notice --------------------------------------------------*
+/*----- Licensing notice --------------------------------------------------*
*
* This file is part of Catacomb.
*
* it under the terms of the GNU Library General Public License as
* published by the Free Software Foundation; either version 2 of the
* License, or (at your option) any later version.
- *
+ *
* Catacomb is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU Library General Public License for more details.
- *
+ *
* You should have received a copy of the GNU Library General Public
* License along with Catacomb; if not, write to the Free
* Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
* MA 02111-1307, USA.
*/
-/*----- Revision history --------------------------------------------------*
- *
- * $Log: key.h,v $
- * Revision 1.9 2001/06/22 19:37:59 mdw
- * New interface to enquire whether a key has expired.
- *
- * 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
#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
typedef struct key {
/* --- Hashtable management --- */
-
+
hash_base _b; /* Symbol table data */
struct key *next; /* Next key of the same type */
/* --- The key data itself --- */
- key_data k; /* The actual key data */
+ key_data *k; /* The actual key data */
/* --- Other attributes and commentary --- */
#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 {
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 void key_discard(key_file */*f*/);
+
/* --- @key_close@ --- *
*
* Arguments: @key_file *f@ = pointer to key file block
* @uint32 id@ = keyid to set
* @const char *type@ = the type of this key
* @time_t exp@ = when the key expires
- * @int *err@ = where to store the error condition
+ * @key *kk@ = where to put the key pointer
*
- * Returns: Key block containing new data, or null if it couldn't be
- * done.
+ * Returns: Error code (one of the @KERR@ constants).
*
* Use: Attaches a new key to a key file. You must have a writable
* key file for this to work.
* You have to set the actual key yourself.
*/
-extern key *key_new(key_file */*f*/, uint32 /*id*/, const char */*type*/,
- time_t /*exp*/, int */*err*/);
+extern int key_new(key_file */*f*/, uint32 /*id*/, const char */*type*/,
+ time_t /*exp*/, key **/*kk*/);
/* --- @key_delete@ --- *
*
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@ --- *
extern int key_settag(key_file */*f*/, key */*k*/, const char */*tag*/);
+/* --- @key_setkeydata@ --- *
+ *
+ * Arguments: @key_file *kf@ = pointer to key file
+ * @key *k@ = pointer to key
+ * @key_data *kd@ = new key data
+ *
+ * Returns: Zero on success, or a @KERR_@ error code on failure.
+ *
+ * Use: Sets the key data for a key.
+ */
+
+extern int key_setkeydata(key_file */*kf*/, key */*k*/, key_data */*kd*/);
+
/* --- @key_fulltag@ --- *
*
* Arguments: @key *k@ = pointer to key
* @const char *tag@ = pointer to tag string
* @dstr *d@ = pointer to string for full tag name
* @key **k@ = where to store the key pointer
- * @key_data **kd@ = where to store the key data pointer
+ * @key_data ***kd@ = where to store the key data pointer
*
* Returns: Zero if OK, nonzero if it failed.
*
* qualified by the names of subkeys, separated by dots. Hence,
* a qualified tag is ID|TAG[.TAG...]. The various result
* pointers can be null to indicate that the result isn't
- * interesting.
+ * interesting.
*/
extern int key_qtag(key_file */*f*/, const char */*tag*/,
- dstr */*d*/, key **/*k*/, key_data **/*kd*/);
+ dstr */*d*/, key **/*k*/, key_data ***/*kd*/);
/* --- @key_getattr@ --- *
*
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
projects / u / mdw / catacomb / blobdiff