2 # Configuration for the SQL module, when using MySQL.
4 # The database schema is available at:
6 # src/radiusd/src/modules/rlm_sql/drivers/rlm_sql_mysql/db_mysql.sql
8 # If you are using PostgreSQL, please use 'postgresql.conf', instead.
9 # If you are using Oracle, please use 'oracle.conf', instead.
10 # If you are using MS-SQL, please use 'mssql.conf', instead.
17 # Current supported are: rlm_sql_mysql, rlm_sql_postgresql,
18 # rlm_sql_iodbc, rlm_sql_oracle, rlm_sql_unixodbc, rlm_sql_freetds
19 driver = "rlm_sql_mysql"
26 # Database table configuration
29 # If you want both stop and start records logged to the
30 # same SQL table, leave this as is. If you want them in
31 # different tables, put the start table in acct_table1
32 # and stop table in acct_table2
33 acct_table1 = "radacct"
34 acct_table2 = "radacct"
36 # Allow for storing data after authentication
37 postauth_table = "radpostauth"
39 authcheck_table = "radcheck"
40 authreply_table = "radreply"
42 groupcheck_table = "radgroupcheck"
43 groupreply_table = "radgroupreply"
45 usergroup_table = "usergroup"
47 # Remove stale session if checkrad does not see a double login
48 deletestalesessions = yes
50 # Print all SQL statements when in debug mode (-x)
52 sqltracefile = ${logdir}/sqltrace.sql
54 # number of sql connections to make to server
57 # number of seconds to dely retrying on a failed database
58 # connection (per_socket)
59 connect_failure_retry_delay = 60
61 #######################################################################
62 # Query config: Username
63 #######################################################################
64 # This is the username that will get substituted, escaped, and added
65 # as attribute 'SQL-User-Name'. '%{SQL-User-Name}' should be used below
66 # everywhere a username substitution is needed so you you can be sure
67 # the username passed from the client is escaped properly.
69 # Uncomment the next line, if you want the sql_user_name to mean:
71 # Use Stripped-User-Name, if it's there.
72 # Else use User-Name, if it's there,
73 # Else use hard-coded string "DEFAULT" as the user name.
74 #sql_user_name = "%{Stripped-User-Name:-%{User-Name:-DEFAULT}}"
76 sql_user_name = "%{User-Name}"
78 #######################################################################
80 #######################################################################
81 # This is the default profile. It is found in SQL by group membership.
82 # That means that this profile must be a member of at least one group
83 # which will contain the corresponding check and reply items.
84 # This profile will be queried in the authorize section for every user.
85 # The point is to assign all users a default profile without having to
86 # manually add each one to a group that will contain the profile.
87 # The SQL module will also honor the User-Profile attribute. This
88 # attribute can be set anywhere in the authorize section (ie the users
89 # file). It is found exactly as the default profile is found.
90 # If it is set then it will *overwrite* the default profile setting.
91 # The idea is to select profiles based on checks on the incoming packets,
92 # not on user group membership. For example:
94 # DEFAULT Service-Type == Outbound-User, User-Profile := "outbound"
95 # DEFAULT Service-Type == Framed-User, User-Profile := "framed"
97 # By default the default_user_profile is not set
99 #default_user_profile = "DEFAULT"
101 # Determines if we will query the default_user_profile or the User-Profile
102 # if the user is not found. If the profile is found then we consider the user
103 # found. By default this is set to 'no'.
105 #query_on_not_found = no
108 #######################################################################
109 # Authorization Queries
110 #######################################################################
111 # These queries compare the check items for the user
112 # in ${authcheck_table} and setup the reply items in
113 # ${authreply_table}. You can use any query/tables
114 # you want, but the return data for each row MUST
115 # be in the following order:
117 # 0. Row ID (currently unused)
118 # 1. UserName/GroupName
121 # 4. Item Attr Operation
122 #######################################################################
123 # Use these for case sensitive usernames. WARNING: Slower queries!
124 # authorize_check_query = "SELECT id,UserName,Attribute,Value,op FROM ${authcheck_table} WHERE STRCMP(Username, '%{SQL-User-Name}') = 0 ORDER BY id"
125 # authorize_reply_query = "SELECT id,UserName,Attribute,Value,op FROM ${authreply_table} WHERE STRCMP(Username, '%{SQL-User-Name}') = 0 ORDER BY id"
127 authorize_check_query = "SELECT id,UserName,Attribute,Value,op FROM ${authcheck_table} WHERE Username = '%{SQL-User-Name}' ORDER BY id"
128 authorize_reply_query = "SELECT id,UserName,Attribute,Value,op FROM ${authreply_table} WHERE Username = '%{SQL-User-Name}' ORDER BY id"
130 # Use these for case sensitive usernames. WANRING: Slower queries!
131 # 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 STRCMP(${usergroup_table}.Username, '%{SQL-User-Name}') = 0 AND ${usergroup_table}.GroupName = ${groupcheck_table}.GroupName ORDER BY ${groupcheck_table}.id"
132 # 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 STRCMP(${usergroup_table}.Username, '%{SQL-User-Name}') = 0 AND ${usergroup_table}.GroupName = ${groupreply_table}.GroupName ORDER BY ${groupreply_table}.id"
134 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"
135 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"
138 #######################################################################
140 #######################################################################
141 # accounting_onoff_query - query for Accounting On/Off packets
142 # accounting_update_query - query for Accounting update packets
143 # accounting_start_query - query for Accounting start packets
144 # accounting_start_query_alt - query for Accounting start packets
145 # (alternate in case first query fails)
146 # accounting_stop_query - query for Accounting stop packets
147 # accounting_stop_query_alt - query for Accounting start packets
148 # (alternate in case first query doesn't
149 # affect any existing rows in the table)
150 #######################################################################
151 accounting_onoff_query = "UPDATE ${acct_table1} SET AcctStopTime='%S', AcctSessionTime=unix_timestamp('%S') - unix_timestamp(AcctStartTime), AcctTerminateCause='%{Acct-Terminate-Cause}', AcctStopDelay = %{Acct-Delay-Time} WHERE AcctSessionTime=0 AND AcctStopTime=0 AND NASIPAddress= '%{NAS-IP-Address}' AND AcctStartTime <= '%S'"
153 accounting_update_query = "UPDATE ${acct_table1} \
154 SET FramedIPAddress = '%{Framed-IP-Address}', \
155 AcctSessionTime = '%{Acct-Session-Time}', \
156 AcctInputOctets = '%{Acct-Input-Octets}', \
157 AcctOutputOctets = '%{Acct-Output-Octets}' \
158 WHERE AcctSessionId = '%{Acct-Session-Id}' \
159 AND UserName = '%{SQL-User-Name}' \
160 AND NASIPAddress= '%{NAS-IP-Address}'"
162 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) values('', '%{Acct-Session-Id}', '%{Acct-Unique-Session-Id}', '%{SQL-User-Name}', '%{Realm}', '%{NAS-IP-Address}', '%{NAS-Port}', '%{NAS-Port-Type}', '%S', '0', '0', '%{Acct-Authentic}', '%{Connect-Info}', '', '0', '0', '%{Called-Station-Id}', '%{Calling-Station-Id}', '', '%{Service-Type}', '%{Framed-Protocol}', '%{Framed-IP-Address}', '%{Acct-Delay-Time}', '0')"
164 accounting_start_query_alt = "UPDATE ${acct_table1} SET AcctStartTime = '%S', AcctStartDelay = '%{Acct-Delay-Time}', ConnectInfo_start = '%{Connect-Info}' WHERE AcctSessionId = '%{Acct-Session-Id}' AND UserName = '%{SQL-User-Name}' AND NASIPAddress = '%{NAS-IP-Address}'"
166 accounting_stop_query = "UPDATE ${acct_table2} SET AcctStopTime = '%S', AcctSessionTime = '%{Acct-Session-Time}', AcctInputOctets = '%{Acct-Input-Octets}', AcctOutputOctets = '%{Acct-Output-Octets}', AcctTerminateCause = '%{Acct-Terminate-Cause}', AcctStopDelay = '%{Acct-Delay-Time}', ConnectInfo_stop = '%{Connect-Info}' WHERE AcctSessionId = '%{Acct-Session-Id}' AND UserName = '%{SQL-User-Name}' AND NASIPAddress = '%{NAS-IP-Address}'"
168 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) values('', '%{Acct-Session-Id}', '%{Acct-Unique-Session-Id}', '%{SQL-User-Name}', '%{Realm}', '%{NAS-IP-Address}', '%{NAS-Port}', '%{NAS-Port-Type}', DATE_SUB('%S',INTERVAL (%{Acct-Session-Time:-0} + %{Acct-Delay-Time:-0}) SECOND), '%S', '%{Acct-Session-Time}', '%{Acct-Authentic}', '', '%{Connect-Info}', '%{Acct-Input-Octets}', '%{Acct-Output-Octets}', '%{Called-Station-Id}', '%{Calling-Station-Id}', '%{Acct-Terminate-Cause}', '%{Service-Type}', '%{Framed-Protocol}', '%{Framed-IP-Address}', '0', '%{Acct-Delay-Time}')"
170 #######################################################################
171 # Simultaneous Use Checking Queries
172 #######################################################################
173 # simul_count_query - query for the number of current connections
174 # - If this is not defined, no simultaneouls use checking
175 # - will be performed by this module instance
176 # simul_verify_query - query to return details of current connections for verification
177 # - Leave blank or commented out to disable verification step
178 # - Note that the returned field order should not be changed.
179 #######################################################################
181 # Uncomment simul_count_query to enable simultaneous use checking
182 # simul_count_query = "SELECT COUNT(*) FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime = 0"
183 simul_verify_query = "SELECT RadAcctId, AcctSessionId, UserName, NASIPAddress, NASPortId, FramedIPAddress, CallingStationId, FramedProtocol FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime = 0"
185 #######################################################################
186 # Group Membership Queries
187 #######################################################################
188 # group_membership_query - Check user group membership
189 #######################################################################
191 group_membership_query = "SELECT GroupName FROM ${usergroup_table} WHERE UserName='%{SQL-User-Name}'"
193 #######################################################################
194 # Authentication Logging Queries
195 #######################################################################
196 # postauth_query - Insert some info after authentication
197 #######################################################################
199 postauth_query = "INSERT into ${postauth_table} (id, user, pass, reply, date) values ('', '%{User-Name}', '%{User-Password}', '%{reply:Packet-Type}', NOW())"