Your suggested change has been received. Thank you.

close

Suggest A Change

https://thales.na.market.dpondemand.io/docs/dpod/services/kmo….

back

Security integrations

Security Orchestration with Cortex XSOAR

search

Security Orchestration with Cortex XSOAR

Security Orchestration with Cortex XSOAR

The SafeNet Trusted Access (STA) integration with Cortex XSOAR from Palo Alto Networks enables you to process alerts received from STA that indicate security risk to end-user accounts, and applies security remediation actions on STA alerts through Cortex XSOAR Security Orchestration Playbooks. The integration comes with an example playbook that you can use as part of your automated security response mechanisms. The playbook can also be a starting point for the creation of your own custom playbooks that may be triggered by alerts from STA or other systems, and include remediation actions on STA.

This integration is configured through the SafeNet Trusted Access Pack available on the Cortex XSOAR marketplace.

This integration documentation is divided into the following three parts:

Invoking Remediation Actions on STA

As a prerequisite, you must have Cortex XSOAR installed and running on your machine.

Cortex XSOAR can invoke remediation actions on STA as part of response playbooks. This is achieved by invoking Rest API calls from STA. The following table lists the remediation actions that can be applied on STA and the steps to configure Cortex XSOAR and STA for the invocation of the remediation actions:

Remediation Action Steps to Configure Cortex XSOAR and STA for the Invocation of the Remediation Actions

- Terminate users’ SSO sessions

- Any other action

  1. Generating an API key
  2. Installing and configuring SafeNet Trusted Access integration instance

Add users to an Unusual Activity group

  1. Generating an API key
  2. Installing and configuring SafeNet Trusted Access integration instance
  3. Creating a User Group in STA
  4. Configuring group policies
  5. Configuring a group and time duration in Cortex XSOAR using XSOAR lists

Generating an API Key

An API key allows Cortex XSOAR to communicate with STA Rest APIs to perform the remediation action. Perform the following steps to generate the API key:

  1. Log in to the STA Access Management console as an administrator.

  2. On the console, in the left pane, at the bottom, click the Settings icon alt_text.

  3. In the right pane, under API Keys, perform the following steps:

    1. From the REST API ENDPOINT URL field, copy the End Point Base URL that is in the https://api.[name].com format (for example, https://api.safenet.com) and paste it in a text editor. The base URL is highlighted in the below screenshot.

    2. From the REST API ENDPOINT URL field, copy the Tenant Code (for example, HOESABCHA9) and paste it in the text editor. The tenant code is highlighted in the below screenshot.

      You will need the End Point Base URL and Tenant Code while configuring Cortex XSOAR.

    3. Click on the Generate API Key link.

    alt_text

  4. On the Generate New API Key window, perform the following steps:

    1. Under Name, enter a name for the key (for example, Cortex XSOAR API Key) that you can easy identify and manage.

    2. Under Service Account, search for the service account user ID that you want to associate with the API key.

      Each API key can be associated with only one service account.

    3. Click Next. The API key will be generated.

    alt_text

  5. On the API Key Successfully Generated window, perform the following steps:

    1. Click Download to download the API key and save it on your local machine. You will need the API key while configuring Cortex XSOAR.

      Ensure to download the API key here while performing this step because API keys are not stored on the STA Access Management console, and you cannot view or download API keys later.

    2. Click Finish.

    alt_text

    This API key can be used for invoking both the remediation actions:

    - Adding a user to the unusual activity group after receiving a push reject notification alert.

    - Terminating a user’s single sign on session after receiving an account lockout alert.

Installing and Configuring SafeNet Trusted Access Integration Instance

