|
2
|
1 |
.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.13
|
|
|
2 |
.\"
|
|
|
3 |
.\" Standard preamble:
|
|
|
4 |
.\" ========================================================================
|
|
|
5 |
.de Sh \" Subsection heading
|
|
0
|
6 |
.br
|
|
|
7 |
.if t .Sp
|
|
|
8 |
.ne 5
|
|
|
9 |
.PP
|
|
|
10 |
\fB\\$1\fR
|
|
|
11 |
.PP
|
|
|
12 |
..
|
|
2
|
13 |
.de Sp \" Vertical space (when we can't use .PP)
|
|
0
|
14 |
.if t .sp .5v
|
|
|
15 |
.if n .sp
|
|
|
16 |
..
|
|
2
|
17 |
.de Vb \" Begin verbatim text
|
|
0
|
18 |
.ft CW
|
|
|
19 |
.nf
|
|
|
20 |
.ne \\$1
|
|
|
21 |
..
|
|
2
|
22 |
.de Ve \" End verbatim text
|
|
0
|
23 |
.ft R
|
|
|
24 |
.fi
|
|
|
25 |
..
|
|
2
|
26 |
.\" Set up some character translations and predefined strings. \*(-- will
|
|
|
27 |
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
|
|
|
28 |
.\" double quote, and \*(R" will give a right double quote. | will give a
|
|
|
29 |
.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
|
|
|
30 |
.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
|
|
|
31 |
.\" expand to `' in nroff, nothing in troff, for use with C<>.
|
|
0
|
32 |
.tr \(*W-|\(bv\*(Tr
|
|
2
|
33 |
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
|
|
0
|
34 |
.ie n \{\
|
|
2
|
35 |
. ds -- \(*W-
|
|
|
36 |
. ds PI pi
|
|
|
37 |
. if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
|
|
|
38 |
. if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
|
|
|
39 |
. ds L" ""
|
|
|
40 |
. ds R" ""
|
|
|
41 |
. ds C` ""
|
|
|
42 |
. ds C' ""
|
|
0
|
43 |
'br\}
|
|
|
44 |
.el\{\
|
|
2
|
45 |
. ds -- \|\(em\|
|
|
|
46 |
. ds PI \(*p
|
|
|
47 |
. ds L" ``
|
|
|
48 |
. ds R" ''
|
|
0
|
49 |
'br\}
|
|
2
|
50 |
.\"
|
|
|
51 |
.\" If the F register is turned on, we'll generate index entries on stderr for
|
|
|
52 |
.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
|
|
|
53 |
.\" entries marked with X<> in POD. Of course, you'll have to process the
|
|
|
54 |
.\" output yourself in some meaningful fashion.
|
|
|
55 |
.if \nF \{\
|
|
|
56 |
. de IX
|
|
|
57 |
. tm Index:\\$1\t\\n%\t"\\$2"
|
|
0
|
58 |
..
|
|
2
|
59 |
. nr % 0
|
|
|
60 |
. rr F
|
|
0
|
61 |
.\}
|
|
2
|
62 |
.\"
|
|
|
63 |
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
|
|
|
64 |
.\" way too many mistakes in technical documents.
|
|
|
65 |
.hy 0
|
|
0
|
66 |
.if n .na
|
|
2
|
67 |
.\"
|
|
|
68 |
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
|
|
|
69 |
.\" Fear. Run. Save yourself. No user-serviceable parts.
|
|
|
70 |
. \" fudge factors for nroff and troff
|
|
0
|
71 |
.if n \{\
|
|
2
|
72 |
. ds #H 0
|
|
|
73 |
. ds #V .8m
|
|
|
74 |
. ds #F .3m
|
|
|
75 |
. ds #[ \f1
|
|
|
76 |
. ds #] \fP
|
|
0
|
77 |
.\}
|
|
|
78 |
.if t \{\
|
|
2
|
79 |
. ds #H ((1u-(\\\\n(.fu%2u))*.13m)
|
|
|
80 |
. ds #V .6m
|
|
|
81 |
. ds #F 0
|
|
|
82 |
. ds #[ \&
|
|
|
83 |
. ds #] \&
|
|
0
|
84 |
.\}
|
|
2
|
85 |
. \" simple accents for nroff and troff
|
|
0
|
86 |
.if n \{\
|
|
2
|
87 |
. ds ' \&
|
|
|
88 |
. ds ` \&
|
|
|
89 |
. ds ^ \&
|
|
|
90 |
. ds , \&
|
|
|
91 |
. ds ~ ~
|
|
|
92 |
. ds /
|
|
0
|
93 |
.\}
|
|
|
94 |
.if t \{\
|
|
2
|
95 |
. ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
|
|
|
96 |
. ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
|
|
|
97 |
. ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
|
|
|
98 |
. ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
|
|
|
99 |
. ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
|
|
|
100 |
. ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
|
|
0
|
101 |
.\}
|
|
2
|
102 |
. \" troff and (daisy-wheel) nroff accents
|
|
0
|
103 |
.ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
|
|
|
104 |
.ds 8 \h'\*(#H'\(*b\h'-\*(#H'
|
|
|
105 |
.ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
|
|
|
106 |
.ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
|
|
|
107 |
.ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
|
|
|
108 |
.ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
|
|
|
109 |
.ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
|
|
|
110 |
.ds ae a\h'-(\w'a'u*4/10)'e
|
|
|
111 |
.ds Ae A\h'-(\w'A'u*4/10)'E
|
|
2
|
112 |
. \" corrections for vroff
|
|
0
|
113 |
.if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
|
|
|
114 |
.if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
|
|
2
|
115 |
. \" for low resolution devices (crt and lpr)
|
|
0
|
116 |
.if \n(.H>23 .if \n(.V>19 \
|
|
|
117 |
\{\
|
|
2
|
118 |
. ds : e
|
|
|
119 |
. ds 8 ss
|
|
|
120 |
. ds o a
|
|
|
121 |
. ds d- d\h'-1'\(ga
|
|
|
122 |
. ds D- D\h'-1'\(hy
|
|
|
123 |
. ds th \o'bp'
|
|
|
124 |
. ds Th \o'LP'
|
|
|
125 |
. ds ae ae
|
|
|
126 |
. ds Ae AE
|
|
0
|
127 |
.\}
|
|
|
128 |
.rm #[ #] #H #V #F C
|
|
2
|
129 |
.\" ========================================================================
|
|
|
130 |
.\"
|
|
|
131 |
.IX Title "CHECKVPW 1"
|
|
|
132 |
.TH CHECKVPW 1 "2003-12-01" "vmailmgr 0.97" "VMailMgr Tools Documentation"
|
|
0
|
133 |
.SH "NAME"
|
|
2
|
134 |
checkvpw \- check passwords for virtual and non\-virtual users
|
|
0
|
135 |
.SH "SYNOPSIS"
|
|
2
|
136 |
.IX Header "SYNOPSIS"
|
|
|
137 |
\&\fBcheckvpw\fR \fBsubprogram\fR [\fBarguments...\fR]
|
|
0
|
138 |
.SH "DESCRIPTION"
|
|
2
|
139 |
.IX Header "DESCRIPTION"
|
|
0
|
140 |
This program is a drop-in replacement for the standard checkpassword,
|
|
|
141 |
written by D. J. Bernstein (djb@pobox.com).
|
|
|
142 |
In the absence of virtual hosting (determined by the use of
|
|
2
|
143 |
\&\fI/var/qmail/control/virtualdomainss\fR and \s-1IP\s0 aliases),
|
|
0
|
144 |
it behaves identically to checkpassword.
|
|
|
145 |
When virtual hosting is used, it permits logins from a unique set of
|
|
|
146 |
users for each of the aliases.
|
|
|
147 |
.PP
|
|
2
|
148 |
\&\fIcheckvpw\fR must be run from either the \fItcp-env\fR program
|
|
0
|
149 |
(part of the \fIqmail\fR
|
|
|
150 |
package) or from a suitable substitute, such as \fItcpserver\fR
|
|
|
151 |
(part of the \fIucspi-tcp\fR package).
|
|
|
152 |
These packages are used to determine to
|
|
|
153 |
which address a remote host is connecting.
|
|
2
|
154 |
\&\fIcheckvpw\fR must also be passed the checkpassword-compatible
|
|
0
|
155 |
authentication data on file descriptor three.
|
|
|
156 |
This can be accomplished by running it from a tool such as
|
|
2
|
157 |
\&\fIqmail-popup\fR.
|
|
0
|
158 |
.PP
|
|
2
|
159 |
\&\fIcheckvpw\fR accepts a command line in the following format:
|
|
0
|
160 |
.PP
|
|
|
161 |
.Vb 1
|
|
|
162 |
\& checkvpw [subprogram] [arguments...]
|
|
|
163 |
.Ve
|
|
2
|
164 |
.PP
|
|
0
|
165 |
If the authentication information is valid, the subprogram is run,
|
|
|
166 |
otherwise \fIcheckvpw\fR returns an error to the program that invokes it.
|
|
|
167 |
.PP
|
|
2
|
168 |
If the user name contains the character \f(CW\*(C`@\*(C'\fR, the host name
|
|
0
|
169 |
reported by \fItcp-env\fR is replaced by the string following the
|
|
2
|
170 |
\&\f(CW\*(C`@\*(C'\fR, and the user name is replaced by the string preceding the
|
|
|
171 |
\&\f(CW\*(C`@\*(C'\fR.
|
|
0
|
172 |
If the local host name reported by \fItcp-env\fR matches one of those
|
|
|
173 |
in \fI/var/qmail/control/virtualdomains\fR, \fIcheckvpw\fR prepends the
|
|
2
|
174 |
\&\fIprepend\fR string associated with the host name to the given user
|
|
0
|
175 |
name.
|
|
|
176 |
Wildcards in \fIvirtualdomains\fR are permitted and are handled in the
|
|
2
|
177 |
same way \fIqmail\fR handles them (see qmail-send).
|
|
|
178 |
For example, if the line \f(CW\*(C`.bar.com:bar\*(C'\fR appears in the virtual hosts
|
|
|
179 |
file, it matches \f(CW\*(C`one.two.bar.com\*(C'\fR but not \f(CW\*(C`bar.com\*(C'\fR.
|
|
0
|
180 |
.PP
|
|
|
181 |
If the user name resulting from the above step appears in the system
|
|
|
182 |
password file (typically \fI/etc/passwd\fR), the user is treated as a
|
|
|
183 |
local user and authenticated with the information from that file.
|
|
|
184 |
If this authentication succeeds, the mail directory is set to the
|
|
|
185 |
subdirectory named on the command line.
|
|
|
186 |
If the user name does not appear in the system password file and is of
|
|
2
|
187 |
the form \f(CW\*(C`name\-ext\*(C'\fR where \f(CW\*(C`name\*(C'\fR does appear in the password
|
|
0
|
188 |
file, the user is treated as a \*(L"virtual\*(R" user and authenticated with the
|
|
|
189 |
information from a file named \fIpasswd\fR in the user's home directory.
|
|
|
190 |
If this authentication succeeds, the mail directory is set to the
|
|
|
191 |
subdirectory \fIusers/ext/\fR in the user's home directory, where
|
|
2
|
192 |
\&\f(CW\*(C`ext\*(C'\fR is from the above step.
|
|
0
|
193 |
.PP
|
|
2
|
194 |
\&\fIcheckvpw\fR also does some rewriting on the arguments of the
|
|
0
|
195 |
subprogram.
|
|
2
|
196 |
Any argument matching the string "\f(CW\*(C`maildir\*(C'\fR" (ignoring case) is
|
|
0
|
197 |
replaced with the full path of the mail directory, as determined by the
|
|
|
198 |
steps above.
|
|
|
199 |
.PP
|
|
|
200 |
This program may be invoked in combination with \fIqmail-popup\fR and
|
|
2
|
201 |
\&\fIqmail\-pop3d\fR from inetd by placing the following line in the
|
|
|
202 |
\&\fI/etc/inetd.conf\fR configuration file (all one line):
|
|
0
|
203 |
.PP
|
|
|
204 |
.Vb 1
|
|
|
205 |
\& 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/
|
|
|
206 |
.Ve
|
|
|
207 |
.SH "RETURN VALUE"
|
|
2
|
208 |
.IX Header "RETURN VALUE"
|
|
0
|
209 |
0 if the user is successfully authenticated, nonzero if any error
|
|
|
210 |
occurred. Exit code 1 indicates that a bad password was given, 2
|
|
|
211 |
indicates that the program was used incorrectly, and 111 indicates
|
|
|
212 |
a temporary failure.
|
|
|
213 |
.SH "ENVIRONMENT"
|
|
2
|
214 |
.IX Header "ENVIRONMENT"
|
|
|
215 |
\&\fIcheckvpw\fR requires that \f(CW\*(C`TCPLOCALHOST\*(C'\fR be set to the host name of
|
|
0
|
216 |
the local address of the connection.
|
|
|
217 |
.SH "SEE ALSO"
|
|
2
|
218 |
.IX Header "SEE ALSO"
|
|
|
219 |
\&\fIvdeliver\fR\|(1)
|
|
0
|
220 |
.SH "AUTHOR"
|
|
2
|
221 |
.IX Header "AUTHOR"
|
|
0
|
222 |
Bruce Guenter <\fIbruceg@em.ca\fR>.
|