README
1$Id: README,v 1.5 2006/09/24 15:04:01 andrew Exp $
2
3copyright 2001, 2006 Andrew Stevenson <andrew@ugh.net.au>,
4 All Rights Reserved.
5
6This program implements the Eudora password changing protocol. That is the
7protocol Eudora (and other programs) try to talk when you select "Change
8Password" from their menus. There are client implementations of this protocol
9for various webmail systems also. poppwd should be run from inetd(8).
10
11poppassd can either authenticate against the system password database (using
12getpwnam(3)) and use pw(8) to do the actual password changes or use PAM(3) for
13both functions. This is controlled with the -P command line option.
14
15pw(8) ships with FreeBSD and possibly other UNIXs. If your UNIX flavour does
16not come with pw(8) and does not support login_cap(3) then the patches found
17at http://www.ugh.net.au/~andrew/misc/pw-no_logincap.patch may help you to
18compile pw(8).
19
20If you only intend to use the PAM(3) support then pw(8) is not required.
21
22By default log messages are logged to syslog using the auth facility. This and
23other things such as the path to pw, timeouts, PAM service name etc can be
24configured at compile time in config.h.
25
26Response codes and strings can be changed at compile time by editing the
27messages array in protocol.c. You should only need to do this if you have
28buggy clients which you can't fix.
29
30For further information please read the man page.
31
32There is no standard for this protocol but from the source of poppassd:
33
34/* Steve Dorner's description of the simple protocol:
35 *
36 * The server's responses should be like an FTP server's responses;
37 * 1xx for in progress, 2xx for success, 3xx for more information
38 * needed, 4xx for temporary failure, and 5xx for permanent failure.
39 * Putting it all together, here's a sample conversation:
40 *
41 * S: 200 hello\r\n
42 * E: user yourloginname\r\n
43 * S: 300 please send your password now\r\n
44 * E: pass yourcurrentpassword\r\n
45 * S: 200 My, that was tasty\r\n
46 * E: newpass yournewpassword\r\n
47 * S: 200 Happy to oblige\r\n
48 * E: quit\r\n
49 * S: 200 Bye-bye\r\n
50 * S: <closes connection>
51 * E: <closes connection>
52 */
53
54poppwd also supports the "noop" command to reset the timeout timer without
55affecting any other changes.
56
57There are currently no known bugs but if you discover one please let me know.
58
59Things For Later Versions
60-------------------------
61* Support TLS/SSL. This requires client support so I will only do it if there
62is demand. If you want this please email me (address above).
63* Localise. This also depends on demand (and willing translators).
64