summaryrefslogtreecommitdiffstats
path: root/manager/knot_resolver_manager/datamodel/dnssec_schema.py
blob: 5e274c9a969596a1ae9a6fbb7e7d9de95e8e4534 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
from typing import List, Optional

from knot_resolver_manager.datamodel.types import DomainName, EscapedStr, File, IntNonNegative, TimeUnit
from knot_resolver_manager.utils.modeling import ConfigSchema


class TrustAnchorFileSchema(ConfigSchema):
    """
    Trust-anchor zonefile configuration.

    ---
    file: Path to the zonefile that stores trust-anchors.
    read_only: Blocks zonefile updates according to RFC 5011.

    """

    file: File
    read_only: bool = False


class DnssecSchema(ConfigSchema):
    """
    DNSSEC configuration.

    ---
    trust_anchor_sentinel: Allows users of DNSSEC validating resolver to detect which root keys are configured in resolver's chain of trust. (RFC 8509)
    trust_anchor_signal_query: Signaling Trust Anchor Knowledge in DNSSEC Using Key Tag Query, according to (RFC 8145#section-5).
    time_skew_detection: Detection of difference between local system time and expiration time bounds in DNSSEC signatures for '. NS' records.
    keep_removed: How many removed keys should be held in history (and key file) before being purged.
    refresh_time: Force trust-anchors to be updated every defined time periodically instead of relying on (RFC 5011) logic and TTLs. Intended only for testing purposes.
    hold_down_time: Modify hold-down timer (RFC 5011). Intended only for testing purposes.
    trust_anchors: List of trust-anchors in DS/DNSKEY records format.
    negative_trust_anchors: List of domain names representing negative trust-anchors. (RFC 7646)
    trust_anchors_files: List of zonefiles where trust-anchors are stored.
    """

    trust_anchor_sentinel: bool = True
    trust_anchor_signal_query: bool = True
    time_skew_detection: bool = True
    keep_removed: IntNonNegative = IntNonNegative(0)
    refresh_time: Optional[TimeUnit] = None
    hold_down_time: TimeUnit = TimeUnit("30d")
    trust_anchors: Optional[List[EscapedStr]] = None
    negative_trust_anchors: Optional[List[DomainName]] = None
    trust_anchors_files: Optional[List[TrustAnchorFileSchema]] = None