.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13
.\"
.\" 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.  | will give a
.\" real vertical bar.  \*(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-|\(bv\*(Tr
.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\}
.\"
.\" 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.
.if \nF \{\
.    de IX
.    tm Index:\\$1\t\\n%\t"\\$2"
..
.    nr % 0
.    rr F
.\}
.\"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.hy 0
.if n .na
.\"
.\" 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 "CHECKVPW 1"
.TH CHECKVPW 1 "2003-12-01" "vmailmgr 0.97" "VMailMgr Tools Documentation"
.SH "NAME"
checkvpw \- check passwords for virtual and non\-virtual users
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
\&\fBcheckvpw\fR \fBsubprogram\fR [\fBarguments...\fR]
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This program is a drop-in replacement for the standard checkpassword,
written by D. J. Bernstein (djb@pobox.com).
In the absence of virtual hosting (determined by the use of
\&\fI/var/qmail/control/virtualdomainss\fR and \s-1IP\s0 aliases),
it behaves identically to checkpassword.
When virtual hosting is used, it permits logins from a unique set of
users for each of the aliases.
.PP
\&\fIcheckvpw\fR must be run from either the \fItcp-env\fR program
(part of the \fIqmail\fR
package) or from a suitable substitute, such as \fItcpserver\fR
(part of the \fIucspi-tcp\fR package).
These packages are used to determine to
which address a remote host is connecting.
\&\fIcheckvpw\fR must also be passed the checkpassword-compatible
authentication data on file descriptor three.
This can be accomplished by running it from a tool such as
\&\fIqmail-popup\fR.
.PP
\&\fIcheckvpw\fR accepts a command line in the following format:
.PP
.Vb 1
\&        checkvpw [subprogram] [arguments...]
.Ve
.PP
If the authentication information is valid, the subprogram is run,
otherwise \fIcheckvpw\fR returns an error to the program that invokes it.
.PP
If the user name contains the character \f(CW\*(C`@\*(C'\fR, the host name
reported by \fItcp-env\fR is replaced by the string following the
\&\f(CW\*(C`@\*(C'\fR, and the user name is replaced by the string preceding the
\&\f(CW\*(C`@\*(C'\fR.
If the local host name reported by \fItcp-env\fR matches one of those
in \fI/var/qmail/control/virtualdomains\fR, \fIcheckvpw\fR prepends the
\&\fIprepend\fR string associated with the host name to the given user
name.
Wildcards in \fIvirtualdomains\fR are permitted and are handled in the
same way \fIqmail\fR handles them (see qmail-send).
For example, if the line \f(CW\*(C`.bar.com:bar\*(C'\fR appears in the virtual hosts
file, it matches \f(CW\*(C`one.two.bar.com\*(C'\fR but not \f(CW\*(C`bar.com\*(C'\fR.
.PP
If the user name resulting from the above step appears in the system
password file (typically \fI/etc/passwd\fR), the user is treated as a
local user and authenticated with the information from that file.
If this authentication succeeds, the mail directory is set to the
subdirectory named on the command line.
If the user name does not appear in the system password file and is of
the form \f(CW\*(C`name\-ext\*(C'\fR where \f(CW\*(C`name\*(C'\fR does appear in the password
file, the user is treated as a \*(L"virtual\*(R" user and authenticated with the
information from a file named \fIpasswd\fR in the user's home directory.
If this authentication succeeds, the mail directory is set to the
subdirectory \fIusers/ext/\fR in the user's home directory, where
\&\f(CW\*(C`ext\*(C'\fR is from the above step.
.PP
\&\fIcheckvpw\fR also does some rewriting on the arguments of the
subprogram.
Any argument matching the string "\f(CW\*(C`maildir\*(C'\fR" (ignoring case) is
replaced with the full path of the mail directory, as determined by the
steps above.
.PP
This program may be invoked in combination with \fIqmail-popup\fR and
\&\fIqmail\-pop3d\fR from inetd by placing the following line in the
\&\fI/etc/inetd.conf\fR configuration file (all one line):
.PP
.Vb 1
\&        pop-3 stream tcp nowait root /var/qmail/bin/tcp-env tcp-env -R /var/qmail/bin/qmail-popup <hostname> /usr/bin/checkvpw /var/qmail/bin/qmail-pop3d Maildir/
.Ve
.SH "RETURN VALUE"
.IX Header "RETURN VALUE"
0 if the user is successfully authenticated, nonzero if any error
occurred.  Exit code 1 indicates that a bad password was given, 2
indicates that the program was used incorrectly, and 111 indicates
a temporary failure.
.SH "ENVIRONMENT"
.IX Header "ENVIRONMENT"
\&\fIcheckvpw\fR requires that \f(CW\*(C`TCPLOCALHOST\*(C'\fR be set to the host name of
the local address of the connection.
.SH "SEE ALSO"
.IX Header "SEE ALSO"
\&\fIvdeliver\fR\|(1)
.SH "AUTHOR"
.IX Header "AUTHOR"
Bruce Guenter <\fIbruceg@em.ca\fR>.