Quickstart: Een gesimuleerd TPM-apparaat inrichten

• Visual Studio 2019 met de workload Desktopontwikkeling met C++ ingeschakeld. Visual Studio 2015 en Visual Studio 2017 worden ook ondersteund.

• Installeer .NET Core 2.1 SDK of hoger op uw Windows machine. U kunt de volgende opdracht gebruiken om uw versie te controleren.

  dotnet --info
  

• Installeer Node.js v4.0+.

• Installeer Python 2.x of 3.x. Zorg ervoor dat u de 32-bits of 64-bits installatie gebruikt, zoals vereist door uw configuratie. Zorg ervoor dat u Python toevoegt aan uw platformspecifieke omgevingsvariabelen als u hierom wordt gevraagd tijdens de installatie.

• Als u een systeemeigen Windows gebruikt, installeert u het herdistribueerbare pakket van Visual C++ om het gebruik van systeemeigen DLL's van Python toe te staan.

• Visual Studio 2019 met de workload Desktopontwikkeling met C++ ingeschakeld. Visual Studio 2015 en Visual Studio 2017 worden ook ondersteund.

• CMake-bouwsysteem.

• Installeer Java SE Development Kit 8 of hoger op uw computer is geïnstalleerd.

• Download en installeer Maven.

In deze sectie bereidt u een ontwikkelomgeving voor die wordt gebruikt om de Azure IoT C SDK en het voorbeeld van de TPM-apparaatsimulator te bouwen.

1. Download het nieuwste CMake-buildsysteem.

   Belangrijk

   Controleer of de Visual Studio (Visual Studio en de workload Desktopontwikkeling met C++) op uw computer zijn geïnstalleerd voordat u de installatie CMake start. Zodra aan de vereisten is voldaan en de download is geverifieerd, installeert u het CMake-bouwsysteem. Let er ook op dat oudere versies van het CMake-buildsysteem het oplossingsbestand dat in dit artikel wordt gebruikt, niet kunnen genereren. Zorg ervoor dat u de nieuwste versie van CMake gebruikt.

2. Open een webbrowser en ga naar de pagina Release van de Azure IoT C SDK.

3. Selecteer het tabblad Tags bovenaan de pagina.

4. Kopieer de tagnaam voor de nieuwste versie van de Azure IoT C SDK.

5. Open een opdrachtprompt of Git Bash-shell. Voer de volgende opdrachten uit om de nieuwste release van de GitHub-opslagplaats van de Azure IoT C-SDK te klonen. (vervang <release-tag> door de tag die u in de vorige stap hebt gekopieerd).

   git clone -b <release-tag> https://github.com/Azure/azure-iot-sdk-c.git
   cd azure-iot-sdk-c
   git submodule update --init
   

   Deze bewerking kan enkele minuten duren.

6. Wanneer de bewerking is voltooid, voert u de volgende opdrachten uit vanuit de azure-iot-sdk-c map :

   mkdir cmake
   cd cmake
   

1. Open een Git CMD- of Git Bash-opdrachtregelomgeving.

2. Kloon de GitHub-opslagplaats Azure IoT-voorbeelden voor C# met behulp van de volgende opdracht:

   git clone https://github.com/Azure-Samples/azure-iot-samples-csharp.git
   

1. Open een Git CMD- of Git Bash-opdrachtregelomgeving.

2. Kloon de opslagplaats azure-utpm-c GitHub behulp van de volgende opdracht:

   git clone https://github.com/Azure/azure-utpm-c.git --recursive
   

1. Open een Git CMD- of Git Bash-opdrachtregelomgeving.

2. Kloon de Python GitHub opslagplaats met behulp van de volgende opdracht:

   git clone --single-branch --branch v1-deprecated https://github.com/Azure/azure-iot-sdk-python.git --recursive
   

3. Maak een map in uw lokale kopie van deze GitHub voor het CMake-bouwproces.

   cd azure-iot-sdk-python/c
   mkdir cmake
   cd cmake
   

