X.509 証明書を使用して、Linux 上で IoT Edge デバイスを大規模に作成およびプロビジョニングする

[アーティクル]
08/17/2022

適用対象: IoT Edge 1.1

重要

IoT Edge 1.1 のサポート終了日は、2022 年 12 月 13 日でした。本製品、サービス、テクノロジ、または API のサポート内容については、Microsoft 製品のライフサイクルに関するページをご確認ください。最新バージョンの IoT Edge への更新の詳細については、「 Update IoT Edge」を参照してください。

この記事では、X.509 証明書を使用して 1 つまたは複数の Linux IoT Edge デバイスを自動プロビジョニングするエンドツーエンドの手順について説明します。 Azure IoT Edge デバイスは、Azure IoT Hub Device Provisioning Service (DPS) を使用して自動プロビジョニングできます。自動プロビジョニングの処理に慣れていない場合は、プロビジョニングの概要を確認してから先に進んでください。

タスクは次のとおりです。

証明書とキーを生成する。
単一のデバイスの個別登録を作成するか、一連のデバイスに対してグループ登録を作成する。
IoT Edge ランタイムをインストールし、デバイスを IoT Hub に登録する。

X.509 証明書を構成証明メカニズムとして使用することは、実稼働環境を拡張し、デバイスのプロビジョニングを簡素化するための優れた方法です。通常、X.509 証明書は信頼する証明書チェーンに配置されます。自己署名証明書または信頼されたルート証明書から開始して、チェーン内の各証明書によって、それよりも 1 つ下位にある証明書が署名されます。このパターンにより、ルート証明書から各中間証明書を経由して、デバイスにインストールされた最終的なダウンストリームデバイス証明書に至る、委任された信頼チェーンが作成されます。

ヒント

デバイスに TPM 2.0 などのハードウェアセキュリティモジュール (HSM) がある場合は、X.509 キーを HSM に安全に格納することをお勧めします。 iotedge-tpm2cloud サンプルを使用して、このブループリントで説明されているゼロタッチプロビジョニングを大規模に実装する方法について説明します。

前提条件

クラウドリソース

アクティブな IoT ハブ
自分の IoT ハブにリンクされた、Azure 内の IoT Hub デバイスプロビジョニングサービスのインスタンス
- デバイスプロビジョニングサービスのインスタンスをお持ちでない場合は、IoT Hub デバイスプロビジョニングサービスクイックスタートの「新しい IoT Hub デバイスプロビジョニングサービスの作成」および「IoT ハブとデバイスプロビジョニングサービスとをリンクさせる」の手順に従ってください。
- Device Provisioning Service を実行した後、概要ページから [ID スコープ] の値をコピーします。この値は、IoT Edge ランタイムを構成するときに使用します。

デバイスの要件

IoT Edge デバイスとなる物理デバイスまたは仮想 Linux デバイス。

デバイス ID 証明書を生成する

デバイス ID 証明書は、証明書の信頼チェーンを介して最上位の X.509 証明機関 (CA) 証明書につながるダウンストリームデバイス証明書です。デバイス ID 証明書の共通名 (CN) は、IoT ハブ内のデバイスに付けるデバイス ID に設定されている必要があります。

デバイス ID 証明書は、IoT Edge デバイスのプロビジョニングと、Azure IoT Hub でのデバイス認証を行うためにのみ使用されます。それらは、IoT Edge デバイスによって検証のためにモジュールやダウンストリームデバイスに提示される CA 証明書のような署名証明書ではありません。詳細については、Azure IoT Edge 証明書の使用方法に関する詳細のページを参照してください。

デバイス ID 証明書を作成すると、2 つのファイルができます。証明書の公開部分を含む .cer または pem ファイルと、証明書の秘密キーを含む .cer または pem ファイルです。 DPS でグループ登録を使用する予定がある場合は、同じ信頼する証明書チェーン内にある中間証明書またはルート CA 証明書の公開部分も必要です。

X.509 を使用して自動プロビジョニングを設定するには、次のファイルが必要です。

