File: sample_get_set_policy_async.py

package info (click to toggle)
python-azure 20250603%2Bgit-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 851,724 kB
  • sloc: python: 7,362,925; ansic: 804; javascript: 287; makefile: 195; sh: 145; xml: 109
file content (485 lines) | stat: -rw-r--r-- 20,790 bytes parent folder | download | duplicates (2)
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
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
# coding: utf-8

# -------------------------------------------------------------------------
# Copyright (c) Microsoft Corporation. All rights reserved.
# Licensed under the MIT License. See License.txt in the project root for
# license information.
# --------------------------------------------------------------------------

"""
FILE: sample_get_set_policy_async.py
DESCRIPTION:
    These samples demonstrate using the attestation administration APIs to manage
    attestation policy documents for the various modes of operation of the attestation
    service.

    Set the following environment variables with your own values before running
    the sample:
    1) ATTESTATION_AAD_URL - the base URL for an attestation service instance in AAD mode.
    2) ATTESTATION_ISOLATED_URL - the base URL for an attestation service instance in Isolated mode.
    3) ATTESTATION_TENANT_ID - Tenant Instance for authentication.
    4) ATTESTATION_CLIENT_ID - Client identity for authentication.
    5) ATTESTATION_CLIENT_SECRET - Secret used to identify the client.
    6) ATTESTATION_ISOLATED_SIGNING_CERTIFICATE - Base64 encoded X.509 Certificate
        specified when the isolated mode instance is created. 
    7) ATTESTATION_ISOLATED_SIGNING_KEY - Base64 encoded DER encoded RSA Private key
        associated with the ATTESTATION_ISOLATED_SIGNING_CERTIFICATE


Usage:
    python sample_get_set_policy.py

This sample demonstrates retrieving, setting policies, and resetting policies
on both AAD and Isolated mode attestation service instances.

It also demonstrates adding and removing attestation policy management certificates,
which are used to set attestation policy on isolated mode attestation service instances.

"""

import base64
import os
from azure.identity.aio import DefaultAzureCredential
from cryptography.hazmat.backends import default_backend
from cryptography.x509 import load_pem_x509_certificate
from dotenv import find_dotenv, load_dotenv
import base64
import asyncio

from azure.security.attestation.aio import (
    AttestationAdministrationClient,
    AttestationClient,
)
from azure.security.attestation import (
    AttestationType,
    AttestationPolicyToken,
    CertificateModification,
)

from sample_collateral import sample_open_enclave_report, sample_runtime_data
from sample_utils import (
    write_banner,
    create_rsa_key,
    create_x509_certificate,
    pem_from_base64,
)


