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
|
# 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_individual_enrollments_async.py
DESCRIPTION:
This sample demos basic DPS individual enrollment operations
PREREQUISITE:
In order to create an x509 enrollment, 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_individual_enrollments_async.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
"""
import asyncio
from os import environ
class EnrollmentSamples(object):
connection_string = environ["AZURE_DPS_CONNECTION_STRING"]
x509_cert_path = environ["AZURE_DPS_ENROLLMENT_CERT_PATH"]
symmetric_enrollment_id = "sample_symmetric_enrollment"
x509_enrollment_id = "sample_x509_enrollment"
tpm_enrollment_id = "sample_tpm_enrollment"
# This is a sample TPM endorsement key
TEST_ENDORSEMENT_KEY = (
"AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAibym9HQP9vxCGF5dVc1Q"
"QsAGe021aUGJzNol1/gycBx3jFsTpwmWbISRwnFvflWd0w2Mc44FAAZNaJOAAxwZvG8GvyLlHh6fGKdh+mSBL4iLH2bZ4Ry22cB3"
"CJVjXmdGoz9Y/j3/NwLndBxQC+baNvzvyVQZ4/A2YL7vzIIj2ik4y+ve9ir7U0GbNdnxskqK1KFIITVVtkTIYyyFTIR0BySjPrRI"
"Dj7r7Mh5uF9HBppGKQCBoVSVV8dI91lNazmSdpGWyqCkO7iM4VvUMv2HT/ym53aYlUrau+Qq87Tu+uQipWYgRdF11KDfcpMHqqzB"
"QQ1NpOJVhrsTrhyJzO7KNw=="
)
async def create_symmetric_key_enrollment_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Set initial twin properties
initial_twin = {
"properties": {
"desired": {
"property": "value"
}
}
}
# Create an individual enrollment object with "SymmetricKey" attestation mechanism
enrollment = {
"registrationId": self.symmetric_enrollment_id,
"attestation": {
"type": "symmetricKey",
},
"initialTwin": initial_twin
}
await dps_service_client.enrollment.create_or_update(
id=self.symmetric_enrollment_id, enrollment=enrollment
)
async def create_x590_enrollment_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio 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 individual enrollment object with "x509" attestation mechanism
enrollment = {
"registrationId": self.x509_enrollment_id,
"attestation": {
"type": "x509",
"x509": {
"clientCertificates": {
"primary": {"certificate": f"{cert_contents}"},
"secondary": {"certificate": f"{cert_contents}"},
}
},
},
}
await dps_service_client.enrollment.create_or_update(
id=self.x509_enrollment_id, enrollment=enrollment
)
async def create_tpm_enrollment_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Create an individual enrollment object with "TPM" attestation mechanism
enrollment = {
"registrationId": self.tpm_enrollment_id,
"attestation": {
"type": "tpm",
"tpm": {"endorsementKey": self.TEST_ENDORSEMENT_KEY},
},
}
await dps_service_client.enrollment.create_or_update(
id=self.tpm_enrollment_id, enrollment=enrollment
)
async def get_enrollment_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Get individual enrollments
await dps_service_client.enrollment.get(
id=self.symmetric_enrollment_id
)
await dps_service_client.enrollment.get(id=self.x509_enrollment_id)
await dps_service_client.enrollment.get(id=self.tpm_enrollment_id)
async def get_enrollment_attestation_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Get attestations for individual enrollments
await dps_service_client.enrollment.get_attestation_mechanism(
id=self.x509_enrollment_id
)
await dps_service_client.enrollment.get_attestation_mechanism(
id=self.symmetric_enrollment_id
)
await dps_service_client.enrollment.get_attestation_mechanism(
id=self.tpm_enrollment_id
)
async def update_enrollment_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Get individual enrollment
sym_enrollment = await dps_service_client.enrollment.get(
id=self.symmetric_enrollment_id
)
# Parse eTag to ensure update
eTag = sym_enrollment["etag"]
# Update individual enrollment properties
sym_enrollment["provisioningStatus"] = "disabled"
sym_enrollment["allocationPolicy"] = "geoLatency"
# Send update
await dps_service_client.enrollment.create_or_update(
id=self.symmetric_enrollment_id,
enrollment=sym_enrollment,
if_match=eTag,
)
async def update_enrollment_reprovisioning_policy_sample(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Get individual enrollment
sym_enrollment = await dps_service_client.enrollment.get(
id=self.symmetric_enrollment_id
)
# Parse eTag to ensure update
eTag = sym_enrollment["etag"]
# Create a new reprovisioning policy
sym_enrollment['reprovisionPolicy'] = {
# update device's hub assignment
"updateHubAssignment": True,
# don't migrate device data to a new hub
"migrateDeviceData": False,
}
# Update enrollment with custom reprovisioning policy
await dps_service_client.enrollment.create_or_update(
id=self.symmetric_enrollment_id,
enrollment=sym_enrollment,
if_match=eTag,
)
async def bulk_enrollment_operations_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Create a few more individual enrollments in bulk
enrollment_id = "bulk_enrollment_1"
enrollment2_id = "bulk_enrollment_2"
enrollments = [
# Create first enrollment
{
"registrationId": enrollment_id,
"attestation": {
"type": "symmetricKey",
},
},
{
"registrationId": enrollment2_id,
"attestation": {
"type": "symmetricKey",
},
},
]
# Create a bulk operation object
bulk_operation = {"mode": "create", "enrollments": enrollments}
# Send create operation
await dps_service_client.enrollment.run_bulk_operation(
bulk_operation=bulk_operation
)
# Modify bulk operation properties
bulk_operation["mode"] = "delete"
# Send delete operation
await dps_service_client.enrollment.run_bulk_operation(
bulk_operation=bulk_operation
)
async def delete_enrollments_sample_async(self):
# Instantiate a DPS Service Client using a connection string
from azure.iot.deviceprovisioning.aio import DeviceProvisioningClient
dps_service_client = DeviceProvisioningClient.from_connection_string(
self.connection_string
)
# Delete individual enrollments
await dps_service_client.enrollment.delete(
id=self.x509_enrollment_id
)
await dps_service_client.enrollment.delete(
id=self.symmetric_enrollment_id
)
await dps_service_client.enrollment.delete(id=self.tpm_enrollment_id)
async def main():
sample = EnrollmentSamples()
await sample.create_symmetric_key_enrollment_sample_async()
await sample.create_x590_enrollment_sample_async()
await sample.create_tpm_enrollment_sample_async()
await sample.get_enrollment_sample_async()
await sample.get_enrollment_attestation_sample_async()
await sample.update_enrollment_sample_async()
await sample.update_enrollment_reprovisioning_policy_sample()
await sample.bulk_enrollment_operations_sample_async()
await sample.delete_enrollments_sample_async()
if __name__ == "__main__":
asyncio.run(main())
|