Chat now with support
Chat with Support

One Identity Safeguard for Privileged Passwords 7.4 - Administration Guide

Introduction System requirements and versions Using API and PowerShell tools Using the virtual appliance and web management console Cloud deployment considerations Setting up Safeguard for Privileged Passwords for the first time Using the web client Home page Privileged access requests Appliance Management
Appliance Backup and Retention Certificates Cluster Global Services External Integration Real-Time Reports Safeguard Access Appliance Management Settings
Asset Management
Account Automation Accounts Assets Partitions Discovery Profiles Tags Registered Connectors Custom platforms Importing objects
Security Policy Management
Access Request Activity Account Groups Application to Application Cloud Assistant Asset Groups Entitlements Linked Accounts User Groups Security Policy Settings
User Management Reports Disaster recovery and clusters Administrator permissions Preparing systems for management Troubleshooting Frequently asked questions Appendix A: Safeguard ports Appendix B: SPP and SPS join guidance Appendix C: Regular Expressions

Configuring and verifying a syslog server

It is the responsibility of the Appliance Administrator to configure SPP to log event messages to a syslog server. The steps below cover configuration.

Other considerations:

To configure a syslog server

  1. Go to Syslog:
    • web client: Navigate to External Integration > Syslog.
  2. Click Add to display the Syslog Serverdialog.

  3. In the Syslog Server dialog, enter the following:

    1. Name: Enter a descriptive name for the syslog server.

    2. Network Address: Enter the IP address or FQDN of the syslog server. Limit: 255 characters

    3. Port: Enter the port number for the syslog server. Default: 514 and range: between 1 and 32767

    4. Protocol: Select the network protocol and syslog header type:

      • UDP (RFC 3164): Sends messages over UDP using the syslog header format specified in RFC 3164.

      • UDP (RFC 5424): Sends messages over UDP using the syslog header format specified in RFC 5424.
      • TCP (RCF 5424): Sends messages over TCP using the syslog header format specified in RFC 5424. TCP is required for TLS options.
    5. If you selected a Protocol of TCP (RCF 5424), additional selections can be made to set the TCP framing and configure SPP to use Transport Layer Security (TLS). This provides encrypted communication with the syslog server instead of plain text over TCP.

      • Select the TCP Framing. By default, Octet Counting will be selected. Possible options are:

        • Octet Counting: The default and recommended framing. For more information, see https://datatracker.ietf.org/doc/html/rfc6587#section-3.4.1. With octet counting, there is no chance of a message containing a character that may otherwise be intended to be used as a delimiter.

        • LF: Use a line feed character (LF 0x0A) as the delimiter between syslog messages. For more information, see https://datatracker.ietf.org/doc/html/rfc6587#section-3.4.2. Note that the RFC describes problems with using this framing and is therefore not recommended. However, some syslog servers do not support octet counting and must use one of these non-transparent framing options. Safeguard for Privileged Passwords makes no attempt to escape out this character if it appears in a message itself. If that happens, you will receive a fragmented and potentially malformed message/data.

        • CR: Use a carriage return character (CR 0x0D) as the delimiter between syslog messages. For more information, see https://datatracker.ietf.org/doc/html/rfc6587#section-3.4.2. Note that the RFC describes problems with using this framing and is therefore not recommended. However, some syslog servers do not support octet counting and must use one of these non-transparent framing options. Safeguard for Privileged Passwords makes no attempt to escape out this character if it appears in a message itself. If that happens, you will receive a fragmented and potentially malformed message/data.

        • CRLF: Use both carriage return and line feed characters (CRLF 0x0D0A) as the delimiter between syslog messages. For more information, see https://datatracker.ietf.org/doc/html/rfc6587#section-3.4.2. Note that the RFC describes problems with using this framing and is therefore not recommended. However, some syslog servers do not support octet counting and must use one of these non-transparent framing options. Safeguard for Privileged Passwords makes no attempt to escape out this character if it appears in a message itself. If that happens, you will receive a fragmented and potentially malformed message/data.

        • NUL: Use a NUL character (0x00) as the delimiter between syslog messages. For more information, see https://datatracker.ietf.org/doc/html/rfc6587#section-3.4.2. Note that the RFC describes problems with using this framing and is therefore not recommended. However, some syslog servers do not support octet counting and must use one of these non-transparent framing options. Safeguard for Privileged Passwords makes no attempt to escape out this character if it appears in a message itself. If that happens, you will receive a fragmented and potentially malformed message/data.

      • Select Use TLS Encrypton.

      • Verify Syslog Server Certificate: If selected, the syslog server certificate messages will only be sent if SPP is able to verify the authenticity of the syslog server TLS certificate. If SPP cannot resolve the syslog server TLS certificate to a trusted root, the message will not be sent.
      • Use Client Certificate: Select this option if the syslog server requires clients to authenticate. You should also set the syslog client certificate appropriately. For more information, see Creating a syslog client Certificate Signing Request.
  4. Click OK to save your selection and add the syslog server configuration.
  5. You can verify the syslog server. See the next section.

To verify a syslog server

  1. Navigate to External Integration > Syslog Event.

  2. Click Send Test Event. For more information, see Syslog Events.

Syslog Events

You can configure audit event logs to send to syslog server (cluster-wide). Audit events include connection, closure, and failures. Failures include the reason, the initiator, and the target. For example, a certificate validation failure will include the initiator and the target.

Debug logging to syslog server is available and is appliance specific (see Debug).

To configure audit event logs to send to a syslog server

  1. You will need a configured syslog server. If you have not configured a syslog server, you will see a message like this: To configure additional debut logging options, you need to configure a syslog server. Click Configure a syslog server. For more information, see Configuring and verifying a syslog server.
  2. Navigate to External Integration > Syslog Events.
  3. The Syslog Events pane displays the following.
Table 56: Syslog server: Properties
Property Description

Syslog Server

The name of the syslog server

Facility The type of program being used to create syslog messages (for example, User or Mail)

Log Format

The format which can be CEF or JSON

Description The description of the syslog event
# of Events The number of events selected to be logged to the syslog server

Use these toolbar buttons to manage the syslog server configurations

Table 57: Syslog server: Toolbar
Option Description
Add Add a new syslog server configuration. For more information, see Configuring and verifying a syslog server.
Remove

Remove the selected syslog server configuration from SPP.

Edit Modify the selected syslog server configuration.
Copy Syslog Template Clone the selected syslog server configuration.
Refresh Update the list of syslog server configurations.

Send Test Event

  • To send a test message to the designated syslog server

    • Add a syslog event subscriber

    It is the responsibility of the Appliance Administrator to add an event subscriber.

    To add an event subscriber

    1. Navigate to External Integration > Syslog Event.
    2. Click Add to display the Syslog Events dialog.

    3. In the Syslog Events dialog, enter the following:

      1. Syslog Server: Select the server to which you want to send the events.

      2. Description: Enter the description of the syslog event.

      3. Subscribe to All Events: Select this check box to subscribe to all events, including new events that may be added in the future. If unselected, select specific events.

        Make sure that the user creating the Syslog Event entry has sufficient permission to receive all of the events configured. If the Syslog Event entry is configured by a user with inadequate permissions to receive all the events that are configured, some events may not be received. If this happens, delete the Syslog Event entry and recreate it as a user that has sufficient permission.

      4. If you left Subscribe to All Events unselected, click Browse then select the check boxes of the Events to which you want to subscribe You can enter characters then click Search to limit the events that are displayed. Click OK.

      5. Facility: Select which syslog facility to send, for example User or Mail.
      6. Log Format: Select between Common Event Format (CEF) or Javascript Object Notation (JSON).
      7. If you select JSON, enter the Attribute Prefix which is text that will be prepended to the JSON attributes.
    4. Click OK.

    Ticket systems

    You can use ticketing that is not configured with an external ticketing system or integrate with an external ticketing system (such as ServiceNow or Remedy).

    Tickets can be viewed in the Activity Center, Ticket # column.

    Go to Ticket Systems:

    • web client: Navigate to External Integration > Ticket Systems.
    Ticketing toolbar

    Use these toolbar buttons to manage the ticketing systems defined to integrate with SPP.

    • Add: Add a new ticket system.
    • Remove: Remove the selected ticket system from SPP.
    • Edit: Modify the selected ticket system configuration.
    • Refresh: Update the list of ticket systems.
    Setup and workflow

    For set up and workflow details, see the following based on the ticketing you use:

    Related Documents

    The document was helpful.

    Select Rating

    I easily found the information I needed.

    Select Rating