README v3.4.11 2025-06-12

1. General
   1.1 Extract the NED package
   1.2 Install the NED package
       1.2.1 Local install
       1.2.2 System install
   1.3 Configure the NED in NSO
2. Optional debug and trace setup
3. Dependencies
4. Sample device configuration
5. Built in live-status actions
6. Built in live-status show
7. Limitations
8. How to report NED issues and feature requests
9. How to rebuild a NED
10. Configure the NED to use ssh multi factor authentication
11. NED Secrets - Securing your Secrets

1. General

This document describes the oneaccess-oneos NED.

Additional README files bundled with this NED package

+---------------------------+------------------------------------------------------------------------------+
| Name                      | Info                                                                         |
+---------------------------+------------------------------------------------------------------------------+
| README-ned-settings.md    | Information about all run time settings supported by this NED.               |
+---------------------------+------------------------------------------------------------------------------+

Common NED Features

+---------------------------+-----------+------------------------------------------------------------------+
| Feature                   | Supported | Info                                                             |
+---------------------------+-----------+------------------------------------------------------------------+
| netsim                    | yes       | additional info                                                  |
|                           |           |                                                                  |
| check-sync                | yes       | additional info                                                  |
|                           |           |                                                                  |
| partial-sync-from         | yes       | additional info                                                  |
|                           |           |                                                                  |
| live-status actions       | yes       | additional info                                                  |
|                           |           |                                                                  |
| live-status show          | no        | additional info                                                  |
|                           |           |                                                                  |
| load-native-config        | yes       | additional info                                                  |
+---------------------------+-----------+------------------------------------------------------------------+

Verified target systems

+---------------------------+-----------------+--------+---------------------------------------------------+
| Model                     | Version         | OS     | Info                                              |
+---------------------------+-----------------+--------+---------------------------------------------------+
| oneaccess-one540          | ONEOS92-MULTI_F | ONEOS9 | additional info                                   |
|                           | T-V5.2R1E4_FT3  | 0      |                                                   |
+---------------------------+-----------------+--------+---------------------------------------------------+

1.1 Extract the NED package

It is assumed the NED package ncs-<NSO version>-oneaccess-oneos-<NED version>.signed.bin has already been downloaded from software.cisco.com.

In this instruction the following example settings will be used:

NSO version: 6.0
NED version: 1.0.1
NED package downloaded to: /tmp/ned-package-store

Extract the NED package and verify its signature:

> cd /tmp/ned-package-store
> chmod u+x ncs-6.0-oneaccess-oneos-1.0.1.signed.bin
> ./ncs-6.0-oneaccess-oneos-1.0.1.signed.bin

In case the signature can not be verified (for instance if no internet connection), do as below instead:
```
> ./ncs-6.0-oneaccess-oneos-1.0.1.signed.bin --skip-verification
```
The result of the extraction shall be a tar.gz file with the same name as the .bin file:
```
> ls *.tar.gz
ncs-6.0-oneaccess-oneos-1.0.1.tar.gz
```

1.2 Install the NED package

There are two alternative ways to install this NED package. Which one to use depends on how NSO itself is setup.

In the instructions below the following example settings will be used:

NSO version: 6.0
NED version: 1.0.1
NED download directory: /tmp/ned-package-store
NSO run time directory: ~/nso-lab-rundir

A prerequisite is to set the environment variable NSO_RUNDIR to point at the NSO run time directory:

> export NSO_RUNDIR=~/nso-lab-rundir

1.2.1 Local install

This section describes how to install a NED package on a locally installed NSO (see "NSO Local Install" in the NSO Installation guide).

It is assumed the NED package has been been unpacked to a tar.gz file as described in 1.1.

Untar the tar.gz file. This creates a new sub-directory named:oneaccess-oneos-<NED major digit>.<NED minor digit>:
```
> tar xfz ncs-6.0-oneaccess-oneos-1.0.1.tar.gz
> ls -d */
oneaccess-oneos-cli-1.0
```

Install the NED into NSO, using the ncs-setup tool:

> ncs-setup --package oneaccess-oneos-cli-1.0 --dest $NSO_RUNDIR

Open a NSO CLI session and load the new NED package like below:

> ncs_cli -C -u admin
admin@ncs# packages reload
reload-result {
    package oneaccess-oneos-cli-1.0
    result true
}

Alternatively the tar.gz file can be installed directly into NSO. Then skip steps 1 and 2 and do like below instead:

  > ncs-setup --package ncs-6.0-oneaccess-oneos-1.0.1.tar.gz --dest $NSO_RUNDIR
  > ncs_cli -C -u admin
  admin@ncs# packages reload
  reload-result {
    package oneaccess-oneos-cli-1.0
    result true
 }

Set the environment variable NED_ROOT_DIR to point at the NSO NED package:

> export NED_ROOT_DIR=$NSO_RUNDIR/packages/oneaccess-oneos-cli-1.0

1.2.2 System install

This section describes how to install a NED package on a system installed NSO (see "NSO System Install" in the NSO Installation Guide).

It is assumed the NED package has been been unpacked to a tar.gz file as described in 1.1.

Do a NSO backup before installing the new NED package:
```
> $NCS_DIR/bin/ncs-backup
```

Start a NSO CLI session and fetch the NED package:

> ncs_cli -C -u admin
admin@ncs# software packages fetch package-from-file \
          /tmp/ned-package-store/ncs-6.0-oneaccess-oneos-1.0.tar.gz
admin@ncs# software packages list
package {
 name ncs-6.0-oneaccess-oneos-1.0.tar.gz
 installable
}

Install the NED package (add the argument replace-existing if a previous version has been loaded):

admin@ncs# software packages install oneaccess-oneos-1.0
admin@ncs# software packages list
package {
 name ncs-6.0-oneaccess-oneos-1.0.tar.gz
 installed
}

Load the NED package

admin@ncs# packages reload
admin@ncs# software packages list
package {
  name ncs-6.0-oneaccess-oneos-cli-1.0
  loaded
}

1.3 Configure the NED in NSO

This section describes the steps for configuring a device instance using the newly installed NED package.

Start a NSO CLI session:
```
> ncs_cli -C -u admin
```

Enter configuration mode:

admin@ncs# configure
Entering configuration mode terminal
admin@ncs(config)#

Configure a new authentication group (my-group) to be used for this device:

admin@ncs(config)# devices authgroup group my-group default-map remote-name <user name on device> \
                   remote-password <password on device>

Configure a new device instance (example: dev-1):

admin@ncs(config)# devices device dev-1 address <ip address to device>
admin@ncs(config)# devices device dev-1 port <port on device>
admin@ncs(config)# devices device dev-1 device-type cli ned-id oneaccess-oneos-cli-1.0
admin@ncs(config)# devices device dev-1 state admin-state unlocked
admin@ncs(config)# devices device dev-1 authgroup my-group

admin@ncs(config)# devices device dev-1 protocol <ssh or telnet>

