Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.1.0 - Administration Guide

Preface Introduction The concepts of One Identity Safeguard for Privileged Sessions (SPS) The Welcome Wizard and the first login Basic settings
Supported web browsers and operating systems The structure of the web interface Network settings Configuring date and time System logging, SNMP and e-mail alerts Configuring system monitoring on SPS Data and configuration backups Archiving and cleanup Forwarding data to third-party systems Joining to One Identity Starling
User management and access control Managing One Identity Safeguard for Privileged Sessions (SPS)
Controlling One Identity Safeguard for Privileged Sessions (SPS): reboot, shutdown Managing Safeguard for Privileged Sessions (SPS) clusters Managing a High Availability One Identity Safeguard for Privileged Sessions (SPS) cluster Upgrading One Identity Safeguard for Privileged Sessions (SPS) Managing the One Identity Safeguard for Privileged Sessions (SPS) license Accessing the One Identity Safeguard for Privileged Sessions (SPS) console Sealed mode Out-of-band management of One Identity Safeguard for Privileged Sessions (SPS) Managing the certificates used on One Identity Safeguard for Privileged Sessions (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 interface Advanced authentication and authorization techniques Reports The One Identity Safeguard for Privileged Sessions (SPS) RPC API The One Identity Safeguard for Privileged Sessions (SPS) REST API One Identity Safeguard for Privileged Sessions (SPS) scenarios Troubleshooting One Identity Safeguard for Privileged Sessions (SPS) Configuring external devices Using SCP with agent-forwarding Security checklist for configuring One Identity Safeguard for Privileged Sessions (SPS) Jumplists for in-product help LDAP user and group resolution in SPS Appendix: Deprecated features

Configuring SPP for Passwords-initiated workflow

To configure SPP to use the joined SPS in Passwords-initiated (SPP-initiated) workflows, complete the following steps. For details on the workflow, see Using SPS with SPP - overview.

Prerequisites

To configure SPP for Passwords-initiated workflow

  1. On SPP, assign the managed networks for sessions management.

    1. Navigate to Administrative Tools > Settings > Cluster > Managed Networks.

    2. Add the network you want to monitor with SPS and choose the SPS appliance for the Sessions Managed By field.

  2. Select the SPS for the access request policy.

    1. Navigate to Administrative Tools > Entitlements > Access Request Policies > (create or edit a policy).

    2. On the Session Settings tab of the selected policy, select the SPS Connection Policy. The IP address of the cluster master is displayed first followed by the SPS Connection Policy name (safeguard_default by default).

Joining SPS to SPP

You can join your One Identity Safeguard for Privileged Sessions (SPS) deployment to your One Identity Safeguard for Privileged Passwords (SPP) deployment.

IMPORTANT: Joining your SPS and SPP appliances is an action that you cannot undo.

If the primary IP address of your SPS or SPP changes, you must repeat this procedure to rejoin the clusters.

Prerequisites
  • Your SPS deployment must be a SPS cluster (not a high-availability cluster, but a Central Management cluster). Even if your SPS deployment consists of a single, standalone node, you must convert it to the Central Management node of its own single-node cluster. For details, see Managing Safeguard for Privileged Sessions (SPS) clusters.

    Configuration synchronization must be enabled between the nodes of the SPS cluster. This is required so SPP entitlements work properly for each SPS node.

    NOTE:

    If you have multiple standalone SPS appliances, consider joining them to a cluster before joining SPP. In general, One Identity recommends creating a cluster if the nodes can use a common configuration, or later you might want to centrally search the data of every node. Creating a cluster from the SPS nodes after joining SPP is problematic and should be avoided.

  • You will need the primary IP address or the hostname of your SPP deployment that SPS can use to access SPP. Only IPv4 addresses are supported.

  • You will need the username and password to an SPP account that has "Appliance" and "Operations" permissions.

  • Verify that your SPS policies do not contain the safeguard_default string in their names. During the join process, SPS automatically creates and configures several policies and plugins. The name of these policies usually contains the string safeguard_default. Existing policies with such names will be overwritten.

  • The SPP and SPS nodes must be able to communicate on the tcp 8649 port. If needed, update your firewall policies.

  • During the join process, SPS must be able to access SPP using HTTPS on the tcp 443 port. This is required only once during the join process. If needed, update your firewall policies.

To join your SPS deployment to SPP

  1. (Optional) Create a configuration backup of SPS. For details, see Creating configuration backups.

  2. (Optional) Create a configuration backup of SPP. For details, see the Safeguard for Privileged Passwords Administration Guide, Backup and Retention settings.

  3. Login to the Central Management node of your SPS cluster. This node has Central Management listed in the Basic Settings > Cluster management > Roles field.

    Figure 308: Basic Settings > Cluster management — Joining SPS to SPP

  4. Navigate to Basic Settings > Cluster management > Join to SPP cluster and enter the primary IP address of SPP into the IPv4 address or hostname of SPP to join field. Only IPv4 addresses are supported.

  5. Click Join. Wait until you are redirected to SPP.

  6. Login to SPP. Wait until you are redirected to SPS.

  7. Wait until SPS creates and configures the policies and plugins required for the joint operation of SPS and SPP. This step can usually take up to a minute.

  8. You will receive a message:

    • If the join is unsuccessful, this message displays: Request failed. Check the credentials and the IP address you provided. For details on resolving errors, see SPP to SPS join issues and SPP to SPS join error resolution

    • If the join is successful, this message displays: SPS successfully joined to SPP. SPP automatically closes any open access requests.

  9. Log out from the SPS web interface.

Caution:

If the primary IP address of your SPS or SPP changes, you must repeat this procedure to rejoin the clusters.

Troubleshooting the SPS to SPP join

SPP to SPS join error resolution

Common join error resolutions follow which may occur when joining SPS (SPP) to One Identity Safeguard for Privileged Sessions (SPS).

Typo in SPP's address, the address is not reachable
  • Error: The browser reports errors when SPS redirects to SPP's login page, for example, This site can’t be reached. The exact error message depends on the browser.

  • Resolution: Click the Back button of the browser and enter the correct address into the Pv4 address or hostname of SPP to join field.

Typo in SPP's address, the address is alive, but not an SPP
  • Error: After clicking the Join button, a web site other than SPP's Login interface is displayed.

  • Resolution: Click the Back button of the browser and enter the correct address into the Pv4 address or hostname of SPP to join field.

SPP's HTTPS certificate does not match its IP address or hostnam
  • Error message: Error joining to SPP: SPS has failed to join to SPP. For more information, see the error details. (JoinFailed)

  • Raw error:

    {
      "response": "Error sending request: SSLError: HTTPSConnectionPool(host='examplespp.company', port=443): Max retries exceeded with url: /service/core/v3/Cluster/SessionModules (Caused by SSLError(CertificateError(\"hostname 'examplespp.company' doesn't match '192.0.2.123'\",),))",
      "status": null,
      "url": "https://examplespp.company/service/core/v3/Cluster/SessionModules"
    }
  • Resolution:

    • If SPP's certificate contains SPP's IPv4 address in the Common Name or subjectAltName field, then enter that IP address when joining SPS to SPP.

    • If SPP's certificate contains only its DNS name in the Common Name or subjectAltName field, then use that hostname when joining SPS to SPP.

    • Otherwise, set up an SSL server certificate for SPP which matches its IP address in the certificate's Common Name or subjectAltNamefields (see SSL Certificates in the Safeguard Administration Guide) and retry joining. Wait about five minutes to let the timeout of the failed join request expire before starting a new join request after a failed incomplete one. (Alternatively, see Reversing the SPP to SPS join in the Safeguard Administration Guide.)

Typo in SPP credentials
  • Error: Login to the SPP web interface fails.

  • Raw error:

    {
            "error": "invalid_request",
            "error_description": "Access denied.",
            "success": false
        }
  • Resolution: Make sure that the correct username and password are entered in the SPP username: and SPP password: prompts.
SPP user has insufficient permission
  • Error message: Error joining to SPP: SPS has failed to join to SPP. For more information, see the error details. (JoinFailed)

     Authorization is required for this request.
    
           Code: 60108
           URL: https://192.0.2.123/service/core/v3/Cluster/SessionModules
           Status: 403
  • Resolution: When SPS redirects to SPP's Login interface, then login as an SPP user has "Appliance" and "Operations" permissions.
SPS is already joined to SPP
  • Error message: Error joining to SPP: SPS has failed to join to SPP. For more information, see the error details. (JoinFailed)

    The session connection has a missing, invalid, or non-unique
    value [ NodeId ].
    
           Code: 60657
           URL: https://192.0.2.123/service/core/v3/Cluster/SessionModules
           Status: 400
  • Resolution: See Reversing the SPP to SPS join in the Safeguard Administration Guide.
Joining takes too long (more than five minutes)
  • ERROR: Request to https://192.0.2.123/service/a2a/v2/PsmValidation failed, response (HTTP 403):

        {
            "Code": 60108,
            "Message": "Authorization is required for this request.",
            "InnerError": null
        }
  • Resolution: Make sure that SPS is not overloaded and try joining again.

SPP to SPS join issues

In addition to the monitoring tools in SPP, you can use the SPP to SPS join issues during the join process. Several SPS tools are described below.

Join process fails and real-time monitoring

If the join process fails for any reason, consult the system logs.

To view the Safeguard for Privileged Sessions logs, navigate to Basic Settings | Troubleshooting | View log files.

To show only the logs for the join process:

  1. Select a Logtype of syslog.
  2. Select the Day; today is the default.
  3. In the Show only messages containing text box, enter SPP-join.

Use the buttons at the bottom of the dialog to perform the following tasks:

  • To download the log file, click Download.
  • To follow the current log messages real-time, click Tail. The latest logs will update in a browser window while you interact with the join process.
  • To display the log messages, click View.

To increase the level of detail in the log, enable debug level logging at Basic Settings | Management | Debug logging | Enable debug logs.

Join successful but connections do not work

When SPP and SPS report a successful join, but the connections don't work, view the SPS connection logs.

In Safeguard for Privileged Sessions, navigate to Basic Settings | Troubleshooting | View log files.

To show only the logs for the join process:

  1. Select a Logtype of ssh or rdp.
  2. Select the Day (today is the default).
  3. In the Show only messages containing text box, enter SPP-join.

To change the verbosity level of SPS, complete the following steps in Safeguard for Privileged Sessions:

  1. Navigate to the Global Options page of the traffic for which you want to change the log level. For example, go to SSH Control | Global Options to change the log level of SSH traffic, RDP Control | Global Options for remote desktop traffic, and so on.
  2. Select the desired log level from the Verbosity level field. The verbosity level ranges from 1 (no logging) to 10 (extremely detailed), with level 4 being the default normal level.

CAUTION: High verbosity levels generate a very large amount of log messages and might result in a very high load on the machine. Log levels set around 9 to 10, may result in logs with highly sensitive data, for example, passwords in plain text format.

Testing network issues

You can use the Diagnostics tools of SPP and SPS to test network issues. The following commands are available:

  • ping: Sends a simple message to the specified host to test network connectivity.
  • traceroute: Sends a simple message from SPS to the specified host and displays all hosts on the path of the message. It is used to trace the path the message travels between the hosts.
  • connect: Attempts to connect the specified host using the specified port. It is used to test the availability or status of an application on the target host.

To execute one of the above commands on SPS, see Network troubleshooting.

To execute one of the above commands on SPP, see Diagnostics tools of SPP.

Creating an SPS Support Bundle

If you have an issue which needs Support assistance, you may be asked to provide an SPS Support Bundle. To collect system-state information (also known as a debug bundle) in One Identity Safeguard for Privileged Sessions, see Collecting logs and system information for error reporting.

Configuring advanced routing on Linux

The following describes how to configure a Linux-based router to redirect selected traffic to One Identity Safeguard for Privileged Sessions (SPS) instead of its original destination. This procedure should work on most modern Linux-based routers, including Check Point firewalls.

Prerequisites

The router must have the iptables and ip tools installed.

To configure a Linux-based router to redirect selected traffic to SPS instead of its original destination

  1. Create the packet filter rules that will mark the connections to be sent to SPS using the CONNMARK feature of iptables. Mark only those connections that must be redirected to SPS.

    # iptables -t mangle -I PREROUTING -i <interface-facing-the-clients> -p tcp -d <network-of-the-servers> --dport <port-to-access> -j CONNMARK --set-mark 1
    Example: Setting up a connection mark for Linux policy routing

    For example, if the network interface of the router that faces the clients is called eth0, the servers are located in the 10.0.0.0/24 subnet, and the clients access the servers using port 3389 (the default port of the RDP protocol), then this command looks like:

    # iptables -t mangle -I PREROUTING -i eth0 -p tcp -d 10.0.0.0/24 --dport 3389 -j CONNMARK --set-mark 1
  2. Create a rule that redirects the answers of the servers to SPS. That way both the client-to-server and the server-to-client traffic is routed to SPS.

    NOTE:

    This step is only required if you want to use Source NAT (IP Spoofing) instead of SPS’s address towards the monitored servers.

    Figure 309: Control > Connections — Using SNAT

    # iptables -t mangle -I PREROUTING -i <interface-facing-the-servers> -p tcp -s <network-of-the-servers> --sport <port-to-access> -j CONNMARK --set-mark 1
  3. Convert the CONNMARK marks to MARK:

    # iptables -t mangle -A PREROUTING ! -i <interface-facing-the-scb> -m connmark --mark 1 -j MARK --set-mark 1 

    Caution:

    This rule must be placed after the CONNMARK rules.

  4. Add the table name to the /etc/iproute2/rt_tables of the router. Use the following format (for details on routing tables, see for example the Guide to IP Layer Network Administration with Linux):

    103 scb
  5. Create a routing table that has a single entry with a default route to SPS:

    # /sbin/ip route add default via <ip-address-of-SPS> table scb
  6. Create a routing rule that selects the routing table called scb, if the connection is marked.

    # /sbin/ip rule add from all fwmark 1 table scb
  7. If SPS is configured to spoof the IP address of the clients on the server side (that is, the SNAT > Use original IP address of the client option of the connection policies is selected), enable spoofing on the router for the interface connected to SPS.

    # echo 0 > /proc/sys/net/ipv4/conf/<interface-facing-SPS>/rp_filter
    # echo 0 > /proc/sys/net/ipv4/conf/all/rp_filter
    Expected result

    The traffic from the clients targeting the specified port of the servers is redirected to SPS. Therefore, SPS can be configured to control and audit this traffic.

Related Documents