Install the SafeNet Trusted Access content pack and configure the integration instance to establish a communication between STA and Cortex XSOAR. Perform the following steps:

  1. Log in to Cortex XSOAR as an administrator using the https://<Fully Qualified Domain Name>/#/login URL.

    Where, <Fully Qualified Domain Name> is the fully qualified domain name of the machine on which Cortex XSOAR is installed.

    For example, https://cortex.safenet.com/#/login

  2. On the Cortex XSOAR dashboard, in the left pane, click Marketplace.

    alt_text

  3. In the right pane, search for SafeNet Trusted Access and from the search results, click the SafeNet Trusted Access content pack.

    alt_text

  4. On the top right-hand side of the window, click Install.

    alt_text

  5. Under Cart, at the bottom, click Install.

    alt_text

  6. After successful installation of the STA content pack, click Refresh Content.

    If the Refresh Content button is not displayed after few seconds, refresh the page.

    After successful installation, the Installed message is displayed.

    alt_text

  7. In the left pane, click Settings.

    alt_text

  8. In the right pane, under Settings, on the INTEGRATIONS tab, on the Servers & Services subtab, search for SafeNet Trusted Access.

  9. Under Authentication, the SafeNet Trusted Access content pack is displayed. Click Add instance to create a new integration instance.

    alt_text

  10. Under Thales SafeNet Trusted Access (Partner Contribution), under Instance Settings, perform the following steps:

    1. In the Name field, enter an instance name of your choice (for example, SafeNet Trusted Access_instance_1). Copy the instance name and paste it in a text editor for future purpose.

      The instance name will be used as an input by the playbook to communicate with your tenant using the configured API key.

      This instance can be used for invoking both use cases:

      - Adding a user to the unusual activity group after receiving a push reject notification alert.

      - Terminating a user’s single sign on session after receiving an account lockout alert.

    2. In the URL field, enter the Endpoint Base URL that you copied in Step3(a) of Generating an API Key.

    3. In the Tenant Code field, enter the tenant code that you copied in Step 3(b) of Generating an API Key.

    4. In the API Key field, enter the API key that you downloaded in Step 5 of Generating an API Key.

    5. Click Test to validate the connection.

    6. Click Save & exit.

    alt_text

    The instance (for example, SafeNet Trusted Access_instance_1) is added.

    alt_text

Creating a User Group in STA

Users who reject the Push Notification can be added in a group. Perform the following steps to create a group in STA:

  1. On the STA Token Management console, click the Groups tab, and then click Group Maintenance.

    alt_text

  2. Under Group Maintenance, click New.

    alt_text

    Ensure that the Internal option is selected.

  3. Under Add Group, perform the following steps:

    1. In the Group Name field, enter a name for the group (for example, Unusual Activity Group).

      Copy the group name and paste it in a text editor. You will need the group name while configuring Cortex XSOAR.

    2. In the Description field, enter a description of the group.

    3. Click Add.

      alt_text

Configuring Group Policies

After receiving a Push Notification Rejection alert, you will need to impose stronger authentication on the next user login attempt by configuring stringent policies on the Unusual Activity group as per your requirements.

Perform the following steps to configure a policy for the user group:

  1. On the STA Access Management console, in the left pane, click the Policies alt_text icon.

  2. In the middle pane, under Policies, click the Add icon alt_text.

    alt_text

  3. In the right pane, under Create Policy, perform the following steps:

    1. In the New Policy text box, enter a name for the policy (for example, Unusual Activity Group Policy).

    2. In the New Policy Description text box, enter a description of the policy (for example, This policy imposes stronger authentication).

    3. Under Default Requirements, configure the policy as per your preferred configuration.

      Click here to get more information on policies.

    4. Under Policy Scope, ensure that the Any of these User Groups option is selected and select the group name (for example, Unusual Activity Group) that you created in Step 3 (a) of Creating a User Group in STA.

    alt_text

  4. At the bottom of the window, click Save.

Configuring a Group and Time Duration Using XSOAR Lists

XSOAR Lists are created to configure a group and the time duration after which users will automatically be removed from the group. Group and time duration parameters are used as inputs in Playbooks to orchestrate a security remediation action.

Perform the following steps to configure a group and time duration in Cortex XSOAR:

  1. On the Cortex XSOAR dashboard, in the left pane, click Settings.

  2. In the right pane, under Settings, click the ADVANCED tab, and then click the Lists subtab.

    alt_text

  3. Click Add a List and perform the following steps:

    1. In the Name field, enter sta_unusual_activity_group.

    2. In the Data field, enter the name of the group (for example, Unusual Activity Group) that you created earlier in Step 3 (a) of Creating a User Group in STA.

    3. Click Save.

    alt_text

  4. Click Add a List to create another list and perform the following steps:

    1. In the Name field, enter sta_user_in_unusual_activity_group_hours.

    2. In the Data field, enter the time duration (in hours) after which users will be automatically removed from the group.

    3. Click Save.

    alt_text

    Both the newly added lists are displayed.

    alt_text

Integrating Alerts from STA

As a prerequisite, you must have an email address with IMAP settings enabled. The email address will be used to receive alerts from STA.

STA alerts can be received by Cortex XSOAR as trigger points for incidents. The following alerts are the indicators of security risks and are particularly relevant in this context:

Configuring Alerts in STA

