From 131e61719165a3d47b043fe139a21dc1d83de0cf Mon Sep 17 00:00:00 2001 From: Jim Harris Date: Wed, 25 Nov 2020 22:27:55 +0000 Subject: [PATCH] nvmf: remove usage of "whitelist" NVMf subsystems can have certain hosts that are allowed. We were previously using the term "whitelist" to refer to those hosts. Replace that usage as part of removing this term from the rest of SPDK. Signed-off-by: Jim Harris Change-Id: I2878352d83f3911aa8b59629061b818c7f1e5c96 Reviewed-on: https://review.spdk.io/gerrit/c/spdk/spdk/+/5282 Community-CI: Broadcom CI Community-CI: Mellanox Build Bot Tested-by: SPDK CI Jenkins Reviewed-by: Shuhei Matsumoto Reviewed-by: Changpeng Liu --- doc/jsonrpc.md | 10 +++++----- include/spdk/nvmf.h | 10 +++++----- scripts/rpc.py | 2 +- scripts/rpc/nvmf.py | 10 +++++----- scripts/spdkcli/ui_node_nvmf.py | 6 +++--- 5 files changed, 19 insertions(+), 19 deletions(-) diff --git a/doc/jsonrpc.md b/doc/jsonrpc.md index e50ebb1933..cce92714ba 100644 --- a/doc/jsonrpc.md +++ b/doc/jsonrpc.md @@ -4892,7 +4892,7 @@ tgt_name | Optional | string | Parent NVMe-oF target name. serial_number | Optional | string | Serial number of virtual controller model_number | Optional | string | Model number of virtual controller max_namespaces | Optional | number | Maximum number of namespaces that can be attached to the subsystem. Default: 0 (Unlimited) -allow_any_host | Optional | boolean | Allow any host (`true`) or enforce allowed host whitelist (`false`). Default: `false`. +allow_any_host | Optional | boolean | Allow any host (`true`) or enforce allowed host list (`false`). Default: `false`. ana_reporting | Optional | boolean | Enable ANA reporting feature (default: `false`). ### Example @@ -5192,7 +5192,7 @@ Example response: ## nvmf_subsystem_add_host method {#rpc_nvmf_subsystem_add_host} -Add a host NQN to the whitelist of allowed hosts. +Add a host NQN to the list of allowed hosts. ### Parameters @@ -5230,7 +5230,7 @@ Example response: ## nvmf_subsystem_remove_host method {#rpc_nvmf_subsystem_remove_host} -Remove a host NQN from the whitelist of allowed hosts. +Remove a host NQN from the list of allowed hosts. ### Parameters @@ -5268,14 +5268,14 @@ Example response: ## nvmf_subsystem_allow_any_host method {#rpc_nvmf_subsystem_allow_any_host} -Configure a subsystem to allow any host to connect or to enforce the host NQN whitelist. +Configure a subsystem to allow any host to connect or to enforce the host NQN list. ### Parameters Name | Optional | Type | Description ----------------------- | -------- | ----------- | ----------- nqn | Required | string | Subsystem NQN -allow_any_host | Required | boolean | Allow any host (`true`) or enforce allowed host whitelist (`false`). +allow_any_host | Required | boolean | Allow any host (`true`) or enforce allowed host list (`false`). tgt_name | Optional | string | Parent NVMe-oF target name. ### Example diff --git a/include/spdk/nvmf.h b/include/spdk/nvmf.h index 366f86ad1b..8ef78feb45 100644 --- a/include/spdk/nvmf.h +++ b/include/spdk/nvmf.h @@ -204,7 +204,7 @@ void spdk_nvmf_tgt_write_config_json(struct spdk_json_write_ctx *w, struct spdk_ * Begin accepting new connections at the address provided. * * The connections will be matched with a subsystem, which may or may not allow - * the connection based on a subsystem-specific whitelist. See + * the connection based on a subsystem-specific list of allowed hosts. See * spdk_nvmf_subsystem_add_host() and spdk_nvmf_subsystem_add_listener() * * \param tgt The target associated with this listen address. @@ -507,7 +507,7 @@ int spdk_nvmf_subsystem_disconnect_host(struct spdk_nvmf_subsystem *subsystem, * * \param subsystem Subsystem to modify. * \param allow_any_host true to allow any host to connect to this subsystem, - * or false to enforce the whitelist configured with spdk_nvmf_subsystem_add_host(). + * or false to enforce the list configured with spdk_nvmf_subsystem_add_host(). * * \return 0 on success, or negated errno value on failure. */ @@ -520,7 +520,7 @@ int spdk_nvmf_subsystem_set_allow_any_host(struct spdk_nvmf_subsystem *subsystem * \param subsystem Subsystem to query. * * \return true if any host is allowed to connect to this subsystem, or false if - * connecting hosts must be in the whitelist configured with spdk_nvmf_subsystem_add_host(). + * connecting hosts must be in the list configured with spdk_nvmf_subsystem_add_host(). */ bool spdk_nvmf_subsystem_get_allow_any_host(const struct spdk_nvmf_subsystem *subsystem); @@ -647,7 +647,7 @@ const struct spdk_nvme_transport_id *spdk_nvmf_subsystem_listener_get_trid( * * \param subsystem Subsystem to allow dynamic listener assignment. * \param allow_any_listener true to allow dynamic listener assignment for - * this subsystem, or false to enforce the whitelist configured during + * this subsystem, or false to enforce the list configured during * subsystem setup. */ void spdk_nvmf_subsystem_allow_any_listener( @@ -660,7 +660,7 @@ void spdk_nvmf_subsystem_allow_any_listener( * \param subsystem Subsystem to query. * * \return true if this subsystem allows dynamic management of listen address list, - * or false if only allows addresses in the whitelist configured during subsystem setup. + * or false if only allows addresses in the list configured during subsystem setup. */ bool spdk_nvmf_subsytem_any_listener_allowed( struct spdk_nvmf_subsystem *subsystem); diff --git a/scripts/rpc.py b/scripts/rpc.py index d4edfdc1a8..9a16abb7c1 100755 --- a/scripts/rpc.py +++ b/scripts/rpc.py @@ -1892,7 +1892,7 @@ Format: 'user:u1 secret:s1 muser:mu1 msecret:ms1,user:u2 secret:s2 muser:mu2 mse p.add_argument("-d", "--model-number", help=""" Format: 'mn' etc Example: 'SPDK Controller'""", default='SPDK bdev Controller') - p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce host NQN whitelist)") + p.add_argument("-a", "--allow-any-host", action='store_true', help="Allow any host to connect (don't enforce allowed host NQN list)") p.add_argument("-m", "--max-namespaces", help="Maximum number of namespaces allowed", type=int, default=0) p.add_argument("-r", "--ana-reporting", action='store_true', help="Enable ANA reporting feature") diff --git a/scripts/rpc/nvmf.py b/scripts/rpc/nvmf.py index 2cfdaf6a91..b7e9d9cbd8 100644 --- a/scripts/rpc/nvmf.py +++ b/scripts/rpc/nvmf.py @@ -237,7 +237,7 @@ def nvmf_create_subsystem(client, tgt_name: name of the parent NVMe-oF target (optional). serial_number: Serial number of virtual controller. model_number: Model number of virtual controller. - allow_any_host: Allow any host (True) or enforce allowed host whitelist (False). Default: False. + allow_any_host: Allow any host (True) or enforce allowed host list (False). Default: False. max_namespaces: Maximum number of namespaces that can be attached to the subsystem (optional). Default: 0 (Unlimited). ana_reporting: Enable ANA reporting feature. Default: False. @@ -459,7 +459,7 @@ def nvmf_subsystem_remove_ns(client, nqn, nsid, tgt_name=None): def nvmf_subsystem_add_host(client, nqn, host, tgt_name=None): - """Add a host NQN to the whitelist of allowed hosts. + """Add a host NQN to the list of allowed hosts. Args: nqn: Subsystem NQN. @@ -479,7 +479,7 @@ def nvmf_subsystem_add_host(client, nqn, host, tgt_name=None): def nvmf_subsystem_remove_host(client, nqn, host, tgt_name=None): - """Remove a host NQN from the whitelist of allowed hosts. + """Remove a host NQN from the list of allowed hosts. Args: nqn: Subsystem NQN. @@ -499,11 +499,11 @@ def nvmf_subsystem_remove_host(client, nqn, host, tgt_name=None): def nvmf_subsystem_allow_any_host(client, nqn, disable, tgt_name=None): - """Configure a subsystem to allow any host to connect or to enforce the host NQN whitelist. + """Configure a subsystem to allow any host to connect or to enforce the host NQN list. Args: nqn: Subsystem NQN. - disable: Allow any host (true) or enforce allowed host whitelist (false). + disable: Allow any host (true) or enforce allowed host list (false). tgt_name: name of the parent NVMe-oF target (optional). Returns: diff --git a/scripts/spdkcli/ui_node_nvmf.py b/scripts/spdkcli/ui_node_nvmf.py index 1b25298d12..2cf183cb0f 100644 --- a/scripts/spdkcli/ui_node_nvmf.py +++ b/scripts/spdkcli/ui_node_nvmf.py @@ -83,8 +83,8 @@ class UINVMfSubsystems(UINode): serial_number - Example: 'SPDK00000000000001'. max_namespaces - Optional parameter. Maximum number of namespaces allowed to added during active connection - allow_any_host - Optional parameter. Allow any host to connect (don't enforce host NQN - whitelist) + allow_any_host - Optional parameter. Allow any host to connect (don't enforce allowed host NQN + list) """ allow_any_host = self.ui_eval_param(allow_any_host, "bool", False) max_namespaces = self.ui_eval_param(max_namespaces, "number", 0) @@ -254,7 +254,7 @@ class UINVMfSubsystemHosts(UINode): nqn=self.parent.subsystem.nqn, host=host) def ui_command_create(self, host): - """Add a host NQN to the whitelist of allowed hosts. + """Add a host NQN to the list of allowed hosts. Args: host: Host NQN to add to the list of allowed host NQNs