.\" -*- 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 "Net::DNS::RR::DNSKEY 3pm"
.TH Net::DNS::RR::DNSKEY 3pm 2024-02-17 "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
Net::DNS::RR::DNSKEY \- DNS DNSKEY resource record
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 2
\&    use Net::DNS;
\&    $rr = Net::DNS::RR\->new(\*(Aqname DNSKEY flags protocol algorithm publickey\*(Aq);
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
Class for DNSSEC Key (DNSKEY) resource records.
.SH METHODS
.IX Header "METHODS"
The available methods are those inherited from the base class augmented
by the type-specific methods defined in this package.
.PP
Use of undocumented package features or direct access to internal data
structures is discouraged and could result in program termination or
other unpredictable behaviour.
.SS flags
.IX Subsection "flags"
.Vb 2
\&    $flags = $rr\->flags;
\&    $rr\->flags( $flags );
.Ve
.PP
Unsigned 16\-bit number representing Boolean flags.
.IP zone 4
.IX Item "zone"
.Vb 1
\& $rr\->zone(1);
\&
\& if ( $rr\->zone ) {
\&        ...
\& }
.Ve
.Sp
Boolean ZONE flag.
.IP revoke 4
.IX Item "revoke"
.Vb 1
\& $rr\->revoke(1);
\&
\& if ( $rr\->revoke ) {
\&        ...
\& }
.Ve
.Sp
Boolean REVOKE flag.
.IP sep 4
.IX Item "sep"
.Vb 1
\& $rr\->sep(1);
\&
\& if ( $rr\->sep ) {
\&        ...
\& }
.Ve
.Sp
Boolean Secure Entry Point (SEP) flag.
.SS protocol
.IX Subsection "protocol"
.Vb 2
\&    $protocol = $rr\->protocol;
\&    $rr\->protocol( $protocol );
.Ve
.PP
The 8\-bit protocol number.  This field MUST have value 3.
.SS algorithm
.IX Subsection "algorithm"
.Vb 2
\&    $algorithm = $rr\->algorithm;
\&    $rr\->algorithm( $algorithm );
.Ve
.PP
The 8\-bit algorithm number describes the public key algorithm.
.PP
\&\fBalgorithm()\fR may also be invoked as a class method or simple function
to perform mnemonic and numeric code translation.
.SS publickey
.IX Subsection "publickey"
.SS key
.IX Subsection "key"
.Vb 2
\&    $key = $rr\->key;
\&    $rr\->key( $key );
.Ve
.PP
Base64 representation of the public key material.
.SS keybin
.IX Subsection "keybin"
.Vb 2
\&    $keybin = $rr\->keybin;
\&    $rr\->keybin( $keybin );
.Ve
.PP
Opaque octet string representing the public key material.
.SS privatekeyname
.IX Subsection "privatekeyname"
.Vb 1
\&    $privatekeyname = $rr\->privatekeyname;
.Ve
.PP
Returns the name of the privatekey as it would be generated by
the BIND dnssec-keygen program. The format of that name being:
.PP
.Vb 1
\&        K<fqdn>+<algorithm>+<keyid>.private
.Ve
.SS signame
.IX Subsection "signame"
Returns the canonical signer name of the privatekey.
.SS keylength
.IX Subsection "keylength"
Returns the length (in bits) of the modulus calculated from the key text.
.SS keytag
.IX Subsection "keytag"
.Vb 1
\&    print "keytag = ", $rr\->keytag, "\en";
.Ve
.PP
Returns the 16\-bit numerical key tag of the key. (RFC2535 4.1.6)
.SH COPYRIGHT
.IX Header "COPYRIGHT"
Copyright (c)2003\-2005 RIPE NCC.  Author Olaf M. Kolkman
.PP
All rights reserved.
.PP
Package template (c)2009,2012 O.M.Kolkman and R.W.Franks.
.SH LICENSE
.IX Header "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 original copyright notices appear in all copies and that both
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.
.PP
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.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
perl Net::DNS Net::DNS::RR
RFC4034 <https://tools.ietf.org/html/rfc4034>
.PP
DNSKEY Flags <http://www.iana.org/assignments/dnskey-flags>
.PP
Algorithm Numbers <http://www.iana.org/assignments/dns-sec-alg-numbers>