Inicio rápido: Aprovisionamiento de un dispositivo de TPM simulado

• Visual Studio 2019 con la carga de trabajo "Desarrollo para el escritorio con C++" habilitada. También se admiten Visual Studio 2015 y Visual Studio 2017.

• Instale el SDK de .NET Core 2.1, o cualquier versión posterior, en una máquina con Windows. Para comprobar la versión, use el siguiente comando.

  dotnet --info
  

• Instale Node.js v4.0+.

• Instale Python 2.x o 3.x. Asegúrese de usar la instalación de 32 bits o 64 bits en función del programa de instalación. Cuando se le solicite durante la instalación, asegúrese de agregar Python a las variables de entorno específicas de la plataforma.

• Si usa el sistema operativo Windows, instale el paquete redistribuible de Visual C++ para permitir el uso de archivos DLL nativos de Python.

• Visual Studio 2019 con la carga de trabajo "Desarrollo para el escritorio con C++" habilitada. También se admiten Visual Studio 2015 y Visual Studio 2017.

• Sistema de compilación de CMake.

• Instale Java SE Development Kit 8 o cualquier versión posterior, en la máquina.

• Descargue e instale Maven.

En esta sección, preparará un entorno de desarrollo para compilar el SDK de Azure IoT para C y el simulador de dispositivos de TPM de ejemplo.

1. Descargue el último sistema de compilación CMake.

   Importante

   Confirme que los requisitos previos de Visual Studio (Visual Studio y la carga de trabajo "Desarrollo para el escritorio con C++") estén instalados en la máquina antes de empezar la instalación de CMake. Una vez que los requisitos previos están en su lugar, y se ha comprobado la descarga, instale el sistema de compilación de CMake. Igualmente, tenga en cuenta que las versiones anteriores del sistema de compilación CMake no generan el archivo de solución que se usa en este artículo. Asegúrese de usar la versión más reciente de CMake.

2. Abra un explorador web y vaya a la página de la versión del SDK de Azure IoT para C.

3. Seleccione la pestaña Etiquetas en la parte superior de la página.

4. Copie el nombre de etiqueta de la versión más reciente del SDK de Azure IoT para C.

5. Abra un símbolo del sistema o el shell de Bash de Git. Ejecute los siguientes comandos para clonar la versión más reciente del repositorio de GitHub del SDK de Azure IoT para C. (Reemplace <release-tag> con el nombre de la etiqueta que copió en el paso anterior).

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

   Esta operación puede tardar varios minutos en completarse.

6. Una vez completada la operación, ejecute los siguientes comandos desde el directorio azure-iot-sdk-c:

   mkdir cmake
   cd cmake
   

1. Abra un entorno de línea de comandos de Git CMD o Git Bash.

2. Utilice el siguiente comando para clonar el repositorio de GitHub de los ejemplos de Azure IoT para C#:

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

1. Abra un entorno de línea de comandos de Git CMD o Git Bash.

2. Clone el repositorio de GitHub azure-utpm-c con el siguiente comando:

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

1. Abra un entorno de línea de comandos de Git CMD o Git Bash.

2. Clone el repositorio de GitHub Python con el siguiente comando:

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

3. Cree una carpeta en su copia local de este repositorio GitHub para el proceso de compilación de CMake.

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

4. Siga estas instrucciones para compilar los paquetes de Python.

   Nota

   Si ejecuta build_client.cmd, asegúrese de usar la marca --use-tpm-simulator.

   Nota

   Si usa pip, asegúrese de instalar también el paquete azure-iot-provisioning-device-client. Tenga en cuenta que los paquetes de PIP publicados utilizan el TPM real y no el simulador. Para usar el simulador, debe compilar desde el código fuente mediante la marca --use-tpm-simulator.

1. Abra un entorno de línea de comandos de Git CMD o Git Bash.

2. Clone el repositorio de GitHub Java con el siguiente comando:

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