If configured protocol is ssh, do fetch the host keys now:
```
admin@ncs(config)# devices device dev-1 ssh fetch-host-keys
```
When connecting through a proxy using SSH or TELNET
Do as follows to setup to connect to a oneos device that resides behind a proxy or terminal server:
+-----+ A +-------+ B +-----+ | NCS | <--> | proxy | <--> | oneos | +-----+ +-------+ +-----+
Setup connection (A):
devices device address
devices device port
devices device device-type cli protocol <proxy proto - telnet or ssh>
devices authgroups group ciscogroup umap admin remote-name
devices authgroups group ciscogroup umap admin remote-password
devices device authgroup ciscogroup
Setup connection (B):
Define the type of connection to the device:
devices device ned-settings oneaccess-oneos proxy remote-connection <ssh|telnet>
Define login credentials for the device:
devices device ned-settings oneaccess-oneos proxy remote-name
devices device ned-settings oneaccess-oneos proxy remote-password
Define prompt on proxy server:
devices device ned-settings oneaccess-oneos proxy proxy-prompt
Define address and port of oneos device:
devices device ned-settings oneaccess-oneos proxy remote-address
devices device ned-settings oneaccess-oneos proxy remote-port
commit
Complete example config:
devices authgroups group jump-server default-map remote-name MYUSERNAME remote-password MYPASSWORD devices device oneos6-via-1234 address 1.2.3.4 port 22 devices device oneos6-via-1234 authgroup jump-server device-type cli ned-id oneaccess-oneos protocol ssh devices device oneos6-via-1234 connect-timeout 60 read-timeout 120 write-timeout 120 devices device oneos6-via-1234 state admin-state unlocked devices device oneos6-via-1234 ned-settings oneaccess-oneos proxy remote-connection telnet devices device oneos6-via-1234 ned-settings oneaccess-oneos proxy proxy-prompt ".*#" devices device oneos6-via-1234 ned-settings oneaccess-oneos proxy remote-address 5.6.7.8 devices device oneos6-via-1234 ned-settings oneaccess-oneos proxy remote-port 23 devices device oneos6-via-1234 ned-settings oneaccess-oneos proxy remote-name admin devices device oneos6-via-1234 ned-settings oneaccess-oneos proxy remote-password admin987
Finally commit the configuration
```
admin@ncs(config)# commit
```

Verify configuration, using a sync-from.

admin@ncs(config)# devices device dev-1 sync-from
result true

If the sync-from was not successful, check the NED configuration again.

2. Optional debug and trace setup

It is often desirable to see details from when and how the NED interacts with the device(Example: troubleshooting)

This can be achieved by configuring NSO to generate a trace file for the NED. A trace file contains information about all interactions with the device. Messages sent and received as well as debug printouts, depending on the log level configured.

NSO creates one separate trace file for each device instance with tracing enabled. Stored in the following location:

$NSO_RUNDIR/logs/ned-oneaccess-oneos-cli-1.0-<device name>.trace

Do as follows to enable tracing in one specific device instance in NSO:

Start a NSO CLI session:
```
> ncs_cli -C -u admin
```

Enter configuration mode:

admin@ncs# configure
Entering configuration mode terminal
admin@ncs(config)#

Enable trace raw:

admin@ncs(config)# devices device dev-1 trace raw
admin@ncs(config)# commit

Alternatively, tracing can be enabled globally affecting all configured device instances:

admin@ncs(config)# devices global-settings trace raw
admin@ncs(config)# commit

Configure the log level for printouts to the trace file:

admin@ncs(config)# devices device dev-1 ned-settings oneaccess-oneos logger \
                  level [debug | verbose | info | error]
admin@ncs(config)# commit

Alternatively the log level can be set globally affecting all configured device instances using this NED package.

admin@ncs(config)# devices device global-settings ned-settings oneaccess-oneos logger \
                  level [debug | verbose | info | error]
admin@ncs(config)# commit

The log level 'info' is used by default and the 'debug' level is the most verbose.

IMPORTANT: Tracing shall be used with caution. This feature does increase the number of IPC messages sent between the NED and NSO. In some cases this can affect the performance in NSO. Hence, tracing should normally be disabled in production systems.

An alternative method for generating printouts from the NED is to enable the Java logging mechanism. This makes the NED print log messages to common NSO Java log file.

$NSO_RUNDIR/logs/ncs-java-vm.log

Do as follows to enable Java logging in the NED

Start a NSO CLI session:
```
> ncs_cli -C -u admin
```

Enter configuration mode:

admin@ncs# configure
Entering configuration mode terminal
admin@ncs(config)#

Enable Java logging with level all from the NED package:

admin@ncs(config)# java-vm java-logging logger com.tailf.packages.ned.oneos \
                  level level-all
admin@ncs(config)# commit

Configure the NED to log to the Java logger

admin@ncs(config)# devices device dev-1 ned-settings oneaccess-oneos logger java true
admin@ncs(config)# commit

Alternatively Java logging can be enabled globally affecting all configured device instances using this NED package.

