Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 5.8.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


SPS can index the contents of audit trails, making the records of privileged users' activities easily searchable.

Audit trails contain user activity data recorded from terminal sessions (such as SSH and Telnet) and graphical protocols (such as RDP, Citrix ICA, and VNC). Examples of data recorded in audit trails are: mouse activity, keystrokes, and so on. Using its own indexer service or one or more external indexers, SPS determines elements of the content visible on the user's screen at a given point in time. Screen content elements include commands, window titles, IP addresses, user names, and so on.

The indexer generates the following types of output as a result of processing the audit trail files:

  • text

  • screenshot files

  • replayable video files

SPS then takes the output of indexing and breaks that down into searchable units.

Indexing audit trail files and the process overview that follows describe how indexing works at a high level:

Figure 7: Indexing audit trail files

  1. SPS monitors and records the protocol traffic in the audited connections passing through SPS. Protocol traffic data is recorded in audit trail files.

  2. Once a connection has been closed, SPS sends the audit trail files to the indexer.

  3. The indexer parses the contents of the audit trail files, and builds an "inventory" of the privileged user's activity data based on what appeared on their screen.

    In the case of a terminal session, screen content corresponds to the activity data that is captured in a terminal window. In the case of graphical protocols, screen content is whatever is visible in the graphical user interface of the applications the user is interacting with. In the latter case, the indexer's Optical Character Recognition (OCR) engine extracts text that appeared on the screen (for example, window titles).

  4. The indexer returns the information extracted from the parsed audit trail files to SPS.

  5. SPS processes the outcome of parsing and OCR-ing done in the previous phase and makes the data searchable.

  6. Once indexed, the contents of the audit trails can be searched from SPS's web interface.

For details on how to configure SPS's internal indexer or one or more external indexers, see Indexing audit trails.

Supported protocols and client applications

SPS supports the following protocols and clients. As a general rule, client applications not specifically tested but conforming to the relevant protocol standards should work with SPS. One Identity supports the listed client and server applications only on a best-effort basis after their vendor or manufacturer declares end-of-support for them. Best-effort basis means that without the vendor support we only can fix issues with our existing knowledge in the problematic area, and can implement straightforward fixes only.


SPS supports the HTTP 1.0 and 1.1 standards.

Secure Shell Protocol:

SPS supports only the SSHv2 protocol. The older and insecure v1 version is not supported.

Supported client and server applications:

  • OpenSSH (client and server)

    Client and server tested with a weekly build of the latest available version.

  • OpenSSH (client and server) with X.509 patch

    Client and server tested with version OpenSSH_7.1p2 and OpenSSL 1.0.2f-fips 28 Jan 2016.

  • Dropbear (client and server)

    Tested with version 2015.67.

  • SecureCRT (Windows, client)

    Tested with version 7.3.4

  • PUTTY (client)

    Tested with version 0.65.

Remote Desktop Protocol:

Supported Windows client applications:

The built-in applications of the Windows 7 SP1, Windows 8.1, Windows Server 2012, Windows Server 2012 R2, Windows Server 2016, and Windows 10 platforms.

Supported Mac OS X client applications:

The Royal TSX client application, tested with Royal TSX 2.0 on Mac OS X Yosemite.

Supported server (target) applications:

The built-in applications of Windows Server 2012, Windows Server 2012 R2, Windows Server 2016 and Windows 10 platforms.

Accessing Remote Desktop Services (RemoteApp programs) is also supported.


Other Remote Desktop clients are not explicitly supported, but may be compatible with SPS. When using an alternative client application, note the following limitations:

  • The rdesktop application and other client applications (for example, JAVA clients) that build on the rdesktop codebase do not support RDP shadowing and Remote Desktop Gateway connections.

  • The Remote Desktop Connection Client for Mac application does not support RDP shadowing.


SPS is certified for the following server versions:

  • Citrix Virtual Apps (formerly known as Citrix XenApp) 6.0 64-bit

  • Citrix Virtual Apps 7.0

  • Citrix Virtual Apps 6.5 on Windows 2008 R2

  • Citrix Virtual Apps 7.1

  • Citrix Virtual Apps 7.5

  • Citrix Virtual Apps 7.6

  • Citrix Virtual Desktops (formerly known as Citrix XenDesktop) 7.0

  • Citrix Virtual Desktops 7.1

  • Citrix Virtual Desktops 7.5

  • Citrix Virtual Desktops 7.6

For details on the deployment scenarios that support Citrix Virtual Desktops (formerly known as Citrix XenDesktop), see SPS deployment scenarios in a Citrix environment.

Only Receiver for Windows clients are supported.


Telnet traffic must conform RFC 854, and to various extensions described in RFCs 856-861, 652-658, 698, 726-27, 732-736, 749, 779, 885, 927, 933, 1041, 1043, 1053, 1073, 1079, 1091, 1096-97, 1184, 1372, 1408, 1572, 2066, 2217, 2840, 2941, and 2946.

TN3270: Telnet 3270 terminal protocol.

TN5250: Telnet 5250 terminal protocol, as described in RFC2877.

Remote Desktop Gateway Server Protocol (RDGSP):

SPS can act as a Remote Desktop Gateway (also called RD Gateway) and transfer the incoming connections to RDP connections.

Virtual Network Computing:

VNC versions 3.3-3.8 are supported. Supported client and server applications: RealVNC, UltraVNC, TightVNC, KVM, Vino.

VMware Horizon View:

VMware Horizon View Clients using the Remote Desktop (RDP) display protocol to access remote servers are supported. For details, see VMware Horizon View connections.

Modes of operation

SPS can be configured to monitor both transparent and non-transparent connections.

  • In transparent mode, SPS acts as a transparent router between two network segments. For details, see Transparent mode.

  • You can also use policy-based routing to forward connections within the same network segment to SPS, in which case it acts like a single interface transparent router. For details, see Single-interface transparent mode.

  • In non-transparent mode, users have to address SPS to initiate connections to protected servers. For details, see Non-transparent mode.

  • When addressing SPS, you can also use inband destination selection to choose the server to connect to. For details, see Inband destination selection.

It is recommended to design the network topology so that only management and server administration traffic passes SPS. This ensures that the services and applications running on the servers are accessible even in case SPS breaks down, so SPS cannot become a single point of failure.

Transparent mode

In transparent mode, SPS acts as a transparent router connecting the network segment of the administrators to the segment of the protected servers at the network layer (Layer 3 in the OSI model). All connections must pass through SPS to reach the servers — SPS is a proxy gateway, completely separating the protected servers from the rest of the network. Controlled connections and traffic are inspected on the application level, while other types of connections are simply forwarded on the packet level.

SPS can also be configured to act as a single-interface transparent router. For details, see Single-interface transparent mode.


Transparent mode does not support multicast traffic.

Figure 8: SPS in transparent mode

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating