Windows Device Portal 概述

Windows 设备门户 (WDP) 是 Windows 设备附带的 web 服务器,使用它,可以通过网络或 USB 连接配置和管理设备的设置(带有 web 浏览器的设备也支持本地连接)。

WDP 还提供高级诊断工具,可用于查看 Windows 设备的实时性能并对其进行故障排除。

通过一组 REST API 以编程方式公开 WDP 功能。

本文提供了 Windows 设备门户的常规说明,并包含一系列文章链接,这些文章介绍了每个 Windows 设备系列的更具体的信息。

注意

设备系列可标识在一个设备类所需的 API、系统特性和行为。

设置

每个设备系列提供 WDP 的一个版本,但功能和设置因设备的要求而异。

这是适用于所有设备的基本步骤。

  1. 在设备上启用开发人员模式和设备门户(“设置”->“隐私和安全性”->“适用于开发人员”)。

  2. 通过本地网络或 USB 连接设备和电脑。

  3. 在浏览器中导航到 Device Portal 页面。 下表显示了每个设备系列使用的端口和协议。

下表包含 WDP 特定于设备的详细信息。

注意

Windows Mixed Reality 在常规桌面上运行,因此它的门户与桌面设备的门户相同。

设备系列 默认启用? HTTP HTTPS USB 说明
桌面版和 IoT 企业版 在开发人员模式内启用 50080* 50043* 不可用 适用于桌面版或 IoT 企业版设备的设备门户
Xbox 在开发人员模式内启用 禁用 11443 不可用 适用于 Xbox 的设备门户
HoloLens 是,处于开发人员模式下 80(默认值) 443(默认值) http://127.0.0.1:10080 适用于 HoloLens 的设备门户
IoT 核心版 是,处于开发人员模式下 8080 通过注册表项启用 不可用 适用于 IoT Core 的设备门户
电话号码 在开发人员模式内启用 80 443 http://127.0.0.1:10080 适用于移动设备的设备门户

* 并非始终是这种情况,桌面上的 Device Portal 声明短暂范围 (>50000) 内的端口以防止与设备上的现有端口声明冲突。 若要了解详细信息,请参阅适用于桌面设备的 Windows 设备门户中的基于注册表的配置部分。

功能

工具栏和导航

页面顶部的工具栏提供对常用功能的访问。

  • 电源:访问电源选项。
    • 关机:关闭设备。
    • 重启:关闭再打开设备的电源。
  • 帮助:打开帮助页面。

使用沿页面左侧的导航窗格中的链接导航到适用于你的设备的可用管理和监视工具。

此处介绍了所有设备系列通用的工具。 根据设备的不同可能提供其他选项。 有关详细信息,请参阅你的设备类型的特定页面。

应用管理器

应用管理器为主机设备上的应用包和捆绑软件提供安装/卸载和管理功能。

Device Portal Apps manager page

  • 部署应用:从本地、网络或 Web 主机部署打包的应用,并从网络共享中注册松散文件。
  • 已安装的应用:使用下拉菜单来删除或启动安装在设备上的应用。
  • 正在运行的应用:获取有关当前正在运行的应用程序的信息,并根据需要将其关闭。

安装(旁加载)应用

可以在开发过程中使用 Windows 设备门户旁加载应用:

  1. 创建应用包后,可以将其远程安装到设备上。 在 Visual Studio 中生成它后,将生成一个输出文件夹。

    App install

  2. 在 Windows 设备门户中,导航到“应用管理器” 页。

  3. 在“部署应用” 部分中,选择“本地存储” 。

  4. 在“选择应用程序包”下 ,选择“选择文件”, 并浏览到要旁加载的应用包。

  5. 在“选择用于对应用包进行签名的证书文件(.cer)” 中,选择“选择文件”, 并浏览到与该应用包关联的证书。

  6. 如果要与应用安装一起安装可选包或框架包,请选中相应的框,然后选择“下一步” 以将其选中。

  7. 选择“安装”启动安装 。

  8. 如果设备在 S 模式下运行 Windows 10,并且这是第一次在设备上安装给定证书,请重新启动设备。

安装证书

或者,可以通过 Windows 设备门户安装证书,并通过其他方式安装应用:

  1. 在 Windows 设备门户中,导航到“应用管理器” 页。

  2. 在“部署应用” 部分中,选择“安装证书” 。

  3. 在“选择用于对应用包进行签名的证书文件(.cer)” 中,选择“选择文件”, 并浏览到与要旁加载的应用包关联的证书。

  4. 选择“安装”启动安装 。

  5. 如果设备在 S 模式下运行 Windows 10,并且这是第一次在设备上安装给定证书,请重新启动设备。

卸载应用

  1. 确保应用未在运行。
  2. 如果应用正在运行,请转到“正在运行的应用”并关闭它 。 如果你尝试在应用正在运行时卸载,则在尝试重新安装应用时会出现问题。
  3. 从下拉列表中选择应用,然后单击“删除” 。

正在运行的进程

此页显示有关主机设备上当前正在运行的进程的详细信息。 这包括应用和系统进程。 在某些平台(桌面设备、IoT 和 HoloLens)上,你可以终止进程。

Device Portal Running processes page

文件资源管理器

在此页上可以查看和操作由任何旁加载应用存储的文件。 请参阅使用应用文件资源管理器博客文章,详细了解文件资源管理器以及如何使用它。

Device Portal File explorer page

性能

“性能”页显示系统诊断信息的实时图形,如电源使用情况、帧速率和 CPU 负载。

可用的指标如下所示:

  • CPU:总可用 CPU 利用率的百分比
  • 内存:总计、已用、已提交、已分页和未分页
  • I/O:读取和写入数据量
  • 网络:接收和发送的数据
  • GPU:总可用 GPU 引擎利用率的百分比

