.\" -*- 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 "GDNSD-PLUGIN-REFLECT 8"
.TH GDNSD-PLUGIN-REFLECT 8 2024-03-15 "gdnsd 3.8.2" gdnsd
.\" 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
gdnsd\-plugin\-reflect \- gdnsd cache reflector plugin
.SH SYNOPSIS
.IX Header "SYNOPSIS"
Zonefile RRs using reflect resolution
.PP
.Vb 5
\&  reflect      10 DYNA reflect
\&  reflect\-dns  10 DYNA reflect!dns
\&  reflect\-edns 10 DYNA reflect!edns
\&  reflect\-both 10 DYNA reflect!both
\&  reflect\-best 10 DYNA reflect!best
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
\&\fBgdnsd-plugin-reflect\fR is a resolution plugin that
acts as a live debugging tool.  It reflects a view
of the client's network address back in the response
in the form of \f(CW\*(C`A\*(C'\fR or \f(CW\*(C`AAAA\*(C'\fR RRs.  It can be
used with both \f(CW\*(C`DYNA\*(C'\fR and \f(CW\*(C`DYNC\*(C'\fR RRs, and will return
address data in both cases.
.PP
The plugin can operate in one of four modes named
\&\f(CW\*(C`dns\*(C'\fR, \f(CW\*(C`edns\*(C'\fR, \f(CW\*(C`both\*(C'\fR, and \f(CW\*(C`best\*(C'\fR, which can
be selected by using the mode name as a resource name
in the zonefile, as shown in the example above.  The
default mode is \f(CW\*(C`best\*(C'\fR.  The modes operate as follows:
.IP dns 4
.IX Item "dns"
In the \f(CW\*(C`dns\*(C'\fR mode, the address in the response is
always the source IP address of the request as seen
by gdnsd.  Note that this is generally the public
address of a central cache/resolver server rather
than the end-user client itself.
.IP edns 4
.IX Item "edns"
In the \f(CW\*(C`edns\*(C'\fR mode, the address in the response is
the address sent by the client in the \f(CW\*(C`edns\-client\-subnet\*(C'\fR
option.  If the client did not send such an option,
the IPv4 address \f(CW0.0.0.0\fR is returned.
.IP both 4
.IX Item "both"
In the \f(CW\*(C`both\*(C'\fR mode, both of the above results
are returned in the same response, but there is no
artificial \f(CW0.0.0.0\fR added if no \f(CW\*(C`edns\-client\-subnet\*(C'\fR
option was available.
.IP best 4
.IX Item "best"
In the \f(CW\*(C`best\*(C'\fR (default) mode, if the \f(CW\*(C`edns\-client\-subnet\*(C'\fR
option was specified its data is returned as in the
\&\f(CW\*(C`edns\*(C'\fR case, otherwise the source IP address is returned
as in the \f(CW\*(C`dns\*(C'\fR case.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fBgdnsd.config\fR\|(5), \fBgdnsd.zonefile\fR\|(5), \fBgdnsd\fR\|(8)
.PP
The gdnsd manual.
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2014 Brandon L Black <blblack@gmail.com>
.PP
This file is part of gdnsd.
.PP
gdnsd is free software: you can redistribute it and/or
modify it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.
.PP
gdnsd is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
GNU General Public License for more details.
.PP
You should have received a copy of the GNU General Public License
along with gdnsd.  If not, see
<http://www.gnu.org/licenses/>.