Getting Started with External Key Source Connection

Prev Next

1.0 Introduction

This article helps you get started with the Fortanix Key Insight external key sources (Fortanix-Data-Security-Manager (DSM)) connection.

It also describes:

  • How to configure Fortanix DSM Software-as-a-Service (SaaS) environment to scan the keys and services in Fortanix Key Insight.

  • How to configure Fortanix DSM on-premises environment to scan the keys and services in Fortanix Key Insight.

  • How to scan external Hardware Security Models (HSMs) using Fortanix DSM HSM Gateway.

2.0 Terminology References

For the external key source connection concepts and supported features, refer to External Key Source Connection Concepts.

3.0 Start the Connection Setup

Before configuring an external key source connection, ensure you can access Fortanix Key Insight.

For information about signing up for Fortanix Armor, creating an Armor account, and accessing Fortanix Key Insight, refer to Getting Started with Key Insight.

You can start the connection setup when you first access Fortanix Key Insight or after you have entered the application.

4.0 Configure Fortanix DSM (SaaS) Connection

After you access the Key Insight solution from Fortanix Armor, if you want to onboard an external key source, that is, a Fortanix DSM (SaaS) connection, you must configure it to scan your keys and services.

4.1 Prerequisites

The following are the prerequisites to add a Fortanix DSM (SaaS) connection to Fortanix Key Insight:

  • Fortanix DSM Account Setup: A valid and active Fortanix DSM (SaaS) account is required to enable communication between Fortanix DSM and Key Insight.

  • Application Configuration: An application (app) must be created in Fortanix DSM (SaaS) to enable interaction between the two solutions. This application defines the roles and permissions required for key management.

  • Security Objects Setup: Security objects, such as keys or key versions, must be created and configured within Fortanix DSM (SaaS) to allow secure key management and usage by Fortanix Key Insight.

  • Group Configuration: User groups or access policies should be configured in Fortanix DSM (SaaS) to ensure appropriate access control and permissions for users interacting with keys through Fortanix Key Insight.

For more information on how to set up the above, refer to Getting Started with Fortanix DSM - UI.

4.2 Select Connection Type

Perform the following steps to select the scan type, connection type, and external KMS key type:

  1. On the Select External KMS Type step, select Automated Scan as the scan type.

  2. Under Select connection type, select External Key SourceConnections. Then, under Select external key source type, select Fortanix DSM (SaaS).

  3. Click NEXT.

Figure 1: Select a DSM (SaaS) provider

4.3 Set Up DSM (SaaS) Connection

Perform the following steps to add a Fortanix DSM (SaaS) connection on the Set Up DSM (SaaS) Connection step:

  1. Connection name: Enter a name for your Fortanix DSM  (SaaS) connection.

  2. Region: Select the required region from the drop down. For example, North America. For the list of all supported regions, refer to Fortanix DSM SaaS Global Availability Map.

  3. This will create a DSM Connection. The connection can be deleted later from the connections screen: Select thecheck box to confirm that a Fortanix DSM SaaS connection will be created. The connection appears on the EXTERNAL KEY SOURCE tab on the Connections page, but it will not yet be integrated with Fortanix DSM.

  4. Click ADD CONNECTION & PROCEED.

Figure 2: Add DSM (SaaS) connection

4.4 Add Admin App UUID

