Commit Graph

6679 Commits

Author SHA1 Message Date
Matthijs Mekking
f2fc0e9c9e Add some clarifications wrt dynamic zones
These were suggested by GitLab user @elmaimbo.

(cherry picked from commit fb517eb52a)
2022-06-27 11:04:11 +02:00
Ron Aitchison
22ac5003b5 Added explanations or Argument, Value, and Directive to the ARM
(cherry picked from commit d44cb9f194)
2022-06-24 16:47:28 +02:00
Petr Špaček
5fbeebc6f3 Add link to glob definition for include directive
(cherry picked from commit bb2a19d655)
2022-06-24 16:47:28 +02:00
Suzanne Goldlust
1fc681cce6 Minor text nitpicking around dnssec-policy grammar reference
(cherry picked from commit f4503061ba)
2022-06-24 16:47:28 +02:00
Petr Špaček
19fde8b8f1 Remove ambiguous link anchors for logging { file } statement
Unfortunatelly logging and zone blocks use file statements with
different semantics but the same name.

There is no sane way to disambiguate them in text, so let's remove the
link anchor from logging so we can link to the file statement in zone.

My assumption is that linking to logging { file } is very unlikely
because logging is self-contained in one block but zone config is all
over the place.

(cherry picked from commit fbcaa44851)
2022-06-24 16:47:28 +02:00
Petr Špaček
1b9c74152e Remove ambiguous link anchors for keys statement
Unfortunatelly dnssec-policy and servers blocks use keys statements with
a totally different grammar and semantics but the same name.
There is no sane way to disambiguate them in text, so let's remove the
link anchors to prevent errorneous linking.

(cherry picked from commit d6b2423c99)
2022-06-24 16:47:28 +02:00
Petr Špaček
a7da2d4993 Change statement->argument terminology for control channel
control { inet ... allow keys read-only }; are not actual statements
but in fact arguments of a statement. Remove .. namedconf:statement::
syntax to avoid collisions with other statements of the same name.

(cherry picked from commit caf2675ef8)
2022-06-24 16:47:28 +02:00
Petr Špaček
70924290ca Deduplicate dnssec-policy definition in the ARM
(cherry picked from commit 3233414a53)
2022-06-24 16:47:28 +02:00
Petr Špaček
b023b62b8d Deduplicate null definition in the ARM logging section
(cherry picked from commit fa2ba5423b)
2022-06-24 16:47:28 +02:00
Petr Špaček
c496ffe4f4 Deduplicate {use,avoid}-v{4,6}-udp-ports definitions in the ARM
Statements affected:
use-v4-udp-ports
use-v6-udp-ports
avoid-v4-udp-ports
avoid-v6-udp-ports

(cherry picked from commit cd1b9aa052)
2022-06-24 16:47:28 +02:00
Petr Špaček
df2c19c19b Deduplicate request-expire definition in the ARM
(cherry picked from commit 6e634c43cd)
2022-06-24 16:47:27 +02:00
Petr Špaček
8af0d9eca7 Deduplicate provide-ixfr definition in the ARM
(cherry picked from commit 22e6c8a29e)
2022-06-24 16:47:27 +02:00
Petr Špaček
98445cc32b Deduplicate request-ixfr definition in the ARM
Let's be consistent and put all definitions in the options block.

(cherry picked from commit 14389bc446)
2022-06-24 16:47:27 +02:00
Petr Špaček
0dd45cb17f Deduplicate notify-source, notify-source-v6 definitions in the ARM
(cherry picked from commit 08a3cd7ae4)
2022-06-24 16:47:27 +02:00
Petr Špaček
3688d706da Deduplicate request-nsid definition in the ARM
(cherry picked from commit e91529a48b)
2022-06-24 16:47:27 +02:00
Petr Špaček
c611110c9b Deduplicate query-source, query-source-v6 definitions in the ARM
(cherry picked from commit 92a125b9c4)
2022-06-24 16:47:27 +02:00
Petr Špaček
8e5925c25a Deduplicate transfer-source, transfer-source-v6 definitions in the ARM
(cherry picked from commit 538f5a7520)
2022-06-24 16:47:27 +02:00
Petr Špaček
8a2470d559 Deduplicate transfer-format definition in the ARM
(cherry picked from commit b6eb0b298d)
2022-06-24 16:47:27 +02:00
Petr Špaček
97530e74e0 Deduplicate send-cookie definition in the ARM
(cherry picked from commit 7937c4bc9c)
2022-06-24 16:47:27 +02:00
Petr Špaček
7390e1e113 Deduplicate max-udp-size definition in the ARM
(cherry picked from commit 8ac82b4f30)
2022-06-24 16:47:27 +02:00
Petr Špaček
9ccadcc310 Deduplicate edns-udp-size definition in the ARM
(cherry picked from commit 624bbf403c)
2022-06-24 16:47:27 +02:00
Petr Špaček
40b9aa2e0b Deduplicate max-zone-ttl definition in the ARM
This is confusing as hell, but we cannot fix that in the manual itself.
At least now the user is made aware of two distinct defaults.

(cherry picked from commit 405a0931ea)
2022-06-24 16:47:27 +02:00
Petr Špaček
e28050e7a4 Deduplicate allow-update definition in the ARM
(cherry picked from commit 420a7331a8)
2022-06-24 16:47:27 +02:00
Ron Aitchison
0c52d244ba Reference new named.conf description instead of man page
(cherry picked from commit cf85e776c6)
2022-06-24 16:47:26 +02:00
Ron Aitchison
b8fa35789e Remove line numbering from config file examples
(cherry picked from commit 31e3d1aaf7)
2022-06-24 16:47:26 +02:00
Ron Aitchison
309a75e56b Changed all references from clause to block
(cherry picked from commit c40a983334)
2022-06-24 16:47:26 +02:00
Ron Aitchison
f16cfcebe4 Restructure introduction to named.conf in the ARM
(cherry picked from commit b01262b7f2)
2022-06-24 16:47:26 +02:00
Petr Špaček
667335bd1c Add link anchors to statements and blocks in the ARM
All statements now use .. namedconf:statement:: or
.. rndcconf:statement:: syntax provided by our Sphinx extension.

This has several consequences:
- It changes how statement headings are rendered
- Statements are indexed and show up as separate items in doc
  search results (in the HTML version)
- Statements can be linked to using either :any:`statement` or
  :namedconf:ref:`statement` syntax (not used in this commit)
- Statements can be categorized and printed using ..
  namedconf:statatementlist:: syntax (not used in this commit)

(cherry picked from commit e5b7022dcb)
2022-06-24 16:47:25 +02:00
Matthijs Mekking
b18e6455d1 Document what is a too short key lifetime
To give a hint to users that get an error that the key lifetime is
shorter than the time it takes to do a rollover.

(cherry picked from commit c47735b86b)
2022-06-23 12:40:47 +02:00
Michał Kępień
40aceeb96a Add a note to the ARM on dnstap & resolver traffic
Warn users that server-side IP addresses are not stored in dnstap
captures of resolver traffic unless "query-source(-v6)" is explicitly
set, explaining why it is so.

(cherry picked from commit 366f7a938b)
2022-06-22 21:14:40 +02:00
Petr Špaček
504cbd2353 Mention zone storage in the DNSSEC chapter
Let's not duplicate texts, link to description elsewhere instead.

(cherry picked from commit 146c125988)
2022-06-22 15:58:59 +02:00
Suzanne Goldlust
003423974b Minor grammar improvements in the Signing chapter of the DNSSEC Guide
(cherry picked from commit 6b1ad4dcfb)
2022-06-22 15:58:51 +02:00
Matthijs Mekking
342baee607 Add a section about key rollover
Describe how to do key rollovers with dnssec-policy. Update the
revert to unsigned recipe in the DNSSEC guide.

(cherry picked from commit f721986589)
2022-06-22 15:58:45 +02:00
Petr Špaček
595eb27b7e Deduplicate Manual Signing between DNSSEC chapter and DNSSEC Guide
The two procedures were essentially the same, but each instance was
missing some details from the other. They are now combined into one text
in the DNSSEC Guide and linked from DNSSEC chapter.

(cherry picked from commit 7d25027898)
2022-06-22 15:58:39 +02:00
Petr Špaček
99ef4f254f Deduplicate key filename description in the DNSSEC Guide
Third time ...

(cherry picked from commit 7e96801841)
2022-06-22 15:58:31 +02:00
Petr Špaček
06b02f2b4a Use ECDSAP256SHA256 in DNSSEC signing examples
(cherry picked from commit 3eb6898a14)
2022-06-22 15:58:08 +02:00
Petr Špaček
eda822a1fc Use code-block directive for complete command lines
Minor rendering nit, not really important.

(cherry picked from commit 915237a28f)
2022-06-22 15:58:00 +02:00
Petr Špaček
f1d71dff5a Deduplicate key filename description in the DNSSEC chapter
(cherry picked from commit 1dcc34f076)
2022-06-22 15:57:53 +02:00
Petr Špaček
5b30bffaaa Move Private Type Records in DNSSEC chapter to higher level
Private Type Records are not specific to manually signing, so it is
better to move it to the end of the "Zone Signing" section shared by all
three methods.

(cherry picked from commit 5ba618fd28)
2022-06-22 15:57:45 +02:00
Petr Špaček
1d07cf4883 Rewrite DNSSEC Validation subchapter in the ARM
Mostly deduplicating and linking information across the ARM.
Generally people should not touch it unless they what they are doing, so
let's try to discourage them a bit.

(cherry picked from commit bffa3063f0)
2022-06-22 15:57:37 +02:00
Petr Špaček
c6a82e0ff1 Add hints about secure delegation to DNSSEC chapter of the ARM
Let's not duplicate texts from elsewhere, just point to different parts
of documentation.

(cherry picked from commit 29030fa5d7)
2022-06-22 15:57:29 +02:00
Petr Špaček
b51c7be326 Reorder chapters about Zone Signing in the DNSSEC chapter of ARM
Let's make more automated methods more prominent:
- KASP first
- dynamic updates second
- command-line tools only as last resort

(cherry picked from commit 28a533322b)
2022-06-22 15:57:21 +02:00
Petr Špaček
b288a7e48a Rewrite KASP section of DNSSEC chapter in the ARM
The goal is simplicity. Copy&paste to do the right thing, or read
referenced material and make up your mind if you need specialities.

NSEC discussion is already present in the DNSSEC guide so I merged
KASP examples with example for NSEC3 and removed NSEC text from the
DNSSEC chapter.

(cherry picked from commit 744763f8f2)
2022-06-22 15:57:14 +02:00
Petr Špaček
b502211060 Rewrite introduction for DNSSEC chapter of the ARM
I've attempted to drop most of DNSSEC-specific jargon from the intro
paragraph, and to convince readers to read on.

(cherry picked from commit 0dc9c33149)
2022-06-22 15:57:07 +02:00
Matthijs Mekking
72ad0ed7cf Use NSEC3 guidance values in nsec3 config examples
Use best practice values in examples that follow new guidance from
draft-ietf-dnsop-nsec3-guidance:

   ; SHA-1, no extra iterations, empty salt:
   ;
   bcp.example. IN NSEC3PARAM 1 0 0 -

(cherry picked from commit 93601d8325)
2022-06-22 15:57:00 +02:00
Matthijs Mekking
ef9dcad036 Move "DNSSEC" chapter before "Advanced" and "Security"
DNSSEC is mainstream nowadays, so let's give it more attention.

(cherry picked from commit 024c15f03b)
2022-06-22 15:56:49 +02:00
Matthijs Mekking
cd348f3d60 Move Dynamic Zones section up
Move this section up so that DNSSEC signing topics are grouped together
(and not split by the DNSSEC Validation chapter).

(cherry picked from commit 7824c5c967)
2022-06-22 15:56:40 +02:00
Matthijs Mekking
205805f5ca Rewrite Dynamic Zones section
Restructure the section about dynamic zones and automatic signing:
- Focus on dynamic zones with 'auto-dnssec allow;'.
- Add a section about multi-signer models.
- Move NSEC3 related topics into one section.
- Remove any text that does not concern dynamic zones (mostly duplicate
  text anyway).

(cherry picked from commit be54c08d2b)
2022-06-22 15:56:34 +02:00
Matthijs Mekking
966645c3a7 Add a section about Denial of Existence
Move bits from the "DNSSEC, Dynamic Zones, and Automatic Signing"
about denial of existence to a separate section below the "Key and
Signing Policy" section.

Add a brief introduction about denial of existence to this section.

(cherry picked from commit 71490a5a2d)
2022-06-22 15:56:27 +02:00
Matthijs Mekking
65498441b0 Rewrap a paragraph in DNSSEC Validation section
No textual changes, just rewrapping to 80 characters.

(cherry picked from commit 34dea43f9c)
2022-06-22 15:56:19 +02:00