Programmgesteuertes Erstellen einer einzelnen Device Provisioning Service-Registrierung für den TPM-Nachweis

• Installieren Sie .NET 6.0 SDK auf Ihrem Windows-basierten Computer. Sie können den folgenden Befehl ausführen, um Ihre Version zu überprüfen:

  dotnet --info
  

  Von Bedeutung

  Sie müssen das .NET 6.0 SDK verwenden, um den Beispielcode in diesem Artikel zu erstellen und auszuführen. Das Beispiel funktioniert derzeit nicht mit späteren Versionen des SDK.

• (Optional) Wenn Sie ein simuliertes Gerät am Ende dieses Artikels registrieren möchten, führen Sie das Verfahren in der Schnellstartanleitung aus: Bereitstellen eines simulierten TPM-Geräts bis zum Schritt, in dem Sie einen Bestätigungsschlüssel für das Gerät erhalten. Speichern Sie den Endorsement Key. Sie werden ihn später in diesem Artikel verwenden.

  Führen Sie die Schritte zum Erstellen einer individuellen Registrierung mit dem Azure-Portal nicht aus.

• Installieren Sie Node.js v4.0+.

• (Optional) Wenn Sie ein simuliertes Gerät am Ende dieses Artikels registrieren möchten, führen Sie das Verfahren in der Schnellstartanleitung aus: Bereitstellen eines simulierten TPM-Geräts bis zum Schritt, in dem Sie einen Bestätigungsschlüssel und eine Registrierungs-ID für das Gerät erhalten. Speichern Sie den Endorsement Key und die Registrierungs-ID. Sie werden beide später in diesem Artikel verwenden.

  Führen Sie die Schritte zum Erstellen einer individuellen Registrierung mit dem Azure-Portal nicht aus.

• Installieren Sie Java SE Development Kit 8. In diesem Artikel wird weiter unten erläutert, wie das Java-Dienst-SDK installiert wird. Es funktioniert sowohl unter Windows als auch unter Linux. In diesem Artikel wird Windows verwendet.

• Installieren Sie Maven 3.

• Installieren Sie Git, und stellen Sie sicher, dass der Pfad zur Umgebungsvariable PATH hinzugefügt wird.

• (Optional) Wenn Sie ein simuliertes Gerät am Ende dieses Artikels registrieren möchten, führen Sie das Verfahren in der Schnellstartanleitung aus: Bereitstellen eines simulierten TPM-Geräts bis zum Schritt, in dem Sie einen Bestätigungsschlüssel für das Gerät erhalten. Notieren Sie sich den Endorsement Key und die Registrierungs-ID. Sie werden beide später in diesem Artikel verwenden.

  Führen Sie die Schritte zum Erstellen einer individuellen Registrierung mit dem Azure-Portal nicht aus.

Dieser Abschnitt zeigt, wie Sie eine .NET Core-Konsolen-App erstellen, die Ihrem Bereitstellungsdienst eine individuelle Registrierung für ein TPM-Gerät hinzufügt.

1. Öffnen Sie eine Windows-Eingabeaufforderung, und navigieren Sie zu dem Ordner, in dem Sie Ihre App erstellen möchten.

2. Führen Sie den folgenden Befehl zum Erstellen eines Konsolenprojekts aus:

   dotnet new console --framework net6.0 --use-program-main 
   

3. Führen Sie den folgenden Befehl aus, um einen Verweis auf das DPS-Dienst-SDK hinzuzufügen:

   dotnet add package Microsoft.Azure.Devices.Provisioning.Service 
   

   In diesem Schritt wird das NuGet-Paket „Azure IoT-DPS-Dienstclient“ heruntergeladen und installiert sowie ein Verweis auf das Paket und dessen Abhängigkeiten hinzugefügt. Dieses Paket enthält die Binärdateien für das .NET-Dienst-SDK.

4. Öffnen Sie die Datei Program.cs in einem Editor.

5. Ersetzen Sie die Namespace-Anweisung oben in der Datei durch den folgenden Code:

   namespace CreateIndividualEnrollment;
   

6. Fügen Sie am Anfang der Datei über der namespace-Anweisung die folgenden using-Anweisungen hinzu:

   using System.Threading.Tasks;
   using Microsoft.Azure.Devices.Provisioning.Service;
   

