README
1Net::DNS::SEC - DNSSEC extensions to Net::DNS
2=============================================
3
4
51. DESCRIPTION
6 -----------
7
8This module is designed as an extension the Net::DNS package
9(https://metacpan.org/release/Net-DNS).
10
11The module implements the cryptographic signature generation and
12verification functions that are relevant for DNSSEC operations.
13
14**
15** ***************
16** ** WARNING **
17** ***************
18** THE USE AND/OR HANDLING OF STRONG ENCRYPTION TECHNOLOGIES IS
19** PROHIBITED OR SEVERELY RESTRICTED IN MANY TERRITORIES.
20** PLEASE BE SURE THAT YOU FULLY UNDERSTAND THE LEGAL POSITION
21** IN YOUR COUNTRY BEFORE ATTEMPTING TO INSTALL THIS MODULE OR
22** ANY OF THE PREREQUISITE CRYPTOGRAPHY PACKAGES.
23**
24
25Net::DNS::SEC also provides a class for handling keysets.
26Keysets are administrative files used by the BIND tools for key
27maintenance tasks. Net::DNS::SEC::Keyset provides an abstract
28interface for doing fun things with them.
29
30See also the 'pod' documentation in:
31 Net::DNS::RR::DNSKEY
32 Net::DNS::RR::DS
33 Net::DNS::RR::RRSIG
34 Net::DNS::SEC::Private
35and for the use of SIG0 see:
36 Net::DNS::Packet (sign_sig0)
37 Net::DNS::RR::SIG
38
39
402. AVAILABILITY
41 ------------
42
43You can get the latest version of Net::DNS::SEC from the
44Comprehensive Perl Archive Network (CPAN):
45
46 https://metacpan.org/release/Net-DNS-SEC
47
48or through
49
50 http://www.net-dns.org/
51
52Additionally a subversion repository is made available through
53
54 http://www.net-dns.org/svn/net-dns-sec/
55
56The version on the "trunk" (http://www.net-dns.org/svn/net-dns-sec/trunk)
57is the version that is targeted for next release.
58
59Please note that the SVN version at any given moment may be broken.
60
61
623. PREREQUISITES
63 -------------
64
65This package relies on Net-DNS version 1.01 or later which has
66features specifically designed to support Net::DNS::SEC.
67
68The availability of prerequisites for Net::DNS::SEC is tested at
69installation time. These are the packages that need to be
70available:
71
72 File::Find
73 File::Spec
74 MIME::Base64
75 Test::More
76
77The cryptographic heavy lifting is performed using the OpenSSL
78libcrypto library distributed under separate license.
79
80You will also require a C compiler.
81
82
834. INSTALLATION
84 ------------
85
86Please install any modules mentioned in the PREREQUISITES section
87above. When you run "perl Makefile.PL", Perl should complain if
88any of the required modules is missing.
89
90To build this module, run the following commands:
91
92 tar xvzf Net-DNS-SEC-1.??.tar.gz
93 cd Net-DNS-SEC-1.??
94 perl Makefile.PL
95 make
96 make test
97 make install
98
99'make test' will do some tests that should all succeed once all
100dependencies are satisfied. Please report any failure during the
101test phase.
102
103Alternatively, install the package using CPAN:
104
105 perl -MCPAN -e shell;
106 cpan> install Net::DNS::SEC
107
108To build the libcrypto library, run the following:
109
110 tar xvzf openssl-3.*.tar.gz
111 cd openssl-3.*
112 ./config shared
113 make # require only libcrypto.so* and include/openssl/*.h
114
115
1165. MAINTENANCE
117 -----------
118
119Please use the CPAN request tracker to report bugs in the
120extensions. The request tracker is available through:
121
122 https://rt.cpan.org/NoAuth/ReportBug.html?Queue=Net-DNS-SEC
123
124
1256. STAYING UP TO DATE
126 ------------------
127
128Announcements about Net::DNS::SEC will be published on
129http://www.net-dns.org/blog/. An RSS feed is available.
130
131
1327. DEMOS
133 -----
134
135demo/getkeyset.pl A small demonstration program that will
136 fetch the keyset for a specified domain,
137 store the keys and print DS RRs to STDOUT.
138
139demo/key2ds Reads the key data from STDIN and prints
140 the corresponding DS record on STDOUT.
141 Contributed by Miek Gieben
142
143demo/make-signed-keyset Creates a self-signed keyset from a BIND
144 public key specified on the command line.
145 Contributed by Wes Griffin
146
147
1488. ACKNOWLEDGEMENTS
149 ----------------
150
151Thanks are due to Eric Young and the many developers and contributors
152to the OpenSSL project and cryptographic library.
153
154
1559. COPYRIGHT
156 ---------
157
158Authorship of individual components and significant contributions is shown
159in the copyright notice attached to the relevant documentation. Copyright
160in all components is retained by their respective authors.
161
162
16310. LICENSE
164 -------
165
166Permission to use, copy, modify, and distribute this software and its
167documentation for any purpose and without fee is hereby granted, provided
168that the original copyright notices appear in all copies and that both
169copyright notice and this permission notice appear in supporting
170documentation, and that the name of the author not be used in advertising
171or publicity pertaining to distribution of the software without specific
172prior written permission.
173
174THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
175IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
176FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL
177THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
178LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
179FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
180DEALINGS IN THE SOFTWARE.
181
182
183------------------------------------------------------------------------------
184$Id: README 1849 2021-08-19 08:25:20Z willem $
185