.\" Automatically generated by Pod::Man 2.25 (Pod::Simple 3.16)
.\"
.\" 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 "Net::DNS::SEC::Tools::TrustAnchor 3pm"
.TH Net::DNS::SEC::Tools::TrustAnchor 3pm "2012-06-28" "perl v5.14.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::SEC::Tools::TrustAnchor \- base class for TA repositories
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
This is a base class for multiple types of trustanchor repositories
that know how to read, write, and modify trust anchor repositories.
.PP
This package serves as both a \s-1API\s0 wrapper around a set of trust
anchors as well as a base class for packages that need to read/write
trust anchor sets into different formats.
.PP
Trust Anchors may be either \s-1DNSKEY\s0 records or \s-1DS\s0 references.
.PP
\&\s-1XXX:\s0 more documentation needed
.SH "API"
.IX Header "API"
Usage \s-1API\s0 defined by this module or sub-modules.
.PP
Note that:
.PP
.Vb 1
\&  use Net::DNS::SEC::Tools::TrustAnchor;
.Ve
.PP
is assumed to have imported some of the \s-1API\s0 routines mentioned below.
.ie n .IP "$tar = new \fINet::DNS::SEC::Tools::TrustAnchor()\fR;" 4
.el .IP "\f(CW$tar\fR = new \fINet::DNS::SEC::Tools::TrustAnchor()\fR;" 4
.IX Item "$tar = new Net::DNS::SEC::Tools::TrustAnchor();"
Initializes a new collection of trust anchors.
.ie n .IP "$module = load_module(""type"");" 4
.el .IP "\f(CW$module\fR = load_module(``type'');" 4
.IX Item "$module = load_module(type);"
Dynamically attemps to load a TrustAnchor reader/writer sub-class of
Net::DNS::SEC::Tools::TrustAnchor named \*(L"Type\*(R" and return an instance of it.
.Sp
All sub-classes are assumed to contain a single letter upper-case
class name followed by all lower case.  Any modules otherwise named
will fail to load using this routine.
.ie n .IP "$module = parse_component(""type:file"");" 4
.el .IP "\f(CW$module\fR = parse_component(``type:file'');" 4
.IX Item "$module = parse_component(type:file);"
This parses a type and file specification consisting of type separated
by a colon (':') followed by a file-name path.  It will then load the
type module using the \fI\fIload_module()\fI\fR rotine and return the type, the
file and extra options.
.Sp
\&\s-1XXX:\s0 option parsing support not yet complete and will likely change
the type:file format specification; I.E. the type:file formatting
specification will likely change in the future and should be
considered alpha-level support.
.ie n .IP "$tar = $module\->read($location, $options);" 4
.el .IP "\f(CW$tar\fR = \f(CW$module\fR\->read($location, \f(CW$options\fR);" 4
.IX Item "$tar = $module->read($location, $options);"
Reads in a given \s-1TAR\s0 from a \f(CW$location\fR reference and returns a blessed
copy of the Net::DNS::SEC::Tools::TrustAnchor object containing all
the data.
.Sp
This function may be over-ridden by a sub-class.
.ie n .IP "$tar = $module\->read($location, $options);" 4
.el .IP "\f(CW$tar\fR = \f(CW$module\fR\->read($location, \f(CW$options\fR);" 4
.IX Item "$tar = $module->read($location, $options);"
Reads in a given \s-1TAR\s0 from a \f(CW$location\fR reference and returns an
unblessed hash the contents.  The \fIread()\fR function merely wraps around
this and blesses it after being returned.
.Sp
Sub-modules must over-ride this function (and/or the \fIread()\fR function)
if they expect the module to support loading.
.ie n .IP "$tar\->merge(@others)" 4
.el .IP "\f(CW$tar\fR\->merge(@others)" 4
.IX Item "$tar->merge(@others)"
Merges the \fI\f(CI@other\fI\fR array of trust anchors into the \f(CW$tar\fR object's own
trust anchor list.
.SH "AUTHOR"
.IX Header "AUTHOR"
Wes Hardaker <hardaker \s-1ATTA\s0 users.sourceforge \s-1DOTTTY\s0 net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIconvertar\fR\|(1)