3 * Adding new keys to a key file
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 /*----- Header files ------------------------------------------------------*/
37 #include <mLib/bits.h>
38 #include <mLib/crc32.h>
39 #include <mLib/dstr.h>
40 #include <mLib/hash.h>
48 /*----- Tweakable macros --------------------------------------------------*/
52 /*----- Low-level functions -----------------------------------------------*/
56 * Arguments: @key_file *f@ = pointer to file structure
57 * @key *k@ = pointer to key block to insert
59 * Returns: Error code (one of the @KERR@ code).
61 * Use: Links a new key block into the complicated data structure
62 * which is a keyring file.
65 static int insert(key_file
*f
, key
*k
)
70 /* --- Sanity preservatives --- */
72 if (key_chkident(k
->type
))
73 return (KERR_BADTYPE
);
74 else if (k
->tag
&& key_chkident(k
->tag
))
77 /* --- Insert into the tag table --- */
80 kr
= sym_find(&f
->bytag
, k
->tag
, -1, sizeof(*kr
), &found
);
86 /* --- Insert into the id table --- */
91 bin
= HASH_BIN(&f
->byid
, k
->id
);
92 for (b
= *bin
; b
; b
= b
->next
) {
93 if (b
->hash
== k
->id
) {
95 sym_remove(&f
->bytag
, kr
);
105 /* --- Extend the table --- */
109 else if (hash_extend(&f
->byid
))
110 f
->idload
= SYM_LIMIT(f
->byid
.mask
/ 2);
112 /* --- Insert into the type table --- */
114 kr
= sym_find(&f
->bytype
, k
->type
, -1, sizeof(*kr
), &found
);
120 if (k
->exp
!= KEXP_FOREVER
) {
121 while (*p
&& (*p
)->exp
!= KEXP_EXPIRE
&& (*p
)->exp
> k
->exp
)
131 /*----- Reading and writing keys ------------------------------------------*/
133 /* --- @exptime@ --- *
135 * Arguments: @const char *p@ = pointer to string
137 * Returns: Time value.
139 * Use: Translates an expiry or deletion time.
142 time_t exptime(const char *p
)
144 size_t sz
= strlen(p
);
145 if (strncmp(p
, "expired", sz
) == 0)
146 return (KEXP_EXPIRE
);
147 else if (strncmp(p
, "forever", sz
) == 0)
148 return (KEXP_FOREVER
);
153 /* --- @key_merge@ --- *
155 * Arguments: @key_file *f@ = pointer to file structure
156 * @const char *file@ = name of file (for error messages)
157 * @FILE *fp@ = file handle to read from
158 * @key_reporter *rep@ = error reporting function
159 * @void *arg@ = argument for function
161 * Returns: Error code (one of the @KERR@ constants).
163 * Use: Reads keys from a file, and inserts them into the file.
166 int key_merge(key_file
*f
, const char *file
, FILE *fp
,
167 key_reporter
*rep
, void *arg
)
171 dstr n
= DSTR_INIT
, v
= DSTR_INIT
;
173 if (!(f
->f
& KF_WRITE
))
174 return (KERR_READONLY
);
176 for (; dstr_putline(&l
, fp
) != EOF
; DRESET(&l
)) {
181 /* --- Skip blank lines and comments --- *
183 * Quite what they're doing in what ought to be an automatically-
184 * maintained file I don't know.
188 while (isspace((unsigned char)*p
))
190 if (!*p
|| *p
== '#')
193 /* --- Break the line into fields --- *
195 * There are currently six fields of interest:
197 * * The key's identification (id, tag and type).
198 * * The actual key data itself.
199 * * The key expiry time.
200 * * The key deletion time.
201 * * The attributes field.
202 * * Any further comments.
204 * All but the last field can contain no spaces.
208 int n
= str_split(p
, vf
, 5, &vf
[5]);
211 rep(file
, line
, "too few fields", arg
);
216 /* --- Allocate a new key block --- */
220 /* --- Extract the key data into the block --- */
222 if ((k
->k
= key_read(vf
[1], 0)) == 0) {
224 rep(file
, line
, "bad key data", arg
);
228 /* --- Decode the identification field --- *
230 * For compatibility, derive a keyid from the key data. This can only be
231 * done if the key encoding is binary (and presumably old-encoding binary
236 char *q
= strchr(vf
[0], ':');
240 if (k
->k
->e
!= KENC_BINARY
) {
242 rep(file
, line
, "new-style key encoding but no keyid", arg
);
245 k
->id
= crc32(0, k
->k
->u
.k
.k
, k
->k
->u
.k
.sz
);
246 k
->type
= xstrdup(vf
[0]);
250 k
->id
= strtoul(p
, 0, 16);
251 if ((qq
= strchr(q
, ':')) == 0 || !qq
[1]) {
257 k
->tag
= xstrdup(qq
);
259 k
->type
= xstrdup(q
);
263 /* --- Get a key block for the new key --- */
265 k
->exp
= exptime(vf
[2]);
266 k
->del
= exptime(vf
[3]);
268 /* --- Insert the key block into the table --- */
274 if ((err
= insert(f
, k
)) < 0) {
275 if (err
== KERR_DUPTAG
) {
277 rep(file
, line
, "duplicate key tag stripped", arg
);
283 rep(file
, line
, key_strerror(err
), arg
);
288 /* --- Parse up the attributes, if specified --- */
291 if (vf
[4] && strcmp(vf
[4], "-") != 0) {
293 for (url_initdec(&uc
, vf
[4]); url_dec(&uc
, &n
, &v
); ) {
294 key_putattr(f
, k
, n
.buf
, v
.buf
);
295 DRESET(&n
); DRESET(&v
);
299 /* --- Insert the comment --- */
302 k
->c
= xstrdup(vf
[5]);
307 /* --- Tidy up after something going wrong --- */
320 /* --- Extensive tidying up now required --- */
329 /* --- @key_extract@ --- *
331 * Arguments: @key_file *f@ = pointer to file structure
332 * @key *k@ = key to extract
333 * @FILE *fp@ = file to write on
334 * @const key_filter *kf@ = pointer to key selection block
336 * Returns: Zero if OK, EOF on error.
338 * Use: Extracts a key to an ouptut file.
341 int key_extract(key_file
*f
, key
*k
, FILE *fp
, const key_filter
*kf
)
346 /* --- Skip the key if it's deleted or unselected--- */
348 if (KEY_EXPIRED(t
, k
->del
) || !key_match(k
->k
, kf
))
351 /* --- Encode the key and write the easy stuff --- */
355 key_write(k
->k
, &d
, kf
);
360 /* --- Write out the expiry and deletion times --- */
362 if (KEY_EXPIRED(t
, k
->exp
))
363 fputs("expired ", fp
);
364 else if (k
->exp
== KEXP_FOREVER
)
365 fputs("forever ", fp
);
367 fprintf(fp
, "%li ", (long)k
->exp
);
369 if (k
->del
== KEXP_FOREVER
)
370 fputs("forever ", fp
);
372 fprintf(fp
, "%li ", (long)k
->del
);
374 /* --- Output the attributes --- */
383 for (sym_mkiter(&i
, &k
->a
); (a
= sym_next(&i
)) != 0; ) {
385 url_enc(&uc
, &d
, SYM_NAME(a
), a
->p
);
398 return (ferror(fp
) ? EOF
: 0);
401 /*----- Opening and closing files -----------------------------------------*/
403 /* --- @key_open@ --- *
405 * Arguments: @key_file *f@ = pointer to file structure to initialize
406 * @const char *file@ = pointer to the file name
407 * @unsigned how@ = opening options (@KOPEN_*@).
408 * @key_reporter *rep@ = error reporting function
409 * @void *arg@ = argument for function
411 * Returns: Zero if it worked, nonzero otherwise.
413 * Use: Opens a key file, reads its contents, and stores them in a
414 * structure. The file is locked appropriately until closed
415 * using @key_close@. On an error, everything is cleared away
416 * tidily. If the file is opened with @KOPEN_WRITE@, it's
417 * created if necessary, with read and write permissions for its
421 int key_open(key_file
*f
, const char *file
, unsigned how
,
422 key_reporter
*rep
, void *arg
)
424 if (key_lockfile(f
, file
, how
)) {
425 rep(file
, 0, strerror(errno
), arg
);
429 f
->name
= xstrdup(file
);
431 hash_create(&f
->byid
, KEY_INITSZ
);
432 f
->idload
= SYM_LIMIT(KEY_INITSZ
);
433 sym_create(&f
->bytype
);
434 sym_create(&f
->bytag
);
437 key_merge(f
, file
, f
->fp
, rep
, arg
);
438 f
->f
&= ~KF_MODIFIED
;
440 if ((how
& KOPEN_MASK
) == KOPEN_READ
) {
449 /* --- @key_discard@ --- *
451 * Arguments: @key_file *f@ = pointer to key file block
455 * Use: Frees all the key data, without writing changes.
458 void key_discard(key_file
*f
)
463 /* --- Free all the individual keys --- */
465 for (hash_mkiter(&i
, &f
->byid
); (b
= hash_next(&i
)) != 0; ) {
470 if (k
->k
) key_drop(k
->k
);
475 for (sym_mkiter(&j
, &k
->a
); (a
= sym_next(&j
)) != 0; )
480 hash_destroy(&f
->byid
);
481 sym_destroy(&f
->bytype
);
482 sym_destroy(&f
->bytag
);
489 /* --- @key_close@ --- *
491 * Arguments: @key_file *f@ = pointer to key file block
493 * Returns: A @KWRITE_@ code indicating how it went.
495 * Use: Frees all the key data, writes any changes. Make sure that
496 * all hell breaks loose if this returns @KWRITE_BROKEN@.
499 int key_close(key_file
*f
)
503 if (f
->fp
&& (e
= key_save(f
)) != KWRITE_OK
)
511 * Arguments: @key_file *f@ = pointer to key file
512 * @uint32 id@ = keyid to set
513 * @const char *type@ = the type of this key
514 * @time_t exp@ = when the key expires
515 * @key *kk@ = where to put the key pointer
517 * Returns: Error code (one of the @KERR@ constants).
519 * Use: Attaches a new key to a key file. You must have a writable
520 * key file for this to work.
522 * The type is a key type string. This interface doesn't care
523 * about how type strings are formatted: it just treats them as
524 * opaque gobs of text. Clients are advised to choose some
525 * standard for representing key types, though.
527 * The expiry time should either be a time in the future, or the
528 * magic value @KEXP_FOREVER@ which means `never expire this
529 * key'. Be careful with `forever' keys. If I were you, I'd
530 * use a more sophisticated key management system than this for
534 int key_new(key_file
*f
, uint32 id
, const char *type
, time_t exp
, key
**kk
)
540 /* --- Make sure the file is writable --- */
542 if (!(f
->f
& KF_WRITE
))
544 else if (KEY_EXPIRED(t
, exp
))
546 else if (key_chkident(type
))
552 k
->exp
= k
->del
= exp
;
554 k
->type
= (char *)type
; /* temporarily */
556 if ((e
= insert(f
, k
)) != 0)
559 k
->k
= key_newstring(KCAT_SHARE
, "<unset>");
560 k
->type
= xstrdup(type
);
569 /*----- That's all, folks -------------------------------------------------*/