Configure GCP Secret Manager Integration
Last modified on September 1, 2022
Secret Store integrations allow you to use your existing third-party secret stores with strongDM. Your credentials are stored in a tool that is controlled by you, and those credentials are never transmitted to strongDM in any form. If you would like to learn more about how this integration works and why you might wish to use it, please read the Secret Stores Reference.
This guide will walk you through how to integrate Google Cloud Platform (GCP) Secret Manager with strongDM and how to use it to connect to Resources.
Set up GCP Secret Manager
To get started with GCP Secret Manager, store credentials to some of your resources in it and note the correct paths to those credentials. Then, set up your Relay server to be able to authorize to the Secret Manager.
- Set up your credentials in GCP Secret Manager (if you have not already). You can store your credentials as plaintext, one value per secret (e.g., username as one secret, key as one secret, etc.) or you can store them as a JSON object, with multiple items in one secret, arranged as key-value pairs.
- Get application credentials for GCP, save them to your Relay server, and set the necessary environment variable that points to those credentials on your Relay server (
- Edit the file
/etc/sysconfig/sdm-proxy(unless you have moved or renamed your
sdm-proxyfile) and add the following lines, substituting your ID and key:
- Restart the
sdm-proxyservice (with something like
sudo systemctl restart sdm-proxy, depending on your distribution).
Configure the Secret Store in the Admin UI
Once you have GCP Secret Manager set up, credentials stored, and your Relay server able to access said credentials, it’s time to integrate the Secret Store with strongDM.
Add a Secret Store
- In the Admin UI, go to Network > Secret Stores.
- Click the add secret store button.
- On the Add Secret Store form, set the following:
- Display Name: Enter a name. This name will show up in the Admin UI.
- Secret Store Type: Select GCP Secret Manager.
- Project ID: Add your GCP project ID.
The project ID is a value generated by GCP when you create a new project. You can find your project ID in the GCP Console by clicking your project name in the top left of the screen, which opens a project selection window:
In this example, the project ID to fill in to the Admin UI field is
Now that you have set up your Secret Store integration, if you’ve configured your Gateway/Relay server correctly to use this secret store for access and authorization, the green online indicator should display. If it does not, you can set up a Gateway/Relay now and tell it to use GCP for its secret storage.
Create a Resource
Create a Resource that uses the secret store, assign it to a Role that is assigned to a User, and verify that you can connect.
In the Admin UI, add a new Resource such as a Server or Datasource.
On the configuration dialog for that Resource, fill out the information for a Resource whose credentials you have stored in your secret store, paying particular attention to the following properties:
- Secret Store: Select GCP Secret Manager.
- Username (path): Enter the path to the secret in GCP Secret Manager (e.g.,
path/to/credential?key=optionalKeyName) The key argument is optional.
- Password (path): Enter the path to the secret in GCP Secret Manager (e.g.,
path/to/credential?key=optionalKeyName). The key argument is optional.
Please note the following about your GCP secret paths:
- Your secret path, when copied from GCP, will look similar to this:
projects/111222333444/secrets/demo-postgres?key=username. Note that strongDM will automatically prepend your project ID, versioning, and
secrets/to the path when interpreting it, so the value needed here is simply
- If your secret is stored as plaintext, with each credential in a different secret, you may just reference the secret’s path. The secret input does accept JSON, so you can store a username/password or key id/key value pair using JSON within a single secret if you desire.
- If you store your credentials as a JSON object rather than as individual plaintext secrets, you will need to also append
?key=username) to fetch the specific item you are looking for.
- To reference a Base64-encoded certificate, you will need to append a
?encoding=base64to your path. If the certificate is in a text field, the path looks like
example-secret?encoding=base64. If the certificate was stored as part of a JSON object, the path looks like
Click create to submit the form.
Grant access and test
- In the Admin UI, go to Infrastructure > Roles.
- Create a Role with an access rule that grants access to the Resource.
- Assign the Role to the User.
- Log in as that User in your local GUI (or have the User do so, if not yours).
- Verify that the Resource exists, test a connection, and execute a query.
Congratulations! You have connected to a Resource using Secret Store integration.
If any errors occur, contact strongDM Support.