import from branch_1_1:
[freeradius.git] / man / man5 / rlm_pap.5
1 .TH rlm_pap 5 "8 February 2005" "" "FreeRADIUS Module"
2 .SH NAME
3 rlm_pap \- FreeRADIUS Module
4 .SH DESCRIPTION
5 The \fIrlm_pap\fP module authenticates RADIUS Access-Request packets
6 that contain a User-Password attribute.  The module should also be
7 listed last in the \fIauthorize\fP section, so that it can set the
8 Auth-Type attribute as appropriate.
9 .PP
10 When a RADIUS packet contains a clear-text password in the form of a
11 User-Password attribute, the \fIrlm_pap\fP module may be used for
12 authentication.  The module requires a "known good" password, which it
13 uses to validate the password given in the RADIUS packet.  That "known
14 good" password must be supplied by another module
15 (e.g. \fIrlm_files\fP, \fIrlm_ldap\fP, etc.), and is usually taken
16 from a database.
17 .SH CONFIGURATION
18 .PP
19 The only relevant configuration item is:
20 .IP auto_header
21 If set to "yes", the module will look inside of the User-Password
22 attribute for the headers {crypt}, {clear}, etc., and will
23 automatically create the appropriate attribute, with the correct
24 value.
25 .PP
26 This module understands many kinds of password hashing methods, as
27 given by the following table.
28 .PP
29 .DS
30 .br
31 Header       Attribute          Description
32 .br
33 ------       ---------          -----------
34 .br
35 {clear}      User-Password      clear-text passwords
36 .br
37 {cleartext}  User-Password      clear-text passwords
38 .br
39 {crypt}      Crypt-Password     Unix-style "crypt"ed passwords
40 .br
41 {md5}        MD5-Password       MD5 hashed passwords
42 .br
43 {smd5}       SMD5-Password      MD5 hashed passwords, with a salt
44 .br
45 {sha}        SHA-Password       SHA1 hashed passwords
46 .br
47 {ssha}       SSHA-Password      SHA1 hashed passwords, with a salt
48 .br
49 {nt}         NT-Password        Windows NT hashed passwords
50 .br
51 {x-nthash}   NT-Password        Windows NT hashed passwords
52 .br
53 {lm}         LM-Password        Windows Lan Manager (LM) passwords.
54 .DE
55
56 The module tries to be flexible when handling the various password
57 formats.  It will automatically handle Base-64 encoded data, hex
58 strings, and binary data, and convert them to a format that the server
59 can use.
60 .PP
61 For backwards compatibility, there are old configuration parameters
62 which may be work, although we do not recommend using them.
63 .SH SECTIONS
64 .BR authorize
65 .BR authenticate
66 .PP
67 .SH FILES
68 .I /etc/raddb/radiusd.conf
69 .PP
70 .SH "SEE ALSO"
71 .BR radiusd (8),
72 .BR radiusd.conf (5)
73 .SH AUTHOR
74 Alan DeKok <aland@freeradius.org>
75