rndc-confgen8
Rndc key generation tool
Usage
rndc-confgen [-a]
[-A
algorithm]
[-b
keysize]
[-c
keyfile]
[-h]
[-k
keyname]
[-p
port]
[-s
address]
[-t
chrootdir]
[-u
user]
Overview
rndc-confgen generates configuration files for rndc <#std-iscman-rndc>. It can be used as a convenient alternative to writing the rndc.conf <#std-iscman-rndc.conf> file and the corresponding controls and key statements in named.conf <#std-iscman-named.conf> by hand. Alternatively, it can be run with the -a option to set up a rndc.key file and avoid the need for a rndc.conf <#std-iscman-rndc.conf> file and a controls statement altogether.
Options
-
-a -
This option sets automatic
rndc<#std-iscman-rndc> configuration, which creates a file/etc/rndc.keythat is read by bothrndc<#std-iscman-rndc> andnamed<#std-iscman-named> on startup. Therndc.keyfile defines a default command channel and authentication key allowingrndc<#std-iscman-rndc> to communicate withnamed<#std-iscman-named> on the local host with no further configuration.If a more elaborate configuration than that generated by rndc-confgen -a is required, for example if rndc is to be used remotely, run
rndc-confgenwithout the-aoption and set uprndc.conf<#std-iscman-rndc.conf> andnamed.conf<#std-iscman-named.conf> as directed.
-
-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.
-
-b keysize -
This option specifies the size of the authentication key in bits. The size must be between 1 and 512 bits; the default is the hash size.
-
-c keyfile -
This option is used with the
-aoption to specify an alternate location forrndc.key.
-
-h -
This option prints a short summary of the options and arguments to
rndc-confgen.
-
-k keyname -
This option specifies the key name of the
rndc<#std-iscman-rndc> authentication key. This must be a valid domain name and will be sanitized using the domain name semantics. The default isrndc-key.
-
-p port -
This option specifies the command channel port where
named<#std-iscman-named> listens for connections fromrndc<#std-iscman-rndc>. The default is 953.
-
-q -
This option prevets printing the written path in automatic configuration mode.
-
-s address -
This option specifies the IP address where
named<#std-iscman-named> listens for command-channel connections fromrndc<#std-iscman-rndc>. The default is the loopback address 127.0.0.1.
-
-t chrootdir -
This option is used with the
-aoption to specify a directory wherenamed<#std-iscman-named> runs chrooted. An additional copy of therndc.keyis written relative to this directory, so that it is found by the chrootednamed<#std-iscman-named>.
-
-u user -
This option is used with the
-aoption to set the owner of the generatedrndc.keyfile. If-tis also specified, only the file in the chroot area has its owner changed.
Examples
To allow rndc <#std-iscman-rndc> to be used with no manual configuration, run:
rndc-confgen -a
To print a sample rndc.conf <#std-iscman-rndc.conf> file and the corresponding controls and key statements to be manually inserted into named.conf <#std-iscman-named.conf>, run:
rndc-confgen
Releases
13 releases since Debian 3.0 (Woody); the text changed 11 times.
-A since Debian 9 (Stretch);
-q since Debian 12 (Bookworm).
-r until Debian 10 (Buster).