7. Fügen Sie die folgenden Felder zur Program-Klasse hinzu, und nehmen Sie die aufgeführten Änderungen vor.

   private static string ProvisioningConnectionString = "{ProvisioningServiceConnectionString}";
   private const string RegistrationId = "sample-registrationid-csharp";
   private const string TpmEndorsementKey =
       "AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUS" +
       "cTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3d" +
       "yKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKR" +
       "dln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFe" +
       "WlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ==";
   
   // Optional parameters
   private const string OptionalDeviceId = "myCSharpDevice";
   private const ProvisioningStatus OptionalProvisioningStatus = ProvisioningStatus.Enabled;
   

   • Ersetzen Sie den Platzhalterwert ProvisioningServiceConnectionString durch die Verbindungszeichenfolge des Bereitstellungsdiensts, die Sie im vorherigen Abschnitt kopiert haben.

   • Wenn Sie diesen Artikel zusammen mit der Schnellstartanleitung: Bereitstellen eines simulierten TPM-Geräts verwenden, um ein simuliertes Gerät bereitzustellen, ersetzen Sie den Bestätigungsschlüssel durch den Wert, den Sie in dieser Schnellstartanleitung notiert haben. Die Geräte-ID und die Registrierungs-ID können Sie durch die in diesem Schnellstart vorgeschlagenen Werte ersetzen oder aber Ihre eigenen Werte oder die Standardwerte in diesem Beispiel verwenden.

8. Fügen Sie der Program-Klasse die folgende Methode hinzu. Dieser Code erstellt einen einzelnen Registrierungseintrag und ruft dann die Methode CreateOrUpdateIndividualEnrollmentAsync für den ProvisioningServiceClient auf, um die einzelne Registrierung dem Bereitstellungsdienst hinzuzufügen.

   public static async Task RunSample()
   {
       Console.WriteLine("Starting sample...");
   
       using (ProvisioningServiceClient provisioningServiceClient =
               ProvisioningServiceClient.CreateFromConnectionString(ProvisioningConnectionString))
       {
           #region Create a new individualEnrollment config
           Console.WriteLine("\nCreating a new individualEnrollment object...");
           Attestation attestation = new TpmAttestation(TpmEndorsementKey);
           IndividualEnrollment individualEnrollment =
                   new IndividualEnrollment(
                           RegistrationId,
                           attestation);
   
           // The following parameters are optional. Remove them if you don't need them.
           individualEnrollment.DeviceId = OptionalDeviceId;
           individualEnrollment.ProvisioningStatus = OptionalProvisioningStatus;
           #endregion
   
           #region Create the individualEnrollment
           Console.WriteLine("\nAdding the individualEnrollment to the provisioning service...");
           IndividualEnrollment individualEnrollmentResult =
               await provisioningServiceClient.CreateOrUpdateIndividualEnrollmentAsync(individualEnrollment).ConfigureAwait(false);
           Console.WriteLine("\nIndividualEnrollment created with success.");
           Console.WriteLine(individualEnrollmentResult);
           #endregion
   
       }
   }
   

9. Ersetzen Sie schließlich die Methode Main durch die folgenden Zeilen:

   static async Task Main(string[] args)
   {
       await RunSample();
       Console.WriteLine("\nHit <Enter> to exit ...");
       Console.ReadLine();
   }
   

10. Speichern Sie die Änderungen.

1. Führen Sie in einem Befehlsfenster in Ihrem Arbeitsordner Folgendes aus:

   npm install azure-iot-provisioning-service
   

   In diesem Schritt wird das Paket „Azure IoT-DPS-Dienstclient“ heruntergeladen und installiert sowie ein Verweis auf das Paket und dessen Abhängigkeiten hinzugefügt. Dieses Paket enthält die Binärdateien für das Node.js-Dienst-SDK.

2. Erstellen Sie mit einem Text-Editor in Ihrem Arbeitsordner die Datei create_individual_enrollment.js. Fügen Sie der Datei den folgenden Code hinzu:

   'use strict';
   
   var provisioningServiceClient = require('azure-iot-provisioning-service').ProvisioningServiceClient;
   
   var serviceClient = provisioningServiceClient.fromConnectionString(process.argv[2]);
   var endorsementKey = process.argv[3];
   
   var enrollment = {
     registrationId: 'first',
     attestation: {
       type: 'tpm',
       tpm: {
         endorsementKey: endorsementKey
       }
     }
   };
   
   serviceClient.createOrUpdateIndividualEnrollment(enrollment, function(err, enrollmentResponse) {
     if (err) {
       console.log('error creating the individual enrollment: ' + err);
     } else {
       console.log("enrollment record returned: " + JSON.stringify(enrollmentResponse, null, 2));
     }
   });
   

3. Speichern Sie die Datei .

1. Öffnen Sie eine Windows-Eingabeaufforderung.

2. Klonen Sie das Repository „Microsoft Azure IoT-SDKs für Java GitHub“:

   git clone https://github.com/Azure/azure-iot-sdk-java.git --recursive
   