4. Volg deze instructies voor het bouwen van de Python-pakketten.

   Notitie

   Als u build_client.cmd uitvoert, moet u ervoor zorgen dat u de vlag --use-tpm-simulator gebruikt.

   Notitie

   Als u pip gebruikt, zorg dan ook dat u het pakket azure-iot-provisioning-device-client installeert. Houd er rekening mee dat de uitgebrachte PIP-pakketten van de echte TPM gebruikmaken, niet van de simulator. Als u de simulator wilt gebruiken, moet u vanuit de bron compileren met behulp van de vlag --use-tpm-simulator.

1. Open een Git CMD- of Git Bash-opdrachtregelomgeving.

2. Kloon de Java GitHub-opslagplaats met de volgende opdracht:

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

1. Voer de volgende opdracht uit om de Azure IoT C SDK te bouwen die de voorbeeldcode van de TPM-apparaatsimulator bevat. Er wordt een Visual Studio-oplossing voor het gesimuleerde apparaat gegenereerd in de map cmake. Dit voorbeeld biedt een TPM attestation-mechanisme via SAS-tokenverificatie (Shared Access Signature).

   cmake -Duse_prov_client:BOOL=ON ..
   

   Tip

   Als cmake uw C++-compiler niet vindt, kunnen er buildfouten optreden tijdens het uitvoeren van de bovenstaande opdracht. Als dit gebeurt, voert u de opdracht uit in de Visual Studio-opdrachtprompt.

2. Wanneer de build is geslaagd, zien de laatste paar uitvoerregels er ongeveer als volgt uit:

   $ cmake -Duse_prov_client:BOOL=ON ..
   -- Building for: Visual Studio 16 2019
   -- The C compiler identification is MSVC 19.23.28107.0
   -- The CXX compiler identification is MSVC 19.23.28107.0
   
   ...
   
   -- Configuring done
   -- Generating done
   -- Build files have been written to: C:/code/azure-iot-sdk-c/cmake
   

3. Ga naar de hoofdmap van de git-opslagplaats die u hebt gekloond.

4. Voer de TPM-simulator uit met behulp van het onderstaande pad.

   cd ..
   .\provisioning_client\deps\utpm\tools\tpm_simulator\Simulator.exe
   

   In de simulator wordt geen uitvoer weergegeven. Laat deze uitvoeren terwijl het een TPM-apparaat simuleert.

1. Selecteer Overzicht in het hoofdmenu van device provisioning service.

2. Kopieer de waarde id-bereik.

   

3. Ga op een opdrachtprompt naar de projectmap met de voorbeeldcode voor het inrichten van het de TPM-apparaat.

   cd .\azure-iot-samples-csharp\provisioning\Samples\device\TpmSample
   

4. Typ de volgende opdracht om het voorbeeld voor het inrichten van TPM-apparaten te bouwen en uit te voeren (vervang <IDScope> door het id-bereik voor uw inrichtingsservice).

   dotnet run <IDScope>
   

   Notitie

   Met deze opdracht wordt de TPM-chip-simulator in een aparte opdrachtprompt gestart. Op Windows ziet u mogelijk een Windows-beveiliging waarschuwing die u vraagt of u wilt toestaan om te Simulator.exe communiceren op openbare netwerken. Voor de doeleinden van dit voorbeeld kunt u de aanvraag negeren.

5. In het oorspronkelijke opdrachtvenster ziet u waarden voor Goedkeuringssleutel, Registratie-id en een voorgestelde Apparaat-id. Deze waarden hebt u nodig voor registratie van het apparaat. Noteer deze waarden. U gebruikt deze waarde om een afzonderlijke inschrijving te maken in uw Device Provisioning Service-exemplaar.

   Notitie

   Verwar het venster met opdrachtuitvoer niet met het venster dat uitvoer van de TPM-simulator bevat. U moet mogelijk het opdrachtvenster selecteren om dit naar de voorgrond te halen.

1. Ga naar de GitHub hoofdmap.

2. Voer de TPM-simulator uit als de HSM voor het gesimuleerde apparaat.

   .\azure-utpm-c\tools\tpm_simulator\Simulator.exe
   

3. Maak een nieuwe, lege map met de naam registerdevice. Maak in de map registerdevice een package.json-bestand met behulp van de volgende opdracht bij de opdrachtprompt (zorg ervoor dat u alle vragen beantwoordt die zijn gesteld door of accepteer de standaardwaarden als deze bij u npm passen):

   npm init
   

4. Installeer de volgende precursorpakketten:

   npm install node-gyp -g
   npm install ffi -g
   

   Notitie

   Het installeren van de bovengenoemde pakketten kan problemen met zich meebrengen. U kunt deze oplossen door npm install --global --production windows-build-tools uit te voeren via een opdrachtprompt in de modus Uitvoeren als administrator. Vervolgens voert u SET VCTargetsPath=C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140 uit nadat u het pad hebt vervangen door dat van de geïnstalleerde versie. Voer ten slotte de bovenstaande installatieopdrachten opnieuw uit.

5. Installeer alle vereiste pakketten met de volgende opdracht in de opdrachtprompt in de map registerdevice:

   npm install --save azure-iot-device azure-iot-device-mqtt azure-iot-security-tpm azure-iot-provisioning-device-http azure-iot-provisioning-device
   

   Met de opdracht worden de volgende pakketten geïnstalleerd:

   • een beveiligingsclient die werkt met TPM: azure-iot-security-tpm

   • een transport voor het apparaat om verbinding te maken met de Device Provisioning Service: azure-iot-provisioning-device-http of azure-iot-provisioning-device-amqp

   • een client om het transport en de beveiligingsclient te kunnen gebruiken: azure-iot-provisioning-device

   • de apparaatclient: azure-iot-device

   • een transportmiddel: hetzij azure-iot-device-amqp, azure-iot-device-mqtt of azure-iot-device-http

   • de beveiligingsclient die u al hebt geïnstalleerd: azure-iot-security-tpm

     Notitie

     In de voorbeelden in deze quickstart worden de azure-iot-provisioning-device-http azure-iot-device-mqtt transporten en gebruikt.

6. Open een teksteditor van uw keuze.

7. Maak in de map registerdevice een nieuw ExtractDevice.jsbestand.

8. Voeg de volgende require-instructies toe aan het begin van het bestand ExtractDevice.js:

   
   'use strict';
   
   var tpmSecurity = require('azure-iot-security-tpm');
   var tssJs = require("tss.js");
   
   var myTpm = new tpmSecurity.TpmSecurityClient(undefined, new tssJs.Tpm(true));
   

9. Voeg de volgende functie toe om de methode te implementeren:

   
   myTpm.getEndorsementKey(function(err, endorsementKey) {
     if (err) {
       console.log('The error returned from get key is: ' + err);
     } else {
       console.log('the endorsement key is: ' + endorsementKey.toString('base64'));
       myTpm.getRegistrationId((getRegistrationIdError, registrationId) => {
         if (getRegistrationIdError) {
           console.log('The error returned from get registration id is: ' + getRegistrationIdError);
         } else {
           console.log('The Registration Id is: ' + registrationId);
           process.exit();
         }
       });
     }
   });
   

10. Sla het bestand ExtractDevice.js op en sluit het.

    node ExtractDevice.js
    

11. Voet het voorbeeld uit.

12. In het uitvoervenster worden de voor apparaatinschrijving vereiste goedkeuringssleutel en registratie-id weergegeven. Kopieer deze waarden.

1. Voer de volgende opdracht uit om de verificatie van het SAS-token in te schakelen (de opdracht genereert ook een Visual Studio oplossing voor het gesimuleerde apparaat):

   cmake -Duse_prov_client:BOOL=ON -Duse_tpm_simulator:BOOL=ON ..
   

2. Open een tweede opdrachtprompt.

3. Navigeer in de tweede opdrachtprompt naar de map van de TPM-simulator.

4. Voer de TPM-simulator uit als de HSM voor het gesimuleerde apparaat.

5. Selecteer Toegang toestaan. De simulator luistert via een socket op poorten 2321 en 2322. Sluit dit opdrachtvenster niet; de simulator moet actief blijven tot u deze quickstart hebt voltooid.

.\azure-iot-sdk-python\c\provisioning_client\deps\utpm\tools\tpm_simulator\Simulator.exe

1. Voer de TPM-simulator uit als de HSM voor het gesimuleerde apparaat.

2. Selecteer Toegang toestaan. De simulator luistert via een socket op poorten 2321 en 2322. Sluit dit opdrachtvenster niet; de simulator moet actief blijven tot u deze quickstart hebt voltooid.

   .\azure-iot-sdk-java\provisioning\provisioning-tools\tpm-simulator\Simulator.exe
   

   

3. Open een tweede opdrachtprompt.

4. Navigeer in de tweede opdrachtprompt naar de hoofdmap en bouw de voorbeeldafhankelijkheden.

   cd azure-iot-sdk-java
   mvn install -DskipTests=true
   

5. Navigeer naar de voorbeeldmap.

   cd provisioning/provisioning-samples/provisioning-tpm-sample
   

Cryptografische sleutels van het TPM-apparaat lezen

In deze sectie bouwt en voert u een voorbeeld uit dat de goedkeuringssleutel en registratie-id leest uit de TPM-simulator die u actief hebt gelaten en nog steeds luistert via de poorten 2321 en 2322. Deze waarden worden gebruikt voor de inschrijving van apparaten met uw Device Provisioning Service-exemplaar.

1. Start Visual Studio.

2. Open de oplossing die is gegenereerd in de map cmake met de naam azure_iot_sdks.sln .

3. Selecteer in het menu van Visual Studio, Build > Build Solution om alle projecten in de oplossing te bouwen.

4. Navigeer in het deelvenster Solution Explorer van Visual Studio naar de map Provision_Tools. Klik met de rechtermuisknop op het tpm_device_provision-project en selecteer Set as Startup Project.

5. Selecteer in het menu van Visual Studio de optie Debug > Start without debugging om de oplossing uit te voeren. De app leest een Registratie-id en een Goedkeuringssleutel en geeft deze weer. Kopieer deze waarden of noteer ze. Deze worden gebruikt in de volgende sectie voor apparaatinschrijving.

1. Start Visual Studio.

2. Open de oplossing die is gegenereerd in de map cmake met de naam azure_iot_sdks.sln .

3. Selecteer in het menu van Visual Studio, Build > Build Solution om alle projecten in de oplossing te bouwen.

4. Klik met de rechtermuisknop op het tpm_device_provision-project en selecteer Set as Startup Project.

5. Voer de oplossing uit. In het uitvoervenster worden de voor apparaatinschrijving vereiste goedkeuringssleutel en registratie-id weergegeven. Kopieer deze waarden.

1. Meld u aan bij Azure Portal, selecteer de knop Alle resources in het menu aan de linkerkant en open Device Provisioning Service. Noteer de waarden voor Id-bereik en Globaal eindpunt voor inrichtingsservice.

   

2. Bewerk src/main/java/samples/com/microsoft/azure/sdk/iot/ProvisioningTpmSample.java om de eerder genoteerde waarden voor Id-bereik en Globaal eindpunt voor inrichtingsservice toe te voegen.

   private static final String idScope = "[Your ID scope here]";
   private static final String globalEndpoint = "[Your Provisioning Service Global Endpoint here]";
   private static final ProvisioningDeviceClientTransportProtocol PROVISIONING_DEVICE_CLIENT_TRANSPORT_PROTOCOL = ProvisioningDeviceClientTransportProtocol.HTTPS;
   

3. Sla het bestand op.

4. Gebruik de volgende opdrachten om het project te bouwen, naar de doelmap te navigeren en het gemaakte JAR-bestand uit te voeren (vervang {version} door uw versie van Java):

   mvn clean install
   cd target
   java -jar ./provisioning-tpm-sample-{version}-with-deps.jar
   