Device Portal Performance page

Windows 事件跟踪 (ETW) 日志记录

ETW 日志记录页管理设备上 Windows 事件跟踪 (ETW) 的实时信息。

Device Portal ETW logging page

选中“隐藏提供程序”以仅显示“事件”列表 。

  • 已注册的提供程序:选择事件提供程序和跟踪级别。 跟踪级别是以下值之一:

    1. 异常退出或终止
    2. 严重错误
    3. 警告
    4. 非错误警告
    5. 详细跟踪

    单击或敲击“启用”以开始跟踪。 提供程序将添加到“已启用的提供程序”下拉列表。

  • 自定义提供程序:选择自定义 ETW 提供程序和跟踪级别。 根据其 GUDI 标识提供程序。 不要在 GUID 中包含括号。

  • 已启用的提供程序:列出已启用的提供程序。 从下拉列表中选择一个提供程序,然后单击或敲击“禁用”可停止跟踪。 单击或敲击“全部停止”会暂停所有跟踪。

  • 提供程序历史记录:显示已在当前会话期间启用的 ETW 提供程序。 单击或敲击“启用”可激活已禁用的提供程序。 单击或敲击“清除”可清除历史记录。

  • 筛选器/事件:“事件” 部分以表格的形式列出来自选定提供程序的 ETW 事件。 此表将实时更新。 使用“筛选器” 菜单设置将显示其事件的自定义筛选器。 单击“清除”按钮可删除表中的所有 ETW 事件 。 这不会禁用任何提供程序。 可以单击“保存到文件”,将当前收集的 ETW 事件导出到本地 CSV 文件 。

有关使用 ETW 日志记录的更多详细信息,请参阅使用设备门户查看调试日志博客文章。

性能跟踪

Windows 性能工具包中有性能跟踪页面,通过它可查看来自主机设备的 Windows 性能记录器 (WPR) 跟踪。

Device Portal performance tracing page

  • 可用配置文件:从下拉列表中选择 WPR 配置文件,然后单击或敲击“开始”以开始跟踪。
  • 自定义配置文件:单击或敲击“浏览”以从电脑中选择 WPR 配置文件。 单击或敲击“上传并启动”以开始跟踪。

若要停止跟踪,请单击“停止” 。 停留在此页面上,直到跟踪文件 (.ETL) 完成下载。

可以打开捕获的 ETL 文件以供在 Windows 性能分析器中进行分析。

设备管理器

“设备管理器”页枚举连接到你的设备的所有外围设备。 可以单击“设置”图标查看每个设备的属性。

Device Portal Device manager page

网络

“网络”页管理设备上的网络连接。 除非你通过 USB 连接到设备门户,否则更改这些设置很可能使你与设备门户断开连接。

  • 可用网络:显示设备可用的 WiFi 网络。 单击或点击某个网络将允许你连接到该网络,并提供密钥(如果需要)。 设备门户尚不支持企业身份验证。 您也可以使用“配置文件” 下拉列表尝试连接到设备已知的任何 WiFi 配置文件。
  • IP 配置:显示有关每个主机设备的网络端口的地址信息。

Device Portal Networking page

服务功能和说明

DNS-SD

Device Portal 使用 DNS-SD 公布其存在于本地网络上。 所有 Device Portal 实例都将在“WDP._wdp._tcp.local”下公布,无论其设备类型如何。 服务实例的 TXT 记录提供以下信息:

类型 说明
S int Device Portal 的安全端口。 如果为 0(零),则表示 Device Portal 不侦听 HTTPS 连接。
D 字符串 设备类型。 这将采用“Windows.*”格式,例如 Windows.Xbox 或 Windows.Desktop
A 字符串 设备体系结构。 这将为 ARM、x86 或 AMD64。
T 字符串的 null 字符分隔列表 用户应用的设备标记。 有关其用法的信息,请参阅标记 REST API。 列表以双 null 结尾。

推荐 HTTPS 端口上的连接,因为并非所有设备都侦听 DNS-SD 记录所公布的 HTTP 端口。

CSRF 保护和脚本

为了防止受到 CSRF 攻击,所有非 GET 请求上都需要唯一的令牌。 此令牌 X-CSRF-Token 请求标头派生自会话 Cookie CSRF-Token。 在 Device Portal Web UI 中,CSRF-Token Cookie 将复制到每个请求的 X-CSRF-Token 标头中。

重要

此保护可防止从独立客户端(例如命令行实用程序)使用 REST API。 这可以通过 3 种方法解决:

  • 使用“auto-”用户名。 将“auto-”置于其用户名前面的客户端将绕过 CSRF 保护。 此用户名不能用于通过浏览器登录到 Device Portal,这一点很重要,因为它将针对 CSRF 攻击打开服务。 例如:如果设备门户的用户名为“admin”,则 curl -u auto-admin:password <args> 应该用于绕过 CSRF 保护。
  • 在客户端中实现 Cookie 到标头的方案。 这需要 GET 请求来建立会话 Cookie,并包含所有后续请求的标头和 Cookie。
  • 禁用身份验证并使用 HTTP。 CSRF 保护仅适用于 HTTPS 终结点,因此 HTTP 终结点上的连接无需执行上述任一操作。

跨站点 WebSocket 劫持 (CSWSH) 保护

若要防止受到 CSWSH 攻击,用于打开对 Device Portal 的 WebSocket 连接的所有客户端还必须提供与主机头匹配的 Origin 标头。 这向 Device Portal 证明了请求来自 Device Portal UI 或有效的客户端应用程序。 如果没有 Origin 标头,将拒绝你的请求。

请参阅

设备门户核心 API 参考