import from HEAD:
[freeradius.git] / doc / rlm_digest
1         Digest module configuration
2
3 0. INTRODUCTION
4
5   The digest module performs HTTP digest authentication, as per
6   the IETF draft rfc/draft-sterman-aaa-sip-00.txt.  It has been
7   successfully tested against a Cisco SIP server.
8
9   However, the draft has been expired by the IETF, so it's unlikely to
10   become an "official" standard.
11
12 1. USAGE
13
14   To use this module, uncomment the lines relating to 'digest' from
15 raddb/radiusd.conf.  Once that is done, any RADIUS request containing
16 the digest attributes will automatically be authenticated using the
17 'digest' module.
18
19   Note tha the 'digest' module REQUIRES access to the clear-text
20 password for the user, in order to perform digest authentication.
21
22 2. TESTING
23
24   Add the following lines to the top of your 'raddb/users' file:
25
26 #---
27 test    Auth-Type := Digest, User-Password = "test"
28         Reply-Message = "Hello, test with digest"
29 #---
30
31
32   Once the server has been re-started (debugging mode is recommended),
33   use 'radclient' to send the following packet to the server:
34
35   $  radclient -f digest localhost auth testing123
36
37   Where 'digest' is a file containing:
38
39 User-Name = "test", Digest-Response = "631d6d73147add2f9e437f59bbc3aeb7", Digest-Realm = "testrealm", Digest-Nonce = "1234abcd", Digest-Method = "INVITE", Digest-URI = "sip:5555551212@example.com", Digest-Algorithm = "MD5", Digest-User-Name = "test"
40
41   You should see the authentication succeed.
42
43 $Id$