From ba52377b3741ab294ee1cea2410b9b9ddcb0b7e9 Mon Sep 17 00:00:00 2001 From: Evan Hunt Date: Thu, 2 Jul 2020 15:27:54 -0700 Subject: [PATCH] use 'tsig-keygen' as the primary name for the tool 'ddns-confgen' is now an alias for 'tsig-keygen', rather than the other way around. --- CHANGES | 5 + bin/confgen/Makefile.am | 8 +- bin/confgen/{ddns-confgen.c => tsig-keygen.c} | 5 +- .../{ddns-confgen.rst => tsig-keygen.rst} | 42 +++---- ...lters.in => tsigkeygen.vcxproj.filters.in} | 4 +- ...nfgen.vcxproj.in => tsigkeygen.vcxproj.in} | 14 +-- ...n.vcxproj.user => tsigkeygen.vcxproj.user} | 2 +- bin/named/named.conf.rst | 2 +- bin/nsupdate/nsupdate.rst | 2 +- bin/tests/system/conf.sh.in | 1 - bin/tests/system/conf.sh.win32 | 1 - bin/tests/system/dlzexternal/setup.sh | 2 +- bin/tests/system/nsupdate/setup.sh | 14 +-- bin/win32/BINDInstall/BINDInstall.vcxproj.in | 2 +- doc/arm/advanced.rst | 2 +- doc/arm/manpages.rst | 2 +- doc/man/Makefile.am | 8 +- doc/man/conf.py | 2 +- doc/man/ddns-confgen.8in | 109 ------------------ doc/man/named.conf.5in | 2 +- doc/man/nsupdate.1in | 2 +- doc/man/tsig-keygen.8in | 38 ++++++ doc/man/{ddns-confgen.rst => tsig-keygen.rst} | 0 doc/misc/named.conf.rst | 2 +- doc/misc/rst-options.pl | 2 +- util/copyrights | 12 +- win32utils/Configure | 4 +- win32utils/bind9.sln.in | 2 +- 28 files changed, 111 insertions(+), 180 deletions(-) rename bin/confgen/{ddns-confgen.c => tsig-keygen.c} (97%) rename bin/confgen/{ddns-confgen.rst => tsig-keygen.rst} (71%) rename bin/confgen/win32/{ddnsconfgen.vcxproj.filters.in => tsigkeygen.vcxproj.filters.in} (92%) rename bin/confgen/win32/{ddnsconfgen.vcxproj.in => tsigkeygen.vcxproj.in} (96%) rename bin/confgen/win32/{ddnsconfgen.vcxproj.user => tsigkeygen.vcxproj.user} (92%) delete mode 100644 doc/man/ddns-confgen.8in create mode 100644 doc/man/tsig-keygen.8in rename doc/man/{ddns-confgen.rst => tsig-keygen.rst} (100%) diff --git a/CHANGES b/CHANGES index 226534ea38..761f9a1161 100644 --- a/CHANGES +++ b/CHANGES @@ -1,3 +1,8 @@ +5460. [cleanup] tsig-keygen was previously an alias for + ddns-confgen and was documented in the ddns-confgen + man page. This has been reversed; tsig-keygen is + now the primary name. [GL #1998] + 5459. [bug] Bad isc_mem_put() size when an invalid type was specified in a update-policy rule. [GL #1990] diff --git a/bin/confgen/Makefile.am b/bin/confgen/Makefile.am index 7d0f41dc37..3101aba39e 100644 --- a/bin/confgen/Makefile.am +++ b/bin/confgen/Makefile.am @@ -20,11 +20,11 @@ libconfgen_la_SOURCES = \ util.c \ unix/os.c -sbin_PROGRAMS = ddns-confgen rndc-confgen +sbin_PROGRAMS = tsig-keygen rndc-confgen install-exec-hook: - ln -f $(DESTDIR)$(sbindir)/ddns-confgen \ - $(DESTDIR)$(sbindir)/tsig-confgen + ln -f $(DESTDIR)$(sbindir)/tsig-keygen \ + $(DESTDIR)$(sbindir)/ddns-confgen uninstall-hook: - -rm -f $(DESTDIR)$(sbindir)/tsig-confgen + -rm -f $(DESTDIR)$(sbindir)/ddns-confgen diff --git a/bin/confgen/ddns-confgen.c b/bin/confgen/tsig-keygen.c similarity index 97% rename from bin/confgen/ddns-confgen.c rename to bin/confgen/tsig-keygen.c index 02e3f72bc5..5e7860faff 100644 --- a/bin/confgen/ddns-confgen.c +++ b/bin/confgen/tsig-keygen.c @@ -12,9 +12,8 @@ /*! \file */ /** - * ddns-confgen generates configuration files for dynamic DNS. It can - * be used as a convenient alternative to writing the ddns.key file - * and the corresponding key and update-policy statements in named.conf. + * tsig-keygen generates TSIG keys that can be used in named configuration + * files for dynamic DNS. */ #include diff --git a/bin/confgen/ddns-confgen.rst b/bin/confgen/tsig-keygen.rst similarity index 71% rename from bin/confgen/ddns-confgen.rst rename to bin/confgen/tsig-keygen.rst index 5380c8a714..d9a2756b71 100644 --- a/bin/confgen/ddns-confgen.rst +++ b/bin/confgen/tsig-keygen.rst @@ -21,10 +21,10 @@ .. highlight: console -.. _man_ddns-confgen: +.. _man_tsig-keygen: -ddns-confgen - ddns key generation tool ---------------------------------------- +tsig-keygen, ddns-confgen - TSIG key generation tool +---------------------------------------------------- Synopsis ~~~~~~~~ @@ -37,15 +37,16 @@ Description ``tsig-keygen`` and ``ddns-confgen`` are invocation methods for a utility that generates keys for use in TSIG signing. The resulting keys -can be used, for example, to secure dynamic DNS updates to a zone or for +can be used, for example, to secure dynamic DNS updates to a zone, or for the ``rndc`` command channel. When run as ``tsig-keygen``, a domain name can be specified on the command line to be used as the name of the generated key. If no name is specified, the default is ``tsig-key``. -When run as ``ddns-confgen``, the generated key is accompanied by -configuration text and instructions that can be used with ``nsupdate`` +When run as ``ddns-confgen``, the key name can specified using ``-k`` +parameter and defaults to ``ddns-key``. The generated key is accompanied +by configuration text and instructions that can be used with ``nsupdate`` and ``named`` when setting up dynamic DNS, including an example ``update-policy`` statement. (This usage is similar to the ``rndc-confgen`` command for setting up command-channel security.) @@ -60,20 +61,20 @@ Options ~~~~~~~ ``-a algorithm`` - This option specifies the algorithm to use for the TSIG key. Available choices - are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, and - hmac-sha512. The default is hmac-sha256. Options are + This option specifies the algorithm to use for the TSIG key. Available + choices are: hmac-md5, hmac-sha1, hmac-sha224, hmac-sha256, hmac-sha384, + and hmac-sha512. The default is hmac-sha256. Options are case-insensitive, and the "hmac-" prefix may be omitted. ``-h`` This option prints a short summary of options and arguments. ``-k keyname`` - This option specifies the key name of the DDNS authentication key. The default is - ``ddns-key`` when neither the ``-s`` nor ``-z`` option is specified; - otherwise, the default is ``ddns-key`` as a separate label followed - by the argument of the option, e.g., ``ddns-key.example.com.`` The - key name must have the format of a valid domain name, consisting of + This option specifies the key name of the DDNS authentication key. The + default is ``ddns-key`` when neither the ``-s`` nor ``-z`` option is + specified; otherwise, the default is ``ddns-key`` as a separate label + followed by the argument of the option, e.g., ``ddns-key.example.com.`` + The key name must have the format of a valid domain name, consisting of letters, digits, hyphens, and periods. ``-q`` (``ddns-confgen`` only) @@ -82,13 +83,12 @@ Options ``tsig-keygen``. ``-s name`` (``ddns-confgen`` only) - This option generates a configuration example to allow - dynamic updates of a single hostname. The example ``named.conf`` text - shows how to set an update policy for the specified name using the - "name" nametype. The default key name is ``ddns-key.name``. Note that the - "self" nametype cannot be used, since the name to be updated may - differ from the key name. This option cannot be used with the ``-z`` - option. + This option generates a configuration example to allow dynamic updates + of a single hostname. The example ``named.conf`` text shows how to set + an update policy for the specified name using the "name" nametype. The + default key name is ``ddns-key.name``. Note that the "self" nametype + cannot be used, since the name to be updated may differ from the key + name. This option cannot be used with the ``-z`` option. ``-z zone`` (``ddns-confgen`` only) This option generates a configuration example to allow diff --git a/bin/confgen/win32/ddnsconfgen.vcxproj.filters.in b/bin/confgen/win32/tsigkeygen.vcxproj.filters.in similarity index 92% rename from bin/confgen/win32/ddnsconfgen.vcxproj.filters.in rename to bin/confgen/win32/tsigkeygen.vcxproj.filters.in index ccdaa818bb..ef6527dccb 100644 --- a/bin/confgen/win32/ddnsconfgen.vcxproj.filters.in +++ b/bin/confgen/win32/tsigkeygen.vcxproj.filters.in @@ -11,8 +11,8 @@ - + Source Files - \ No newline at end of file + diff --git a/bin/confgen/win32/ddnsconfgen.vcxproj.in b/bin/confgen/win32/tsigkeygen.vcxproj.in similarity index 96% rename from bin/confgen/win32/ddnsconfgen.vcxproj.in rename to bin/confgen/win32/tsigkeygen.vcxproj.in index a49330cae7..c12dd1c0b0 100644 --- a/bin/confgen/win32/ddnsconfgen.vcxproj.in +++ b/bin/confgen/win32/tsigkeygen.vcxproj.in @@ -13,7 +13,7 @@ {1EA4FC64-F33B-4A50-970A-EA052BBE9CF1} Win32Proj - ddnsconfgen + tsigkeygen @WINDOWS_TARGET_PLATFORM_VERSION@ @@ -45,14 +45,14 @@ ..\..\..\Build\$(Configuration)\ .\$(Configuration)\ None - ddns-confgen + tsig-keygen false ..\..\..\Build\$(Configuration)\ .\$(Configuration)\ None - ddns-confgen + tsig-keygen @@ -81,8 +81,8 @@ cd ..\..\..\Build\$(Configuration) -copy /Y ddns-confgen.exe tsig-keygen.exe -copy /Y ddns-confgen.ilk tsig-keygen.ilk +copy /Y tsig-keygen.exe ddns-confgen.exe +copy /Y tsig-keygen.ilk ddns-confgen.ilk @@ -119,12 +119,12 @@ copy /Y ddns-confgen.ilk tsig-keygen.ilk cd ..\..\..\Build\$(Configuration) -copy /Y ddns-confgen.exe tsig-keygen.exe +copy /Y tsig-keygen.exe ddns-confgen.exe - + diff --git a/bin/confgen/win32/ddnsconfgen.vcxproj.user b/bin/confgen/win32/tsigkeygen.vcxproj.user similarity index 92% rename from bin/confgen/win32/ddnsconfgen.vcxproj.user rename to bin/confgen/win32/tsigkeygen.vcxproj.user index ace9a86acb..7135522534 100644 --- a/bin/confgen/win32/ddnsconfgen.vcxproj.user +++ b/bin/confgen/win32/tsigkeygen.vcxproj.user @@ -1,3 +1,3 @@  - \ No newline at end of file + diff --git a/bin/named/named.conf.rst b/bin/named/named.conf.rst index 0716c1b748..2b982d580a 100644 --- a/bin/named/named.conf.rst +++ b/bin/named/named.conf.rst @@ -1025,5 +1025,5 @@ Files See Also ~~~~~~~~ -:manpage:`ddns-confgen(8)`, :manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, BIND 9 Administrator Reference Manual. +:manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, :manpage:`tsig-keygen(8)`, BIND 9 Administrator Reference Manual. diff --git a/bin/nsupdate/nsupdate.rst b/bin/nsupdate/nsupdate.rst index 55d1b26a35..ffb22bec28 100644 --- a/bin/nsupdate/nsupdate.rst +++ b/bin/nsupdate/nsupdate.rst @@ -355,7 +355,7 @@ See Also ~~~~~~~~ :rfc:`2136`, :rfc:`3007`, :rfc:`2104`, :rfc:`2845`, :rfc:`1034`, :rfc:`2535`, :rfc:`2931`, -:manpage:`named(8)`, :manpage:`ddns-confgen(8)`, :manpage:`dnssec-keygen(8)`. +:manpage:`named(8)`, :manpage:`dnssec-keygen(8)`, :manpage:`tsig-keygen(8)`. Bugs ~~~~ diff --git a/bin/tests/system/conf.sh.in b/bin/tests/system/conf.sh.in index 9e3ab3248c..8ff73f0ad0 100644 --- a/bin/tests/system/conf.sh.in +++ b/bin/tests/system/conf.sh.in @@ -31,7 +31,6 @@ ARPANAME=$TOP_BUILDDIR/bin/tools/arpaname CDS=$TOP_BUILDDIR/bin/dnssec/dnssec-cds CHECKCONF=$TOP_BUILDDIR/bin/check/named-checkconf CHECKZONE=$TOP_BUILDDIR/bin/check/named-checkzone -DDNSCONFGEN=$TOP_BUILDDIR/bin/confgen/ddns-confgen DELV=$TOP_BUILDDIR/bin/delv/delv DIG=$TOP_BUILDDIR/bin/dig/dig DNSTAPREAD=$TOP_BUILDDIR/bin/tools/dnstap-read diff --git a/bin/tests/system/conf.sh.win32 b/bin/tests/system/conf.sh.win32 index 6565e1620b..c0600eee44 100644 --- a/bin/tests/system/conf.sh.win32 +++ b/bin/tests/system/conf.sh.win32 @@ -32,7 +32,6 @@ ARPANAME=$TOP_BUILDDIR/Build/$VSCONF/arpaname@EXEEXT@ CDS=$TOP_BUILDDIR/Build/$VSCONF/dnssec-cds@EXEEXT@ CHECKCONF=$TOP_BUILDDIR/Build/$VSCONF/named-checkconf@EXEEXT@ CHECKZONE=$TOP_BUILDDIR/Build/$VSCONF/named-checkzone@EXEEXT@ -DDNSCONFGEN=$TOP_BUILDDIR/Build/$VSCONF/ddns-confgen@EXEEXT@ DELV=$TOP_BUILDDIR/Build/$VSCONF/delv@EXEEXT@ DIG=$TOP_BUILDDIR/Build/$VSCONF/dig@EXEEXT@ DNSTAPREAD=$TOP_BUILDDIR/Build/$VSCONF/dnstap-read@EXEEXT@ diff --git a/bin/tests/system/dlzexternal/setup.sh b/bin/tests/system/dlzexternal/setup.sh index 063cdba5ab..d7551eade9 100644 --- a/bin/tests/system/dlzexternal/setup.sh +++ b/bin/tests/system/dlzexternal/setup.sh @@ -11,6 +11,6 @@ . $SYSTEMTESTTOP/conf.sh -$DDNSCONFGEN -q -z example.nil > ns1/ddns.key +$TSIGKEYGEN ddns-key.example.nil > ns1/ddns.key copy_setports ns1/named.conf.in ns1/named.conf diff --git a/bin/tests/system/nsupdate/setup.sh b/bin/tests/system/nsupdate/setup.sh index f0ccd9ef3e..2c73a45a9b 100644 --- a/bin/tests/system/nsupdate/setup.sh +++ b/bin/tests/system/nsupdate/setup.sh @@ -53,14 +53,14 @@ ns1.update.nil. A 10.53.0.2 ns2.update.nil. AAAA ::1 EOF -$DDNSCONFGEN -q -z example.nil > ns1/ddns.key +$TSIGKEYGEN ddns-key.example.nil > ns1/ddns.key -$DDNSCONFGEN -q -a hmac-md5 -k md5-key -z keytests.nil > ns1/md5.key -$DDNSCONFGEN -q -a hmac-sha1 -k sha1-key -z keytests.nil > ns1/sha1.key -$DDNSCONFGEN -q -a hmac-sha224 -k sha224-key -z keytests.nil > ns1/sha224.key -$DDNSCONFGEN -q -a hmac-sha256 -k sha256-key -z keytests.nil > ns1/sha256.key -$DDNSCONFGEN -q -a hmac-sha384 -k sha384-key -z keytests.nil > ns1/sha384.key -$DDNSCONFGEN -q -a hmac-sha512 -k sha512-key -z keytests.nil > ns1/sha512.key +$TSIGKEYGEN -a hmac-md5 md5-key > ns1/md5.key +$TSIGKEYGEN -a hmac-sha1 sha1-key > ns1/sha1.key +$TSIGKEYGEN -a hmac-sha224 sha224-key > ns1/sha224.key +$TSIGKEYGEN -a hmac-sha256 sha256-key > ns1/sha256.key +$TSIGKEYGEN -a hmac-sha384 sha384-key > ns1/sha384.key +$TSIGKEYGEN -a hmac-sha512 sha512-key > ns1/sha512.key (cd ns3; $SHELL -e sign.sh) diff --git a/bin/win32/BINDInstall/BINDInstall.vcxproj.in b/bin/win32/BINDInstall/BINDInstall.vcxproj.in index e54a8f5ba6..7e01a4b9f6 100644 --- a/bin/win32/BINDInstall/BINDInstall.vcxproj.in +++ b/bin/win32/BINDInstall/BINDInstall.vcxproj.in @@ -162,7 +162,7 @@ {64964B03-4815-41F0-9057-E766A94AF197} - + {1EA4FC64-F33B-4A50-970A-EA052BBE9CF1} diff --git a/doc/arm/advanced.rst b/doc/arm/advanced.rst index 921039a136..d7c2edd853 100644 --- a/doc/arm/advanced.rst +++ b/doc/arm/advanced.rst @@ -416,7 +416,7 @@ email, etc.) ``tsig-keygen`` can also be run as ``ddns-confgen``, in which case its output includes additional configuration text for setting up dynamic DNS -in ``named``. See :ref:`man_ddns-confgen` for details. +in ``named``. See :ref:`man_tsig-keygen` for details. Loading a New Key ~~~~~~~~~~~~~~~~~ diff --git a/doc/arm/manpages.rst b/doc/arm/manpages.rst index 1579ff2a08..0ca442053a 100644 --- a/doc/arm/manpages.rst +++ b/doc/arm/manpages.rst @@ -14,7 +14,7 @@ Manual Pages ============ .. include:: ../../bin/tools/arpaname.rst -.. include:: ../../bin/confgen/ddns-confgen.rst +.. include:: ../../bin/confgen/tsig-keygen.rst .. include:: ../../bin/delv/delv.rst .. include:: ../../bin/dig/dig.rst .. include:: ../../bin/dnssec/dnssec-cds.rst diff --git a/doc/man/Makefile.am b/doc/man/Makefile.am index 625d0da0e0..d038d01e6e 100644 --- a/doc/man/Makefile.am +++ b/doc/man/Makefile.am @@ -3,7 +3,6 @@ include $(top_srcdir)/Makefile.docs MANPAGES_RST = \ arpaname.rst \ - ddns-confgen.rst \ delv.rst \ dig.rst \ dnssec-cds.rst \ @@ -37,10 +36,11 @@ MANPAGES_RST = \ rndc-confgen.rst \ rndc.conf.rst \ rndc.rst \ + tsig-keygen.rst \ ../../bin/check/named-checkconf.rst \ ../../bin/check/named-checkzone.rst \ - ../../bin/confgen/ddns-confgen.rst \ ../../bin/confgen/rndc-confgen.rst \ + ../../bin/confgen/tsig-keygen.rst \ ../../bin/delv/delv.rst \ ../../bin/dig/dig.rst \ ../../bin/dig/host.rst \ @@ -84,7 +84,6 @@ man_MANS = \ nsupdate.1 \ named.conf.5 \ rndc.conf.5 \ - ddns-confgen.8 \ dnssec-cds.1 \ dnssec-dsfromkey.1 \ dnssec-importkey.1 \ @@ -102,7 +101,8 @@ man_MANS = \ named.8 \ nsec3hash.1 \ rndc-confgen.8 \ - rndc.8 + rndc.8 \ + tsig-keygen.8 if HAVE_PKCS11 man_MANS += \ diff --git a/doc/man/conf.py b/doc/man/conf.py index 03d70dd7e0..8e1706f169 100644 --- a/doc/man/conf.py +++ b/doc/man/conf.py @@ -60,7 +60,6 @@ master_doc = 'index' # pylint: disable=line-too-long man_pages = [ ('arpaname', 'arpaname', 'translate IP addresses to the corresponding ARPA names', author, 1), - ('ddns-confgen', 'ddns-confgen', 'ddns key generation tool', author, 8), ('delv', 'delv', 'DNS lookup and validation utility', author, 1), ('dig', 'dig', 'DNS lookup utility', author, 1), ('dnssec-cds', 'dnssec-cds', 'change DS records for a child zone based on CDS/CDNSKEY', author, 1), @@ -93,4 +92,5 @@ man_pages = [ ('rndc-confgen', 'rndc-confgen', 'rndc key generation tool', author, 8), ('rndc.conf', 'rndc.conf', 'rndc configuration file', author, 5), ('rndc', 'rndc', 'name server control utility', author, 8), + ('tsig-keygen', 'tsig-keygen', 'TSIG key generation tool', author, 8), ] diff --git a/doc/man/ddns-confgen.8in b/doc/man/ddns-confgen.8in deleted file mode 100644 index fe0d8431e7..0000000000 --- a/doc/man/ddns-confgen.8in +++ /dev/null @@ -1,109 +0,0 @@ -.\" Man page generated from reStructuredText. -. -.TH "DDNS-CONFGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9" -.SH NAME -ddns-confgen \- ddns key generation tool -. -.nr rst2man-indent-level 0 -. -.de1 rstReportMargin -\\$1 \\n[an-margin] -level \\n[rst2man-indent-level] -level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] -- -\\n[rst2man-indent0] -\\n[rst2man-indent1] -\\n[rst2man-indent2] -.. -.de1 INDENT -.\" .rstReportMargin pre: -. RS \\$1 -. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] -. nr rst2man-indent-level +1 -.\" .rstReportMargin post: -.. -.de UNINDENT -. RE -.\" indent \\n[an-margin] -.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] -.nr rst2man-indent-level -1 -.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] -.in \\n[rst2man-indent\\n[rst2man-indent-level]]u -.. -.SH SYNOPSIS -.sp -\fBtsig\-keygen\fP [\fB\-a\fP algorithm] [\fB\-h\fP] [\fB\-r\fP randomfile] [\fB\-s\fP name] -.sp -\fBddns\-confgen\fP [\fB\-a\fP algorithm] [\fB\-h\fP] [\fB\-k\fP keyname] [\fB\-q\fP] [\fB\-r\fP randomfile] [\fB\-s\fP name] [\fB\-z\fP zone] -.SH DESCRIPTION -.sp -\fBtsig\-keygen\fP and \fBddns\-confgen\fP are invocation methods for a -utility that generates keys for use in TSIG signing. The resulting keys -can be used, for example, to secure dynamic DNS updates to a zone or for -the \fBrndc\fP command channel. -.sp -When run as \fBtsig\-keygen\fP, a domain name can be specified on the -command line to be used as the name of the generated key. If no -name is specified, the default is \fBtsig\-key\fP\&. -.sp -When run as \fBddns\-confgen\fP, the generated key is accompanied by -configuration text and instructions that can be used with \fBnsupdate\fP -and \fBnamed\fP when setting up dynamic DNS, including an example -\fBupdate\-policy\fP statement. (This usage is similar to the \fBrndc\-confgen\fP -command for setting up command\-channel security.) -.sp -Note that \fBnamed\fP itself can configure a local DDNS key for use with -\fBnsupdate \-l\fP; it does this when a zone is configured with -\fBupdate\-policy local;\fP\&. \fBddns\-confgen\fP is only needed when a more -elaborate configuration is required: for instance, if \fBnsupdate\fP is to -be used from a remote system. -.SH OPTIONS -.INDENT 0.0 -.TP -.B \fB\-a algorithm\fP -This option specifies the algorithm to use for the TSIG key. Available choices -are: hmac\-md5, hmac\-sha1, hmac\-sha224, hmac\-sha256, hmac\-sha384, and -hmac\-sha512. The default is hmac\-sha256. Options are -case\-insensitive, and the "hmac\-" prefix may be omitted. -.TP -.B \fB\-h\fP -This option prints a short summary of options and arguments. -.TP -.B \fB\-k keyname\fP -This option specifies the key name of the DDNS authentication key. The default is -\fBddns\-key\fP when neither the \fB\-s\fP nor \fB\-z\fP option is specified; -otherwise, the default is \fBddns\-key\fP as a separate label followed -by the argument of the option, e.g., \fBddns\-key.example.com.\fP The -key name must have the format of a valid domain name, consisting of -letters, digits, hyphens, and periods. -.TP -.B \fB\-q\fP (\fBddns\-confgen\fP only) -This option enables quiet mode, which prints only the key, with no -explanatory text or usage examples. This is essentially identical to -\fBtsig\-keygen\fP\&. -.TP -.B \fB\-s name\fP (\fBddns\-confgen\fP only) -This option generates a configuration example to allow -dynamic updates of a single hostname. The example \fBnamed.conf\fP text -shows how to set an update policy for the specified name using the -"name" nametype. The default key name is \fBddns\-key.name\fP\&. Note that the -"self" nametype cannot be used, since the name to be updated may -differ from the key name. This option cannot be used with the \fB\-z\fP -option. -.TP -.B \fB\-z zone\fP (\fBddns\-confgen\fP only) -This option generates a configuration example to allow -dynamic updates of a zone. The example \fBnamed.conf\fP text shows how -to set an update policy for the specified zone using the "zonesub" -nametype, allowing updates to all subdomain names within that zone. -This option cannot be used with the \fB\-s\fP option. -.UNINDENT -.SH SEE ALSO -.sp -\fBnsupdate(1)\fP, \fBnamed.conf(5)\fP, \fBnamed(8)\fP, BIND 9 Administrator Reference Manual. -.SH AUTHOR -Internet Systems Consortium -.SH COPYRIGHT -2020, Internet Systems Consortium -.\" Generated by docutils manpage writer. -. diff --git a/doc/man/named.conf.5in b/doc/man/named.conf.5in index bc3319edd5..f8feea55aa 100644 --- a/doc/man/named.conf.5in +++ b/doc/man/named.conf.5in @@ -1120,7 +1120,7 @@ zone string [ class ] { \fB/etc/named.conf\fP .SH SEE ALSO .sp -\fBddns\-confgen(8)\fP, \fBnamed(8)\fP, \fBnamed\-checkconf(8)\fP, \fBrndc(8)\fP, \fBrndc\-confgen(8)\fP, BIND 9 Administrator Reference Manual. +\fBtsig\-keygen(8)\fP, \fBnamed(8)\fP, \fBnamed\-checkconf(8)\fP, \fBrndc(8)\fP, \fBrndc\-confgen(8)\fP, BIND 9 Administrator Reference Manual. .SH AUTHOR Internet Systems Consortium .SH COPYRIGHT diff --git a/doc/man/nsupdate.1in b/doc/man/nsupdate.1in index a52c03d6d1..3e53a1b351 100644 --- a/doc/man/nsupdate.1in +++ b/doc/man/nsupdate.1in @@ -364,7 +364,7 @@ Base\-64 encoding of the HMAC\-MD5 key created by \fBdnssec\-keygen\fP\&. .SH SEE ALSO .sp \fI\%RFC 2136\fP, \fI\%RFC 3007\fP, \fI\%RFC 2104\fP, \fI\%RFC 2845\fP, \fI\%RFC 1034\fP, \fI\%RFC 2535\fP, \fI\%RFC 2931\fP, -\fBnamed(8)\fP, \fBddns\-confgen(8)\fP, \fBdnssec\-keygen(8)\fP\&. +\fBnamed(8)\fP, \fBtsig\-keygen(8)\fP, \fBdnssec\-keygen(8)\fP\&. .SH BUGS .sp The TSIG key is redundantly stored in two separate files. This is a diff --git a/doc/man/tsig-keygen.8in b/doc/man/tsig-keygen.8in new file mode 100644 index 0000000000..cd19148de5 --- /dev/null +++ b/doc/man/tsig-keygen.8in @@ -0,0 +1,38 @@ +.\" Man page generated from reStructuredText. +. +.TH "TSIG-KEYGEN" "8" "@RELEASE_DATE@" "@PACKAGE_VERSION@" "BIND 9" +.SH NAME +tsig-keygen \- TSIG key generation tool +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH AUTHOR +Internet Systems Consortium +.SH COPYRIGHT +2020, Internet Systems Consortium +.\" Generated by docutils manpage writer. +. diff --git a/doc/man/ddns-confgen.rst b/doc/man/tsig-keygen.rst similarity index 100% rename from doc/man/ddns-confgen.rst rename to doc/man/tsig-keygen.rst diff --git a/doc/misc/named.conf.rst b/doc/misc/named.conf.rst index 24ff5aa1b8..1de1a2a2c1 100644 --- a/doc/misc/named.conf.rst +++ b/doc/misc/named.conf.rst @@ -1021,5 +1021,5 @@ Files See Also ~~~~~~~~ -:manpage:`ddns-confgen(8)`, :manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, BIND 9 Administrator Reference Manual. +:manpage:`tsig-keygen(8)`, :manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, BIND 9 Administrator Reference Manual. diff --git a/doc/misc/rst-options.pl b/doc/misc/rst-options.pl index c82dd0bab3..d65e620330 100644 --- a/doc/misc/rst-options.pl +++ b/doc/misc/rst-options.pl @@ -114,6 +114,6 @@ Files See Also ~~~~~~~~ -:manpage:`ddns-confgen(8)`, :manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, BIND 9 Administrator Reference Manual. +:manpage:`named(8)`, :manpage:`named-checkconf(8)`, :manpage:`rndc(8)`, :manpage:`rndc-confgen(8)`, :manpage:`tsig-keygen(8)`, BIND 9 Administrator Reference Manual. END diff --git a/util/copyrights b/util/copyrights index e049c42f45..135b8f835a 100644 --- a/util/copyrights +++ b/util/copyrights @@ -22,26 +22,26 @@ ./bin/check/win32/checkzone.vcxproj.filters.in X 2013,2015,2018,2019,2020 ./bin/check/win32/checkzone.vcxproj.in X 2013,2014,2015,2016,2017,2018,2019,2020 ./bin/check/win32/checkzone.vcxproj.user X 2013,2018,2019,2020 -./bin/confgen/ddns-confgen.c C 2009,2011,2014,2016,2018,2019,2020 -./bin/confgen/ddns-confgen.rst RST 2020 ./bin/confgen/include/confgen/os.h C 2009,2016,2018,2019,2020 ./bin/confgen/keygen.c C 2009,2012,2013,2014,2015,2016,2017,2018,2019,2020 ./bin/confgen/keygen.h C 2009,2016,2018,2019,2020 ./bin/confgen/rndc-confgen.c C 2001,2003,2004,2005,2007,2008,2009,2011,2013,2014,2016,2017,2018,2019,2020 ./bin/confgen/rndc-confgen.rst RST 2020 +./bin/confgen/tsig-keygen.c C 2009,2011,2014,2016,2018,2019,2020 +./bin/confgen/tsig-keygen.rst RST 2020 ./bin/confgen/unix/os.c C 2009,2016,2018,2019,2020 ./bin/confgen/util.c C 2009,2015,2016,2018,2019,2020 ./bin/confgen/util.h C 2009,2016,2018,2019,2020 ./bin/confgen/win32/confgentool.vcxproj.filters.in X 2013,2015,2018,2019,2020 ./bin/confgen/win32/confgentool.vcxproj.in X 2013,2015,2016,2017,2018,2019,2020 ./bin/confgen/win32/confgentool.vcxproj.user X 2013,2018,2019,2020 -./bin/confgen/win32/ddnsconfgen.vcxproj.filters.in X 2013,2015,2018,2019,2020 -./bin/confgen/win32/ddnsconfgen.vcxproj.in X 2013,2014,2015,2016,2017,2018,2019,2020 -./bin/confgen/win32/ddnsconfgen.vcxproj.user X 2013,2018,2019,2020 ./bin/confgen/win32/os.c C 2009,2016,2018,2019,2020 ./bin/confgen/win32/rndcconfgen.vcxproj.filters.in X 2013,2015,2018,2019,2020 ./bin/confgen/win32/rndcconfgen.vcxproj.in X 2013,2015,2016,2017,2018,2019,2020 ./bin/confgen/win32/rndcconfgen.vcxproj.user X 2013,2018,2019,2020 +./bin/confgen/win32/tsigkeygen.vcxproj.filters.in X 2013,2015,2018,2019,2020 +./bin/confgen/win32/tsigkeygen.vcxproj.in X 2013,2014,2015,2016,2017,2018,2019,2020 +./bin/confgen/win32/tsigkeygen.vcxproj.user X 2013,2018,2019,2020 ./bin/delv/delv.c C 2014,2015,2016,2017,2018,2019,2020 ./bin/delv/delv.rst RST 2020 ./bin/delv/win32/delv.vcxproj.filters.in X 2014,2015,2018,2019,2020 @@ -1174,7 +1174,6 @@ ./doc/doxygen/mainpage X 2006,2018,2019,2020 ./doc/man/arpaname.rst RST 2020 ./doc/man/conf.py PYTHON 2020 -./doc/man/ddns-confgen.rst RST 2020 ./doc/man/delv.rst RST 2020 ./doc/man/dig.rst RST 2020 ./doc/man/dnssec-cds.rst RST 2020 @@ -1208,6 +1207,7 @@ ./doc/man/rndc-confgen.rst RST 2020 ./doc/man/rndc.conf.rst RST 2020 ./doc/man/rndc.rst RST 2020 +./doc/man/tsig-keygen.rst RST 2020 ./doc/misc/cfg_test.c C 2020 ./doc/misc/delegation-only.zoneopt X 2018,2019,2020 ./doc/misc/format-options.pl PERL 2001,2004,2007,2012,2016,2018,2019,2020 diff --git a/win32utils/Configure b/win32utils/Configure index e33ed59215..4567fb39b7 100644 --- a/win32utils/Configure +++ b/win32utils/Configure @@ -40,8 +40,8 @@ my @projectlist = ("../bin/check/win32/checkconf.vcxproj", "../bin/check/win32/checkzone.vcxproj.filters", "../bin/confgen/win32/confgentool.vcxproj", "../bin/confgen/win32/confgentool.vcxproj.filters", - "../bin/confgen/win32/ddnsconfgen.vcxproj", - "../bin/confgen/win32/ddnsconfgen.vcxproj.filters", + "../bin/confgen/win32/tsigkeygen.vcxproj", + "../bin/confgen/win32/tsigkeygen.vcxproj.filters", "../bin/confgen/win32/rndcconfgen.vcxproj", "../bin/confgen/win32/rndcconfgen.vcxproj.filters", "../bin/delv/win32/delv.vcxproj", diff --git a/win32utils/bind9.sln.in b/win32utils/bind9.sln.in index 1cd3ca3283..fe004aece3 100644 --- a/win32utils/bind9.sln.in +++ b/win32utils/bind9.sln.in @@ -92,7 +92,7 @@ Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "confgentool", "..\bin\confg EndProject Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "rndcconfgen", "..\bin\confgen\win32\rndcconfgen.vcxproj", "{1E2C1635-3093-4D59-80E7-4743AC10F22F}" EndProject -Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "ddnsconfgen", "..\bin\confgen\win32\ddnsconfgen.vcxproj", "{1EA4FC64-F33B-4A50-970A-EA052BBE9CF1}" +Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "tsigkeygen", "..\bin\confgen\win32\tsigkeygen.vcxproj", "{1EA4FC64-F33B-4A50-970A-EA052BBE9CF1}" EndProject @IF PKCS11 Project("{8BC9CEB8-8B4A-11D0-8D11-00A0C91BC942}") = "pk11keygen", "..\bin\pkcs11\win32\pk11keygen.vcxproj", "{5042D371-0402-4FA3-A52A-769708694422}"