Microsoft Azure Key Vault Keys Client Library for Python
Project description
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
Source code | Package (PyPI) | API reference documentation | Product documentation | Samples
Getting started
Install packages
Install azure-keyvault-keys and azure-identity with pip:
pip install azure-keyvault-keys azure-identity
azure-identity is used for Azure Active Directory authentication as demonstrated below.
Prerequisites
-
Python 2.7, 3.5.3, or later
-
A Key Vault. If you need to create one, you can use the Azure Cloud Shell to create one with these commands (replace
"my-resource-group"
and"my-key-vault"
with your own, unique names):(Optional) if you want a new resource group to hold the Key Vault:
az group create --name my-resource-group --location westus2
Create the Key Vault:
az keyvault create --resource-group my-resource-group --name my-key-vault
Output:
{ "id": "...", "location": "westus2", "name": "my-key-vault", "properties": { "accessPolicies": [...], "createMode": null, "enablePurgeProtection": null, "enableSoftDelete": null, "enabledForDeployment": false, "enabledForDiskEncryption": null, "enabledForTemplateDeployment": null, "networkAcls": null, "provisioningState": "Succeeded", "sku": { "name": "standard" }, "tenantId": "...", "vaultUri": "https://my-key-vault.vault.azure.net/" }, "resourceGroup": "my-resource-group", "type": "Microsoft.KeyVault/vaults" }
The
"vaultUri"
property is thevault_url
used by KeyClient
Authenticate the client
This document demonstrates using DefaultAzureCredential to authenticate as a service principal. However, KeyClient accepts any azure-identity credential. See the azure-identity documentation for more information about other credentials.
Create a service principal (optional)
This Azure Cloud Shell snippet shows how to create a new service principal. Before using it, replace "your-application-name" with a more appropriate name for your service principal.
Create a service principal:
az ad sp create-for-rbac --name http://my-application --skip-assignment
Output:
{ "appId": "generated app id", "displayName": "my-application", "name": "http://my-application", "password": "random password", "tenant": "tenant id" }
Use the output to set AZURE_CLIENT_ID ("appId" above), AZURE_CLIENT_SECRET ("password" above) and AZURE_TENANT_ID ("tenant" above) environment variables. The following example shows a way to do this in Bash:
export AZURE_CLIENT_ID="generated app id"
export AZURE_CLIENT_SECRET="random password"
export AZURE_TENANT_ID="tenant id"
Authorize the service principal to perform key operations in your Key Vault:
az keyvault set-policy --name my-key-vault --spn $AZURE_CLIENT_ID --key-permissions backup delete get list create update decrypt encrypt
Possible permissions:
- Key management: backup, delete, get, list, purge, recover, restore, create, update, import
- Cryptographic operations: decrypt, encrypt, unwrapKey, wrapKey, verify, sign
Create a client
Once the AZURE_CLIENT_ID, AZURE_CLIENT_SECRET and AZURE_TENANT_ID environment variables are set, DefaultAzureCredential will be able to authenticate the KeyClient.
Constructing the client also requires your vault's URL, which you can get from the Azure CLI or the Azure Portal. In the Azure Portal, this URL is the vault's "DNS Name".
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 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 below.
Examples
This section contains code snippets covering common tasks:
- Create a Key
- Retrieve a Key
- Update an existing Key
- Delete a Key
- List Keys
- Asynchronously create a Key
- Asynchronously list Keys
- Perform cryptographic operations
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.
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.
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.
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.
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)
List keys
list_properties_of_keys lists the properties of all of the keys in the client's vault.
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.
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 async API supported on Python 3.5+. To use it, you must first install an async transport, such as aiohttp. See azure-core documentation for more information.
Async clients should be closed when they're no longer needed. Each async
client is an async context manager and defines an async close
method. For
example:
from azure.keyvault.keys import KeyClient
# call close when the client is no longer needed
client = KeyClient()
...
await client.close()
# alternatively, use the client as an async context manager
client = KeyClient()
async with client:
...
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.
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.
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
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:
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:
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:
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:
- hello_world.py and hello_world_async.py - create/get/update/delete keys
- list_operations.py and list_operations_async.py - basic list operations for keys
- backup_restore_operations.py and backup_restore_operations_async.py - backup and recover keys
- recover_purge_operations.py and recover_purge_operations_async.py - recovering and purging 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.
Release History
4.2.0b1 (2020-03-10)
- Support for Key Vault API version 7.1-preview
(#10124)
- Added
import_key
toKeyOperation
- Added
recoverable_days
toCertificateProperties
- Added
ApiVersion
enum identifying Key Vault versions supported by this package
- Added
4.1.0 (2020-03-10)
KeyClient
instances have aclose
method which closes opened sockets. Used as a context manager, aKeyClient
closes opened sockets on exit. (#9906)- Pollers no longer sleep after operation completion (#9991)
4.0.1 (2020-02-11)
azure.keyvault.keys
defines__version__
- Challenge authentication policy preserves request options (#8999)
- Updated
msrest
requirement to >=0.6.0 - Challenge authentication policy requires TLS (#9457)
- Methods no longer raise the internal error
KeyVaultErrorException
(#9690) - Fix
AttributeError
in async CryptographyClient when verifying signatures remotely (#9734)
2019-10-31 4.0.0
Breaking changes:
- Removed
KeyClient.get_cryptography_client()
andCryptographyClient.get_key()
- Moved the optional parameters of several methods into kwargs (
docs
detail the new keyword arguments):
create_key
now has positional parametersname
andkey_type
create_ec_key
andcreate_rsa_key
now have one positional parameter,name
update_key_properties
now has two positional parameters,name
and (optional)version
import_key
now has positional parametersname
andkey
CryptographyClient
operations return class instances instead of tuples and renamed the following properties- Renamed the
decrypted_bytes
property ofDecryptResult
toplaintext
- Renamed the
unwrapped_bytes
property ofUnwrapResult
tokey
- Renamed the
result
property ofVerifyResult
tois_valid
- Renamed the
- Renamed the
UnwrapKeyResult
andWrapKeyResult
classes toUnwrapResult
andWrapResult
- Renamed
list_keys
tolist_properties_of_keys
- Renamed
list_key_versions
tolist_properties_of_key_versions
- Renamed sync method
delete_key
tobegin_delete_key
- The sync method
begin_delete_key
and asyncdelete_key
now return pollers that return aDeletedKey
- Renamed
Key
toKeyVaultKey
KeyVaultKey
propertiescreated
,expires
, andupdated
renamed tocreated_on
,expires_on
, andupdated_on
- The
vault_endpoint
parameter ofKeyClient
has been renamed tovault_url
- The property
vault_endpoint
has been renamed tovault_url
in all models
New features:
- Now all
CryptographyClient
returns includekey_id
andalgorithm
properties
4.0.0b4 (2019-10-08)
- Enums
JsonWebKeyCurveName
,JsonWebKeyOperation
, andJsonWebKeyType
have been renamed toKeyCurveName
,KeyOperation
, andKeyType
, respectively. Key
now has attributeproperties
, which holds certain properties of the key, such asversion
. This changes the shape of the returnedKey
type, as certain properties ofKey
(such asversion
) have to be accessed through theproperties
property. See the updated docs for details.update_key
has been renamed toupdate_key_properties
- The
vault_url
parameter ofKeyClient
has been renamed tovault_endpoint
- The property
vault_url
has been renamed tovault_endpoint
in all models
Fixes and improvements:
- The
key
argument toimport_key
should be an instance ofazure.keyvault.keys.JsonWebKey
(#7590)
4.0.0b3 (2019-09-11)
Breaking changes:
CryptographyClient
methodswrap
andunwrap
are renamedwrap_key
andunwrap_key
, respectively.
New features:
CryptographyClient
performs encrypt, verify and wrap operations locally when its key's public material is available (i.e., when it has keys/get permission).
4.0.0b2 (2019-08-06)
Breaking changes:
- Removed
azure.core.Configuration
from the public API in preparation for a revamped configuration API. Staticcreate_config
methods have been renamed_create_config
, and will be removed in a future release. - Removed
wrap_key
andunwrap_key
fromKeyClient
. These are now available throughCryptographyClient
. - This version of the library requires
azure-core
1.0.0b2- If you later want to revert to a version requiring azure-core 1.0.0b1,
of this or another Azure SDK library, you must explicitly install azure-core
1.0.0b1 as well. For example:
pip install azure-core==1.0.0b1 azure-keyvault-keys==4.0.0b1
- If you later want to revert to a version requiring azure-core 1.0.0b1,
of this or another Azure SDK library, you must explicitly install azure-core
1.0.0b1 as well. For example:
New features:
- Added
CryptographyClient
, a client for performing cryptographic operations (encrypt/decrypt, wrap/unwrap, sign/verify) with a key. - Distributed tracing framework OpenCensus is now supported
- Added support for HTTP challenge based authentication, allowing clients to interact with vaults in sovereign clouds.
Other changes:
- Async clients use aiohttp for transport by default. See azure-core documentation for more information about using other transports.
4.0.0b1 (2019-06-28)
Version 4.0.0b1 is the first preview of our efforts to create a user-friendly and Pythonic client library for Azure Key Vault. For more information about preview releases of other Azure SDK libraries, please visit https://aka.ms/azure-sdk-preview1-python.
This library is not a direct replacement for azure-keyvault
. Applications
using that library would require code changes to use azure-keyvault-keys
.
This package's
documentation
and
samples
demonstrate the new API.
Major changes from azure-keyvault
- Packages scoped by functionality
azure-keyvault-keys
contains a client for key operations,azure-keyvault-secrets
contains a client for secret operations
- Client instances are scoped to vaults (an instance interacts with one vault only)
- Asynchronous API supported on Python 3.5.3+
- the
azure.keyvault.keys.aio
namespace contains an async equivalent of the synchronous client inazure.keyvault.keys
- the
- Authentication using
azure-identity
credentials- see this package's documentation , and the Azure Identity documentation for more information
azure-keyvault
features not implemented in this release
- Certificate management APIs
- Cryptographic operations, e.g. sign, un/wrap_key, verify, en- and decrypt
- National cloud support. This release supports public global cloud vaults, e.g. https://{vault-name}.vault.azure.net
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file azure-keyvault-keys-4.2.0b1.zip
.
File metadata
- Download URL: azure-keyvault-keys-4.2.0b1.zip
- Upload date:
- Size: 334.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 883d70e42beb9a35fcfd481886411363a844eb8d16e6c832559621bb4659dd8c |
|
MD5 | 3c532335698d611d3a06e8fafc51bc8e |
|
BLAKE2b-256 | 06884e392541e590f341174d0f3af5f84ba75fc4a5955f676659fa49fb73ec02 |
File details
Details for the file azure_keyvault_keys-4.2.0b1-py2.py3-none-any.whl
.
File metadata
- Download URL: azure_keyvault_keys-4.2.0b1-py2.py3-none-any.whl
- Upload date:
- Size: 253.5 kB
- Tags: Python 2, Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/41.2.0 requests-toolbelt/0.9.1 tqdm/4.43.0 CPython/3.8.2
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | d24b5df6f895cbc73f5b125b53169340630d073354903bf290b2d77c2391eadd |
|
MD5 | 49dbe61e115ea9a03847d2393689f7cf |
|
BLAKE2b-256 | 80403fd3a6471523faf295beb648cc2b22dfcd3bff092c7e86d573ce3ebccd1c |