デバイス ID 証明書とその秘密キー証明書。個別登録を作成すると、デバイス ID 証明書が DPS にアップロードされます。秘密キーは IoT Edge ランタイムに渡されます。
完全なチェーン証明書。少なくともデバイス ID と中間証明書が含まれている必要があります。完全なチェーン証明書は IoT Edge ランタイムに渡されます。
信頼する証明書チェーンからの中間証明書またはルート CA 証明書。グループ登録を作成すると、この証明書は DPS にアップロードされます。

Note

現時点では、libiothsm の制限により、2038 年 1 月 1 日以降に有効期限が切れる証明書は使用できません。

テスト証明書を使用する (省略可能)

新しい ID 証明書を作成するために使用できる証明機関がない場合、このシナリオを試すには、Azure IoT Edge の Git リポジトリにあるスクリプトを使用してテスト証明書を生成できます。それらの証明書は開発テスト専用に設計されているため、運用環境では使用できません。

テスト証明書を作成するには、「IoT Edge デバイスの機能をテストするためのデモ用の証明書を作成する」の手順に従います。証明書生成スクリプトを設定してルート CA 証明書を作成するために必要とされる、2 つのセクションを完了します。次に、手順に従ってデバイス ID 証明書を作成します。完了すると、次の証明書チェーンとキーの組が作成されます。

<WRKDIR>/certs/iot-edge-device-identity-<name>-full-chain.cert.pem
<WRKDIR>/private/iot-edge-device-identity-<name>.key.pem

これらの証明書の両方が IoT Edge デバイス上に必要です。 DPS で個別登録を使用する場合は、.cert.pem ファイルをアップロードします。 DPS でグループ登録を使用する場合は、同じ信頼する証明書チェーン内に、アップロードする中間証明書またはルート CA 証明書も必要です。デモ用の証明書を使用している場合は、グループ登録用に <WRKDIR>/certs/azure-iot-test-only.root.ca.cert.pem 証明書を使用します。

DPS の登録を作成する

生成された証明書とキーを使用して、DPS で 1 つまたは複数の IoT Edge デバイスの登録を作成します。

単一の IoT Edge デバイスをプロビジョニングする方法を求めている場合は、個別の登録を作成します。複数のデバイスをプロビジョニングする必要がある場合は、DPS グループ登録を作成する手順に従います。

DPS 内に登録を作成するときに、デバイスツインの初期状態を宣言する機会があります。デバイスツインでは、ソリューションで必要な任意のメトリック (リージョン、環境、場所、デバイスの種類など) によってデバイスをグループ化するためのタグを設定できます。これらのタグは、自動展開を作成するために使用されます。

デバイスプロビジョニングサービスでの登録の詳細については、デバイス登録の管理方法に関するページをご覧ください。

個別登録
グループ登録

DPS 個別登録を作成する

個別登録では、デバイスの ID 証明書の公開部分が渡され、デバイス上の証明書と照合されます。

ヒント

この記事の手順は Azure portal 向けですが、Azure CLI を使用して個別登録を作成することもできます。詳細については、az iot dps enrollment を参照してください。この CLI コマンドの一部として、edge-enabled フラグを使用して、登録の対象が IoT Edge デバイスであることを指定します。

Azure portal で、IoT Hub Device Provisioning Service のインスタンスに移動します。
[設定] の下の [登録の管理] を選択します。
[Add individual enrollment]\(個別登録の追加\) を選択し、登録を構成する次の手順を完了します。
- メカニズム: [X.509] を選択します。
- [プライマリ証明書の .pem ファイルまたは .cer ファイル]: デバイス ID 証明書からパブリックファイルをアップロードします。スクリプトを使用してテスト証明書を生成した場合は、次のファイルを選択します。
  
  <WRKDIR>\certs\iot-edge-device-identity-<name>.cert.pem
- [IoT Hub のデバイス ID]: 必要に応じて、デバイス ID を指定します。デバイス ID を使用して、個々のデバイスをモジュール展開のターゲットにすることができます。デバイス ID を指定しない場合は、X.509 証明書内の共通名 (CN) が使用されます。
- [IoT Edge デバイス]: [True] を選択して、その登録が IoT Edge デバイス用のものであることを宣言します。
- [このデバイスを割り当てることができる IoT ハブを選択する]: デバイスの接続先になるリンクされた IoT ハブを選択します。複数のハブを選択でき、デバイスは、選択した割り当てポリシーに従ってそれらのハブの 1 つに割り当てられます。
- [デバイスツインの初期状態]: 必要に応じて、デバイスツインに追加するタグ値を追加します。タグを使用して、デバイスグループを自動展開のターゲットにすることができます。次に例を示します。
```
{
    "tags": {
       "environment": "test"
    },
    "properties": {
       "desired": {}
    }
}
```
[保存] を選択します。

[登録を管理します] で、作成した登録の登録 ID を確認できます。デバイスをプロビジョニングするときに使用できるので、メモします。

これで、このデバイスの登録が存在しているので、IoT Edge ランタイムによってインストール時にデバイスを自動的にプロビジョニングできます。

DPS グループ登録を作成する

グループ登録では、個々のデバイス ID 証明書の生成に使用された信頼する証明書チェーンから、中間証明書またはルート CA 証明書を使用します。

ルート証明書を確認する

登録グループを作成するときに、確認済みの証明書を使用することもできます。ルート証明書の所有権があることを示すことによって、DPS で証明書を確認できます。詳細については、X.509 CA 証明書の所有証明を行う方法に関するページを参照してください。

Azure portal で、IoT Hub Device Provisioning Service のインスタンスに移動します。
左側のメニューから [証明書] を選択します。
[追加] を選択して新しい証明書を追加します。
証明書のフレンドリ名を入力し、X.509 証明書の公開部分を表す .cer または .pem ファイルを参照します。

デモ用の証明書を使用している場合は、<wrkdir>\certs\azure-iot-test-only.root.ca.cert.pem 証明書をアップロードします。
[保存] を選択します。
これで、その証明書が [証明書] ページに表示されます。それを選択して証明書の詳細を開きます。
[確認コードを生成します] を選択した後、生成されたコードをコピーします。
独自の CA 証明書を入手したか、デモ用の証明書を使用しているかにかかわらず、IoT Edge リポジトリに用意されている検証ツールを使用して、所有証明を確認することができます。検証ツールでは、CA 証明書を使用して、指定された確認コードをサブジェクト名として持つ新しい証明書に署名します。
```
New-CACertsVerificationCert "<verification code>"
```
Azure portal の同じ証明書詳細ページで、新しく生成された検証証明書をアップロードします。
[認証] を選択します。

登録グループを作成する

デバイスプロビジョニングサービスでの登録の詳細については、デバイス登録の管理方法に関するページをご覧ください。

ヒント

この記事の手順は Azure portal 向けですが、Azure CLI を使用してグループ登録を作成することもできます。詳細については、az iot dps enrollment-group を参照してください。この CLI コマンドの一部として、edge-enabled フラグを使用して、登録の対象が IoT Edge デバイスであることを指定します。グループ登録の場合、すべてのデバイスを IoT Edge デバイスにする必要があります。そうしない場合、いずれも IoT Edge デバイスにすることはできません。

Azure portal で、IoT Hub Device Provisioning Service のインスタンスに移動します。
[設定] の下の [登録の管理] を選択します。
[登録グループの追加] を選択し、登録を構成する以下の手順を完了します。
- [グループ名]: このグループ登録の覚えやすい名前を入力します。
- [構成証明の種類]: [Certificate] を選択します。
- [IoT Edge デバイス]: [True] を選択します。グループ登録の場合、すべてのデバイスを IoT Edge デバイスにする必要があります。そうしない場合、いずれも IoT Edge デバイスにすることはできません。
- [証明書の種類]: [CA 証明書] を選択します。
- [プライマリ証明書]: ドロップダウンリストからご利用の証明書を選択します。
- [このデバイスを割り当てることができる IoT ハブを選択する]: デバイスの接続先になるリンクされた IoT ハブを選択します。複数のハブを選択でき、デバイスは、選択した割り当てポリシーに従ってそれらのハブの 1 つに割り当てられます。
- [デバイスツインの初期状態]: 必要に応じて、デバイスツインに追加するタグ値を追加します。タグを使用して、デバイスグループを自動展開のターゲットにすることができます。次に例を示します。
```
{
    "tags": {
       "environment": "test"
    },
    "properties": {
       "desired": {}
    }
}
```
[保存] を選択します。

