3 * Manipulating key data
5 * (c) 1999 Straylight/Edgeware
8 /*----- Licensing notice --------------------------------------------------*
10 * This file is part of Catacomb.
12 * Catacomb is free software; you can redistribute it and/or modify
13 * it under the terms of the GNU Library General Public License as
14 * published by the Free Software Foundation; either version 2 of the
15 * License, or (at your option) any later version.
17 * Catacomb is distributed in the hope that it will be useful,
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
20 * GNU Library General Public License for more details.
22 * You should have received a copy of the GNU Library General Public
23 * License along with Catacomb; if not, write to the Free
24 * Software Foundation, Inc., 59 Temple Place - Suite 330, Boston,
28 #ifndef CATACOMB_KEY_DATA_H
29 #define CATACOMB_KEY_DATA_H
35 /*----- Header files ------------------------------------------------------*/
39 #include <mLib/bits.h>
40 #include <mLib/dstr.h>
41 #include <mLib/macros.h>
44 #ifndef CATACOMB_KEY_ERROR_H
45 # include "key-error.h"
56 /*----- Data structures ---------------------------------------------------*/
58 /* --- Key binary data --- */
60 typedef struct key_bin {
61 octet *k; /* Pointer to key data */
62 size_t sz; /* Size of the key data (in bytes) */
65 /* --- Key data structure --- */
67 typedef struct key_data {
68 unsigned e; /* Encoding type for key data */
69 unsigned ref; /* Reference counter */
71 key_bin k; /* Binary key data */
72 mp *m; /* Multiprecision integer */
73 sym_table s; /* Structured key data */
74 char *p; /* String pointer */
75 ec e; /* Elliptic curve point */
79 typedef struct key_struct {
84 typedef struct key_subkeyiter { sym_iter i; } key_subkeyiter;
86 /* --- Packing and unpacking --- */
88 typedef struct key_packdef {
89 unsigned e; /* Key data encoding type */
90 void *p; /* Pointer to the destination */
91 key_data *kd; /* Key data block */
94 typedef struct key_packstruct {
95 char *name; /* Pointer to name string */
96 key_packdef kp; /* Packing structure */
99 /* --- Key binary encoding --- *
101 * The binary encoding consists of a header containing a 16-bit encoding type
102 * and a 16-bit length, followed immediately by the key data, followed by
103 * between zero and three zero bytes to make the total length a multiple of
104 * four. The format of the following data depends on the encoding type:
106 * @KENC_BINARY@ Binary data.
108 * @KENC_MP@ Octet array interpreted in big-endian byte order.
110 * @KENC_STRUCT@ An array of pairs, each containing a string (8-bit
111 * length followed by data and zero-padding to 4-byte
112 * boundary) and key binary encodings.
114 * @KENC_ENCRYPT@ Binary data, format
117 /* --- Key encoding methods and other flags--- */
121 /* --- Bottom two bits are the encoding type --- */
123 KF_ENCMASK = 0x83, /* Encoding mask */
124 KENC_BINARY = 0x00, /* Plain binary key (@k@) */
125 KENC_MP = 0x01, /* Multiprecision integer (@i@) */
126 KENC_STRUCT = 0x02, /* Structured key data (@s@) */
127 KENC_ENCRYPT = 0x03, /* Encrypted key type (@k@) */
128 KENC_STRING = 0x80, /* ASCII string (@p@) */
129 KENC_EC = 0x81, /* Elliptic curve point (@e@) */
131 /* --- Key category bits --- */
133 KF_CATMASK = 0x0c, /* Category mask */
134 KCAT_SYMM = 0x00, /* Symmetric encryption key */
135 KCAT_PRIV = 0x04, /* Private (asymmetric) key */
136 KCAT_PUB = 0x08, /* Public (asymmetric) key */
137 KCAT_SHARE = 0x0c, /* Shared (asymmetric) key */
138 KF_NONSECRET = 0x08, /* Bit flag for non-secret keys */
140 /* --- Other flags --- */
142 KF_BURN = 0x10, /* Burn key after use */
143 KF_OPT = 0x20, /* Optional key (for @key_unpack@) */
145 /* --- Tag end --- */
147 KENC_MAX /* Dummy limit constant */
150 /* --- Key locking return codes --- */
152 #define KL_OK 0 /* All good */
153 #define KL_IOERR -1 /* I/O problem (e.g., getting pp) */
154 #define KL_KEYERR -2 /* Wrong key supplied */
155 #define KL_DATAERR -3 /* Data format error */
157 /* --- Key flag filtering --- */
159 typedef struct key_filter {
164 /* --- Matching aginst key selection --- */
166 #define KEY_MATCH(kd, kf) \
167 (MUFFLE_WARNINGS_EXPR(GCC_WARNING("-Waddress"), !(kf)) || \
168 ((kd)->e & KF_ENCMASK) == KENC_STRUCT || \
169 ((kd)->e & (kf)->m) == (kf)->f)
171 /*----- Key flags and filtering -------------------------------------------*/
173 /* --- @key_readflags@ --- *
175 * Arguments: @const char *p@ = pointer to string to read
176 * @char **pp@ = where to store the end pointer
177 * @unsigned *ff@ = where to store the flags
178 * @unsigned *mm@ = where to store the mask
180 * Returns: Zero if all went well, nonzero if there was an error.
182 * Use: Reads a flag string.
185 extern int key_readflags(const char */*p*/, char **/*pp*/,
186 unsigned */*ff*/, unsigned */*mm*/);
188 /* --- @key_writeflags@ --- *
190 * Arguments: @unsigned f@ = flags to write
191 * @dstr *d@ = pointer to destination string
195 * Use: Emits a flags word as a string representation.
198 extern void key_writeflags(unsigned /*f*/, dstr */*d*/);
200 /* --- @key_match@ --- *
202 * Arguments: @key_data *k@ = pointer to key data block
203 * @const key_filter *kf@ = pointer to filter block
205 * Returns: Nonzero if the key matches the filter.
207 * Use: Checks whether a key matches a filter.
210 extern int key_match(key_data */*k*/, const key_filter */*kf*/);
212 /*----- Setting new key data ----------------------------------------------*/
214 /* --- @key_newraw@ --- *
216 * Arguments: @unsigned e@ = encoding type to set
218 * Returns: New key block, not filled in.
221 extern key_data *key_newraw(unsigned /*e*/);
223 /* --- @key_newbinary@ --- *
225 * Arguments: @unsigned e@ = other encoding flags
226 * @const void *p@ = pointer to key data
227 * @size_t sz@ = size of the key data
229 * Returns: New key data object.
232 extern key_data *key_newbinary(unsigned /*e*/,
233 const void */*p*/, size_t /*sz*/);
235 /* --- @key_newencrypted@ --- *
237 * Arguments: @unsigned e@ = other encoding flags
238 * @const void *p@ = pointer to key data
239 * @size_t sz@ = size of the key data
241 * Returns: New key data object.
244 extern key_data *key_newencrypted(unsigned /*e*/,
245 const void */*p*/, size_t /*sz*/);
247 /* --- @key_newmp@ --- *
249 * Arguments: @unsigned e@ = other encoding flags
250 * @mp *m@ = pointer to the value to set
252 * Returns: New key data object.
255 extern key_data *key_newmp(unsigned /*e*/, mp */*m*/);
257 /* --- @key_newstring@ --- *
259 * Arguments: @unsigned e@ = other encoding flags
260 * @const char *p@ = pointer to the value to set
262 * Returns: New key data object.
265 extern key_data *key_newstring(unsigned /*e*/, const char */*p*/);
267 /* --- @key_newec@ --- *
269 * Arguments: @unsigned e@ = other encoding flags
270 * @const ec *pt@ = pointer to the value to set
272 * Returns: New key data object.
275 extern key_data *key_newec(unsigned /*e*/, const ec */*pt*/);
277 /* --- @key_newstruct@ --- *
281 * Returns: New key data object.
284 extern key_data *key_newstruct(void);
286 /* --- @key_structfind@ --- *
288 * Arguments: @key_data *k@ = pointer to key data block
289 * @const char *tag@ = pointer to tag string
291 * Returns: Pointer to key data block, or null.
293 * Use: Looks up the tag in a structured key.
296 extern key_data *key_structfind(key_data */*k*/, const char */*tag*/);
298 /* --- @key_mksubkeyiter@ --- *
300 * Arguments: @key_subkeyiter *i@ = pointer to iterator block
301 * @key_data *k@ = pointer to key data block
305 * Use: Initializes a subkey iterator.
308 extern void key_mksubkeyiter(key_subkeyiter */*i*/, key_data */*k*/);
310 /* --- @key_nextsubkey@ --- *
312 * Arguments: @key_structiter *i@ = pointer to iterator block
313 * @const char **tag@ = where to put the tag pointer, or null
314 * @key_data **kd@ = where to put the key data pointer, or null
316 * Returns: Nonzero if there was another item, zero if we hit the
319 * Use: Collects the next subkey of a structured key.
322 extern int key_nextsubkey(key_subkeyiter */*i*/,
323 const char **/*tag*/, key_data **/*kd*/);
325 /* --- @key_structset@, @key_structsteal@ --- *
327 * Arguments: @key_data *k@ = pointer to key data block
328 * @const char *tag@ = pointer to tag string
329 * @key_data *kd@ = new key data to store
333 * Use: Creates a new subkey. Stealing doesn't affect @kd@'s
334 * refcount. If @kd@ is null, the subkey is deleted.
337 extern void key_structset(key_data */*k*/,
338 const char */*tag*/, key_data */*kd*/);
339 extern void key_structsteal(key_data */*k*/,
340 const char */*tag*/, key_data */*kd*/);
342 /* --- @key_split@ --- *
344 * Arguments: @key_data **kk@ = address of pointer to key data block
348 * Use: Replaces @*kk@ with a pointer to the same key data, but with
349 * just one reference.
352 extern void key_split(key_data **/*kk*/);
354 /*----- Miscellaneous operations ------------------------------------------*/
356 /* --- @key_incref@ --- *
358 * Arguments: @key_data *k@ = pointer to key data
362 * Use: Increments the refcount on a key data block.
365 #define KEY_INCREF(k) ((k)->ref++)
366 extern void key_incref(key_data */*k*/);
368 /* --- @key_destroy@ --- *
370 * Arguments: @key_data *k@ = pointer to key data to destroy
374 * Use: Destroys a block of key data, regardless of reference count.
375 * Don't use this unless you know what you're doing.
378 extern void key_destroy(key_data */*k*/);
380 /* --- @key_drop@ --- *
382 * Arguments: @key_data *k@ = pointer to key data to destroy
386 * Use: Drops a reference to key data, destroying it if necessary.
389 #define KEY_DROP(k) do { \
396 extern void key_drop(key_data */*k*/);
398 /* --- @key_do@ --- *
400 * Arguments: @key_data *k@ = pointer to key data block
401 * @const key_filter *kf@ = pointer to filter block
402 * @dstr *d@ = pointer to base string
403 * @int (*func)(key_data *kd, dstr *d, void *p@ = function
404 * @void *p@ = argument to function
406 * Returns: Nonzero return code from function, or zero.
408 * Use: Runs a function over all the leaves of a key.
411 extern int key_do(key_data */*k*/, const key_filter */*kf*/, dstr */*d*/,
412 int (*/*func*/)(key_data */*kd*/,
413 dstr */*d*/, void */*p*/),
416 /* --- @key_copydata@ --- *
418 * Arguments: @key_data *k@ = key data to copy
419 * @const key_filter *kf@ = pointer to filter block
421 * Returns: Pointer to a copy of the data, or null if the root subkey
422 * didn't match the filter.
424 * Use: Copies a chunk of key data. Subkeys, whether they're
425 * structured or leaves, which don't match the filter aren't
426 * copied. The copy may or may not have structure in common
430 extern key_data *key_copydata(key_data */*k*/, const key_filter */*kf*/);
432 /*----- Textual encoding --------------------------------------------------*/
434 /* --- @key_read@ --- *
436 * Arguments: @const char *p@ = pointer to textual key representation
437 * @char **pp@ = where to store the end pointer
439 * Returns: The newly-read key data, or null if it failed.
441 * Use: Parses a textual key description.
444 extern key_data *key_read(const char */*p*/, char **/*pp*/);
446 /* --- @key_write@ --- *
448 * Arguments: @key_data *k@ = pointer to key data
449 * @dstr *d@ = destination string to write on
450 * @const key_filter *kf@ = pointer to key selection block
452 * Returns: Nonzero if any items were actually written.
454 * Use: Writes a key in a textual encoding.
457 extern int key_write(key_data */*k*/, dstr */*d*/, const key_filter */*kf*/);
459 /*----- Key binary encoding -----------------------------------------------*/
461 /* --- @key_decode@ --- *
463 * Arguments: @const void *p@ = pointer to buffer to read
464 * @size_t sz@ = size of the buffer
466 * Returns: The newly-read key data, or null if it failed.
468 * Use: Decodes a binary representation of a key.
471 extern key_data *key_decode(const void */*p*/, size_t /*sz*/);
473 /* --- @key_encode@ --- *
475 * Arguments: @key_data *k@ = pointer to key data block
476 * @dstr *d@ = pointer to destination string
477 * @const key_filter *kf@ = pointer to key selection block
479 * Returns: Nonzero if any items were actually written.
481 * Use: Encodes a key block as binary data.
484 extern int key_encode(key_data */*k*/, dstr */*d*/,
485 const key_filter */*kf*/);
487 /*----- Packing and unpacking keys ----------------------------------------*/
489 /* --- @key_pack@ --- *
491 * Arguments: @key_packdef *kp@ = pointer to packing structure
492 * @key_data **kd@ = where to put the key data pointer
493 * @dstr *d@ = pointer to tag string for the key data
495 * Returns: Error code, or zero.
497 * Use: Packs a key from a data structure.
500 extern int key_pack(key_packdef */*kp*/, key_data **/*kd*/, dstr */*d*/);
502 /* --- @key_unpack@ --- *
504 * Arguments: @key_packdef *kp@ = pointer to packing structure
505 * @key_data *kd@ = pointer to source key data
506 * @dstr *d@ = pointer to tag string for the key data
508 * Returns: Error code, or zero.
510 * Use: Unpacks a key into an appropriate data structure.
513 extern int key_unpack(key_packdef */*kp*/, key_data */*kd*/, dstr */*d*/);
515 /* --- @key_unpackdone@ --- *
517 * Arguments: @key_packdef *kp@ = pointer to packing definition
521 * Use: Frees the key components contained within a packing
522 * definition, created during key unpacking.
525 extern void key_unpackdone(key_packdef */*kp*/);
527 /*----- Key encryption ----------------------------------------------------*/
529 /* --- @key_lock@ --- *
531 * Arguments: @key_data **kt@ = where to store the destination pointer
532 * @key_data *k@ = source key data block or null to use @*kt@
533 * @const void *e@ = secret to encrypt key with
534 * @size_t esz@ = size of the secret
538 * Use: Encrypts a key data block using a secret.
541 extern void key_lock(key_data **/*kt*/, key_data */*k*/,
542 const void */*e*/, size_t /*esz*/);
544 /* --- @key_unlock@ --- *
546 * Arguments: @key_data **kt@ = where to store the destination pointer
547 * @key_data *k@ = source key data block or null to use @*kt@
548 * @const void *e@ = secret to decrypt the block with
549 * @size_t esz@ = size of the secret
551 * Returns: Zero for success, or a @KERR_@ error code.
553 * Use: Unlocks a key using a secret.
556 extern int key_unlock(key_data **/*kt*/, key_data */*k*/,
557 const void */*e*/, size_t /*esz*/);
559 /* --- @key_plock@ --- *
561 * Arguments: @key_data **kt@ = where to store the destination pointer
562 * @key_data *k@ = source key data block or null to use @*kt@
563 * @const char *tag@ = tag to use for passphrase
565 * Returns: Zero if successful, a @KERR@ error code on failure.
567 * Use: Locks a key by encrypting it with a passphrase.
570 extern int key_plock(key_data **/*kt*/, key_data */*k*/,
571 const char */*tag*/);
573 /* --- @key_punlock@ --- *
575 * Arguments: @key_data **kt@ = where to store the destination pointer
576 * @key_data *k@ = source key data block or null to use @*kt@
577 * @const char *tag@ = tag to use for passphrase
579 * Returns: Zero if successful, a @KERR@ error code on failure.
581 * Use: Unlocks a passphrase-locked key.
584 extern int key_punlock(key_data **/*kt*/, key_data */*k*/,
585 const char */*tag*/);
587 /*----- That's all, folks -------------------------------------------------*/