Azure Device Provisioning Service (DPS) でX.509証明書を使用したデバイス自動登録をやってみた

# 作業ディレクトリの作成
mkdir azure-iot-certs
cd azure-iot-certs

# プライベートキーの作成
openssl genrsa -out root-ca.key 2048

# 証明書署名要求(CSR)の作成
openssl req -new -sha256 -key root-ca.key -out root-ca.csr -subj "/CN=Root CA for IoT"

# 自己署名ルート証明書の作成（.pem拡張子で作成）
openssl x509 -req -sha256 -days 3650 -in root-ca.csr -signkey root-ca.key -out root-ca.pem

# デバイスのプライベートキーの作成
openssl genrsa -out device1.key 2048

# デバイスのCSRの作成
# CN（Common Name）にデバイスIDを設定
openssl req -new -key device1.key -out device1.csr -subj "/CN=device1"

# ルート証明書でデバイス証明書に署名
openssl x509 -req -in device1.csr -CA root-ca.pem -CAkey root-ca.key -CAcreateserial -out device1.pem -days 365

# 検証用の秘密鍵を作成
openssl genrsa -out verification-cert.key 2048

# 検証コードをCN（Common Name）に設定したCSRを作成
openssl req -new -key verification-cert.key -out verification-cert.csr -subj "/CN=<verification_code>"

# ルート証明書で検証証明書に署名（.pem拡張子で作成）
openssl x509 -req -in verification-cert.csr -CA root-ca.pem -CAkey root-ca.key -CAcreateserial -out verification-cert.pem -days 365

pip install azure-iot-device

import os
import asyncio
import datetime
import random
import json
from azure.iot.device import X509
from azure.iot.device.aio import ProvisioningDeviceClient
from azure.iot.device.aio import IoTHubDeviceClient

# DPSの設定情報 - ご自身の環境に合わせて変更してください
PROVISIONING_HOST = "global.azure-devices-provisioning.net"
ID_SCOPE = "xxx"  # DPSインスタンスのIDスコープ

# 証明書とキーのパス - ご自身の環境に合わせて変更してください
DEVICE_CERT_PATH = "./device1.pem"  # デバイス証明書のパス
DEVICE_KEY_PATH = "./device1.key"   # デバイスのプライベートキーのパス
REGISTRATION_ID = "device1"  # 証明書のCN（Common Name）と一致する必要があります

async def provision_device():
    print("X.509証明書を使ってDPSに接続し、IoT Hubへの登録を開始します...")

    # X.509証明書の設定
    x509 = X509(
        cert_file=DEVICE_CERT_PATH,
        key_file=DEVICE_KEY_PATH,
        pass_phrase=None  # パスフレーズがある場合は指定
    )

    # DPSクライアントの作成
    provisioning_device_client = ProvisioningDeviceClient.create_from_x509_certificate(
        provisioning_host=PROVISIONING_HOST,
        registration_id=REGISTRATION_ID,  # 証明書のCNと一致する登録IDを指定
        id_scope=ID_SCOPE,
        x509=x509,
    )

    # DPSに接続して登録
    print("DPSに接続して登録を行っています...")
    registration_result = await provisioning_device_client.register()

    print(f"DPS登録ステータス: {registration_result.status}")
    if registration_result.status == "assigned":
        print(f"デバイスがIoT Hubに登録されました: {registration_result.registration_state.assigned_hub}")
        print(f"デバイスID: {registration_result.registration_state.device_id}")

        # IoT Hubに接続してテストメッセージを送信
        # X.509証明書で認証されたIoT Hubクライアントを作成
        device_client = IoTHubDeviceClient.create_from_x509_certificate(
            x509=x509,
            hostname=registration_result.registration_state.assigned_hub,
            device_id=registration_result.registration_state.device_id,
        )

        # IoT Hubに接続
        await device_client.connect()
        print(f"IoT Hub ({registration_result.registration_state.assigned_hub}) に接続しました！")

        # テストメッセージを送信
        for i in range(3):
            message = {
                "temperature": round(random.uniform(20.0, 30.0), 1),
                "humidity": round(random.uniform(50.0, 70.0), 1),
                "message": f"Hello from Python X.509 DPS device! (message {i+1}/3)",
                "timestamp": datetime.datetime.now().isoformat(),
                "deviceId": registration_result.registration_state.device_id
            }
            print(f"メッセージを送信しています: {json.dumps(message)}")
            await device_client.send_message(json.dumps(message))
            await asyncio.sleep(1)

        # 切断
        await device_client.disconnect()
        print("IoT Hubから切断しました")
    else:
        print(f"デバイスの登録に失敗しました。ステータス: {registration_result.status}")

    # DPSクライアントの切断は不要
    print("処理を終了します")

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

python dps_cert_device_test.py

X.509証明書を使ってDPSに接続し、IoT Hubへの登録を開始します...
DPSに接続して登録を行っています...
DPS登録ステータス: assigned
デバイスがIoT Hubに登録されました: sample-iot-hub.azure-devices.net
デバイスID: device1
IoT Hub (sample-iot-hub.azure-devices.net) に接続しました！
メッセージを送信しています: {"temperature": 24.6, "humidity": 67.3, "message": "Hello from Python X.509 DPS device! (message 1/3)", "timestamp": "2025-05-22T08:06:59.626893", "deviceId": "device1"}
メッセージを送信しています: {"temperature": 21.5, "humidity": 62.8, "message": "Hello from Python X.509 DPS device! (message 2/3)", "timestamp": "2025-05-22T08:07:00.857368", "deviceId": "device1"}
メッセージを送信しています: {"temperature": 29.0, "humidity": 58.1, "message": "Hello from Python X.509 DPS device! (message 3/3)", "timestamp": "2025-05-22T08:07:02.027735", "deviceId": "device1"}
IoT Hubから切断しました
処理を終了します

az extension add --name azure-iot

az iot hub monitor-events --hub-name YourIoTHubName

{
    "event": {
        "origin": "device1",
        "module": "",
        "interface": "",
        "component": "",
        "payload": {
            "temperature": 24.6,
            "humidity": 58.4,
            "message": "Hello from Python X.509 DPS device! (message 1/3)",
            "timestamp": "2025-05-22T10:45:12.345678",
            "deviceId": "device1"
        }
    }
}