2020-02-19 03:07:42 +00:00
|
|
|
# Key Management Services
|
|
|
|
|
|
|
|
|
|
This document describes how to use a key management service or KMS to store the
|
|
|
|
|
private keys and sign certificates.
|
|
|
|
|
|
|
|
|
|
Support for multiple KMS are planned, but currently the only supported one is
|
|
|
|
|
Google's Cloud KMS.
|
|
|
|
|
|
|
|
|
|
## Google's Cloud KMS.
|
|
|
|
|
|
|
|
|
|
[Cloud KMS](https://cloud.google.com/kms) is the Google's cloud-hosted KMS that
|
|
|
|
|
allows you to store the cryptographic keys, and sign certificates using their
|
|
|
|
|
infrastructure. Cloud KMS supports two different protection levels, SOFTWARE and
|
|
|
|
|
HSM.
|
|
|
|
|
|
|
|
|
|
To configure Cloud KMS in your CA you need add the `"kms"` property to you
|
|
|
|
|
`ca.json`, and replace the property`"key"` with the Cloud KMS key name of your
|
|
|
|
|
intermediate key:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
...
|
|
|
|
|
"key": "projects/<project-id>/locations/global/keyRings/<ring-id>/cryptoKeys/<key-id>/cryptoKeyVersions/<version-number>",
|
|
|
|
|
...
|
|
|
|
|
"kms": {
|
|
|
|
|
"type": "cloudkms",
|
|
|
|
|
"credentialsFile": "path/to/credentials.json"
|
|
|
|
|
}
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
In a similar way, for SSH certificate, the SSH keys must be Cloud KMS names:
|
|
|
|
|
|
|
|
|
|
```json
|
|
|
|
|
{
|
|
|
|
|
...
|
|
|
|
|
"ssh": {
|
|
|
|
|
"hostKey": "projects/<project-id>/locations/global/keyRings/<ring-id>/cryptoKeys/<key-id>/cryptoKeyVersions/<version-number>",
|
|
|
|
|
"userKey": "projects/<project-id>/locations/global/keyRings/<ring-id>/cryptoKeys/<key-id>/cryptoKeyVersions/<version-number>"
|
|
|
|
|
},
|
|
|
|
|
}
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Currently [step](https://github.com/smallstep/cli) does not provide an automatic
|
|
|
|
|
way to initialize the public key infrastructure (PKI) using Cloud KMS, but an
|
|
|
|
|
experimental tool named `step-cloudkms-init` is available for this use case. At
|
|
|
|
|
some point this tool will be integrated into `step` and it will be deleted.
|
|
|
|
|
|
2020-02-21 18:53:22 +00:00
|
|
|
To use `step-cloudkms-init` just enable Cloud KMS in your project and run:
|
2020-02-19 03:07:42 +00:00
|
|
|
|
|
|
|
|
```sh
|
|
|
|
|
$ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials.json
|
|
|
|
|
$ step-cloudkms-init --project your-project-id --ssh
|
|
|
|
|
Creating PKI ...
|
2020-02-21 18:55:42 +00:00
|
|
|
✔ Root Key: projects/your-project-id/locations/global/keyRings/pki/cryptoKeys/root/cryptoKeyVersions/1
|
2020-02-19 03:07:42 +00:00
|
|
|
✔ Root Certificate: root_ca.crt
|
2020-02-21 18:55:42 +00:00
|
|
|
✔ Intermediate Key: projects/your-project-id/locations/global/keyRings/pki/cryptoKeys/intermediate/cryptoKeyVersions/1
|
2020-02-19 03:07:42 +00:00
|
|
|
✔ Intermediate Certificate: intermediate_ca.crt
|
|
|
|
|
|
|
|
|
|
Creating SSH Keys ...
|
|
|
|
|
✔ SSH User Public Key: ssh_user_ca_key.pub
|
2020-02-21 18:55:42 +00:00
|
|
|
✔ SSH User Private Key: projects/your-project-id/locations/global/keyRings/pki/cryptoKeys/ssh-user-key/cryptoKeyVersions/1
|
2020-02-19 03:07:42 +00:00
|
|
|
✔ SSH Host Public Key: ssh_host_ca_key.pub
|
2020-02-21 18:55:42 +00:00
|
|
|
✔ SSH Host Private Key: projects/your-project-id/locations/global/keyRings/pki/cryptoKeys/ssh-host-key/cryptoKeyVersions/1
|
2020-02-19 03:07:42 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
See `step-cloudkms-init --help` for more options.
|
