Programmatically create a Device Provisioning Service individual enrollment for TPM attestation

This article shows you how to programmatically create an individual enrollment for a TPM device in the Azure IoT Hub Device Provisioning Service by using the Azure IoT Hub DPS service SDK and a sample application. After you've created the individual enrollment, you can optionally enroll a simulated TPM device to the provisioning service through this enrollment entry.

Although these steps work on both Windows and Linux computers, this article uses a Windows development computer.

Prerequisites

  • Install .NET 6.0 SDK or later or later on your Windows-based machine. You can use the following command to check your version.

    dotnet --info
    
  • (Optional) If you want to enroll a simulated device at the end of this article, follow the procedure in Create and provision a simulated TPM device up to the step where you get an endorsement key for the device. Save the Endorsement key, you'll use it later in this article.

    Note

    Don't follow the steps to create an individual enrollment by using the Azure portal.

  • Install Node.js v4.0+.

  • (Optional) If you want to enroll a simulated device at the end of this article, follow the procedure in Create and provision a simulated TPM device up to the step where you get an endorsement key and registration ID for the device. Save the Endorsement key and Registration ID, you'll use them later in this article.

    Note

    Don't follow the steps to create an individual enrollment by using the Azure portal.

  • Install the Java SE Development Kit 8. This article installs the Java Service SDK below. It works on both Windows and Linux. This article uses Windows.

  • Install Maven 3.

  • Install Git and make sure the the path is added to the environment variable PATH.

  • (Optional) If you want to enroll a simulated device at the end of this article, follow the procedure in Create and provision a simulated TPM device up to the step where you get an endorsement key for the device. Note the Endorsement key and the Registration ID, you'll use them later in this article.

    Note

    Don't follow the steps to create an individual enrollment by using the Azure portal.

Get TPM endorsement key (Optional)

You can follow the steps in this article to create a sample individual enrollment. In this, case, you'll be able to view the enrollment entry in DPS, but you won't be able to use it to provision a device.

You can also choose to follow the steps in this article to create an individual enrollment and enroll a simulated TPM device. If you want to enroll a simulated device at the end of this article, follow the procedure in Create and provision a simulated TPM device up to the step where you get an endorsement key for the device. Save the Endorsement key, you'll use it later in this article.

Note

Don't follow the steps to create an individual enrollment by using the Azure portal.

You can also choose to follow the steps in this article to create an individual enrollment and enroll a simulated TPM device. If you want to enroll a simulated device at the end of this article, follow the procedure in Create and provision a simulated TPM device up to the step where you get an endorsement key and registration ID for the device. Save the Endorsement key and Registration ID, you'll use them later in this article.

Note

Don't follow the steps to create an individual enrollment by using the Azure portal.

You can also choose to follow the steps in this article to create an individual enrollment and enroll a simulated TPM device. If you want to enroll a simulated device at the end of this article, follow the procedure in Create and provision a simulated TPM device up to the step where you get an endorsement key for the device. Note the Endorsement key and the Registration ID, you'll use them later in this article.

Note

Don't follow the steps to create an individual enrollment by using the Azure portal.

Get the connection string for your provisioning service

For the sample in this article, you'll need to copy the connection string for your provisioning service.

  1. Sign in to the Azure portal.

  2. On the left-hand menu or on the portal page, select All resources.

  3. Select your Device Provisioning Service.

  4. In the Settings menu, select Shared access policies.

  5. Select the access policy that you want to use.

  6. In the Access Policy panel, copy and save the primary key connection string.

    Get provisioning service connection string from the portal.

Create the individual enrollment sample

