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>
41 #include <mLib/macros.h>
49 /*----- Tweakable macros --------------------------------------------------*/
53 /*----- Low-level functions -----------------------------------------------*/
57 * Arguments: @key_file *f@ = pointer to file structure
58 * @key *k@ = pointer to key block to insert
60 * Returns: Error code (one of the @KERR@ code).
62 * Use: Links a new key block into the complicated data structure
63 * which is a keyring file.
66 static int insert(key_file
*f
, key
*k
)
71 /* --- Sanity preservatives --- */
73 if (key_chkident(k
->type
))
74 return (KERR_BADTYPE
);
75 else if (k
->tag
&& key_chkident(k
->tag
))
78 /* --- Insert into the tag table --- */
81 kr
= sym_find(&f
->bytag
, k
->tag
, -1, sizeof(*kr
), &found
);
87 /* --- Insert into the id table --- */
92 bin
= HASH_BIN(&f
->byid
, k
->id
);
93 for (b
= *bin
; b
; b
= b
->next
) {
94 if (b
->hash
== k
->id
) {
96 sym_remove(&f
->bytag
, kr
);
106 /* --- Extend the table --- */
110 else if (hash_extend(&f
->byid
))
111 f
->idload
= SYM_LIMIT(f
->byid
.mask
/ 2);
113 /* --- Insert into the type table --- */
115 kr
= sym_find(&f
->bytype
, k
->type
, -1, sizeof(*kr
), &found
);
121 if (k
->exp
!= KEXP_FOREVER
) {
122 while (*p
&& (*p
)->exp
!= KEXP_EXPIRE
&& (*p
)->exp
> k
->exp
)
132 /*----- Reading and writing keys ------------------------------------------*/
134 /* --- @exptime@ --- *
136 * Arguments: @const char *p@ = pointer to string
138 * Returns: Time value.
140 * Use: Translates an expiry or deletion time.
143 static time_t exptime(const char *p
)
145 size_t sz
= strlen(p
);
146 if (STRNCMP(p
, ==, "expired", sz
))
147 return (KEXP_EXPIRE
);
148 else if (STRNCMP(p
, ==, "forever", sz
))
149 return (KEXP_FOREVER
);
154 /* --- @merge_core@ --- *
156 * Arguments: @key_file *f@ = pointer to file structure
157 * @const char *file@ = name of file (for error messages)
158 * @int lno@ = line number
159 * @char *p@ = pointer into the line buffer (which will be
161 * @key_reporter *rep@ = error reporting function
162 * @void *arg@ = argument for function
163 * @dstr *n, *v@ = scratch dynamic strings, which must be empty
164 * on entry and are left empty on exit
168 * Use: This is the common core of @key_merge@ and @key_mergeline@.
170 * It is assumed that the caller has already verified that the
171 * keyring is writable.
174 static void merge_core(key_file
*f
, const char *file
, int lno
, char *p
,
175 key_reporter
*rep
, void *arg
, dstr
*n
, dstr
*v
)
180 /* --- Skip blank lines and comments --- *
182 * Quite what they're doing in what ought to be an automatically-
183 * maintained file I don't know.
188 if (!*p
|| *p
== '#')
191 /* --- Break the line into fields --- *
193 * There are currently six fields of interest:
195 * * The key's identification (id, tag and type).
196 * * The actual key data itself.
197 * * The key expiry time.
198 * * The key deletion time.
199 * * The attributes field.
200 * * Any further comments.
202 * All but the last field can contain no spaces.
206 int n
= str_split(p
, vf
, 5, &vf
[5]);
209 rep(file
, lno
, "too few fields", arg
);
214 /* --- Allocate a new key block --- */
221 /* --- Extract the key data into the block --- */
223 if ((k
->k
= key_read(vf
[1], 0)) == 0) {
225 rep(file
, lno
, "bad key data", arg
);
229 /* --- Decode the identification field --- *
231 * For compatibility, derive a keyid from the key data. This can only be
232 * done if the key encoding is binary (and presumably old-encoding binary
237 char *q
= strchr(vf
[0], ':');
241 if (k
->k
->e
!= KENC_BINARY
) {
243 rep(file
, lno
, "new-style key encoding but no keyid", arg
);
246 k
->id
= crc32(0, k
->k
->u
.k
.k
, k
->k
->u
.k
.sz
);
247 k
->type
= xstrdup(vf
[0]);
251 k
->id
= strtoul(p
, 0, 16);
252 if ((qq
= strchr(q
, ':')) == 0 || !qq
[1]) {
258 k
->tag
= xstrdup(qq
);
260 k
->type
= xstrdup(q
);
264 /* --- Get a key block for the new key --- */
266 k
->exp
= exptime(vf
[2]);
267 k
->del
= exptime(vf
[3]);
269 /* --- Insert the key block into the table --- */
275 if ((err
= insert(f
, k
)) < 0) {
276 if (err
== KERR_DUPTAG
) {
278 rep(file
, lno
, "duplicate key tag stripped", arg
);
284 rep(file
, lno
, key_strerror(err
), arg
);
289 /* --- Parse up the attributes, if specified --- */
292 if (vf
[4] && STRCMP(vf
[4], !=, "-")) {
294 for (url_initdec(&uc
, vf
[4]); url_dec(&uc
, n
, v
); ) {
295 key_putattr(f
, k
, n
->buf
, v
->buf
);
296 DRESET(n
); DRESET(v
);
300 /* --- Insert the comment --- */
303 k
->c
= xstrdup(vf
[5]);
312 /* --- Tidy up after something going wrong --- */
316 if (k
->tag
) xfree(k
->tag
);
317 if (k
->type
) xfree(k
->type
);
318 if (k
->k
) key_drop(k
->k
);
323 /* --- @key_merge@, @key_mergeline@ --- *
325 * Arguments: @key_file *f@ = pointer to file structure
326 * @const char *file@ = name of file (for error messages)
327 * @int lno@ = line number (for error messages, @key_mergeline@)
328 * @FILE *fp@ = file handle to read from (@key_merge@)
329 * @const char *line@ = line from the input (@key_mergeline@)
330 * @key_reporter *rep@ = error reporting function
331 * @void *arg@ = argument for function
333 * Returns: Error code (one of the @KERR@ constants).
335 * Use: The @key_merge@ function reads keys from a file, and inserts
336 * them into the keyring.
338 * The @key_mergeline@ function reads a key from a single input
339 * line (which may, but need not, have a final newline), and
340 * adds it to the keyring.
342 * The @key_mergeline@ function is intended to help with
343 * interfacing Catacomb to runtimes which don't use C's @stdio@
344 * streams, rather than as a general-purpose service, though if
345 * it turns out to be useful in other ways then so much the
349 int key_merge(key_file
*f
, const char *file
, FILE *fp
,
350 key_reporter
*rep
, void *arg
)
352 dstr n
= DSTR_INIT
, v
= DSTR_INIT
;
356 if (!(f
->f
& KF_WRITE
))
357 return (KERR_READONLY
);
359 for (; dstr_putline(&l
, fp
) != EOF
; DRESET(&l
))
360 merge_core(f
, file
, lno
++, l
.buf
, rep
, arg
, &n
, &v
);
363 dstr_destroy(&n
); dstr_destroy(&v
);
367 int key_mergeline(key_file
*f
, const char *file
, int lno
, const char *line
,
368 key_reporter
*rep
, void *arg
)
370 dstr n
= DSTR_INIT
, v
= DSTR_INIT
;
371 size_t len
= strlen(line
);
374 if (!(f
->f
& KF_WRITE
)) return (KERR_READONLY
);
376 if (len
&& line
[len
- 1] == '\n') len
--;
377 p
= xmalloc(len
); memcpy(p
, line
, len
); p
[len
] = 0;
378 merge_core(f
, file
, lno
, p
, rep
, arg
, &n
, &v
);
379 xfree(p
); dstr_destroy(&n
); dstr_destroy(&v
);
383 /* --- @key_extract@, @key_extractline@ --- *
385 * Arguments: @key_file *f@ = pointer to file structure
386 * @key *k@ = key to extract
387 * @FILE *fp@ = file to write on (@key_extract@)
388 * @dstr *d@ = string to write on (@key_extractline@)
389 * @const key_filter *kf@ = pointer to key selection block
391 * Returns: @key_extract@ returns zero if OK, EOF on error.
392 * @key_extractline@ does not return a value.
394 * Use: Extracts a key to an ouptut file or buffer.
396 * The @key_extractline@ includes a final newline in its output.
398 * The @key_extractline@ function is intended to help with
399 * interfacing Catacomb to runtimes which don't use C's @stdio@
400 * streams, rather than as a general-purpose service, though if
401 * it turns out to be useful in other ways then so much the
405 void key_extractline(key_file
*f
, key
*k
, dstr
*d
, const key_filter
*kf
)
409 /* --- Skip the key if it's deleted or unselected--- */
411 if (KEY_EXPIRED(t
, k
->del
) || !key_match(k
->k
, kf
))
414 /* --- Encode the key and write the easy stuff --- */
418 if (!key_write(k
->k
, d
, kf
)) dstr_puts(d
, "struct:[]");
421 /* --- Write out the expiry and deletion times --- */
423 if (KEY_EXPIRED(t
, k
->exp
))
424 dstr_puts(d
, "expired ");
425 else if (k
->exp
== KEXP_FOREVER
)
426 dstr_puts(d
, "forever ");
428 dstr_putf(d
, "%li ", (long)k
->exp
);
430 if (k
->del
== KEXP_FOREVER
)
431 dstr_puts(d
, "forever ");
433 dstr_putf(d
, "%li ", (long)k
->del
);
435 /* --- Output the attributes --- */
444 for (sym_mkiter(&i
, &k
->a
); (a
= sym_next(&i
)) != 0; ) {
446 url_enc(&uc
, d
, SYM_NAME(a
), a
->p
);
453 dstr_putf(d
, " %s", k
->c
);
455 DPUTC(d
, '\n'); DPUTZ(d
);
458 int key_extract(key_file
*f
, key
*k
, FILE *fp
, const key_filter
*kf
)
462 key_extractline(f
, k
, &d
, kf
);
464 return (ferror(fp
) ? EOF
: 0);
467 /*----- Opening and closing files -----------------------------------------*/
469 /* --- @key_open@ --- *
471 * Arguments: @key_file *f@ = pointer to file structure to initialize
472 * @const char *file@ = pointer to the file name
473 * @unsigned how@ = opening options (@KOPEN_*@).
474 * @key_reporter *rep@ = error reporting function
475 * @void *arg@ = argument for function
477 * Returns: Zero if it worked, nonzero otherwise.
479 * Use: Opens a key file, reads its contents, and stores them in a
480 * structure. The file is locked appropriately until closed
481 * using @key_close@. On an error, everything is cleared away
482 * tidily. If the file is opened with @KOPEN_WRITE@, it's
483 * created if necessary, with read and write permissions for its
487 int key_open(key_file
*f
, const char *file
, unsigned how
,
488 key_reporter
*rep
, void *arg
)
490 if (key_lockfile(f
, file
, how
)) {
491 rep(file
, 0, strerror(errno
), arg
);
495 f
->name
= xstrdup(file
);
497 hash_create(&f
->byid
, KEY_INITSZ
);
498 f
->idload
= SYM_LIMIT(KEY_INITSZ
);
499 sym_create(&f
->bytype
);
500 sym_create(&f
->bytag
);
503 key_merge(f
, file
, f
->fp
, rep
, arg
);
504 f
->f
&= ~KF_MODIFIED
;
506 if ((how
& KOPEN_MASK
) == KOPEN_READ
) {
508 if (f
->fp
) fclose(f
->fp
);
515 /* --- @key_discard@ --- *
517 * Arguments: @key_file *f@ = pointer to key file block
521 * Use: Frees all the key data, without writing changes.
524 void key_discard(key_file
*f
)
529 /* --- Free all the individual keys --- */
531 for (hash_mkiter(&i
, &f
->byid
); (b
= hash_next(&i
)) != 0; ) {
536 if (k
->k
) key_drop(k
->k
);
541 for (sym_mkiter(&j
, &k
->a
); (a
= sym_next(&j
)) != 0; )
546 hash_destroy(&f
->byid
);
547 sym_destroy(&f
->bytype
);
548 sym_destroy(&f
->bytag
);
555 /* --- @key_close@ --- *
557 * Arguments: @key_file *f@ = pointer to key file block
559 * Returns: A @KWRITE_@ code indicating how it went.
561 * Use: Frees all the key data, writes any changes. Make sure that
562 * all hell breaks loose if this returns @KWRITE_BROKEN@.
565 int key_close(key_file
*f
)
569 if (f
->fp
&& (e
= key_save(f
)) != KWRITE_OK
)
577 * Arguments: @key_file *f@ = pointer to key file
578 * @uint32 id@ = keyid to set
579 * @const char *type@ = the type of this key
580 * @time_t exp@ = when the key expires
581 * @key *kk@ = where to put the key pointer
583 * Returns: Error code (one of the @KERR@ constants).
585 * Use: Attaches a new key to a key file. You must have a writable
586 * key file for this to work.
588 * The type is a key type string. This interface doesn't care
589 * about how type strings are formatted: it just treats them as
590 * opaque gobs of text. Clients are advised to choose some
591 * standard for representing key types, though.
593 * The expiry time should either be a time in the future, or the
594 * magic value @KEXP_FOREVER@ which means `never expire this
595 * key'. Be careful with `forever' keys. If I were you, I'd
596 * use a more sophisticated key management system than this for
600 int key_new(key_file
*f
, uint32 id
, const char *type
, time_t exp
, key
**kk
)
606 /* --- Make sure the file is writable --- */
608 if (!(f
->f
& KF_WRITE
))
610 else if (KEY_EXPIRED(t
, exp
))
612 else if (key_chkident(type
))
618 k
->exp
= k
->del
= exp
;
620 k
->type
= (char *)type
; /* temporarily */
621 if ((e
= insert(f
, k
)) != 0)
624 k
->k
= key_newstring(KCAT_SHARE
, "<unset>");
625 k
->type
= xstrdup(type
);
635 /*----- That's all, folks -------------------------------------------------*/