.. role:: raw-html-m2r(raw)
:format: html
Azure Key Vault Keys client library for Python
==============================================
Azure Key Vault helps solve the following problems:
* Cryptographic key management (this library) - create, store, and control
access to the keys used to encrypt your data
* Secrets management
(\ `azure-keyvault-secrets `_\ ) -
securely store and control access to tokens, passwords, certificates, API keys,
and other secrets
* Certificate management
(\ `azure-keyvault-certificates `_\ ) -
create, manage, and deploy public and private SSL/TLS certificates
* Vault administration (\ `azure-keyvault-administration `_\ ) - role-based access control (RBAC), and vault-level backup and restore options
`Source code `_ | `Package (PyPI) `_ | `API reference documentation `_ | `Product documentation `_ | `Samples `_
*Disclaimer*
----------------
*Azure SDK Python packages support for Python 2.7 has ended 01 January 2022. For more information and questions, please refer to https://github.com/Azure/azure-sdk-for-python/issues/20691*.
*Python 3.7 or later is required to use this package. For more details, please refer to `Azure SDK for Python version support policy `_.*
Getting started
---------------
Install the package
^^^^^^^^^^^^^^^^^^^
Install `azure-keyvault-keys `_ and
`azure-identity `_ with `pip `_\ :
.. code-block:: Bash
pip install azure-keyvault-keys azure-identity
`azure-identity `_ is used for Azure Active Directory
authentication as demonstrated below.
Prerequisites
^^^^^^^^^^^^^
* An `Azure subscription `_
* Python 3.7 or later
* An existing `Azure Key Vault `_. If you need to create one, you can do so using the Azure CLI by following the steps in `this document `_.
* If using Managed HSM, an existing `Key Vault Managed HSM `_. If you need to create a Managed HSM, you can do so using the Azure CLI by following the steps in `this document `_.
Authenticate the client
^^^^^^^^^^^^^^^^^^^^^^^
In order to interact with the Azure Key Vault service, you will need an instance of a `KeyClient `_\ , as well as a **vault url** and a credential object. This document demonstrates using a `DefaultAzureCredential `_\ , which is appropriate for most scenarios, including local development and production environments. We recommend using a `managed identity `_ for authentication in production environments.
See `azure-identity `_ documentation for more information about other methods of authentication and their corresponding credential types.
Create a client
~~~~~~~~~~~~~~~
After configuring your environment for the `DefaultAzureCredential `_ to use a suitable method of authentication, you can do the following to create a key client (replacing the value of ``vault_url`` with your vault's URL):
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
..
**NOTE:** For an asynchronous client, import ``azure.keyvault.keys.aio``\ 's ``KeyClient`` instead.
Key concepts
------------
Keys
^^^^
Azure Key Vault can create and store RSA and elliptic curve keys. Both can
optionally be protected by hardware security modules (HSMs). Azure Key Vault
can also perform cryptographic operations with them. For more information about
keys and supported operations and algorithms, see the
`Key Vault documentation `_.
`KeyClient `_ can create keys in the vault, get existing keys
from the vault, update key metadata, and delete keys, as shown in the
`examples <#examples>`_ below.
Examples
--------
This section contains code snippets covering common tasks:
* `Create a key <#create-a-key>`_
* `Retrieve a key <#retrieve-a-key>`_
* `Update an existing key <#update-an-existing-key>`_
* `Delete a key <#delete-a-key>`_
* `Configure automatic key rotation <#configure-automatic-key-rotation>`_
* `List keys <#list-keys>`_
* `Perform cryptographic operations <#cryptographic-operations>`_
* `Async API <#async-api>`_
* `Asynchronously create a key <#asynchronously-create-a-key>`_
* `Asynchronously list keys <#asynchronously-list-keys>`_
Create a key
^^^^^^^^^^^^
`create_rsa_key `_ and
`create_ec_key `_
create RSA and elliptic curve keys in the vault, respectively. If a key with the same name already exists, a new version
of that key is created.
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
# Create an RSA key
rsa_key = key_client.create_rsa_key("rsa-key-name", size=2048)
print(rsa_key.name)
print(rsa_key.key_type)
# Create an elliptic curve key
ec_key = key_client.create_ec_key("ec-key-name", curve="P-256")
print(ec_key.name)
print(ec_key.key_type)
Retrieve a key
^^^^^^^^^^^^^^
`get_key `_ retrieves a key
previously stored in the Vault.
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
key = key_client.get_key("key-name")
print(key.name)
Update an existing key
^^^^^^^^^^^^^^^^^^^^^^
`update_key_properties `_
updates the properties of a key previously stored in the Key Vault.
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
# we will now disable the key for further use
updated_key = key_client.update_key_properties("key-name", enabled=False)
print(updated_key.name)
print(updated_key.properties.enabled)
Delete a key
^^^^^^^^^^^^
`begin_delete_key `_
requests Key Vault delete a key, returning a poller which allows you to wait for the deletion to finish. Waiting is
helpful when the vault has `soft-delete `_ enabled, and you want to purge (permanently delete) the key as
soon as possible. When `soft-delete `_ is disabled, ``begin_delete_key`` itself is permanent.
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
deleted_key = key_client.begin_delete_key("key-name").result()
print(deleted_key.name)
print(deleted_key.deleted_date)
Configure automatic key rotation
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
`update_key_rotation_policy `_
allows you to configure automatic key rotation for a key by specifying a rotation policy.
In addition,
`rotate_key `_
allows you to rotate a key on-demand by creating a new version of the given key.
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient, KeyRotationLifetimeAction, KeyRotationPolicyAction
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
# Set the key's automated rotation policy to rotate the key 30 days before the key expires
actions = [KeyRotationLifetimeAction(KeyRotationPolicyAction.ROTATE, time_before_expiry="P30D")]
# You may also specify the duration after which the newly rotated key will expire
# In this example, any new key versions will expire after 90 days
updated_policy = key_client.update_key_rotation_policy("key-name", expires_in="P90D", lifetime_actions=actions)
# You can get the current rotation policy for a key with get_key_rotation_policy
current_policy = key_client.get_key_rotation_policy("key-name")
# Finally, you can rotate a key on-demand by creating a new version of the key
rotated_key = key_client.rotate_key("key-name")
List keys
^^^^^^^^^
`list_properties_of_keys `_
lists the properties of all of the keys in the client's vault.
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
keys = key_client.list_properties_of_keys()
for key in keys:
# the list doesn't include values or versions of the keys
print(key.name)
Cryptographic operations
^^^^^^^^^^^^^^^^^^^^^^^^
`CryptographyClient `_
enables cryptographic operations (encrypt/decrypt, wrap/unwrap, sign/verify) using a particular key.
.. code-block:: py
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
from azure.keyvault.keys.crypto import CryptographyClient, EncryptionAlgorithm
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
key = key_client.get_key("key-name")
crypto_client = CryptographyClient(key, credential=credential)
plaintext = b"plaintext"
result = crypto_client.encrypt(EncryptionAlgorithm.rsa_oaep, plaintext)
decrypted = crypto_client.decrypt(result.algorithm, result.ciphertext)
See the
`package documentation `_
for more details of the cryptography API.
Async API
^^^^^^^^^
This library includes a complete set of async APIs. To use them, you must
first install an async transport, such as `aiohttp `_.
See
`azure-core documentation `_
for more information.
Async clients and credentials should be closed when they're no longer needed. These
objects are async context managers and define async ``close`` methods. For
example:
.. code-block:: py
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.keys.aio import KeyClient
credential = DefaultAzureCredential()
# call close when the client and credential are no longer needed
client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
...
await client.close()
await credential.close()
# alternatively, use them as async context managers (contextlib.AsyncExitStack can help)
client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
async with client:
async with credential:
...
Asynchronously create a key
^^^^^^^^^^^^^^^^^^^^^^^^^^^
`create_rsa_key `_ and
`create_ec_key `_
create RSA and elliptic curve keys in the vault, respectively. If a key with the same name already exists, a new
version of the key is created.
.. code-block:: python
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.keys.aio import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
# Create an RSA key
rsa_key = await key_client.create_rsa_key("rsa-key-name", size=2048)
print(rsa_key.name)
print(rsa_key.key_type)
# Create an elliptic curve key
ec_key = await key_client.create_ec_key("ec-key-name", curve="P-256")
print(ec_key.name)
print(ec_key.key_type)
Asynchronously list keys
^^^^^^^^^^^^^^^^^^^^^^^^
`list_properties_of_keys `_
lists the properties of all of the keys in the client's vault.
.. code-block:: python
from azure.identity.aio import DefaultAzureCredential
from azure.keyvault.keys.aio import KeyClient
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
keys = key_client.list_properties_of_keys()
async for key in keys:
print(key.name)
Troubleshooting
---------------
See the ``azure-keyvault-keys``
`troubleshooting guide `_
for details on how to diagnose various failure scenarios.
General
^^^^^^^
Key Vault clients raise exceptions defined in `azure-core `_.
For example, if you try to get a key that doesn't exist in the vault, `KeyClient `_
raises `ResourceNotFoundError `_\ :
.. code-block:: python
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
from azure.core.exceptions import ResourceNotFoundError
credential = DefaultAzureCredential()
key_client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential)
try:
key_client.get_key("which-does-not-exist")
except ResourceNotFoundError as e:
print(e.message)
Logging
^^^^^^^
This library uses the standard
`logging `_ library for logging.
Basic information about HTTP sessions (URLs, headers, etc.) is logged at INFO
level.
Detailed DEBUG level logging, including request/response bodies and unredacted
headers, can be enabled on a client with the ``logging_enable`` argument:
.. code-block:: py
from azure.identity import DefaultAzureCredential
from azure.keyvault.keys import KeyClient
import sys
import logging
# Create a logger for the 'azure' SDK
logger = logging.getLogger('azure')
logger.setLevel(logging.DEBUG)
# Configure a console output
handler = logging.StreamHandler(stream=sys.stdout)
logger.addHandler(handler)
credential = DefaultAzureCredential()
# This client will log detailed information about its HTTP sessions, at DEBUG level
client = KeyClient(vault_url="https://my-key-vault.vault.azure.net/", credential=credential, logging_enable=True)
Similarly, ``logging_enable`` can enable detailed logging for a single operation,
even when it isn't enabled for the client:
.. code-block:: py
client.get_key("my-key", logging_enable=True)
Next steps
----------
Several samples are available in the Azure SDK for Python GitHub repository.
These provide example code for additional Key Vault scenarios:
| File | Description |
|-------------|-------------|
| `hello_world.py `_ (\ `async version `_\ ) | create/get/update/delete keys |
| `list_operations.py `_ (\ `async version `_\ ) | basic list operations for keys |
| `backup_restore_operations.py `_ (\ `async version `_\ ) | back up and recover keys |
| `recover_purge_operations.py `_ (\ `async version `_\ ) | recover and purge keys |
Additional documentation
^^^^^^^^^^^^^^^^^^^^^^^^
For more extensive documentation on Azure Key Vault, see the
`API reference documentation `_.
Contributing
------------
This project welcomes contributions and suggestions. Most contributions require
you to agree to a Contributor License Agreement (CLA) declaring that you have
the right to, and actually do, grant us the rights to use your contribution.
For details, visit https://cla.microsoft.com.
When you submit a pull request, a CLA-bot will automatically determine whether
you need to provide a CLA and decorate the PR appropriately (e.g., label,
comment). Simply follow the instructions provided by the bot. You will only
need to do this once across all repos using our CLA.
This project has adopted the `Microsoft Open Source Code of Conduct `_.
For more information, see the
`Code of Conduct FAQ `_ or
contact opencode@microsoft.com with any additional questions or comments.
:raw-html-m2r:``
.. image:: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-keys%2FREADME.png
:target: https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-keys%2FREADME.png
:alt: Impressions
Indices and tables
------------------
* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`
.. toctree::
:maxdepth: 5
:glob:
:caption: Developer Documentation
azure.keyvault.keys.rst