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 MS-SQL, please use 'mssql.conf', instead.
16 # Current supported are: rlm_sql_mysql, rlm_sql_postgresql,
17 # rlm_sql_iodbc, rlm_sql_oracle, rlm_sql_unixodbc, rlm_sql_freetds
18 driver = "rlm_sql_mysql"
25 # Database table configuration
28 # If you want both stop and start records logged to the
29 # same SQL table, leave this as is. If you want them in
30 # different tables, put the start table in acct_table1
31 # and stop table in acct_table2
32 acct_table1 = "radacct"
33 acct_table2 = "radacct"
35 authcheck_table = "radcheck"
36 authreply_table = "radreply"
38 groupcheck_table = "radgroupcheck"
39 groupreply_table = "radgroupreply"
41 usergroup_table = "usergroup"
43 # Remove stale session if checkrad does not see a double login
44 deletestalesessions = yes
46 # Print all SQL statements when in debug mode (-x)
48 sqltracefile = ${logdir}/sqltrace.sql
50 # number of sql connections to make to server
53 # number of seconds to dely retrying on a failed database
54 # connection (per_socket)
55 connect_failure_retry_delay = 60
57 #######################################################################
58 # Query config: Username
59 #######################################################################
60 # This is the username that will get substituted, escaped, and added
61 # as attribute 'SQL-User-Name'. '%{SQL-User-Name}' should be used below
62 # everywhere a username substitution is needed so you you can be sure
63 # the username passed from the client is escaped properly.
65 # Uncomment the next line, if you want the sql_user_name to mean:
67 # Use Stripped-User-Name, if it's there.
68 # Else use User-Name, if it's there,
69 # Else use hard-coded string "DEFAULT" as the user name.
70 #sql_user_name = "%{Stripped-User-Name:-%{User-Name:-DEFAULT}}"
72 sql_user_name = "%{User-Name}"
74 #######################################################################
76 #######################################################################
77 # This is the default profile. It is found in SQL by group membership.
78 # That means that this profile must be a member of at least one group
79 # which will contain the corresponding check and reply items.
80 # This profile will be queried in the authorize section for every user.
81 # The point is to assign all users a default profile without having to
82 # manually add each one to a group that will contain the profile.
83 # The SQL module will also honor the User-Profile attribute. This
84 # attribute can be set anywhere in the authorize section (ie the users
85 # file). It is found exactly as the default profile is found.
86 # If it is set then it will *overwrite* the default profile setting.
87 # The idea is to select profiles based on checks on the incoming packets,
88 # not on user group membership. For example:
90 # DEFAULT Service-Type == Outbound-User, User-Profile := "outbound"
91 # DEFAULT Service-Type == Framed-User, User-Profile := "framed"
93 # By default the default_user_profile is not set
95 #default_user_profile = "DEFAULT"
97 # Determines if we will query the default_user_profile or the User-Profile
98 # if the user is not found. If the profile is found then we consider the user
99 # found. By default this is set to 'no'.
101 #query_on_not_found = no
104 #######################################################################
105 # Authorization Queries
106 #######################################################################
107 # These queries compare the check items for the user
108 # in ${authcheck_table} and setup the reply items in
109 # ${authreply_table}. You can use any query/tables
110 # you want, but the return data for each row MUST
111 # be in the following order:
113 # 0. Row ID (currently unused)
114 # 1. UserName/GroupName
117 # 4. Item Attr Operation
118 #######################################################################
119 # Use these for case sensitive usernames. WARNING: Slower queries!
120 # authorize_check_query = "SELECT id,UserName,Attribute,Value,op FROM ${authcheck_table} WHERE STRCMP(Username, '%{SQL-User-Name}') = 0 ORDER BY id"
121 # authorize_reply_query = "SELECT id,UserName,Attribute,Value,op FROM ${authreply_table} WHERE STRCMP(Username, '%{SQL-User-Name}') = 0 ORDER BY id"
123 authorize_check_query = "SELECT id,UserName,Attribute,Value,op FROM ${authcheck_table} WHERE Username = '%{SQL-User-Name}' ORDER BY id"
124 authorize_reply_query = "SELECT id,UserName,Attribute,Value,op FROM ${authreply_table} WHERE Username = '%{SQL-User-Name}' ORDER BY id"
126 # Use these for case sensitive usernames. WANRING: Slower queries!
127 # 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"
128 # 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"
130 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"
131 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"
134 #######################################################################
136 #######################################################################
137 # accounting_onoff_query - query for Accounting On/Off packets
138 # accounting_update_query - query for Accounting update packets
139 # accounting_start_query - query for Accounting start packets
140 # accounting_start_query_alt - query for Accounting start packets
141 # (alternate in case first query fails)
142 # accounting_stop_query - query for Accounting stop packets
143 # accounting_stop_query_alt - query for Accounting start packets
144 # (alternate in case first query doesn't
145 # affect any existing rows in the table)
146 #######################################################################
147 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'"
149 accounting_update_query = "UPDATE ${acct_table1} SET FramedIPAddress = '%{Framed-IP-Address}' WHERE AcctSessionId = '%{Acct-Session-Id}' AND UserName = '%{SQL-User-Name}' AND NASIPAddress= '%{NAS-IP-Address}' AND AcctStopTime = 0"
151 accounting_start_query = "INSERT into radacct (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')"
153 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}' AND AcctStopTime = 0"
155 accounting_stop_query = "UPDATE ${acct_table1} 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}' AND AcctStopTime = 0"
157 accounting_stop_query_alt = "INSERT into radacct (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}', '0', '%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}')"
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 #######################################################################
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 = 0"
172 simul_verify_query = "SELECT RadAcctId, AcctSessionId, UserName, NASIPAddress, NASPortId, FramedIPAddress, CallingStationId, FramedProtocol FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime = 0"
174 #######################################################################
175 # Group Membership Queries
176 #######################################################################
177 # group_membership_query - Check user group membership
178 #######################################################################
180 group_membership_query = "SELECT GroupName FROM ${usergroup_table} WHERE UserName='%{SQL-User-Name}'"