The alerts indicate an attempt of breaking into the user’s account. Perform the following steps to enable alerts for non-operator email recipients:

  1. On the STA Token Management console, click the Policy tab and then click Role Management.

    alt_text

  2. Under Role Management, in the Task column, click External Alerts Recipients.

    alt_text

  3. Under Set Event Recipients, click Add to add a new alert recipient.

  4. On the Add Recipient window, perform the following steps:

    1. In the Alert Name field, enter a name to identify the type of the alert (for example, Cortex XSOAR Alert Management).

    2. Under Alert Recipients, in the Name and Email fields, enter the name and email address of the alert recipient, respectively.

    3. Copy the email address of the alert recipient and paste it in a text editor for future purpose.

    4. Click Add.

    5. In the table, in the Email column,

      For Push Notification Rejection Alerts

      • Select the Push Notification Rejection Operator Alert check box.

        alt_text

      For Account Lockout Alerts

      • Select the Operator Lockout Alert check box.

        alt_text

    6. Click Apply.

      alt_text

Customizing the Email Message for STA Alert

Perform the following steps to customize the email message that will contain the information retrieved from STA alerts by Cortex XSOAR:

  1. On the STA Token Management console, click the Comms tab, and then click Communications.

    alt_text

  2. Under Communications, in the Task column, click Email Messages.

    alt_text

  3. Under Customize Email Messages, select the Custom option.

For Push Notification Rejection Alert

  1. Perform the following steps to customize email message for Push Notification Rejection alerts:

    1. In the Email Message Type field, select Push Notification Rejection Internal Operator Alert.

    2. In the Subject field, change the value to SafeNet Trusted Access Push Notification Rejection Alert.

    3. In the Body field, at the end, add Instance name: <instance name>.

    For example, Instance name: SafeNet Trusted Access_instance_1

    Ensure that the instance name is same as configured in Step10(a) of Installing and Configuring SafeNet Trusted Access Integration Instance.

    alt_text

For Account Lockout Alert

  1. Perform the following steps to customize email message for Account Lockout alerts:

    1. In the Email Message Type field, select Operator Lockout Alert.

    2. In the Subject field, change the value to SafeNet Trusted Access User Lockout Alert.

    3. In the Body field, perform the following steps:

      1. After the <unlockTime /> tag, Add time zone as UTC.

      2. At the end, add Instance name: <instance name> (for example, Instance name: SafeNet Trusted Access_instance_1).

      Ensure that the instance name is same as configured in Step10(a) of Installing and Configuring SafeNet Trusted Access Integration Instance.

    4. Click Apply.

    alt_text

Installing and Configuring a Mail Listener Integration Instance

You need to create and configure mail listener integration instances to allow Cortex to listen STA alerts from the email address that you configured in the Configuring Alerts in STA section. After the configuration, incidents for alerts are generated in Cortex XSOAR.

If a Mail Listener content pack is already installed, go to Configuring the Mail Listener Integration Instance to configure it.

Installing the Mail Listener Integration Instance

Perform the following steps to install the Mail Listener integration instance:

  1. On the Cortex XSOAR dashboard, in the left pane, click Marketplace.

  2. In the right pane, search for Mail listener and under Search Results, click the Mail Listener content pack.

    alt_text

  3. On the top right-hand side, click Install.

  4. In the Cart pane, click Install.

  5. After successful installation of the content pack, click Refresh Content.

    If the Refresh Content button is not displayed after few seconds, refresh the page.

    After successful installation, the Installed message is displayed.

    alt_text

Configuring the Mail Listener Integration Instance

Perform the following steps to configure the Mail Listener integration instance:

  1. In the left pane, click Settings.

    alt_text

  2. In the right pane, under Settings, on the INTEGRATIONS tab, on the Servers & Services subtab, search for Mail Listener v2.

  3. Under Messaging, next to Mail Listener v2, click Add instance to create and configure a new integration instance.

    alt_text

