.\" -*- 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::Nameserver 3pm" .TH Net::DNS::Nameserver 3pm 2024-02-17 "perl v5.38.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::Nameserver \- DNS server class .SH SYNOPSIS .IX Header "SYNOPSIS" .Vb 1 \& use Net::DNS::Nameserver; \& \& my $nameserver = Net::DNS::Nameserver\->new( \& LocalAddr => [\*(Aq::1\*(Aq, \*(Aq127.0.0.1\*(Aq], \& LocalPort => 15353, \& ZoneFile => \*(Aqfilename\*(Aq \& ); \& \& my $nameserver = Net::DNS::Nameserver\->new( \& LocalAddr => \*(Aq10.1.2.3\*(Aq, \& LocalPort => 15353, \& ReplyHandler => \e&reply_handler \& ); \& \& $nameserver\->start_server($timeout); \& $nameserver\->stop_server; .Ve .SH DESCRIPTION .IX Header "DESCRIPTION" Net::DNS::Nameserver offers a simple mechanism for instantiation of customised DNS server objects intended to provide test responses to queries emanating from a client resolver. .PP It is not, nor will it ever be, a general-purpose DNS nameserver implementation. .PP See "EXAMPLES" below for further details. .SH METHODS .IX Header "METHODS" .SS new .IX Subsection "new" .Vb 5 \& $nameserver = Net::DNS::Nameserver\->new( \& LocalAddr => [\*(Aq::1\*(Aq, \*(Aq127.0.0.1\*(Aq], \& LocalPort => 15353, \& ZoneFile => "filename" \& ); \& \& $nameserver = Net::DNS::Nameserver\->new( \& LocalAddr => \*(Aq10.1.2.3\*(Aq, \& LocalPort => 15353, \& ReplyHandler => \e&reply_handler, \& Verbose => 1, \& Truncate => 0 \& ); .Ve .PP Instantiates a Net::DNS::Nameserver object. An exception is raised if the object could not be created. .PP Each instance is configured using the following optional arguments: .PP .Vb 10 \& LocalAddr IP address on which to listen Defaults to loopback address \& LocalPort Port on which to listen \& ZoneFile Name of file containing RRs \& accessed using the internal \& reply\-handling subroutine \& ReplyHandler Reference to customised \& reply\-handling subroutine \& NotifyHandler Reference to reply\-handling \& subroutine for queries with \& opcode NOTIFY (RFC1996) \& UpdateHandler Reference to reply\-handling \& subroutine for queries with \& opcode UPDATE (RFC2136) \& Verbose Report internal activity Defaults to 0 (off) \& Truncate Truncates UDP packets that \& are too big for the reply Defaults to 1 (on) .Ve .PP The LocalAddr attribute may alternatively be specified as an array of IP addresses to listen to. .PP The ReplyHandler subroutine is passed the query name, query class, query type, peerhost, query record, and connection descriptor. It must either return the response code and references to the answer, authority, and additional sections of the response, or undef to leave the query unanswered. Common response codes are: .PP .Vb 6 \& NOERROR No error \& FORMERR Format error \& SERVFAIL Server failure \& NXDOMAIN Non\-existent domain (name doesn\*(Aqt exist) \& NOTIMP Not implemented \& REFUSED Query refused .Ve .PP For advanced usage it may also contain a headermask containing an hashref with the settings for the \f(CW\*(C`aa\*(C'\fR, \f(CW\*(C`ra\*(C'\fR, and \f(CW\*(C`ad\*(C'\fR header bits. The argument is of the form: {ad => 1, aa => 0, ra => 1} .PP EDNS options may be specified in a similar manner using the optionmask: {$optioncode => \f(CW$value\fR, \f(CW$optionname\fR => \f(CW$value\fR} .PP See RFC1035 and IANA DNS parameters file for more information: .PP The nameserver will listen for both UDP and TCP connections. On linux and other Unix-like systems, unprivileged users are denied access to ports below 1024. .PP UDP reply truncation functionality was introduced in Net::DNS 0.66. The size limit is determined by the EDNS0 size advertised in the query, otherwise 512 is used. If you want to do packet truncation yourself you should set Truncate=>0 and truncate the reply packet in the code of the ReplyHandler. .SS start_server .IX Subsection "start_server" .Vb 1 \& $ns\->start_server( ); .Ve .PP Starts a server process for each of the specified UDP and TCP sockets which continuously responds to user connections. .PP The timeout parameter specifies the time the server is to remain active. If called with no parameter a default timeout of 10 minutes is applied. .SS stop_server .IX Subsection "stop_server" .Vb 1 \& $ns\->stop_server(); .Ve .PP Terminates all server processes in an orderly fashion. .SH EXAMPLES .IX Header "EXAMPLES" .SS "Example 1: Test script with embedded nameserver" .IX Subsection "Example 1: Test script with embedded nameserver" The following example is a self-contained test script which queries DNS zonefile data served by an embedded Net::DNS::Nameserver instance. .PP .Vb 3 \& use strict; \& use warnings; \& use Test::More; \& \& plan skip_all => \*(AqNet::DNS::Nameserver not available\*(Aq \& unless eval { require Net::DNS::Nameserver } \& and Net::DNS::Nameserver\->can(\*(Aqstart_server\*(Aq); \& plan tests => 2; \& \& my $resolver = Net::DNS::Resolver\->new( \& nameserver => [\*(Aq::1\*(Aq, \*(Aq127.0.0.1\*(Aq], \& port => 15353 \& ); \& \& my $ns = Net::DNS::Nameserver\->new( \& LocalAddr => [$resolver\->nameserver], \& LocalPort => $resolver\->port, \& Verbose => 0, \& ZoneFile => \e*DATA \& ) \& || die "couldn\*(Aqt create nameserver object"; \& \& $ns\->start_server(10); \& \& my $reply = $resolver\->send(qw(example.com SOA)); \& is( ref($reply), \*(AqNet::DNS::Packet\*(Aq, \*(Aqreceived reply packet\*(Aq ); \& my ($rr) = $reply\->answer; \& is( $rr\->type, \*(AqSOA\*(Aq, \*(Aqanswer contains SOA record\*(Aq ); \& \& $ns\->stop_server(); \& \& exit; \& \& _\|_DATA_\|_ \& $ORIGIN example.com. \& @ IN SOA mname rname 2023 2h 1h 2w 1h \& www IN A 93.184.216.34 .Ve .SS "Example 2: Free-standing customised DNS nameserver" .IX Subsection "Example 2: Free-standing customised DNS nameserver" The following example will listen on port 15353 and respond to all queries for A records with the IP address 10.1.2.3. All other queries will be answered with NXDOMAIN. Authority and additional sections are left empty. The \f(CW$peerhost\fR variable catches the IP address of the peer host, so that additional filtering on a per-host basis may be applied. .PP .Vb 3 \& use strict; \& use warnings; \& use Net::DNS::Nameserver; \& \& sub reply_handler { \& my ( $qname, $qclass, $qtype, $peerhost, $query, $conn ) = @_; \& my ( $rcode, @ans, @auth, @add ); \& \& print "Received query from $peerhost to " . $conn\->{sockhost} . "\en"; \& $query\->print; \& \& if ( $qtype eq "A" && $qname eq "foo.example.com" ) { \& my ( $ttl, $rdata ) = ( 3600, "10.1.2.3" ); \& my $rr = Net::DNS::RR\->new("$qname $ttl $qclass $qtype $rdata"); \& push @ans, $rr; \& $rcode = "NOERROR"; \& } elsif ( $qname eq "foo.example.com" ) { \& $rcode = "NOERROR"; \& \& } else { \& $rcode = "NXDOMAIN"; \& } \& \& # mark the answer as authoritative (by setting the \*(Aqaa\*(Aq flag) \& my $headermask = {aa => 1}; \& \& # specify EDNS options { option => value } \& my $optionmask = {}; \& \& return ( $rcode, \e@ans, \e@auth, \e@add, $headermask, $optionmask ); \& } \& \& my $ns = Net::DNS::Nameserver\->new( \& LocalPort => 15353, \& ReplyHandler => \e&reply_handler, \& Verbose => 1 \& ) or die "couldn\*(Aqt create nameserver object"; \& \& $ns\->start_server(60); \& \& exit; # leaving nameserver processes running .Ve .SH BUGS .IX Header "BUGS" Limitations in perl make it impossible to guarantee that replies to UDP queries from Net::DNS::Nameserver are sent from the IP-address to which the query was directed, the source address being chosen by the operating system based upon its notion of "closest address". This limitation is mitigated by creating a separate set of sockets and server subprocesses bound to each IP address. .SH COPYRIGHT .IX Header "COPYRIGHT" Copyright (c)2000 Michael Fuhr. .PP Portions Copyright (c)2002\-2004 Chris Reinhardt. .PP Portions Copyright (c)2005 Robert Martin-Legene. .PP Portions Copyright (c)2005\-2009 O.M.Kolkman, RIPE NCC. .PP Portions Copyright (c)2017\-2024 R.W.Franks. .PP All rights reserved. .SH LICENSE .IX Header "LICENSE" Permission to use, copy, modify, and distribute this software and its documentation for any purpose and without fee is hereby granted, provided that the original copyright notices appear in all copies and that both 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. .PP THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. .SH "SEE ALSO" .IX Header "SEE ALSO" perl Net::DNS Net::DNS::Resolver Net::DNS::Packet Net::DNS::Update Net::DNS::Header Net::DNS::Question Net::DNS::RR .PP RFC1035 .PP IANA DNS parameters