.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "Zonemaster::Engine::Test::DNSSEC 3pm"
.TH Zonemaster::Engine::Test::DNSSEC 3pm 2024-04-22 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
Zonemaster::Engine::Test::DNSSEC \- Module implementing tests focused on DNSSEC
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 1
\&    my @results = Zonemaster::Engine::Test::DNSSEC\->all( $zone );
.Ve
.SH METHODS
.IX Header "METHODS"
.IP \fBall()\fR 4
.IX Item "all()"
.Vb 1
\&    my @logentry_array = all( $zone );
.Ve
.Sp
Runs the default set of tests for that module, i.e. between one and seventeen tests depending on the tested zone.
If DNSSEC07 finds no DNSKEY nor DS RRs, no other test is run. If DNSSEC07 finds a DNSKEY RR, DNSSEC06 is run.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBmetadata()\fR 4
.IX Item "metadata()"
.Vb 1
\&    my $hash_ref = metadata();
.Ve
.Sp
Returns a reference to a hash, the keys of which are the names of all Test Cases in the module, and the corresponding values are references to
an array containing all the message tags that the Test Case can use in log entries.
.IP \fBtag_descriptions()\fR 4
.IX Item "tag_descriptions()"
.Vb 1
\&    my $hash_ref = tag_descriptions();
.Ve
.Sp
Used by the built-in translation system.
.Sp
Returns a reference to a hash, the keys of which are the message tags and the corresponding values are strings (message IDs).
.IP \fBversion()\fR 4
.IX Item "version()"
.Vb 1
\&    my $version_string = version();
.Ve
.Sp
Returns a string containing the version of the current module.
.SH "INTERNAL METHODS"
.IX Header "INTERNAL METHODS"
.IP \fB_emit_log()\fR 4
.IX Item "_emit_log()"
.Vb 1
\&    my $log_entry = _emit_log( $message_tag_string, $hash_ref );
.Ve
.Sp
Adds a message to the logger for this module.
See "add($tag, \f(CW$argref\fR, \f(CW$module\fR, \f(CW$testcase\fR)" in Zonemaster::Engine::Logger::Entry for more details.
.Sp
Takes a string (message tag) and a reference to a hash (arguments).
.Sp
Returns a Zonemaster::Engine::Logger::Entry object.
.IP \fB_ip_disabled_message()\fR 4
.IX Item "_ip_disabled_message()"
.Vb 1
\&    my $bool = _ip_disabled_message( $logentry_array_ref, $ns, @query_type_array );
.Ve
.Sp
Checks if the IP version of a given name server is allowed to be queried. If not, it adds a logging message and returns true. Else, it returns false.
.Sp
Takes a reference to an array of Zonemaster::Engine::Logger::Entry objects, a Zonemaster::Engine::Nameserver object and an array of strings (query type).
.Sp
Returns a boolean.
.SH TESTS
.IX Header "TESTS"
.IP \fBdnssec01()\fR 4
.IX Item "dnssec01()"
.Vb 1
\&    my @logentry_array = dnssec01( $zone );
.Ve
.Sp
Runs the DNSSEC01 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec01.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec02()\fR 4
.IX Item "dnssec02()"
.Vb 1
\&    my @logentry_array = dnssec02( $zone );
.Ve
.Sp
Runs the DNSSEC02 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec02.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec03()\fR 4
.IX Item "dnssec03()"
.Vb 1
\&    my @logentry_array = dnssec03( $zone );
.Ve
.Sp
Runs the DNSSEC03 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec03.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec04()\fR 4
.IX Item "dnssec04()"
.Vb 1
\&    my @logentry_array = dnssec04( $zone );
.Ve
.Sp
Runs the DNSSEC04 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec04.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec05()\fR 4
.IX Item "dnssec05()"
.Vb 1
\&    my @logentry_array = dnssec05( $zone );
.Ve
.Sp
Runs the DNSSEC05 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec05.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec06()\fR 4
.IX Item "dnssec06()"
.Vb 1
\&    my @logentry_array = dnssec06( $zone );
.Ve
.Sp
Runs the DNSSEC06 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec06.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec07()\fR 4
.IX Item "dnssec07()"
.Vb 1
\&    my @logentry_array = dnssec07( $zone );
.Ve
.Sp
Runs the DNSSEC07 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec07.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec08()\fR 4
.IX Item "dnssec08()"
.Vb 1
\&    my @logentry_array = dnssec08( $zone );
.Ve
.Sp
Runs the DNSSEC08 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec08.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec09()\fR 4
.IX Item "dnssec09()"
.Vb 1
\&    my @logentry_array = dnssec09( $zone );
.Ve
.Sp
Runs the DNSSEC09 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec09.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec10()\fR 4
.IX Item "dnssec10()"
.Vb 1
\&    my @logentry_array = dnssec10( $zone );
.Ve
.Sp
Runs the DNSSEC10 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec10.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec11()\fR 4
.IX Item "dnssec11()"
.Vb 1
\&    my @logentry_array = dnssec11( $zone );
.Ve
.Sp
Runs the DNSSEC11 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec11.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec13()\fR 4
.IX Item "dnssec13()"
.Vb 1
\&    my @logentry_array = dnssec13( $zone );
.Ve
.Sp
Runs the DNSSEC13 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec13.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec14()\fR 4
.IX Item "dnssec14()"
.Vb 1
\&    my @logentry_array = dnssec14( $zone );
.Ve
.Sp
Runs the DNSSEC14 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec14.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec15()\fR 4
.IX Item "dnssec15()"
.Vb 1
\&    my @logentry_array = dnssec15( $zone );
.Ve
.Sp
Runs the DNSSEC15 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec15.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec16()\fR 4
.IX Item "dnssec16()"
.Vb 1
\&    my @logentry_array = dnssec16( $zone );
.Ve
.Sp
Runs the DNSSEC16 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec16.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec17()\fR 4
.IX Item "dnssec17()"
.Vb 1
\&    my @logentry_array = dnssec17( $zone );
.Ve
.Sp
Runs the DNSSEC17 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec17.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.
.IP \fBdnssec18()\fR 4
.IX Item "dnssec18()"
.Vb 1
\&    my @logentry_array = dnssec18( $zone );
.Ve
.Sp
Runs the DNSSEC18 Test Case <https://github.com/zonemaster/zonemaster/blob/master/docs/public/specifications/tests/DNSSEC-TP/dnssec18.md>.
.Sp
Takes a Zonemaster::Engine::Zone object.
.Sp
Returns a list of Zonemaster::Engine::Logger::Entry objects.