On Tue, May 19, 2020 at 14:39:40 +0100, David Howells wrote:
> Ben Boeckel <me@xxxxxxxxxxxxxx> wrote:
> > Is there precedent for this config file format?
>
> Okay, I can change it to:
>
> default_ttl = <number-of-seconds>
>
> and strip spaces all over the place.
Thanks. This is at least a subset of other formats with specs that
aren't bigger than XML :) .
> > But no trailing whitespace is allowed?
>
> Yes... See a few lines above:
>
> while (p > buf && isspace(p[-1]))
> p--;
> *p = 0;
Ah, I missed that. The `-1` should have clued me in. It's a pity there's
not a `strrspn` or the like, but alas.
> > The valid range should be mentioned in the docs (basically that 0 is not
> > allowed and has no special meaning (it could mean leaving off the TTL as
> > previously done)).
>
> I suppose - that's mainly to make sure I'm not passing an invalid value to the
> syscall.
Leaving 0 as invalid is fine, I'm more worried about documenting the
semantics that are implemented.
> > Forwards compatibility is hard with such behavior. Is there any reason
> > this can't be a warning?
>
> I can downgrade it to a warning. I'm not sure that there's any problem here,
> but I have met circumstances before where it is the wrong thing to ignore an
> explicit option that you don't support rather than giving an error.
It's hard to know for sure, true. However, as existing instances
silently ignore this file missing as well, one cannot expect that a
customization here is not being ignored today. I think it's mainly going
to be distributions and/or "devops" folks tweaking this value. Hopefully
they have policies in place for syncing their versions and
configurations up.
> > There's no mention of the leading whitespace support or comments here.
> > Does the file deserve its own manpage?
>
> Um. I'm not sure. Quite possibly there should at least be a stub file with a
> .so directive in it.
That'd be sufficient. It'd show up in `apropos` then at least. I see you
have a full manpage now though, so that's even better.
> diff --git a/key.dns_resolver.c b/key.dns_resolver.c
> index 4ac27d30..c241eda3 100644
> --- a/key.dns_resolver.c
> +++ b/key.dns_resolver.c
> @@ -46,10 +46,13 @@ static const char key_type[] = "dns_resolver";
> static const char a_query_type[] = "a";
> static const char aaaa_query_type[] = "aaaa";
> static const char afsdb_query_type[] = "afsdb";
> +static const char *config_file = "/etc/keyutils/key.dns_resolver.conf";
> +static bool config_specified = false;
> key_serial_t key;
> static int verbose;
> int debug_mode;
> unsigned mask = INET_ALL;
> +unsigned int key_expiry = 10 * 60;
>
>
> /*
> @@ -105,6 +108,23 @@ void _error(const char *fmt, ...)
> va_end(va);
> }
>
> +/*
> + * Pring a warning to stderr or the syslog
Typo. `Print`
> + */
> +void warning(const char *fmt, ...)
> +{
> + va_list va;
> +
> + va_start(va, fmt);
> + if (isatty(2)) {
> + vfprintf(stderr, fmt, va);
> + fputc('\n', stderr);
> + } else {
> + vsyslog(LOG_WARNING, fmt, va);
> + }
> + va_end(va);
> +}
> +
> /*
> * Print status information
> */
> @@ -272,6 +292,7 @@ void dump_payload(void)
> }
>
> info("The key instantiation data is '%s'", buf);
> + info("The expiry time is %us", key_expiry);
> free(buf);
> }
>
> @@ -412,6 +433,9 @@ int dns_query_a_or_aaaa(const char *hostname, char *options)
>
> /* load the key with data key */
> if (!debug_mode) {
> + ret = keyctl_set_timeout(key, key_expiry);
> + if (ret == -1)
> + error("%s: keyctl_set_timeout: %m", __func__);
> ret = keyctl_instantiate_iov(key, payload, payload_index, 0);
> if (ret == -1)
> error("%s: keyctl_instantiate: %m", __func__);
> @@ -420,6 +444,145 @@ int dns_query_a_or_aaaa(const char *hostname, char *options)
> exit(0);
> }
>
> +/*
> + * Read the config file.
> + */
> +static void read_config(void)
> +{
> + FILE *f;
> + char buf[4096], *b, *p, *k, *v;
> + unsigned int line = 0, u;
> + int n;
> +
> + printf("READ CONFIG %s\n", config_file);
Thanks. This looks much more rigorous than before.
> + while (*b) {
> + if (esc) {
> + esc = false;
> + *p++ = *b++;
This probably wants to verify that an escapable character is being
escaped. Right now `\n` will be `n` rather than ASCII NL.
> diff --git a/man/key.dns_resolver.conf.5 b/man/key.dns_resolver.conf.5
> new file mode 100644
> index 00000000..03d04049
> --- /dev/null
> +++ b/man/key.dns_resolver.conf.5
> @@ -0,0 +1,48 @@
> +.\" -*- nroff -*-
> +.\" Copyright (C) 2020 Red Hat, Inc. All Rights Reserved.
> +.\" Written by David Howells (dhowells@xxxxxxxxxx)
> +.\"
> +.\" This program is free software; you can redistribute it and/or
> +.\" modify it under the terms of the GNU General Public License
> +.\" as published by the Free Software Foundation; either version
> +.\" 2 of the License, or (at your option) any later version.
> +.\"
> +.TH KEY.DNS_RESOLVER.CONF 5 "18 May 2020" Linux "Linux Key Management Utilities"
> +.SH NAME
> +key.dns_resolver.conf \- Kernel DNS resolver config
> +.SH DESCRIPTION
> +This file is used by the key.dns_resolver(5) program to set parameters.
> +Unless otherwise overridden with the \fB\-c\fR flag, the program reads:
> +.IP
> +/etc/key.dns_resolver.conf
> +.P
> +Configuration options are given in \fBkey[=value]\fR form, where \fBvalue\fR is
> +optional. If present, the value may be surrounded by a pair of single ('') or
> +double quotes ("") which will be stripped off. The special characters in the
> +value may be escaped with a backslash to turn them into ordinary characters.
> +.P
> +Lines beginning with a '#' are considered comments and ignored. A '#' symbol
> +anywhere after the '=' makes the rest of the line into a comment unless the '#'
> +is inside a quoted section or is escaped.
> +.P
> +Leading and trailing spaces and spaces around the '=' symbol will be stripped
> +off.
> +.P
> +Available options include:
> +.TP
> +.B default_ttl=<number>
> +The number of seconds to set as the expiration on a cached record. This will
> +be overridden if the program manages to retrieve TTL information along with
> +the addresses (if, for example, it accesses the DNS directly). The default is
> +600 seconds. The value must be in the range 1 to INT_MAX.
> +.P
> +The file can also include comments beginning with a '#' character unless
> +otherwise suppressed by being inside a quoted value or being escaped with a
> +backslash.
> +
> +.SH FILES
> +.ul
> +/etc/key.dns_resolver.conf
> +.ul 0
> +.SH SEE ALSO
> +\fBkey.dns_resolver\fR(8)
This looks good enough docs to me.
Thanks,
--Ben
