From a0a4ba93ca98cb9bb8c3125eb68bfd45ca40ff25 Mon Sep 17 00:00:00 2001 From: Matej Sramcik Date: Thu, 19 Oct 2023 10:08:12 +0200 Subject: [PATCH 1/1] Replace whitelist with allowlist Replaced all usages of whitelist as its considered non-technical term with allowlist. JIRA: NETCONF-1185 Change-Id: Id6f827ae1b1fb4c2c3e52e69ec2c60ab3c19b25d Signed-off-by: Matej Sramcik --- .../netconf/callhome/mount/CallhomeStatusReporter.java | 6 +++--- .../callhome/mount/IetfZeroTouchCallHomeServerProvider.java | 2 +- docs/user-guide.rst | 6 +++--- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/CallhomeStatusReporter.java b/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/CallhomeStatusReporter.java index abd8ad685d..4b1eb3d069 100644 --- a/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/CallhomeStatusReporter.java +++ b/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/CallhomeStatusReporter.java @@ -276,7 +276,7 @@ final class CallhomeStatusReporter implements DataTreeChangeListener, Stat return rxTransaction.read(LogicalDatastoreType.OPERATIONAL, IetfZeroTouchCallHomeServerProvider.ALL_DEVICES) .get().orElse(null); } catch (ExecutionException | InterruptedException e) { - LOG.error("Error trying to read the whitelist devices", e); + LOG.error("Error trying to read the allowlist devices", e); return null; } } @@ -298,7 +298,7 @@ final class CallhomeStatusReporter implements DataTreeChangeListener, Stat keyString = device.getSshHostKey(); } if (keyString == null) { - LOG.info("Whitelist device {} does not have a host key, skipping it", device.getUniqueId()); + LOG.info("Allowlist device {} does not have a host key, skipping it", device.getUniqueId()); continue; } @@ -319,7 +319,7 @@ final class CallhomeStatusReporter implements DataTreeChangeListener, Stat } } - LOG.error("No match found for the failed auth device (should have been filtered by whitelist). Key: {}", + LOG.error("No match found for the failed auth device (should have been filtered by allowlist). Key: {}", sshKey); } diff --git a/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/IetfZeroTouchCallHomeServerProvider.java b/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/IetfZeroTouchCallHomeServerProvider.java index c70b0a91a3..bb1b327915 100644 --- a/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/IetfZeroTouchCallHomeServerProvider.java +++ b/apps/callhome-provider/src/main/java/org/opendaylight/netconf/callhome/mount/IetfZeroTouchCallHomeServerProvider.java @@ -170,7 +170,7 @@ public final class IetfZeroTouchCallHomeServerProvider readAndUpdateStatus(confDevice); } } catch (ExecutionException | InterruptedException e) { - LOG.error("Error trying to read the whitelist devices", e); + LOG.error("Error trying to read the allowlist devices", e); } } diff --git a/docs/user-guide.rst b/docs/user-guide.rst index 74bb5e0371..48c2266a84 100644 --- a/docs/user-guide.rst +++ b/docs/user-guide.rst @@ -1309,9 +1309,9 @@ Configure device to connect over SSH protocol Netconf Call Home Server uses device provided SSH server key (host key) to identify device. The pairing of name and server key is configured in ``/odl-netconf-callhome-server:netconf-callhome-server/allowed-devices``. -This list is colloquially called a whitelist. +This list is colloquially called a allowlist. -If the Call-Home Server finds the SSH host key in the whitelist, it continues +If the Call-Home Server finds the SSH host key in the allowlist, it continues to negotiate a NETCONF connection over an SSH session. If the SSH host key is not found, the connection between the Call Home server and the device is dropped immediately. In either case, the device that connects to the Call home server @@ -1570,7 +1570,7 @@ available for network management. Rogue Devices ''''''''''''' -Devices which are not on the whitelist might try to connect to the Call-Home Server. In +Devices which are not on the allowlist might try to connect to the Call-Home Server. In these cases, the server will keep a record by instantiating an operational device. There will be no corresponding config device for these rogues. They can be identified readily because their device id, rather than being user-supplied, will be of the form -- 2.36.6