Perform the following steps to configure the private key and certificate on the Add Admin App UUID step:

  1. Click GENERATE PRIVATE KEY to create a private key. You can generate a maximum of two private keys.

    • Click GENERATE ANOTHER PRIVATE KEY to generate an additional key.

    • You can delete the private key using .

  2. Click GENERATE CERTIFICATE to generate a self-signed certificate. This option becomes available only after a private key has been generated..

    • You can copy the generated certificate details.

    • You can also RE-GENERATE THE CERTIFICATE, if required.

  3. After generating and downloading the certificate,

    1. Log in to your Fortanix DSM account in the same region selected in Step 2 ofSection 4.3: Set Up DSM (SaaS) Connection above to ensure proper correlation.

    2. Create an administrative (admin) app using the steps mentioned in Authentication, selecting Certificate as the authentication method, and uploading the certificate generated in Step 2.

    3. After creating the admin app, copy the UUID value.

  4. Admin app UUID: Enter the value obtained from Fortanix DSM (SaaS) admin app.

    NOTE

    It is recommended to use a unique Fortanix DSM admin app UUID for each Fortanix DSM (SaaS) connection in Fortanix Key Insight to prevent performance degradation and reduce unnecessary clutter.

  5. Click CONNECT to establish the connection between Fortanix DSM (SaaS) and Fortanix Key Insight. If your credentials (region and certificate) are incorrect, an error message appears. Ensure you use the correct credentials to establish the connection with Fortanix DSM (SaaS).

Figure 3: Configure Fortanix DSM (SaaS) in Fortanix Key Insight

NOTE

After onboarding the Fortanix DSM (SaaS) connection:

  • Access the Overview and Keys user interface (UI). You can also switch the region using the region switcher drop down located on the top navigation bar. When the region is changed, the UI updates automatically to show the data, connections, and scan results for that region.

    For more information on the external key source (Fortanix DSM SaaS) UI, refer to External Key Source Connection - User Interface Components.

  • Users with the Account Administrator and Group Administrator roles can manage (edit, delete, rescan) the connection from the Configuration → Connections → EXTERNAL KEY SOURCE.

    • If you edit the Fortanix DSM (SaaS) connection, rescan both the Fortanix DSM (On-premises) connection and its associated parent connection (if any) to apply the changes.

    • Deleting the Fortanix DSM (SaaS) connection cannot be undone.

    • The Rescan option is available only when the Fortanix DSM (SaaS) connection status is Connected.

    • After rescanning the Fortanix DSM (SaaS) connection, manually rescan the linked Fortanix Key Insight cloud or on-premises connection (if any) to update the correlated key data.

  • A group with the same name will be created on the Fortanix IAM Groups page. For more information on Groups, refer to Fortanix Armor Identity and Access Management (IAM)  

  • All security objects in your Fortanix DSM (SaaS) account that are accessible to the admin application will be imported into Fortanix Key Insight.

5.0 Configure Fortanix DSM (On-premises) Connection

After accessing the Fortanix Key Insight solution from Fortanix Armor, if you want to onboard an external key source, that is, a Fortanix DSM (On-premises) connection, you need to configure it to scan your keys and services.

5.1 Prerequisites

For prerequisites, refer to Getting Started with On-premises Connection.

5.2 Select Connection Type

Perform the following steps to select the scan type, connection type, and external KMS key type:

  1. On the Select Connection Type step, select Automated Scan as the scan type.

  2. Under Select connection type, select External Key Source Connections. Then, under Select external key source type, select Fortanix DSM (On-Premises).

  3. Click NEXT.

Figure 4: Select DSM (On-Premises) provider

NOTE

You can also add a Fortanix DSM (On-premises) connection by clicking ADD EXTERNAL KEY SOURCE in the top-right corner of the EXTERNAL KEY SOURCE tab on the Connections page.

5.3 Set Up Fortanix DSM (On-premises) Connection

Perform the following steps to add a Fortanix DSM (On-premises) connection on the Set Up DSM (On-Premises) Connection step:

  1. Connection name: Enter a name for your Fortanix DSM (On-premises) connection.

  2. This will create a DSM Connection. The connection can be deleted later from the connections screen: Select the check box to confirm that a Fortanix DSM SaaS connection will be created. The connection appears on the EXTERNAL KEY SOURCE tab on the Connections page, but it will not yet be integrated with Fortanix DSM.

  3. Click Fortanix on-premises scanner package to download the Fortanix On-premises Scanner for Fortanix DSM on-premises connection.

    1. After downloading the package, install it depending on your operating system (Linux or Windows).

    2. After installing the package, configure the Fortanix DSM on-premises connection using the configuration file.

      For information on Fortanix DSM On-premises connection configuration file parameters, refer to On-premises Scanner Configuration File.

    3. After configuration, execute the Fortanix On-premises Scanner package depending on your operating system (Linux or Windows).

  4. After installing and configuring the package, select the I have downloaded and installed the Scanner package check box.

  5. Click ADD DSM & GENERATE API KEY to add the scanner using the generated API key.

  6. In the API Key Details dialog box, click COPY API KEY to copy the API key value. This value is used to authenticate both the Fortanix On-premises Scanner and Fortanix Key Insight.

  7. Close the dialog box to complete the onboarding.