[登録を管理します] で、作成した登録の登録 ID を確認できます。デバイスをプロビジョニングするときに使用できるので、メモします。

これで、これらのデバイスの登録が存在しているので、IoT Edge ランタイムによってインストール時にデバイスを自動的にプロビジョニングできます。

IoT Edge をインストールする

このセクションでは、Linux VM または IoT Edge の物理デバイスを準備します。次に、IoT Edge をインストールします。

次のコマンドを実行してパッケージリポジトリを追加し、信頼できるキーの一覧に Microsoft パッケージ署名キーを追加します。

重要

2022 年 6 月 30 日に、レベル 1 OS サポートリストから Raspberry Pi OS Stretch が廃止されました。潜在的なセキュリティの脆弱性を回避するために、ホスト OS を Bullseye に更新してください。

インストールは、数個のコマンドで実行できます。ターミナルを開き、次のコマンドを実行します。

20.04:

wget https://packages.microsoft.com/config/ubuntu/20.04/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb

18.04:

wget https://packages.microsoft.com/config/ubuntu/18.04/multiarch/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb

APT を使用したインストールは、少ないコマンドで実行できます。ターミナルを開き、次のコマンドを実行します。

11 - Bullseye (arm32v7):

curl https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb > ./packages-microsoft-prod.deb
sudo apt install ./packages-microsoft-prod.deb

ヒント

OS のインストール中に "root" アカウントにパスワードを指定した場合、'sudo' は不要です。上記のコマンドを 'apt' から始めて実行できます。

インストールは、数個のコマンドで実行できます。ターミナルを開き、次のコマンドを実行します。

8.x (amd64):

  wget https://packages.microsoft.com/config/rhel/8/packages-microsoft-prod.rpm -O packages-microsoft-prod.rpm
  sudo yum localinstall packages-microsoft-prod.rpm
  rm packages-microsoft-prod.rpm

Note

Azure IoT Edge ソフトウェアパッケージには、パッケージ内にあるライセンス条項 (usr/share/doc/{package-name} または LICENSE ディレクトリ) が適用されます。パッケージを使用する前に、ライセンス条項をお読みください。インストールし、パッケージを使用すると、これらの条項に同意したものと見なされます。ライセンス条項に同意しない場合は、そのパッケージを使用しないでください。

コンテナーエンジンをインストールする

Azure IoT Edge は、OCI と互換性のあるコンテナーランタイムに依存します。運用環境のシナリオでは、Moby エンジンを使用することをお勧めします。 Moby エンジンは、IoT Edge で公式にサポートされている唯一のコンテナーエンジンです。 Docker CE/EE コンテナーイメージは、Moby ランタイムと互換性があります。

Moby エンジンをインストールします。

sudo apt-get update; \
  sudo apt-get install moby-engine

Moby エンジンをインストールします。

sudo apt-get update; \
  sudo apt-get install moby-engine

Moby エンジンと CLI をインストールします。

sudo yum install moby-engine moby-cli

Moby エンジンが正常にインストールされたら、ログメカニズムとして local ログドライバーを使用するように構成します。ログ構成の詳細については、「運用環境デプロイのチェックリスト」を参照してください。

/etc/docker/daemon.json で、Docker デーモンの構成ファイルを作成するか、開きます。
次の例に示すように、既定のログドライバーを local ログドライバーに設定します。
```
   {
      "log-driver": "local"
   }
```
コンテナーエンジンを再起動して、変更を有効にします。
```
sudo systemctl restart docker
```
ヒント

