Made it 2.0.0, and removed the changes that are in 1.1.x, as
[freeradius.git] / man / man5 / rlm_digest.5
1 .TH rlm_digest 5 "31 March 2005" "" "FreeRADIUS Module"
2 .SH NAME
3 rlm_digest \- FreeRADIUS Module
4 .SH DESCRIPTION
5 The \fIrlm_digest\fP module authenticates RADIUS Access-Request
6 packets that contain Cisco SIP digest authentication attributes.  The
7 module should be listed in the \fIauthorize\fP and \fIauthenticate\fP
8 sections of \fIradiusd.conf\fP.
9 .SH CONFIGURATION
10 The digest module requires no additional configuration items.  When it
11 is being used to authenticate requests, however, it does require
12 access to the clear-text password for the user.  Hashed passwords are
13 not acceptable, and will not work.
14 .SH EXAMPLES
15 Add the following lines to the top of your 'raddb/users' file:
16 .PP
17 .DS
18 #---
19 .br
20 test    Auth-Type := Digest, User-Password = "test"
21 .br
22         Reply-Message = "Hello, test with digest"
23 .br
24 #---
25 .DE
26
27 Once the server has been started (debugging mode is recommended),
28 use '\fIradclient\fP to send the following packet to the server:
29 .PP
30 .DS
31 $  radclient -f digest localhost auth testing123
32 .DE
33
34 Where 'digest' is a file containing:
35 .PP
36 .DS
37   User-Name = "test",
38 .br
39   Digest-Response = "631d6d73147add2f9e437f59bbc3aeb7",
40 .br
41   Digest-Realm = "testrealm",
42 .br
43   Digest-Nonce = "1234abcd",
44 .br
45   Digest-Method = "INVITE",
46 .br
47   Digest-URI = "sip:5555551212@example.com",
48 .br
49   Digest-Algorithm = "MD5",
50 .br
51   Digest-User-Name = "test",
52 .br
53   Message-Authenticator = ""
54 .DE
55
56 You should see the authentication succeed.
57
58 .SH SECTIONS
59 .BR authorize,
60 .BR authenticate
61 .PP
62 .SH FILES
63 .I /etc/raddb/radiusd.conf,
64 .I draft-sterman-aaa-sip-00.txt
65 .PP
66 .SH AUTHOR
67 Alan DeKok <aland@ox.org>