5. Wanneer het programma wordt uitgevoerd, worden de goedkeuringssleutel en registratie-id weergegeven. Kopieer deze waarden voor de volgende sectie. Zorg ervoor dat u het programma actief laat.

1. Selecteer in Azure Portal het tabblad Overzicht voor device provisioning service.

2. Kopieer de waarde id-bereik.

   

3. Navigeer in het deelvenster Solution Explorer van Visual Studio naar de map Provision_Samples. Vouw het voorbeeldproject met de naam prov_dev_client_sample uit. Vouw Source Files uit en open prov_dev_client_sample.c.

4. Zoek boven aan het bestand de instructies #define op voor elk apparaatprotocol, zoals hieronder wordt weergegeven. Zorg ervoor dat alleen SAMPLE_AMQP geen commentaar bevat.

   Op dit moment wordt het MQTT-protocol niet ondersteund voor een afzonderlijke TPM-inschrijving.

   //
   // The protocol you wish to use should be uncommented
   //
   //#define SAMPLE_MQTT
   //#define SAMPLE_MQTT_OVER_WEBSOCKETS
   #define SAMPLE_AMQP
   //#define SAMPLE_AMQP_OVER_WEBSOCKETS
   //#define SAMPLE_HTTP
   

5. Zoek de constante id_scope op en vervang de waarde door uw Id-bereik-waarde die u eerder hebt gekopieerd.

   static const char* id_scope = "0ne00002193";
   

6. Zoek de definitie voor de functie main() op in hetzelfde bestand. Zorg ervoor dat de variabele hsm_type is ingesteld op SECURE_DEVICE_TYPE_X509 in plaats van SECURE_DEVICE_TYPE_TPM, zoals hieronder wordt weergegeven.

   SECURE_DEVICE_TYPE hsm_type;
   //hsm_type = SECURE_DEVICE_TYPE_TPM;
   hsm_type = SECURE_DEVICE_TYPE_X509;
   

7. Klik met de rechtermuisknop op het prov_dev_client_sample-project en selecteer Set as Startup Project.

8. Selecteer in het menu van Visual Studio de optie Debug > Start without debugging om de oplossing uit te voeren. Klik in de prompt om het project opnieuw te bouwen op Yes om het project opnieuw te bouwen voordat het wordt uitgevoerd.

   De volgende uitvoer is een voorbeeld van de voorbeeldcode van de Provisioning Device-client die met succes opstart en verbinding maakt met het Device Provisioning Service-exemplaar om IoT hub-informatie op te halen en zich te registreren:

   Provisioning API Version: 1.2.7
   
   Registering... Press enter key to interrupt.
   
   Provisioning Status: PROV_DEVICE_REG_STATUS_CONNECTED
   Provisioning Status: PROV_DEVICE_REG_STATUS_ASSIGNING
   Provisioning Status: PROV_DEVICE_REG_STATUS_ASSIGNING
   
   Registration Information received from service:
   test-docs-hub.azure-devices.net, deviceId: test-docs-cert-device
   

1. Selecteer in Azure Portal het tabblad Overzicht voor device provisioning service.

2. Kopieer de waarde id-bereik.

   

3. Open een teksteditor naar keuze.

4. Maak in de map registerdevice een nieuw RegisterDevice.jsbestand.

5. Voeg de volgende require -instructies toe aan het begin van RegisterDevice.js bestand:

   
   'use strict';
   
   var ProvisioningTransport = require('azure-iot-provisioning-device-http').Http;
   var iotHubTransport = require('azure-iot-device-mqtt').Mqtt;
   var Client = require('azure-iot-device').Client;
   var Message = require('azure-iot-device').Message;
   var tpmSecurity = require('azure-iot-security-tpm');
   var ProvisioningDeviceClient = require('azure-iot-provisioning-device').ProvisioningDeviceClient;
   

   Notitie

   Azure IoT SDK for Node.js ondersteunt aanvullende protocollen, zoals AMQP, AMQP WS en MQTT WS. Zie Device Provisioning Service SDK for Node.js samples (Device Provisioning Service-SDK voor Node.js-voorbeelden) voor meer voorbeelden.