3. Wechseln Sie zum Beispielordner:

   cd azure-iot-sdk-java\provisioning\provisioning-service-client-samples\service-enrollment-sample
   

4. Öffnen Sie die Datei \src\main\java\samples\com\microsoft\azure\sdk\iot\ServiceEnrollmentSample.java in einem Editor.

5. Ersetzen Sie [Provisioning Connection String] durch die Verbindungszeichenfolge, die Sie unter Abrufen der Verbindungszeichenfolge für Ihren Bereitstellungsdienst kopiert haben.

   private static final String PROVISIONING_CONNECTION_STRING = "[Provisioning Connection String]";
   

6. Fügen Sie die Details des TPM-Geräts hinzu. Ersetzen Sie die Werte [RegistrationId] und [TPM Endorsement Key] in den folgenden Anweisungen durch Ihren Endorsement Key und die Registrierungs-ID.

   private static final String REGISTRATION_ID = "[RegistrationId]";
   private static final String TPM_ENDORSEMENT_KEY = "[TPM Endorsement Key]";
   

   • Wenn Sie diesen Artikel zusammen mit der Schnellstartanleitung: Ein simuliertes TPM-Gerät bereitstellen verwenden, um ein simuliertes Gerät zu provisionieren, verwenden Sie die Werte der Registrierungs-ID und des Endorsementschlüssels, die Sie in dieser Schnellstartanleitung notiert haben.

   • Wenn Sie mithilfe dieses Artikels lediglich eine einzelne Beispielregistrierung erstellen und ihn nicht zum Registrieren eines Geräts nutzen möchten, können Sie den folgenden Wert für einen Endorsement Key verwenden:

     private static final String TPM_ENDORSEMENT_KEY = "AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnefZcBhgy1SSDQMQ==";
     

     Geben Sie Ihren eigenen Wert für die Registrierungs-ID ein.

7. Bei einzelnen Registrierungen können Sie wahlweise eine Geräte-ID festlegen, die der DPS dem Gerät zuweist, wenn er es für IoT Hub bereitstellt. Wenn Sie keine Geräte-ID zuweisen, verwendet der DPS die Registrierungs-ID als Geräte-ID. Standardmäßig weist dieses Beispiel "myJavaDevice" als Geräte-ID zu. Wenn Sie die Geräte-ID ändern möchten, ändern Sie die folgende Anweisung:

       private static final String DEVICE_ID = "myJavaDevice";
   

   Wenn Sie keine bestimmte Geräte-ID zuweisen möchten, kommentieren Sie die folgende Anweisung aus:

   individualEnrollment.setDeviceId(DEVICE_ID);
   

8. Im Beispiel können Sie einen IoT-Hub in der einzelnen Registrierung festlegen, um dafür das Gerät bereitzustellen. Dieser IoT-Hub muss einer sein, der zuvor mit dem Bereitstellungsdienst verknüpft war. Für diesen Artikel kann DPS aus den verknüpften Hubs entsprechend der Standardzuordnungsrichtlinie in gleichmäßig gewichteter Verteilung auswählen. Kommentieren Sie in der Datei die folgende Anweisung aus:

   individualEnrollment.setIotHubHostName(IOTHUB_HOST_NAME);
   

9. Im Beispiel wird eine einzelne Registrierung eines TPM-Geräts erstellt, aktualisiert, abgefragt und gelöscht. Wenn Sie überprüfen möchten, ob die Registrierung im Portal erfolgreich war, kommentieren Sie die folgenden Codezeilen am Ende der Datei vorübergehend aus:

   // *********************************** Delete info of individualEnrollment ************************************
   System.out.println("\nDelete the individualEnrollment...");
   provisioningServiceClient.deleteIndividualEnrollment(REGISTRATION_ID);
   

10. Speichern Sie die Änderungen.

1. Führen Sie das Beispiel aus:

   dotnet run
   

2. Bei erfolgreicher Erstellung werden im Befehlsfenster die Eigenschaften der neuen Registrierung angezeigt.

Zum Ausführen des Beispiels benötigen Sie die Verbindungszeichenfolge für Ihren Bereitstellungsdienst, die Sie im vorhergehenden Abschnitt kopiert haben, sowie den Endorsement Key für das Gerät. Wenn Sie dem Artikel Quickstart: Provision a simulated TPM device folgen, um ein simuliertes TPM-Gerät bereitzustellen, verwenden Sie den für dieses Gerät erstellten Bestätigungsschlüssel. Andernfalls können Sie zum Erstellen eines Beispiels für die individuelle Registrierung den folgenden Endorsement Key nutzen, der über das Node.js-Dienst-SDK bereitgestellt wird:

AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ==