This section shows you how to create a .NET Core console app that adds an individual enrollment for a TPM device to your provisioning service.

  1. Open a Windows command prompt and navigate to a folder where you want to create your app.

  2. To create a console project, run the following command:

    dotnet new console --framework net6.0 --use-program-main 
    
  3. To add a reference to the DPS service SDK, run the following command:

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

    This step downloads, installs, and adds a reference to the Azure IoT DPS service client NuGet package and its dependencies. This package includes the binaries for the .NET service SDK.

  4. Open Program.cs file in an editor.

  5. Replace the namespace statement at the top of the file with the following:

    namespace CreateIndividualEnrollment;
    
  6. Add the following using statements at the top of the file above the namespace statement:

    using System.Threading.Tasks;
    using Microsoft.Azure.Devices.Provisioning.Service;
    
  7. Add the following fields to the Program class, and make the listed changes.

    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;
    
    • Replace the ProvisioningServiceConnectionString placeholder value with the connection string of the provisioning service that you copied in the previous section.

    • If you're using this article together with the Create and provision a simulated TPM device quickstart to provision a simulated device, replace the endorsement key with the value that you noted in that quickstart. You can replace the device ID and registration ID with the values suggested in that quickstart, use your own values, or use the default values in this sample.

  8. Add the following method to the Program class. This code creates an individual enrollment entry and then calls the CreateOrUpdateIndividualEnrollmentAsync method on the ProvisioningServiceClient to add the individual enrollment to the provisioning service.

    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. Finally, replace the Main method with the following lines:

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

  1. From a command window in your working folder, run:

    npm install azure-iot-provisioning-service
    

    This step downloads, installs, and adds a reference to the Azure IoT DPS service client package and its dependencies. This package includes the binaries for the Node.js service SDK.

  2. Using a text editor, create a create_individual_enrollment.js file in your working folder. Add the following code to the file:

    '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. Save the file.

  1. Open a Windows command prompt.

  2. Clone the Microsoft Azure IoT SDKs for Java GitHub repo:

    git clone https://github.com/Azure/azure-iot-sdk-java.git --recursive
    
  3. Go to the sample folder:

    cd azure-iot-sdk-java\provisioning\provisioning-samples\service-enrollment-sample
    
  4. Open the file \src\main\java\samples\com\microsoft\azure\sdk\iot\ServiceEnrollmentSample.java in an editor.

  5. Replace [Provisioning Connection String] with the connection string that you copied in Get the connection string for your provisioning service.

    private static final String PROVISIONING_CONNECTION_STRING = "[Provisioning Connection String]";
    
  6. Add the TPM device details. Replace the [RegistrationId] and [TPM Endorsement Key] in the following statements with your endorsement key and registration ID.

    private static final String REGISTRATION_ID = "[RegistrationId]";
    private static final String TPM_ENDORSEMENT_KEY = "[TPM Endorsement Key]";
    
    • If you're using this article together with the Create and provision a simulated TPM device quickstart to provision a simulated device, use the Registration ID and Endorsement key values that you noted from that quickstart.

    • If you're using this article to just create a sample individual enrollment and don't intend to use it to enroll a device, you can use the following value for an endorsement key:

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

      Enter your own value for the registration ID, for example, "myJavaDevice".

  7. For individual enrollments, you can choose to set a device ID that DPS will assign to the device when it provisions it to IoT Hub. If you don't assign a device ID, DPS will use the registration ID as the device ID. By default, this sample assigns "myJavaDevice" as the device ID. If you want to change the device ID, modify the following statement:

        private static final String DEVICE_ID = "myJavaDevice";
    

    If you don't want to assign a specific device ID, comment out the following statement:

    individualEnrollment.setDeviceId(DEVICE_ID);
    
  8. The sample allows you to set an IoT hub in the individual enrollment to provision the device to. This must be an IoT hub that has been previously linked to the provisioning service. For this article, we'll let DPS choose from the linked hubs according to the default allocation policy, evenly-weighted distribution. Comment out the following statement in the file:

    individualEnrollment.setIotHubHostName(IOTHUB_HOST_NAME);
    
  9. The sample creates, updates, queries, and deletes an individual TPM device enrollment. To verify successful enrollment in portal, temporarily comment out the following lines of code at the end of the file:

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

Run the individual enrollment sample

  1. Run the sample:

    dotnet run
    
  2. Upon successful creation, the command window displays the properties of the new enrollment.

To run the sample, you'll need the connection string for your provisioning service that you copied in the previous section, as well as the endorsement key for the device. If you've followed the Create and provision a simulated device quickstart to create a simulated TPM device, use the endorsement key created for that device. Otherwise, to create a sample individual enrollment, you can use the following endorsement key supplied with the Node.js Service SDK:

AToAAQALAAMAsgAgg3GXZ0SEs/gakMyNRqXXJP1S124GUgtk8qHaGzMUaaoABgCAAEMAEAgAAAAAAAEAxsj2gUScTk1UjuioeTlfGYZrrimExB+bScH75adUMRIi2UOMxG1kw4y+9RW/IVoMl4e620VxZad0ARX2gUqVjYO7KPVt3dyKhZS3dkcvfBisBhP1XH9B33VqHG9SHnbnQXdBUaCgKAfxome8UmBKfe+naTsE5fkvjb/do3/dD6l4sGBwFCnKRdln4XpM03zLpoHFao8zOwt8l/uP3qUIxmCYv9A7m69Ms+5/pCkTu/rK4mRDsfhZ0QLfbzVI6zQFOKF/rwsfBtFeWlWtcuJMKlXdD8TXWElTzgh7JS4qhFzreL0c1mI0GCj+Aws0usZh7dLIVPnlgZcBhgy1SSDQMQ==
  1. To create an individual enrollment for your TPM device, run the following command (include the quotes around the command arguments):

    node create_individual_enrollment.js "<the connection string for your provisioning service>" "<endorsement key>"
    
  2. Upon successful creation, the command window displays the properties of the new enrollment.

  1. From the azure-iot-sdk-java\provisioning\provisioning-samples\service-enrollment-sample folder in your command prompt, run the following command to build the sample:

    mvn install -DskipTests
    

    This command downloads the Azure IoT DPS service client Maven package to your machine and builds the sample. This package includes the binaries for the Java service SDK.

  2. Switch to the target folder and run the sample. Be aware that the build in the previous step outputs .jar file in the target folder with the following file format: service-enrollment-sample-{version}-with-deps.jar; for example: service-enrollment-sample-1.8.1-with-deps.jar. You may need to replace the version in the command below.

    cd target
    java -jar ./service-enrollment-sample-1.8.1-with-deps.jar
    
  3. Upon successful creation, the command window displays the properties of the new enrollment.

To verify that the enrollment group has been created:

  1. In the Azure portal, select your Device Provisioning Service.

  2. In the Settings menu, select Manage enrollments.

  3. Select Individual Enrollments. You should see a new enrollment entry that corresponds to the registration ID that you used in the sample.

Verify enrollment for C# individual device in the portal.

Verify enrollment for Node.js individual device in the portal.

Verify enrollment for Java individual device in the portal.

Enroll a simulated device (Optional)

If you've been following steps in the Create and provision a simulated TPM device quickstart to provision a simulated device, resume the quickstart at Register the device.

If you've been following steps in the Create and provision a simulated TPM device quickstart to provision a simulated device, resume the quickstart at Register the device.

If you've been following steps in the Create and provision a simulated TPM device quickstart to provision a simulated device, resume the quickstart at Register the device.

Clean up resources

If you plan to explore the DPS tutorials, don't clean up the resources created in this article. Otherwise, use the following steps to delete all resources created by this article.

  1. Close the sample output window on your computer.

  2. From the left-hand menu in the Azure portal, select All resources.

  3. Select your Device Provisioning Service.

  4. In the left-hand menu under Settings, select Manage enrollments.

  5. Select the Individual Enrollments tab.

  6. Select the check box next to the REGISTRATION ID of the enrollment entry you created in this article.

  7. At the top of the page, select Delete.

  1. If you followed the steps in Create and provision a simulated TPM device to create a simulated TPM device, do the following steps:

    1. In the Azure portal, navigate to the IoT Hub where your device was provisioned.

    2. In the left-hand menu under Device management, select Devices.

    3. Select the check box next to the Device ID of the device you registered in this article.

    4. At the top of the pane, select Delete.

  1. If you followed the steps in Create and provision a simulated TPM device to create a simulated TPM device, do the following steps:

    1. Close the TPM simulator window and the sample output window for the simulated device.

    2. In the Azure portal, navigate to the IoT Hub where your device was provisioned.

    3. In the left-hand menu under Device management, select Devices.

    4. Select the check box next to the Device ID of the device you registered in this article.

    5. At the top of the pane, select Delete.

  1. If you followed the steps in Create and provision a simulated TPM device to create a simulated TPM device, do the following steps:

    1. Close the TPM simulator window and the sample output window for the simulated device.

    2. In the Azure portal, navigate to the IoT Hub where your device was provisioned.

    3. In the left-hand menu under Device management, select Devices.

    4. Select the check box next to the Device ID of the device you registered in this article.

    5. At the top of the pane, select Delete.

Next steps

In this article, you’ve programmatically created an individual enrollment entry for a TPM device. Optionally, you created a TPM simulated device on your computer and provisioned it to your IoT hub using the Azure IoT Hub Device Provisioning Service. To explore further, check out the following links: