User manual

– This file is auto-generated using the ckms markdown command. –

ckms¶

CLI used to manage the Cosmian KMS.

Usage¶

ckms <subcommand> [options]

Arguments¶

--conf [-c] <CONF> Configuration file location

Subcommands¶

access-rights [1] Manage the users’ access rights to the cryptographic objects

cc [2] Manage Covercrypt keys and policies. Rotate attributes. Encrypt and decrypt data

certificates [3] Manage certificates. Create, import, destroy and revoke. Encrypt and decrypt data

ec [4] Manage elliptic curve keys. Encrypt and decrypt data using ECIES

get-attributes [5] Get the KMIP object attributes and tags.

locate [6] Locate cryptographic objects inside the KMS

new-database [7] Initialize a new user encrypted database and return the secret (SQLCipher only).

rsa [8] Manage RSA keys

server-version [9] Print the version of the server

sym [10] Manage symmetric keys. Encrypt and decrypt data

login [11] Login to the Identity Provider of the KMS server using the OAuth2 authorization code flow.

logout [12] Logout from the Identity Provider.

markdown [13] Generate the CLI documentation as markdown

1 ckms access-rights¶

Manage the users’ access rights to the cryptographic objects

Usage¶

ckms access-rights <subcommand>

Subcommands¶

grant [1.1] Grant another user one or multiple access rights to an object

revoke [1.2] Revoke another user one or multiple access rights to an object

list [1.3] List the access rights granted on an object to other users

owned [1.4] List the objects owned by the calling user

obtained [1.5] List the access rights obtained by the calling user

1.1 ckms access-rights grant¶

Grant another user one or multiple access rights to an object

Usage¶

ckms access-rights grant [options] <USER> <OBJECT_UID> <OPERATIONS>...

Arguments¶

<USER> The user identifier to allow

<OBJECT_UID> The object unique identifier stored in the KMS

<OPERATIONS> The operations to grant (create, get, encrypt, decrypt, import, revoke, locate, rekey, destroy)

1.2 ckms access-rights revoke¶

Revoke another user one or multiple access rights to an object

Usage¶

ckms access-rights revoke [options] <USER> <OBJECT_UID> <OPERATIONS>...

Arguments¶

<USER> The user to revoke access to

<OBJECT_UID> The object unique identifier stored in the KMS

<OPERATIONS> The operations to revoke (create, get, encrypt, decrypt, import, revoke, locate, rekey, destroy)

1.3 ckms access-rights list¶

List the access rights granted on an object to other users

Usage¶

ckms access-rights list [options] <OBJECT_UID>

Arguments¶

<OBJECT_UID> The object unique identifier

1.4 ckms access-rights owned¶

List the objects owned by the calling user

Usage¶

ckms access-rights owned

1.5 ckms access-rights obtained¶

List the access rights obtained by the calling user

Usage¶

ckms access-rights obtained

2 ckms cc¶

Manage Covercrypt keys and policies. Rotate attributes. Encrypt and decrypt data

Usage¶

ckms cc <subcommand>

Subcommands¶

keys [2.1] Create, destroy, import, export, and rekey Covercrypt master and user keys

policy [2.2] Extract, view, or edit policies of existing keys, and create a binary policy from specifications

encrypt [2.3] Encrypt a file using Covercrypt

decrypt [2.4] Decrypt a file using Covercrypt

2.1 ckms cc keys¶

Create, destroy, import, export, and rekey Covercrypt master and user keys

Usage¶

ckms cc keys <subcommand>

Subcommands¶

create-master-key-pair [2.1.1] Create a new master key pair for a given policy and return the key IDs.

create-user-key [2.1.2] Create a new user decryption key given an access policy expressed as a boolean expression.

export [2.1.3] Export a key from the KMS

import [2.1.4] Import a private or public key in the KMS.

revoke [2.1.5] Revoke a Covercrypt master or user decryption key

destroy [2.1.6] Destroy a Covercrypt master or user decryption key

rekey [2.1.7] Rekey the master and user keys for a given access policy.

prune [2.1.8] Prune the master and user keys for a given access policy.

2.1.1 ckms cc keys create-master-key-pair¶

Create a new master key pair for a given policy and return the key IDs.

Usage¶

ckms cc keys create-master-key-pair [options]

Arguments¶

--policy-specifications [-s] <POLICY_SPECIFICATIONS_FILE> The JSON policy specifications file to use to generate the master keys. See the inline doc of the create-master-key-pair command for details

--policy-binary [-b] <POLICY_BINARY_FILE> When not using policy specifications, a policy binary file can be used instead. See the policy command, to create this binary file from policy specifications or to extract it from existing keys

--tag [-t] <TAG> The tag to associate with the master key pair. To specify multiple tags, use the option multiple times

2.1.2 ckms cc keys create-user-key¶

Create a new user decryption key given an access policy expressed as a boolean expression.

Usage¶

ckms cc keys create-user-key [options] <MASTER_PRIVATE_KEY_ID> <ACCESS_POLICY>

Arguments¶

<MASTER_PRIVATE_KEY_ID> The master private key unique identifier

