X-Git-Url: https://git.distorted.org.uk/u/mdw/catacomb/blobdiff_plain/052b36d05a622a93733b735acce2de865b14627b..7675ae6bdd4a8372b734ebcb90ee9b6fe13cc14a:/key-data.h diff --git a/key-data.h b/key-data.h index 6cf2439..5644834 100644 --- a/key-data.h +++ b/key-data.h @@ -1,6 +1,6 @@ /* -*-c-*- * - * $Id: key-data.h,v 1.1 2000/02/12 18:21:23 mdw Exp $ + * $Id$ * * Manipulating key data * @@ -27,14 +27,6 @@ * MA 02111-1307, USA. */ -/*----- Revision history --------------------------------------------------* - * - * $Log: key-data.h,v $ - * Revision 1.1 2000/02/12 18:21:23 mdw - * Overhaul of key management (again). - * - */ - #ifndef CATACOMB_KEY_DATA_H #define CATACOMB_KEY_DATA_H @@ -50,10 +42,18 @@ #include #include +#ifndef CATACOMB_KEY_ERROR_H +# include "key-error.h" +#endif + #ifndef CATACOMB_MP_H # include "mp.h" #endif +#ifndef CATACOMB_EC_H +# include "ec.h" +#endif + /*----- Data structures ---------------------------------------------------*/ /* --- Key binary data --- */ @@ -71,6 +71,8 @@ typedef struct key_data { key_bin k; /* Binary key data */ mp *m; /* Multiprecision integer */ sym_table s; /* Structured key data */ + char *p; /* String pointer */ + ec e; /* Elliptic curve point */ } u; } key_data; @@ -79,6 +81,18 @@ typedef struct key_struct { key_data k; } key_struct; +/* --- Packing and unpacking --- */ + +typedef struct key_packdef { + void *p; /* Pointer to the destination */ + key_data kd; /* Key data block */ +} key_packdef; + +typedef struct key_packstruct { + char *name; /* Pointer to name string */ + key_packdef kp; /* Packing structure */ +} key_packstruct; + /* --- Key binary encoding --- * * * The binary encoding consists of a header containing a 16-bit encoding type @@ -103,11 +117,13 @@ enum { /* --- Bottom two bits are the encoding type --- */ - KF_ENCMASK = 0x03, /* Encoding mask */ + KF_ENCMASK = 0x83, /* Encoding mask */ KENC_BINARY = 0x00, /* Plain binary key (@k@) */ KENC_MP = 0x01, /* Multiprecision integer (@i@) */ KENC_STRUCT = 0x02, /* Structured key data (@s@) */ KENC_ENCRYPT = 0x03, /* Encrypted key type (@k@) */ + KENC_STRING = 0x80, /* ASCII string (@p@) */ + KENC_EC = 0x81, /* Elliptic curve point (@e@) */ /* --- Key category bits --- */ @@ -122,12 +138,20 @@ enum { KF_BURN = 0x10, /* Burn key after use */ KF_TEMP = 0x20, /* Temporary copy flag */ + KF_OPT = 0x40, /* Optional key (for @key_unpack@) */ /* --- Tag end --- */ KENC_MAX /* Dummy limit constant */ }; +/* --- Key locking return codes --- */ + +#define KL_OK 0 /* All good */ +#define KL_IOERR -1 /* I/O problem (e.g., getting pp) */ +#define KL_KEYERR -2 /* Wrong key supplied */ +#define KL_DATAERR -3 /* Data format error */ + /* --- Key flag filtering --- */ typedef struct key_filter { @@ -223,6 +247,30 @@ extern void key_encrypted(key_data */*k*/, const void */*p*/, size_t /*sz*/); extern void key_mp(key_data */*k*/, mp */*m*/); +/* --- @key_string@ --- * + * + * Arguments: @key_data *k@ = pointer to key data block + * @const char *p@ = pointer to the value to set + * + * Returns: --- + * + * Use: Sets a plain string in a key block. + */ + +extern void key_string(key_data */*k*/, const char */*p*/); + +/* --- @key_ec@ --- * + * + * Arguments: @key_data *k@ = pointer to key data block + * @const ec *e@ = pointer to the value to set + * + * Returns: --- + * + * Use: Sets an elliptic curve point in a key block. + */ + +extern void key_ec(key_data */*k*/, const ec */*e*/); + /* --- @key_structure@ --- * * * Arguments: @key_data *k@ = pointer to key data block @@ -330,7 +378,7 @@ extern int key_read(const char */*p*/, key_data */*k*/, char **/*pp*/); */ extern int key_write(key_data */*k*/, dstr */*d*/, - const key_filter */*kf*/); + const key_filter */*kf*/); /*----- Key binary encoding -----------------------------------------------*/ @@ -361,7 +409,77 @@ extern int key_decode(const void */*p*/, size_t /*sz*/, key_data */*k*/); extern int key_encode(key_data */*k*/, dstr */*d*/, const key_filter */*kf*/); -/*----- Passphrase encryption ---------------------------------------------*/ +/*----- Packing and unpacking keys ----------------------------------------*/ + +/* --- @key_pack@ --- * + * + * Arguments: @key_packdef *kp@ = pointer to packing structure + * @key_data *kd@ = pointer to destination key data + * @dstr *d@ = pointer to tag string for the key data + * + * Returns: Error code, or zero. + * + * Use: Packs a key from a data structure. + */ + +extern int key_pack(key_packdef */*kp*/, key_data */*kd*/, dstr */*d*/); + +/* --- @key_unpack@ --- * + * + * Arguments: @key_packdef *kp@ = pointer to packing structure + * @key_data *kd@ = pointer to source key data + * @dstr *d@ = pointer to tag string for the key data + * + * Returns: Error code, or zero. + * + * Use: Unpacks a key into an appropriate data structure. + */ + +extern int key_unpack(key_packdef */*kp*/, key_data */*kd*/, dstr */*d*/); + +/* --- @key_unpackdone@ --- * + * + * Arguments: @key_packdef *kp@ = pointer to packing definition + * + * Returns: --- + * + * Use: Frees the key components contained within a packing + * definition, created during key unpacking. + */ + +extern void key_unpackdone(key_packdef */*kp*/); + +/*----- Key encryption ----------------------------------------------------*/ + +/* --- @key_lock@ --- * + * + * Arguments: @key_data *kt@ = destination block + * @key_data *k@ = source key data block + * @const void *e@ = secret to encrypt key with + * @size_t esz@ = size of the secret + * + * Returns: --- + * + * Use: Encrypts a key data block using a secret. + */ + +extern void key_lock(key_data */*kt*/, key_data */*k*/, + const void */*e*/, size_t /*esz*/); + +/* --- @key_unlock@ --- * + * + * Arguments: @key_data *kt@ = target block + * @key_data *k@ = source key data block + * @const void *e@ = secret to decrypt the block with + * @size_t esz@ = size of the secret + * + * Returns: Zero for success, or a @KERR_@ error code. + * + * Use: Unlocks a key using a secret. + */ + +extern int key_unlock(key_data */*kt*/, key_data */*k*/, + const void */*e*/, size_t /*esz*/); /* --- @key_plock@ --- * * @@ -369,7 +487,7 @@ extern int key_encode(key_data */*k*/, dstr */*d*/, * @key_data *k@ = source key data block * @key_data *kt@ = target key data block * - * Returns: Zero if successful, nonzero if there was a problem. + * Returns: Zero if successful, a @KERR@ error code on failure. * * Use: Locks a key by encrypting it with a passphrase. */ @@ -382,7 +500,7 @@ extern int key_plock(const char */*tag*/, key_data */*k*/, key_data */*kt*/); * @key_data *k@ = source key data block * @key_data *kt@ = target key data block * - * Returns: Zero if it worked, nonzero if it didn't. + * Returns: Zero if successful, a @KERR@ error code on failure. * * Use: Unlocks a passphrase-locked key. */