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

Searching session data on a central node in a cluster


Central search is currently an experimental feature of Safeguard for Privileged Sessions.

The central search functionality is available when your deployment consists of two or more instances of Safeguard for Privileged Sessions organized into a cluster. When you have a cluster of nodes set up, you have the possibility to search all session data recorded by all nodes in the cluster on a single node. This is achieved by assigning roles to the individual nodes in your cluster: you can set up one of your Safeguard for Privileged Sessions nodes to be the Search Master and the rest of the nodes to be Search Minions. Search Minions send session data that they record to the Search Master, and the Search Master acts as a central search node.

To set up your environment for central searching, complete the following steps:

  1. Enable cluster management on the nodes that you want to be part of your cluster.
  2. Build a cluster.
  3. Assign roles to nodes in your cluster.

    Familiarize yourself with the available search roles before assigning them to nodes. For details, see Cluster roles.

Once you have your cluster set up and the appropriate roles assigned, you can start searching session data using the Search interface.


Central search is not available on the Search (classic) interface.

Limitations of the central search functionality

Currently, the central search functionality comes with a number of limitations:

  • It is not possible to assign the Search privilege to a user in a way that they can only access audit trails for connections for which they have been granted permission. Assigning the Search privilege to a user on the AAA > Access Control page automatically enables the Search in all connections privilege, and grants the user access to every audit trail, even if the user is not a member of the groups listed in the Access Control option of the particular connection policy.
  • Session data recorded by a node before it was joined to the cluster will not be searchable centrally. Only session data recorded after the node has been joined to the cluster is available for central search.
  • Content search is not available, that is, it is not possible to search in the contents of audit trails, only in session metadata.
  • User behavior analysis provided by One Identity Safeguard for Privileged Analytics is not available.
  • It is not possible to replay audit trail files in your browser from the Search Master node.
  • When near real-time indexing is configured on a Search Minion node, while session data from active connections is visible on the Search interface of the Search Master node, it is not possible to:
    • export the audit trail of an active connection,
    • follow an active connection, and
    • terminate an active connection.

    Note, however, that you can terminate the active, ongoing connection on the Search Minion node that is recording the connection in question.

  • A reliable, high-bandwidth connection is required between the nodes. Small loss of connection is handled well but if the connection between the Search Minions and the Search Master is lost for a longer period of time, the Search Minions will stop accepting new connections until the connection is repaired. Data is automatically pushed to the Search Master after the connection is repaired.


Search Minion nodes do not send the files storing the audit trails to the Search Master node. When a user clicks , the Search Master node streams the trail files to the user from the original Search Minion node that recorded the sessions. If a Search Minion node does not have a backup policy set up and an error occurs that causes data loss, then session data recorded by that node will not be available.

Advanced authentication and authorization techniques

This chapter describes the advanced authentication and authorization techniques available in SPS.

Configuring usermapping policies


For SSH, RDP, Telnet, and Citrix ICA connections, usermapping policies can be defined. A usermapping policy describes who can use a specific username to access the remote server: only members of the specified local or LDAP usergroups (for example, administrators) can use the specified username (for example, root) on the server. To configure usermapping, complete the following steps.


In SSH connections, the users must use the following as their username: gu=username@remoteusername, where username is the username used in the LDAP directory, SPS will use this username to determine their group memberships, and remoteusername is the username they will use on the remote server. For example, to access the server as root, use:

For the username of SSH users, only valid UTF-8 strings are allowed.


In Telnet connections, usermapping policy works only if Extract username from the traffic is enabled. For details, see Extracting username from Telnet connections.

When configuring ICA connections, also consider the following:


If the clients are accessing a remote application or desktop that is shared for Anonymous users (that is, the Users properties of the application is set to Allow anonymous users in the Citrix Delivery Services Console), the actual remote session will be running under an Anonymous account name (for example, Anon001, Anon002, and so on), not under the username used to access the remote server. Therefore, you need to enable usermapping to the Anon* usernames.

To accomplish this, create a usermapping policy and set the Username on the server option to Anon*, and the Groups option to *, then use this usermapping policy in your ICA connections. For details on using usermapping policies, see Configuring usermapping policies.


Starting from SPS version 3.2, usermapping is possible only when gateway authentication is used as well.

  1. Navigate to Policies > Usermapping Policies.

    Figure 235: Policies > Usermapping Policies — Configuring usermapping policies

  2. Click to create a new policy, and enter a name for the policy.

  3. Click and enter the username that can be used to access the remote server (for example root) into the Username on the server field. SPS will use this username in the server-side connection. To permit any username on the server side, enter an asterisk (*).

  4. Select Groups, click and specify who is permitted to use the remote username set in the Username on the server field.

    • If you have an LDAP Server set in the connection policy where you will use usermapping, enter the name of the local or LDAP usergroup (for example admins) whose members will be permitted to use the remote username. For details on LDAP authentication, see Authenticating users to an LDAP server.


      The LDAP server configured in the connection policy is not necessarily the same as the LDAP server used to authenticate the users accessing the SPS web interface.

    • If you do not authenticate the connections to an LDAP server, enter the name of the userlist whose members will be permitted to use the remote username. For details on using userlists, see Creating and editing user lists.

    Repeat this step to add further groups if needed.

  5. Repeat steps 3-4 to add further usernames if needed.

  6. To permit other users, who are not explicitly listed in the Usermapping Policy access the remote servers, select the Allow other unmapped usernames option. Note that these users must use the same username on the SPS gateway and the remote server.

  7. Click Commit.

  8. Navigate to the Connections page of the traffic (for example to SSH Control > Connections), and select the connection policy to modify.

  9. Select the usermapping policy created in Step 2 from the Usermapping policy field.

  10. Click Commit.


    For RDP connections, usermapping is possible only when gateway authentication is used as well. When configuring usermapping for RDP connections, proceed to Configuring out-of-band gateway authentication and configure gateway authentication.

Configuring gateway authentication

When gateway authentication is required for a connection, the user must authenticate on SPS as well. This additional authentication can be performed:

  • Out-of-band, on the SPS web interface, for every protocol.

  • Inband, using the incoming connection, for the SSH, Telnet, and RDP protocols.

For details about the concepts of gateway authentication, see The gateway authentication process. You can use gateway authentication to authenticate the real person when the user is using a shared account to access the target server.


For SSH, Telnet, and RDP connections, gateway authentication can be performed also inband, without having to access the SPS web interface.

  • For SSH and Telnet connections, inband gateway authentication must be performed when client-side authentication is configured. For details on configuring client-side authentication, see Client-side authentication settings.

  • For RDP connections, inband gateway authentication must be performed when SPS is acting as a Remote Desktop Gateway (or RD Gateway). In this case, the client authenticates to the Domain Controller or a local user database. For details, see Using SPS as a Remote Desktop Gateway.

    In the case of RDP connections, inband gateway authentication can also be performed if an AA plugin is configured.


Gateway authentication can be used together with other advanced authentication and authorization techniques like four-eyes authorization, client- and server-side authentication, and so on.


If the username used within the protocol to access the remote server is different from the username used to perform gateway authentication (for example, because the user uses a shared account in the remote server, but a personal account for gateway authentication), usermapping must be configured for the connection. For details on usermapping, see Configuring usermapping policies.


To configure a credential store for gateway authentication, see Using credential stores for server-side authentication.

Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating