Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 5.9.0 - Administration Guide

Preface Introduction The concepts of SPS The Welcome Wizard and the first login Basic settings User management and access control Managing SPS
Controlling SPS: reboot, shutdown Managing Safeguard for Privileged Sessions clusters Managing a high availability SPS cluster Upgrading SPS Managing the SPS license Accessing the SPS console Sealed mode Out-of-band management of SPS Managing the certificates used on SPS
General connection settings HTTP-specific settings ICA-specific settings RDP-specific settings SSH-specific settings Telnet-specific settings VMware Horizon View connections VNC-specific settings Indexing audit trails Using the Search (classic) interface Using the Search interface Searching session data on a central node in a cluster Advanced authentication and authorization techniques Reports The SPS RPC API The SPS REST API SPS scenarios Troubleshooting SPS Configuring external devices Using SCP with agent-forwarding Security checklist for configuring SPS Jumplists for in-product help Third-party contributions About us

Enabling SSH access to the SPS host

Purpose:

Exclusively for troubleshooting purposes, you can access the SPS host using SSH.

Completing the Welcome Wizard automatically disables SSH access to SPS. Re-enabling it allows you to connect remotely to the SPS host and login using the root user. The password of the root user is the one you provided in the Welcome Wizard. For details on how to change the root password from the web interface, see Changing the root password of SPS.

Caution:

Accessing the SPS host directly using SSH is not recommended or supported, except for troubleshooting purposes. In such case, the One Identity Support Team will give you exact instructions on what to do to solve the problem.

For security reasons, disable SSH access to SPS when it is not needed. For details, see "Enabling SSH access to the SPS host" in the Administration Guide.

The following encryption algorithms are configured on the local SSH service of SPS:

  • Key exchange (KEX) algorithms:

    diffie-hellman-group-exchange-sha256
  • Ciphers:

    aes256-ctr,aes128-ctr
  • Message authentication codes:

    hmac-sha2-512,hmac-sha2-256

SSH access is, by default, protected against brute-force attacks: after 20 unsuccessful login attempts, the offending IP is blocked from accessing the SSH service for ten minutes.

You can turn off brute force protection by unselecting the Protect against brute-force attacks option for the SSH server.

Steps:
  1. Navigate to Basic Settings > Local Services > SSH server.

    Figure 106: Basic Settings > Local Services > SSH server — Enabling remote SSH access to SPS

  2. Select the Enable option.

    NOTE:

    Remote SSH access is automatically disabled if Sealed mode is enabled. For details, see Sealed mode.

  3. Choose the authentication method for the remote SSH connections.

    • To enable password-based authentication, select the Enable password authentication option.

    • To enable public-key authentication, click in the Authorized keys field, click and upload the private keys of the users who can access and manage SPS remotely via SSH.

      One Identity recommends using 2048-bit RSA keys (or stronger).

  4. Choose an address and a port for the SSH server in the Listening addresses section.

    The available addresses correspond to the interface addresses configured in Basic Settings > Network > Interfaces. Only IPv4 addresses can be selected.

    To add multiple addresses, click .

  5. Optional step: To permit SSH acces only from selected subnets or IP addresses, select Restrict clients, click and enter the IP address and netmask of the allowed clients.

    Use an IPv4 address.

    To add multiple addresses, click .

  6. Click Commit.

Changing the root password of SPS

Purpose:

The root password is required to access SPS locally, or remotely via an SSH connection. Note that the password of the root user can be changed from the console menu as well. For details, see Accessing the SPS console.

Steps:
  1. Navigate to Basic Settings > Management > Change root password.

    Figure 107: Basic Settings > Management > Change root password — Changing the root password of SPS

  2. Enter the new password into the New root password and Confirm password fields.

    NOTE:

    SPS accepts passwords that are not longer than 150 characters. The following special characters can be used: !"#$%&'()*+,-./:;<=>?@[\]^-`{|}

  3. Click Commit.

Firmware update using SSH

Purpose:

In some cases, uploading large files over HTTP is not possible. In such cases, you can update the firmware using SSH. Complete the following steps.

Caution:

The recommended way to update the firmware is using the SPS web interface (see Upgrading SPS). Update the SPS firmware using SSH is only if you cannot update the firmware using the web interface. Note that updating using SSH may be removed from later versions of SPS.

Prerequisites:
Steps:
  1. Download the firmware file to your computer.

  2. Log in to SPS remotely using SSH, and select Shells > Core shell from the console menu.

  3. Copy the firmware to the SPS host, for example, into the /root/ directory.

    If you are copying the firmware to SPS using SCP and you issue the copy command on the client side and not within the core firmware, the root directory of the core firmware is: /mnt/firmware/root

  4. Install the firmware: /opt/scb/bin/firmwarectl install <path-to-firmware>

    This command installs the firmware into the first empty slot, and returns the value of the slot where the firmware has been installed.

  5. Check if you can upgrade to the new firmware, and resolve any errors before continuing: /opt/scb/bin/firmwarectl precheck <slot-number-of-the-firmware>

    In the returned values, "exitcode": 0 means that the precheck has finished without any errors. "exitcode": 1 means that errors have occurred, and the contents of "output": [] gives you a clue as to what is causing the problem.

  6. Activate the new firmware: /opt/scb/bin/firmwarectl activate <slot-number-of-the-firmware>

    Using the /opt/scb/bin/firmwarectl list command, you can check whether activation has been successful. In the returned values, look for your slot number and the value of "active":, it should say true. For example:

    ...
    "slot": 3,
    "precheck": true,
    "active": true,
    "boot_link": "mnt/boot-firmware/slot3",
    "core_link": "mnt/firmware/slot3",
    "branch": "5.6",
    "version": "5.6.0a",
    "current": false,
    ...		
  7. Reboot SPS: xcbclient self xcb_do_reboot

  8. If the upgrade is successful, delete any unused firmware: /opt/scb/bin/firmwarectl delete <slot-number-of-unused-firmware>

  9. Delete the firmware file you uploaded to SPS, it is not needed anymore: rm -fv /root/<firmware-file-you-uploaded>

Exporting and importing the configuration of SPS using the console

Purpose:

You can export/import the configuration of SPS (for manual archiving, or to migrate it to another SPS unit) from the console using the /opt/scb/bin/configbundle.py script.

NOTE:

You must run the /opt/scb/bin/configbundle.py script using the root user.

NOTE:

The configuration of your SPS may contain sensitive information. Make sure you delete any configuration export files that are not needed anymore.

Steps:
  1. Execute the following command to export the configuration of your SPS:

    /opt/scb/bin/configbundle.py create --bundle /<my destination folder>/bundle.tar.gz

    Where:

    • /opt/scb/bin/configbundle.py: The script you execute to export the configuration.

    • create: The option that lets you export a configuration.

    • --bundle: The option used to specify the bundle file.

    • /<my destination folder>/bundle.tar.gz: The path to the file where you wish to export the configuration.

      Replace <my destination folder> with the name of the folder where you wish to store the exported configuration.

  2. Execute the following command to import the configuration of your SPS:

    /opt/scb/bin/configbundle.py import --bundle /<my destination folder>/bundle.tar.gz

    Where:

    • /opt/scb/bin/configbundle.py: The script you execute to import the configuration.

    • import: The option that lets you import a configuration.

    • --bundle: The option used to specify the bundle file.

    • /<my destination folder>/bundle.tar.gz: The path to the file from which you wish to import the configuration.

      Replace <my destination folder> with the name of the folder where your configuration export file is stored.

Related Documents