IDT for FreeRTOS でデバイスプールを作成する
テストするデバイスは、デバイスプールにまとめられます。各デバイスプールは、1 つ以上の同一デバイスで構成されます。IDT for FreeRTOS を設定して、プール内の 1 つのデバイスまたは複数のデバイスをテストすることもがきます。認定プロセスを迅速化するために、IDT for FreeRTOS は、同じ仕様を持つデバイスを並行してテストできます。その際、ラウンドロビンメソッドを使用し、デバイスプール内の各デバイスで異なるテストグループが実行されます。
device.json ファイルの最上位には配列があります。各配列属性は新しいデバイスプールです。各デバイスプールにはデバイス配列属性があり、複数のデバイスが宣言されています。テンプレートには 1 つのデバイスプールがあり、そのデバイスプールにはデバイスが 1 つしかありません。1 つ以上のデバイスをデバイスプールに追加するには、devices フォルダにある device.json テンプレートの configs セクションを編集します。
注記
同じプール内のすべてのデバイスの技術仕様と SKU は同じでなければなりません。IDT for FreeRTOS は、異なるテストグループに対してソースコードの並列ビルドを可能にするため、ソースコードを IDT for FreeRTOS の抽出されたフォルダにある結果フォルダにコピーします。ビルドコマンドまたはフラッシュコマンドでは、testdata.sourcePath 変数を使用してソースコードパスを参照する必要があります。IDT for FreeRTOS は、この変数を、コピーしたソースコードの一時パスで置き換えます。詳細については、IDT for FreeRTOS 変数 を参照してください。
次の例では、device.json ファイルを使用して、複数のデバイスが含まれるデバイスプールを作成しました。
[ { "id": "pool-id", "sku": "sku", "features": [ { "name": "Wifi", "value": "Yes | No" }, { "name": "Cellular", "value": "Yes | No" }, { "name": "BLE", "value": "Yes | No" }, { "name": "PKCS11", "value": "RSA | ECC | Both" }, { "name": "OTA", "value": "Yes | No", "configs": [ { "name": "OTADataPlaneProtocol", "value": "MQTT | HTTP | None" } ] }, { "name": "KeyProvisioning", "value": "Onboard | Import | Both | No" } ], "devices": [ { "id": "device-id", "connectivity": { "protocol": "uart", "serialPort": "/dev/tty*" }, "secureElementConfig" : { "publicKeyAsciiHexFilePath": "absolute-path-to/public-key-txt-file: contains-the-hex-bytes-public-key-extracted-from-onboard-private-key", "publiDeviceCertificateArn": "arn:partition:iot:region:account-id:resourcetype:resource:qualifier", "secureElementSerialNumber": "secure-element-serialNo-value", "preProvisioned" : "Yes | No", "pkcs11JITPCodeVerifyRootCertSupport": "Yes | No" }, "identifiers": [ { "name": "serialNo", "value": "serialNo-value" } ] } ] } ]
次の属性は、device.json ファイルで使用されます。
-
id -
デバイスのプールを一意に識別するユーザー定義の英数字の ID。プールに属するデバイスは同じタイプであることが必要です。テストスイートを実行するとき、プールのデバイスを使用してワークロードが並列化されます。
-
sku -
テスト対象であるボードを一意に識別する英数字の値。SKU は、適格性が確認されたボードの追跡に使用されます。
注記
AWS Partner Device Catalog にボードを出品する場合は、ここで指定する SKU と出品プロセスで使用する SKU が一致する必要があります。
-
features -
デバイスでサポートされる機能を含む配列。AWS IoT Device Tester は、この情報を使用して、実行する認定テストを選択します。
サポートされている値は以下のとおりです。
-
Wifi -
ボードが Wi-Fi 機能を備えているかどうかを示します。
-
Cellular -
ボードがセルラー機能を備えているかどうかを示します。
-
PKCS11 -
ボードがサポートする公開鍵暗号化アルゴリズムを指定します。資格認定には PKCS11 が必要です。サポートされている値は、
ECC、RSA、およびBothです。Bothは、ボードがECCとRSAの両方をサポートしていることを示します。 -
KeyProvisioning -
信頼された X.509 クライアント証明書をボードに書き込む方法を指定します。
有効な値は、
Import、Onboard、Both、およびNoです。認定には、Onboard、Both、またはNoキープロビジョニングが必要です。Import単独では認定に有効なオプションではありません。-
Importは、ボードがプライベートキーのインポートを許可している場合にのみ使用します。Importの選択は認定には有効な構成ではないため、テスト目的、特に PKCS11 テストケースでのみ使用してください。Onboard、BothまたはNoは認定に必須です。 -
ボードがオンボードプライベートキーをサポートしている場合 (例えば、デバイスに安全な要素がある場合、または独自のデバイスのキーペアと証明書を生成する場合) は、
Onboardを使用します。各デバイスセクションにsecureElementConfig要素を追加し、publicKeyAsciiHexFilePathフィールドにパブリックキーファイルへの絶対パスを入力していることを確認します。 -
Bothは、ボードがキープロビジョニングのためにプライベートキーのインポートとオンボードキーの生成の両方をサポートしている場合に使用します。 -
Noは、ボードがキープロビジョニングをサポートしていない場合に使用します。Noは、デバイスも事前プロビジョニングされている場合のにみ有効なオプションです。
-
-
OTA -
ボードが無線 (OTA) による更新機能をサポートしているかどうかを示します。
OtaDataPlaneProtocol属性は、デバイスがサポートする OTA データプレーンプロトコルを示します。認定には、HTTP または MQTT データプレーンプロトコルのいずれかを使用する OTA が必要です。テスト中に OTA テストの実行をスキップするには、OTA 機能をNoに、OtaDataPlaneProtocol属性をNoneに設定します。これは認定の実行にはなりません。 -
BLE -
ボードが Bluetooth Low Energy (BLE) をサポートしているかどうかを示します。
-
-
devices.id -
テスト対象のデバイスのユーザー定義の一意の識別子。
-
devices.connectivity.serialPort -
テスト対象であるデバイスへの接続に使用される、ホストコンピュータのシリアルポート。
-
devices.secureElementConfig.PublicKeyAsciiHexFilePath -
ボードが
pre-provisionedではない場合、またはPublicDeviceCertificateArnが指定されていない場合は必須です。Onboardはキープロビジョニングの必須タイプであるため、現在 FullTransportInterfaceTLS テストグループでは、このフィールドは必須です。デバイスがpre-provisionedの場合、PublicKeyAsciiHexFilePathはオプションであり、含める必要はありません。次のブロックは、
Onboardプライベートキーから抽出された 16 進バイトのパブリックキーを含むファイルへの絶対パスです。3059 3013 0607 2a86 48ce 3d02 0106 082a 8648 ce3d 0301 0703 4200 04cd 6569 ceb8 1bb9 1e72 339f e8cf 60ef 0f9f b473 33ac 6f19 1813 6999 3fa0 c293 5fae 08f1 1ad0 41b7 345c e746 1046 228e 5a5f d787 d571 dcb2 4e8d 75b3 2586 e2cc 0cパブリックキーが .der 形式の場合は、パブリックキーを直接 16 進エンコードして 16 進ファイルを生成できます。
.der パブリックキーから 16 進ファイルを生成するには、次の xxd コマンドを入力します。
xxd -p pubkey.der > outFileパブリックキーが.pem 形式の場合、base64 でエンコードされたヘッダーとフッターを抽出し、それをバイナリ形式にデコードできます。その後、バイナリ文字列を 16 進エンコードして 16 進ファイルを生成します。
.pem パブリックキーの 16 進ファイルを生成するには、以下を行います。
-
次の base64 コマンドを実行して、パブリックキーから base64 ヘッダーとフッターを削除します。その後、
base64keyという名前のデコードされたキーが、ファイルpubkey.derに出力されます。base64 —decode base64key > pubkey.der -
次の xxd コマンドを実行して、
pubkey.derを 16 進形式に変換します。結果として生成されたキーは、として保存されます。outFilexxd -p pubkey.der >outFile
-
-
devices.secureElementConfig.PublicDeviceCertificateArn -
AWS IoT Core にアップロードされたセキュアエレメントからの証明書の ARN。証明書を AWS IoT Core にアップロードする方法については、「AWS IoT デベロッパーガイド」の「X.509 クライアント証明書」を参照してください。
-
devices.secureElementConfig.SecureElementSerialNumber -
(オプション) 安全なエレメントのシリアル番号。シリアル番号は、オプションで JITR キープロビジョニング用のデバイス証明書を作成するために使用されます。
-
devices.secureElementConfig.preProvisioned -
(オプション) デバイスにロックダウンされた認証情報を持つ事前プロビジョニングされたセキュア要素があり、オブジェクトをインポート、作成、または破棄できない場合は、「Yes」に設定します。この属性が Yes に設定されている場合は、対応する pkcs11 ラベルを指定する必要があります。
-
devices.secureElementConfig.pkcs11JITPCodeVerifyRootCertSupport -
(オプション) デバイスの corePKCS11 実装が JITP 用のストレージをサポートしている場合は Yes に設定します。これにより、コア PKCS 11 をテストするときに JITP
codeverifyテストが可能になり、コード検証キー、JITP 証明書、およびルート証明書 PKCS 11 ラベルを指定する必要があります。 -
identifiers -
(オプション) 任意の名前と値のペアの配列。これらの値は、次のセクションで説明されているビルドコマンドやフラッシュコマンドで使用できます。