admin@ncs(config)# devices global-settings ned-settings oneaccess-oneos logger java true
admin@ncs(config)# commit

IMPORTANT: Java logging does not use any IPC messages sent to NSO. Consequently, NSO performance is not affected. However, all log printouts from all log enabled devices are saved in one single file. This means that the usability is limited. Typically single device use cases etc.

3. Dependencies

This NED has the following host environment dependencies:

Java 1.8 (NSO version < 6.2)
Java 17 (NSO version >= 6.2)
Gnu Sed

Dependencies for NED recompile:

Apache Ant
Bash
Gnu Sort
Gnu awk
Grep
Python3 (with packages: re, sys, getopt, subprocess, argparse, os, glob)

4. Sample device configuration

[edit devices device config]

admin@ncs% edit ?
Description: NCS copy of the device configuration
Possible completions:
  oneos:interface - Select an interface to configure
  oneos:ip        - IP configuration commands
admin@ncs% edit oneos:interface ?
Description: Select an interface to configure
Possible completions:
  Bvi              - Bridge Virtual routing interface
  GigabitEthernet  - IEEE 802.3
  atm              - ATM interface
  atm-aal5         - ATM interface
  dialer           - dialer interface
  dot11radio       - IEEE 802.11b or IEEE802.11a
  efm              - EFM interface
  ethernet         - IEEE 802.3
  fastethernet     - IEEE 802.3
  l2tunnel         - Interface l2tunnel
  loopback         - Loopback interface
  tunnel           - Tunnel interface
  virtual-access   - Interface virtual-access
  virtual-template - Interface virtual-template
admin@ncs% edit oneos:interface dot11radio 0/0.1
[ok][2015-11-10 10:34:04]

[edit devices device <device-name> config interface dot11radio 0/0.1]

admin@ncs% edit ?
Description: Select an interface to configure
Possible completions:
  bridge-group - Set bridge group
  dot11        - IEEE 802.11 config interface commands
  ip           - Interface IP configuration commands
  shutdown     - Shutdown the interface
  ssid         - service set identifier
admin@ncs% set ?
Description: Select an interface to configure
Possible completions:
  bridge-group - Set bridge group
  dot11        - IEEE 802.11 config interface commands
  ip           - Interface IP configuration commands
  shutdown     - Shutdown the interface
  ssid         - service set identifier
admin@ncs% exit
[ok][2015-11-10 10:34:39]

[edit devices device <device-name> config]
admin@ncs% edit oneos:i
Possible completions:
  oneos:interface - Select an interface to configure
  oneos:ip        - IP configuration commands
admin@ncs% edit oneos:ip ?
Description: IP configuration commands
Possible completions:
  dhcp - DHCP server/relay/client configuration
admin@ncs% edit oneos:ip dhcp ?
Description: DHCP server/relay/client configuration
Possible completions:
  pool - Configure DHCP address pool
admin@ncs% edit oneos:ip dhcp pool
Possible completions:
  <WORD> - Pool name
  POOL   -
  aaa    -
admin@ncs% edit oneos:ip dhcp pool POOL ?
Description: Configure DHCP address pool
Possible completions:
  default-router - Default routers
  dns-server     - DNS servers
  domain-name    - Domain name
  network        - Network number and mask
admin@ncs% edit oneos:ip dhcp pool POOL

5. Built in live-status actions

The NED has support for all operational oneaccess oneos commands by use of the 'devices device live-status exec any' action. For example:

admin@ncs(config-device-tel)# live-status exec any "show version"
result show version
Software version    : OneOS-pCPE-PPC_pi2-6.7.1
Software created on : 2021-08-31 08:48:23

To execute multiple commands, separate them with " ; " NOTE: Must be a white space on either side of the comma. For example:

admin@ncs(config-device-tel)# live-status exec any "show version ; show system hardware"
result show version
Software version    : OneOS-pCPE-PPC_pi2-6.7.1
Software created on : 2021-08-31 08:48:23
OA2501-1#show system hardware

 HARDWARE DESCRIPTION

  Device   : ONE2501
  CPU      : Freescale T1040E (1.1) - Security Engine - 8-port Ethernet switch

 Core Freq : 1200MHz  DDR Freq : 600MHz (1200 MT/s data rate)
 Core Complex Bus Freq : 500MHz   Platform Freq : 500MHz
 FMAN Freq : 500MHz   QMAN Freq : 250MHz
 CPLD Index : 2   CPLD Version : F0
 Physical Ram size :   2GiB
 Nand Flash size : 512MiB


 Secure Boot protection : no


 Local   : x Uplink :      ISDN :      Radio :      Usb :

 Local   : 2 x GIGABIT ETHERNET + 2 x SFP ETHERNET + SWITCH ETHERNET / 4 ports

OA2501-1#

Generally the command output parsing halts when the NED detects an operational or config prompt, however sometimes the command requests additional input, 'answer(s)' to questions.

   ned-settings oneaccess-oneos console extension

Using these settings it is possible to define a separate way of interacting with the device, ignoring the default behaviour of the ned.

Example ned-settings:

     devices device oneaccess-1
       ned-settings oneaccess-oneos console extension
         command CMD-CUSTOM "do something"
         command CMD-CUSTOM-ACCEPT "Y"
         command CMD-CUSTOM-ACTION "act upon pattern detected"
         pattern PAT-CUSTOM-ACCEPT "Warning: .+ Continue\? \[Y/N\]:"
         pattern PAT-CUSTOM-ERROR "this is an error"
         pattern PAT-CUSTOM-PMT "\\A[^(\\#|>) ]+(#|>)[ ]?$"
         pattern PAT-CUSTOM-PATTERN "some custom pattern"
         action ACT-CUSTOM
           init CMD-CUSTOM
           flush true
           state PAT-CUSTOM-ACCEPT sendCommand CMD-CUSTOM-ACCEPT next ACT-CUSTOM
           state PAT-CUSTOM-PATTERN sendCommand CMD-CUSTOM-ACTION next ACT-CUSTOM
           state PAT-CUSTOM-ACCEPT reportError null next ACT-CUSTOM
           state PAT-OPER-PMT next DONE
         !
       !
     !

Example executions:

     devices device oneaccess-1 live-status exec any ACT-CUSTOM

Example with multiple custom extensions:

     devices device oneaccess-1 live-status exec any "ACT-CUSTOM1 ; ACT-CUSTOM2 ; ACT-CUSTOM3"

6. Built in live-status show

NONE

7. Limitations

NONE

8. How to report NED issues and feature requests

Issues like bugs and errors shall always be reported to the Cisco NSO NED team through the Cisco Support channel:

The following information is required for the Cisco NSO NED team to be able to investigate an issue:

- A detailed recipe with steps to reproduce the issue.
- A raw trace file generated when the issue is reproduced.
- SSH/TELNET access to a device where the issue can be reproduced by the Cisco NSO NED team.
  This typically means both read and write permissions are required.
  Pseudo access via tools like Webex, Zoom etc is not acceptable.
  However, it is ok with device access through VPNs, jump servers etc though.

Do as follows to gather the necessary information needed for your device, here named 'dev-1':

Enable full debug logging in the NED

ncs_cli -C -u admin
admin@ncs# configure
admin@ncs(config)# devices device dev-1 ned-settings oneaccess-oneos logging level debug
admin@ncs(config)# commit

Configure the NSO to generate a raw trace file from the NED

admin@ncs(config)# devices device dev-1 trace raw
admin@ncs(config)# commit

If the NED already had trace enabled, clear it in order to submit only relevant information
Do as follows for NSO 6.4 or newer:
```
admin@ncs(config)# devices device dev-1 clear-trace
```
Do as follows for older NSO versions:
```
admin@ncs(config)# devices clear-trace
```
Run a compare-config to populate the trace with initial device config
```
admin@ncs(config)# devices device dev-1 compare-config
```
Reproduce the found issue using ncs_cli or your NSO service. Write down each necessary step in a reproduction report.
In addition to this, it helps if you can show how it should work by manually logging into the device using SSH/TELNET and type the relevant commands showing a successful operation.
Gather the reproduction report and a copy of the raw trace file containing data recorded when the issue happened.
Contact the Cisco support and request to open a case. Provide the gathered files together with access details for a device that can be used by the Cisco NSO NED when investigating the issue.

