upstream/bind9
1
0
Fork 0
mirror of https://github.com/isc-projects/bind9.git synced 2026-04-28 17:46:40 -04:00
Code Issues Projects Releases Packages Wiki Activity Actions
bind9/bin/tools/nsec3hash.rst

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

71 lines
2 KiB
ReStructuredText
Raw Normal View History

Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
.. Copyright (C) Internet Systems Consortium, Inc. ("ISC")
..
.. SPDX-License-Identifier: MPL-2.0
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files.
2021-06-03 02:37:05 -04:00
..
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
.. 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 https://mozilla.org/MPL/2.0/.
Update the copyright information in all files in the repository This commit converts the license handling to adhere to the REUSE specification. It specifically: 1. Adds used licnses to LICENSES/ directory 2. Add "isc" template for adding the copyright boilerplate 3. Changes all source files to include copyright and SPDX license header, this includes all the C sources, documentation, zone files, configuration files. There are notes in the doc/dev/copyrights file on how to add correct headers to the new files. 4. Handle the rest that can't be modified via .reuse/dep5 file. The binary (or otherwise unmodifiable) files could have license places next to them in <foo>.license file, but this would lead to cluttered repository and most of the files handled in the .reuse/dep5 file are system test files.
2021-06-03 02:37:05 -04:00
..
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
.. See the COPYRIGHT file distributed with this work for additional
.. information regarding copyright ownership.
.. highlight: console
Introduce new Sphinx role iscman for ISC manual pages The new directive and role "iscman" allow to tag & reference man pages in our source tree. Essentially it is just namespacing for ISC man pages, but it comes with couple benefits. Differences from .. _man_program label we formerly used: - Does not expand :ref:`man_program` into full text of the page header. - Generates index entry with category "manual page". - Rendering style is closer to ubiquitous to the one produced by ``named`` syntax. Differences from Sphinx built-in :manpage: role: - Supports all builders with support for cross-references. - Generates internal links (unlike :manpage: which generates external URLs). - Checks that target exists withing our source tree.
2022-03-03 09:32:35 -05:00
.. iscman:: nsec3hash
Add semantic markup for program names into manual pages It allows to cross-reference options in man pages from other documents using :option:`named -g` syntax.
2022-03-02 10:36:34 -05:00
.. program:: nsec3hash
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
.. _man_nsec3hash:
nsec3hash - generate NSEC3 hash
-------------------------------
Synopsis
~~~~~~~~
:program:`nsec3hash` {salt} {algorithm} {iterations} {domain}
:program:`nsec3hash` **-r** {algorithm} {flags} {iterations} {salt} {domain}
Description
~~~~~~~~~~~
Use semantic markup for :program: self-references Sphinx has it's own :program: syntax for refering to program names. Use it for self-references in manual pages. These self-references are not clickable and not as eye-cathing as links, which is a good thing. There is no point in attracting attention to ``dig`` several times on a single page dedicated to dig itself. Substituted automatically using: find bin -name *.rst | xargs fgrep --files-with-matches '.. program' | xargs -n1 bash /tmp/repl.sh With /tmp/repl.sh being: BASE=$(basename "$1" .rst) sed -i -e "s/\`\`$BASE\`\`/:program:\`$BASE\`/g" "$1"
2022-03-03 10:00:43 -05:00
:program:`nsec3hash` generates an NSEC3 hash based on a set of NSEC3
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
parameters. This can be used to check the validity of NSEC3 records in a
signed zone.
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 16:01:17 -04:00
If this command is invoked as ``nsec3hash -r``, it takes arguments in
order, matching the first four fields of an NSEC3 record followed by the
domain name: ``algorithm``, ``flags``, ``iterations``, ``salt``, ``domain``. This makes it
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
convenient to copy and paste a portion of an NSEC3 or NSEC3PARAM record
into a command line to confirm the correctness of an NSEC3 hash.
Arguments
~~~~~~~~~
Denote all command line options using semantic markup (.. option::) The markup allows referencing individual options, and also makes them more legible (no more thin red text on gray background). Most of the work was done using regexes: s/^``-\(.*\)``$/.. option:: -\1\r/ s/^``+\(.*\)``$/.. option:: +\1\r/ on bin/**/*.rst files along with visual inspection and hand-edits, mostly for positional arguments. Regex for rndc.rst: s/^``\(.*\)``/.. option:: \1\r/ + hand edits to remove extra asterisk and whitespace here and there.
2022-03-02 09:12:17 -05:00
.. option:: salt
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 16:01:17 -04:00
This is the salt provided to the hash algorithm.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
Denote all command line options using semantic markup (.. option::) The markup allows referencing individual options, and also makes them more legible (no more thin red text on gray background). Most of the work was done using regexes: s/^``-\(.*\)``$/.. option:: -\1\r/ s/^``+\(.*\)``$/.. option:: +\1\r/ on bin/**/*.rst files along with visual inspection and hand-edits, mostly for positional arguments. Regex for rndc.rst: s/^``\(.*\)``/.. option:: \1\r/ + hand edits to remove extra asterisk and whitespace here and there.
2022-03-02 09:12:17 -05:00
.. option:: algorithm
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 16:01:17 -04:00
This is a number indicating the hash algorithm. Currently the only supported
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
hash algorithm for NSEC3 is SHA-1, which is indicated by the number
1; consequently "1" is the only useful value for this argument.
Denote all command line options using semantic markup (.. option::) The markup allows referencing individual options, and also makes them more legible (no more thin red text on gray background). Most of the work was done using regexes: s/^``-\(.*\)``$/.. option:: -\1\r/ s/^``+\(.*\)``$/.. option:: +\1\r/ on bin/**/*.rst files along with visual inspection and hand-edits, mostly for positional arguments. Regex for rndc.rst: s/^``\(.*\)``/.. option:: \1\r/ + hand edits to remove extra asterisk and whitespace here and there.
2022-03-02 09:12:17 -05:00
.. option:: flags
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 16:01:17 -04:00
This is provided for compatibility with NSEC3 record presentation format, but
is ignored since the flags do not affect the hash.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
Denote all command line options using semantic markup (.. option::) The markup allows referencing individual options, and also makes them more legible (no more thin red text on gray background). Most of the work was done using regexes: s/^``-\(.*\)``$/.. option:: -\1\r/ s/^``+\(.*\)``$/.. option:: +\1\r/ on bin/**/*.rst files along with visual inspection and hand-edits, mostly for positional arguments. Regex for rndc.rst: s/^``\(.*\)``/.. option:: \1\r/ + hand edits to remove extra asterisk and whitespace here and there.
2022-03-02 09:12:17 -05:00
.. option:: iterations
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 16:01:17 -04:00
This is the number of additional times the hash should be performed.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
Denote all command line options using semantic markup (.. option::) The markup allows referencing individual options, and also makes them more legible (no more thin red text on gray background). Most of the work was done using regexes: s/^``-\(.*\)``$/.. option:: -\1\r/ s/^``+\(.*\)``$/.. option:: +\1\r/ on bin/**/*.rst files along with visual inspection and hand-edits, mostly for positional arguments. Regex for rndc.rst: s/^``\(.*\)``/.. option:: \1\r/ + hand edits to remove extra asterisk and whitespace here and there.
2022-03-02 09:12:17 -05:00
.. option:: domain
Text and formatting edits to various manual pages. Follwing manual pages have been updated: rndc.conf.rst, rndc.rst nsec3hash.rst, dnstap-read.rst, named-nzd2nzf.rst, mdig.rst, named-rrchecker.rst, dnssec-revoke.rst, dnssec-cds.rst, dnssec-keyfromlabel.rst, and dnssec-keygen.rst
2020-06-03 16:01:17 -04:00
This is the domain name to be hashed.
Convert the documentation to Sphinx documentation format The ARM and the manpages have been converted into Sphinx documentation format. Sphinx uses reStructuredText as its markup language, and many of its strengths come from the power and straightforwardness of reStructuredText and its parsing and translating suite, the Docutils.
2019-03-31 06:49:47 -04:00
See Also
~~~~~~~~
BIND 9 Administrator Reference Manual, :rfc:`5155`.
Reference in a new issue Copy permalink