以编程方式为 X.509 证书证明创建设备预配服务注册组

• 在基于 Windows 的计算机上安装 .NET 6.0 SDK 或更高版本。 可使用以下命令来检查你的版本。

  dotnet --info
  

• 在计算机上安装 Node.js v4.0 或更高版本。

• Java SE 开发工具包 8。 本文使用适用于 Java 的 Azure IoT SDK，它在 Windows 和 Linux 上都可以工作。 本文使用 Windows。

• Maven 3。

本部分介绍如何创建一个 .NET Core 控制台应用程序，用于将注册组添加到预配服务。

1. 打开 Windows 命令提示符并导航到要在其中创建应用的文件夹。

2. 若要创建控制台项目，请运行以下命令：

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

3. 若要添加对 DPS 服务 SDK 的引用，请运行以下命令：

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

   此步骤将下载、安装 Azure IoT DPS 服务客户端 NuGet 包及其依赖项，并添加对其的引用。 此包包含 .NET 服务 SDK 的二进制文件。

4. 在编辑器中打开 Program.cs 文件。

5. 将文件顶部的命名空间语句替换为以下行：

   namespace CreateEnrollmentGroup;
   

6. 在文件顶部（namespace 语句之上）添加以下 using 语句：

   using System.Security.Cryptography.X509Certificates;
   using System.Threading.Tasks;
   using Microsoft.Azure.Devices.Provisioning.Service;
   

7. 将以下字段添加到 Program 类，并按指示进行更改。

   private static string ProvisioningConnectionString = "{ProvisioningServiceConnectionString}";
   private static string EnrollmentGroupId = "enrollmentgrouptest";
   private static string X509RootCertPath = @"{Path to a .cer or .pem file for a verified root CA or intermediate CA X.509 certificate}";
   

   • 将 ProvisioningServiceConnectionString 占位符值替换为在上一部分复制的预配服务连接字符串。

   • 将 X509RootCertPath 占位符值替换为 .pem 或 .cer 文件的路径。 此文件表示根 CA X.509 证书的公共部分，该证书之前已通过预配服务上传和验证，或者表示中间证书的公共部分，该证书本身已上传和验证或其签名链中的证书已上传和验证。

   • 可以选择性地更改 EnrollmentGroupId 值。 字符串只能包含小写字符和连字符。

   重要

   在生产代码中，请注意以下安全注意事项：

   • 为预配服务管理员硬编码连接字符串不符合安全最佳做法。 与硬编码相反，连接字符串应采用安全方式进行存储，例如存储在安全配置文件或注册表中。
   • 确保只上传签名证书的公用部分。 不要将包含私钥的 .pfx (PKCS12) 或 .pem 文件上传到预配服务。

8. 将以下方法添加到 Program 类。 此代码创建一个 EnrollmentGroup 条目，然后调用 ProvisioningServiceClient.CreateOrUpdateEnrollmentGroupAsync 方法，将注册组添加到预配服务。

   public static async Task RunSample()
   {
       Console.WriteLine("Starting sample...");
   
       using (ProvisioningServiceClient provisioningServiceClient =
               ProvisioningServiceClient.CreateFromConnectionString(ProvisioningConnectionString))
       {
           #region Create a new enrollmentGroup config
           Console.WriteLine("\nCreating a new enrollmentGroup...");
           var certificate = new X509Certificate2(X509RootCertPath);
           Attestation attestation = X509Attestation.CreateFromRootCertificates(certificate);
           EnrollmentGroup enrollmentGroup =
                   new EnrollmentGroup(
                           EnrollmentGroupId,
                           attestation)
                   {
                       ProvisioningStatus = ProvisioningStatus.Enabled
                   };
           Console.WriteLine(enrollmentGroup);
           #endregion
   
           #region Create the enrollmentGroup
           Console.WriteLine("\nAdding new enrollmentGroup...");
           EnrollmentGroup enrollmentGroupResult =
               await provisioningServiceClient.CreateOrUpdateEnrollmentGroupAsync(enrollmentGroup).ConfigureAwait(false);
           Console.WriteLine("\nEnrollmentGroup created with success.");
           Console.WriteLine(enrollmentGroupResult);
           #endregion
   
       }
   }
   

9. 最后，将 Main 方法替换为以下行：

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

10. 保存所做更改。

本部分介绍如何创建一个 Node.js 脚本，用于将注册组添加到预配服务。

1. 在工作文件夹的命令窗口中，运行以下命令：

   npm install azure-iot-provisioning-service
   

   此步骤将下载、安装 Azure IoT DPS 服务客户端包及其依赖项，并添加对其的引用。 此包包含 Node.js 服务 SDK 的二进制文件。

2. 使用文本编辑器，在工作文件夹中创建 create_enrollment_group.js 文件。 将以下代码添加到文件并进行保存：

       'use strict';
       var fs = require('fs');
   
       var provisioningServiceClient = require('azure-iot-provisioning-service').ProvisioningServiceClient;
   
       var serviceClient = provisioningServiceClient.fromConnectionString(process.argv[2]);
   
       var enrollment = {
         enrollmentGroupId: 'first',
         attestation: {
           type: 'x509',
           x509: {
             signingCertificates: {
               primary: {
                 certificate: fs.readFileSync(process.argv[3], 'utf-8').toString()
               }
             }
           }
         },
         provisioningStatus: 'disabled'
       };
   
       serviceClient.createOrUpdateEnrollmentGroup(enrollment, function(err, enrollmentResponse) {
         if (err) {
           console.log('error creating the group enrollment: ' + err);
         } else {
           console.log("enrollment record returned: " + JSON.stringify(enrollmentResponse, null, 2));
           enrollmentResponse.provisioningStatus = 'enabled';
           serviceClient.createOrUpdateEnrollmentGroup(enrollmentResponse, function(err, enrollmentResponse) {
             if (err) {
               console.log('error updating the group enrollment: ' + err);
             } else {
               console.log("updated enrollment record returned: " + JSON.stringify(enrollmentResponse, null, 2));
             }
           });
         }
       });
   

