Chat now with support
Chat with Support

One Identity Safeguard for Privileged Sessions 6.0.3 - 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 Searching session data on a central node in a cluster 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) Using SPS with SPP 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 Glossary

Starting and restarting the external-indexer service when using a custom password for PKCS#11 PIN encryption

When you choose to encrypt the PKCS#11 PIN(s) using a custom password, on starting or restarting the external-indexer service, you are asked to enter your password using a special tool.

To provide your password using the required tool

  1. Start the external-indexer service:

    systemctl start external-indexer
  2. The external-indexer service prompts you to provide a password using the systemd-ask-password tool. Issue:

    systemd-tty-ask-password-agent
  3. Provide the password at the prompt. You can use multiple agents to enter the password.

  4. Once the external indexer(s) have been started or restarted, make sure that all the indexers have started up successfully.

    For example, on CentOS 7, you can use:

    systemctl status external-indexer

Configuring SoftHSM

SoftHSM is the software implementation of an HSM. It can be installed from the EPEL repository. The configuration of SoftHSM can be found at /etc/softhsm2.conf (CentOS 7), or /etc/softhsm.conf (CentOS 6).

The following describes how to configure SoftHSM.

NOTE:

Depending on the exact SoftHSM solution that you are using, the steps described here may slightly differ.

NOTE:

The following steps assume that:

  • You are on the host operating system.

  • The external indexer has been installed.

Prerequisites

The indexer user/group has the rights to read the data directory of SoftHSM and its contents, which defaults to /var/lib/softhsm.

To configure SoftHSM

  1. Initialize directories for SoftHSM.

    mkdir -p /var/lib/softhsm
    chgrp -R indexer /var/lib/softhsm
  2. Configure slots for softhsm1 (CentOS 6). For softhsm2 (CentOS 7), you can skip this step.

    cat /etc/softhsm.conf
    0:/var/lib/softhsm/slot0.db
    1:/var/lib/softhsm/slot1.db
  3. Initialize slot 0 (softhsm1).

    softhsm --init-token --slot 0 --label "<your-slot-label>" –-<so-pin> topsecret --pin <your-SoftHSM-PIN>
  4. Initialize a new slot (softhsm2) and get the slot ID:

    softhsm2-util --init-token --free --label "<your-slot-label>" --<so-pin> topsecret --pin <your-SoftHSM-PIN>
    SLOT_ID=$(softhsm2-util --show-slots | grep -B 15 "<your-slot-label>" | grep "Slot [0-9]" | head -n 1 | cut -d ' ' -f 2)
  5. Import your keys. Your keys must be in the .der format.

    For softhsm1, use:

    pkcs11-tool --module /usr/lib/softhsm/libsofthsm.so -l -y privkey --slot 0 -w key.der -d 001 -a <your-key-label> --pin <your-SoftHSM-PIN>

    For softhsm2, use:

    pkcs11-tool --module /usr/lib/softhsm/libsofthsm2.so -l -y privkey --slot 0 -w key.der -d 001 -a <your-key-label> --pin <your-SoftHSM-PIN>
  6. Make sure that the indexer user/group has execute right to the token directory and read right to the token files below the /var/lib/softhsm/tokens/ directory.

  7. Test your SoftHSM configuration with the indexer.

    source /etc/indexer/external-indexer.env
    indexerworker -l -v 7 --pkcs11-lib "<your-SoftHSM-library>" --pkcs11-slot-id 0 --pkcs11-pin "<your-SoftHSM-PIN>"
  8. Encrypt the PKCS#11 PIN(s). For detailed instructions, see Encrypting a PKCS#11 PIN.

  9. Update the "pkcs11" object in the /etc/indexer/indexerworker.cfg file.

    ...
       "pkcs11": {
           "slots": [
             {
               "library": "/usr/lib/softhsm/libsofthsm.so",
               "slot_id": 0,
               "pin": "<your-encrypted-PIN>"
             }
           ]
       }
    ...

Configuring AWS CloudHSM

Amazon Web Services (AWS) CloudHSM provides hardware security modules in the AWS Cloud.

The following describes how to configure CloudHSM.

NOTE:

The following steps assume that:

  • You have set up your AWS CloudHSM, that is, you have created a user for the indexer, imported/generated keys, and so on.

    For detailed information on AWS CloudHSM, see the AWS CloudHSM User Guide.

  • The CloudHSM PKCS#11 library is installed.

  • The external indexer has been installed.

To configure CloudHSM

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

    Note that you will need to provide your CloudHSM PIN in the following format:

    "<your-CloudHSM-username:your-CloudHSM-PIN>"
  2. Encrypt the PKCS#11 PIN(s). For detailed instructions, see Encrypting a PKCS#11 PIN.

  3. Update the "pkcs11" object in the /etc/indexer/indexerworker.cfg file.

    ...
       "pkcs11": {
           "custom_password": true
           "slots": [
             {
               "library": "/opt/cloudhsm/lib/libcloudhsm_pkcs11.so",
               "slot_id": 1,
               "pin": "<your-encrypted-PIN>"
             }
           ]
       }
    ...

Configuring a smart card

NOTE:

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

To configure a smart card

  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/opensc-pkcs11.so", 
               "slot_id": 1, 
               "pin": "encrypted_pin" 
             } 
           ] 
       } 
    ...
Related Documents

The document was helpful.

Select Rating

I easily found the information I needed.

Select Rating