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.
2020-07-02 15:27:54 -07:00
parent 858082de51
commit ba52377b37
28 changed files with 111 additions and 180 deletions
--- 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
--- a/bin/confgen/ddns-confgen.c
+++ b/bin/confgen/ddns-confgen.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 <stdarg.h>
--- a/bin/confgen/ddns-confgen.rst
+++ b/bin/confgen/ddns-confgen.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
--- a/bin/confgen/win32/ddnsconfgen.vcxproj.filters.in
+++ b/bin/confgen/win32/ddnsconfgen.vcxproj.filters.in
@@ -11,8 +11,8 @@
    </Filter>
  </ItemGroup>
  <ItemGroup>
-    <ClCompile Include="..\ddns-confgen.c">
+    <ClCompile Include="..\tsig-keygen.c">
      <Filter>Source Files</Filter>
    </ClCompile>
  </ItemGroup>
-</Project>
+</Project>
--- a/bin/confgen/win32/ddnsconfgen.vcxproj.in
+++ b/bin/confgen/win32/ddnsconfgen.vcxproj.in
@@ -13,7 +13,7 @@
  <PropertyGroup Label="Globals">
    <ProjectGuid>{1EA4FC64-F33B-4A50-970A-EA052BBE9CF1}</ProjectGuid>
    <Keyword>Win32Proj</Keyword>
-    <RootNamespace>ddnsconfgen</RootNamespace>
+    <RootNamespace>tsigkeygen</RootNamespace>
    @WINDOWS_TARGET_PLATFORM_VERSION@
  </PropertyGroup>
  <Import Project="$(VCTargetsPath)\Microsoft.Cpp.Default.props" />
@@ -45,14 +45,14 @@
    <OutDir>..\..\..\Build\$(Configuration)\</OutDir>
    <IntDir>.\$(Configuration)\</IntDir>
    <IntDirSharingDetected>None</IntDirSharingDetected>
-    <TargetName>ddns-confgen</TargetName>
+    <TargetName>tsig-keygen</TargetName>
  </PropertyGroup>
  <PropertyGroup Condition="'$(Configuration)|$(Platform)'=='Release|@PLATFORM@'">
    <LinkIncremental>false</LinkIncremental>
    <OutDir>..\..\..\Build\$(Configuration)\</OutDir>
    <IntDir>.\$(Configuration)\</IntDir>
    <IntDirSharingDetected>None</IntDirSharingDetected>
-    <TargetName>ddns-confgen</TargetName>
+    <TargetName>tsig-keygen</TargetName>
  </PropertyGroup>
  <ItemDefinitionGroup Condition="'$(Configuration)|$(Platform)'=='Debug|@PLATFORM@'">
    <ClCompile>
@@ -81,8 +81,8 @@
    </Link>
    <PostBuildEvent>
      <Command>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
 </Command>
    </PostBuildEvent>
  </ItemDefinitionGroup>
@@ -119,12 +119,12 @@ copy /Y ddns-confgen.ilk tsig-keygen.ilk
    </Link>
    <PostBuildEvent>
      <Command>cd ..\..\..\Build\$(Configuration)
-copy /Y ddns-confgen.exe tsig-keygen.exe
+copy /Y tsig-keygen.exe ddns-confgen.exe
 </Command>
    </PostBuildEvent>
  </ItemDefinitionGroup>
  <ItemGroup>
-    <ClCompile Include="..\ddns-confgen.c" />
+    <ClCompile Include="..\tsig-keygen.c" />
  </ItemGroup>
  <ItemGroup>
    <ProjectReference Include="..\..\..\lib\isc\win32\libisc.vcxproj">
--- a/bin/confgen/win32/ddnsconfgen.vcxproj.user
+++ b/bin/confgen/win32/ddnsconfgen.vcxproj.user
@@ -1,3 +1,3 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project ToolsVersion="4.0" xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
-</Project>
+</Project>