Merge branch '4593-deprecate-sortlist' into 'main'

Deprecate sortlist option

Closes #4593

See merge request isc-projects/bind9!8807

CHANGES

@@ -1,3 +1,6 @@
+6368.	[func]		The 'sortlist' option has been marked and documented
+			as deprecated. [GL #4593]
+
 6367.	[bug]		Since the dns_validator_destroy() function doesn't
 			guarantee that it destroys the validator, rename it to
 			dns_validator_shutdown() and require explicit

bin/tests/system/checkconf/deprecated.conf

@@ -28,6 +28,8 @@ options {
 	avoid-v6-udp-ports { range 1 1023; };
 
 	dnssec-must-be-secure mustbesecure.example yes;
+
+	sortlist { };
 };
 
 trusted-keys {

bin/tests/system/checkconf/tests.sh

@@ -179,6 +179,7 @@ grep "option 'avoid-v6-udp-ports' is deprecated" <checkconf.out$n.1 >/dev/null |
 grep "option 'dialup' is deprecated" <checkconf.out$n.1 >/dev/null || ret=1
 grep "option 'heartbeat-interval' is deprecated" <checkconf.out$n.1 >/dev/null || ret=1
 grep "option 'dnssec-must-be-secure' is deprecated" <checkconf.out$n.1 >/dev/null || ret=1
+grep "option 'sortlist' is deprecated" <checkconf.out$n.1 >/dev/null || ret=1
 grep "token 'port' is deprecated" <checkconf.out$n.1 >/dev/null || ret=1
 if [ $ret -ne 0 ]; then echo_i "failed"; fi
 status=$((status + ret))

doc/arm/reference.rst

@@ -4014,9 +4014,11 @@ client's address. This only requires configuring the name servers, not
 all the clients.
 
 .. namedconf:statement:: sortlist
-   :tags: query
+   :tags: query, deprecated
    :short: Controls the ordering of RRs returned to the client, based on the client's IP address.
 
+   This option is deprecated and will be removed in a future release.
+
    The :any:`sortlist` statement (see below) takes an :term:`address_match_list` and
    interprets it in a special way. Each top-level statement in the :any:`sortlist`
    must itself be an explicit :term:`address_match_list` with one or two elements. The

doc/misc/options

@@ -274,7 +274,7 @@ options {
 	sig-signing-signatures <integer>;
 	sig-signing-type <integer>;
 	sig-validity-interval <integer> [ <integer> ]; // obsolete
-	sortlist { <address_match_element>; ... };
+	sortlist { <address_match_element>; ... }; // deprecated
 	stale-answer-client-timeout ( disabled | off | <integer> );
 	stale-answer-enable <boolean>;
 	stale-answer-ttl <duration>;
@@ -569,7 +569,7 @@ view <string> [ <class> ] {
 	sig-signing-signatures <integer>;
 	sig-signing-type <integer>;
 	sig-validity-interval <integer> [ <integer> ]; // obsolete
-	sortlist { <address_match_element>; ... };
+	sortlist { <address_match_element>; ... }; // deprecated
 	stale-answer-client-timeout ( disabled | off | <integer> );
 	stale-answer-enable <boolean>;
 	stale-answer-ttl <duration>;

doc/notes/notes-current.rst

@@ -32,6 +32,10 @@ Feature Changes
 
 - None.
 
+- The ``sortlist`` option has been deprecated and will be removed
+  in a future BIND 9.21.x release. Please don't rely on a specific
+  order of resource records in the DNS messages.  :gl:`#4593`
+
 Bug Fixes
 ~~~~~~~~~
 

lib/isccfg/namedconf.c

@@ -2199,7 +2199,7 @@ static cfg_clausedef_t view_clauses[] = {
 	{ "rrset-order", &cfg_type_rrsetorder, 0 },
 	{ "send-cookie", &cfg_type_boolean, 0 },
 	{ "servfail-ttl", &cfg_type_duration, 0 },
-	{ "sortlist", &cfg_type_bracketed_aml, 0 },
+	{ "sortlist", &cfg_type_bracketed_aml, CFG_CLAUSEFLAG_DEPRECATED },
 	{ "stale-answer-enable", &cfg_type_boolean, 0 },
 	{ "stale-answer-client-timeout", &cfg_type_staleanswerclienttimeout,
 	  0 },