Moby コンテナーエンジンをインストールするときにエラーが発生する場合は、Linux カーネルに Moby との互換性があることを確認します。埋め込みデバイスの一部の製造元からは、コンテナーエンジンとの互換性のために必要な機能を備えていないカスタム Linux カーネルを含むデバイスイメージが提供されています。 Moby から提供されている check-config スクリプトを使用する次のコマンドを実行して、カーネルの構成を確認します。
```
curl -ssl https://raw.githubusercontent.com/moby/moby/master/contrib/check-config.sh -o check-config.sh
chmod +x check-config.sh
./check-config.sh
```
スクリプトの出力で、Generally Necessary と Network Drivers の下のすべての項目が有効になっていることを確認します。機能が欠けている場合は、カーネルをソースから再構築し、カーネルの適切な .config に含める関連モジュールを選択することで、それらを有効にします。同様に、defconfig や menuconfig などのカーネル構成ジェネレーターを使用している場合は、それぞれの機能を見つけて有効にし、ご自分のカーネルを適宜再構築します。新たに変更されたカーネルを展開したら、check-config スクリプトをもう一度実行して、必要なすべての機能が正常に有効になっていることを確認します。

IoT Edge ランタイムをインストールする

IoT Edge セキュリティデーモンによって、IoT Edge デバイス上にセキュリティ標準が提供されて維持されます。デーモンは起動のたびに開始され、IoT Edge ランタイムの残りの部分を開始することでデバイスをブートストラップします。

このセクションの手順では、インターネットに接続されているデバイスに最新バージョンをインストールする一般的なプロセスが示されています。プレリリースバージョンなどの特定のバージョンをインストールする必要がある場合、またはオフラインの間にインストールする必要がある場合は、この記事で後述する「オフラインまたは特定のバージョンのインストール」の手順に従ってください。

IoT Edge バージョン 1.1* と libiothsm-std パッケージをインストールします。

sudo apt-get update; \
  sudo apt-get install iotedge

sudo apt-get update; \
  sudo apt-get install iotedge

Note

IoT Edge バージョン 1.1 は、IoT Edge の長期サポートブランチです。古いバージョンを実行している場合は、サポートされなくなるため、最新のパッチのインストールまたは更新をお勧めします。

クラウド ID を使用してデバイスをプロビジョニングする

ランタイムがデバイスにインストールされたら、デバイスプロビジョニングサービスと IoT Hub に接続するための情報を使用してデバイスを構成します。

次の情報を用意しておきます。

DPS の ID スコープ値。 Azure portal で、使用している DPS インスタンスの概要ページから、この値を取得できます。
デバイス上のデバイス ID 証明書チェーンファイル。
デバイス上のデバイス ID キーファイル。

IoT Edge デバイスで構成ファイルを開きます。
```
sudo nano /etc/iotedge/config.yaml
```

ファイルのプロビジョニング構成セクションを見つけます。 DPS X.509 証明書のプロビジョニング行をコメント解除し、他にもプロビジョニング行があれば、それらもコメントアウトするようにします。

provisioning: の行の先頭には空白文字を入れず、入れ子の項目には 2 つの空白でインデントする必要があります。

# DPS X.509 provisioning configuration
provisioning:
  source: "dps"
  global_endpoint: "https://global.azure-devices-provisioning.net"
  scope_id: "SCOPE_ID_HERE"
  attestation:
    method: "x509"
#   registration_id: "OPTIONAL_REGISTRATION_ID_LEAVE_COMMENTED_OUT_TO_REGISTER_WITH_CN_OF_IDENTITY_CERT"
    identity_cert: "REQUIRED_URI_TO_DEVICE_IDENTITY_CERTIFICATE_HERE"
    identity_pk: "REQUIRED_URI_TO_DEVICE_IDENTITY_PRIVATE_KEY_HERE"

# always_reprovision_on_startup: true
# dynamic_reprovisioning: false

scope_id、identity_cert、identity_pk の値を DPS およびデバイス情報で更新します。

