New build path variable
[freeradius.git] / raddb / sql.conf
index a01a03c..690c3a2 100644 (file)
@@ -1,29 +1,47 @@
+# -*- text -*-
+##
+## sql.conf -- SQL modules
+##
+##     $Id$
+
+######################################################################
 #
-#  Configuration for the SQL module, when using MySQL.
-#
-#  The database schema is available at:
+#  Configuration for the SQL module
 #
-#   src/radiusd/src/modules/rlm_sql/drivers/rlm_sql_mysql/db_mysql.sql
+#  The database schemas and queries are located in subdirectories:
 #
-#  If you are using PostgreSQL, please use 'postgresql.conf', instead.
-#  If you are using Oracle, please use 'oracle.conf', instead.
-#  If you are using MS-SQL, please use 'mssql.conf', instead.
+#      sql/DB/schema.sql       Schema
+#      sql/DB/dialup.conf      Basic dialup (including policy) queries
+#      sql/DB/counter.conf     counter
+#      sql/DB/ippool.conf      IP Pools in SQL
+#      sql/DB/ippool.sql       schema for IP pools.
 #
-#      $Id$
+#  Where "DB" is mysql, mssql, oracle, or postgresql.
 #
+
 sql {
-       # Database type
-       # Current supported are: rlm_sql_mysql, rlm_sql_postgresql,
-       # rlm_sql_iodbc, rlm_sql_oracle, rlm_sql_unixodbc, rlm_sql_freetds
-       driver = "rlm_sql_mysql"
+       #
+       #  Set the database to one of:
+       #
+       #       mysql, mssql, oracle, postgresql
+       #
+       database = "mysql"
 
-       # Connect info
+       #
+       #  Which FreeRADIUS driver to use.
+       #
+       driver = "rlm_sql_${database}"
+
+       # Connection info:
        server = "localhost"
-       login = "root"
-       password = "rootpass"
+       #port = 3306
+       login = "radius"
+       password = "radpass"
 
-       # Database table configuration
+       # Database table configuration for everything except Oracle
        radius_db = "radius"
+       # If you are using Oracle then use this instead
+        # radius_db = "(DESCRIPTION=(ADDRESS=(PROTOCOL=TCP)(HOST=localhost)(PORT=1521))(CONNECT_DATA=(SID=your_sid)))"
 
        # If you want both stop and start records logged to the
        # same SQL table, leave this as is.  If you want them in
@@ -41,10 +59,12 @@ sql {
        groupcheck_table = "radgroupcheck"
        groupreply_table = "radgroupreply"
 
-       usergroup_table = "usergroup"
+       # Table to keep group info
+       usergroup_table = "radusergroup"
 
-       # Table to keep radius client info
-       nas_table = "nas"
+       # If set to 'yes' (default) we read the group tables
+       # If set to 'no' the user MUST have Fall-Through = Yes in the radreply table
+       # read_groups = yes
 
        # Remove stale session if checkrad does not see a double login
        deletestalesessions = yes
@@ -60,168 +80,28 @@ sql {
        # connection (per_socket)
        connect_failure_retry_delay = 60
 
-       # Safe characters list for sql queries. Everything else is replaced
-       # with their mime-encoded equivalents.
-       # The default list should be ok
-       #safe-characters = "@abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ0123456789.-_: /"
-
-       #######################################################################
-       #  Query config:  Username
-       #######################################################################
-       # This is the username that will get substituted, escaped, and added
-       # as attribute 'SQL-User-Name'.  '%{SQL-User-Name}' should be used below
-       # everywhere a username substitution is needed so you you can be sure
-       # the username passed from the client is escaped properly.
-       #
-       #  Uncomment the next line, if you want the sql_user_name to mean:
-       #
-       #    Use Stripped-User-Name, if it's there.
-       #    Else use User-Name, if it's there,
-       #    Else use hard-coded string "DEFAULT" as the user name.
-       #sql_user_name = "%{Stripped-User-Name:-%{User-Name:-DEFAULT}}"
-       #
-       sql_user_name = "%{User-Name}"
-
-       #######################################################################
-       #  Default profile
-       #######################################################################
-       # This is the default profile. It is found in SQL by group membership.
-       # That means that this profile must be a member of at least one group
-       # which will contain the corresponding check and reply items.
-       # This profile will be queried in the authorize section for every user.
-       # The point is to assign all users a default profile without having to
-       # manually add each one to a group that will contain the profile.
-       # The SQL module will also honor the User-Profile attribute. This
-       # attribute can be set anywhere in the authorize section (ie the users
-       # file). It is found exactly as the default profile is found.
-       # If it is set then it will *overwrite* the default profile setting.
-       # The idea is to select profiles based on checks on the incoming packets,
-       # not on user group membership. For example:
-       # -- users file --
-       # DEFAULT       Service-Type == Outbound-User, User-Profile := "outbound"
-       # DEFAULT       Service-Type == Framed-User, User-Profile := "framed"
-       #
-       # By default the default_user_profile is not set
-       #
-       #default_user_profile = "DEFAULT"
-       #
-       # Determines if we will query the default_user_profile or the User-Profile
-       # if the user is not found. If the profile is found then we consider the user
-       # found. By default this is set to 'no'.
-       #
-       #query_on_not_found = no
-
-       #######################################################################
-       #  Authorization Queries
-       #######################################################################
-       #  These queries compare the check items for the user
-       #  in ${authcheck_table} and setup the reply items in
-       #  ${authreply_table}.  You can use any query/tables
-       #  you want, but the return data for each row MUST
-       #  be in the  following order:
-       #
-       #  0. Row ID (currently unused)
-       #  1. UserName/GroupName
-       #  2. Item Attr Name
-       #  3. Item Attr Value
-       #  4. Item Attr Operation
-       #######################################################################
-       # Use these for case sensitive usernames.
-#      authorize_check_query = "SELECT id, UserName, Attribute, Value, op \
-#         FROM ${authcheck_table} \
-#         WHERE Username = BINARY '%{SQL-User-Name}' \
-#         ORDER BY id"
-#      authorize_reply_query = "SELECT id, UserName, Attribute, Value, op \
-#         FROM ${authreply_table} \
-#         WHERE Username = BINARY '%{SQL-User-Name}' \
-#         ORDER BY id"
-
-       # The default queries are case insensitive. (for compatibility with
-       # older versions of FreeRADIUS)
-       authorize_check_query = "SELECT id, UserName, Attribute, Value, op \
-          FROM ${authcheck_table} \
-          WHERE Username = '%{SQL-User-Name}' \
-          ORDER BY id"
-       authorize_reply_query = "SELECT id, UserName, Attribute, Value, op \
-          FROM ${authreply_table} \
-          WHERE Username = '%{SQL-User-Name}' \
-          ORDER BY id"
-
-       # Use these for case sensitive usernames.
-#      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 = BINARY '%{SQL-User-Name}' AND ${usergroup_table}.GroupName = ${groupcheck_table}.GroupName ORDER BY ${groupcheck_table}.id"
-#      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 = BINARY '%{SQL-User-Name}' AND ${usergroup_table}.GroupName = ${groupreply_table}.GroupName ORDER BY ${groupreply_table}.id"
-
-       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"
-       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"
-
-       #######################################################################
-       #  Accounting Queries
-       #######################################################################
-       # accounting_onoff_query        - query for Accounting On/Off packets
-       # accounting_update_query       - query for Accounting update packets
-       # accounting_update_query_alt   - query for Accounting update packets
-       #                               (alternate in case first query fails)
-       # accounting_start_query        - query for Accounting start packets
-       # accounting_start_query_alt    - query for Accounting start packets
-       #                               (alternate in case first query fails)
-       # accounting_stop_query         - query for Accounting stop packets
-       # accounting_stop_query_alt     - query for Accounting start packets
-       #                               (alternate in case first query doesn't
-       #                                affect any existing rows in the table)
-       #######################################################################
-       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'"
-
-       accounting_update_query = "UPDATE ${acct_table1} \
-          SET FramedIPAddress = '%{Framed-IP-Address}', \
-          AcctSessionTime = '%{Acct-Session-Time}', \
-          AcctInputOctets = '%{Acct-Input-Octets}', \
-          AcctOutputOctets = '%{Acct-Output-Octets}' \
-          WHERE AcctSessionId = '%{Acct-Session-Id}' \
-          AND UserName = '%{SQL-User-Name}' \
-          AND NASIPAddress= '%{NAS-IP-Address}'"
-
-       accounting_update_query_alt = "INSERT into ${acct_table1} (AcctSessionId, AcctUniqueId, UserName, Realm, NASIPAddress, NASPortId, NASPortType, AcctStartTime, AcctSessionTime, AcctAuthentic, ConnectInfo_start, AcctInputOctets, AcctOutputOctets, CalledStationId, CallingStationId, ServiceType, FramedProtocol, FramedIPAddress, AcctStartDelay) 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), '%{Acct-Session-Time}', '%{Acct-Authentic}', '', '%{Acct-Input-Octets}', '%{Acct-Output-Octets}', '%{Called-Station-Id}', '%{Calling-Station-Id}', '%{Service-Type}', '%{Framed-Protocol}', '%{Framed-IP-Address}', '0')"
-
-       accounting_start_query = "INSERT into ${acct_table1} (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')"
-
-       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}'"
-
-       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}'"
-
-       accounting_stop_query_alt = "INSERT into ${acct_table2} (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}')"
-
-       #######################################################################
-       # Simultaneous Use Checking Queries
-       #######################################################################
-       # simul_count_query     - query for the number of current connections
-       #                       - If this is not defined, no simultaneouls use checking
-       #                       - will be performed by this module instance
-       # simul_verify_query    - query to return details of current connections for verification
-       #                       - Leave blank or commented out to disable verification step
-       #                       - Note that the returned field order should not be changed.
-       #######################################################################
-
-       # Uncomment simul_count_query to enable simultaneous use checking
-       # simul_count_query = "SELECT COUNT(*) FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime = 0"
-       simul_verify_query = "SELECT RadAcctId, AcctSessionId, UserName, NASIPAddress, NASPortId, FramedIPAddress, CallingStationId, FramedProtocol FROM ${acct_table1} WHERE UserName='%{SQL-User-Name}' AND AcctStopTime = 0"
-
-       #######################################################################
-       # Group Membership Queries
-       #######################################################################
-       # group_membership_query        - Check user group membership
-       #######################################################################
-
-       group_membership_query = "SELECT GroupName FROM ${usergroup_table} WHERE UserName='%{SQL-User-Name}'"
-
-       #######################################################################
-       # Authentication Logging Queries
-       #######################################################################
-       # postauth_query                - Insert some info after authentication
-       #######################################################################
-
-       postauth_query = "INSERT into ${postauth_table} (id, user, pass, reply, date) values ('', '%{User-Name}', '%{User-Password:-Chap-Password}', '%{reply:Packet-Type}', NOW())"
+       # lifetime of an SQL socket.  If you are having network issues
+       # such as TCP sessions expiring, you may need to set the socket
+       # lifetime.  If set to non-zero, any open connections will be
+       # closed "lifetime" seconds after they were first opened.
+       lifetime = 0
+
+       # Maximum number of queries used by an SQL socket.  If you are
+       # having issues with SQL sockets lasting "too long", you can
+       # limit the number of queries performed over one socket.  After
+       # "max_qeuries", the socket will be closed.  Use 0 for "no limit".
+       max_queries = 0
 
-       #
        # Set to 'yes' to read radius clients from the database ('nas' table)
+       # Clients will ONLY be read on server startup.  For performance
+       # and security reasons, finding clients via SQL queries CANNOT
+       # be done "live" while the server is running.
+       # 
        #readclients = yes
+
+       # Table to keep radius client info
+       nas_table = "nas"
+
+       # Read driver-specific configuration
+       $INCLUDE sql/${database}/dialup.conf
 }