google-cloud-kms

Python Client for Google Cloud Key Management Service

|stable| |pypi| |versions|

Google Cloud Key Management Service_: a cloud-hosted key management service that lets you manage cryptographic keys for your cloud services the same way you do on-premises. You can generate, use, rotate, and destroy AES256, RSA 2048, RSA 3072, RSA 4096, EC P256, and EC P384 cryptographic keys. Cloud KMS is integrated with Cloud IAM and Cloud Audit Logging so that you can manage permissions on individual keys and monitor how these are used. Use Cloud KMS to protect secrets and other sensitive data that you need to store in Google Cloud Platform.

• Client Library Documentation_
• Product Documentation_

.. |stable| image:: https://img.shields.io/badge/support-stable-gold.svg :target: https://github.com/googleapis/google-cloud-python/blob/main/README.rst#stability-levels .. |pypi| image:: https://img.shields.io/pypi/v/google-cloud-kms.svg :target: https://pypi.org/project/google-cloud-kms/ .. |versions| image:: https://img.shields.io/pypi/pyversions/google-cloud-kms.svg :target: https://pypi.org/project/google-cloud-kms/ .. _Google Cloud Key Management Service: https://cloud.google.com/kms .. _Client Library Documentation: https://cloud.google.com/python/docs/reference/cloudkms/latest .. _Product Documentation: https://cloud.google.com/kms

Quick Start

In order to use this library, you first need to go through the following steps:

1. Select or create a Cloud Platform project._
2. Enable billing for your project._
3. Enable the Google Cloud Key Management Service._
4. Setup Authentication._

.. _Select or create a Cloud Platform project.: https://console.cloud.google.com/project .. _Enable billing for your project.: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project .. _Enable the Google Cloud Key Management Service.: https://cloud.google.com/kms .. _Setup Authentication.: https://googleapis.dev/python/google-api-core/latest/auth.html

Installation

Install this library in a virtual environment using `venv`_. `venv`_ is a tool that
creates isolated Python environments. These isolated environments can have separate
versions of Python packages, which allows you to isolate one project's dependencies
from the dependencies of other projects.

With `venv`_, it's possible to install this library without needing system
install permissions, and without clashing with the installed system
dependencies.

.. _`venv`: https://docs.python.org/3/library/venv.html


Code samples and snippets

Code samples and snippets live in the samples/_ folder.

.. _samples/: https://github.com/googleapis/google-cloud-python/tree/main/packages/google-cloud-kms/samples

Supported Python Versions ^^^^^^^^^^^^^^^^^^^^^^^^^ Our client libraries are compatible with all current active_ and maintenance_ versions of Python.

Python >= 3.7

.. _active: https://devguide.python.org/devcycle/#in-development-main-branch .. _maintenance: https://devguide.python.org/devcycle/#maintenance-branches

Unsupported Python Versions ^^^^^^^^^^^^^^^^^^^^^^^^^^^ Python <= 3.6

If you are using an end-of-life_ version of Python, we recommend that you update as soon as possible to an actively supported version.

.. _end-of-life: https://devguide.python.org/devcycle/#end-of-life-branches

Mac/Linux ^^^^^^^^^

.. code-block:: console

python3 -m venv <your-env>
source <your-env>/bin/activate
pip install google-cloud-kms

Windows ^^^^^^^

.. code-block:: console

py -m venv <your-env>
.\<your-env>\Scripts\activate
pip install google-cloud-kms

Next Steps

-  Read the `Client Library Documentation`_ for Google Cloud Key Management Service
   to see other available methods on the client.
-  Read the `Google Cloud Key Management Service Product documentation`_ to learn
   more about the product and see How-to Guides.
-  View this `README`_ to see the full list of Cloud
   APIs that we cover.

.. _Google Cloud Key Management Service Product documentation:  https://cloud.google.com/kms
.. _README: https://github.com/googleapis/google-cloud-python/blob/main/README.rst