gcloud-rest-kms 3.3.1

Python Client for Google Cloud KMS

This is a shared codebase for gcloud-rest-kms and gcloud-rest-kms

Installation

$ pip install --upgrade gcloud-{aio,rest}-kms

Usage

We’re still working on more complete documentation, but roughly you can do:

from gcloud.rest.kms import KMS
from gcloud.rest.kms import decode
from gcloud.rest.kms import encode

kms = KMS('my-kms-project', 'my-keyring', 'my-key-name')

# encrypt
plaintext = 'the-best-animal-is-the-aardvark'
ciphertext = await kms.encrypt(encode(plaintext))

# decrypt
assert decode(await kms.decrypt(ciphertext)) == plaintext

# close the HTTP session
# Note that other options include:
# * providing your own session: ``KMS(.., session=session)``
# * using a context manager: ``async with KMS(..) as kms:``
await kms.close()

Emulators

For testing purposes, you may want to use gcloud-rest-kms along with a local emulator. Setting the $KMS_EMULATOR_HOST environment variable to the address of your emulator should be enough to do the trick.

Contributing

Please see our contributing guide.