3 * $Id: key-data.h,v 1.3 2004/03/28 01:58:47 mdw Exp $
5 * Manipulating key data
7 * (c) 1999 Straylight/Edgeware
10 /*----- Licensing notice --------------------------------------------------*
12 * This file is part of Catacomb.
14 * Catacomb is free software; you can redistribute it and/or modify
15 * it under the terms of the GNU Library General Public License as
16 * published by the Free Software Foundation; either version 2 of the
17 * License, or (at your option) any later version.
19 * Catacomb is distributed in the hope that it will be useful,
20 * but WITHOUT ANY WARRANTY; without even the implied warranty of
21 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
22 * GNU Library General Public License for more details.
24 * You should have received a copy of the GNU Library General Public
25 * License along with Catacomb; if not, write to the Free
26 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
30 /*----- Revision history --------------------------------------------------*
32 * $Log: key-data.h,v $
33 * Revision 1.3 2004/03/28 01:58:47 mdw
34 * Generate, store and retreive elliptic curve keys.
36 * Revision 1.2 2000/06/17 11:26:18 mdw
37 * Add the key packing interface.
39 * Revision 1.1 2000/02/12 18:21:23 mdw
40 * Overhaul of key management (again).
44 #ifndef CATACOMB_KEY_DATA_H
45 #define CATACOMB_KEY_DATA_H
51 /*----- Header files ------------------------------------------------------*/
55 #include <mLib/bits.h>
56 #include <mLib/dstr.h>
67 /*----- Data structures ---------------------------------------------------*/
69 /* --- Key binary data --- */
71 typedef struct key_bin
{
72 octet
*k
; /* Pointer to key data */
73 size_t sz
; /* Size of the key data (in bytes) */
76 /* --- Key data structure --- */
78 typedef struct key_data
{
79 unsigned e
; /* Encoding type for key data */
81 key_bin k
; /* Binary key data */
82 mp
*m
; /* Multiprecision integer */
83 sym_table s
; /* Structured key data */
84 char *p
; /* String pointer */
85 ec e
; /* Elliptic curve point */
89 typedef struct key_struct
{
94 /* --- Packing and unpacking --- */
96 typedef struct key_packdef
{
97 void *p
; /* Pointer to the destination */
98 key_data kd
; /* Key data block */
101 typedef struct key_packstruct
{
102 char *name
; /* Pointer to name string */
103 key_packdef kp
; /* Packing structure */
106 /* --- Key binary encoding --- *
108 * The binary encoding consists of a header containing a 16-bit encoding type
109 * and a 16-bit length, followed immediately by the key data, followed by
110 * between zero and three zero bytes to make the total length a multiple of
111 * four. The format of the following data depends on the encoding type:
113 * @KENC_BINARY@ Binary data.
115 * @KENC_MP@ Octet array interpreted in big-endian byte order.
117 * @KENC_STRUCT@ An array of pairs, each containing a string (8-bit
118 * length followed by data and zero-padding to 4-byte
119 * boundary) and key binary encodings.
121 * @KENC_ENCRYPT@ Binary data, format
124 /* --- Key encoding methods and other flags--- */
128 /* --- Bottom two bits are the encoding type --- */
130 KF_ENCMASK
= 0x83, /* Encoding mask */
131 KENC_BINARY
= 0x00, /* Plain binary key (@k@) */
132 KENC_MP
= 0x01, /* Multiprecision integer (@i@) */
133 KENC_STRUCT
= 0x02, /* Structured key data (@s@) */
134 KENC_ENCRYPT
= 0x03, /* Encrypted key type (@k@) */
135 KENC_STRING
= 0x80, /* ASCII string (@p@) */
136 KENC_EC
= 0x81, /* Elliptic curve point (@e@) */
138 /* --- Key category bits --- */
140 KF_CATMASK
= 0x0c, /* Category mask */
141 KCAT_SYMM
= 0x00, /* Symmetric encryption key */
142 KCAT_PRIV
= 0x04, /* Private (asymmetric) key */
143 KCAT_PUB
= 0x08, /* Public (asymmetric) key */
144 KCAT_SHARE
= 0x0c, /* Shared (asymmetric) key */
145 KF_NONSECRET
= 0x08, /* Bit flag for non-secret keys */
147 /* --- Other flags --- */
149 KF_BURN
= 0x10, /* Burn key after use */
150 KF_TEMP
= 0x20, /* Temporary copy flag */
151 KF_OPT
= 0x40, /* Optional key (for @key_unpack@) */
153 /* --- Tag end --- */
155 KENC_MAX
/* Dummy limit constant */
158 /* --- Key flag filtering --- */
160 typedef struct key_filter
{
165 /* --- Matching aginst key selection --- */
167 #define KEY_MATCH(kd, kf) \
169 ((kd)->e & KF_ENCMASK) == KENC_STRUCT || \
170 ((kd)->e & (kf)->m) == (kf)->f)
172 /*----- Key flags and filtering -------------------------------------------*/
174 /* --- @key_readflags@ --- *
176 * Arguments: @const char *p@ = pointer to string to read
177 * @char **pp@ = where to store the end pointer
178 * @unsigned *ff@ = where to store the flags
179 * @unsigned *mm@ = where to store the mask
181 * Returns: Zero if all went well, nonzero if there was an error.
183 * Use: Reads a flag string.
186 extern int key_readflags(const char */
*p*/
, char **/
*pp*/
,
187 unsigned */
*ff*/
, unsigned */
*mm*/
);
189 /* --- @key_writeflags@ --- *
191 * Arguments: @unsigned f@ = flags to write
192 * @dstr *d@ = pointer to destination string
196 * Use: Emits a flags word as a string representation.
199 extern void key_writeflags(unsigned /*f*/, dstr */
*d*/
);
201 /* --- @key_match@ --- *
203 * Arguments: @key_data *k@ = pointer to key data block
204 * @const key_filter *kf@ = pointer to filter block
206 * Returns: Nonzero if the key matches the filter.
208 * Use: Checks whether a key matches a filter.
211 extern int key_match(key_data */
*k*/
, const key_filter */
*kf*/
);
213 /*----- Setting new key data ----------------------------------------------*/
215 /* --- @key_binary@ --- *
217 * Arguments: @key_data *k@ = pointer to key data block
218 * @const void *p@ = pointer to key data
219 * @size_t sz@ = size of the key data
223 * Use: Sets a binary key in a key data block.
226 extern void key_binary(key_data */
*k*/
, const void */
*p*/
, size_t /*sz*/);
228 /* --- @key_encrypted@ --- *
230 * Arguments: @key_data *k@ = pointer to key data block
231 * @const void *p@ = pointer to key data
232 * @size_t sz@ = size of the key data
236 * Use: Sets an encrypted key in a key data block.
239 extern void key_encrypted(key_data */
*k*/
, const void */
*p*/
, size_t /*sz*/);
241 /* --- @key_mp@ --- *
243 * Arguments: @key_data *k@ = pointer to key data block
244 * @mp *m@ = pointer to the value to set
248 * Use: Sets a multiprecision integer key in a key block.
251 extern void key_mp(key_data */
*k*/
, mp */
*m*/
);
253 /* --- @key_string@ --- *
255 * Arguments: @key_data *k@ = pointer to key data block
256 * @const char *p@ = pointer to the value to set
260 * Use: Sets a plain string in a key block.
263 extern void key_string(key_data */
*k*/
, const char */
*p*/
);
265 /* --- @key_ec@ --- *
267 * Arguments: @key_data *k@ = pointer to key data block
268 * @const ec *e@ = pointer to the value to set
272 * Use: Sets an elliptic curve point in a key block.
275 extern void key_ec(key_data */
*k*/
, const ec */
*e*/
);
277 /* --- @key_structure@ --- *
279 * Arguments: @key_data *k@ = pointer to key data block
283 * Use: Initializes a structured key type.
286 extern void key_structure(key_data */
*k*/
);
288 /* --- @key_structfind@ --- *
290 * Arguments: @key_data *k@ = pointer to key data block
291 * @const char *tag@ = pointer to tag string
293 * Returns: Pointer to key data block, or null.
295 * Use: Looks up the tag in a structured key.
298 extern key_data
*key_structfind(key_data */
*k*/
, const char */
*tag*/
);
300 /* --- @key_structcreate@ --- *
302 * Arguments: @key_data *k@ = pointer to key data block
303 * @const char *tag@ = pointer to tag string
305 * Returns: Pointer to newly created key data.
307 * Use: Creates a new uninitialized subkey.
310 extern key_data
*key_structcreate(key_data */
*k*/
, const char */
*tag*/
);
312 /*----- Miscellaneous operations ------------------------------------------*/
314 /* --- @key_destroy@ --- *
316 * Arguments: @key_data *k@ = pointer to key data to destroy
320 * Use: Destroys a lump of key data.
323 extern void key_destroy(key_data */
*k*/
);
325 /* --- @key_do@ --- *
327 * Arguments: @key_data *k@ = pointer to key data block
328 * @const key_filter *kf@ = pointer to filter block
329 * @dstr *d@ = pointer to base string
330 * @int (*func)(key_data *kd, dstr *d, void *p@ = function
331 * @void *p@ = argument to function
333 * Returns: Nonzero return code from function, or zero.
335 * Use: Runs a function over all the leaves of a key.
338 extern int key_do(key_data */
*k*/
, const key_filter */
*kf*/
, dstr */
*d*/
,
339 int (*/
*func*/
)(key_data */
*kd*/
,
340 dstr */
*d*/
, void */
*p*/
),
343 /* --- @key_copy@ --- *
345 * Arguments: @key_data *kd@ = pointer to destination data block
346 * @key_data *k@ = pointer to source data block
347 * @const key_filter *kf@ = pointer to filter block
349 * Returns: Nonzero if an item was actually copied.
351 * Use: Copies a chunk of key data from one place to another.
354 extern int key_copy(key_data */
*kd*/
, key_data */
*k*/
,
355 const key_filter */
*kf*/
);
357 /*----- Textual encoding --------------------------------------------------*/
359 /* --- @key_read@ --- *
361 * Arguments: @const char *p@ = pointer to textual key representation
362 * @key_data *k@ = pointer to output block for key data
363 * @char **pp@ = where to store the end pointer
365 * Returns: Zero if all went well, nonzero if there was a problem.
367 * Use: Parses a textual key description.
370 extern int key_read(const char */
*p*/
, key_data */
*k*/
, char **/
*pp*/
);
372 /* --- @key_write@ --- *
374 * Arguments: @key_data *k@ = pointer to key data
375 * @dstr *d@ = destination string to write on
376 * @const key_filter *kf@ = pointer to key selection block
378 * Returns: Nonzero if any items were actually written.
380 * Use: Writes a key in a textual encoding.
383 extern int key_write(key_data */
*k*/
, dstr */
*d*/
,
384 const key_filter */
*kf*/
);
386 /*----- Key binary encoding -----------------------------------------------*/
388 /* --- @key_decode@ --- *
390 * Arguments: @const void *p@ = pointer to buffer to read
391 * @size_t sz@ = size of the buffer
392 * @key_data *k@ = pointer to key data block to write to
394 * Returns: Zero if everything worked, nonzero otherwise.
396 * Use: Decodes a binary representation of a key.
399 extern int key_decode(const void */
*p*/
, size_t /*sz*/, key_data */
*k*/
);
401 /* --- @key_encode@ --- *
403 * Arguments: @key_data *k@ = pointer to key data block
404 * @dstr *d@ = pointer to destination string
405 * @const key_filter *kf@ = pointer to key selection block
407 * Returns: Nonzero if any items were actually written.
409 * Use: Encodes a key block as binary data.
412 extern int key_encode(key_data */
*k*/
, dstr */
*d*/
,
413 const key_filter */
*kf*/
);
415 /*----- Packing and unpacking keys ----------------------------------------*/
417 /* --- @key_pack@ --- *
419 * Arguments: @key_packdef *kp@ = pointer to packing structure
420 * @key_data *kd@ = pointer to destination key data
421 * @dstr *d@ = pointer to tag string for the key data
423 * Returns: Error code, or zero.
425 * Use: Packs a key from a data structure.
428 extern int key_pack(key_packdef */
*kp*/
, key_data */
*kd*/
, dstr */
*d*/
);
430 /* --- @key_unpack@ --- *
432 * Arguments: @key_packdef *kp@ = pointer to packing structure
433 * @key_data *kd@ = pointer to source key data
434 * @dstr *d@ = pointer to tag string for the key data
436 * Returns: Error code, or zero.
438 * Use: Unpacks a key into an appropriate data structure.
441 extern int key_unpack(key_packdef */
*kp*/
, key_data */
*kd*/
, dstr */
*d*/
);
443 /* --- @key_unpackdone@ --- *
445 * Arguments: @key_packdef *kp@ = pointer to packing definition
449 * Use: Frees the key components contained within a packing
450 * definition, created during key unpacking.
453 extern void key_unpackdone(key_packdef */
*kp*/
);
455 /*----- Passphrase encryption ---------------------------------------------*/
457 /* --- @key_plock@ --- *
459 * Arguments: @const char *tag@ = tag to use for passphrase
460 * @key_data *k@ = source key data block
461 * @key_data *kt@ = target key data block
463 * Returns: Zero if successful, nonzero if there was a problem.
465 * Use: Locks a key by encrypting it with a passphrase.
468 extern int key_plock(const char */
*tag*/
, key_data */
*k*/
, key_data */
*kt*/
);
470 /* --- @key_punlock@ --- *
472 * Arguments: @const char *tag@ = tag to use for passphrase
473 * @key_data *k@ = source key data block
474 * @key_data *kt@ = target key data block
476 * Returns: Zero if it worked, nonzero if it didn't.
478 * Use: Unlocks a passphrase-locked key.
481 extern int key_punlock(const char */
*tag*/
,
482 key_data */
*k*/
, key_data */
*kt*/
);
484 /*----- That's all, folks -------------------------------------------------*/