Common terminology that will be referenced throughout this documentation
In order to organize and maintain access to Secrets, Keeper Secrets Manager uses structures called Applications and Clients.
Keeper Secrets Manager Structure
Read below about how each of these items function in Secrets Manager.
Secrets are stored as records in the Keeper Vault and are typically stored as attachments or fields in these records.
Any record or shared folder from the vault can be shared with an Application.
Keeper Secrets Manager Applications are assigned to specific secrets or shared folders. The application is a container of permissions, client devices, audit trail, and history. An application can only decrypt the records assigned.
An application can have up to 500 records shared with it. It is recommended to use least privilege, ensuring client devices only have access to the records they need. The user of the Vault can have unlimited secrets.
An example of an Application would be a Production Github Actions pipeline or Jenkins server.
A Client device is any endpoint that needs to access secrets associated with an Application. This can be a physical device, virtual device, or cloud-based device. A client device can also be identified by any software application running in the cloud or CI/CD tool.
Each Client device has a unique key to read and access the secrets.
Clients adhere to the following:
- One Time Access Tokens used for initialization that expire after 24 hours
- IP Address lock (optional)
- Access expiration (optional)
An example of a Client Device would be a development machine, Terraform script or a Github Actions instance. At least one client device is required to access secrets that are associated with an Application. Multiple client devices can be associated with the same Application.
A Secrets Manager "Configuration" is a set of tokens that includes encryption keys, client identifiers and destination server information used to authenticate and decrypt data from the Keeper Secrets Manager APIs.
Secrets Manager configurations are created from One Time Access Tokens and have a one to one relationship with client devices.
A configuration can be stored as a text file with JSON, or it can be encoded into a single line string.