.\" -*- 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::SEC::Tools::TrustAnchor 3"
.TH Net::DNS::SEC::Tools::TrustAnchor 3 2023-07-29 "perl v5.38.0" "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
.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 API 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 DNSKEY records or DS references.
.PP
XXX: more documentation needed
.SH API
.IX Header "API"
Usage API 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 API routines mentioned below.
.Sp
.RS 4
\&\f(CW$tar\fR = new \fBNet::DNS::SEC::Tools::TrustAnchor()\fR;
.Sp
Initializes a new collection of trust anchors.
.Sp
\&\f(CW$module\fR = load_module("type");
.Sp
Dynamically attemps to load a TrustAnchor reader/writer sub-class of
Net::DNS::SEC::Tools::TrustAnchor named "Type" 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.
.Sp
\&\f(CW$module\fR = parse_component("type:file");
.Sp
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 \fR\f(BIload_module()\fR\fI\fR rotine and return the type, the
file and extra options.
.Sp
XXX: 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.
.Sp
\&\f(CW$tar\fR = \f(CW$module\fR\->read($location, \f(CW$options\fR);
.Sp
Reads in a given TAR 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.
.Sp
\&\f(CW$tar\fR = \f(CW$module\fR\->read($location, \f(CW$options\fR);
.Sp
Reads in a given TAR from a \f(CW$location\fR reference and returns an
unblessed hash the contents.  The \fBread()\fR function merely wraps around
this and blesses it after being returned.
.Sp
Sub-modules must over-ride this function (and/or the \fBread()\fR function)
if they expect the module to support loading.
.Sp
\&\f(CW$tar\fR\->merge(@others)
.Sp
Merges the \fR\f(CI@other\fR\fI\fR array of trust anchors into the \f(CW$tar\fR object's own
trust anchor list.
.RE
.SH AUTHOR
.IX Header "AUTHOR"
Wes Hardaker <hardaker ATTA users.sourceforge DOTTTY net>
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBconvertar\fR\|(1)
.SH "POD ERRORS"
.IX Header "POD ERRORS"
Hey! \fBThe above document had some coding errors, which are explained below:\fR
.IP "Around line 32:" 4
.IX Item "Around line 32:"
You can't have =items (as at line 45) unless the first thing after the =over is an =item