<ACCESS_POLICY> The access policy as a boolean expression combining policy attributes

--tag [-t] <TAG> The tag to associate with the user decryption key. To specify multiple tags, use the option multiple times

2.1.3 ckms cc keys export¶

Export a key from the KMS

Usage¶

ckms cc keys export [options] <KEY_FILE>

Arguments¶

<KEY_FILE> The file to export the key to

--key-id [-k] <KEY_ID> The key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--key-format [-f] <KEY_FORMAT> The format of the key

json-ttlv [default]. It should be the format to use to later re-import the key
sec1-pem and sec1-deronly apply to NIST EC private keys (Not Curve25519 or X448)
pkcs1-pem and pkcs1-der only apply to RSA private and public keys
pkcs8-pem and pkcs8-der only apply to RSA and EC private keys
spki-pem and spki-der only apply to RSA and EC public keys
raw returns the raw bytes of
- symmetric keys
- Covercrypt keys
- wrapped keys

Possible values: "json-ttlv", "sec1-pem", "sec1-der", "pkcs1-pem", "pkcs1-der", "pkcs8-pem", "pkcs8-der", "spki-pem", "spki-der", "raw" [default: "json-ttlv"]

--unwrap [-u] <UNWRAP> Unwrap the key if it is wrapped before export

Possible values: "true", "false" [default: "false"]

--wrap-key-id [-w] <WRAP_KEY_ID> The id of the key/certificate to use to wrap this key before export

--allow-revoked [-i] <ALLOW_REVOKED> Allow exporting revoked and destroyed keys. The user must be the owner of the key. Destroyed keys have their key material removed.

Possible values: "true", "false" [default: "false"]

2.1.4 ckms cc keys import¶

Import a private or public key in the KMS.

Usage¶

ckms cc keys import [options] <KEY_FILE> [KEY_ID]

Arguments¶

<KEY_FILE> The KMIP JSON TTLV key file

<KEY_ID> The unique id of the key; a unique id based on the key material is generated if not specified

--key-format [-f] <KEY_FORMAT> The format of the key

Possible values: "json-ttlv", "pem", "sec1", "pkcs1-priv", "pkcs1-pub", "pkcs8", "spki", "aes", "chacha20" [default: "json-ttlv"]

--public-key-id [-p] <PUBLIC_KEY_ID> For a private key: the corresponding public key id if any

--private-key-id [-k] <PRIVATE_KEY_ID> For a public key: the corresponding private key id if any

--certificate-id [-c] <CERTIFICATE_ID> For a public or private key: the corresponding certificate id if any

--unwrap [-u] <UNWRAP> In the case of a JSON TTLV key, unwrap the key if it is wrapped before storing it

Possible values: "true", "false" [default: "false"]

--replace [-r] <REPLACE_EXISTING> Replace an existing key under the same id

Possible values: "true", "false" [default: "false"]

--tag [-t] <TAG> The tag to associate with the key. To specify multiple tags, use the option multiple times

2.1.5 ckms cc keys revoke¶

Revoke a Covercrypt master or user decryption key

Usage¶

ckms cc keys revoke [options] <REVOCATION_REASON>

Arguments¶

<REVOCATION_REASON> The reason for the revocation as a string

--key-id [-k] <KEY_ID> The key unique identifier of the key to revoke. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.1.6 ckms cc keys destroy¶

Destroy a Covercrypt master or user decryption key

Usage¶

ckms cc keys destroy [options]

Arguments¶

--key-id [-k] <KEY_ID> The key unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.1.7 ckms cc keys rekey¶

Rekey the master and user keys for a given access policy.

Usage¶

ckms cc keys rekey [options] <ACCESS_POLICY>

Arguments¶

<ACCESS_POLICY> The access policy to rekey. Example: department::marketing && level::confidential

--key-id [-k] <SECRET_KEY_ID> The private master key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.1.8 ckms cc keys prune¶

Prune the master and user keys for a given access policy.

Usage¶

ckms cc keys prune [options] <ACCESS_POLICY>

Arguments¶

<ACCESS_POLICY> The access policy to prune. Example: department::marketing && level::confidential

--key-id [-k] <SECRET_KEY_ID> The private master key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.2 ckms cc policy¶

Extract, view, or edit policies of existing keys, and create a binary policy from specifications

Usage¶

ckms cc policy <subcommand>

Subcommands¶

view [2.2.1] View the policy of an existing public or private master key.

specs [2.2.2] Extract the policy specifications from a public or private master key to a policy specifications file

binary [2.2.3] Extract the policy from a public or private master key to a policy binary file

create [2.2.4] Create a policy binary file from policy specifications

add-attribute [2.2.5] Add an attribute to the policy of an existing private master key.

remove-attribute [2.2.6] Remove an attribute from the policy of an existing private master key. Permanently removes the ability to use this attribute in both encryptions and decryptions.

disable-attribute [2.2.7] Disable an attribute from the policy of an existing private master key. Prevents the encryption of new messages for this attribute while keeping the ability to decrypt existing ciphertexts.

rename-attribute [2.2.8] Rename an attribute in the policy of an existing private master key.

