X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/d901c8888560a1745ecee7c8d5ddad6229aafc66..1d6d3b01cb40e0cfaeb816c87c513695aea0816a:/key.h diff --git a/key.h b/key.h index 6f5bedb..dffd0eb 100644 --- a/key.h +++ b/key.h @@ -7,7 +7,7 @@ * (c) 1999 Straylight/Edgeware */ -/*----- Licensing notice --------------------------------------------------* +/*----- Licensing notice --------------------------------------------------* * * This file is part of Catacomb. * @@ -15,12 +15,12 @@ * 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, @@ -44,6 +44,10 @@ #include #include +#ifndef CATACOMB_KEY_ERROR_H +# include "key-error.h" +#endif + #ifndef CATACOMB_KEY_DATA_H # include "key-data.h" #endif @@ -80,7 +84,7 @@ typedef struct key_attr { typedef struct key { /* --- Hashtable management --- */ - + hash_base _b; /* Symbol table data */ struct key *next; /* Next key of the same type */ @@ -93,7 +97,7 @@ typedef struct key { /* --- The key data itself --- */ - key_data k; /* The actual key data */ + key_data *k; /* The actual key data */ /* --- Other attributes and commentary --- */ @@ -155,26 +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_BADATTR = -13, /* Malformed attribute name */ - KERR_MAX /* Largest possible error */ -}; - /* --- Write error codes --- */ enum { @@ -256,7 +240,7 @@ extern int key_open(key_file */*f*/, const char */*file*/, unsigned /*how*/, * Use: Frees all the key data, without writing changes. */ -extern int key_discard(key_file */*f*/); +extern void key_discard(key_file */*f*/); /* --- @key_close@ --- * * @@ -318,10 +302,9 @@ extern int key_lockfile(key_file */*f*/, const char */*file*/, * @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. @@ -340,8 +323,8 @@ extern int key_lockfile(key_file */*f*/, const char */*file*/, * 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@ --- * * @@ -467,6 +450,19 @@ extern int key_setcomment(key_file */*f*/, key */*k*/, const char */*c*/); 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 @@ -487,7 +483,7 @@ extern void key_fulltag(key */*k*/, dstr */*d*/); * @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. * @@ -495,11 +491,11 @@ extern void key_fulltag(key */*k*/, dstr */*d*/); * 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@ --- * * @@ -697,17 +693,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