Requests for new features and extensions of the NED are handled by the Cisco NSO NED team when applicable. Such requests shall also go through the Cisco support channel.

The following information is required for feature requests and extensions:

Set the config on the real device including all existing dependent config and run sync-from to show it in the trace.
Run sync-from # devices device dev-1 sync-from
Attach the raw trace to the ticket
List the config you want implemented in the same syntax as shown on the device
SSH/TELNET access to a device that can be used by the Cisco NSO NED team for testing and verification of the new feature. This usually means that both read and write permissions are required. Pseudo access via tools like Webex, Zoom etc is not acceptable. However, it is ok with access through VPNs, jump servers etc as long as we can connect to the NED via SSH/TELNET.

9. How to rebuild a NED

To rebuild the NED do as follows:

> cd $NED_ROOT_DIR/src
> make clean all

When the NED has been successfully rebuilt, it is necessary to reload the package into NSO.

admin@ncs# packages reload

10. Configure the NED to use ssh multi factor authentication

This NED supports multi factor authentication (MFA) using the ssh authentication method 'keyboard-interactive'.

Some additional steps are required to enable the MFA support:

Verify that your NSO version supports MFA. This is configurable as additional settings in the authentication group used by the device instance.

Enter a NSO CLI and enter the following and do tab completion:

> ncs_cli -C -u admin
admin@ncs# show running-config devices authgroups group default default-map <tab>
Possible completions:
action-name                 The action to call when a notification is received.
callback-node               Invoke a standalone action to retrieve login credentials for managed devices on the 'callback-node' instance.
mfa                         Settings for handling multi-factor authentication towards the device
public-key                  Use public-key authentication
remote-name                 Specify device user name
remote-password             Specify the remote password
remote-secondary-password   Second password for configuration
same-pass                   Use the local NCS password as the remote password
same-secondary-password     Use the local NCS password as the remote secondary password
same-user                   Use the local NCS user name as the remote user name

If 'mfa' is displayed in the output like above, NSO has MFA support enabled. In case MFA is not supported it is necessary to upgrade NSO before proceeding.

Implement the authenticator executable. The MFA feature relies on an external executable to take care of the client part of the multi factor authentication. The NED will automatically call this executable for each challenge presented by the ssh server and expects to get a proper response in return.

The executable can be a simple shell script or a program implemented in any programming language.

The required behaviour is like this:

read one line from stdin The line passed from the NED will be a semi colon separated string containing the following info:
```
[<device name>;<user>;<password>;<opaque>;<ssh server name>;<ssh server instruction>;<ssh server prompt>;]
```
The elements for device name, user, password and opaque corresponds to what has been configured in NSO. The ssh server name, instruction and prompt are given by the ssh server during the authentication step.
Each individual element in the semi colon separated list is Base64 encoded.
Extract the challenge based on the contents above.
Print a response matching the challenge to stdout and exit with code 0
In case a matching response can not be given do exit with code 2

Below is a simple example of an MFA authenticator implemented in Python3:

#!/usr/bin/env python3
import sys
import base64

# This is an example on how to implement an external multi factor authentication handler
# that will be called by the NED upon a ssh 'keyboard-interactive' authentication
# The handler is reading a line from stdin with the following expected format:
#   [<device name>;<user>;<password>;<opaque>;<ssh server name>;<ssh server instruction>;<ssh server prompt>;]
# All elements are base64 encoded.

def decode(arg):
    return str(base64.b64decode(arg))[2:-1]

