cfeff8208b9bee10f2ab201b9d03d14ef4ae74cf
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>
43 #ifndef CATACOMB_KEY_ERROR_H
44 # include "key-error.h"
55 /*----- Data structures ---------------------------------------------------*/
57 /* --- Key binary data --- */
59 typedef struct key_bin
{
60 octet
*k
; /* Pointer to key data */
61 size_t sz
; /* Size of the key data (in bytes) */
64 /* --- Key data structure --- */
66 typedef struct key_data
{
67 unsigned e
; /* Encoding type for key data */
68 unsigned ref
; /* Reference counter */
70 key_bin k
; /* Binary key data */
71 mp
*m
; /* Multiprecision integer */
72 sym_table s
; /* Structured key data */
73 char *p
; /* String pointer */
74 ec e
; /* Elliptic curve point */
78 typedef struct key_struct
{
83 typedef struct key_subkeyiter
{ sym_iter i
; } key_subkeyiter
;
85 /* --- Packing and unpacking --- */
87 typedef struct key_packdef
{
88 unsigned e
; /* Key data encoding type */
89 void *p
; /* Pointer to the destination */
90 key_data
*kd
; /* Key data block */
93 typedef struct key_packstruct
{
94 char *name
; /* Pointer to name string */
95 key_packdef kp
; /* Packing structure */
98 /* --- Key binary encoding --- *
100 * The binary encoding consists of a header containing a 16-bit encoding type
101 * and a 16-bit length, followed immediately by the key data, followed by
102 * between zero and three zero bytes to make the total length a multiple of
103 * four. The format of the following data depends on the encoding type:
105 * @KENC_BINARY@ Binary data.
107 * @KENC_MP@ Octet array interpreted in big-endian byte order.
109 * @KENC_STRUCT@ An array of pairs, each containing a string (8-bit
110 * length followed by data and zero-padding to 4-byte
111 * boundary) and key binary encodings.
113 * @KENC_ENCRYPT@ Binary data, format
116 /* --- Key encoding methods and other flags--- */
120 /* --- Bottom two bits are the encoding type --- */
122 KF_ENCMASK
= 0x83, /* Encoding mask */
123 KENC_BINARY
= 0x00, /* Plain binary key (@k@) */
124 KENC_MP
= 0x01, /* Multiprecision integer (@i@) */
125 KENC_STRUCT
= 0x02, /* Structured key data (@s@) */
126 KENC_ENCRYPT
= 0x03, /* Encrypted key type (@k@) */
127 KENC_STRING
= 0x80, /* ASCII string (@p@) */
128 KENC_EC
= 0x81, /* Elliptic curve point (@e@) */
130 /* --- Key category bits --- */
132 KF_CATMASK
= 0x0c, /* Category mask */
133 KCAT_SYMM
= 0x00, /* Symmetric encryption key */
134 KCAT_PRIV
= 0x04, /* Private (asymmetric) key */
135 KCAT_PUB
= 0x08, /* Public (asymmetric) key */
136 KCAT_SHARE
= 0x0c, /* Shared (asymmetric) key */
137 KF_NONSECRET
= 0x08, /* Bit flag for non-secret keys */
139 /* --- Other flags --- */
141 KF_BURN
= 0x10, /* Burn key after use */
142 KF_OPT
= 0x20, /* Optional key (for @key_unpack@) */
144 /* --- Tag end --- */
146 KENC_MAX
/* Dummy limit constant */
149 /* --- Key locking return codes --- */
151 #define KL_OK 0 /* All good */
152 #define KL_IOERR -1 /* I/O problem (e.g., getting pp) */
153 #define KL_KEYERR -2 /* Wrong key supplied */
154 #define KL_DATAERR -3 /* Data format error */
156 /* --- Key flag filtering --- */
158 typedef struct key_filter
{
163 /* --- Matching aginst key selection --- *
165 * GCC will warn about constant addresses in this test, which is rather
166 * unfortunate. Muffle the warning. This is rather hideous because of the
167 * way GCC's parser handles pragmata.
170 #if __GNUC__ >= 5 || (__GNUC__ == 4 && __GNUC_MINOR__ >= 6)
171 # define KEY_MATCH_MUFFLE_WARNING(x) __extension__ ({ \
172 _Pragma("GCC diagnostic push") \
173 _Pragma("GCC diagnostic ignored \"-Waddress\"") \
175 _Pragma("GCC diagnostic pop") \
178 # define KEY_MATCH_MUFFLE_WARNING(x) (x)
181 #define KEY_MATCH(kd, kf) \
182 (KEY_MATCH_MUFFLE_WARNING(!(kf)) || \
183 ((kd)->e & KF_ENCMASK) == KENC_STRUCT || \
184 ((kd)->e & (kf)->m) == (kf)->f)
186 /*----- Key flags and filtering -------------------------------------------*/
188 /* --- @key_readflags@ --- *
190 * Arguments: @const char *p@ = pointer to string to read
191 * @char **pp@ = where to store the end pointer
192 * @unsigned *ff@ = where to store the flags
193 * @unsigned *mm@ = where to store the mask
195 * Returns: Zero if all went well, nonzero if there was an error.
197 * Use: Reads a flag string.
200 extern int key_readflags(const char */
*p*/
, char **/
*pp*/
,
201 unsigned */
*ff*/
, unsigned */
*mm*/
);
203 /* --- @key_writeflags@ --- *
205 * Arguments: @unsigned f@ = flags to write
206 * @dstr *d@ = pointer to destination string
210 * Use: Emits a flags word as a string representation.
213 extern void key_writeflags(unsigned /*f*/, dstr */
*d*/
);
215 /* --- @key_match@ --- *
217 * Arguments: @key_data *k@ = pointer to key data block
218 * @const key_filter *kf@ = pointer to filter block
220 * Returns: Nonzero if the key matches the filter.
222 * Use: Checks whether a key matches a filter.
225 extern int key_match(key_data */
*k*/
, const key_filter */
*kf*/
);
227 /*----- Setting new key data ----------------------------------------------*/
229 /* --- @key_newraw@ --- *
231 * Arguments: @unsigned e@ = encoding type to set
233 * Returns: New key block, not filled in.
236 extern key_data
*key_newraw(unsigned /*e*/);
238 /* --- @key_newbinary@ --- *
240 * Arguments: @unsigned e@ = other encoding flags
241 * @const void *p@ = pointer to key data
242 * @size_t sz@ = size of the key data
244 * Returns: New key data object.
247 extern key_data
*key_newbinary(unsigned /*e*/,
248 const void */
*p*/
, size_t /*sz*/);
250 /* --- @key_newencrypted@ --- *
252 * Arguments: @unsigned e@ = other encoding flags
253 * @const void *p@ = pointer to key data
254 * @size_t sz@ = size of the key data
256 * Returns: New key data object.
259 extern key_data
*key_newencrypted(unsigned /*e*/,
260 const void */
*p*/
, size_t /*sz*/);
262 /* --- @key_newmp@ --- *
264 * Arguments: @unsigned e@ = other encoding flags
265 * @mp *m@ = pointer to the value to set
267 * Returns: New key data object.
270 extern key_data
*key_newmp(unsigned /*e*/, mp */
*m*/
);
272 /* --- @key_newstring@ --- *
274 * Arguments: @unsigned e@ = other encoding flags
275 * @const char *p@ = pointer to the value to set
277 * Returns: New key data object.
280 extern key_data
*key_newstring(unsigned /*e*/, const char */
*p*/
);
282 /* --- @key_newec@ --- *
284 * Arguments: @unsigned e@ = other encoding flags
285 * @const ec *pt@ = pointer to the value to set
287 * Returns: New key data object.
290 extern key_data
*key_newec(unsigned /*e*/, const ec */
*pt*/
);
292 /* --- @key_newstruct@ --- *
296 * Returns: New key data object.
299 extern key_data
*key_newstruct(void);
301 /* --- @key_structfind@ --- *
303 * Arguments: @key_data *k@ = pointer to key data block
304 * @const char *tag@ = pointer to tag string
306 * Returns: Pointer to key data block, or null.
308 * Use: Looks up the tag in a structured key.
311 extern key_data
*key_structfind(key_data */
*k*/
, const char */
*tag*/
);
313 /* --- @key_mksubkeyiter@ --- *
315 * Arguments: @key_subkeyiter *i@ = pointer to iterator block
316 * @key_data *k@ = pointer to key data block
320 * Use: Initializes a subkey iterator.
323 extern void key_mksubkeyiter(key_subkeyiter */
*i*/
, key_data */
*k*/
);
325 /* --- @key_nextsubkey@ --- *
327 * Arguments: @key_structiter *i@ = pointer to iterator block
328 * @const char **tag@ = where to put the tag pointer, or null
329 * @key_data **kd@ = where to put the key data pointer, or null
331 * Returns: Nonzero if there was another item, zero if we hit the
334 * Use: Collects the next subkey of a structured key.
337 extern int key_nextsubkey(key_subkeyiter */
*i*/
,
338 const char **/
*tag*/
, key_data
**/
*kd*/
);
340 /* --- @key_structset@, @key_structsteal@ --- *
342 * Arguments: @key_data *k@ = pointer to key data block
343 * @const char *tag@ = pointer to tag string
344 * @key_data *kd@ = new key data to store
348 * Use: Creates a new subkey. Stealing doesn't affect @kd@'s
349 * refcount. If @kd@ is null, the subkey is deleted.
352 extern void key_structset(key_data */
*k*/
,
353 const char */
*tag*/
, key_data */
*kd*/
);
354 extern void key_structsteal(key_data */
*k*/
,
355 const char */
*tag*/
, key_data */
*kd*/
);
357 /* --- @key_split@ --- *
359 * Arguments: @key_data **kk@ = address of pointer to key data block
363 * Use: Replaces @*kk@ with a pointer to the same key data, but with
364 * just one reference.
367 extern void key_split(key_data
**/
*kk*/
);
369 /*----- Miscellaneous operations ------------------------------------------*/
371 /* --- @key_incref@ --- *
373 * Arguments: @key_data *k@ = pointer to key data
377 * Use: Increments the refcount on a key data block.
380 #define KEY_INCREF(k) ((k)->ref++)
381 extern void key_incref(key_data */
*k*/
);
383 /* --- @key_destroy@ --- *
385 * Arguments: @key_data *k@ = pointer to key data to destroy
389 * Use: Destroys a block of key data, regardless of reference count.
390 * Don't use this unless you know what you're doing.
393 extern void key_destroy(key_data */
*k*/
);
395 /* --- @key_drop@ --- *
397 * Arguments: @key_data *k@ = pointer to key data to destroy
401 * Use: Drops a reference to key data, destroying it if necessary.
404 #define KEY_DROP(k) do { \
411 extern void key_drop(key_data */
*k*/
);
413 /* --- @key_do@ --- *
415 * Arguments: @key_data *k@ = pointer to key data block
416 * @const key_filter *kf@ = pointer to filter block
417 * @dstr *d@ = pointer to base string
418 * @int (*func)(key_data *kd, dstr *d, void *p@ = function
419 * @void *p@ = argument to function
421 * Returns: Nonzero return code from function, or zero.
423 * Use: Runs a function over all the leaves of a key.
426 extern int key_do(key_data */
*k*/
, const key_filter */
*kf*/
, dstr */
*d*/
,
427 int (*/
*func*/
)(key_data */
*kd*/
,
428 dstr */
*d*/
, void */
*p*/
),
431 /* --- @key_copydata@ --- *
433 * Arguments: @key_data *k@ = key data to copy
434 * @const key_filter *kf@ = pointer to filter block
436 * Returns: Pointer to a copy of the data, or null if the root subkey
437 * didn't match the filter.
439 * Use: Copies a chunk of key data. Subkeys, whether they're
440 * structured or leaves, which don't match the filter aren't
441 * copied. The copy may or may not have structure in common
445 extern key_data
*key_copydata(key_data */
*k*/
, const key_filter */
*kf*/
);
447 /*----- Textual encoding --------------------------------------------------*/
449 /* --- @key_read@ --- *
451 * Arguments: @const char *p@ = pointer to textual key representation
452 * @char **pp@ = where to store the end pointer
454 * Returns: The newly-read key data, or null if it failed.
456 * Use: Parses a textual key description.
459 extern key_data
*key_read(const char */
*p*/
, char **/
*pp*/
);
461 /* --- @key_write@ --- *
463 * Arguments: @key_data *k@ = pointer to key data
464 * @dstr *d@ = destination string to write on
465 * @const key_filter *kf@ = pointer to key selection block
467 * Returns: Nonzero if any items were actually written.
469 * Use: Writes a key in a textual encoding.
472 extern int key_write(key_data */
*k*/
, dstr */
*d*/
, const key_filter */
*kf*/
);
474 /*----- Key binary encoding -----------------------------------------------*/
476 /* --- @key_decode@ --- *
478 * Arguments: @const void *p@ = pointer to buffer to read
479 * @size_t sz@ = size of the buffer
481 * Returns: The newly-read key data, or null if it failed.
483 * Use: Decodes a binary representation of a key.
486 extern key_data
*key_decode(const void */
*p*/
, size_t /*sz*/);
488 /* --- @key_encode@ --- *
490 * Arguments: @key_data *k@ = pointer to key data block
491 * @dstr *d@ = pointer to destination string
492 * @const key_filter *kf@ = pointer to key selection block
494 * Returns: Nonzero if any items were actually written.
496 * Use: Encodes a key block as binary data.
499 extern int key_encode(key_data */
*k*/
, dstr */
*d*/
,
500 const key_filter */
*kf*/
);
502 /*----- Packing and unpacking keys ----------------------------------------*/
504 /* --- @key_pack@ --- *
506 * Arguments: @key_packdef *kp@ = pointer to packing structure
507 * @key_data **kd@ = where to put the key data pointer
508 * @dstr *d@ = pointer to tag string for the key data
510 * Returns: Error code, or zero.
512 * Use: Packs a key from a data structure.
515 extern int key_pack(key_packdef */
*kp*/
, key_data
**/
*kd*/
, dstr */
*d*/
);
517 /* --- @key_unpack@ --- *
519 * Arguments: @key_packdef *kp@ = pointer to packing structure
520 * @key_data *kd@ = pointer to source key data
521 * @dstr *d@ = pointer to tag string for the key data
523 * Returns: Error code, or zero.
525 * Use: Unpacks a key into an appropriate data structure.
528 extern int key_unpack(key_packdef */
*kp*/
, key_data */
*kd*/
, dstr */
*d*/
);
530 /* --- @key_unpackdone@ --- *
532 * Arguments: @key_packdef *kp@ = pointer to packing definition
536 * Use: Frees the key components contained within a packing
537 * definition, created during key unpacking.
540 extern void key_unpackdone(key_packdef */
*kp*/
);
542 /*----- Key encryption ----------------------------------------------------*/
544 /* --- @key_lock@ --- *
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 encrypt key with
549 * @size_t esz@ = size of the secret
553 * Use: Encrypts a key data block using a secret.
556 extern void key_lock(key_data
**/
*kt*/
, key_data */
*k*/
,
557 const void */
*e*/
, size_t /*esz*/);
559 /* --- @key_unlock@ --- *
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 void *e@ = secret to decrypt the block with
564 * @size_t esz@ = size of the secret
566 * Returns: Zero for success, or a @KERR_@ error code.
568 * Use: Unlocks a key using a secret.
571 extern int key_unlock(key_data
**/
*kt*/
, key_data */
*k*/
,
572 const void */
*e*/
, size_t /*esz*/);
574 /* --- @key_plock@ --- *
576 * Arguments: @key_data **kt@ = where to store the destination pointer
577 * @key_data *k@ = source key data block or null to use @*kt@
578 * @const char *tag@ = tag to use for passphrase
580 * Returns: Zero if successful, a @KERR@ error code on failure.
582 * Use: Locks a key by encrypting it with a passphrase.
585 extern int key_plock(key_data
**/
*kt*/
, key_data */
*k*/
,
586 const char */
*tag*/
);
588 /* --- @key_punlock@ --- *
590 * Arguments: @key_data **kt@ = where to store the destination pointer
591 * @key_data *k@ = source key data block or null to use @*kt@
592 * @const char *tag@ = tag to use for passphrase
594 * Returns: Zero if successful, a @KERR@ error code on failure.
596 * Use: Unlocks a passphrase-locked key.
599 extern int key_punlock(key_data
**/
*kt*/
, key_data */
*k*/
,
600 const char */
*tag*/
);
602 /*----- That's all, folks -------------------------------------------------*/