.\" Automatically generated by Pod::Man 2.16 (Pod::Simple 3.07)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sh \" Subsection heading
.br
.if t .Sp
.ne 5
.PP
\fB\\$1\fR
.PP
..
.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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
'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 turned on, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.ie \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.el \{\
.    de IX
..
.\}
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear.  Run.  Save yourself.  No user-serviceable parts.
.    \" fudge factors for nroff and troff
.if n \{\
.    ds #H 0
.    ds #V .8m
.    ds #F .3m
.    ds #[ \f1
.    ds #] \fP
.\}
.if t \{\
.    ds #H ((1u-(\\\\n(.fu%2u))*.13m)
.    ds #V .6m
.    ds #F 0
.    ds #[ \&
.    ds #] \&
.\}
.    \" simple accents for nroff and troff
.if n \{\
.    ds ' \&
.    ds ` \&
.    ds ^ \&
.    ds , \&
.    ds ~ ~
.    ds /
.\}
.if t \{\
.    ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
.    ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
.    ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
.    ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
.    ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
.    ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
.\}
.    \" troff and (daisy-wheel) nroff accents
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
.ds ae a\h'-(\w'a'u*4/10)'e
.ds Ae A\h'-(\w'A'u*4/10)'E
.    \" corrections for vroff
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
.    \" for low resolution devices (crt and lpr)
.if \n(.H>23 .if \n(.V>19 \
\{\
.    ds : e
.    ds 8 ss
.    ds o a
.    ds d- d\h'-1'\(ga
.    ds D- D\h'-1'\(hy
.    ds th \o'bp'
.    ds Th \o'LP'
.    ds ae ae
.    ds Ae AE
.\}
.rm #[ #] #H #V #F C
.\" ========================================================================
.\"
.IX Title "DKIMPROXY.IN 1"
.TH DKIMPROXY.IN 1 "2009-07-12" "perl v5.10.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"
dkimproxy.in \- SMTP proxy for verifying DKIM signatures
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 6
\&  dkimproxy.in [options] LISTENADDR:PORT RELAYADDR:PORT
\&    smtp options:
\&      \-\-conf_file=FILENAME
\&      \-\-listen=LISTENADDR:PORT
\&      \-\-relay=RELAYADDR:PORT
\&      \-\-reject\-error
\&
\&    verification options:
\&      \-\-reject\-fail
\&      \-\-hostname=HOSTNAME
\&
\&    daemon options:
\&      \-\-daemonize
\&      \-\-user=USER
\&      \-\-group=GROUP
\&      \-\-pidfile=PIDFILE
\&
\&  dkimproxy.in \-\-help
\&    to see a full description of the various options
.Ve
.SH "OPTIONS"
.IX Header "OPTIONS"
.IP "\fB\-\-daemonize\fR" 4
.IX Item "--daemonize"
If specified, the server will run in the background.
.IP "\fB\-\-group=GROUP\fR" 4
.IX Item "--group=GROUP"
If specified, the daemonized process will \fIsetgid()\fR to the specified
\&\s-1GROUP\s0.
.IP "\fB\-\-hostname=HOSTNAME\fR" 4
.IX Item "--hostname=HOSTNAME"
Overrides the hostname used in the Authentication-Results header.
This header gets added to every verified message.
Use this option if the hostname that appears is not fully qualified
or you want to use an alternate name.
.IP "\fB\-\-pidfile=PIDFILE\fR" 4
.IX Item "--pidfile=PIDFILE"
Creates a \s-1PID\s0 file (a file containing the \s-1PID\s0 of the process) for
the daemonized process. This makes it possible to check the status
of the process, and to cleanly shut it down.
.IP "\fB\-\-reject\-error\fR" 4
.IX Item "--reject-error"
This option specifies what to do if an error occurs during verification
of a message. If this option is specified, the message will be rejected
with an \s-1SMTP\s0 error code. This will result in the \s-1MTA\s0 sending the message
to try again later, or bounce it back to the sender (depending on the
exact error code used). If this option is not specified, the message
will be passed through with an error listed in the Authentication-Results
header instead of the verification results.
.Sp
The most common cause of an error when verifying a message is a
\&\s-1DNS\s0 error when trying to retrieve a public key or sender policy.
.IP "\fB\-\-reject\-fail\fR" 4
.IX Item "--reject-fail"
This option specifies what to do if verification fails and the sender
signing policy says to reject the message. If this option is specified,
the message will be rejected with an \s-1SMTP\s0 error code.
This will result in the sending \s-1MTA\s0 to
bounce the message back to the sender. If this option is not specified,
the message will pass through as normal.
.IP "\fB\-\-user=USER\fR" 4
.IX Item "--user=USER"
If specified, the daemonized process will \fIsetuid()\fR to \s-1USER\s0 after
completing any necessary privileged operations, but before accepting
connections.
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
dkimproxy.in listens on the \s-1IP\s0 address and \s-1TCP\s0 port specified by its
first argument (the \*(L"listen\*(R" port), and sends the traffic it receives
onto the second argument (the \*(L"relay\*(R" port), with messages getting
verified and having an \*(L"Authentication-Results\*(R" header added to them.
.SH "EXAMPLE"
.IX Header "EXAMPLE"
For example, if dkimproxy.in is started with:
.PP
.Vb 1
\&  dkimproxy.in \-\-reject\-fail \-\-reject\-error 127.0.0.1:10025 127.0.0.1:10026
.Ve
.PP
the proxy will listen on port 10025 and send the verified messages to
some other \s-1SMTP\s0 service on port 10026.
.SH "CONFIGURATION FILE"
.IX Header "CONFIGURATION FILE"
Parameters can be stored in a separate file instead of specifying
them all on the command-line. Use the conf_file option to specify
the path to the configuration file, e.g.
.PP
.Vb 1
\&  dkimproxy.in \-\-conf_file=/etc/dkimproxy_in.conf
.Ve
.PP
The format of the configuration file is one option per line:
name of the option, space, then the value of the option. E.g.
.PP
.Vb 5
\&  # this is an example config file
\&  listen      127.0.0.1:10025
\&  relay       127.0.0.1:10026
\&  hostname    myhost.example.com
\&  reject_fail
.Ve
.PP
is equivalent to
.PP
.Vb 2
\&  dkimproxy.out \-\-hostname=myhost.example.com \-\-reject\-fail \e
\&                  127.0.0.1:10025 127.0.0.1:10026
.Ve
.SH "AUTHOR"
.IX Header "AUTHOR"
Jason Long