Client key guide

Client keys are used to perform the encryption and decryption operations in combination with the keys stored in ZeroKMS. Before you create a client, first create a dataset.

Creating a client

When you create a client you'll need to provide a name and a dataset ID. The dataset ID is the ID of the dataset you want to associate this client with. A client belongs to a single dataset, but a dataset can have multiple clients.

You will need the CipherStash CLI installed to create a client. If you don't have the CLI installed, follow the instructions for installing the CipherStash CLI.

1stash clients create --dataset-id $CS_DATASET_ID "CipherStash Proxy example application"

The output will look like this:

1Client created:
2Client ID  : <a UUID style ID>
3Name       : CipherStash Proxy example application
4Description:
5Dataset ID : <your provided dataset ID>
6
7#################################################
8#                                               #
9#  Copy and store these credentials securely.   #
10#                                               #
11#  THIS IS THE LAST TIME YOU WILL SEE THE KEY.  #
12#                                               #
13#################################################
14
15Client ID          : <a UUID style ID>
16
17Client Key [hex]   : <a long hex string>

Note down the client key somewhere safe, like a password vault. You will not be able to see the client key again. You can also set local environment variables to make it easier to use the key info in the next steps:

1export CS_CLIENT_ID=<your client ID>
2export CS_CLIENT_KEY=<your client key>