File: dps_service_sample_enrollment_groups.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 (206 lines) | stat: -rw-r--r-- 7,827 bytes parent folder | download
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
# 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: dps_service_sample_enrollment_groups.py
DESCRIPTION:
    This sample demos basic DPS enrollment group operations
PREREQUISITE:
    In order to create an x509 enrollment group, you'll need to have created at least
    one primary certificate. Any valid self-signed certificate should work.
    You can create a self-signed cert with openssl by running the following command:
        `openssl req -nodes -new -x509 -out enrollment-cert.pem --subj="/CN=Provisioning Service SDK Test Cert"`
USAGE: python dps_service_sample_enrollment_groups.py
    Set the environment variables with your own values before running the sample:
    1) AZURE_DPS_CONNECTION_STRING - the connection string to your DPS instance.
    2) AZURE_DPS_ENROLLMENT_CERT_PATH - Path to your certificate
"""

from os import environ


class EnrollmentGroupSamples(object):
    connection_string = environ["AZURE_DPS_CONNECTION_STRING"]
    x509_cert_path = environ["AZURE_DPS_ENROLLMENT_CERT_PATH"]

    symmetric_enrollment_group_id = "sample_symmetric_enrollment_group"
    x509_enrollment_group_id = "sample_x509_enrollment_group"

    def create_symmetric_key_enrollment_group_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Create an enrollment group object with "SymmetricKey" attestation mechanism
        enrollment_group = {
            "enrollmentGroupId": self.symmetric_enrollment_group_id,
            "attestation": {
                "type": "symmetricKey",
            },
        }

        dps_service_client.enrollment_group.create_or_update(
            id=self.symmetric_enrollment_group_id, enrollment_group=enrollment_group
        )

    def create_x590_enrollment_group_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Load certificate contents from file
        certificate = open(self.x509_cert_path, "rt", encoding="utf-8")
        cert_contents = certificate.read()

        # Create an enrollment group object with "x509" attestation mechanism
        enrollment_group = {
            "enrollmentGroupId": self.x509_enrollment_group_id,
            "attestation": {
                "type": "x509",
                "x509": {
                    "signingCertificates": {
                        "primary": {"certificate": f"{cert_contents}"},
                        "secondary": {"certificate": f"{cert_contents}"},
                    }
                },
            },
        }

        dps_service_client.enrollment_group.create_or_update(
            id=self.x509_enrollment_group_id, enrollment_group=enrollment_group
        )

    def get_enrollment_group_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Get enrollment groups
        dps_service_client.enrollment_group.get(id=self.symmetric_enrollment_group_id)

        dps_service_client.enrollment_group.get(id=self.x509_enrollment_group_id)

    def get_enrollment_group_attestation_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Get attestations for enrollment groups
        dps_service_client.enrollment_group.get_attestation_mechanism(
            id=self.x509_enrollment_group_id
        )

        dps_service_client.enrollment_group.get_attestation_mechanism(
            id=self.symmetric_enrollment_group_id
        )

    def update_enrollment_group_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Get enrollment group
        sym_enrollment = dps_service_client.enrollment_group.get(
            id=self.symmetric_enrollment_group_id
        )

        # Parse eTag to ensure update
        eTag = sym_enrollment["etag"]

        # Update enrollment group properties
        sym_enrollment["provisioningStatus"] = "disabled"
        sym_enrollment["allocationPolicy"] = "geoLatency"

        # Send update
        dps_service_client.enrollment_group.create_or_update(
            id=self.symmetric_enrollment_group_id,
            enrollment_group=sym_enrollment,
            if_match=eTag,
        )

    def bulk_enrollment_group_operations_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Create a few more enrollment groups in bulk
        enrollment_group_id = "bulk_enrollment_group_1"
        enrollment_group2_id = "bulk_enrollment_group_2"
        enrollment_groups = [
            # Create first enrollment
            {
                "enrollmentGroupId": enrollment_group_id,
                "attestation": {
                    "type": "symmetricKey",
                },
            },
            {
                "enrollmentGroupId": enrollment_group2_id,
                "attestation": {
                    "type": "symmetricKey",
                },
            },
        ]

        # Create a bulk operation object
        bulk_operation = {"mode": "create", "enrollmentGroups": enrollment_groups}

        # Send create operation
        dps_service_client.enrollment_group.run_bulk_operation(
            bulk_operation=bulk_operation
        )

        # Modify bulk operation properties
        bulk_operation["mode"] = "delete"

        # Send delete operation
        dps_service_client.enrollment_group.run_bulk_operation(
            bulk_operation=bulk_operation
        )

    def delete_enrollment_groups_sample(self):
        # Instantiate a DPS Service Client using a connection string
        from azure.iot.deviceprovisioning import DeviceProvisioningClient

        dps_service_client = DeviceProvisioningClient.from_connection_string(
            self.connection_string
        )

        # Delete enrollment groups
        dps_service_client.enrollment_group.delete(id=self.x509_enrollment_group_id)
        dps_service_client.enrollment_group.delete(
            id=self.symmetric_enrollment_group_id
        )


if __name__ == "__main__":
    sample = EnrollmentGroupSamples()
    sample.create_symmetric_key_enrollment_group_sample()
    sample.create_x590_enrollment_group_sample()
    sample.get_enrollment_group_sample()
    sample.get_enrollment_group_attestation_sample()
    sample.update_enrollment_group_sample()
    sample.bulk_enrollment_group_operations_sample()
    sample.delete_enrollment_groups_sample()