Enterprise Recon 2.16.0

Azure

This section covers the following topics:

Azure Cosmos DB

Licensing

All scanned Azure Cosmos DB Targets consume data from the Sitewide License data allowance limit.

See Target Licenses for more information.

Requirements

Requirements Description
Proxy Agent
  • Proxy Agent host with direct Internet access.
  • Cloud service-specific access keys.
Required Proxy Agents:
  • Windows Agent with database runtime components
  • Windows Agent
  • Linux Agent with database runtime components
  • Linux Agent
TCP Allowed Connections Port 443

Configure Azure Cosmos DB Credentials

Azure Cosmos DB target can be authenticated using any of the three methods:

Get Azure Cosmos DB Account Access Keys

  1. Log in to your Azure account and go to your Azure Cosmos DB account page.
  2. Under Settings, click Keys.
  3. Note down the Primary Key and Secondary Key. Use the active access key to connect ER2 to your Azure Cosmos DB account.

Generate Client ID and Tenant ID Key

  1. With your administrator account, log in to the Azure app registration portal.
  2. In the App registrations page, click + New registration.
  3. In the Register an application page, fill in the following fields:

    Field Description
    Name Enter a descriptive display name for ER2. For example, Enterprise Recon.
    Supported account types Select Accounts in this organizational directory only.
  4. Click Register. You will be redirected to the Overview page for the newly registered app, Enterprise Recon.
  5. Take down the Application (client) ID and Directory (tenant) ID.

    Enterprise Recon app Overview in the Microsoft Azure app registration portal.

Generate Client Secret Key

  1. With your administrator account, log in to the Azure app registration portal.
  2. In the App registrations page, go to the Owned applications tab. Click on the app that you registered (e.g. Enterprise Recon) when generating the Client ID and Tenant ID key.
  3. In the Manage panel, click Certificates & secrets.
  4. In the Client secrets section, click + New client secret.
  5. In the Add a client secret page, fill in the following fields:

    Field Description
    Description Enter a descriptive label for the Client Secret key.
    Expires Select a validity period for the Client Secret key.
  6. Click Add. The Value column will contain the Client Secret key.

    Newly created Client Secret key for the Enterprise Recon app.

  7. Copy and save the Client Secret key to a secure location.

Generate a Client Certificate

  1. Obtain Signed SSL Certificate or generate a self-signed certificate by running the following commands:

    # Generate a new private key with passphrase # Syntax: openssl genrsa -aes256 -out <private-key-filename>.pem 2048 openssl genrsa -aes256 -out private-key.pem 2048 Alternative: Generate a new private key without passphrase openssl genrsa -out private-key.pem 2048
    # Generate certificate and provide the details for the certificate when prompted # Where <private-key-file> is the newly generated private key from the previous command # Syntax: openssl req -new -x509 -sha256 -days 365 -key <private-key>.pem -out <public-cert-filename>.pem openssl req -new -x509 -sha256 -days 365 -key private-key.pem -out public-cert.pem

  2. Upload the certificate to your registered application.

    1. With your administrator account, log in to the Azure app registration portal.
    2. In the App registrations page, go to the Owned applications tab.
    3. Click on the app that you registered (e.g. Enterprise Recon) when generating the Client ID and Tenant ID key.
    4. In the Manage panel, click Certificates & secrets.
    5. In the Certificates section, click Upload certificate.
    6. From the dropdown, select your certificate in PEM format.
    7. In the Description field, enter a description for the certificate.
    8. Click Add.

Set up Azure Cosmos DB as a Target

