Integrating SSH

Capabilities

DataGrail's SSH integration provides the following capabilities:

Product	Capability
Request Manager	Request Types Access, Deletion, Do Not Sell/Share, Identifiers Identifier Categories Any

Before You Start

To successfully configure this integration, please ensure you have sufficient privileges:

• DataGrail User Role: Super Admin, Connections Manager
• SSH User Role: Admin
• Secrets Manager: Write Access

Connecting with RM Agent

The Request Manager Agent allows you to automate Data Subject Requests by connecting to internal systems within your network, and without requiring ingress from the public network.

The Agent connects to your SSH instance using least privileged credentials that you will create and store in a secrets manager. When configuring the SSH integration in DataGrail, only the location of that secrets manager entry will be referenced (e.g., AWS Secrets Manager ARN), which ensures that no secrets are shared directly with DataGrail.

Prerequisites

Before you can connect to SSH, ensure the following:

• RM Agent is deployed and connected in DataGrail.
• Network is configured to allow the Agent to connect with the SSH instance.

Create and Store Credentials

1. In SSH, create a new user for the agent using either password or private key authentication (recommended).

2. Configure the following JSON key-value pairs:

   {
     "username": "<agent user>",
     "password": "(optional) <agent password>",
     "private_key": "(preferred over password) <PEM encoded private key>",
     "server": "<hostname or IP Address of server>",
     "port": "(optional) <port to connect to, defaults to 22>"
   }

3. Store the JSON value in your vault with an entry name like datagrail-rm-agent-ssh.

4. Ensure that the agent is configured to retrieve the value of this vault entry.

Add the Agent Integration

1. In DataGrail, navigate to Agents and select your Agent.
2. In the top right, select Add New Integration and search for SSH.
3. Under Enabled Capabilities and Enabled Identifiers, select only those that will be used for this integration.
4. Enter the Credentials Location (e.g. AWS Secrets Manager ARN).
5. Select the Data Retrieval behavior for deletion requests.
   warning

   When using Retrieve Data, the data reviewed may not be exactly what is deleted due to the access and deletion logic executing separately!

6. Under Agent Query Configuration, add request logic to be executed within SSH for all enabled request types.
   Query Parameter Format

   Use format paramstyle when formatting query parameters with identifiers (e.g., email, user_id).

   Example:

   /path/to/script.sh {email}

7. Finally, select Configure Integration. Wait a few moments to ensure that the connection is successful. For failed connections, review the Agent container logs for additional details.

---

Troubleshooting

If you are unable to successfully connect the integration, review these common troubleshooting steps:

Agent Unable to Connect to SSH

1. Verify that the network is configured to allow the Agent to connect with the SSH instance.
2. Verify the Agent has permissions to access the SSH credentials stored in your vault.

Agent is Not Connected in DataGrail

1. Confirm that the Agent is running, and logs do not indicate any errors.
2. The DataGrail API Key used by the Agent is valid and not expired.
3. The Agent has permissions to access the DataGrail API Key stored in your vault.
4. Network egress is permitted from the Agent to your DataGrail domain.

Technical Details

Access Type	Synchronous
Deletion Type	Synchronous (Whole Record)
Opt Out Type	Synchronous