X.509 証明書とキー情報を config.yaml ファイルに追加する場合、パスはファイル URI として指定する必要があります。次に例を示します。

file:///<path>/identity_certificate_chain.pem file:///<path>/identity_key.pem
必要に応じて、デバイスの registration_id を指定します。これは ID 証明書の共通名 (CN) と一致している必要があります。その行をコメントアウトしたままにすると、CN が自動的に適用されます。
必要に応じて、always_reprovision_on_startup または dynamic_reprovisioning の行を使用して、デバイスの再プロビジョニング動作を構成します。起動時に再プロビジョニングするようにデバイスが設定されている場合、常に最初に DPS を使用してプロビジョニングが試行され、失敗した場合はプロビジョニングのバックアップにフォールバックします。デバイスが動的に自分自身を再プロビジョニングするように設定されている場合、再プロビジョニングイベントが検出されると (デバイスが IoT Hub 間で移動された場合など)、IoT Edge (およびすべてのモジュール) が再起動して再プロビジョニングされます。具体的には、IoT Edge は、再プロビジョニングイベントを検出するため、SDK からの bad_credential または device_disabled エラーをチェックします。このイベントを手動でトリガーするには、IoT Hub でデバイスを無効にします。詳細については、「IoT Hub デバイスの再プロビジョニングの概念」を参照してください。
config.yaml ファイルを保存して閉じます。
デバイスで行ったすべての構成の変更が反映されるように、IoT Edge ランタイムを再起動します。
```
sudo systemctl restart iotedge
```

インストールの成功を確認する

ランタイムが正常に起動されたら、IoT Hub にアクセスし、デバイスに IoT Edge モジュールを展開できます。

個別登録
グループ登録

デバイスプロビジョニングサービスで作成した個々の登録が使用されたことを確認できます。 Azure portal でデバイスプロビジョニングサービスインスタンスに移動します。作成した個々の登録の詳細を開きます。登録の状態が割り当てられており、デバイス ID が表示されています。

IoT Edge が正常にインストールされ、起動されたことを確認するには、デバイスで次のコマンドを使用します。

IoT Edge サービスの状態を確認します。

systemctl status iotedge

サービスログを調べます。

journalctl -u iotedge --no-pager --no-full

実行中のモジュールを一覧表示します。

iotedge list

次のステップ

デバイスプロビジョニングサービスの登録プロセスでは、新しいデバイスをプロビジョニングするときに、デバイス ID とデバイスツインタグを同時に設定できます。これらの値を使用して、個々のデバイスまたはデバイスグループをデバイスの自動管理で使用できます。使用方法については、「Azure Portal を使用した大規模な IoT Edge モジュールの展開と監視」または「Azure CLI を使用した大規模な IoT Edge モジュールの展開と監視」を参照してください。

次の方法で共有

X.509 証明書を使用して、Linux 上で IoT Edge デバイスを大規模に作成およびプロビジョニングする

前提条件

クラウドリソース

デバイスの要件

デバイス ID 証明書を生成する

テスト証明書を使用する (省略可能)

DPS の登録を作成する

DPS 個別登録を作成する

DPS グループ登録を作成する

ルート証明書を確認する

登録グループを作成する

IoT Edge をインストールする

コンテナーエンジンをインストールする

IoT Edge ランタイムをインストールする

クラウド ID を使用してデバイスをプロビジョニングする

インストールの成功を確認する

次のステップ

その他のリソース

次の方法で共有

X.509 証明書を使用して、Linux 上で IoT Edge デバイスを大規模に作成およびプロビジョニングする

前提条件

クラウド リソース

デバイスの要件

デバイス ID 証明書を生成する

テスト証明書を使用する (省略可能)

DPS の登録を作成する

DPS 個別登録を作成する

IoT Edge をインストールする

コンテナー エンジンをインストールする

IoT Edge ランタイムをインストールする

クラウド ID を使用してデバイスをプロビジョニングする

インストールの成功を確認する

次のステップ

その他のリソース

クラウドリソース

コンテナーエンジンをインストールする