NLnet Labs > Net-DNS-SEC > Net::DNS::Keyset

Download:
Net-DNS-SEC-0.21.tar.gz

Dependencies

Annotate this POD

CPAN RT

New  1
Open  0
View/Report Bugs
Module Version: 1271   Source  

NAME ^

Net::DNS::Keyset - DNSSEC Keyset object class

SYNOPSIS ^

    use Net::DNS::Keyset;

DESCRIPTION ^

A keyset is an "administrative" unit used for DNSSEC maintenance.

The bind dnssec-signzone tool uses it to generate DS records. This class provides interfaces for creating, reading and parsing keysets.

Note that this class is still being developed. Attributes and methods are subject to change.

new (from file)

    $keyset = Net::DNS::Keyset->new( $filename );
    $keyset = Net::DNS::Keyset->new( $filename, $directory );

Constructor method which reads the specified keyset file and returns a keyset object.

The optional second argument specifies the filename base directory.

Sets $Net::DNS::Keyset::keyset_err and returns undef on failure.

new (by signing keys)

    $keyset = Net::DNS::Keyset->new( \@keyrr, $privatekeypath );

Creates a keyset object from the keys provided through the reference to an array of Net::DNS::RR::Key objects.

The method will create and self-sign the whole keyset. The private keys as generated by the BIND dnssec-keygen tool are assumed to be in the current directory or, if specified, the directory indicated by $privatekeypath.

Sets $Net::DNS::Keyset::keyset_err and returns undef on failure.

new (from key and sig RRsets)

    $keyset = Net::DNS::Keyset->new( \@keyrr, \@sigrr );

Creates a keyset object from the keys provided through the references to arrays of Net::DNS::RR::DNSKEY and Net::DNS::RR::RRSIG objects.

Sets $Net::DNS::Keyset::keyset_err and returns undef on failure.

new (from Packet)

    $res = Net::DNS::Resolver->new;
    $res->dnssec(1);
   
    $packet = $res->query ( "example.com", "DNSKEY", "IN" );

    $keyset = Net::DNS::Keyset->new( $packet )

Creates a keyset object from a Net::DNS::Packet that contains the answer to a query for the apex key records.

This is the method you should use for automatically fetching keys.

Sets $Net::DNS::Keyset::keyset_err and returns undef on failure.

keys

    @keyrr = $keyset->keys;

Returns an array of Net::DNS::RR::Key objects

sigs

    @keyrr = $keyset->sigs;

Returns an array of Net::DNS::RR::RRSIG objects

extract_ds

    @ds = $keyset->extract_ds;

Extracts DS records from the keyset. Note that the keyset will be verified during extraction: All keys will need to have a valid self-signature.

verify

    die $Net::DNS::Keyset::keyset_err unless $keyset->verify;

If no arguments are given:

    - 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 least one RRSIG made with one of the keys from the keyset.

If an argument is given, it is should be the KEYID of one of the keys in the keyset which will be verified using the corresponding RRSIG.

If verification fails the method sets $Net::DNS::Keyset::keyset_err and returns 0.

If verification succeeds an array is returned with the key-tags of the keys for which signatures verified.

string

    $string = $keyset->string;

Returns a string representation of the keyset.

print

    $keyset->print;             # similar to print( $keyset->string )

Prints the keyset.

writekeyset

    $keyset->writekeyset;
    $keyset->writekeyset( $path );
    $keyset->writekeyset( $prefix );
    $keyset->writekeyset( $prefix, $path );

Writes the keyset to a file named "keyset-<domain>." in the current working directory or directory defined by the optional $path argument.

The optional $prefix argument specifies the prefix that will be prepended to the domain name to form the keyset filename.

COPYRIGHT ^

Copyright (c) 2002 RIPE NCC. Author Olaf M. Kolkman

Portions Copyright (c) 2014 Dick Franks

All Rights Reserved

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 AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS; IN NO EVENT SHALL AUTHOR BE LIABLE FOR ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

syntax highlighting: