Skip to content

Commit

Permalink
Don't display commands using classic expression as deprecated commands
Browse files Browse the repository at this point in the history
  • Loading branch information
@Aman-Agrawal1
Aman-Agrawal1 committed Nov 28, 2024
1 parent e3d2697 commit 925b37c
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 235 deletions.
19 changes: 3 additions & 16 deletions nspepi/check_invalid_config
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/perl

# Copyright 2021-2023 Citrix Systems, Inc. All rights reserved.
# Copyright 2021-2024 Citrix Systems, Inc. All rights reserved.
# Use of this software is governed by the license terms, if any,
# which accompany or are included with this software.

Expand Down Expand Up @@ -58,7 +58,7 @@ if (not -e $config_file) {
}

sub tool_usage() {
print "Usage: check_invalid_config <ns_config_file> -buildVersion <Build version for which invalid or depreacted commands need to check>\n";
print "Usage: check_invalid_config <ns_config_file> -buildVersion <Build version for which invalid commands need to check>\n";
}

my($filename, $dir_path) = fileparse($config_file);
Expand All @@ -70,28 +70,15 @@ if ($exit_status != 0) {
exit;
}
my $invalid_config_file = $dir_path."/issues_".$filename;
my $deprecated_config_file = $dir_path."deprecated_".$filename;

# Checks whether any command is present in the file
if (!(-z $invalid_config_file)) {
print "\nThe following configuration lines will get errors in ".$buildVersion." and both they and dependent configuration will be removed from the configuration:\n";
system("cat $invalid_config_file");
print "\nThe nspepi upgrade tool can be useful in converting your configuration - see the documentation at https://docs.citrix.com/en-us/citrix-adc/current-release/appexpert/policies-and-expressions/introduction-to-policies-and-exp/converting-policy-expressions-nspepi-tool.html.\n";
print "\nNOTE: the nspepi tool doesn't convert the following configurations:\n\t1. SureConnect commands\n\t2. PriorityQueuing commands\n\t3. HTTP Denial of Service Protection commands\n\t4. HTMLInjection commands.\n";
if (!(-z $deprecated_config_file)) {
print "\nNOTE: some deprecated commands have also been detected in the config file, please check ".$deprecated_config_file." file for the deprecated commands.\n";
} else {
print "\nNOTE: No deprecated commands detected in the configuration.\n";
}
} else {
if (!(-z $deprecated_config_file)) {
print "\nThe following configuration lines have been deprecated in ".$buildVersion." and will be removed in future releases:\n";
system("tail -n 10 $deprecated_config_file");
print "\nFor the complete deprecated commands, please see the output of ".$deprecated_config_file." file.\n";
print "\nNo invalid config detected with the configuration.\n";
} else {
print "\nNo invalid or deprecated config detected with the configuration.\n";
}
print "\nNo invalid config detected with the configuration.\n";
}
print "\nUse pre-validation tool and nspepi tool available at https://github.com/citrix/ADC-scripts/tree/master/nspepi for the most complete and up-to-date version.\n"
### End check_invalid_config script
213 changes: 0 additions & 213 deletions nspepi/nspepi2/check_classic_configs.py
View file
Original file line number Diff line number Diff line change
Expand Up @@ -634,11 +634,6 @@ def check_policy_expr(self, commandParseTree):

if commandParseTree.keyword_exists('clientSecurityMessage'):
NamedExpression.register_classic_entity_name(commandParseTree)
logging.warning(("Client security expressions are deprecated"
" using this command [{}], please use"
" the advanced authentication policy command")
.format(str(commandParseTree).strip()))
return []

named_expr[lower_expr_name] = expr_rule

Expand All @@ -654,9 +649,6 @@ def check_policy_expr(self, commandParseTree):
"""
NamedExpression.register_policy_entity_name(commandParseTree)
NamedExpression.register_classic_entity_name(original_tree)
logging.warning(("Classic expressions are deprecated in"
" command [{}], please use the advanced expression")
.format(str(commandParseTree).strip()))
else:
NamedExpression.register_policy_entity_name(original_tree)
if is_advanced_removed_expr_present(expr_rule):
Expand Down Expand Up @@ -762,7 +754,6 @@ def check_cmp_global_bind(self, bind_cmd_tree):
# If state keyword is present then it is a
# classic binding.
if bind_cmd_tree.keyword_exists("state"):
bind_cmd_tree.set_invalid()
return [bind_cmd_tree]

policy_name = bind_cmd_tree.positional_value(0).value
Expand Down Expand Up @@ -1004,206 +995,6 @@ def check_advanced_expr(self, commandParseTree):
return []


@common.register_class_methods
class Deprecation(CheckConfig):
"""
Check the deprecated commands or parameters or expressions.
"""

@common.register_for_cmd("add", "audit", "syslogPolicy")
@common.register_for_cmd("add", "audit", "nslogPolicy")
@common.register_for_cmd("add", "authorization", "policy")
@common.register_for_cmd("add", "vpn", "trafficPolicy")
@common.register_for_cmd("add", "tunnel", "trafficPolicy")
@common.register_for_cmd("add", "tm", "sessionPolicy")
def check_deprecated_classic_policy(self, commandParseTree):
"""
Check the policies which can still use the classic
expressions.
"""
rule_expr = commandParseTree.positional_value(1).value
commandParseTree = Deprecation.check_pos_expr(commandParseTree, 1, False)
if commandParseTree.invalid:
logging.warning(("Classic expression in the rule field is deprecated"
" for command [{}], please use the advanced expression")
.format(str(commandParseTree).strip()))
elif is_advanced_removed_expr_present(rule_expr):
commandParseTree.set_invalid()
return [commandParseTree]
return []

@common.register_for_cmd("add", "authentication", "certPolicy")
@common.register_for_cmd("add", "authentication", "negotiatePolicy")
@common.register_for_cmd("add", "authentication", "tacacsPolicy")
@common.register_for_cmd("add", "authentication", "samlPolicy")
@common.register_for_cmd("add", "authentication", "radiusPolicy")
@common.register_for_cmd("add", "authentication", "ldapPolicy")
@common.register_for_cmd("add", "authentication", "localPolicy")
@common.register_for_cmd("add", "authentication", "webAuthPolicy")
@common.register_for_cmd("add", "authentication", "dfaPolicy")
@common.register_for_cmd("add", "aaa", "preauthenticationpolicy")
def check_authentication_commands(self, commandParseTree):
"""
Check the Authentication commands which are deprecated
"""
logging.warning(("[{}] command is deprecated,"
" please use the advanced authentication policy command")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("set", "aaa", "preauthenticationparameter")
def check_aaa_preauth_params(self, commandParseTree):
"""
Rule filed of "set aaa preauthenticationparameter"
command is deprecated.
"""
if commandParseTree.keyword_exists('rule'):
logging.warning(("Client security expressions are deprecated"
" using this command [{}], please use the"
" advanced authentication policy command")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("add", "vpn", "sessionAction")
def check_vpn_sessionaction(self, commandParseTree):
"""
clientSecurity filed of "add vpn sessionAction"
command is deprecated.
"""
if commandParseTree.keyword_exists('clientSecurity'):
logging.warning(("Client security expressions are deprecated"
" using this command [{}], please use the"
" advanced authentication policy command")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("add", "vpn", "url")
def check_vpn_url(self, commandParseTree):
"""
SelfAuth SSO type is deprecated
"""
if commandParseTree.keyword_exists('ssotype'):
sso_type = commandParseTree.keyword_value("ssotype")[0].value.lower()
if sso_type == "selfauth":
logging.warning("Selfauth type is deprecated"
" in command [{}]".format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("add", "vpn", "portaltheme")
def check_vpn_portaltheme(self, commandParseTree):
"""
Default, X1, and Greenbubble portal themes are
deprecated
"""
if commandParseTree.keyword_exists('basetheme'):
base_theme = commandParseTree.keyword_value("basetheme")[0].value
if base_theme == "Default" or base_theme == "X1" \
or base_theme == "Greenbubble":
logging.warning(("Default, GreenBubble and X1 themes"
" are deprecated in command [{}],"
" please use RfWebUI theme or RfWebUI based custom theme")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("bind", "vpn", "vserver")
@common.register_for_cmd("bind", "vpn", "global")
def check_vpn_commands(self, commandParseTree):
"""
Default, X1, and Greenbubble portal themes are
deprecated
"""
if commandParseTree.keyword_exists('portaltheme'):
base_theme = commandParseTree.keyword_value("portaltheme")[0].value
if base_theme == "Default" or base_theme == "X1" \
or base_theme == "Greenbubble":
logging.warning(("Default, GreenBubble and X1 themes"
" are deprecated in command [{}],"
" please use RfWebUI theme or RfWebUI based custom theme")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("add", "dns", "action")
def check_dns_action(self, commandParseTree):
"""
Rewrite_response and DROP action types are
deprecated.
"""
action_type = commandParseTree.positional_value(1).value.lower()
if action_type == "rewrite_response":
logging.warning(("Rewrite_Response action type is deprecated in"
" command [{}], please use the replace_dns_answer_section"
" action type under Rewrite feature.")
.format(str(commandParseTree).strip()))
elif action_type == "drop":
logging.warning(("Drop action type is deprecated in"
" command [{}], please use the Drop"
" action type under Responder feature.")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("enable", "ns", "feature")
def check_ns_feature(self, commandParseTree):
"""
SC, PQ, HDOSP, and CF features are deprecated.
"""
features_to_remove = ["SC", "PQ", "HDOSP", "CF"]
num_of_enabled_features = commandParseTree.get_number_of_params()
for inx in range(num_of_enabled_features):
feature_node = commandParseTree.positional_value(inx)
feature_name = feature_node.value
if feature_name in features_to_remove:
logging.warning("SC, PQ, HDOSP, and CF features"
" are deprecated in command [{}], please"
" use the APPQOE, REWRITE, and RESPONDER features"
.format(str(commandParseTree).strip()))
break
return []

@common.register_for_cmd("add", "videooptimization", "pacingpolicy")
@common.register_for_cmd("add", "videooptimization", "pacingaction")
@common.register_for_cmd("add", "videooptimization", "pacingpolicylabel")
@common.register_for_cmd("bind", "videooptimization", "globalpacing")
@common.register_for_cmd("bind", "videooptimization", "pacingpolicylabel")
def check_deprecated_pacingcommands(self, commandParseTree):
"""
Check the videooptimization pacing commands
"""
if (commandParseTree.ot == "pacingpolicy"):
rule_expr = commandParseTree.keyword_value("rule")[0].value
if is_advanced_removed_expr_present(rule_expr):
commandParseTree.set_invalid()
return [commandParseTree]

logging.warning(("[{}] command is deprecated")
.format(str(commandParseTree).strip()))
return []

@common.register_for_cmd("add", "lsn", "appsattributes")
@common.register_for_cmd("add", "lsn", "appsprofile")
@common.register_for_cmd("add", "lsn", "client")
@common.register_for_cmd("add", "lsn", "group")
@common.register_for_cmd("add", "lsn", "httphdrlogprofile")
@common.register_for_cmd("add", "lsn", "ip6profile")
@common.register_for_cmd("add", "lsn", "logprofile")
@common.register_for_cmd("add", "lsn", "pool")
@common.register_for_cmd("add", "lsn", "rtspalgprofile")
@common.register_for_cmd("add", "lsn", "sipalgprofile")
@common.register_for_cmd("add", "lsn", "static")
@common.register_for_cmd("add", "lsn", "transportprofile")
@common.register_for_cmd("bind", "lsn", "appsprofile")
@common.register_for_cmd("bind", "lsn", "client")
@common.register_for_cmd("bind", "lsn", "group")
@common.register_for_cmd("bind", "lsn", "pool")
@common.register_for_cmd("set", "lsn", "parameter")
def check_lsn_commands(self, commandParseTree):
"""
Check the Authentication commands which are deprecated
"""
if (int(build_version.split(".")[0]) > 13):
logging.warning(("[{}] command is deprecated")
.format(str(commandParseTree).strip()))
return []


@common.register_class_methods
class Responder(CheckConfig):
Expand All @@ -1221,10 +1012,6 @@ def check_responder_action(self, commandParseTree):
commandParseTree, [2, "reasonPhrase", "headers"])
if commandParseTree.invalid:
return [commandParseTree]
action_type = commandParseTree.positional_value(1).value.lower()
if action_type == "noop":
logging.warning("NOOP action type is deprecated"
" for command [{}]".format(str(commandParseTree).strip()))
return []


Expand Down
10 changes: 4 additions & 6 deletions nspepi/nspepi2/config_check_main.py
View file
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
#!/usr/bin/env python

# Copyright 2021-2023 Citrix Systems, Inc. All rights reserved.
# Copyright 2021-2024 Citrix Systems, Inc. All rights reserved.
# Use of this software is governed by the license terms, if any,
# which accompany or are included with this software.

Expand All @@ -13,7 +13,7 @@

# Ensure that the version string conforms to PEP 440:
# https://www.python.org/dev/peps/pep-0440/
__version__ = "1.0"
__version__ = "1.1"

import re
import argparse
Expand Down Expand Up @@ -129,7 +129,7 @@ def check_config_file(infile, outfile, verbose):
def main():
desc = cleandoc(
"""
Checks whether invalid or deprecated config is present in input file
Checks whether invalid config is present in input file
""")
arg_parser = argparse.ArgumentParser(
prog="configCheck",
Expand All @@ -146,7 +146,7 @@ def main():
version='%(prog)s {}'.format(__version__))
arg_parser.add_argument(
'-B', '--buildVersion', default='13.1',
help="Build version for which invalid or depreacted commands"
help="Build version for which invalid commands"
" need to check")
try:
args = arg_parser.parse_args()
Expand All @@ -158,8 +158,6 @@ def main():
check_classic_configs.check_configs_init()
check_classic_configs.build_version = args.buildVersion
new_path = os.path.join(conf_file_path, "issues_" + conf_file_name)
deprecated_file_name = os.path.join(conf_file_path, "deprecated_" + conf_file_name)
setup_logging(deprecated_file_name, logging.WARNING)
with open(args.infile, 'r') as infile:
with open(new_path, 'w') as outfile:
check_config_file(infile, outfile, args.verbose)
Expand Down

0 comments on commit 925b37c

Please sign in to comment.