bionic (3) Net::DNS::RR::NSEC3.3pm.gz

NAME

       Net::DNS::RR::NSEC3 - DNS NSEC3 resource record

SYNOPSIS

           use Net::DNS;
           $rr = new Net::DNS::RR('name NSEC3 algorithm flags iterations salt hnxtname');

DESCRIPTION

       Class for DNSSEC NSEC3 resource records.

       The NSEC3 Resource Record (RR) provides authenticated denial of existence for DNS Resource Record Sets.

       The NSEC3 RR lists RR types present at the original owner name of the NSEC3 RR.  It includes the next
       hashed owner name in the hash order of the zone.  The complete set of NSEC3 RRs in a zone indicates which
       RRSets exist for the original owner name of the RR and form a chain of hashed owner names in the zone.

METHODS

       The available methods are those inherited from the base class augmented by the type-specific methods
       defined in this package.

       Use of undocumented package features or direct access to internal data structures is discouraged and
       could result in program termination or other unpredictable behaviour.

   algorithm
           $algorithm = $rr->algorithm;
           $rr->algorithm( $algorithm );

       The Hash Algorithm field is represented as an unsigned decimal integer.  The value has a maximum of 255.

       algorithm() may also be invoked as a class method or simple function to perform mnemonic and numeric code
       translation.

   flags
           $flags = $rr->flags;
           $rr->flags( $flags );

       The Flags field is represented as an unsigned decimal integer.  The value has a maximum value of 255.

       optout
            $rr->optout(1);

            if ( $rr->optout ) {
                   ...
            }

           Boolean Opt Out flag.

   iterations
           $iterations = $rr->iterations;
           $rr->iterations( $iterations );

       The Iterations field is represented as an unsigned decimal integer.  The value is between 0 and 65535,
       inclusive.

   salt
           $salt = $rr->salt;
           $rr->salt( $salt );

       The Salt field is represented as a contiguous sequence of hexadecimal digits. A "-" (unquoted) is used in
       string format to indicate that the salt field is absent.

   saltbin
           $saltbin = $rr->saltbin;
           $rr->saltbin( $saltbin );

       The Salt field as a sequence of octets.

   hnxtname
           $hnxtname = $rr->hnxtname;
           $rr->hnxtname( $hnxtname );

       The Next Hashed Owner Name field points to the next node that has authoritative data or contains a
       delegation point NS RRset.

   typelist
           @typelist = $rr->typelist;
           $typelist = $rr->typelist;
           $rr->typelist( @typelist );

       The Type List identifies the RRset types that exist at the domain name matched by the NSEC3 RR.  When
       called in scalar context, the list is interpolated into a string.

   covered, match
           print "covered" if $rr->covered{'example.foo'}

       covered() returns a nonzero value when the the domain name provided as argument is covered as defined in
       the NSEC3 specification:

          To cover:  An NSEC3 RR is said to "cover" a name if the hash of the
             name or "next closer" name falls between the owner name and the
             next hashed owner name of the NSEC3.  In other words, if it proves
             the nonexistence of the name, either directly or by proving the
             nonexistence of an ancestor of the name.

       Similarly matched() returns a nonzero value when the domainname in the argument matches as defined in the
       NSEC3 specification:

          To match: An NSEC3 RR is said to "match" a name if the owner name
             of the NSEC3 RR is the same as the hashed owner name of that
             name.

COPYRIGHT

       Copyright (c)2017 Dick Franks

       Portions Copyright (c)2007,2008 NLnet Labs.  Author Olaf M. Kolkman

       All rights reserved.

       Package template (c)2009,2012 O.M.Kolkman and R.W.Franks.

LICENSE

       Permission to use, copy, modify, and distribute this software and its documentation for any purpose and
       without fee is hereby granted, provided that the above copyright notice appear in all copies and that
       both that copyright notice and this permission notice appear in supporting documentation, and that the
       name of the author not be used in advertising or publicity pertaining to distribution of the software
       without specific prior written permission.

       THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT
       LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO
       EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
       IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
       THE USE OR OTHER DEALINGS IN THE SOFTWARE.

SEE ALSO

       perl, Net::DNS, Net::DNS::RR, RFC5155, RFC4648

       Hash Algorithms <http://www.iana.org/assignments/dnssec-nsec3-parameters>