~ubuntu-branches/ubuntu/hardy/freeradius/hardy-proposed

« back to all changes in this revision

Viewing changes to man/man5/rlm_mschap.5

  • Committer: Bazaar Package Importer
  • Author(s): Mark Hymers
  • Date: 2006-12-16 20:45:11 UTC
  • mfrom: (3.1.10 feisty)
  • Revision ID: james.westby@ubuntu.com-20061216204511-3pbbsu4s8jtehsor
Tags: 1.1.3-3
Fix POSIX compliance problem in init script.  Closes: #403384. 

Show diffs side-by-side

added added

removed removed

Lines of Context:
1
 
.TH rlm_mschap 5 "13 March 2004" "" "FreeRADIUS Module"
 
1
.TH rlm_mschap 5 "19 May 2006" "" "FreeRADIUS Module"
2
2
.SH NAME
3
3
rlm_mschap \- FreeRADIUS Module
4
4
.SH DESCRIPTION
5
5
The \fIrlm_mschap\fP module provides MS-CHAP and MS-CHAPv2
6
6
authentication support. 
7
7
.PP
8
 
This module validates a user with MS-CHAP or MS-CHAPv2 
9
 
authentication.
10
 
If called in Authorize, it will look for MS-CHAP Challenge/Response
11
 
attributes in the Acess-Request and adds an Auth-Type
12
 
attribute set to MS-CHAP in the Config-Items list unless 
13
 
Auth-Type has already set.
 
8
This module validates a user with MS-CHAP or MS-CHAPv2 authentication.
 
9
It should be listed in both the \fIauthorize\fP and \fIauthenticate\fP
 
10
sections.  In \fIauthorize\fP, it will look for MS-CHAP
 
11
Challenge/Response attributes in the Acess-Request, and configure
 
12
itself to be the module called for the \fIauthenticate\fP section.
14
13
.PP
15
14
The module can authenticate the MS-CHAP session via plain-text
16
15
passwords (User-Password attribute), or NT passwords (NT-Password
17
 
attribute).  The module cannot perform authentication against an NT
18
 
domain.
19
 
.PP
 
16
attribute).  The module can perform authentication against an NT
 
17
domain by using the \fIntlm_auth\fP program.
 
18
.SH SMB Integration
20
19
The module also enforces the SMB-Account-Ctrl attribute.  See the
21
20
Samba documentation for the meaning of SMB account control.  The
22
 
module does not read Samba password files.  Instead, the fIrlm_passwd\fP
23
 
module can be used to read a Samba password file, and supply an
24
 
NT-Password attribute which this module can use.
25
 
.PP
 
21
module does not read Samba password files.  Instead, the
 
22
\fIrlm_passwd\fP module should be used to read a Samba password file,
 
23
and to supply an NT-Password attribute which this module can use.  See
 
24
the \fIetc_smbpasswd\fP module in \fIradiusd.conf\fP for more details.
 
25
.SH MODULE CONFIGURATION
26
26
The main configuration items to be aware of are:
27
 
.IP authtype
28
 
This is the string used to set the authtype.  Normally it should be
29
 
left to the default value of MS-CHAP.
30
27
.IP use_mppe
31
28
Unless this is set to 'no', FreeRADIUS will add MS-CHAP-MPPE-Keys for
32
29
MS-CHAPv1 and MS-MPPE-Recv-Key/MS-MPPE-Send-Key for MS-CHAPv2.  The
43
40
Windows clients send User-Name in the form of "DOMAIN\\User", but send the
44
41
challenge/response based only on the User portion.  Setting this value
45
42
to yes, enables a work-around for this error.  The default is 'no'.
46
 
.PP
47
 
.SH CONFIGURATION
48
 
.DS
49
 
modules {
50
 
  ...
51
 
.br
52
 
  mschap {
53
 
.br
54
 
        authtype = MS-CHAP
55
 
.br
56
 
        use_mppe = yes  
57
 
.br
58
 
  }
59
 
.br
60
 
  ...
61
 
.br
62
 
}
63
 
.br
64
 
 ...
65
 
.br
66
 
authorize {
67
 
  ...
68
 
.br
69
 
  mschap
70
 
.br
71
 
  ...
72
 
.br
73
 
}
74
 
 ...
75
 
.br
76
 
authenticate {
77
 
  ...
78
 
.br
79
 
  mschap
80
 
.br
81
 
  ...
82
 
.br
83
 
}
84
 
.DE
 
43
.IP ntlm_auth
 
44
Use the \fIntlm_auth\fP program for authentication against Samba, or a
 
45
Windows NT or Active Directory Domain Controller.  For machine
 
46
authentication, the following configuration should be used:
 
47
.DS
 
48
ntlm_auth = "/path/to/ntlm_auth --username=%{mschap:User-Name:-None} --challenge=%{mschap:Challenge:-00} --nt-response=%{mschap:NT-Response:-00} --domain=%{mschap:NT-Domain:-YOUR_DEFAULT_DOMAIN}
 
49
.DE
 
50
If configured, \fIntlm_auth\fP will always be called, even if there is
 
51
a clear-text or NT-Password available for the user.  You can force
 
52
\fIntlm_auth\fP to not be used by setting
 
53
.DS
 
54
MS-CHAP-Use-NTLM-Auth := No
 
55
.DE
 
56
in the \fIusers\fP file, or in a database such as SQL.
85
57
.PP
86
58
.SH SECTIONS
87
59
.BR authorization,