if __name__ == '__main__':
    query_challenges = {
        "admin@localhost's password: ":'admin',
        'Enter SMS passcode:':'secretSMScode',
        'Press secret key: ':'2'
    }
    # read line from stdin and trim brackets
    line = sys.stdin.readline().strip()[1:-1]
    args = line.split(';')
    prompt = decode(args[6])
    if prompt in query_challenges.keys():
        print(query_challenges[prompt])
        exit(0)
    else:
        exit(2)

Configure the authentication group used by the device instance to enable MFA. There are two configurables available:

executable The path to the external multi factor authentication executable (mandatory).
opaque Opaque data that will passed as a cookie element to the executable (optional).

> ncs_cli -C -u admin
admin@ncs# config
Entering configuration mode terminal
admin@ncs(config)# devices authgroups group <name> default-map mfa executable <path to the executable>
admin@ncs(config)# devices authgroups group <name> default-map mfa opaque <some opaque data>
admin@ncs(config)# commit

Try connecting to the device.

10.1 Trouble shooting

In case of connection problems the following steps can help for debugging:

Enable the NED trace in debug level:

> devices device dev-1 trace raw
> devices device dev-1 ned-settings oneaccess-oneos logger level debug
> commit

Try connect again

Inspect the generated trace file.

Verify that the ssh client is using the external authenticator executable:

using ssh external mfa executable: <configured path to executable>

Verify that the executable is called with the challenges presented by the ssh server:

calling external mfa executable with ssh server given name: '<name>', instruction: '<instruction>', prompt '<challenge>'

Check for any errors reported by the NED when calling the executable

ERROR: external mfa executable failed <....>

11. NED Secrets - Securing your Secrets

It is best practice to avoid storing your secrets (e.g. passwords and
shared keys) in plain-text, either on NSO or on the device. In NSO we
support multiple encrypted datatypes that are encrypted using a local
key, similarly many devices such as ONEOS supports automatically
encrypting all passwords stored on the device. 

Naturally, for security reasons, NSO in general has no way of
encrypting/decrypting passwords with the secret key on the
device. This means that if nothing is done about this we will
become out of sync once we write secrets to the device. Looking at
the oneaccess-oneos NED there is only 1 path that contain such secrets:

    // router bgp * / neighbor * password

In order to avoid becoming out of sync the NED reads back these elements
immediately after set and stores the encrypted value(s) in a special
`secrets` table in oper data. Later on, when config is read from the
device, the NED replaces all cached encrypted values with their plaintext
values; effectively avoiding all config diffs in this area. If the values
are changed on the device, the new encrypted value will not match the
cached pair and no replacement will take place. This is desired, since out
of band changes should be detected.

This handles the device-side encryption, but passwords are still unencrypted
in NSO. To deal with this we support using NSO-encrypted strings instead of
plaintext passwords in the NSO data model.

--- Handling auto-encryption

Let us say that we have password-encryption on and we want to write a new
password  to our device:
        router bgp 1
          neighbor 1.2.3.4
           password abc1234

