3 * Simple key management
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 ------------------------------------------------------*/
35 #include <mLib/bits.h>
36 #include <mLib/hash.h>
42 /*----- Useful macros -----------------------------------------------------*/
44 #define KEY_WRITE(f) do { \
45 if (!(f)->f & KF_WRITE) \
46 return (KERR_READONLY); \
49 #define KEY_MODIFY(f) do { (f)->f |= KF_MODIFIED; } while (0)
51 #define KEY_LOAD(n) ((n) * 2)
53 /*----- Iteration and iterators -------------------------------------------*/
55 /* --- @key_mkiter@ --- *
57 * Arguments: @key_iter *i@ = pointer to iterator object
58 * @key_file *f@ = pointer to file structure
62 * Use: Initializes a key iterator. The keys are returned by
66 void key_mkiter(key_iter *i, key_file *f)
68 HASH_MKITER(&i->i, &f->byid);
72 /* --- @key_next@ --- *
74 * Arguments: @key_iter *i@ = pointer to iterator object
76 * Returns: Pointer to next key, or null.
78 * Use: Returns the next key in some arbitrary sequence.
81 key *key_next(key_iter *i)
88 } while (k && KEY_EXPIRED(i->t, k->exp) && KEY_EXPIRED(i->t, k->del));
92 /*----- Lookup ------------------------------------------------------------*/
94 /* --- @key_bytype@ --- *
96 * Arguments: @key_file *f@ = key file we want a key from
97 * @const char *type@ = type string for desired key
99 * Returns: Pointer to the best key to use, or null.
101 * Use: Looks up a key by its type. Returns the key with the latest
102 * expiry time. This function will not return an expired key.
105 key *key_bytype(key_file *f, const char *type)
107 time_t now = time(0);
111 if ((kr = sym_find(&f->bytype, type, -1, 0, 0)) == 0)
113 for (k = kr->k; k && KEY_EXPIRED(now, k->exp); k = k->next)
118 /* --- @key_byid@ --- *
120 * Arguments: @key_file *f@ = key file to find a key from
121 * @uint32 id@ = id to look for
123 * Returns: Key with matching id.
125 * Use: Returns a key given its id. This function will return an
126 * expired key, but not a deleted one.
129 key *key_byid(key_file *f, uint32 id)
134 bin = HASH_BIN(&f->byid, id);
135 for (b = *bin; b; b = b->next) {
138 if (KEY_EXPIRED(t, k->exp) && KEY_EXPIRED(t, k->del))
146 /* --- @key_bytag@ --- *
148 * Arguments: @key_file *f@ = key file to find a key from
149 * @const char *tag@ = pointer to tag string
151 * Returns: Key with matching id or tag.
153 * Use: Returns a key given its tag or id. This function will return
154 * an expired key, but not a deleted one.
157 key *key_bytag(key_file *f, const char *tag)
162 key_ref *kr = sym_find(&f->bytag, tag, -1, 0, 0);
164 if (kr && !(KEY_EXPIRED(t, kr->k->exp) && KEY_EXPIRED(t, kr->k->del)))
166 id = strtoul(tag, &p, 16);
168 return (key_byid(f, id));
169 return (key_bytype(f, tag));
172 /* --- @key_qtag@ --- *
174 * Arguments: @key_file *f@ = key file to find a key from
175 * @const char *tag@ = pointer to tag string
176 * @dstr *d@ = pointer to string for full tag name
177 * @key **k@ = where to store the key pointer
178 * @key_data ***kd@ = where to store the key data pointer
180 * Returns: Zero if OK, nonzero if it failed.
182 * Use: Performs a full lookup on a qualified tag name. The tag is
183 * qualified by the names of subkeys, separated by dots. Hence,
184 * a qualified tag is ID|TAG[.TAG...]. The various result
185 * pointers can be null to indicate that the result isn't
189 int key_qtag(key_file *f, const char *tag, dstr *d, key **k, key_data ***kd)
196 /* --- Find the end of the base tag --- */
198 if ((q = strchr(tag, '.')) == 0)
201 DPUTM(&dd, tag, q - tag);
206 /* --- Look up the key tag --- */
208 if ((kk = key_bytag(f, dd.buf)) == 0) {
213 /* --- Set the various initial bits of result up --- */
221 /* --- Now dig through the rest of the tag --- */
227 /* --- Stick on the next bit of the fullqtag --- */
230 while (*q && *q != '.') {
240 /* --- Look up the subkey --- */
242 if ((*kkd)->e != KENC_STRUCT) {
246 if ((ks = sym_find(&(*kkd)->u.s, dd.buf, -1, 0, 0)) == 0) {
254 /* --- Return the results --- */
264 /*----- Miscellaneous functions -------------------------------------------*/
266 /* --- @key_delete@ --- *
268 * Arguments: @key_file *f@ = pointer to file block
269 * @key *k@ = key to delete
271 * Returns: Error code (one of the @KERR@ constants).
273 * Use: Removes the given key from the list. The key file must be
274 * writable. (Due to the horridness of the data structures,
275 * deleted keys aren't actually removed, just marked so that
276 * they can't be looked up or iterated over. One upshot of
277 * this is that they don't get written back to the file when
281 int key_delete(key_file *f, key *k)
284 k->exp = KEXP_EXPIRE;
285 k->del = KEXP_EXPIRE;
290 /* --- @key_expired@ --- *
292 * Arguments: @key *k@ = pointer to key block
294 * Returns: Zero if the key is OK, nonzero if it's expired.
297 int key_expired(key *k)
299 time_t now = time(0);
300 return (KEY_EXPIRED(now, k->exp) || KEY_EXPIRED(now, k->del));
303 /* --- @key_expire@ --- *
305 * Arguments: @key_file *f@ = pointer to file block
306 * @key *k@ = pointer to key block
308 * Returns: Error code (one of the @KERR@ constants).
310 * Use: Immediately marks the key as expired. It may be removed
311 * immediately, if it is no longer required, and will be removed
312 * by a tidy operation when it is no longer required. The key
313 * file must be writable.
316 int key_expire(key_file *f, key *k)
319 k->exp = KEXP_EXPIRE;
320 if (k->del == KEXP_FOREVER)
321 k->del = KEXP_EXPIRE;
326 /* --- @key_used@ --- *
328 * Arguments: @key_file *f@ = pointer to key file
329 * @key *k@ = pointer to key block
330 * @time_t t@ = when key can be removed
332 * Returns: Zero if OK, nonzero on failure.
334 * Use: Marks a key as being required until a given time. Even
335 * though the key may expire before then (and won't be returned
336 * by type after that time), it will still be available when
337 * requested explicitly by id. The key file must be writable.
339 * The only (current) reason for failure is attempting to use
340 * a key which can expire for something which can't.
343 int key_used(key_file *f, key *k, time_t t)
346 if (t == KEXP_FOREVER) {
347 if (k->exp != KEXP_FOREVER)
348 return (KERR_WILLEXPIRE);
349 } else if (k->del >= t)
357 /* --- @key_fingerprint@ --- *
359 * Arguments: @key *k@ = the key to fingerprint
360 * @ghash *h@ = the hash to use
361 * @const key_filter *kf@ = filter to apply
363 * Returns: Nonzero if the key slightly matched the filter.
365 * Use: Updates the hash context with the key contents.
368 static int abyname(const void *a, const void *b) {
369 key_attr *const *x = a, *const *y = b;
370 return (strcmp(SYM_NAME(*x), SYM_NAME(*y)));
373 int key_fingerprint(key *k, ghash *h, const key_filter *kf)
381 if (!key_encode(k->k, &d, kf))
384 GH_HASHSTR(h, "catacomb-key-fingerprint:");
385 GH_HASHU32(h, k->id);
386 GH_HASHSTR8(h, k->type);
387 GH_HASH(h, d.buf, d.len);
388 for (n = 0, sym_mkiter(&ai, &k->a); (a = sym_next(&ai)) != 0; n++);
390 v = xmalloc(n * sizeof(*v));
391 for (i = 0, sym_mkiter(&ai, &k->a); (a = sym_next(&ai)) != 0; i++)
393 qsort(v, n, sizeof(*v), abyname);
394 for (i = 0; i < n; i++) {
395 GH_HASHSTR8(h, SYM_NAME(v[i]));
396 GH_HASHSTR16(h, v[i]->p);
405 /*----- That's all, folks -------------------------------------------------*/