.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14)
.\"
.\" 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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, 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.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "Keyset 3pm"
.TH Keyset 3pm "2010-03-12" "perl v5.12.4" "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"
.Vb 1
\&    Net::DNS::Keyset \- DNSSEC Keyset object class
.Ve
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
use Net::DNS::Keyset;
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
A keyset is a \*(L"administrative\*(R" unit used for \s-1DNSSEC\s0 maintenance.
.PP
The bind dnssec-signzone tool uses it to genertate \s-1DS\s0 records. This class
provides interfaces for reading keysets, creating and parsing them.
.PP
Note that this class is still being developed. Attributes and methods
are subject to change.
.SS "new (from file)"
.IX Subsection "new (from file)"
.Vb 1
\&    $keyset=Net::DNS::Keyset\->new("keyset\-example.tld");
.Ve
.PP
Creator method, will read the specified keyset file and return a 
keyset object. Fails if not all keys in the set are self-signed.
.PP
Sets \f(CW$Net::DNS::Keyset::keyset_err\fR and returns 0 on failure.
.SS "new (by signing keys)"
.IX Subsection "new (by signing keys)"
.Vb 1
\&    $keyset=Net::DNS::Keyset\->new(\e@keyrr,$privatekeypath);
.Ve
.PP
Creates a keyset object from the keys provided through the reference
to an array of Net::DNS::RR::Key objects.
.PP
The method will create selfsign the whole keyset. The private keys as
generated by the \s-1BIND\s0 dnssec-keygen tool are assumed to be in the
current directory or, if specified, in the directory indicat by the
\&\f(CW$privatekeypath\fR.
.PP
Sets \f(CW$Net::DNS::Keyset::keyset_err\fR and returns 0 on failure.
.SS "new (from keys and sig RRsets)"
.IX Subsection "new (from keys and sig RRsets)"
.Vb 1
\&    $keyset=Net::DNS::Keyset\->new(\e@keyrr,\e@sigrr);
.Ve
.PP
Creates a keyset object from the keys provided through the reference
to an array of Net::DNS::RR::DNSKEY and Net::DNS::RR::RRSIG objects.
.PP
Sets \f(CW$Net::DNS::Keyset::keyset_err\fR and returns 0 on failure.
.SS "new (from Packet)"
.IX Subsection "new (from Packet)"
.Vb 2
\&    $res = Net::DNS::Resolver\->new;
\&    $res\->dnssec(1);
\&   
\&    $packet = $res\->query ("example.com", "DNSKEY", "IN");
\&
\&    $keyset=Net::DNS::Keyset\->new($packet)
\&    
\&    die "Corrupted selfsignature " if ! $keyset\->verify;
.Ve
.PP
Creates a keyset object from a Net::DNS::Packet that contains the
answer to a query for the apex key records.
.PP
This is the method you want to use for automatically fetching keys.
.PP
Sets \f(CW$Net::DNS::Keyset::keyset_err\fR and returns 0 on failure.
.SS "keys"
.IX Subsection "keys"
.Vb 1
\&    @keyrr=$keyset\->keys;
.Ve
.PP
Returns an array of Net::DNS::RR::Key objects
.SS "sigs"
.IX Subsection "sigs"
.Vb 1
\&    @keyrr=$keyset\->sigs;
.Ve
.PP
Returns an array of Net::DNS::RR::Sig objects
.SS "verify"
.IX Subsection "verify"
.Vb 1
\&    die $Net::DNS::Keyset::keyset_err if $keyset\->verify;
.Ve
.PP
If no arguments are given:
.PP
.Vb 5
\&    \- Verifies if all signatures present verify the keyset.
\&    \- Verifies if there are DNSKEYs with the SEP flag set there is
\&      at least one RRSIG made using that key
\&    \- Verifies that if there are no DNSKEYS with the SEP flag set there is
\&      at lease one RRSIG made with one of the keys from the keyset.
.Ve
.PP
If an argument is given it is should be the \s-1KEYID\s0 of one of the keys
in the keyset and the method verifies if the the \s-1RRSIG\s0 with that made
with that key verifies.
.PP
The argument returns 0 if verification fails and sets
\&\f(CW$Net::DNS::Keyset::keyset_err\fR.
.PP
If verification succeeds an array is returne with the key-tags of the
keys for which signatures verified.
.SS "print"
.IX Subsection "print"
.Vb 1
\&    $keyset\->print;
.Ve
.PP
Prints the keyset
.SS "string"
.IX Subsection "string"
.Vb 1
\&    $keysetstring=$keyset\->string;
.Ve
.PP
Returns a string representation of the keyset
.PP
.Vb 3
\&    print $keyset\->string;
\&    is similar to
\&    $keyset\->print;
.Ve
.SS "extract_ds"
.IX Subsection "extract_ds"
.Vb 4
\&    @ds=$keyset\->extract_ds;
\&    foreach $ds (@ds) {
\&        $ds\->print;
\&    }
.Ve
.PP
Extracts \s-1DS\s0 records from the keyset. Note that the keyset will be verified
during extraction: All keys will need to have a valid selfsignature.
.SS "writekeyset"
.IX Subsection "writekeyset"
.Vb 1
\&    die $Net::DNS::Keyset::keyset_err if ! $keyset\->writekeyset($prefix, $path);
.Ve
.PP
Writes the keyset to a file named \*(L"keyset\-<domain>.\*(R" in the current
working directory or the directory defined by \f(CW$path\fR. \f(CW$prefix\fR specifies an
optional prefix that will be prepended to the string \*(L"keyset\-<domain>.\*(R"
Returns 0 on failure and sets keyset_err.
.SH "COPYRIGHT"
.IX Header "COPYRIGHT"
Copyright (c) 2002 \s-1RIPE\s0 \s-1NCC\s0.  Author Olaf M. Kolkman
<net\-dns\-sec@ripe.net>
.PP
All Rights Reserved
.PP
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, written prior permission.
.PP
\&\s-1THE\s0 \s-1AUTHOR\s0 \s-1DISCLAIMS\s0 \s-1ALL\s0 \s-1WARRANTIES\s0 \s-1WITH\s0 \s-1REGARD\s0 \s-1TO\s0 \s-1THIS\s0 \s-1SOFTWARE\s0,
\&\s-1INCLUDING\s0 \s-1ALL\s0 \s-1IMPLIED\s0 \s-1WARRANTIES\s0 \s-1OF\s0 \s-1MERCHANTABILITY\s0 \s-1AND\s0 \s-1FITNESS\s0; \s-1IN\s0 \s-1NO\s0
\&\s-1EVENT\s0 \s-1SHALL\s0 \s-1AUTHOR\s0 \s-1BE\s0 \s-1LIABLE\s0 \s-1FOR\s0 \s-1ANY\s0 \s-1SPECIAL\s0, \s-1INDIRECT\s0 \s-1OR\s0
\&\s-1CONSEQUENTIAL\s0 \s-1DAMAGES\s0 \s-1OR\s0 \s-1ANY\s0 \s-1DAMAGES\s0 \s-1WHATSOEVER\s0 \s-1RESULTING\s0 \s-1FROM\s0 \s-1LOSS\s0 \s-1OF\s0
\&\s-1USE\s0, \s-1DATA\s0 \s-1OR\s0 \s-1PROFITS\s0, \s-1WHETHER\s0 \s-1IN\s0 \s-1AN\s0 \s-1ACTION\s0 \s-1OF\s0 \s-1CONTRACT\s0, \s-1NEGLIGENCE\s0 \s-1OR\s0
\&\s-1OTHER\s0 \s-1TORTIOUS\s0 \s-1ACTION\s0, \s-1ARISING\s0 \s-1OUT\s0 \s-1OF\s0 \s-1OR\s0 \s-1IN\s0 \s-1CONNECTION\s0 \s-1WITH\s0 \s-1THE\s0 \s-1USE\s0 \s-1OR\s0
\&\s-1PERFORMANCE\s0 \s-1OF\s0 \s-1THIS\s0 \s-1SOFTWARE\s0.