class AttestationClientPolicySamples(object):
    def __init__(self):
        load_dotenv(find_dotenv())
        if os.environ.get("ATTESTATION_ISOLATED_URL"):
            self.isolated_certificate = pem_from_base64(
                os.getenv("ATTESTATION_ISOLATED_SIGNING_CERTIFICATE"), "CERTIFICATE"
            )
            self.isolated_key = pem_from_base64(
                os.getenv("ATTESTATION_ISOLATED_SIGNING_KEY"), "PRIVATE KEY"
            )

    async def close(self):
        pass

    async def get_policy_aad(self):
        """
        Demonstrates retrieving the policy document for an SGX enclave.
        """
        write_banner("get_policy_aad")
        print("Retrieve an unsecured Policy on an AAD mode attestation instance.")
        # [BEGIN get_policy]
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_AAD_URL"), credential
        ) as admin_client:
            policy, _ = await admin_client.get_policy(AttestationType.SGX_ENCLAVE)
            print("Current instance SGX Policy is: ", policy)
        # [END get_policy]

    async def set_policy_aad_unsecured(self):
        """
        Demonstrates setting an attestation policy for OpenEnclave attestation
        operations.
        """

        write_banner("set_policy_aad_unsecured")
        print("Set an unsecured Policy on an AAD mode attestation instance.")
        # [BEGIN set_policy_unsecured]
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_AAD_URL"), credential
        ) as admin_client:
            new_policy = """
version= 1.0;
authorizationrules
{
    [ type=="x-ms-sgx-is-debuggable", value==false ] &&
    [ type=="x-ms-sgx-product-id", value==1 ] &&
    [ type=="x-ms-sgx-svn", value>= 0 ] &&
    [ type=="x-ms-sgx-mrsigner", value=="2c1a44952ae8207135c6c29b75b8c029372ee94b677e15c20bd42340f10d41aa"]
        => permit();
};
issuancerules {
    c:[type=="x-ms-sgx-mrsigner"] => issue(type="My-MrSigner", value=c.value);
};
    """

            set_result, _ = await admin_client.set_policy(
                AttestationType.OPEN_ENCLAVE, new_policy
            )
            print("Policy Set result: ", set_result.policy_resolution)
            # [END set_policy_unsecured]

            get_policy, _ = await admin_client.get_policy(AttestationType.OPEN_ENCLAVE)
            if new_policy != get_policy:
                print("Policy does not match set policy.")
            # Attest an OpenEnclave using the new policy.
            await self._attest_open_enclave(os.environ.get("ATTESTATION_AAD_URL"))

    async def reset_policy_aad_unsecured(self):
        """
        Demonstrates reset the attestation policy on an AAD mode instance to the
        default value.
        """
        # [BEGIN reset_aad_policy]
        print("Reset an unsecured Policy on an AAD mode attestation instance.")
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_AAD_URL"), credential
        ) as admin_client:

            set_result, _ = await admin_client.reset_policy(
                AttestationType.OPEN_ENCLAVE
            )
            print("Policy reset result: ", set_result.policy_resolution)
        # [END reset_aad_policy]

    async def reset_policy_aad_secured(self):
        """Set a secured attestation policy on an AAD mode instance, specifying
        a default signing key and certificate to be used for all policy operations.
        """
        write_banner("reset_policy_aad_secured")
        # [BEGIN reset_aad_policy_secured]
        print("Set Secured Policy on an AAD mode attestation instance.")
        rsa_key = create_rsa_key()
        cert = create_x509_certificate(rsa_key, u"TestCertificate")

        # Create an administrative client, specifying a default key and certificate.
        # The key and certificate will be used for subsequent policy operations.
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_AAD_URL"),
            credential,
            signing_key=rsa_key,
            signing_certificate=cert,
        ) as admin_client:

            set_result, _ = await admin_client.reset_policy(AttestationType.SGX_ENCLAVE)
            print("Policy Set Resolution: ", set_result.policy_resolution)
        # [END reset_aad_policy_secured]

    async def set_policy_aad_secured(self):
        """
        Sets a minimal attestation policy for SGX enclaves with a customer
        specified signing key and certificate.
        """

        write_banner("set_policy_aad_secured")
        print("Set Secured Policy on an AAD mode attestation instance.")
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_AAD_URL"), credential
        ) as admin_client:

            # [START set_secured_policy]
            # Create an RSA Key and wrap an X.509 certificate around
            # the public key for that certificate.
            rsa_key = create_rsa_key()
            cert = create_x509_certificate(rsa_key, u"TestCertificate")

            # Set a minimal policy.
            set_result, _ = await admin_client.set_policy(
                AttestationType.SGX_ENCLAVE,
                """version= 1.0;authorizationrules{=> permit();};issuancerules {};""",
                signing_key=rsa_key,
                signing_certificate=cert,
            )
            print("Policy Set Resolution: ", set_result.policy_resolution)
            print("Resulting policy signer should match the input certificate:")
            print("Policy Signer: ", set_result.policy_signer.certificates[0])
            print("Certificate:   ", cert)
            # [END set_secured_policy]

            # Reset the policy now that we're done.
            await admin_client.reset_policy(AttestationType.SGX_ENCLAVE)

    async def set_policy_validate_hash(self):
        """
        Sets a signed attestation policy and validates the signing certificate and
        policy hash after the `set_policy` API returns.
        """

        # [START validate_policy_hash]
        from cryptography.hazmat.primitives import hashes

        write_banner("set_policy_aad_secured")
        print("Set Secured Policy on an AAD mode attestation instance.")
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_AAD_URL"), credential
        ) as admin_client:
            # Create an RSA Key and wrap an X.509 certificate around
            # the public key for that certificate.
            rsa_key = create_rsa_key()
            cert = create_x509_certificate(rsa_key, u"TestCertificate")

            # Set a minimal policy.
            policy_to_set = """
version= 1.0;
authorizationrules{=> permit();};
issuancerules {};
"""
            set_result, _ = await admin_client.set_policy(
                AttestationType.SGX_ENCLAVE,
                policy_to_set,
                signing_key=rsa_key,
                signing_certificate=cert,
            )
            print("Policy Set Resolution: ", set_result.policy_resolution)
            print("Resulting policy signer should match the input certificate:")
            print("Policy Signer: ", set_result.policy_signer.certificates[0])
            print("Certificate:   ", cert)

            # Create an Attestation Token object representing the stored
            # attestation policy.
            expected_policy = AttestationPolicyToken(
                policy_to_set,
                signing_key=rsa_key,
                signing_certificate=cert,
            )

            # Generate the Sha256 hash of the attestation token.
            hasher = hashes.Hash(hashes.SHA256(), backend=default_backend())
            hasher.update(expected_policy.to_jwt_string().encode("utf-8"))
            expected_hash = hasher.finalize()

            print("Expected hash should match returned hash.")
            print("Expected hash: ", expected_hash)
            print("Returned hash: ", set_result.policy_token_hash)
            # [END validate_policy_hash]

            # Reset the policy now that we're done.
            await admin_client.reset_policy(AttestationType.SGX_ENCLAVE)

    async def reset_policy_isolated(self):
        """Set a secured attestation policy on an AAD mode instance"""
        write_banner("reset_policy_isolated")
        isolated_certificate = pem_from_base64(
            os.getenv("ATTESTATION_ISOLATED_SIGNING_CERTIFICATE"), "CERTIFICATE"
        )
        isolated_key = pem_from_base64(
            os.getenv("ATTESTATION_ISOLATED_SIGNING_KEY"), "PRIVATE KEY"
        )

        # [BEGIN reset_isolated_policy]
        print("Set Secured Policy on an Isolated mode attestation instance.")
        # < Load the PEM encoded isolated signing certificate and  key >
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_ISOLATED_URL"), credential
        ) as admin_client:
            set_result, _ = await admin_client.reset_policy(
                AttestationType.SGX_ENCLAVE,
                signing_key=isolated_key,
                signing_certificate=isolated_certificate,
            )
            print("Policy Set Resolution: ", set_result.policy_resolution)
        # [END reset_isolated_policy]

    async def get_policy_isolated(self):
        """
        Retrieve the SGX policy for an the isolated attestation instance.
        """
        write_banner("get_policy_isolated")
        print(
            "Retrieve the SGX Policy on an Isolated mode attestation instance, explicitly setting the issuer for validation."
        )
        endpoint = os.environ.get("ATTESTATION_ISOLATED_URL")
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            endpoint, credential
        ) as admin_client:
            get_result, _ = await admin_client.get_policy(
                AttestationType.SGX_ENCLAVE, validate_issuer=True, issuer=endpoint
            )
            print("SGX Policy is: ", get_result)

    async def set_policy_isolated_secured(self):
        """
        Set a secured attestation policy on an Isolated mode instance.

        This sample sets the signing key on the admin client object directly, rather
        than providing the signing key to individual APIs.

        For an isolated attestation instance, the new attestation policy must
        be signed with one of the existing policy management certificates.

        """
        write_banner("set_policy_isolated_secured")
        print("Set Secured Policy on an AAD mode attestation instance.")
        endpoint = os.environ.get("ATTESTATION_ISOLATED_URL")

        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            endpoint,
            credential,
            signing_key=self.isolated_key,
            signing_certificate=self.isolated_certificate,
        ) as admin_client:

            set_result, _ = await admin_client.set_policy(
                AttestationType.SGX_ENCLAVE,
                """version= 1.0;authorizationrules{=> permit();};issuancerules {};""",
                validation_slack=1.0,
            )
            print("Policy Set Resolution: ", set_result.policy_resolution)
            print("Resulting policy signer should match the input certificate:")
            print("Policy Signer: ", set_result.policy_signer.certificates[0])
            print("Certificate:   ", self.isolated_certificate)

            print(
                "Reset the attestation policy to the default now to avoid side effects."
            )
            # Reset the policy now that we're done.
            await admin_client.reset_policy(AttestationType.SGX_ENCLAVE)

    async def get_policy_management_certificates(self):
        """
        Retrieve the policy management certificates for an Isolated mode attestation
        instance.
        This sample shows the use of the get_certificates API to retrieve the
        current set of attestation signing certificates.
        """
        write_banner("get_policy_management_certificates_isolated")

        # [BEGIN get_policy_management_certificate]
        print("Get the policy management certificates for a isolated instance.")
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            os.environ.get("ATTESTATION_ISOLATED_URL"), credential
        ) as admin_client:
            certificates, _ = await admin_client.get_policy_management_certificates()
            print("Isolated instance has", len(certificates), "certificates")

            # An Isolated attestation instance should have at least one signing
            # certificate which is configured when the instance is created.
            #
            # Note that the certificate list returned is an array of certificate chains.
            for cert_chain in certificates:
                print("Certificate chain has ", len(cert_chain), " elements.")
                i = 1
                for cert in cert_chain:
                    # load_pem_x509_certifcate takes a bytes, not str, so convert.
                    certificate = load_pem_x509_certificate(cert.encode("ascii"))
                    print("    Certificate", i, "subject:", certificate.subject)
                    i += 1
        # [END get_policy_management_certificate]

    async def add_remove_policy_management_certificate(self):
        """
        Add and then remove a  policy management certificates for an Isolated
        mode attestation instance.

        """
        write_banner("add_remove_policy_management_certificate")
        print("Get and set the policy management certificates for a isolated instance.")
        endpoint = os.environ.get("ATTESTATION_ISOLATED_URL")
        # [BEGIN add_policy_management_certificate]
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            endpoint, credential
        ) as admin_client:
            new_key = create_rsa_key()
            new_certificate = create_x509_certificate(new_key, u"NewCertificateName")

            # Add the new certificate to the list.
            add_result, _ = await admin_client.add_policy_management_certificate(
                new_certificate,
                signing_key=self.isolated_key,
                signing_certificate=self.isolated_certificate,
                validation_slack=1.0,
            )
            if add_result.certificate_resolution != CertificateModification.IS_PRESENT:
                raise Exception("Certificate was not added!")
            # [END add_policy_management_certificate]

            certificates, _ = await admin_client.get_policy_management_certificates()
            print("Isolated instance now has", len(certificates), "certificates")

            for cert_pem in certificates:
                cert = load_pem_x509_certificate(
                    cert_pem[0].encode("ascii"), default_backend()
                )
                print("certificate subject: ", cert.subject)

            # The signing certificate for the isolated instance should be
            # the configured isolated_signing_certificate.
            #
            # Note that the certificate list returned is an array of certificate chains.
            actual_cert0 = certificates[0][0]
            isolated_cert = self.isolated_certificate
            print("Actual Cert 0:   ", actual_cert0)
            print("Isolated Cert: ", isolated_cert)
            if actual_cert0 != isolated_cert:
                raise Exception("Unexpected certificate mismatch.")

            found_cert = False
            expected_cert = new_certificate
            for cert_pem in certificates:
                actual_cert1 = cert_pem[0]
                if actual_cert1 == expected_cert:
                    found_cert = True
            if not found_cert:
                raise Exception("Could not find new certificate!")

            # Now remove the certificate we just added.
            print("Remove the newly added certificate.")
            # [BEGIN remove_policy_management_certificate]
        async with DefaultAzureCredential() as credential, AttestationAdministrationClient(
            endpoint, credential
        ) as admin_client:
            remove_result, _ = await admin_client.remove_policy_management_certificate(
                new_certificate,
                signing_key=self.isolated_key,
                signing_certificate=self.isolated_certificate,
            )

            if (
                remove_result.certificate_resolution
                != CertificateModification.IS_ABSENT
            ):
                raise Exception("Certificate was not removed!")
            # [END remove_policy_management_certificate]

    async def _attest_open_enclave(self, client_uri):
        oe_report = base64.urlsafe_b64decode(sample_open_enclave_report)
        runtime_data = base64.urlsafe_b64decode(sample_runtime_data)
        print("Attest open enclave using ", client_uri)
        async with DefaultAzureCredential() as credential, AttestationClient(
            client_uri, credential
        ) as attest_client:
            await attest_client.attest_open_enclave(
                oe_report, runtime_data=runtime_data
            )
            print("Successfully attested enclave.")

    async def __aenter__(self):
        return self

    async def __aexit__(self, *exc_type):
        await self.close()


async def main():
    async with AttestationClientPolicySamples() as sample:
        await sample.get_policy_aad()
        await sample.set_policy_aad_unsecured()
        await sample.reset_policy_aad_unsecured()
        await sample.set_policy_aad_secured()
        await sample.set_policy_validate_hash()
        await sample.reset_policy_aad_secured()
        await sample.reset_policy_isolated()
        await sample.set_policy_isolated_secured()
        await sample.get_policy_management_certificates()
        await sample.add_remove_policy_management_certificate()


if __name__ == "__main__":
    asyncio.run(main())