This will be automatically encrypted by the device (some devices)

  password xAb[PDCO[fQDJhDfMIciONMedifAAB

But the secrets management will store this new encrypted value in our `secrets` table:

  admin@ncs# show devices device dev-1 ned-settings secrets
  ID                                      ENCRYPTED                         REGEX
  ---------------------------------------------------------------------------------
  oneos:router/bgp(1)/neighbor(1.2.3.4)/password   xAb[PDCO[fQDJhDfMIciONMedifAAB

  which means that compare-config or sync-from will not show any
  changes and will not result in any updates to CDB". In fact, we can
  still see the unencrypted value in the device tree:


   config
        router bgp 1
          neighbor 1.2.3.4
           password abc1234
    !
   !

--- Increasing security with NSO-side encryption

We have two alternatives, either we can manually encrypt our values using
one of the NSO-encrypted types (e.g `aes-256-cfb-128-encrypted-string`) and
set them to the tree, or we can recompile the NED to always encrypt secrets.

--- Setting encrypted value

Let us say we know that the NSO-encrypted string
  `$9$T963R76+wgaQuZCtcGC/Nreo75FigP+znmOln8XDFK0=` (`password`), we
can then set it in the device tree as normal

   password $9$T963R76+wgaQuZCtcGC/Nreo75FigP+znmOln8XDFK0=


when commiting this value it will be decrypted and the plaintext will be written to the device.
Unlike the previous example the plaintext is not visible in the device tree:

  config
        router bgp 1
          neighbor 1.2.3.4
           password $9$T963R76+wgaQuZCtcGC/Nreo75FigP+znmOln8XDFK0=
    !
   !

On the device side this plaintext value is of course encrypted
with the device key, and just as before we store it in our
`secrets` table:

admin@ncs# show devices device dev-1 ned-settings secrets
ID                                      ENCRYPTED                         REGEX
---------------------------------------------------------------------------------
 oneos:router/bgp(1)/neighbor(1.2.3.4)/password   xAb[PDCO[fQDJhDfMIciONMedifAAB

We can see that this corresponds to the value set on the device


--- Auto-encrypting passwords in NSO

To avoid having to pre-encrypt your passwords you can rebuild your NED in your OS
command shell specifying an encrypted type for secrets using a command like:

yourhost:~/oneaccess-oneos-cli-x.y$ NEDCOM_SECRET_TYPE="tailf:aes-cfb-128-encrypted-string" make -C src/ clean all

Or by adding the line `NED_EXTRA_BUILDFLAGS ?= NEDCOM_SECRET_TYPE=tailf:aes-cfb-128-encrypted-string`
in top of the `Makefile` located in <oneaccess-oneos-cli-x.y>/src directory.

Doing this means that even if the input to a passwordis a plaintext string, NSO will always
encrypt it, and you will never see plain text secrets in the device tree.

If we reload our example with the new NED all of the secrets are now encrypted:

admin@ncs# show running-config devices device dev-1 config username
devices device dev-1
 config
         router bgp 1
          neighbor 1.2.3.4
           password "$8$BVzY1FLE47Wum5WXokAVZ3UqaeJQt4s7ksGyiWKOLxGZIUrhp92KqBG4R2zINyMFl+L71TOk\naT8u3/l4L/p4Xg=="
 !
!

and if we create yet another password we get the desired result:


password $8$BVzY1FLE47Wum5WXokAVZ3UqaeJQt4s7ksGyiWKOLxGZIUrhp92KqBG4R2zINyMFl+L71TOk\naT8u3/l4L/p4Xg=



admin@ncs# show devices device dev-1 ned-settings secrets
ID                                      ENCRYPTED                               REGEX
---------------------------------------------------------------------------------------
oneos:router/bgp(1)/neighbor(1.2.3.4)/password   xAb[PDCO[fQDJhDfMIciONMedifAAB

PreviousREADME-ned-settings Nextonf-tapi_rc

Last updated 1 month ago

Was this helpful?

Table of contents

1. General

1.1 Extract the NED package

1.2 Install the NED package

1.2.1 Local install

1.2.2 System install

1.3 Configure the NED in NSO

devices device address

devices device port

devices device device-type cli protocol <proxy proto - telnet or ssh>

devices authgroups group ciscogroup umap admin remote-name

devices authgroups group ciscogroup umap admin remote-password

devices device authgroup ciscogroup

devices device ned-settings oneaccess-oneos proxy remote-connection <ssh|telnet>

devices device ned-settings oneaccess-oneos proxy remote-name

devices device ned-settings oneaccess-oneos proxy remote-password

devices device ned-settings oneaccess-oneos proxy proxy-prompt

devices device ned-settings oneaccess-oneos proxy remote-address

devices device ned-settings oneaccess-oneos proxy remote-port

commit

2. Optional debug and trace setup

3. Dependencies

4. Sample device configuration

5. Built in live-status actions

6. Built in live-status show

7. Limitations

8. How to report NED issues and feature requests

9. How to rebuild a NED

10. Configure the NED to use ssh multi factor authentication

10.1 Trouble shooting

11. NED Secrets - Securing your Secrets