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