To add an Azure Cosmos DB Target:

  1. From the New Scan page, Add Targets.
  2. In the Select Target Type dialog box, click on Azure and select Azure Cosmos DB.
  3. Fill in the following fields:
    Dialog box to configure the path, credentials and proxy agent for an Azure Cosmos DB Target.

    Field Description
    Account Name

    Enter the Azure Cosmos DB account name.

    Example: mysqlaccount

    New Credential Label

    Enter a descriptive label for the Azure Cosmos DB credential set.

    Authentication Method If authenticating with master key:
    1. From the dropdown, select Master Key.
    2. In the Master Key field, enter the master key. See Get Azure Cosmos DB Account Access Keys.
    If authenticating with Microsoft Entra ID (Client Secret - AAD):
    1. Ensure the Service Principal has been assigned the required Cosmos DB Data-Plane RBAC role. See the cloud service provider's official documentation.
    2. From the dropdown, select Client Secret (AAD).
    3. In the New Client ID field, enter the client ID.

      Example: clientid-1234-5678-abcd-6d05bf28c2bf

      See Generate Client ID and Tenant ID Key for more information.

    4. In the New Client Secret field, enter the client secret key.

      Example: client~secret.key-CHvV1B5YQfr~6zDjEyv

      See Generate Client ID and Tenant ID Key for more information.

    5. In the Tenant ID field, enter the tenant ID.

      Example: tenantid-1234-abcd-5678-02011df316f4

      See Generate Client ID and Tenant ID Key for more information.

    If authenticating with Microsoft Entra ID (Client Certificate - AAD):
    1. Ensure the Service Principal has been assigned the required Cosmos DB Data-Plane RBAC role. See the cloud service provider's official documentation.
    2. From the dropdown, select Client Certificate (AAD).
    3. In the New Client ID field, enter the client ID.

      Example: clientid-1234-5678-abcd-6d05bf28c2bf

      See Generate Client ID and Tenant ID Key for more information.

    4. In the PEM File (cert + private key) field, upload the private key (*.pem) file.

      See Generate Client Certificate for more information.

    5. In the Tenant ID field, enter the tenant ID.

      Example: tenantid-1234-abcd-5678-02011df316f4

      See Generate Client ID and Tenant ID Key for more information.

    Agent to act as proxy host

    Select a Windows, Linux or macOS Proxy Agent host with direct Internet access.

  4. Click Test. If ER2 can connect to the Target, the button changes to a Commit button.
  5. Click Commit to add the Target.

Edit Azure Cosmos DB Target Path

To scan a specific Target location in Azure Cosmos DB:

  1. Set up Azure Cosmos DB as a Target.
  2. In the Select Locations section, select your Azure Cosmos DB Target location and click Edit.
  3. In the Edit Azure Cosmos DB Location dialog box, enter the Path to scan. Use the following syntax:

    Location Path syntax
    All locations Leave blank.
    All databases in the account name dbs
    Colls identifier for containers dbs\<database_name>
    All containers in the database dbs\<database_name>\colls
    Specific container dbs\<database_name>\colls\<container_name>
  4. Click Test and then Commit to save the path to the Target location.

Azure Storage

Overview

The instructions here work for setting up the following Azure Storage types as Targets:

  • Azure Blobs
  • Azure Tables
  • Azure Queues

To set up Azure Storage as a Target:

  1. Get Azure Account Access Keys
  2. Set up Azure Storage as a Target

To scan specific paths in an Azure Storage Target, see Edit Azure Storage Target Path.

Licensing

All scanned Azure Storage Targets consume data from the Sitewide License data allowance limit.

See Target Licenses for more information.

Requirements

Requirements Description
Proxy Agent
  • Proxy Agent host with direct Internet access.
  • Cloud service-specific access keys.
Required Proxy Agents:
  • Windows Agent with database runtime components
  • Windows Agent
  • Linux Agent with database runtime components
  • Linux Agent
TCP Allowed Connections Port 443

Get Azure Account Access keys

  1. Log in to your Azure account.
  2. Go to All resources > [Storage account], and under Settings, click on Access keys.
  3. Note down key1 and key2 which are your primary and secondary access keys respectively. Use the active access key to connect ER2 to your Azure Storage account.

Set up Azure as a Target Location

  1. From the New Scan page, Add Targets.
  2. In the Select Target Type dialog box, click on Azure Storage and select one of the following Azure Storage types:
    • Azure Blobs
    • Azure Queue
    • Azure Table
  3. Fill in the following fields:
    Dialog box to configure the path, credentials and proxy agent for an Azure Blob Target.

    Field Description
    Azure Account Name Enter your Azure account name.
    New Credential Label Enter a descriptive label for the credential set.
    New Username Enter your Azure Storage account name.
    New Password Enter either key1 or key2. See Get Azure Account Access Keys for more information.
    Agent to act as proxy host Select a Proxy Agent host with direct Internet access.
    Recommended Least Privilege User Approach

    To reduce the risk of data loss or privileged account abuse, the Target credentials provided for the intended Target should only be granted read-only access to the exact resources and data that require scanning. Never grant full user access privileges or unrestricted data access to any application if it is not required.

  4. Click Test. If ER2 can connect to the Target, the button changes to a Commit button.
  5. Click Commit to add the Target.

Edit Azure Storage Target Path

To scan a specific Target location in Azure Storage:

  1. Set up Azure Storage as a Target.
  2. In the Select Locations section, select your Azure Storage Target location and click Edit.
  3. In the Edit Azure Storage Location dialog box, enter the Path to scan. Use the following syntax:

    Azure Storage type Path syntax
    Azure Blobs To scan a specific folder:
    <folder_name>
    To scan a specific file:
    <[folder_name/]file_name.txt>
    Azure Table To scan a specific table:
    <table_name>
    Azure Queue To scan a specific Queue:
    <queue_name>
  4. Click Test and then Commit to save the path to the Target location.