1. Ejecute el siguiente comando para compilar el SDK de Azure IoT para C que incluye el código de ejemplo del simulador de dispositivos TPM. Se genera una solución de Visual Studio para el dispositivo simulado en el directorio cmake. Este ejemplo proporciona un mecanismo de atestación de TPM mediante la autenticación del token de firma de acceso compartido (SAS).

   cmake -Duse_prov_client:BOOL=ON ..
   

   Sugerencia

   Si cmake no encuentra el compilador de C++, es posible que obtenga errores de compilación durante la ejecución del comando anterior. Si eso sucede, pruebe a ejecutar este comando en el símbolo del sistema de Visual Studio.

2. Una vez realizada la compilación, las últimas líneas de salida son similares a las siguientes:

   $ 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. Vaya a la carpeta raíz del repositorio Git clonado.

4. Ejecute el simulador de TPM mediante la ruta de acceso que se muestra a continuación.

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

   El simulador no muestra ningún resultado. Deje que continúe ejecutándose mientras simula un dispositivo TPM.

1. En el menú principal de la instancia de Device Provisioning Service, seleccione Información general.

2. Copie el valor de del Ámbito de id.

   

3. En un símbolo del sistema, cambie los directorios al directorio del proyecto del ejemplo de aprovisionamiento de dispositivo de TPM.

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

4. Escriba el siguiente comando para compilar y ejecutar el ejemplo de aprovisionamiento de dispositivos TPM (reemplace <IDScope> con el ámbito de id. del servicio de aprovisionamiento).

   dotnet run <IDScope>
   

   Nota

   Este comando iniciará el simulador de chip de TPM en un símbolo del sistema independiente. En Windows, es posible que encuentre una alerta de seguridad de Windows que le pregunte si quiere permitir que Simulator.exe se comunique en redes públicas. Para los fines de este ejemplo, puede cancelar la solicitud.

5. La ventana de comandos original muestra la clave de aprobación, el identificador de registro y un identificador de dispositivo sugerido, ya que son necesarios para la inscripción del dispositivo. Anote estos valores. Usará estos valores para crear una inscripción individual en la instancia de Device Provisioning Service.

   Nota

   No confunda la ventana que contiene la salida del comando con la ventana que contiene la salida desde el simulador de TPM. Es posible que tenga que seleccionar la ventana de comandos original para pasarla al primer plano.

1. Vaya a la carpeta raíz de GitHub.

2. Ejecute el simulador de TPM para que sea el HSM para el dispositivo simulado.

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

3. Cree una nueva carpeta vacía denominada registerdevice. En la carpeta registerdevice, cree un archivo package.json mediante el siguiente comando en el símbolo del sistema (asegúrese de responder todas las preguntas de npm o acepte los valores predeterminados si le van bien):

   npm init
   

4. Instale los siguientes paquetes precursores:

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

   Nota

   Hay algunos problemas conocidos al instalar los paquetes anteriores. Para resolver estos problemas, ejecute npm install --global --production windows-build-tools desde un símbolo del sistema en modo Ejecutar como administrador, ejecute SET VCTargetsPath=C:\Program Files (x86)\MSBuild\Microsoft.Cpp\v4.0\V140 después de reemplazar la ruta de acceso por la versión instalada y, luego, vuelva a ejecutar los comandos de la instalación anterior.

5. Instale todos los paquetes necesarios ejecutando el siguiente comando en el símbolo del sistema en la carpeta registerdevice:

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

   El comando instala los siguientes paquetes:

   • un cliente de seguridad que funciona con TPM: azure-iot-security-tpm

   • un transporte para que el dispositivo se conecte al servicio Device Provisioning: azure-iot-provisioning-device-http o azure-iot-provisioning-device-amqp

   • un cliente que use el transporte y el cliente de seguridad: azure-iot-provisioning-device

   • el cliente de dispositivo: azure-iot-device

   • un transporte: azure-iot-device-amqp, azure-iot-device-mqtt o azure-iot-device-http

   • el cliente de seguridad que ya ha instalado: azure-iot-security-tpm

     Nota

     Los ejemplos de esta guía de inicio rápido utilizan los transportes azure-iot-provisioning-device-http y azure-iot-device-mqtt.

6. Abra el editor de texto que prefiera.

7. En la carpeta registerdevice, cree un nuevo archivo ExtractDevice.js.

8. Agregue las siguientes instrucciones require al principio del archivo 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. Agregue la siguiente función para implementar el método:

   
   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. Guarde y cierre el archivo ExtractDevice.js.

    node ExtractDevice.js
    

11. Ejecute el ejemplo.

12. La ventana de salida muestra los valores de Clave de aprobación e Id. de registro necesarios para la inscripción del dispositivo. Copie estos valores.

1. Ejecute el siguiente comando para habilitar la autenticación del token de SAS (el comando también genera una solución de Visual Studio para el dispositivo simulado):

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

2. Abra un segundo símbolo del sistema.

3. En el segundo símbolo del sistema, vaya a la carpeta del simulador de TPM.

4. Ejecute el simulador de TPM para que sea el HSM para el dispositivo simulado.

5. Seleccione Permitir acceso. Este simulador escucha a través de un socket en los puertos 2321 y 2322. No cierre esta ventana de comandos; la ejecución del no debe interrumpirse hasta el final de esta guía de inicio rápido.

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

1. Ejecute el simulador de TPM para que sea el HSM para el dispositivo simulado.

2. Seleccione Permitir acceso. Este simulador escucha a través de un socket en los puertos 2321 y 2322. No cierre esta ventana de comandos; la ejecución del no debe interrumpirse hasta el final de esta guía de inicio rápido.

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

   

3. Abra un segundo símbolo del sistema.

4. En el segundo símbolo del sistema, vaya a la carpeta raíz y compile las dependencias de ejemplo.

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

5. Navegue hasta la carpeta de ejemplos.

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

Lectura de las claves criptográficas desde el dispositivo de TPM

En esta sección, compilará y ejecutará un ejemplo que leerá la clave de aprobación y el id. de registro del simulador de TPM que dejó ejecutándose y que aún está escuchando a través de los puertos 2321 y 2322. Estos valores se usarán para la inscripción de dispositivos en la instancia del servicio Device Provisioning.

1. Inicie Visual Studio.

2. Abra la solución que creó en la carpeta cmake denominada azure_iot_sdks.sln.

3. En el menú de Visual Studio, seleccione Compilar > Compilar solución para compilar todos los proyectos de la solución.

4. En el Explorador de soluciones de Visual Studio, vaya a la carpeta Aprovisionar_Herramientas. Haga clic con el botón derecho en el proyecto tpm_device_provision y seleccione Establecer como proyecto de inicio.

5. En el menú de Visual Studio, seleccione Depurar > Iniciar sin depurar para ejecutar la solución. La aplicación lee y muestra un identificador de registro y una clave de aprobación. Anote o copie estos valores. Los usará en la sección siguiente para la inscripción del dispositivo.

1. Inicie Visual Studio.

2. Abra la solución que creó en la carpeta cmake denominada azure_iot_sdks.sln.

3. En el menú de Visual Studio, seleccione Compilar > Compilar solución para compilar todos los proyectos de la solución.

4. Haga clic con el botón derecho en el proyecto tpm_device_provision y seleccione Establecer como proyecto de inicio.

5. Ejecute la solución. La ventana de salida muestra los valores de Clave de aprobación e Id. de registro necesarios para la inscripción del dispositivo. Copie estos valores.

1. Inicie sesión en Azure Portal, seleccione el botón Todos los recursos en el menú de la izquierda y abra la instancia de Device Provisioning Service. Anote los valores de Ámbito de id. y Provisioning Service Global Endpoint (Punto de conexión global del servicio de aprovisionamiento).

   

2. Edite el archivo src/main/java/samples/com/microsoft/azure/sdk/iot/ProvisioningTpmSample.java para que incluya el Ámbito de id. y el Provisioning Service Global Endpoint (Punto de conexión global del Servicio de aprovisionamiento) tal y como se indicó antes.

   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. Guarde el archivo.

4. Use los siguientes comandos para compilar el proyecto, vaya a la carpeta de destino y ejecute el archivo .jar que creó (reemplace {version} con su versión de Java):

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

5. Cuando el programa comience a ejecutarse, mostrará la Clave de aprobación y el Id. de registro. Copie estos valores para la sección siguiente. Asegúrese de dejar el programa en ejecución.

1. En Azure Portal, seleccione la pestaña Información general de Device Provisioning Service.

2. Copie el valor de del Ámbito de id.

   

3. En la ventana del Explorador de soluciones de Visual Studio, desplácese hasta la carpeta Aprovisionar_Ejemplos. Expanda el proyecto de ejemplo denominado prov_dev_client_sample. Expanda Archivos de código fuente y abra prov_dev_cliente_sample.c.

4. Cerca de la parte superior del archivo, busque las instrucciones #define para cada protocolo de dispositivo, tal como se muestra a continuación. Asegúrese de que solo SAMPLE_AMQP tenga quitada la marca de comentario.

   Actualmente, el protocolo MQTT no se admite para la inscripción individual de TPM.

   //
   // 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. Busque la constante id_scope y reemplace el valor por el valor de Ámbito de id. que copió anteriormente.

   static const char* id_scope = "0ne00002193";
   

6. Busque la definición de la función main() en el mismo archivo. Asegúrese de que la variable hsm_type está establecida en SECURE_DEVICE_TYPE_X509 y no en SECURE_DEVICE_TYPE_TPM, tal como se muestra a continuación.

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

7. Haga clic con el botón derecho en el proyecto prov_dev_client_sample y seleccione Set as Startup Project (Establecer como proyecto de inicio).

8. En el menú de Visual Studio, seleccione Depurar > Iniciar sin depurar para ejecutar la solución. En la solicitud para volver a compilar el proyecto, seleccione Sí para recompilar el proyecto antes de ejecutarlo.

   La salida siguiente es un ejemplo del cliente de dispositivo de aprovisionamiento de ejemplo que ha arrancado correctamente y se conecta a la instancia del servicio Device Provisioning para obtener información de IoT Hub y registrarse:

   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. En Azure Portal, seleccione la pestaña Información general de Device Provisioning Service.

2. Copie el valor de del Ámbito de id.

   

3. Abra el editor de texto que prefiera.

4. En la carpeta registerdevice, cree un nuevo archivo RegisterDevice.js.

5. Agregue las instrucciones require al principio del archivo RegisterDevice.js:

   
   '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;
   

   Nota

   El SDK de IoT de Azure para Node.js admite protocolos adicionales, como AMQP, AMQP WS y MQTT WS. Para ver más ejemplos, consulte Samples for the Azure IoT Device Provisioning Service SDK for Node.js (Ejemplos del SDK de servicio de aprovisionamiento de dispositivos de Azure IoT para Node.js).

6. Agregue las variables globalDeviceEndpoint e idScope y úselas para crear una instancia de ProvisioningDeviceClient. Reemplace {globalDeviceEndpoint} e {idScope} por los valores de Punto de conexión global del dispositivo y Ámbito de id del paso 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. Agregue la siguiente función para implementar el método en el dispositivo:

   
   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. Guarde el archivo RegisterDevice.js y ciérrelo.

9. Ejecute el siguiente comando:

   node RegisterDevice.js
   

10. Tenga en cuenta los mensajes que simulan el arranque del dispositivo y la conexión al servicio Device Provisioning para obtener la información del centro de IoT.

1. Vaya a la carpeta de ejemplos del repositorio de Git.

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

2. Con el IDE de Python, edite la secuencia de comandos de Python denominada aprovisionamiento_dispositivo_cliente_sample.py (reemplazar) {globalServiceEndpoint} y {idScope} con los valores que copió previamente). Asegúrese también de que SECURITY_DEVICE_TYPE está establecido en ProvisioningSecurityDeviceType.TPM.

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

   

3. Ejecute el ejemplo.

   python provisioning_device_client_sample.py
   

4. Tenga en cuenta los mensajes que simulan el arranque del dispositivo y la conexión al servicio Device Provisioning para obtener la información del centro de IoT.

1. En la ventana de comandos que ejecuta el código de ejemplo de Java en la máquina, presione Entrar para seguir ejecutando la aplicación. Tenga en cuenta los mensajes que simulan el arranque del dispositivo y la conexión al servicio Device Provisioning para obtener la información del centro de IoT.