使用 X.509 证书在 Windows 上大规模创建和预配 IoT Edge 设备
适用于: IoT Edge 1.1
重要
IoT Edge 1.1 终止支持日期为 2022 年 12 月 13 日。 请查看 Microsoft 产品生命周期,了解此产品、服务、技术或 API 的受支持情况。 有关更新到最新版本的 IoT Edge 的详细信息,请参阅 更新 IoT Edge。
本文提供有关使用 X.509 证书自动预配一个或多个 Windows IoT Edge 设备的端到端说明。 可以通过 Azure IoT 中心设备预配服务 (DPS) 自动预配 Azure IoT Edge 设备。 如果你不熟悉自动预配过程,请在继续操作之前查看预配概述。
注意
从 Azure IoT Edge 1.2 版开始,将不再支持带有 Windows 容器的 Azure IoT Edge。
请考虑使用新方法在 Windows 设备上运行 IoT Edge:Azure IoT Edge for Linux on Windows。
要使用 Azure IoT Edge for Linux on Windows,可按照等效操作指南中的步骤操作。
任务如下:
- 生成证书和密钥。
- 为单个设备创建单个注册,或为一组设备创建组注册。
- 安装 IoT Edge 运行时并将设备注册到 IoT 中心。
将 X.509 证书用作一种证明机制是扩大生产规模和简化设备设置的极佳途径。 X.509 证书通常排列在证书信任链中。 从自签名证书或受信任的根证书开始,证书链中的每个证书为下一级证书签名。 此模式创建了从设备上安装的根证书到每个中间证书,再到最终的下游设备证书的委托信任链。
先决条件
云资源
- 一个活动的 IoT 中心
- Azure 中的一个 IoT 中心设备预配服务实例,该实例已链接到 IoT 中心
- 如果没有设备预配服务实例,则可按照 IoT 中心设备预配服务快速入门的创建新的 IoT 中心设备预配服务和将 IoT 中心和设备预配服务相链接部分的说明进行操作。
- 运行设备预配服务后,从概述页复制“ID 范围”的值。 配置 IoT Edge 运行时时,需要使用此值。
设备要求
一个充当 IoT Edge 设备的物理设备或虚拟 Windows 设备。
生成设备标识证书
设备标识证书是通过证书信任链连接到顶级 X.509 证书颁发机构 (CA) 证书的下游设备证书。 设备标识证书的公用名 (CN) 必须设置为你希望该设备在 IoT 中心内使用的设备 ID。
设备标识证书仅用于预配 IoT Edge 设备,以及通过 Azure IoT 中心对设备进行身份验证。 设备标识证书不是签名证书,这与 CA 证书不同,后者是 IoT Edge 设备向模块或下游设备提供的用于验证的证书。 有关详细信息,请参阅 Azure IoT Edge 证书用法详细信息。
创建设备标识证书后,应会获得两个文件:一个包含证书公共部分的 .cer 或 .pem 文件,一个包含证书私钥的 .cer 或 .pem 文件。 如果你打算在 DPS 中使用组注册,则还需要提供同一证书信任链中某个中间证书或根 CA 证书的公共部分。
若要使用 X.509 设置自动预配,需要以下文件:
- 设备标识证书及其私钥证书。 如果创建单个注册,则设备标识证书会上传到 DPS。 私钥会传递到 IoT Edge 运行时。
- 完整链证书,其中应至少包含设备标识和中间证书。 完整链证书会传递到 IoT Edge 运行时。
- 证书信任链中的中间或根 CA 证书。 如果创建组注册,则此证书会上传到 DPS。
注意
目前存在一个 libiothsm 限制,会阻止使用在 2038 年 1 月 1 日或之后到期的证书。
使用测试证书(可选)
如果你没有可用于创建新标识证书的证书颁发机构,但想要尝试此方案,可以使用 Azure IoT Edge Git 存储库中包含的脚本来生成测试证书。 这些证书仅用于开发测试,不得在生产环境中使用。
若要创建测试证书,请遵循创建演示证书用于测试 IoT Edge 设备功能中的步骤。 请完成其中的两个必要部分来设置证书生成脚本,并创建根 CA 证书。 然后,遵循相应的步骤创建设备标识证书。 完成后,应会获得以下证书链和密钥对:
<WRKDIR>\certs\iot-edge-device-identity-<name>-full-chain.cert.pem
<WRKDIR>\private\iot-edge-device-identity-<name>.key.pem
需要在 IoT Edge 设备上使用这两个证书。 若要在 DPS 中使用单独的注册,需要上传 .cert.pem 文件。 若要在 DPS 中使用组注册,则还需要上传同一证书信任链中的某个中间证书或根 CA 证书。 如果使用演示证书,请将 <WRKDIR>\certs\azure-iot-test-only.root.ca.cert.pem
证书用于组注册。
创建 DPS 注册
使用生成的证书和密钥在 DPS 中为一个或多个 IoT Edge 设备创建注册。
如果要预配单个 IoT Edge 设备,请创建单个注册。 如果需要预配多个设备,请按照创建 DPS 组注册的步骤进行操作。
在 DPS 中创建注册时,可以声明“初始设备孪生状态”。 在设备孪生中可以设置标记,以便按解决方案中所需的任何指标(例如区域、环境、位置或设备类型)将设备分组。 这些标记用于创建自动部署。
有关设备预配服务中的注册的详细信息,请参阅如何管理设备注册。
创建 DPS 单独注册
单独注册采用设备标识证书的公共部分,并将其与设备上的证书进行匹配。
提示
本文中的步骤适用于 Azure 门户,但你也可使用 Azure CLI 创建单个注册。 有关详细信息,请参阅 az iot dps enrollment。 作为 CLI 命令的一部分,使用 edge-enabled 标志指定注册适用于单个 IoT Edge设备。
在 Azure 门户中,导航到 IoT 中心设备预配服务实例。
在“设置”下,选择“管理注册”。
选择“添加个人注册”,然后完成以下步骤以配置注册:
机制:选择“X.509”。
主要证书 .pem 或 .cer 文件:上传设备标识证书中的公共文件。 如果使用脚本生成了测试证书,请选择以下文件:
<WRKDIR>\certs\iot-edge-device-identity-<name>.cert.pem
IoT 中心设备 ID:根据需要,为设备提供一个 ID。 可以使用设备 ID 将单个设备指定为模块部署的目标。 如果未提供设备 ID,将使用 X.509 证书中的公用名 (CN)。
IoT Edge 设备:选择“True”,声明该注册适用于 IoT Edge 设备。
选择此设备可分配到的 IoT 中心:选择要将设备连接到的链接 IoT 中心。 可以选择多个中心,设备将根据所选的分配策略分配到其中的一个中心。
初始设备孪生状态:如果需要,请添加要添加到设备孪生的标记值。 可以使用标记将设备组指定为自动部署的目标。 例如:
{ "tags": { "environment": "test" }, "properties": { "desired": {} } }
选择“保存” 。
在“管理注册”下,可以查看刚创建的注册的“注册 ID”。 请记下该注册 ID,因为预配设备时可能会使用它。
既然此设备已存在注册,IoT Edge 运行时在安装期间可以自动预配设备。
安装 IoT Edge
在本节中,你将准备 IoT Edge 的 Windows VM 或物理设备。 然后安装 IoT Edge。
Azure IoT Edge 依赖于 OCI 兼容的容器运行时。 Moby 是一种基于 Moby 的引擎,包含在安装脚本中,这意味着无需执行其他步骤来安装引擎。
要安装 IoT Edge 运行时:
以管理员身份运行 PowerShell。
使用 PowerShell 的 AMD64 会话,不要使用 PowerShell(x86)。 如果不确定你使用的是哪种会话类型,请运行以下命令:
(Get-Process -Id $PID).StartInfo.EnvironmentVariables["PROCESSOR_ARCHITECTURE"]
运行 Deploy-IoTEdge 命令,它将执行以下任务:
- 检查 Windows 计算机的版本是否受支持
- 启用容器功能
- 下载 moby 引擎和 IoT Edge 运行时
. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; ` Deploy-IoTEdge
如果出现提示,请重启设备。
在设备上安装 IoT Edge 时,可使用附加参数来修改过程,包括:
- 定向流量,使其通过代理服务器
- 将安装程序指向本地目录进行脱机安装
有关这些附加参数的详细信息,请参阅用于带有 Windows 容器的 IoT Edge 的 PowerShell 脚本。
为设备预配其云标识
在设备上安装运行时后,请使用供设备用来连接到设备预配服务和 IoT 中心的信息来配置该设备。
准备好以下信息:
- DPS 的“ID 范围”值。 可以从 Azure 门户中 DPS 实例的概述页检索此值。
- 设备上的设备标识证书链文件。
- 设备上的设备标识密钥文件。
在管理员模式下打开 PowerShell 窗口。 在安装 IoT Edge 而不是 PowerShell (x86) 时,请确保使用 PowerShell 的 AMD64 会话。
Initialize-IoTEdge 命令在计算机上配置 IoT Edge 运行时。 该命令默认为使用 Windows 容器手动预配,因此使用
-DpsX509
标志借助 X.509 证书身份验证来使用自动预配。请将
scope_id
、identity cert chain path
和identity key path
的占位符值替换为 DPS 实例中的相应值,以及设备上的文件路径。如果你要将设备 ID 设置为除标识证书 CN 名称以外的其他值,请添加
-RegistrationId paste_registration_id_here
参数。. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; ` Initialize-IoTEdge -DpsX509 -ScopeId paste_scope_id_here -X509IdentityCertificate paste_identity_cert_chain_path_here -X509IdentityPrivateKey paste_identity_key_path_here
提示
配置文件以文件 URI 的形式存储证书和密钥信息。 但是,Initialize-IoTEdge 命令将为你处理此格式设置步骤,因此,可以提供证书和密钥文件在设备上的绝对路径。
验证是否成功安装
如果运行时成功启动,则可以进入 IoT 中心,开始将 IoT Edge 模块部署到你的设备。
可以验证是否使用了在设备预配服务中创建的单独注册。 在 Azure 门户中导航到你的设备预配服务实例。 打开创建的个人注册的注册详细信息。 注意注册状态是否为“已分配”并且设备 ID 已列出。
在设备上,使用以下命令验证是否已成功安装并启动 IoT Edge。
检查 IoT Edge 服务的状态。
Get-Service iotedge
检查服务日志。
. {Invoke-WebRequest -useb aka.ms/iotedge-win} | Invoke-Expression; Get-IoTEdgeLog
列出正在运行的模块。
iotedge list
后续步骤
使用设备预配服务注册过程可以在预配新设备的同时,设置设备 ID 和设备孪生标记。 可以在自动设备管理中,使用这些值将单个设备或设备组指定为目标。 了解如何使用 Azure 门户大规模部署和监视 IoT Edge 模块,或使用 Azure CLI 执行此操作。