1. Führen Sie den folgenden Befehl aus (einschließlich der Anführungszeichen der Befehlsargumente), um eine individuelle Registrierung für Ihr TPM-Gerät zu erstellen:

   node create_individual_enrollment.js "<the connection string for your provisioning service>" "<endorsement key>"
   

2. Bei erfolgreicher Erstellung werden im Befehlsfenster die Eigenschaften der neuen Registrierung angezeigt.

1. Führen Sie in Ihrer Eingabeaufforderung aus dem Ordner azure-iot-sdk-java\provisioning\provisioning-service-client-samples\service-enrollment-sample den folgenden Befehl zum Erstellen des Beispiels aus:

   mvn install -DskipTests
   

   Dieser Befehl lädt das Maven-Paket „Azure IoT DPS-Dienstclient“ auf Ihren Computer herunter und erstellt das Beispiel. Dieses Paket enthält die Binärdateien für das Java-Dienst-SDK.

2. Wechseln Sie zum Zielordner, und führen Sie das Beispiel aus. Beachten Sie, dass der Build im vorhergehenden Schritt die JAR-Datei im Zielordner mit dem folgenden Dateiformat ausgibt: service-enrollment-sample-{version}-with-deps.jar; Beispiel: service-enrollment-sample-1.8.1-with-deps.jar. Möglicherweise müssen Sie im folgenden Befehl die Version ersetzen.

   cd target
   java -jar ./service-enrollment-sample-1.8.1-with-deps.jar
   

3. Bei erfolgreicher Erstellung werden im Befehlsfenster die Eigenschaften der neuen Registrierung angezeigt.

Wenn Sie die Schritte im Artikel Schnellstart: Ein simuliertes TPM-Gerät bereitstellen befolgt haben, um ein simuliertes Gerät bereitzustellen, setzen Sie die Schnellstartanleitung bei Registrieren des Geräts fort.

Wenn Sie dem Artikel Schnellstart: Ein simuliertes TPM-Gerät bereitstellen gefolgt sind, um ein simuliertes Gerät einzurichten, setzen Sie den Schnellstart bei Registrieren des Geräts fort.

Wenn Sie den Schritten im Artikel Quickstart: Ein simuliertes TPM-Gerät bereitstellen gefolgt sind, um ein simuliertes Gerät bereitzustellen, setzen Sie die Schnellstartanleitung bei Registrieren des Geräts fort.

6. Wenn Sie die Schritte in der Schnellstartanleitung ausgeführt haben: Bereitstellen eines simulierten TPM-Geräts zum Erstellen eines simulierten TPM-Geräts, führen Sie die folgenden Schritte aus:

   1. Navigieren Sie im Azure-Portal zum IoT-Hub, in dem Ihr Gerät bereitgestellt wurde.

   2. Wählen Sie im Menü "Dienst" unter "Geräteverwaltung" die Option "Geräte" aus.

   3. Aktivieren Sie das Kontrollkästchen neben der Geräte-ID des Geräts, das Sie in diesem Artikel registriert haben.

   4. Wählen Sie am oberen Rand des Bereichs die Option Löschen aus.

8. Wenn Sie die Schritte in der Schnellstartanleitung ausgeführt haben: Bereitstellen eines simulierten TPM-Geräts zum Erstellen eines simulierten TPM-Geräts, führen Sie die folgenden Schritte aus:

   1. Schließen Sie das TPM-Simulatorfenster und das Beispielausgabefenster für das simulierte Gerät.

   2. Navigieren Sie im Azure-Portal zum IoT-Hub, in dem Ihr Gerät bereitgestellt wurde.

   3. Wählen Sie im Menü "Dienst" unter "Geräteverwaltung" die Option "Geräte" aus.

   4. Aktivieren Sie das Kontrollkästchen neben der Geräte-ID des Geräts, das Sie in diesem Artikel registriert haben.

   5. Wählen Sie am oberen Rand des Bereichs die Option Löschen aus.

8. Wenn Sie die Schritte in der Schnellstartanleitung ausgeführt haben: Bereitstellen eines simulierten TPM-Geräts zum Erstellen eines simulierten TPM-Geräts, führen Sie die folgenden Schritte aus:

   1. Schließen Sie das TPM-Simulatorfenster und das Beispielausgabefenster für das simulierte Gerät.

   2. Navigieren Sie im Azure-Portal zum IoT-Hub, in dem Ihr Gerät bereitgestellt wurde.

   3. Wählen Sie im Menü "Dienst" unter "Geräteverwaltung" die Option "Geräte" aus.

   4. Aktivieren Sie das Kontrollkästchen neben der Geräte-ID des Geräts, das Sie in diesem Artikel registriert haben.

   5. Wählen Sie am oberen Rand des Bereichs die Option Löschen aus.