2.2.1 ckms cc policy view¶

View the policy of an existing public or private master key.

Usage¶

ckms cc policy view [options]

Arguments¶

--key-id [-i] <KEY_ID> The public or private master key ID if the key is stored in the KMS

--key-file [-f] <KEY_FILE> If key-id is not provided, the file containing the public or private master key in TTLV format

--detailed [-d] <DETAILED> Show all the policy details rather than just the specifications

Possible values: "true", "false" [default: "false"]

2.2.2 ckms cc policy specs¶

Extract the policy specifications from a public or private master key to a policy specifications file

Usage¶

ckms cc policy specs [options]

Arguments¶

--key-id [-i] <KEY_ID> The public or private master key ID if the key is stored in the KMS

--key-file [-f] <KEY_FILE> If key-id is not provided, the file containing the public or private master key in JSON TTLV format

--specifications [-s] <POLICY_SPECS_FILE> The output policy specifications file

2.2.3 ckms cc policy binary¶

Extract the policy from a public or private master key to a policy binary file

Usage¶

ckms cc policy binary [options]

Arguments¶

--key-id [-i] <KEY_ID> The public or private master key ID if the key is stored in the KMS

--key-file [-f] <KEY_FILE> If key-id is not provided, the file containing the public or private master key in TTLV format

--policy [-p] <POLICY_BINARY_FILE> The output binary policy file

2.2.4 ckms cc policy create¶

Create a policy binary file from policy specifications

Usage¶

ckms cc policy create [options]

Arguments¶

--specifications [-s] <POLICY_SPECIFICATIONS_FILE> The policy specifications filename. The policy is expressed as a JSON object describing the Policy axes. See the documentation for details

--policy [-p] <POLICY_BINARY_FILE> The output binary policy file generated from the specifications file

2.2.5 ckms cc policy add-attribute¶

Add an attribute to the policy of an existing private master key.

Usage¶

ckms cc policy add-attribute [options] <ATTRIBUTE>

Arguments¶

<ATTRIBUTE> The name of the attribute to create. Example: department::rd

--hybridized <HYBRIDIZED> Set encryption hint for the new attribute to use hybridized keys

Possible values: "true", "false" [default: "false"]

--key-id [-k] <SECRET_KEY_ID> The private master key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.2.6 ckms cc policy remove-attribute¶

Remove an attribute from the policy of an existing private master key. Permanently removes the ability to use this attribute in both encryptions and decryptions.

Usage¶

ckms cc policy remove-attribute [options] <ATTRIBUTE>

Arguments¶

<ATTRIBUTE> The name of the attribute to remove. Example: department::marketing

--key-id [-k] <SECRET_KEY_ID> The private master key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.2.7 ckms cc policy disable-attribute¶

Disable an attribute from the policy of an existing private master key. Prevents the encryption of new messages for this attribute while keeping the ability to decrypt existing ciphertexts.

Usage¶

ckms cc policy disable-attribute [options] <ATTRIBUTE>

Arguments¶

<ATTRIBUTE> The name of the attribute to disable. Example: department::marketing

--key-id [-k] <SECRET_KEY_ID> The private master key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.2.8 ckms cc policy rename-attribute¶

Rename an attribute in the policy of an existing private master key.

Usage¶

ckms cc policy rename-attribute [options] <ATTRIBUTE> <NEW_NAME>

Arguments¶

<ATTRIBUTE> The name of the attribute to rename. Example: department::mkg

<NEW_NAME> The new name for the attribute. Example: marketing

--key-id [-k] <SECRET_KEY_ID> The private master key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

2.3 ckms cc encrypt¶

Encrypt a file using Covercrypt

Usage¶

ckms cc encrypt [options] <FILE>... <ENCRYPTION_POLICY>

Arguments¶

<FILE> The files to encrypt

