debian/rules: Use `git' potty wrapper.
[qmail] / qmail-popup.8
CommitLineData
2117e02e
MW
1.TH qmail-popup 8
2.SH NAME
3qmail-popup \- read a POP username and password
4.SH SYNOPSIS
5.B qmail-popup
6.I hostname
7.I subprogram
8.SH DESCRIPTION
9.B qmail-popup
10reads a POP username and password from the network.
11It then runs
12.IR subprogram .
13
14.B qmail-popup
15is most commonly invoked from
16.B inetd
17as
18
19.EX
20 qmail-popup CHANGEME checkpassword qmail-pop3d Maildir
21.EE
22
23with
24CHANGEME
25replaced by the fully qualified domain name of the local host.
26
27.B qmail-popup
28expects descriptor 0 to read from the network
29and descriptor 1 to write to the network.
30It reads a username and password from descriptor 0
31in POP's USER-PASS style or APOP style.
32It invokes
33.IR subprogram ,
34with the same descriptors 0 and 1;
35descriptor 2 writing to the network;
36and descriptor 3 reading the username, a 0 byte, the password,
37another 0 byte,
38an APOP timestamp derived from
39.IR hostname ,
40and a final 0 byte.
41.B qmail-popup
42then waits for
43.I subprogram
44to finish.
45It prints an error message if
46.I subprogram
47crashes or exits nonzero.
48
49.B qmail-popup
50should be used only within
51a secure network.
52Otherwise an eavesdropper can steal passwords.
53Even if you use APOP,
54an active attacker can still take over the connection
55and wreak havoc.
56
57.B qmail-popup
58has a 20-minute idle timeout.
59
60.B qmail-popup
61is based on a program contributed by Russ Nelson.
62.SH "SEE ALSO"
63maildir(5),
64qmail-local(8),
65qmail-pop3d(8)