1. 打开 Windows 命令提示符。

2. 使用 Java 服务 SDK 克隆设备注册代码示例的 GitHub 存储库：

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

3. 从下载存储库的位置转到示例文件夹：

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

4. 在所选的编辑器中打开文件“/src/main/java/samples/com/microsoft/azure/sdk/iot/ServiceEnrollmentGroupSample.java”。

5. 将 [Provisioning Connection String] 替换为在获取适用于预配服务的连接字符串中复制的连接字符串。

6. 将 PUBLIC_KEY_CERTIFICATE_STRING 常量字符串替换为根 CA 证书或中间 CA 证书 .pem 文件的值。 此文件表示根 CA X.509 证书的公共部分，该证书之前已通过预配服务上传和验证，或者表示中间证书的公共部分，该证书本身已上传和验证或其签名链中的证书已上传和验证。

   证书文本的语法必须遵循以下模式，其中不包含额外的空格或字符。

   private static final String PUBLIC_KEY_CERTIFICATE_STRING = 
           "-----BEGIN CERTIFICATE-----\n" +
           "MIIFOjCCAyKgAwIBAgIJAPzMa6s7mj7+MA0GCSqGSIb3DQEBCwUAMCoxKDAmBgNV\n" +
               ...
           "MDMwWhcNMjAxMTIyMjEzMDMwWjAqMSgwJgYDVQQDDB9BenVyZSBJb1QgSHViIENB\n" +
           "-----END CERTIFICATE-----";
   

   手动更新此字符串值可能容易出错。 若要生成正确的语法，可以复制以下命令并并粘贴到 Git Bash 提示符中，将 your-cert.pem 替换为证书文件的位置，然后按 ENTER。 此命令将生成 PUBLIC_KEY_CERTIFICATE_STRING 字符串常量值的语法并将其写入到输出。

   sed 's/^/"/;$ !s/$/\\n" +/;$ s/$/"/' your-cert.pem
   

   复制并粘贴常量值的输出证书文本。

   重要

   在生产代码中，请注意以下安全注意事项：

   • 为预配服务管理员硬编码连接字符串不符合安全最佳做法。 与硬编码相反，连接字符串应采用安全方式进行存储，例如存储在安全配置文件或注册表中。
   • 确保只上传签名证书的公用部分。 不要将包含私钥的 .pfx (PKCS12) 或 .pem 文件上传到预配服务。

7. 可以通过此示例在注册组中设置 IoT 中心以在其中预配设备。 设置的 IoT 中心必须是以前链接到预配服务的 IoT 中心。 在本文中，我们让 DPS 根据默认的分配策略（均匀加权分布），从链接中心中进行选择。 注释禁止文件中的以下语句：

   enrollmentGroup.setIotHubHostName(IOTHUB_HOST_NAME);                // Optional parameter.
   

8. 示例代码为 X.509 设备创建、更新、查询和删除注册组。 若要验证是否在 Azure 门户中成功创建注册组，请注释禁止文件末尾附近的以下代码行：

   // ************************************** Delete info of enrollmentGroup ***************************************
   System.out.println("\nDelete the enrollmentGroup...");
   provisioningServiceClient.deleteEnrollmentGroup(enrollmentGroupId);
   

9. 保存 ServiceEnrollmentGroupSample.java 文件。

1. 运行示例：

   dotnet run
   

2. 成功创建后，该命令窗口将显示新注册组的属性。

1. 在命令提示符下，运行以下命令。 包括命令参数两侧的引号，并将 <connection string> 替换为在上一部分复制的连接字符串，将 <certificate .pem file> 替换为证书 .pem 文件的路径。 此文件表示根 CA X.509 证书的公共部分，该证书之前已通过预配服务上传和验证，或者表示中间证书的公共部分，该证书本身已上传和验证或其签名链中的证书已上传和验证。

   node create_enrollment_group.js "<connection string>" "<certificate .pem file>"
   

2. 成功创建后，该命令窗口将显示新注册组的属性。

1. 在命令提示符的 azure-iot-sdk-java\provisioning\provisioning-service-client-samples\service-enrollment-group-sample 文件夹中，运行以下命令以生成示例：

   mvn install -DskipTests
   

   此命令将 Azure IoT DPS 服务客户端 Maven 包下载到计算机并生成示例。 此包包含 Java 服务 SDK 的二进制文件。

2. 切换到 target 文件夹并运行示例。 上一步中的生成会在 target 文件夹中输出使用以下文件格式的 .jar 文件：provisioning-x509-sample-{version}-with-deps.jar；例如：provisioning-x509-sample-1.8.1-with-deps.jar。 可能需要替换以下命令中的版本。

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

3. 成功创建后，该命令窗口将显示新注册组的属性。

Azure IoT C SDK 具有可以帮助创建和管理证书的脚本。 若要了解详细信息，请参阅管理用于示例和教程的测试 CA 证书。

Azure IoT Node.js SDK 具有可以帮助创建和管理证书的脚本。 若要了解详细信息，请参阅 适用于 Node.js 的 Azure IoT 设备预配设备 SDK 工具。

还可以使用 Azure IoT C SDK 中提供的工具。 若要了解详细信息，请参阅管理用于示例和教程的测试 CA 证书。

Azure IoT Java SDK 包含测试工具，可以帮助创建和管理证书。 若要了解详细信息，请参阅使用 DICE 模拟器的 X509 证书生成器。