<ENCRYPTION_POLICY> The encryption policy to encrypt the file with Example: “department::marketing && level::confidential”`

--key-id [-k] <KEY_ID> The public key unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data. This data needs to be provided back for decryption

2.4 ckms cc decrypt¶

Decrypt a file using Covercrypt

Usage¶

ckms cc decrypt [options] <FILE>...

Arguments¶

<FILE> The files to decrypt

--key-id [-k] <KEY_ID> The user key unique identifier If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data that was supplied during encryption

3 ckms certificates¶

Manage certificates. Create, import, destroy and revoke. Encrypt and decrypt data

Usage¶

ckms certificates <subcommand>

Subcommands¶

certify [3.1] Certify a Certificate Signing Request or a Public key to create a X509 certificate.

decrypt [3.2] Decrypt a file using the private key of a certificate

encrypt [3.3] Encrypt a file using the certificate public key

export [3.4] Export a certificate from the KMS

import [3.5] Import one of the following:

a certificate: formatted as a X509 PEM (pem), X509 DER (der) or JSON TTLV (json-ttlv)
a certificate chain as a PEM-stack (chain)
a PKCS12 file containing a certificate, a private key and possibly a chain (pkcs12)
the Mozilla Common CA Database (CCADB - fetched by the CLI before import) (ccadb)

revoke [3.6] Revoke a certificate

destroy [3.7] Destroy a certificate

3.1 ckms certificates certify¶

Certify a Certificate Signing Request or a Public key to create a X509 certificate.

Usage¶

ckms certificates certify [options]

Arguments¶

--certificate-id [-i] <CERTIFICATE_ID> The certificate unique identifier. A random one will be generated if not provided

--certificate-signing-request [-r] <CERTIFICATE_SIGNING_REQUEST> The path to a certificate signing request

--certificate-signing-request-format [-f] <CERTIFICATE_SIGNING_REQUEST_FORMAT> The format of the certificate signing request

Possible values: "pem", "der" [default: "pem"]

--public-key-id-to-certify [-p] <PUBLIC_KEY_ID_TO_CERTIFY> If not using a CSR, the id of the public key to certify

--subject-name [-s] <SUBJECT_NAME> When certifying a public key, the subject name to use

--issuer-private-key-id [-k] <ISSUER_PRIVATE_KEY_ID> The unique identifier of the private key of the issuer. A certificate must be linked to that private key if no issuer certificate id is provided

--issuer-certificate-id [-c] <ISSUER_CERTIFICATE_ID> The unique identifier of the certificate of the issuer. A private key must be linked to that certificate if no issuer private key id is provided

--days [-d] <NUMBER_OF_DAYS> The requested number of validity days The server may grant a different value

--certificate-extensions [-e] <CERTIFICATE_EXTENSIONS> The path to a X509 extension’s file, containing a v3_ca parag

--tag [-t] <TAG> The tag to associate to the certificate. To specify multiple tags, use the option multiple times

3.2 ckms certificates decrypt¶

Decrypt a file using the private key of a certificate

Usage¶

ckms certificates decrypt [options] <FILE>

Arguments¶

<FILE> The file to decrypt

--key-id [-k] <PRIVATE_KEY_ID> The private key unique identifier related to certificate If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data that was supplied during encryption

3.3 ckms certificates encrypt¶

Encrypt a file using the certificate public key

Usage¶

ckms certificates encrypt [options] <FILE>

Arguments¶

<FILE> The file to encrypt

--certificate-id [-k] <CERTIFICATE_ID> The certificate unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data. This data needs to be provided back for decryption

3.4 ckms certificates export¶

Export a certificate from the KMS

Usage¶

ckms certificates export [options] <CERTIFICATE_FILE>

Arguments¶

<CERTIFICATE_FILE> The file to export the certificate to

--certificate-id [-k] <UNIQUE_ID> The certificate unique identifier stored in the KMS; for PKCS#12, provide the private key id If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the certificate/private key when no unique id is specified. To specify multiple tags, use the option multiple times.

--format [-f] <OUTPUT_FORMAT> Export the certificate in the selected format

Possible values: "json-ttlv", "pem", "pkcs12" [default: "json-ttlv"]

--pkcs12-password [-p] <PKCS12_PASSWORD> Password to use to protect the PKCS#12 file

--allow-revoked [-i] <ALLOW_REVOKED> Allow exporting revoked and destroyed certificates or private key (for PKCS#12). The user must be the owner of the certificate. Destroyed objects have their key material removed.

Possible values: "true", "false" [default: "false"]

3.5 ckms certificates import¶

Import one of the following:

a certificate: formatted as a X509 PEM (pem), X509 DER (der) or JSON TTLV (json-ttlv)
a certificate chain as a PEM-stack (chain)
a PKCS12 file containing a certificate, a private key and possibly a chain (pkcs12)
the Mozilla Common CA Database (CCADB - fetched by the CLI before import) (ccadb)

Usage¶

ckms certificates import [options] [CERTIFICATE_FILE] [CERTIFICATE_ID]

Arguments¶

<CERTIFICATE_FILE> The input file in PEM, KMIP-JSON-TTLV or PKCS#12 format

<CERTIFICATE_ID> The unique id of the leaf certificate; a unique id based on the key material is generated if not specified. When importing a PKCS12, the unique id will be that of the private key.

--format [-f] <INPUT_FORMAT> Import the certificate in the selected format

Possible values: "json-ttlv", "pem", "der", "chain", "ccadb", "pkcs12" [default: "json-ttlv"]

--private-key-id [-k] <PRIVATE_KEY_ID> The corresponding private key id if any. Ignored for PKCS12 and CCADB formats

--public-key-id [-q] <PUBLIC_KEY_ID> The corresponding public key id if any. Ignored for PKCS12 and CCADB formats

--issuer-certificate-id [-i] <ISSUER_CERTIFICATE_ID> The issuer certificate id if any. Ignored for PKCS12 and CCADB formats

--pkcs12-password [-p] <PKCS12_PASSWORD> PKCS12 password: only available for PKCS12 format

--replace [-r] <REPLACE_EXISTING> Replace an existing certificate under the same id

Possible values: "true", "false" [default: "false"]

--tag [-t] <TAG> The tag to associate with the certificate. To specify multiple tags, use the option multiple times

3.6 ckms certificates revoke¶

Revoke a certificate

Usage¶

ckms certificates revoke [options] <REVOCATION_REASON>

Arguments¶

<REVOCATION_REASON> The reason for the revocation as a string

--certificate-id [-k] <CERTIFICATE_ID> The certificate unique identifier of the certificate to revoke. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the certificate when no certificate id is specified. To specify multiple tags, use the option multiple times

3.7 ckms certificates destroy¶

Destroy a certificate

Usage¶

ckms certificates destroy [options]

Arguments¶

--certificate-id [-k] <CERTIFICATE_ID> The certificate unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the certificate when no certificate id is specified. To specify multiple tags, use the option multiple times

4 ckms ec¶

Manage elliptic curve keys. Encrypt and decrypt data using ECIES

Usage¶

ckms ec <subcommand>

Subcommands¶

keys [4.1] Create, destroy, import, and export elliptic curve key pairs

encrypt [4.2] Encrypt a file with the given public key using ECIES

decrypt [4.3] Decrypts a file with the given private key using ECIES

4.1 ckms ec keys¶

Create, destroy, import, and export elliptic curve key pairs

Usage¶

ckms ec keys <subcommand>

Subcommands¶

create [4.1.1] Create an elliptic curve key pair

export [4.1.2] Export a key from the KMS

import [4.1.3] Import a private or public key in the KMS.

revoke [4.1.4] Revoke a public or private key

destroy [4.1.5] Destroy a public or private key

4.1.1 ckms ec keys create¶

Create an elliptic curve key pair

Usage¶

ckms ec keys create [options]

Arguments¶

--curve [-c] <CURVE> The elliptic curve

Possible values: "nist-p192", "nist-p224", "nist-p256", "nist-p384", "nist-p521", "x25519", "ed25519", "x448", "ed448" [default: "nist-p256"]

--tag [-t] <TAG> The tag to associate with the master key pair. To specify multiple tags, use the option multiple times

4.1.2 ckms ec keys export¶

Export a key from the KMS

Usage¶

ckms ec keys export [options] <KEY_FILE>

Arguments¶

<KEY_FILE> The file to export the key to

--key-id [-k] <KEY_ID> The key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--key-format [-f] <KEY_FORMAT> The format of the key

json-ttlv [default]. It should be the format to use to later re-import the key
sec1-pem and sec1-deronly apply to NIST EC private keys (Not Curve25519 or X448)
pkcs1-pem and pkcs1-der only apply to RSA private and public keys
pkcs8-pem and pkcs8-der only apply to RSA and EC private keys
spki-pem and spki-der only apply to RSA and EC public keys
raw returns the raw bytes of
- symmetric keys
- Covercrypt keys
- wrapped keys

Possible values: "json-ttlv", "sec1-pem", "sec1-der", "pkcs1-pem", "pkcs1-der", "pkcs8-pem", "pkcs8-der", "spki-pem", "spki-der", "raw" [default: "json-ttlv"]

--unwrap [-u] <UNWRAP> Unwrap the key if it is wrapped before export

Possible values: "true", "false" [default: "false"]

--wrap-key-id [-w] <WRAP_KEY_ID> The id of the key/certificate to use to wrap this key before export

--allow-revoked [-i] <ALLOW_REVOKED> Allow exporting revoked and destroyed keys. The user must be the owner of the key. Destroyed keys have their key material removed.

Possible values: "true", "false" [default: "false"]

4.1.3 ckms ec keys import¶

Import a private or public key in the KMS.

Usage¶

ckms ec keys import [options] <KEY_FILE> [KEY_ID]

Arguments¶

<KEY_FILE> The KMIP JSON TTLV key file

<KEY_ID> The unique id of the key; a unique id based on the key material is generated if not specified

--key-format [-f] <KEY_FORMAT> The format of the key

Possible values: "json-ttlv", "pem", "sec1", "pkcs1-priv", "pkcs1-pub", "pkcs8", "spki", "aes", "chacha20" [default: "json-ttlv"]

--public-key-id [-p] <PUBLIC_KEY_ID> For a private key: the corresponding public key id if any

--private-key-id [-k] <PRIVATE_KEY_ID> For a public key: the corresponding private key id if any

--certificate-id [-c] <CERTIFICATE_ID> For a public or private key: the corresponding certificate id if any

--unwrap [-u] <UNWRAP> In the case of a JSON TTLV key, unwrap the key if it is wrapped before storing it

Possible values: "true", "false" [default: "false"]

--replace [-r] <REPLACE_EXISTING> Replace an existing key under the same id

Possible values: "true", "false" [default: "false"]

--tag [-t] <TAG> The tag to associate with the key. To specify multiple tags, use the option multiple times

4.1.4 ckms ec keys revoke¶

Revoke a public or private key

Usage¶

ckms ec keys revoke [options] <REVOCATION_REASON>

Arguments¶

<REVOCATION_REASON> The reason for the revocation as a string

--key-id [-k] <KEY_ID> The key unique identifier of the key to revoke. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

4.1.5 ckms ec keys destroy¶

Destroy a public or private key

Usage¶

ckms ec keys destroy [options]

Arguments¶

--key-id [-k] <KEY_ID> The key unique identifier of the key to destroy If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

4.2 ckms ec encrypt¶

Encrypt a file with the given public key using ECIES

Usage¶

ckms ec encrypt [options] <FILE>

Arguments¶

<FILE> The file to encrypt

--key-id [-k] <KEY_ID> The public key unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data. This data needs to be provided back for decryption

4.3 ckms ec decrypt¶

Decrypts a file with the given private key using ECIES

Usage¶

ckms ec decrypt [options] <FILE>

Arguments¶

<FILE> The file to decrypt

--key-id [-k] <KEY_ID> The private key unique identifier If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data that was supplied during encryption

5 ckms get-attributes¶

Get the KMIP object attributes and tags.

Usage¶

ckms get-attributes [options]

Arguments¶

--id [-i] <ID> The unique identifier of the cryptographic object. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--attribute [-a] <ATTRIBUTE> The attributes or tags to retrieve. To specify multiple attributes, use the option multiple times.

Possible values: "activation-date", "cryptographic-algorithm", "cryptographic-length", "cryptographic-parameters", "cryptographic-domain-parameters", "cryptographic-usage-mask", "key-format-type", "linked-private-key-id", "linked-public-key-id", "linked-issuer-certificate-id", "linked-certificate-id", "tags"

--output-file [-o] <OUTPUT_FILE> An optional file where to export the attributes. The attributes will be in JSON TTLV format.

6 ckms locate¶

Locate cryptographic objects inside the KMS

Usage¶

ckms locate [options]

Arguments¶

--tag [-t] <TAG> User tags or system tags to locate the object. To specify multiple tags, use the option multiple times.

--algorithm [-a] <CRYPTOGRAPHIC_ALGORITHM> Cryptographic algorithm (case insensitive)

--cryptographic-length [-l] <CRYPTOGRAPHIC_LENGTH> Cryptographic length (e.g. key size) in bits

--key-format-type [-f] <KEY_FORMAT_TYPE> Key format type (case insensitive)

--public-key-id [-p] <PUBLIC_KEY_ID> Locate an object which has a link to this public key id

--private-key-id [-k] <PRIVATE_KEY_ID> Locate an object which has a link to this private key id

--certificate-id [-c] <CERTIFICATE_ID> Locate an object which has a link to this certificate key id

7 ckms new-database¶

Initialize a new user encrypted database and return the secret (SQLCipher only).

Usage¶

ckms new-database

8 ckms rsa¶

Manage RSA keys

Usage¶

ckms rsa <subcommand>

Subcommands¶

keys [8.1] Create, destroy, import, and export RSA key pairs

encrypt [8.2] Encrypt a file with the given public key using either

CKM_RSA_PKCS_OAEP a.k.a PKCS #1 RSA OAEP as specified in PKCS#11 v2.40
RSA_OAEP AES_128_GCM

By default the hashing function used with RSA OAEP is set to SHA-256

decrypt [8.3] Decrypt a file with the given public key using either

CKM_RSA_PKCS_OAEP a.k.a PKCS #1 RSA OAEP as specified in PKCS#11 v2.40
RSA_OAEP AES_128_GCM

By default the hashing function used with RSA OAEP is set to SHA-256

8.1 ckms rsa keys¶

Create, destroy, import, and export RSA key pairs

Usage¶

ckms rsa keys <subcommand>

Subcommands¶

create [8.1.1] Create a new RSA key pair

export [8.1.2] Export a key from the KMS

import [8.1.3] Import a private or public key in the KMS.

revoke [8.1.4] Revoke a public or private key

destroy [8.1.5] Destroy a public or private key

8.1.1 ckms rsa keys create¶

Create a new RSA key pair

Usage¶

ckms rsa keys create [options]

Arguments¶

--size_in_bits [-s] <SIZE_IN_BITS> The expected size in bits

--tag [-t] <TAG> The tag to associate with the master key pair. To specify multiple tags, use the option multiple times

8.1.2 ckms rsa keys export¶

Export a key from the KMS

Usage¶

ckms rsa keys export [options] <KEY_FILE>

Arguments¶

<KEY_FILE> The file to export the key to

--key-id [-k] <KEY_ID> The key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--key-format [-f] <KEY_FORMAT> The format of the key

json-ttlv [default]. It should be the format to use to later re-import the key
sec1-pem and sec1-deronly apply to NIST EC private keys (Not Curve25519 or X448)
pkcs1-pem and pkcs1-der only apply to RSA private and public keys
pkcs8-pem and pkcs8-der only apply to RSA and EC private keys
spki-pem and spki-der only apply to RSA and EC public keys
raw returns the raw bytes of
- symmetric keys
- Covercrypt keys
- wrapped keys

Possible values: "json-ttlv", "sec1-pem", "sec1-der", "pkcs1-pem", "pkcs1-der", "pkcs8-pem", "pkcs8-der", "spki-pem", "spki-der", "raw" [default: "json-ttlv"]

--unwrap [-u] <UNWRAP> Unwrap the key if it is wrapped before export

Possible values: "true", "false" [default: "false"]

--wrap-key-id [-w] <WRAP_KEY_ID> The id of the key/certificate to use to wrap this key before export

--allow-revoked [-i] <ALLOW_REVOKED> Allow exporting revoked and destroyed keys. The user must be the owner of the key. Destroyed keys have their key material removed.

Possible values: "true", "false" [default: "false"]

8.1.3 ckms rsa keys import¶

Import a private or public key in the KMS.

Usage¶

ckms rsa keys import [options] <KEY_FILE> [KEY_ID]

Arguments¶

<KEY_FILE> The KMIP JSON TTLV key file

<KEY_ID> The unique id of the key; a unique id based on the key material is generated if not specified

--key-format [-f] <KEY_FORMAT> The format of the key

Possible values: "json-ttlv", "pem", "sec1", "pkcs1-priv", "pkcs1-pub", "pkcs8", "spki", "aes", "chacha20" [default: "json-ttlv"]

--public-key-id [-p] <PUBLIC_KEY_ID> For a private key: the corresponding public key id if any

--private-key-id [-k] <PRIVATE_KEY_ID> For a public key: the corresponding private key id if any

--certificate-id [-c] <CERTIFICATE_ID> For a public or private key: the corresponding certificate id if any

--unwrap [-u] <UNWRAP> In the case of a JSON TTLV key, unwrap the key if it is wrapped before storing it

Possible values: "true", "false" [default: "false"]

--replace [-r] <REPLACE_EXISTING> Replace an existing key under the same id

Possible values: "true", "false" [default: "false"]

--tag [-t] <TAG> The tag to associate with the key. To specify multiple tags, use the option multiple times

8.1.4 ckms rsa keys revoke¶

Revoke a public or private key

Usage¶

ckms rsa keys revoke [options] <REVOCATION_REASON>

Arguments¶

<REVOCATION_REASON> The reason for the revocation as a string

--key-id [-k] <KEY_ID> The key unique identifier of the key to revoke. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

8.1.5 ckms rsa keys destroy¶

Destroy a public or private key

Usage¶

ckms rsa keys destroy [options]

Arguments¶

--key-id [-k] <KEY_ID> The key unique identifier of the key to destroy If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

8.2 ckms rsa encrypt¶

Encrypt a file with the given public key using either

CKM_RSA_PKCS_OAEP a.k.a PKCS #1 RSA OAEP as specified in PKCS#11 v2.40
RSA_OAEP AES_128_GCM

By default the hashing function used with RSA OAEP is set to SHA-256

Usage¶

ckms rsa encrypt [options] <FILE>

Arguments¶

<FILE> The file to encrypt

--key-id [-k] <KEY_ID> The public key unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--encryption-algorithm [-e] <ENCRYPTION_ALGORITHM> The encryption algorithm

Possible values: "ckm-rsa-pkcs-oaep", "rsa-oaep-aes128-gcm" [default: "ckm-rsa-pkcs-oaep"]

--hashing-algorithm [-s] <HASH_FN> The hashing algorithm

Possible values: "sha1", "sha224", "sha256", "sha384", "sha512", "sha3-224", "sha3-256", "sha3-384", "sha3-512" [default: "sha256"]

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data. This data needs to be provided back for decryption

8.3 ckms rsa decrypt¶

Decrypt a file with the given public key using either

CKM_RSA_PKCS_OAEP a.k.a PKCS #1 RSA OAEP as specified in PKCS#11 v2.40
RSA_OAEP AES_128_GCM

By default the hashing function used with RSA OAEP is set to SHA-256

Usage¶

ckms rsa decrypt [options] <FILE>

Arguments¶

<FILE> The file to decrypt

--key-id [-k] <KEY_ID> The private key unique identifier If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--encryption-algorithm [-e] <ENCRYPTION_ALGORITHM> The encryption algorithm

Possible values: "ckm-rsa-pkcs-oaep", "rsa-oaep-aes128-gcm" [default: "ckm-rsa-pkcs-oaep"]

--hashing-algorithm [-s] <HASH_FN> The hashing algorithm

Possible values: "sha1", "sha224", "sha256", "sha384", "sha512", "sha3-224", "sha3-256", "sha3-384", "sha3-512" [default: "sha256"]

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data that was supplied during encryption

9 ckms server-version¶

Print the version of the server

Usage¶

ckms server-version

10 ckms sym¶

Manage symmetric keys. Encrypt and decrypt data

Usage¶

ckms sym <subcommand>

Subcommands¶

keys [10.1] Create, destroy, import, and export symmetric keys

encrypt [10.2] Encrypt a file using AES GCM

decrypt [10.3] Decrypts a file using AES GCM

10.1 ckms sym keys¶

Create, destroy, import, and export symmetric keys

Usage¶

ckms sym keys <subcommand>

Subcommands¶

create [10.1.1] Create a new symmetric key

export [10.1.2] Export a key from the KMS

import [10.1.3] Import a private or public key in the KMS.

revoke [10.1.4] Revoke a symmetric key

destroy [10.1.5] Destroy a symmetric key

10.1.1 ckms sym keys create¶

Create a new symmetric key

Usage¶

ckms sym keys create [options]

Arguments¶

--number-of-bits [-l] <NUMBER_OF_BITS> The length of the generated random key or salt in bits

--bytes-b64 [-k] <WRAP_KEY_B64> The symmetric key bytes or salt as a base 64 string

--algorithm [-a] <ALGORITHM> The algorithm

Possible values: "chacha20", "aes", "sha3", "shake" [default: "aes"]

--tag [-t] <TAG> The tag to associate with the key. To specify multiple tags, use the option multiple times

10.1.2 ckms sym keys export¶

Export a key from the KMS

Usage¶

ckms sym keys export [options] <KEY_FILE>

Arguments¶

<KEY_FILE> The file to export the key to

--key-id [-k] <KEY_ID> The key unique identifier stored in the KMS. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--key-format [-f] <KEY_FORMAT> The format of the key

json-ttlv [default]. It should be the format to use to later re-import the key
sec1-pem and sec1-deronly apply to NIST EC private keys (Not Curve25519 or X448)
pkcs1-pem and pkcs1-der only apply to RSA private and public keys
pkcs8-pem and pkcs8-der only apply to RSA and EC private keys
spki-pem and spki-der only apply to RSA and EC public keys
raw returns the raw bytes of
- symmetric keys
- Covercrypt keys
- wrapped keys

Possible values: "json-ttlv", "sec1-pem", "sec1-der", "pkcs1-pem", "pkcs1-der", "pkcs8-pem", "pkcs8-der", "spki-pem", "spki-der", "raw" [default: "json-ttlv"]

--unwrap [-u] <UNWRAP> Unwrap the key if it is wrapped before export

Possible values: "true", "false" [default: "false"]

--wrap-key-id [-w] <WRAP_KEY_ID> The id of the key/certificate to use to wrap this key before export

--allow-revoked [-i] <ALLOW_REVOKED> Allow exporting revoked and destroyed keys. The user must be the owner of the key. Destroyed keys have their key material removed.

Possible values: "true", "false" [default: "false"]

10.1.3 ckms sym keys import¶

Import a private or public key in the KMS.

Usage¶

ckms sym keys import [options] <KEY_FILE> [KEY_ID]

Arguments¶

<KEY_FILE> The KMIP JSON TTLV key file

<KEY_ID> The unique id of the key; a unique id based on the key material is generated if not specified

--key-format [-f] <KEY_FORMAT> The format of the key

Possible values: "json-ttlv", "pem", "sec1", "pkcs1-priv", "pkcs1-pub", "pkcs8", "spki", "aes", "chacha20" [default: "json-ttlv"]

--public-key-id [-p] <PUBLIC_KEY_ID> For a private key: the corresponding public key id if any

--private-key-id [-k] <PRIVATE_KEY_ID> For a public key: the corresponding private key id if any

--certificate-id [-c] <CERTIFICATE_ID> For a public or private key: the corresponding certificate id if any

--unwrap [-u] <UNWRAP> In the case of a JSON TTLV key, unwrap the key if it is wrapped before storing it

Possible values: "true", "false" [default: "false"]

--replace [-r] <REPLACE_EXISTING> Replace an existing key under the same id

Possible values: "true", "false" [default: "false"]

--tag [-t] <TAG> The tag to associate with the key. To specify multiple tags, use the option multiple times

10.1.4 ckms sym keys revoke¶

Revoke a symmetric key

Usage¶

ckms sym keys revoke [options] <REVOCATION_REASON>

Arguments¶

<REVOCATION_REASON> The reason for the revocation as a string

--key-id [-k] <KEY_ID> The key unique identifier of the key to revoke. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

10.1.5 ckms sym keys destroy¶

Destroy a symmetric key

Usage¶

ckms sym keys destroy [options]

Arguments¶

--key-id [-k] <KEY_ID> The key unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

10.2 ckms sym encrypt¶

Encrypt a file using AES GCM

Usage¶

ckms sym encrypt [options] <FILE>

Arguments¶

<FILE> The file to encrypt

--key-id [-k] <KEY_ID> The symmetric key unique identifier. If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data. This data needs to be provided back for decryption

10.3 ckms sym decrypt¶

Decrypts a file using AES GCM

Usage¶

ckms sym decrypt [options] <FILE>

Arguments¶

<FILE> The file to decrypt

--key-id [-k] <KEY_ID> The private key unique identifier If not specified, tags should be specified

--tag [-t] <TAG> Tag to use to retrieve the key when no key id is specified. To specify multiple tags, use the option multiple times

--output-file [-o] <OUTPUT_FILE> The encrypted output file path

--authentication-data [-a] <AUTHENTICATION_DATA> Optional authentication data that was supplied during encryption

Login to the Identity Provider of the KMS server using the OAuth2 authorization code flow.

Usage¶

ckms login

12 ckms logout¶

Logout from the Identity Provider.

Usage¶

ckms logout

13 ckms markdown¶

Generate the CLI documentation as markdown

Usage¶

ckms markdown [options] <MARKDOWN_FILE>

Arguments¶

<MARKDOWN_FILE> The file to export the markdown to