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

Configuring a smart card



Using the external indexer with a smart card is currently an experimental feature only.

To configure a smart card, complete the following steps.

  1. Install OpenSC, for example, from the EPEL repository of CentOS.

  2. Ensure that the PC/SC Smart Card Daemon (pcscd) service is running:

    • On CentOS 6:

      service pcscd start
    • On CentOS 7:

      systemctl enable pcscd
      systemctl start pcscd

      Alternatively, you can use:

      systemctl enable pcscd.socket
      systemctl start pcscd.socket

      This ensures that the pcscd service will not start at system startup, it will only start when there is an attempt (for example, by the indexerworker) to connect to it.

  3. Test your environment as described in Setting up and testing the environment.

  4. Encrypt the PKCS#11 PIN(s). For detailed instructions, see the Encrypting a PKCS#11 PIN.

  5. Update the "pkcs11" object in the /etc/indexer/indexerworker.cfg file, for example:

       "pkcs11": { 
           "slots": [ 
               "library": "/usr/lib64/pkcs11/", 
               "slot_id": 1, 
               "pin": "encrypted_pin" 

Customizing the indexing of HTTP traffic


To customize how SPS indexes HTTP traffic, complete the following steps.


You can customize only the configuration of external indexers. The indexer running on the SPS host always uses the default HTTP configuration, which is the following:

  "General": {
    "Whitelist": ["text/.*", ".*json.*", "application/x-www-form-urlencoded", "multipart/.*"],
    "Blacklist": ["text/css", "application/javascript", "text/xslt", ".*xml.*"]
  "Form": {
     "Blacklist": ["password", "pass"]
  "Html": {
    "Attributes": ["href", "name", "value", "title", "id", "src"],
    "StrippedTags": ["script", "object", "style", "noscript", "embed", "video", "audio", "canvas", "svg"]
  1. Create a configuration file for the HTTP indexer using a text editor. The configuration file uses the JSON format. For details on the configuration format, see HTTP indexer configuration format.


    If you want to index HTTP POST messages, include the "application/x-www-form-urlencoded" Content-Type in the General > WhiteList list. The indexer will decode URL encoding (percentage encoding), and create key=value pairs from the form fields and their values. Note that in the values, the indexer will replace whitespace with the underscore (_) character. To avoid indexing sensitive information (for example, passwords from login forms), use the Form > Blacklist option.

  2. Copy the configuration file to the external hosts, to the /opt/external-indexer/usr/share/adp/httpconfig.json file.

  3. Reload the indexer service: systemctl restart external-indexer.service

  4. Repeat the above steps for your other external indexer hosts. Otherwise, it is possible that certain audit trails will be indexed using different indexer configuration.

  5. Disable the indexer that is running on the SPS host. Otherwise, it is possible that certain audit trails will be indexed using different indexer configuration.

    Navigate to Basic Settings > Local Services > Indexer service, and set the Maximum parallel audit trails to index on box option to 0.

Starting the external indexer


When you have configured the external indexer, and added all decryption keys, you can start running the service.

  1. Start the indexer service using the following command.

    • On Red Hat or CentOS 6.5:

      service external-indexer start
    • On Red Hat or CentOS 7:

      systemctl start external-indexer.service
  2. Verify that the indexer service is running. Execute the ps aux command. In the output, you should see a workercontroller and one or more indexerworker processes. The number of the indexerworker processes should be the same number you set for the number_of_workers key of the /opt/external-indexer/etc/indexer/indexerworker.cfg file.

  3. Verify the indexer-certs.cfg configuration file.

    Check the system logs of the host of the external indexer. The "Error loading key store" log indicates that there was a problem with the indexer-certs.cfg configuration file.

  4. Verify that the indexer host is displayed in the list of indexers on the Indexer > Indexer status page of the SPS web interface.

Disabling indexing on SPS


To reduce load on SPS, you can disable indexing audit trails on the box. Note that this introduces delays when generating on-demand screenshots for audit trail searches.


Disabling indexing on the SPS box works only if an external indexer is available. If SPS cannot detect the presence of an external indexer (for example, because of a network outage), indexing is re-enabled on SPS automatically with one indexing process.

  1. On the SPS web interface, navigate to Basic Settings > Local Services > Indexer service.

  2. Set the Maximum parallel audit trails to index on box to 0.

  3. Click Commit.

Related Documents