Skip to main content

Python Client for Google Cloud KMS

Project description

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

Latest PyPI Version (gcloud-aio-kms) Python Version Support (gcloud-aio-kms) Python Version Support (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.aio.kms import KMS
from gcloud.aio.kms import decode
from gcloud.aio.kms import encode

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

# encrypt
plaintext = b'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-aio-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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gcloud-aio-kms-4.0.0.tar.gz (4.1 kB view hashes)

Uploaded source

Built Distribution

gcloud_aio_kms-4.0.0-py3-none-any.whl (4.8 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page