75adf06f19
Add two more arguments to the dnssec-settime tool. '-P ds' sets the
time that the DS was published in the parent, '-D ds' sets the time
that the DS was removed from the parent (these times are not accurate,
but rely on the user to use them appropriately, and as long as the
time is not before actual publication/withdrawal, it is fine).
These new arguments are needed for the kasp system test. We want to
test when the next key event is once a DS is published, and now
that 'parent-registration-delay' is obsoleted, we need a different
approach to reliable test the timings.
(cherry picked from commit d4c4f6a669)
240 lines
9.2 KiB
ReStructuredText
240 lines
9.2 KiB
ReStructuredText
..
|
|
Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
|
|
This Source Code Form is subject to the terms of the Mozilla Public
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
See the COPYRIGHT file distributed with this work for additional
|
|
information regarding copyright ownership.
|
|
|
|
..
|
|
Copyright (C) Internet Systems Consortium, Inc. ("ISC")
|
|
|
|
This Source Code Form is subject to the terms of the Mozilla Public
|
|
License, v. 2.0. If a copy of the MPL was not distributed with this
|
|
file, You can obtain one at http://mozilla.org/MPL/2.0/.
|
|
|
|
See the COPYRIGHT file distributed with this work for additional
|
|
information regarding copyright ownership.
|
|
|
|
|
|
.. highlight: console
|
|
|
|
.. _man_dnssec-settime:
|
|
|
|
dnssec-settime: set the key timing metadata for a DNSSEC key
|
|
------------------------------------------------------------
|
|
|
|
Synopsis
|
|
~~~~~~~~
|
|
|
|
:program:`dnssec-settime` [**-f**] [**-K** directory] [**-L** ttl] [**-P** date/offset] [**-P** ds date/offset] [**-P** sync date/offset] [**-A** date/offset] [**-R** date/offset] [**-I** date/offset] [**-D** date/offset] [**-D** ds date/offset] [**-D** sync date/offset] [**-S** key] [**-i** interval] [**-h**] [**-V**] [**-v** level] [**-E** engine] {keyfile} [**-s**] [**-g** state] [**-d** state date/offset] [**-k** state date/offset] [**-r** state date/offset] [**-z** state date/offset]
|
|
|
|
Description
|
|
~~~~~~~~~~~
|
|
|
|
``dnssec-settime`` reads a DNSSEC private key file and sets the key
|
|
timing metadata as specified by the ``-P``, ``-A``, ``-R``, ``-I``, and
|
|
``-D`` options. The metadata can then be used by ``dnssec-signzone`` or
|
|
other signing software to determine when a key is to be published,
|
|
whether it should be used for signing a zone, etc.
|
|
|
|
If none of these options is set on the command line, then
|
|
``dnssec-settime`` simply prints the key timing metadata already stored
|
|
in the key.
|
|
|
|
When key metadata fields are changed, both files of a key pair
|
|
(``Knnnn.+aaa+iiiii.key`` and ``Knnnn.+aaa+iiiii.private``) are
|
|
regenerated.
|
|
|
|
Metadata fields are stored in the private file. A
|
|
human-readable description of the metadata is also placed in comments in
|
|
the key file. The private file's permissions are always set to be
|
|
inaccessible to anyone other than the owner (mode 0600).
|
|
|
|
When working with state files, it is possible to update the timing metadata in
|
|
those files as well with ``-s``. If this option is used you can also update key
|
|
states with ``-d`` (DS), ``-k`` (DNSKEY), ``-r`` (RRSIG of KSK), or ``-z``
|
|
(RRSIG of ZSK). Allowed states are HIDDEN, RUMOURED, OMNIPRESENT, and
|
|
UNRETENTIVE.
|
|
|
|
You can also set the goal state of the key with ``-g``. This should be either
|
|
HIDDEN or OMNIPRESENT (representing whether the key should be removed from the
|
|
zone, or published).
|
|
|
|
It is NOT RECOMMENDED to manipulate state files manually except for testing
|
|
purposes.
|
|
|
|
Options
|
|
~~~~~~~
|
|
|
|
**-f**
|
|
Force an update of an old-format key with no metadata fields. Without
|
|
this option, ``dnssec-settime`` will fail when attempting to update a
|
|
legacy key. With this option, the key will be recreated in the new
|
|
format, but with the original key data retained. The key's creation
|
|
date will be set to the present time. If no other values are
|
|
specified, then the key's publication and activation dates will also
|
|
be set to the present time.
|
|
|
|
**-K** directory
|
|
Sets the directory in which the key files are to reside.
|
|
|
|
**-L** ttl
|
|
Sets the default TTL to use for this key when it is converted into a
|
|
DNSKEY RR. If the key is imported into a zone, this is the TTL that
|
|
will be used for it, unless there was already a DNSKEY RRset in
|
|
place, in which case the existing TTL would take precedence. If this
|
|
value is not set and there is no existing DNSKEY RRset, the TTL will
|
|
default to the SOA TTL. Setting the default TTL to ``0`` or ``none``
|
|
removes it from the key.
|
|
|
|
**-h**
|
|
Emit usage message and exit.
|
|
|
|
**-V**
|
|
Prints version information.
|
|
|
|
**-v** level
|
|
Sets the debugging level.
|
|
|
|
**-E** engine
|
|
Specifies the cryptographic hardware to use, when applicable.
|
|
|
|
When BIND is built with OpenSSL PKCS#11 support, this defaults to the
|
|
string "pkcs11", which identifies an OpenSSL engine that can drive a
|
|
cryptographic accelerator or hardware service module. When BIND is
|
|
built with native PKCS#11 cryptography (--enable-native-pkcs11), it
|
|
defaults to the path of the PKCS#11 provider library specified via
|
|
"--with-pkcs11".
|
|
|
|
Timing Options
|
|
~~~~~~~~~~~~~~
|
|
|
|
Dates can be expressed in the format YYYYMMDD or YYYYMMDDHHMMSS. If the
|
|
argument begins with a '+' or '-', it is interpreted as an offset from
|
|
the present time. For convenience, if such an offset is followed by one
|
|
of the suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the offset is
|
|
computed in years (defined as 365 24-hour days, ignoring leap years),
|
|
months (defined as 30 24-hour days), weeks, days, hours, or minutes,
|
|
respectively. Without a suffix, the offset is computed in seconds. To
|
|
unset a date, use 'none' or 'never'.
|
|
|
|
**-P** date/offset
|
|
Sets the date on which a key is to be published to the zone. After
|
|
that date, the key will be included in the zone but will not be used
|
|
to sign it.
|
|
|
|
**-P** ds date/offset
|
|
Sets the date on which DS records that match this key have been
|
|
seen in the parent zone.
|
|
|
|
**-P** sync date/offset
|
|
Sets the date on which CDS and CDNSKEY records that match this key
|
|
are to be published to the zone.
|
|
|
|
**-A** date/offset
|
|
Sets the date on which the key is to be activated. After that date,
|
|
the key will be included in the zone and used to sign it.
|
|
|
|
**-R** date/offset
|
|
Sets the date on which the key is to be revoked. After that date, the
|
|
key will be flagged as revoked. It will be included in the zone and
|
|
will be used to sign it.
|
|
|
|
**-I** date/offset
|
|
Sets the date on which the key is to be retired. After that date, the
|
|
key will still be included in the zone, but it will not be used to
|
|
sign it.
|
|
|
|
**-D** date/offset
|
|
Sets the date on which the key is to be deleted. After that date, the
|
|
key will no longer be included in the zone. (It may remain in the key
|
|
repository, however.)
|
|
|
|
**-D** ds date/offset
|
|
Sets the date on which the DS records that match this key have
|
|
been seen removed from the parent zone.
|
|
|
|
**-D** sync date/offset
|
|
Sets the date on which the CDS and CDNSKEY records that match this
|
|
key are to be deleted.
|
|
|
|
**-S** predecessor key
|
|
Select a key for which the key being modified will be an explicit
|
|
successor. The name, algorithm, size, and type of the predecessor key
|
|
must exactly match those of the key being modified. The activation
|
|
date of the successor key will be set to the inactivation date of the
|
|
predecessor. The publication date will be set to the activation date
|
|
minus the prepublication interval, which defaults to 30 days.
|
|
|
|
**-i** interval
|
|
Sets the prepublication interval for a key. If set, then the
|
|
publication and activation dates must be separated by at least this
|
|
much time. If the activation date is specified but the publication
|
|
date isn't, then the publication date will default to this much time
|
|
before the activation date; conversely, if the publication date is
|
|
specified but activation date isn't, then activation will be set to
|
|
this much time after publication.
|
|
|
|
If the key is being set to be an explicit successor to another key,
|
|
then the default prepublication interval is 30 days; otherwise it is
|
|
zero.
|
|
|
|
As with date offsets, if the argument is followed by one of the
|
|
suffixes 'y', 'mo', 'w', 'd', 'h', or 'mi', then the interval is
|
|
measured in years, months, weeks, days, hours, or minutes,
|
|
respectively. Without a suffix, the interval is measured in seconds.
|
|
|
|
Key State Options
|
|
~~~~~~~~~~~~~~~~~
|
|
|
|
Known key states are HIDDEN, RUMOURED, OMNIPRESENT and UNRETENTIVE. These should
|
|
not be set manually except for testing purposes.
|
|
|
|
``-s``
|
|
When setting key timing data, also update the state file.
|
|
|
|
``-g``
|
|
Set the goal state for this key. Must be HIDDEN or OMNIPRESENT.
|
|
|
|
``-d``
|
|
Set the DS state for this key, and when it was last changed.
|
|
|
|
``-k``
|
|
Set the DNSKEY state for this key, and when it was last changed.
|
|
|
|
``-r``
|
|
Set the RRSIG (KSK) state for this key, and when it was last changed.
|
|
|
|
``-z``
|
|
|
|
Set the RRSIG (ZSK) state for this key, and when it was last changed.
|
|
|
|
Printing Options
|
|
~~~~~~~~~~~~~~~~
|
|
|
|
``dnssec-settime`` can also be used to print the timing metadata
|
|
associated with a key.
|
|
|
|
**-u**
|
|
Print times in UNIX epoch format.
|
|
|
|
**-p** C/P/Pds/Psync/A/R/I/D/Dds/Dsync/all
|
|
Prints a specific metadata value or set of metadata values. The ``-p``
|
|
option may be followed by one or more of the following letters or strings
|
|
to indicate which value or values to print: ``C`` for the creation date,
|
|
``P`` for the publication date, ``Pds` for the DS publication date,
|
|
``Psync`` for the CDS and CDNSKEY publication date, ``A`` for the
|
|
activation date, ``R`` for the revocation date, ``I`` for the inactivation
|
|
date, ``D`` for the deletion date, ``Dds`` for the DS deletion date,
|
|
and ``Dsync`` for the CDS and CDNSKEY deletion date. To print all of the
|
|
metadata, use ``all``.
|
|
|
|
See Also
|
|
~~~~~~~~
|
|
|
|
:manpage:`dnssec-keygen(8)`, :manpage:`dnssec-signzone(8)`, BIND 9 Administrator Reference Manual,
|
|
:rfc:`5011`.
|