Key Vault Certificates

sdk/keyvault/azure-keyvault-certificates/HISTORY.md

@@ -0,0 +1,5 @@
+# Release History
+
+## 4.0.0b1 (2019-06-28)
+For release notes and more information please visit
+https://aka.ms/azure-sdk-preview1-python

sdk/keyvault/azure-keyvault-certificates/MANIFEST.in

@@ -0,0 +1,6 @@
+include *.md
+include azure/__init__.py
+include azure/keyvault/__init__.py
+include azure/keyvault/certificates/__init__.py
+include azure/keyvault/certificates/_generated/__init__.py
+include azure/keyvault/certificates/aio/__init__.py

sdk/keyvault/azure-keyvault-certificates/README.md

@@ -0,0 +1,241 @@
+# Azure Key Vault Certificates client library for Python
+Azure Key Vault is a cloud service that provides a secure management of certificates, which are built on top of keys and secrets and adds an automated renewal feature. The certificate client library allows you securely store and manage the life-cycle of your certificate, be notified about certificate life-cycle events, and supports automatic renewal with selected issuers. This library offers operations to create, retrieve, update, delete, purge, backup, restore, and list the certificates and its versions, and offers CRUD operations for the certificate issuers, contacts, and management policies of the certificates..
+
+[Source code][certificates_client_src] | [Package (PyPI)](TODO) | [API reference documentation](TODO) | [Product documentation][keyvault_docs] | [Samples][certificates_samples]
+## Getting started
+### Install the package
+Install the Azure Key Vault client library for Python with [pip][pip]:
+
+```Bash
+pip install azure-keyvault-certificates
+```
+
+### Prerequisites
+* An [Azure subscription][azure_sub].
+* Python 2.7, 3.5.3, or later to use this package.
+* An existing Key Vault. If you need to create a Key Vault, you can use the [Azure Cloud Shell][azure_cloud_shell] to create one with this Azure CLI command. Replace `<your-resource-group-name>` and `<your-key-vault-name>` with your own unique names:
+
+    ```Bash
+    az keyvault create --resource-group <your-resource-group-name> --name <your-key-vault-name>
+    ```
+
+### Authenticate the client
+In order to interact with the Key Vault service, you'll need to create an instance of the [CertificateClient](TODO-rst-docs) class. You would need a **vault url** and **client certificate credentials (client id, client secret, tenant id)** to instantiate a client object for using the `DefaultAzureCredential` examples in the README. `DefaultAzureCredential` authentication is achieved by providing client certificate credentials as seen in this getting started section, but you can find more ways to authenticate with [azure-identity][azure_identity].
+
+ #### Create/Get credentials
+Use the [Azure Cloud Shell][azure_cloud_shell] snippet below to create/get client certificate credentials.
+
+ * Create a service principal and configure its access to Azure resources:
+    ```Bash
+    az ad sp create-for-rbac -n <your-application-name> --skip-assignment
+    ```
+    Output:
+    ```json
+    {
+        "appId": "generated-app-ID",
+        "displayName": "dummy-app-name",
+        "name": "http://dummy-app-name",
+        "password": "random-password",
+        "tenant": "tenant-ID"
+    }
+    ```
+* Use the credentials returned above to set **AZURE_CLIENT_ID**(appId), **AZURE_CLIENT_SECRET**(password) and (password) and **AZURE_TENANT_ID**(tenant) environment variables. The following example shows a way to do this in Bash:
+  ```Bash
+    export AZURE_CLIENT_ID="generated-app-ID"
+    export AZURE_CLIENT_SECRET="random-password"
+    export AZURE_TENANT_ID="tenant-ID"
+  ```
+
+* Grant the above mentioned application authorization to perform certificate operations on the keyvault:
+    ```Bash 
+    az keyvault set-policy --name <your-key-vault-name> --spn $AZURE_CLIENT_ID --certificate-permissions backup create delete get import list purge recover restore update
+    ```
+    > --certificate-permissions:
+    > Accepted values: backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers, update
+
+* Use the above mentioned Key Vault name to retrieve details of your Vault which also contains your Key Vault URL:
+    ```Bash
+    az keyvault show --name <your-key-vault-name>
+    ```
+
+#### Create Certificate client
+Once you've populated the **AZURE_CLIENT_ID**, **AZURE_CLIENT_SECRET** and **AZURE_TENANT_ID** environment variables and replaced **your-vault-url** with the above returned URI, you can create the [CertificateClient](TODO-rst-docs):
+
+```python
+    from azure.identity import DefaultAzureCredential
+    from azure.keyvault.certificates import CertificateClient
+
+    credential = DefaultAzureCredential()
+
+    # Create a new certificate client using the default credential
+    certificate_client = CertificateClient(vault_url=<your-vault-url>, credential=credential)
+```
+## Key concepts
+### Certificate
+  A certificate is the fundamental resource within Azure KeyVault. From a developer's perspective, Key Vault APIs accept and return certificates as the Certificate type. In addition to the certificate data, the following attributes may be specified:
+* expires: Identifies the expiration time on or after which the certificate data should not be retrieved.
+* not_before: Identifies the time after which the certificate will be active.
+* enabled: Specifies whether the certificate data can be retrieved.
+* created: Indicates when this version of the certificate was created.
+* updated: Indicates when this version of the certificate was updated.
+
+### Certificate Client:
+The Certificate client performs the interactions with the Azure Key Vault service for getting, setting, updating, deleting, and listing secrets and its versions. An asynchronous and synchronous, SecretClient, client exists in the SDK allowing for selection of a client based on an application's use case. Once you've initialized a CertificateClient, you can interact with the primary resource types in Key Vault.
+
+## Examples
+The following section provides several code snippets using the above created `certificate_client`, covering some of the most common Azure Key Vault Certificate service related tasks, including:
+* [Create a Certificate](#create-a-certificate)
+* [Retrieve a Certificate](#retrieve-a-certificate)
+* [Update an existing Certificate](#update-an-existing-certificate)
+* [Delete a Certificate](#delete-a-certificate)
+* [List Certificates](#list-certificates)
+* 
+
+### Create a Certificate
+`create_certificate` creates a Certificate to be stored in the Azure Key Vault. If a certificate with the same name already exists, then a new version of the certificate is created.
+Before creating a certificate, a management policy for the certificate must be created. Following the service's guidelines, create_certificate returns a CertificateOperation, as 
+`create_certificate` is an asynchronous request to the server.
+```python
+    cert_policy = CertificatePolicy(key_properties=KeyProperties(exportable=True,
+                                                                     key_type='RSA',
+                                                                     key_size=2048,
+                                                                     reuse_key=False),
+                                        content_type='application/x-pkcs12',
+                                        issuer_name='Self',
+                                        subject_name='CN=*.microsoft.com',
+                                        san_dns_names=['onedrive.microsoft.com', 'xbox.microsoft.com'],
+                                        validity_in_months=24,
+                                        lifetime_actions=lifetime_actions,
+                                        attributes=CertificateAttributes(recovery_level="Purgeable")
+                                        )
+    cert_operation = certificate_client.create_certificate(name="cert-name", policy=cert-policy)
+
+    print(cert_operation.name)
+    print(cert_operation.id)
+```
+
+### Retrieve a Certificate
+`get_certificate` retrieves a certificate previously stored in the Key Vault.
+```python
+    certificate = certificate_client.get_certificate(name="cert-name")
+
+    print(certificate.name)
+    print(certificate.version)
+```
+
+### Update an existing Certificate
+`update_certificate` updates a certificate previously stored in the Key Vault.
+```python
+    # You can specify additional application-specific metadata in the form of tags.
+    tags = {"foo": "updated tag"}
+
+    updated_certificate= certificate_client.update_certificate(name="cert-name", tags=tags)
+
+    print(updated_certificate.name)
+    print(updated_certificate.version)
+    print(updated_certificate.updated)
+    print(updated_certificate.tags)
+
+```
+
+### Delete a Certificate
+`delete_certificate` deletes a certificate previously stored in the Key Vault. When [soft-delete][soft_delete] is not enabled for the Key Vault, this operation permanently deletes the certificate.
+```python
+    deleted_certificate = certificate_client.delete_certificate(name="cert-name")
+
+    print(deleted_certificate.name)
+    print(deleted_certificate.deleted_date)
+```
+### List Certificates
+This example lists all the certificates in the specified Key Vault.
+```python
+    certificates = certificate_client.list_certificates()
+
+    for certificate in certificates:
+        # the list doesn't include versions of the certificates
+        print(certificate.name)
+```
+
+## Troubleshooting
+### General
+Key Vault clients raise exceptions defined in azure-core. For more detailed information about exceptions and how to deal with them, see [Azure Core exceptions][azure_core_exceptions].
+
+For example, if you try to retrieve a certificate after it is deleted a `404` error is returned, indicating resource not found. In the following snippet, the error is handled gracefully by catching the exception and displaying additional information about the error.
+```python
+from azure.core.exceptions import ResourceNotFoundError
+try:
+    certificate_client.get_certificate(name="deleted_certificate")
+except ResourceNotFoundError as e:
+    print(e.message)
+
+Output: "certificate not found:deleted_certificate"
+```
+### Logging
+Network trace logging is disabled by default for this library. When enabled, this will be logged at DEBUG level. The logging policy is used to output the HTTP network trace to the configured logger. You can configure logging to print out debugging information to the stdout or write it to a file using the following example:
+
+ ```python
+import sys
+import logging
+ # Create a logger for the 'azure' SDK
+logger = logging.getLogger(__name__)
+logger.setLevel(logging.DEBUG)
+ # Configure a console output
+handler = logging.StreamHandler(stream=sys.stdout)
+logger.addHandler(handler)
+ # Configure a file output
+file_handler = logging.FileHandler(filename)
+logger.addHandler(file_handler)
+
+# Enable network trace logging. This will be logged at DEBUG level.
+# By default, network trace logging is disabled.
+config = CertificateClient.create_config(credential=credential, logging_enable=True)
+client = CertificateClient(vault_url=url, credential=credential, config=config)
+```
+The logger can also be enabled per operation.
+
+ ```python
+certificate = client.get_certificate(name="cert-name", logging_enable=True)
+```
+
+## Next steps
+Several KeyVault Python SDK samples are available to you in the SDK's GitHub repository. These samples provide example code for additional scenarios commonly encountered while working with Key Vault:
+* [test_examples_certificates.py][test_examples_certificates] - Contains the code snippets working with Key Vault certificates.
+* [hello_world.py][hello_world_sample] and [hello_world_async.py][hello_world_async_sample] - Python code for working with Azure Key Vault, including:
+  * Create a new certificate
+  * Get an existing certificate
+  * Update an existing certificate
+  * Delete certificate
+* [list_operations.py][list_operations_sample] and [list_operations_async.py][list_operations_async_sample] - Example code for working with Key Vault certificates backup and recovery, including:
+  * Create a certificate
+  * List all certificates in the Key Vault
+  * List versions of a specified certificate
+  * Delete certificates from the Key Vault
+  * List deleted certificates in the Key Vault
+
+ ###  Additional Documentation
+For more extensive documentation on Azure Key Vault, see the [API reference documentation](TODO).
+
+## 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][code_of_conduct]. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
+
+<!-- LINKS -->
+[asyncio_package]: https://docs.python.org/3/library/asyncio.html
+[azure_cloud_shell]: https://shell.azure.com/bash
+[azure_core_exceptions]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/core/azure-core/docs/exceptions.md
+[azure_identity]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/identity/azure-identity
+[azure_sub]: https://azure.microsoft.com/free/
+[code_of_conduct]: https://opensource.microsoft.com/codeofconduct/
+[hello_world_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/hello_world.py
+[keyvault_docs]: https://docs.microsoft.com/en-us/azure/key-vault/
+[list_operations_sample]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/samples/list_operations.py
+[pip]: https://pypi.org/project/pip/
+[certificates_client_src]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault/azure/keyvault/certificates
+[certificates_samples]: https://github.com/Azure/azure-sdk-for-python/tree/master/sdk/keyvault/azure-keyvault-certificates/samples
+[soft_delete]: https://docs.microsoft.com/en-us/azure/key-vault/key-vault-ovw-soft-delete
+[test_example_certificates]: https://github.com/Azure/azure-sdk-for-python/blob/master/sdk/keyvault/azure-keyvault-certificates/tests/test_example_certificates.py
+
+![Impressions](https://azure-sdk-impressions.azurewebsites.net/api/impressions/azure-sdk-for-python%2Fsdk%2Fkeyvault%2Fazure-keyvault-certificates%2FFREADME.png)

sdk/keyvault/azure-keyvault-certificates/azure/__init__.py

@@ -0,0 +1,6 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+# pylint:disable=missing-docstring
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/keyvault/azure-keyvault-certificates/azure/keyvault/__init__.py

@@ -0,0 +1,6 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+# pylint:disable=missing-docstring
+__path__ = __import__("pkgutil").extend_path(__path__, __name__)  # type: ignore

sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/__init__.py

@@ -0,0 +1,40 @@
+# --------------------------------------------------------------------------
+# Copyright (c) Microsoft Corporation. All rights reserved.
+# Licensed under the MIT License. See LICENSE.txt in the project root for
+# license information.
+# --------------------------------------------------------------------------
+from .client import CertificateClient
+from .models import (
+    AdministratorDetails,
+    Certificate,
+    CertificateBase,
+    DeletedCertificate,
+    Error,
+    CertificateOperation,
+    CertificatePolicy,
+    Contact,
+    Issuer,
+    IssuerBase,
+    KeyProperties,
+    LifetimeAction,
+    SecretContentType,
+    KeyUsageType
+)
+
+__all__ = [
+    "AdministratorDetails",
+    "Certificate",
+    "CertificateBase",
+    "CertificateClient",
+    "CertificateOperation",
+    "CertificatePolicy",
+    "Contact",
+    "DeletedCertificate",
+    "Error",
+    "Issuer",
+    "IssuerBase",
+    "KeyProperties",
+    "LifetimeAction",
+    "SecretContentType",
+    "KeyUsageType"
+]

sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/_shared/__init__.py

@@ -0,0 +1,57 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from collections import namedtuple
+
+try:
+    import urllib.parse as parse
+except ImportError:
+    # pylint:disable=import-error
+    import urlparse as parse  # type: ignore
+
+from .challenge_auth_policy import ChallengeAuthPolicy, ChallengeAuthPolicyBase
+from .client_base import KeyVaultClientBase
+from .http_challenge import HttpChallenge
+from . import http_challenge_cache as HttpChallengeCache
+
+__all__ = [
+    "ChallengeAuthPolicy",
+    "ChallengeAuthPolicyBase",
+    "HttpChallenge",
+    "HttpChallengeCache",
+    "KeyVaultClientBase",
+]
+
+_VaultId = namedtuple("VaultId", ["vault_url", "collection", "name", "version"])
+
+
+def parse_vault_id(url):
+    try:
+        parsed_uri = parse.urlparse(url)
+    except Exception:  # pylint: disable=broad-except
+        raise ValueError("'{}' is not not a valid url".format(url))
+    if not (parsed_uri.scheme and parsed_uri.hostname):
+        raise ValueError("'{}' is not not a valid url".format(url))
+
+    path = list(filter(None, parsed_uri.path.split("/")))
+
+    if len(path) < 2 or len(path) > 3:
+        raise ValueError("'{}' is not not a valid vault url".format(url))
+
+    return _VaultId(
+        vault_url="{}://{}".format(parsed_uri.scheme, parsed_uri.hostname),
+        collection=path[0],
+        name=path[1],
+        version=path[2] if len(path) == 3 else None,
+    )
+
+
+try:
+    # pylint:disable=unused-import
+    from .async_challenge_auth_policy import AsyncChallengeAuthPolicy
+    from .async_client_base import AsyncKeyVaultClientBase
+
+    __all__.extend(["AsyncChallengeAuthPolicy", "AsyncKeyVaultClientBase"])
+except (SyntaxError, ImportError):
+    pass

sdk/keyvault/azure-keyvault-certificates/azure/keyvault/certificates/_shared/_generated/__init__.py

@@ -0,0 +1,7 @@
+# ------------------------------------
+# Copyright (c) Microsoft Corporation.
+# Licensed under the MIT License.
+# ------------------------------------
+from .key_vault_client import KeyVaultClient
+
+__all__ = ["KeyVaultClient"]