For Push Notification Rejection Alerts

  1. Perform the following steps to configure the mail listener integration instance for Push Notification Rejection alerts:

    1. Under Mail Listener v2, in the Name field, enter a name (for example, STA_Push_Reject_Alert_instance) for the Mail Listener integration instance. Copy the name and paste it in a text editor for future purpose.

    2. Select the Fetches incidents option.

    3. Under Classifier, select SafeNet Trusted Access – Alert Classifier.

    4. Under Incident type (if classifier doesn't exist), select SafeNet Trusted Access Push Reject Alert.

    5. Under Mapper (incoming), select SafeNet Trusted Access – Alert Mapper.

    6. In the Mail Server Hostname / IP address field, enter one of the following:

      • Mail server URL

      • Hostname

      • IP address

      For example, imap.gmail.com for Gmail account.

    7. In the IMAP Port field, enter the IMAP port number (for example, 993 for Gmail account).

    8. In the Username field, enter the email address that you configured in Step 4(b) of Configuring Alerts in STA.

    9. In the Password field, enter the password of the email address.

    10. Click Test to validate the connection.

    11. Click Save & exit.

    alt_text

    The instance (for example, STA_Push_Reject_Alert_instance) is added.

    alt_text

For Account Lockout Alerts

  1. Perform the following steps to configure the mail listener integration instance for Account Lockout alerts:

    1. Under Mail Listener v2, click Add instance to create and configure a new integration instance.

    2. In the Name field, enter a name (for example, STA_Account_Lockout_Alert_instance) for the Mail Listener integration instance. Copy the name and paste it in a text editor for future purpose.

    3. Select the Fetches incidents option.

    4. Under Classifier, select SafeNet Trusted Access – Alert Classifier.

    5. Under Incident type (if classifier doesn't exist), select SafeNet Trusted Access Account Lockout Alert.

    6. Under Mapper (incoming), select SafeNet Trusted Access – Alert Mapper.

    7. In the Mail Server Hostname / IP address field, enter anyone of the following:

      • Mail server URL

      • Hostname

      • IP address

      For example, imap.gmail.com for Gmail account.

    8. In the IMAP Port field, enter the IMAP port number (for example, 993 for Gmail account).

    9. In the Username field, enter the email address that you configured in Step 4(b) of Configuring Alerts in STA.

    10. In the Password field, enter the password of the email address.

    11. Click Test to validate the connection.

    12. Click Save & exit.

    alt_text

    The instance (for example, STA_Account_Lockout_Alert_instance) is added.

    alt_text

Creating a Pre-Process Rule

You need to create a pre-process rule for the instances created in the Installing and Configuring a Mail Listener Integration Instance section to drop unwanted incidents created at Cortex XSOAR. The rule will allow the creation of incidents only for the required STA alerts and will reject all other emails.

Perform the following steps to create a pre-process rule:

  1. In the left panel, click Settings.

  2. In the right pane, under Settings, on the INTEGRATIONS tab, click the Pre-Process Rules subtab.

    alt_text

For Push Notification Rejection Alerts

  1. Perform the following steps to create a pre-process rule for Push Notification Rejection alert:

    1. Click New Rule and in the Rule name field, enter a name for the rule (for example, SafeNet Trusted Access - Push Reject Drop Rule).

      alt_text

    2. Under Conditions for Incoming Incident, click Add filter, and perform the following steps:

      1. In the Choose an incident field text box, search and select SourceInstance.

      2. Ensure that the Equal (Strings) condition is selected.

      3. In the Type a value text box, search and select the name of the Mail Listener v2 Integration Instance (for example, STA_Push_Reject_Alert_instance) that you entered in step 4(a) of Configuring the Mail Listener Integration Instance.

      alt_text

    3. Click Add Filter to add another filter and perform the following steps:

      1. In the Choose an incident field text box, search and select Name.

      2. Click Equals (String) condition and click on the Add icon alt_text.

      3. Search and select the Doesn't Contain (General) condition.

      4. In the Type a value text box, enter Push Notification Rejection Alert.

      alt_text

    4. Under Action, select Drop.

      alt_text

    5. Click Save. The SafeNet Trusted Access - Push Reject Drop Rule is added under Pre-Process Rules.

      alt_text

For Account Lockout Alerts

  1. Perform the following steps:

    1. Click New Rule and in the Rule name field, enter a name for the rule (for example, SafeNet Trusted Access – Account Lockout Drop Rule).

      alt_text

    2. Under Conditions for Incoming Incident, click Add filter, and perform the following steps:

      1. In the Choose an incident field text box, search and select SourceInstance.

      2. Ensure that the Equal (Strings) condition is selected.

      3. In the Type a value text box, search and select the name of the Mail Listener v2 Integration Instance (for example, STA_Account_Lockout_Alert_instance) that you entered in step 5(b) of Configuring the Mail Listener Integration Instance.

        alt_text

    3. Click Add Filter to add another filter and perform the following steps:

      1. In the Choose an incident field text box, search and select Name.

      2. Click Equals (String) condition and click on the Add icon alt_text.

      3. Search and select the Doesn't Contain (General) condition.

      4. In the Type a value text box, enter User Lockout Alert.

      alt_text

    4. Under Action, select Drop.

      alt_text

    5. Click Save. The SafeNet Trusted Access – Account Lockout Drop Rule is added under Pre-Process Rules.

      alt_text

Example Use-Cases

The following user cases for integrating a STA alerts and remediation actions on STA are explained below:

Adding a User to the Unusual Activity Group after receiving a push reject notification alert

A user is added to the Unusual Activity group after a push notification rejection alert is generated.

The alert handling process involves the following steps:

  1. STA sends an alert while rejecting a Push Notification event that indicates an attempt of breaking into the user’s account.

  2. Cortex XSOAR listens to the alert received from STA and classify the same in order to perform a remediation action.

The remediation process involves the following steps:

  1. Cortex XSOAR creates an incident, which automatically invokes a playbook that executes the security remediation steps.

  2. The remediation action involves, adding the user to a group (for a configured period of time) on which STA policies with stronger authentication requirements are imposed.

Configuring the Alert

The following steps need to be performed to configure the alert:

  1. Perform all the steps as mentioned in the Invoking Remediation Actions on STA section.

  2. Integrate the Reject Push Authentication alert as described in the Integrating Alerts from STA section.

Validating the Use Case

  1. Log in to the STA User Portal using the MobilePASS+ authentication.

  2. On receiving the Push notification, tap Deny.

    alt_text

  3. Tap Report.

  4. Log in to the configured email address to see the Push Notification Rejection alert email as shown below.

    alt_text

  5. On the Cortex XSOAR dashboard, in the left pane, click Incidents.

    alt_text

  6. In the right pane, click Refresh to refresh the window.

    alt_text

  7. Under Incidents, a new incident is displayed. In the ID column, click the incident ID (for example, #363).

    alt_text

    On the Incident Info window, on the Incident Info tab, details of the incident are displayed.

    alt_text

  8. Click the Work Plan tab to verify that SafeNet Trusted Access – Add to Unusual Activity Group playbook is automatically executed. The playbook will add the user to the Unusual Activity group for the configured period of time.

    alt_text

  9. Log into the User Portal using the same credentials to verify if the policies configured for the group (for example, Unusual Activity group) have been applied.

    As shown in the below screen shot, the incident gets automatically closed when the configured time duration is over and the user would be removed from Unusual Activity group.

    alt_text

    The playbook is fully automated and the incident gets automatically closed after the successful execution of the playbook. If you manually close the incident, you need to ensure that the user is removed from the user group (for example, Unusual Activity group). Refer to the below screen shot:

    alt_text

Terminating a User’s Single Sign On Session after Receiving an Account Lockout Alert

A user's SSO session is terminated after an account lockout alert is received for the user’s account to provide stronger protection on the next login attempt by enforcing a new login session.

The alert handling process involves the following steps:

  1. STA sends an Account Lockout alert on exceeding the maximum number of consecutive failed authentication attempts.

  2. Cortex XSOAR listens to the alert received from STA and classify the same in order to perform remediation action.

The remediation process involves the following steps:

  1. Cortex XSOAR creates an incident, which automatically invokes a playbook that executes the security remediation steps.

  2. The remediation action involves terminating the user's SSO sessions so that when the account gets unlocked, upon the follow up next login attempt, a new session is needed and authentication is required.

Configuring the Alert

The following steps need to be performed to configure the alert:

  1. Perform the following steps as mentioned in the Invoking Remediation Actions on STA section:

    1. Generating an API key

    2. Installing and configuring SafeNet Trusted Access integration instance

  2. Integrate the Reject Push Authentication alert as described in the Integrating Alerts from STA section.

Validating the User Case

  1. Log in to the STA User Portal.

  2. In the left pane, click the Applications alt_text icon.

  3. In order to create use-case scenario, perform the following steps:

    1. Open the STA User Portal login URL in the incognito mode of the web browser.

    2. Exceed the maximum number of consecutive failed authentication attempts (by default, maximum number is 3) using a wrong password or token. As a result, the your account will be locked.

  4. Log in to the configured email address to see the Account Lockout alert.

    alt_text

  5. On the Cortex XSOAR dashboard, in the left pane, click Incidents.

    alt_text

  6. In the right pane, click Refresh to refresh the window.

    alt_text

  7. Under Incidents, a new incident is displayed. In the ID column, click the incident ID (for example, #356).

    alt_text

    On the Incident Info window, on the Incident Info tab, details of the incident are displayed.

    alt_text

  8. Click the Work Plan tab to verify that SafeNet Trusted Access – Add to Unusual Activity Group playbook is automatically executed.

    alt_text

  9. In the User Portal Applications tab, which you have opened in Step 2, click on any application that you want to access. Now, full authentication is required to access the application as user SSO sessions are terminated.

    As shown in the below screen shot, the incident is automatically closed after two minutes.

    alt_text