Added server field to NAS table, and updated docs to match
[freeradius.git] / raddb / sql / oracle / dialup.conf
1 # -*- text -*-
2 ##
3 ## dialup.conf -- Oracle configuration for default schema (schema.sql)
4 ##
5 ##      $Id$
6
7         #######################################################################
8         #  Query config:  Username
9         #######################################################################
10         # This is the username that will get substituted, escaped, and added 
11         # as attribute 'SQL-User-Name'.  '%{SQL-User-Name}' should be used below 
12         # everywhere a username substitution is needed so you you can be sure 
13         # the username passed from the client is escaped properly.  
14         #
15         #  Uncomment the next line, if you want the sql_user_name to mean:
16         #
17         #    Use Stripped-User-Name, if it's there.
18         #    Else use User-Name, if it's there,
19         #    Else use hard-coded string "DEFAULT" as the user name.
20         #sql_user_name = "%{Stripped-User-Name:-%{User-Name:-DEFAULT}}"
21         #
22         sql_user_name = "%{User-Name}"
23
24         #######################################################################
25         #  Default profile
26         #######################################################################
27         # This is the default profile. It is found in SQL by group membership. 
28         # That means that this profile must be a member of at least one group
29         # which will contain the corresponding check and reply items.
30         # This profile will be queried in the authorize section for every user.
31         # The point is to assign all users a default profile without having to
32         # manually add each one to a group that will contain the profile.
33         # The SQL module will also honor the User-Profile attribute. This
34         # attribute can be set anywhere in the authorize section (ie the users
35         # file). It is found exactly as the default profile is found.
36         # If it is set then it will *overwrite* the default profile setting.
37         # The idea is to select profiles based on checks on the incoming packets,
38         # not on user group membership. For example:
39         # -- users file --
40         # DEFAULT       Service-Type == Outbound-User, User-Profile := "outbound"
41         # DEFAULT       Service-Type == Framed-User, User-Profile := "framed"
42         #
43         # By default the default_user_profile is not set
44         #
45         #default_user_profile = "DEFAULT"
46         #
47         # Determines if we will query the default_user_profile or the User-Profile
48         # if the user is not found. If the profile is found then we consider the user
49         # found. By default this is set to 'no'.
50         # 
51         #query_on_not_found = no
52
53
54         #######################################################################
55         #  NAS Query
56         #######################################################################
57         #  This query retrieves the radius clients
58         #
59         #  0. Row ID (currently unused)
60         #  1. Name (or IP address)
61         #  2. Shortname
62         #  3. Type
63         #  4. Secret
64         #  5. Virtual server
65         #######################################################################
66
67         nas_query = "SELECT id, nasname, shortname, type, secret, server FROM ${nas_table}"
68         #######################################################################
69         #  Authorization Queries
70         #######################################################################
71         #  These queries compare the check items for the user
72         #  in ${authcheck_table} and setup the reply items in 
73         #  ${authreply_table}.  You can use any query/tables
74         #  you want, but the return data for each row MUST 
75         #  be in the  following order:
76         #
77         #  0. Row ID (currently unused)
78         #  1. UserName/GroupName
79         #  2. Item Attr Name
80         #  3. Item Attr Value
81         #  4. Item Attr Operation
82         #######################################################################
83         #
84         # WARNING: Oracle is case sensitive
85         #
86         # The main difference between MySQL and Oracle queries is the date format.
87         # You must use the TO_DATE function to transform the radius date format to
88         # the Oracle date format, and put NULL otherwise '0' in a void date field.
89         #
90         #######################################################################
91
92         authorize_check_query = "SELECT id,UserName,Attribute,Value,op FROM ${authcheck_table} WHERE Username = '%{SQL-User-Name}' ORDER BY id"
93         authorize_reply_query = "SELECT id,UserName,Attribute,Value,op FROM ${authreply_table} WHERE Username = '%{SQL-User-Name}' ORDER BY id"
94
95         authorize_group_check_query = "SELECT ${groupcheck_table}.id,${groupcheck_table}.GroupName,${groupcheck_table}.Attribute,${groupcheck_table}.Value,${groupcheck_table}.op  FROM ${groupcheck_table},${usergroup_table} WHERE ${usergroup_table}.Username = '%{SQL-User-Name}' AND ${usergroup_table}.GroupName = ${groupcheck_table}.GroupName ORDER BY ${groupcheck_table}.id"
96         authorize_group_reply_query = "SELECT ${groupreply_table}.id,${groupreply_table}.GroupName,${groupreply_table}.Attribute,${groupreply_table}.Value,${groupreply_table}.op  FROM ${groupreply_table},${usergroup_table} WHERE ${usergroup_table}.Username = '%{SQL-User-Name}' AND ${usergroup_table}.GroupName = ${groupreply_table}.GroupName ORDER BY ${groupreply_table}.id"
97
98         #######################################################################
99         #  Accounting Queries
100         #######################################################################
101         # accounting_onoff_query        - query for Accounting On/Off packets 
102         # accounting_update_query       - query for Accounting update packets 
103         # accounting_update_query_alt   - query for Accounting update packets 
104         #                               (alternate in case first query fails)
105         # accounting_start_query        - query for Accounting start packets 
106         # accounting_start_query_alt    - query for Accounting start packets 
107         #                               (alternate in case first query fails)
108         # accounting_stop_query         - query for Accounting stop packets 
109         # accounting_stop_query_alt     - query for Accounting start packets 
110         #                               (alternate in case first query doesn't
111         #                                affect any existing rows in the table)
112         #######################################################################
113         accounting_onoff_query = "UPDATE ${acct_table1} SET AcctStopTime=TO_DATE('%S','yyyy-mm-dd hh24:mi:ss'), AcctSessionTime=((TO_DATE('%S','yyyy-mm-dd hh24:mi:ss') - AcctStartTime)*86400), AcctTerminateCause='%{Acct-Terminate-Cause}', AcctStopDelay = %{Acct-Delay-Time:-0} WHERE AcctStopTime IS NULL AND NASIPAddress = '%{NAS-IP-Address}' AND AcctStartTime <= TO_DATE('%S','yyyy-mm-dd hh24:mi:ss')"
114
115 accounting_update_query = "UPDATE ${acct_table1} \
116     SET FramedIPAddress = NULLIF('%{Framed-IP-Address}', ''), \
117     AcctSessionTime = '%{Acct-Session-Time}', \
118     AcctInputOctets = '%{Acct-Input-Octets}' + ('%{%{Acct-Input-Gigawords}:-0}' * 4294967296), \
119     AcctOutputOctets = '%{Acct-Output-Octets}' +  ('%{%{Acct-Output-Gigawords}:-0}' * 4294967296) \
120     WHERE \
121     AcctSessionId = '%{Acct-Session-Id}' AND \
122     UserName = '%{SQL-User-Name}' AND \
123     NASIPAddress= '%{NAS-IP-Address}' AND \
124     AcctStopTime IS NULL" 
125
126 accounting_update_query_alt = "INSERT into ${acct_table1} (RadAcctId, AcctSessionId, AcctUniqueId, UserName, Realm, NASIPAddress, NASPortId, NASPortType, AcctStartTime, AcctSessionTime, AcctAuthentic, ConnectInfo_start, AcctInputOctets, AcctOutputOctets, CalledStationId, CallingStationId, ServiceType, FramedProtocol, FramedIPAddress, AcctStartDelay, XAscendSessionSvrKey) \
127     VALUES('', '%{Acct-Session-Id}', '%{Acct-Unique-Session-Id}', \
128     '%{SQL-User-Name}', '%{Realm}', '%{NAS-IP-Address}', '%{NAS-Port-Id}', \
129     '%{NAS-Port-Type}', NULL, '%{Acct-Session-Time}', '%{Acct-Authentic}', '', \
130     '%{Acct-Input-Octets}' + ('%{%{Acct-Input-Gigawords}:-0}' * 4294967296), \
131     '%{Acct-Output-Octets}' +  ('%{%{Acct-Output-Gigawords}:-0}' * 4294967296), \
132     '%{Called-Station-Id}', '%{Calling-Station-Id}', '%{Service-Type}', \
133     '%{Framed-Protocol}', '%{Framed-IP-Address}', '0', '%{X-Ascend-Session-Svr-Key}')"
134
135         accounting_start_query = "INSERT into ${acct_table1} (RadAcctId, AcctSessionId, AcctUniqueId, UserName, Realm, NASIPAddress, NASPortId, NASPortType, AcctStartTime, AcctStopTime, AcctSessionTime, AcctAuthentic, ConnectInfo_start, ConnectInfo_stop, AcctInputOctets, AcctOutputOctets, CalledStationId, CallingStationId, AcctTerminateCause, ServiceType, FramedProtocol, FramedIPAddress, AcctStartDelay, AcctStopDelay, XAscendSessionSvrKey) \
136  VALUES('', '%{Acct-Session-Id}', '%{Acct-Unique-Session-Id}', '%{SQL-User-Name}', '%{Realm}', '%{NAS-IP-Address}', '%{NAS-Port-Id}', '%{NAS-Port-Type}', TO_DATE('%S','yyyy-mm-dd hh24:mi:ss'), NULL, '0', '%{Acct-Authentic}', '%{Connect-Info}', '', '0', '0', '%{Called-Station-Id}', '%{Calling-Station-Id}', '', '%{Service-Type}', '%{Framed-Protocol}', '%{Framed-IP-Address}', '%{Acct-Delay-Time}', '0', '%{X-Ascend-Session-Svr-Key}')"
137
138         accounting_start_query_alt  = "UPDATE ${acct_table1} SET AcctStartTime = TO_DATE('%S','yyyy-mm-dd hh24:mi:ss'), AcctStartDelay = '%{Acct-Delay-Time:-0}', ConnectInfo_start = '%{Connect-Info}' WHERE AcctSessionId = '%{Acct-Session-Id}' AND UserName = '%{SQL-User-Name}' AND NASIPAddress = '%{NAS-IP-Address}' AND AcctStopTime IS NULL"
139
140         accounting_stop_query = "UPDATE ${acct_table2} \
141     SET AcctStopTime = TO_DATE('%S','yyyy-mm-dd hh24:mi:ss'), \
142     AcctSessionTime = '%{Acct-Session-Time}', \
143     AcctInputOctets = '%{Acct-Input-Octets}' + ('%{%{Acct-Input-Gigawords}:-0}' * 4294967296), \
144     AcctOutputOctets = '%{Acct-Output-Octets}' +  ('%{%{Acct-Output-Gigawords}:-0}' * 4294967296), \
145     AcctTerminateCause = '%{Acct-Terminate-Cause}', AcctStopDelay = '%{Acct-Delay-Time:-0}', ConnectInfo_stop = '%{Connect-Info}' WHERE AcctSessionId = '%{Acct-Session-Id}' AND UserName = '%{SQL-User-Name}' AND NASIPAddress = '%{NAS-IP-Address}' AND AcctStopTime IS NULL"
146
147         # Optional Query - pnixon
148         #accounting_stop_query =3D "UPDATE ${acct_table2} SET AcctStopTime = TO_DATE('%S','yyyy-mm-dd hh24:mi:ss'), AcctSessionTime = (substr((sysdate-acctstarttime),instr((sysdate-acctstarttime),' ')+7,2) + substr((sysdate-acctstarttime),instr((sysdate-acctstarttime),' ')+4,2)*60 + substr((sysdate-acctstarttime),instr((sysdate-acctstarttime),' ')+1,2)*3600 + trunc(to_number(substr((sysdate-acctstarttime),1,instr(sysdate-acctstarttime,' '))))*86400), AcctInputOctets = '%{Acct-Input-Octets}', AcctOutputOctets = '%{Acct-Output-Octets}', AcctTerminateCause = '%{Acct-Terminate-Cause}', AcctStopDelay = '%{Acct-Delay-Time}', ConnectInfo_stop = '%{Connect-Info}' WHERE AcctSessionId =3D '%{Acct-Session-Id}' AND UserName = '%{SQL-User-Name}' AND NASIPAddress = '%{NAS-IP-Address}' AND AcctStopTime IS NULL" 
149
150 accounting_stop_query_alt = "INSERT into ${acct_table2} (RadAcctId, AcctSessionId, AcctUniqueId, UserName, Realm, NASIPAddress, NASPortId, NASPortType, AcctStartTime, AcctStopTime, AcctSessionTime, AcctAuthentic, ConnectInfo_start, ConnectInfo_stop, AcctInputOctets, AcctOutputOctets, CalledStationId, CallingStationId, AcctTerminateCause, ServiceType, FramedProtocol, FramedIPAddress, AcctStartDelay, AcctStopDelay) \
151     VALUES('', '%{Acct-Session-Id}', '%{Acct-Unique-Session-Id}', '%{SQL-User-Name}', '%{Realm}', \
152     '%{NAS-IP-Address}', '%{NAS-Port-Id}', '%{NAS-Port-Type}', NULL, TO_DATE('%S','yyyy-mm-dd hh24:mi:ss'), \
153     '%{Acct-Session-Time}', '%{Acct-Authentic}', '', '%{Connect-Info}', \
154     '%{Acct-Input-Octets}' + ('%{%{Acct-Input-Gigawords}:-0}' * 4294967296), \
155     '%{Acct-Output-Octets}' +  ('%{%{Acct-Output-Gigawords}:-0}' * 4294967296), \
156     '%{Called-Station-Id}', '%{Calling-Station-Id}', '%{Acct-Terminate-Cause}', '%{Service-Type}', \
157     '%{Framed-Protocol}', '%{Framed-IP-Address}', '0', '%{Acct-Delay-Time:-0}')"
158
159         #######################################################################
160         # Simultaneous Use Checking Queries
161         #######################################################################
162         # simul_count_query     - query for the number of current connections
163         #                       - If this is not defined, no simultaneouls use checking 
164         #                       - will be performed by this module instance
165         # simul_verify_query    - query to return details of current connections for verification
166         #                       - Leave blank or commented out to disable verification step
167         #                       - Note that the returned field order should not be changed.
168         #######################################################################
169
170         # Uncomment simul_count_query to enable simultaneous use checking
171         # simul_count_query = "SELECT COUNT(*) FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime IS NULL"
172         simul_verify_query = "SELECT RadAcctId, AcctSessionId, UserName, NASIPAddress, NASPortId, FramedIPAddress, CallingStationId, FramedProtocol FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime IS NULL"
173
174         #######################################################################
175         # Group Membership Queries
176         #######################################################################
177         # group_membership_query        - Check user group membership
178         #######################################################################
179
180         group_membership_query = "SELECT GroupName FROM ${usergroup_table} WHERE UserName='%{SQL-User-Name}'"
181