6. Voeg de variabelen globalDeviceEndpoint en idScope toe en gebruik ze om een ProvisioningDeviceClient-exemplaar te maken. Vervang {globalDeviceEndpoint} en {idScope} door de waarden Global Device Endpoint en ID Scope uit Stap 1:

   
   var provisioningHost = '{globalDeviceEndpoint}';
   var idScope = '{idScope}';
   
   var tssJs = require("tss.js");
   var securityClient = new tpmSecurity.TpmSecurityClient('', new tssJs.Tpm(true));
   // if using non-simulated device, replace the above line with following:
   //var securityClient = new tpmSecurity.TpmSecurityClient();
   
   var provisioningClient = ProvisioningDeviceClient.create(provisioningHost, idScope, new ProvisioningTransport(), securityClient);
   

7. Voeg de volgende functie toe om de methode in het apparaat te implementeren:

   
   provisioningClient.register(function(err, result) {
     if (err) {
       console.log("error registering device: " + err);
     } else {
       console.log('registration succeeded');
       console.log('assigned hub=' + result.registrationState.assignedHub);
       console.log('deviceId=' + result.registrationState.deviceId);
       var tpmAuthenticationProvider = tpmSecurity.TpmAuthenticationProvider.fromTpmSecurityClient(result.registrationState.deviceId, result.registrationState.assignedHub, securityClient);
       var hubClient = Client.fromAuthenticationProvider(tpmAuthenticationProvider, iotHubTransport);
   
       var connectCallback = function (err) {
         if (err) {
           console.error('Could not connect: ' + err.message);
         } else {
           console.log('Client connected');
           var message = new Message('Hello world');
           hubClient.sendEvent(message, printResultFor('send'));
         }
       };
   
       hubClient.open(connectCallback);
   
       function printResultFor(op) {
         return function printResult(err, res) {
           if (err) console.log(op + ' error: ' + err.toString());
           if (res) console.log(op + ' status: ' + res.constructor.name);
           process.exit(1);
         };
       }
     }
   });
   

8. Sla het bestand RegisterDevice.js op en sluit het.

9. Voer de volgende opdracht uit:

   node RegisterDevice.js
   

10. De gegevens van uw IoT-hub leest u in de berichten die het opstarten van het apparaat en het verbinding maken met Device Provisioning Service simuleren.

1. Navigeer naar de map met voorbeelden van de Git-opslagplaats.

   cd azure-iot-sdk-python/provisioning_device_client/samples
   

2. Bewerk met behulp van uw Python IDE het Python-script met de naam provisioning _ device client _ _ sample.py (vervang ) en in de waarden {globalServiceEndpoint} die u eerder hebt {idScope} gekopieerd). Zorg er ook voor dat TYPE _ _ BEVEILIGINGSAPPARAAT is ingesteld op ProvisioningSecurityDeviceType.TPM .

   GLOBAL_PROV_URI = "{globalServiceEndpoint}"
   ID_SCOPE = "{idScope}"
   SECURITY_DEVICE_TYPE = ProvisioningSecurityDeviceType.TPM
   PROTOCOL = ProvisioningTransportProvider.HTTP
   

   

3. Voet het voorbeeld uit.

   python provisioning_device_client_sample.py
   

4. De gegevens van uw IoT-hub leest u in de berichten die het opstarten van het apparaat en het verbinding maken met Device Provisioning Service simuleren.

1. Druk in het opdrachtvenster waarin de Java-voorbeeldcode op uw computer wordt uitgevoerd op Enter om door te gaan met het uitvoeren van de toepassing. De gegevens van uw IoT-hub leest u in de berichten die het opstarten van het apparaat en het verbinding maken met Device Provisioning Service simuleren.