3 * $Id: key-io.c,v 1.2 2000/02/12 18:21:02 mdw Exp $
5 * Adding new keys to a key file
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 --------------------------------------------------*
33 * Revision 1.2 2000/02/12 18:21:02 mdw
34 * Overhaul of key management (again).
36 * Revision 1.1 1999/12/22 15:47:48 mdw
37 * Major key-management revision.
41 /*----- Header files ------------------------------------------------------*/
50 #include <mLib/bits.h>
51 #include <mLib/crc32.h>
52 #include <mLib/dstr.h>
53 #include <mLib/hash.h>
61 /*----- Tweakable macros --------------------------------------------------*/
63 #define KEY_LOAD(n) ((n) * 2)
65 /*----- Low-level functions -----------------------------------------------*/
69 * Arguments: @key_file *f@ = pointer to file structure
70 * @key *k@ = pointer to key block to insert
72 * Returns: Error code (one of the @KERR@ code).
74 * Use: Links a new key block into the complicated data structure
75 * which is a keyring file.
78 static int insert(key_file
*f
, key
*k
)
83 /* --- Sanity preservatives --- */
85 if (key_chkident(k
->type
))
86 return (KERR_BADTYPE
);
87 else if (k
->tag
&& key_chkident(k
->tag
))
90 /* --- Insert into the tag table --- */
93 kr
= sym_find(&f
->bytag
, k
->tag
, -1, sizeof(*kr
), &found
);
99 /* --- Insert into the id table --- */
104 bin
= HASH_BIN(&f
->byid
, k
->id
);
105 for (b
= *bin
; b
; b
= b
->next
) {
106 if (b
->hash
== k
->id
) {
108 sym_remove(&f
->bytag
, kr
);
118 /* --- Extend the table --- */
122 else if (hash_extend(&f
->byid
))
123 f
->idload
= KEY_LOAD(f
->byid
.mask
/ 2);
125 /* --- Insert into the type table --- */
127 kr
= sym_find(&f
->bytype
, k
->type
, -1, sizeof(*kr
), &found
);
133 if (k
->exp
!= KEXP_FOREVER
) {
134 while (*p
&& (*p
)->exp
!= KEXP_EXPIRE
&& (*p
)->exp
> k
->exp
)
144 /*----- Reading and writing keys ------------------------------------------*/
146 /* --- @exptime@ --- *
148 * Arguments: @const char *p@ = pointer to string
150 * Returns: Time value.
152 * Use: Translates an expiry or deletion time.
155 time_t exptime(const char *p
)
157 size_t sz
= strlen(p
);
158 if (strncmp(p
, "expired", sz
) == 0)
159 return (KEXP_EXPIRE
);
160 else if (strncmp(p
, "forever", sz
) == 0)
161 return (KEXP_FOREVER
);
166 /* --- @key_merge@ --- *
168 * Arguments: @key_file *f@ = pointer to file structure
169 * @const char *file@ = name of file (for error messages)
170 * @FILE *fp@ = file handle to read from
171 * @key_reporter *rep@ = error reporting function
172 * @void *arg@ = argument for function
174 * Returns: Error code (one of the @KERR@ constants).
176 * Use: Reads keys from a file, and inserts them into the file.
179 int key_merge(key_file
*f
, const char *file
, FILE *fp
,
180 key_reporter
*rep
, void *arg
)
184 dstr n
= DSTR_INIT
, v
= DSTR_INIT
;
186 if (!(f
->f
& KF_WRITE
))
187 return (KERR_READONLY
);
189 for (; dstr_putline(&l
, fp
) != EOF
; DRESET(&l
)) {
194 /* --- Skip blank lines and comments --- *
196 * Quite what they're doing in what ought to be an automatically-
197 * maintained file I don't know.
201 while (isspace((unsigned char)*p
))
203 if (!*p
|| *p
== '#')
206 /* --- Break the line into fields --- *
208 * There are currently six fields of interest:
210 * * The key's identification (id, tag and type).
211 * * The actual key data itself.
212 * * The key expiry time.
213 * * The key deletion time.
214 * * The attributes field.
215 * * Any further comments.
217 * All but the last field can contain no spaces.
221 int n
= str_split(p
, vf
, 5, &vf
[5]);
224 rep(file
, line
, "too few fields", arg
);
229 /* --- Allocate a new key block --- */
233 /* --- Extract the key data into the block --- */
235 if (key_read(vf
[1], &k
->k
, 0)) {
237 rep(file
, line
, "bad key data", arg
);
241 /* --- Decode the identification field --- *
243 * For compatibility, derive a keyid from the key data. This can only be
244 * done if the key encoding is binary (and presumably old-encoding binary
249 char *q
= strchr(vf
[0], ':');
253 if (k
->k
.e
!= KENC_BINARY
) {
255 rep(file
, line
, "new-style key encoding but no keyid", arg
);
258 k
->id
= crc32(0, k
->k
.u
.k
.k
, k
->k
.u
.k
.sz
);
259 k
->type
= xstrdup(vf
[0]);
263 k
->id
= strtoul(p
, 0, 16);
264 if ((qq
= strchr(q
, ':')) == 0 || !qq
[1]) {
270 k
->tag
= xstrdup(qq
);
272 k
->type
= xstrdup(q
);
276 /* --- Get a key block for the new key --- */
278 k
->exp
= exptime(vf
[2]);
279 k
->del
= exptime(vf
[3]);
281 /* --- Insert the key block into the table --- */
287 if ((err
= insert(f
, k
)) < 0) {
288 if (err
== KERR_DUPTAG
) {
290 rep(file
, line
, "duplicate key tag stripped", arg
);
296 rep(file
, line
, key_strerror(err
), arg
);
301 /* --- Parse up the attributes, if specified --- */
304 if (vf
[4] && strcmp(vf
[4], "-") != 0) {
306 for (url_initdec(&uc
, vf
[4]); url_dec(&uc
, &n
, &v
); ) {
307 key_putattr(f
, k
, n
.buf
, v
.buf
);
308 DRESET(&n
); DRESET(&v
);
312 /* --- Insert the comment --- */
315 k
->c
= xstrdup(vf
[5]);
320 /* --- Tidy up after something going wrong --- */
333 /* --- Extensive tidying up now required --- */
342 /* --- @key_extract@ --- *
344 * Arguments: @key_file *f@ = pointer to file structure
345 * @key *k@ = key to extract
346 * @FILE *fp@ = file to write on
347 * @const key_filter *kf@ = pointer to key selection block
349 * Returns: Zero if OK, EOF on error.
351 * Use: Extracts a key to an ouptut file.
354 int key_extract(key_file
*f
, key
*k
, FILE *fp
, const key_filter
*kf
)
359 /* --- Skip the key if it's deleted or unselected--- */
361 if (KEY_EXPIRED(t
, k
->del
) || !key_match(&k
->k
, kf
))
364 /* --- Encode the key and write the easy stuff --- */
368 key_write(&k
->k
, &d
, kf
);
373 /* --- Write out the expiry and deletion times --- */
375 if (KEY_EXPIRED(t
, k
->exp
))
376 fputs("expired ", fp
);
377 else if (k
->exp
== KEXP_FOREVER
)
378 fputs("forever ", fp
);
380 fprintf(fp
, "%li ", (long)k
->exp
);
382 if (k
->del
== KEXP_FOREVER
)
383 fputs("forever ", fp
);
385 fprintf(fp
, "%li ", (long)k
->del
);
387 /* --- Output the attributes --- */
396 for (sym_mkiter(&i
, &k
->a
); (a
= sym_next(&i
)) != 0; ) {
398 url_enc(&uc
, &d
, SYM_NAME(a
), a
->p
);
411 return (ferror(fp
) ? EOF
: 0);
414 /*----- Opening and closing files -----------------------------------------*/
416 /* --- @key_open@ --- *
418 * Arguments: @key_file *f@ = pointer to file structure to initialize
419 * @const char *file@ = pointer to the file name
420 * @int how@ = opening options (@KOPEN_*@).
421 * @key_reporter *rep@ = error reporting function
422 * @void *arg@ = argument for function
424 * Returns: Zero if it worked, nonzero otherwise.
426 * Use: Opens a key file, reads its contents, and stores them in a
427 * structure. The file is locked appropriately until closed
428 * using @key_close@. On an error, everything is cleared away
429 * tidily. If the file is opened with @KOPEN_WRITE@, it's
430 * created if necessary, with read and write permissions for its
434 int key_open(key_file
*f
, const char *file
, int how
,
435 key_reporter
*rep
, void *arg
)
437 if (key_lockfile(f
, file
, how
))
440 /* --- Trivial bits of initialization --- */
443 f
->name
= xstrdup(file
);
445 /* --- Read the file of keys into the table --- */
447 hash_create(&f
->byid
, 16);
448 f
->idload
= KEY_LOAD(16);
449 sym_create(&f
->bytype
);
450 sym_create(&f
->bytag
);
452 key_merge(f
, file
, f
->fp
, rep
, arg
);
453 if (how
== KOPEN_READ
)
454 f
->f
&= ~(KF_WRITE
| KF_MODIFIED
);
456 f
->f
&= ~KF_MODIFIED
;
458 /* --- Close the file if only needed for reading --- */
460 if (how
== KOPEN_READ
) {
468 /* --- @key_close@ --- *
470 * Arguments: @key_file *f@ = pointer to key file block
472 * Returns: A @KWRITE_@ code indicating how it went.
474 * Use: Frees all the key data, writes any changes. Make sure that
475 * all hell breaks loose if this returns @KWRITE_BROKEN@.
478 int key_close(key_file
*f
)
484 if ((e
= key_save(f
)) != KWRITE_OK
)
487 /* --- Free all the individual keys --- */
489 for (hash_mkiter(&i
, &f
->byid
); (b
= hash_next(&i
)) != 0; ) {
499 for (sym_mkiter(&j
, &k
->a
); (a
= sym_next(&j
)) != 0; )
504 hash_destroy(&f
->byid
);
505 sym_destroy(&f
->bytype
);
506 sym_destroy(&f
->bytag
);
516 * Arguments: @key_file *f@ = pointer to key file
517 * @uint32 id@ = keyid to set
518 * @const char *type@ = the type of this key
519 * @time_t exp@ = when the key expires
520 * @int *err@ = where to store the error condition
522 * Returns: Key block containing new data, or null if it couldn't be
525 * Use: Attaches a new key to a key file. You must have a writable
526 * key file for this to work.
528 * The type is a key type string. This interface doesn't care
529 * about how type strings are formatted: it just treats them as
530 * opaque gobs of text. Clients are advised to choose some
531 * standard for representing key types, though.
533 * The expiry time should either be a time in the future, or the
534 * magic value @KEXP_FOREVER@ which means `never expire this
535 * key'. Be careful with `forever' keys. If I were you, I'd
536 * use a more sophisticated key management system than this for
539 * You have to set the actual key yourself.
542 key
*key_new(key_file
*f
, uint32 id
, const char *type
, time_t exp
, int *err
)
548 /* --- Make sure the file is writable --- */
550 if (!(f
->f
& KF_WRITE
))
552 else if (KEY_EXPIRED(t
, exp
))
554 else if (key_chkident(type
))
560 k
->type
= xstrdup(type
);
561 k
->exp
= k
->del
= exp
;
565 if ((e
= insert(f
, k
)) == 0)
576 /*----- That's all, folks -------------------------------------------------*/