From: Alan T. DeKok <aland@freeradius.org>
Date: Mon, 24 May 2021 14:27:56 +0000 (-0400)
Subject: add class columns / fields to queries
X-Git-Tag: release_3_0_23~70
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=cbec45921c6f9a908030aa842108dc59e45965ba;p=thirdparty%2Ffreeradius-server.git

add class columns / fields to queries

for both accounting and postauth
---

diff --git a/raddb/mods-config/sql/main/sqlite/queries.conf b/raddb/mods-config/sql/main/sqlite/queries.conf
index ef413138781..20e87a928a8 100644
--- a/raddb/mods-config/sql/main/sqlite/queries.conf
+++ b/raddb/mods-config/sql/main/sqlite/queries.conf
@@ -26,6 +26,35 @@
 #
 sql_user_name = "%{User-Name}"
 
+#
+#  3.0.22 and later have a "class" column in the accounting table.
+#
+#  However, we do NOT want to break existing configurations by adding
+#  the Class attribute to the default queries.  If we did that, then
+#  systems using newer versions of the server would fail, because
+#  there is no "class" column in their accounting tables.
+#
+#  The solution to that is the following "class" subsection.  If your
+#  database has a "class" column for the various tables, then you can
+#  uncomment the configuration items here.  The queries below will
+#  then automatically insert the Class attribute into radacct,
+#  radpostauth, etc.
+#
+class {
+	#
+	#  Delete the '#' from all of the next 3 lines in order to
+	#  put the Class attribute into the various tables.
+	#
+	#  See also policy.d/accounting, and the "insert_acct_class"
+	#  policy.  You will need to list (or uncomment)
+	#  "insert_acct_class" in the "post-auth" section in order to
+	#  create a Class attribute.
+	#
+	column_name =  # ", class"
+	packet_xlat =  # ", '%{Class}'"
+	reply_xlat =   # ", '%{Reply:Class}'"
+}
+
 #######################################################################
 #  Query config:  Event-Timestamp
 #######################################################################
@@ -236,7 +265,8 @@ accounting {
 		framedipv6address, \
 		framedipv6prefix, \
 		framedinterfaceid, \
-		delegatedipv6prefix"
+		delegatedipv6prefix \
+		${..class.column_name}"
 
 	type {
 		accounting-on {
@@ -345,7 +375,8 @@ accounting {
 					'%{Framed-IPv6-Address}', \
 					'%{Framed-IPv6-Prefix}', \
 					'%{Framed-Interface-Id}', \
-					'%{Delegated-IPv6-Prefix}')"
+					'%{Delegated-IPv6-Prefix}' \
+					${....class.packet_xlat})"
 
 			#
 			#  When using "sql_session_start", you should comment out
@@ -448,7 +479,8 @@ accounting {
 					'%{Framed-IPv6-Address}', \
 					'%{Framed-IPv6-Prefix}', \
 					'%{Framed-Interface-Id}', \
-					'%{Delegated-IPv6-Prefix}')"
+					'%{Delegated-IPv6-Prefix}' \
+					${....class.packet_xlat})"
 
 			#
 			#  When using "sql_session_start", you should comment out
@@ -538,7 +570,8 @@ accounting {
 					'%{Framed-IPv6-Address}', \
 					'%{Framed-IPv6-Prefix}', \
 					'%{Framed-Interface-Id}', \
-					'%{Delegated-IPv6-Prefix}')"
+					'%{Delegated-IPv6-Prefix}' \
+					${....class.packet_xlat})"
 
 			#
 			#  When using "sql_session_start", you should comment out
@@ -603,10 +636,11 @@ post-auth {
 
 	query =	"\
 		INSERT INTO ${..postauth_table} \
-			(username, pass, reply, authdate) \
+			(username, pass, reply, authdate ${..class.column_name}) \
 		VALUES ( \
 			'%{SQL-User-Name}', \
 			'%{%{User-Password}:-%{Chap-Password}}', \
 			'%{reply:Packet-Type}', \
-			'%S.%M')"
+			'%S.%M' \
+			${..class.reply_xlat})"
 }
diff --git a/raddb/mods-config/sql/main/sqlite/schema.sql b/raddb/mods-config/sql/main/sqlite/schema.sql
index bdbbfec27bb..d6277531a9a 100644
--- a/raddb/mods-config/sql/main/sqlite/schema.sql
+++ b/raddb/mods-config/sql/main/sqlite/schema.sql
@@ -42,6 +42,15 @@ CREATE TABLE IF NOT EXISTS radacct (
 	class varchar(64) default NULL
 );
 
+--
+--  You might not need all of these indexes.  It should be safe to
+--  delete indexes you do not use.  For example, if you're not using
+--  IPv6, you can delete the indexes on IPv6 attributes.
+--
+--  You MUST however leave the indexes needed by the server, which
+--  include username, acctstoptime, nasipaddress, acctstarttime, and
+--  acctuniqueid.
+--
 CREATE UNIQUE INDEX acctuniqueid ON radacct(acctuniqueid);
 CREATE INDEX username ON radacct(username);
 CREATE INDEX framedipaddress ON radacct (framedipaddress);
@@ -55,6 +64,7 @@ CREATE INDEX acctstarttime ON radacct(acctstarttime);
 CREATE INDEX acctinterval ON radacct(acctinterval);
 CREATE INDEX acctstoptime ON radacct(acctstoptime);
 CREATE INDEX nasipaddress ON radacct(nasipaddress);
+CREATE INDEX class ON radacct(class);
 
 --
 -- Table structure for table 'radcheck'
@@ -123,8 +133,11 @@ CREATE TABLE IF NOT EXISTS radpostauth (
 	username varchar(64) NOT NULL default '',
 	pass varchar(64) NOT NULL default '',
 	reply varchar(32) NOT NULL default '',
-	authdate timestamp NOT NULL
+	authdate timestamp NOT NULL,
+	class varchar(64) default NULL
 );
+CREATE INDEX username ON radpostauth(username);
+CREATE INDEX class ON radpostauth(class);
 
 --
 -- Table structure for table 'nas'