Figure 5: Configure a Fortanix DSM on-premises connection

NOTE

After onboarding the Fortanix DSM (On-premises) connection:

  • You can verify the connection status on the EXTERNAL KEY SOURCE tab.

    • If the status is Connected, you can access the Overview and Keys UI. You can alsoswitch the regionusing the region switcher drop down located on the top navigation bar. When the region is changed, the UI updates automatically to show the data, connections, and scan results for that region.

      For more information on the UI, refer to External Key Source Connection - User Interface Components.

    • If the status is Disconnected, restart the scanner to re-establish the connection.

    • If the status is Pending, use the generated API key to connect to Fortanix Key Insight. After the connection is established, add the resources to begin scanning.

  • Users with theAccount AdministratorandGroup Administratorroles can manage (edit, delete, rescan, and view details) the connection from the Configuration → Connections → EXTERNAL KEY SOURCE.

    • If you edit the Fortanix DSM (On-premises) connection, rescan both the Fortanix DSM (On-premises) connection and its associated parent connection (if any) to apply the changes.

    • Deleting the Fortanix DSM (On-premises) connection cannot be undone.

    • The Rescan option is available only when the Fortanix DSM (On-premises) connection status is Connected.

      • After rescanning the Fortanix DSM (On-premises) connection, manually rescan the linked Fortanix Key Insight cloud or on-premises connection (if any) to update the correlated key data.

    • When viewing the connection details:

      • Copy the Connection ID. This value is required in the Fortanix On-premises Scanner configuration.

      • Click MANAGE API KEY to manage (copy, delete, regenerate) the API key geneated.

        • You can generate a maximum of two API keys for configuring the connection between Fortanix DSM (On-premises) and Fortanix Key Insight.

        • Deleting an API key may revoke access for the Fortanix DSM (On-premises) connection, potentially disrupting its functionality. This action is irreversible.

      • Click DOWNLOAD PACKAGE to download the package again in case you changed your machine, your current package has errors or was not installed correctly.

      Figure 6: View Fortanix DSM (on-premises) key details

  • A group with the same name will be created on the Fortanix IAM Groups page. For more information on Groups, refer to Fortanix Armor Identity and Access Management (IAM).

6.0 Scanning External HSMs Using Fortanix DSM HSM Gateway

Fortanix Key Insight supports scanning cryptographic keys stored in external HSMs using the Fortanix DSM (SaaS or on-premises) HSM Gateway.

NOTE

Before scanning, ensure the following:

  • The Fortanix DSM instance (SaaS or on-premises) already connected to Fortanix Key Insight.

  • Fortanix DSM HSM Gateway installed and connected to the target HSM.

In this scanning process,

  1. Fortanix Key Insight connects to Fortanix DSM, which uses the HSM Gateway to reach the external HSM.

  2. Fortanix Key Insight requests key information from Fortanix DSM.

  3. Fortanix DSM retrieves the details from the HSM through the gateway and returns them to Fortanix Key Insight.

This setup allows Fortanix Key Insight to,

  • Collect and view keys from different HSMs in one place, without needing a direct connection between Fortanix Key Insight and the external HSM.

  • Include the keys in security and compliance reports, such as CBOM.

  • Prepare for post-quantum readiness by including keys managed in external HSMs.

For detailed steps on how to add a new HSM Gateway to the Fortanix DSM, refer to HSM Gateway.

Fortanix-logo

4.6

star-ratings

As of August 2025