Fix parameter passing issue. closes bug #105
[freeradius.git] / man / man5 / rlm_acct_unique.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_acct_unique 5 "3 February 2004" "" "FreeRADIUS Module"
14 .SH NAME
15 rlm_acct_unique \- FreeRADIUS Module
16 .SH DESCRIPTION
17 The \fIrlm_acct_unique\fP module creates a unique accounting session
18 Id.
19 .PP
20 Many NAS vendors have their equipment supply an Acct-Session-Id
21 attribute which is not unique over reboots.  This makes accounting
22 difficult, as there will be many independent sessions with the same
23 Acct-Session-Id attribute.  This module uses the Acct-Session-Id
24 attribute, along with other attributes in the request, to create a
25 more unique session ID, called Acct-Unique-Session-Id.
26 .PP
27 The main configuration items to be aware of are:
28 .IP key
29 A list of the attributes used in calculating an MD5 hash which is used
30 as the value for the unique session id.
31 .SH CONFIGURATION
32 .DS
33 modules {
34   ...
35 .br
36   acct_unique {
37 .br
38         key = "User-Name, Acct-Session-Id, NAS-IP-Address, NAS-Port"
39 .br
40   }
41 .br
42   ...
43 .br
44 }
45 .br
46  ...
47 .br
48 preacct {
49   ...
50 .br
51   acct_unique
52   ...
53 .br
54 }
55 .DE
56 .PP
57 After generating the MD5 hash, the module adds it to the accounting
58 request packet received from the client.  It will look something like
59 this in your detail file:
60 .PP
61 .DS
62         Acct-Unique-Session-Id = "c66ef57e480b9d26"
63 .DE
64 .PP
65 NOTE:  Any attribute you specify that is not found in the 'dictionary' 
66 file will cause the server to fail and exit with an error.
67 .PP
68 NOTE:  If you want the Acct-Unique-Session-Id of the Start and the
69 Stop packet of a particular session to match, you must use values for
70 the key that will stay the same for the Start and Stop.  The above 
71 example is a good start.  Adding 'Acct-Session-Time', for example, would 
72 cause a mismatch because that value is not the same on the Start and 
73 Stop accounting packets.
74 .PP
75 .SH SECTIONS
76 .BR authorization,
77 .BR pre-accounting,
78 .BR accounting
79 .PP
80 .SH FILES
81 .I /etc/raddb/radiusd.conf
82 .PP
83 .SH "SEE ALSO"
84 .BR radiusd (8),
85 .BR radiusd.conf (5)
86 .SH AUTHORS
87 Chris Parker, cparker@segv.org