1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114
|
# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------
"""
FILE: manage_users.py
DESCRIPTION:
This sample demonstrates how to manage users using Confidential Ledger's native role-based
access control. In this sample, we add two test users - one using a random AAD-object-id-like
identifier, and one using the thumbprint of a test certificate.
USAGE:
python manage_users.py
Set the environment variables with your own values before running the sample:
1) CONFIDENTIALLEDGER_ENDPOINT - the endpoint of the Confidential Ledger.
"""
import logging
import os
import sys
import tempfile
import time
from azure.confidentialledger import ConfidentialLedgerClient
from azure.confidentialledger.certificate import (
ConfidentialLedgerCertificateClient,
)
from azure.identity import DefaultAzureCredential
logging.basicConfig(level=logging.ERROR)
LOG = logging.getLogger()
def main():
# Example values identifying users.
# This is an example thumbprint for certificate identifying a certificate-based user.
cert_thumbprint = "4F:E1:61:D8:6E:5A:7B:E6:00:25:A6:D8:5D:EC:2C:71:E5:86:C3:E4:70:BE:D0:3C:73:7E:69:00:87:98:B0:25"
# This is an example AAD object id identifying an AAD-based user.
aad_object_id = "0" * 36 # AAD Object Ids have length 36
# Set the values of the client ID, tenant ID, and client secret of the AAD application as
# environment variables:
# AZURE_CLIENT_ID, AZURE_TENANT_ID, AZURE_CLIENT_SECRET, CONFIDENTIALLEDGER_ENDPOINT
try:
ledger_endpoint = os.environ["CONFIDENTIALLEDGER_ENDPOINT"]
except KeyError:
LOG.error(
"Missing environment variable 'CONFIDENTIALLEDGER_ENDPOINT' - "
"please set it before running the example"
)
sys.exit(1)
# Under the current URI format, the ledger id is the first part of the ledger endpoint.
# i.e. https://<ledger id>.confidential-ledger.azure.com
ledger_id = ledger_endpoint.replace("https://", "").split(".")[0]
identity_service_client = ConfidentialLedgerCertificateClient() # type: ignore[call-arg]
ledger_certificate = identity_service_client.get_ledger_identity(ledger_id)
# The Confidential Ledger's TLS certificate must be written to a file to be used by the
# ConfidentialLedgerClient. Here, we write it to a temporary file so that is is cleaned up
# automatically when the program exits.
with tempfile.TemporaryDirectory() as tempdir:
ledger_cert_file = os.path.join(tempdir, f"{ledger_id}.pem")
with open(ledger_cert_file, "w") as outfile:
outfile.write(ledger_certificate["ledgerTlsCertificate"])
print(
f"Ledger certificate has been written to {ledger_cert_file}. "
"It will be deleted when the script completes."
)
# Build a client through AAD
ledger_client = ConfidentialLedgerClient(
ledger_endpoint,
credential=DefaultAzureCredential(),
ledger_certificate_path=ledger_cert_file,
)
try:
role = "Reader"
ledger_client.create_or_update_user(aad_object_id, {"assignedRole": role})
print(f"User {aad_object_id} has been added as a {role}")
role = "Contributor"
ledger_client.create_or_update_user(cert_thumbprint, {"assignedRole": role})
print(f"User {cert_thumbprint} has been added as a {role}")
print(
"Sleeping 3 seconds before getting user details. Due to replication lag, "
"it may not immediately be available."
)
time.sleep(3)
aad_user_details = ledger_client.get_user(aad_object_id)
print(f"Details about user {aad_object_id}: {aad_user_details}")
cert_user_details = ledger_client.get_user(cert_thumbprint)
print(f"Details about user {cert_thumbprint}: {cert_user_details}")
# Always delete the user in case an exception is raised.
finally:
try:
ledger_client.delete_user(aad_object_id)
print(f"User {aad_object_id} deleted")
finally:
ledger_client.delete_user(cert_thumbprint)
print(f"User {cert_thumbprint} deleted")
if __name__ == "__main__":
main()
|