3 * $Id: key-io.c,v 1.6 2004/04/08 01:36:15 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 /*----- Header files ------------------------------------------------------*/
39 #include <mLib/bits.h>
40 #include <mLib/crc32.h>
41 #include <mLib/dstr.h>
42 #include <mLib/hash.h>
50 /*----- Tweakable macros --------------------------------------------------*/
54 /*----- Low-level functions -----------------------------------------------*/
58 * Arguments: @key_file *f@ = pointer to file structure
59 * @key *k@ = pointer to key block to insert
61 * Returns: Error code (one of the @KERR@ code).
63 * Use: Links a new key block into the complicated data structure
64 * which is a keyring file.
67 static int insert(key_file
*f
, key
*k
)
72 /* --- Sanity preservatives --- */
74 if (key_chkident(k
->type
))
75 return (KERR_BADTYPE
);
76 else if (k
->tag
&& key_chkident(k
->tag
))
79 /* --- Insert into the tag table --- */
82 kr
= sym_find(&f
->bytag
, k
->tag
, -1, sizeof(*kr
), &found
);
88 /* --- Insert into the id table --- */
93 bin
= HASH_BIN(&f
->byid
, k
->id
);
94 for (b
= *bin
; b
; b
= b
->next
) {
95 if (b
->hash
== k
->id
) {
97 sym_remove(&f
->bytag
, kr
);
107 /* --- Extend the table --- */
111 else if (hash_extend(&f
->byid
))
112 f
->idload
= SYM_LIMIT(f
->byid
.mask
/ 2);
114 /* --- Insert into the type table --- */
116 kr
= sym_find(&f
->bytype
, k
->type
, -1, sizeof(*kr
), &found
);
122 if (k
->exp
!= KEXP_FOREVER
) {
123 while (*p
&& (*p
)->exp
!= KEXP_EXPIRE
&& (*p
)->exp
> k
->exp
)
133 /*----- Reading and writing keys ------------------------------------------*/
135 /* --- @exptime@ --- *
137 * Arguments: @const char *p@ = pointer to string
139 * Returns: Time value.
141 * Use: Translates an expiry or deletion time.
144 time_t exptime(const char *p
)
146 size_t sz
= strlen(p
);
147 if (strncmp(p
, "expired", sz
) == 0)
148 return (KEXP_EXPIRE
);
149 else if (strncmp(p
, "forever", sz
) == 0)
150 return (KEXP_FOREVER
);
155 /* --- @key_merge@ --- *
157 * Arguments: @key_file *f@ = pointer to file structure
158 * @const char *file@ = name of file (for error messages)
159 * @FILE *fp@ = file handle to read from
160 * @key_reporter *rep@ = error reporting function
161 * @void *arg@ = argument for function
163 * Returns: Error code (one of the @KERR@ constants).
165 * Use: Reads keys from a file, and inserts them into the file.
168 int key_merge(key_file
*f
, const char *file
, FILE *fp
,
169 key_reporter
*rep
, void *arg
)
173 dstr n
= DSTR_INIT
, v
= DSTR_INIT
;
175 if (!(f
->f
& KF_WRITE
))
176 return (KERR_READONLY
);
178 for (; dstr_putline(&l
, fp
) != EOF
; DRESET(&l
)) {
183 /* --- Skip blank lines and comments --- *
185 * Quite what they're doing in what ought to be an automatically-
186 * maintained file I don't know.
190 while (isspace((unsigned char)*p
))
192 if (!*p
|| *p
== '#')
195 /* --- Break the line into fields --- *
197 * There are currently six fields of interest:
199 * * The key's identification (id, tag and type).
200 * * The actual key data itself.
201 * * The key expiry time.
202 * * The key deletion time.
203 * * The attributes field.
204 * * Any further comments.
206 * All but the last field can contain no spaces.
210 int n
= str_split(p
, vf
, 5, &vf
[5]);
213 rep(file
, line
, "too few fields", arg
);
218 /* --- Allocate a new key block --- */
222 /* --- Extract the key data into the block --- */
224 if (key_read(vf
[1], &k
->k
, 0)) {
226 rep(file
, line
, "bad key data", arg
);
230 /* --- Decode the identification field --- *
232 * For compatibility, derive a keyid from the key data. This can only be
233 * done if the key encoding is binary (and presumably old-encoding binary
238 char *q
= strchr(vf
[0], ':');
242 if (k
->k
.e
!= KENC_BINARY
) {
244 rep(file
, line
, "new-style key encoding but no keyid", arg
);
247 k
->id
= crc32(0, k
->k
.u
.k
.k
, k
->k
.u
.k
.sz
);
248 k
->type
= xstrdup(vf
[0]);
252 k
->id
= strtoul(p
, 0, 16);
253 if ((qq
= strchr(q
, ':')) == 0 || !qq
[1]) {
259 k
->tag
= xstrdup(qq
);
261 k
->type
= xstrdup(q
);
265 /* --- Get a key block for the new key --- */
267 k
->exp
= exptime(vf
[2]);
268 k
->del
= exptime(vf
[3]);
270 /* --- Insert the key block into the table --- */
276 if ((err
= insert(f
, k
)) < 0) {
277 if (err
== KERR_DUPTAG
) {
279 rep(file
, line
, "duplicate key tag stripped", arg
);
285 rep(file
, line
, key_strerror(err
), arg
);
290 /* --- Parse up the attributes, if specified --- */
293 if (vf
[4] && strcmp(vf
[4], "-") != 0) {
295 for (url_initdec(&uc
, vf
[4]); url_dec(&uc
, &n
, &v
); ) {
296 key_putattr(f
, k
, n
.buf
, v
.buf
);
297 DRESET(&n
); DRESET(&v
);
301 /* --- Insert the comment --- */
304 k
->c
= xstrdup(vf
[5]);
309 /* --- Tidy up after something going wrong --- */
322 /* --- Extensive tidying up now required --- */
331 /* --- @key_extract@ --- *
333 * Arguments: @key_file *f@ = pointer to file structure
334 * @key *k@ = key to extract
335 * @FILE *fp@ = file to write on
336 * @const key_filter *kf@ = pointer to key selection block
338 * Returns: Zero if OK, EOF on error.
340 * Use: Extracts a key to an ouptut file.
343 int key_extract(key_file
*f
, key
*k
, FILE *fp
, const key_filter
*kf
)
348 /* --- Skip the key if it's deleted or unselected--- */
350 if (KEY_EXPIRED(t
, k
->del
) || !key_match(&k
->k
, kf
))
353 /* --- Encode the key and write the easy stuff --- */
357 key_write(&k
->k
, &d
, kf
);
362 /* --- Write out the expiry and deletion times --- */
364 if (KEY_EXPIRED(t
, k
->exp
))
365 fputs("expired ", fp
);
366 else if (k
->exp
== KEXP_FOREVER
)
367 fputs("forever ", fp
);
369 fprintf(fp
, "%li ", (long)k
->exp
);
371 if (k
->del
== KEXP_FOREVER
)
372 fputs("forever ", fp
);
374 fprintf(fp
, "%li ", (long)k
->del
);
376 /* --- Output the attributes --- */
385 for (sym_mkiter(&i
, &k
->a
); (a
= sym_next(&i
)) != 0; ) {
387 url_enc(&uc
, &d
, SYM_NAME(a
), a
->p
);
400 return (ferror(fp
) ? EOF
: 0);
403 /*----- Opening and closing files -----------------------------------------*/
405 /* --- @key_open@ --- *
407 * Arguments: @key_file *f@ = pointer to file structure to initialize
408 * @const char *file@ = pointer to the file name
409 * @unsigned how@ = opening options (@KOPEN_*@).
410 * @key_reporter *rep@ = error reporting function
411 * @void *arg@ = argument for function
413 * Returns: Zero if it worked, nonzero otherwise.
415 * Use: Opens a key file, reads its contents, and stores them in a
416 * structure. The file is locked appropriately until closed
417 * using @key_close@. On an error, everything is cleared away
418 * tidily. If the file is opened with @KOPEN_WRITE@, it's
419 * created if necessary, with read and write permissions for its
423 int key_open(key_file
*f
, const char *file
, unsigned how
,
424 key_reporter
*rep
, void *arg
)
426 if (key_lockfile(f
, file
, how
)) {
427 rep(file
, 0, strerror(errno
), arg
);
431 f
->name
= xstrdup(file
);
433 hash_create(&f
->byid
, KEY_INITSZ
);
434 f
->idload
= SYM_LIMIT(KEY_INITSZ
);
435 sym_create(&f
->bytype
);
436 sym_create(&f
->bytag
);
439 key_merge(f
, file
, f
->fp
, rep
, arg
);
440 f
->f
&= ~KF_MODIFIED
;
442 if ((how
& KOPEN_MASK
) == KOPEN_READ
) {
451 /* --- @key_close@ --- *
453 * Arguments: @key_file *f@ = pointer to key file block
455 * Returns: A @KWRITE_@ code indicating how it went.
457 * Use: Frees all the key data, writes any changes. Make sure that
458 * all hell breaks loose if this returns @KWRITE_BROKEN@.
461 int key_close(key_file
*f
)
467 if (f
->fp
&& (e
= key_save(f
)) != KWRITE_OK
)
470 /* --- Free all the individual keys --- */
472 for (hash_mkiter(&i
, &f
->byid
); (b
= hash_next(&i
)) != 0; ) {
482 for (sym_mkiter(&j
, &k
->a
); (a
= sym_next(&j
)) != 0; )
487 hash_destroy(&f
->byid
);
488 sym_destroy(&f
->bytype
);
489 sym_destroy(&f
->bytag
);
499 * Arguments: @key_file *f@ = pointer to key file
500 * @uint32 id@ = keyid to set
501 * @const char *type@ = the type of this key
502 * @time_t exp@ = when the key expires
503 * @int *err@ = where to store the error condition
505 * Returns: Key block containing new data, or null if it couldn't be
508 * Use: Attaches a new key to a key file. You must have a writable
509 * key file for this to work.
511 * The type is a key type string. This interface doesn't care
512 * about how type strings are formatted: it just treats them as
513 * opaque gobs of text. Clients are advised to choose some
514 * standard for representing key types, though.
516 * The expiry time should either be a time in the future, or the
517 * magic value @KEXP_FOREVER@ which means `never expire this
518 * key'. Be careful with `forever' keys. If I were you, I'd
519 * use a more sophisticated key management system than this for
522 * You have to set the actual key yourself.
525 key
*key_new(key_file
*f
, uint32 id
, const char *type
, time_t exp
, int *err
)
531 /* --- Make sure the file is writable --- */
533 if (!(f
->f
& KF_WRITE
))
535 else if (KEY_EXPIRED(t
, exp
))
537 else if (key_chkident(type
))
543 k
->type
= xstrdup(type
);
544 k
->exp
= k
->del
= exp
;
548 if ((e
= insert(f
, k
)) == 0)
559 /*----- That's all, folks -------------------------------------------------*/