windows-drivers-rs

此仓库是Rust crates的集合，使开发人员能够使用Rust开发Windows驱动程序。目的是支持WDM和WDF驱动程序开发模型。此仓库包含以下crate

• wdk-build：一个库，用于配置Cargo构建脚本来生成绑定和WDK（Windows驱动程序包）的下游链接。虽然此crate是为不同的WDK发布和不同的WDF版本编写的，但它目前仅针对NI eWDK、KMDF 1.33、UMDF 2.33和WDM驱动程序进行了测试。可能缺少旧DDK的链接器选项。
• wdk-sys：直接FFI绑定到Windows开发工具包（WDK）中可用的API。这包括来自bindgen的自动生成的ffi绑定，以及bindgen无法生成的宏的手动重新实现。
• wdk：对Windows开发工具包（WDK）中可用的API的优雅绑定
• wdk-panic：使用WDK构建的程序默认的panic处理器实现
• wdk-alloc：对使用Windows开发工具包（WDK）编译的二进制文件的分配支持
• wdk-macros：一组宏，有助于使与wdk-sys的直接绑定交互更加容易。此crate通过wdk-sys重新导出，crate通常不需要直接依赖于wdk-macros

要查看此仓库用于创建驱动程序的示例，请参阅 Windows-rust-driver-samples。

注意：此项目尚处于开发初期阶段，不建议用于生产环境。我们鼓励社区进行实验、提出建议和讨论！我们将使用我们的GitHub 讨论论坛作为与社区互动的主要方式！

支持的配置

该项目是在考虑到支持WDM、KMDF和UMDF驱动程序以及Win32服务的情况下构建的，包括对WDK 22H2及更高版本中包含的所有WDF版本的支持。目前，在crates.io上可用的crate只支持KMDF v1.33，但可以通过克隆windows-drivers-rs并修改build.rs中指定的wdk-sys来生成其他所有内容的绑定。计划在不久的将来为其他WDK配置提供Crates.io支持。

入门

构建要求

• 通过bindgen生成绑定需要libclang。获取它的最简单方法是使用winget

  • winget-安装LLVM.LLVM
    • 确保您选择GUI选项以将LLVM添加到PATH

• 要执行构建后的任务（例如inf2cat、infverif等），使用cargo make

  • cargo安装 --锁定cargo-make --无默认功能 --功能tls-native

• 使用WDK构建程序还需要在有效的WDK环境中。推荐的做法是进入eWDK开发提示符

将windows-drivers-rs添加到您的驱动程序包中

此存储库中的crate可以从crates.io获取，但请考虑支持的配置中概述的当前限制。如果您需要支持不同的配置，请尝试克隆此存储库并使用路径依赖关系

1. 创建一个新的带有lib crate的Cargo包

   cargo new <driver_name> --lib
   

2. 在windows-drivers-rs crate上添加依赖关系

   cd <driver_name>
   cargo add --build wdk-build
   cargo add wdk wdk-sys wdk-alloc wdk-panic
   

3. 通过在Cargo.toml中添加以下片段将crate类型设置为cdylib

   [lib]
   crate-type = ["cdylib"]
   

4. 通过wdk元数据部分将crate标记为驱动程序。这使cargo-make任务知道该包是驱动程序，并且需要运行驱动程序打包步骤。

   [package.metadata.wdk]
   

5. 在Cargo.toml中将crate panic策略设置为abort

   [profile.dev]
   panic = "abort"
   lto = true # optional setting to enable Link Time Optimizations
   
   [profile.release]
   panic = "abort"
   lto = true # optional setting to enable Link Time Optimizations
   

6. 创建一个build.rs并添加以下片段

   fn main() -> Result<(), wdk_build::ConfigError> {
      wdk_build::Config::from_env_auto()?.configure_binary_build();
      Ok(())
   }
   

7. 在lib.rs中将您的驱动程序crate标记为no_std

   #![no_std]
   

8. 在lib.rs中添加panic处理程序

   #[cfg(not(test))]
   extern crate wdk_panic;
   
   

9. 可选：在lib.rs中添加全局分配器

   #[cfg(not(test))]
   use wdk_alloc::WDKAllocator;
   
   #[cfg(not(test))]
   #[global_allocator]
   static GLOBAL_ALLOCATOR: WDKAllocator = WDKAllocator;
   

   这仅当您想要使用rust标准库中的alloc模块时才需要。您也可以使用自己的全局分配器实现。

10. 在lib.rs中添加DriverEntry

use wdk_sys::{
   DRIVER_OBJECT,
   NTSTATUS,
   PCUNICODE_STRING,
};

#[export_name = "DriverEntry"] // WDF expects a symbol with the name DriverEntry
pub unsafe extern "system" fn driver_entry(
   driver: &mut DRIVER_OBJECT,
   registry_path: PCUNICODE_STRING,
) -> NTSTATUS {
   0
}

11. 添加Makefile.toml

extend = "target/rust-driver-makefile.toml"

[env]
CARGO_MAKE_EXTEND_WORKSPACE_MAKEFILE = true

[config]
load_script = '''
#!@rust
//! ```cargo
//! [dependencies]
//! wdk-build = "0.2.0"
//! ```
#![allow(unused_doc_comments)]

wdk_build::cargo_make::load_rust_driver_makefile()?
'''

12. 添加一个与您的cdylib crate名称匹配的inx文件。

13. 构建驱动程序

cargo make

将生成一个签名驱动程序包，包括一个 WDRLocalTestCert.cer 文件，并将其放在 target/<Cargo配置文件>/package。如果指定了特定的目标架构，驱动程序包将生成在 target/<目标架构>/<Cargo配置文件>/package

Cargo Make

cargo-make 用于简化使用 windows-drivers-rs 的构建过程，包括执行构建后的驱动程序打包步骤。

执行默认操作（构建并打包驱动程序）

cargomake default

执行默认任务时，只需运行 cargo make 即可，因为默认任务已经隐含。

参数转发

windows-drivers-rs 扩展了 cargo make，以便将特定参数转发到底层的 cargo 命令。为了指定要转发的参数，必须在明确指定 （即对于 default 任务不支持省略名称） cargo-make 任务名称之后提供。

示例

对于特定目标

cargomake default --target <目标三元组>

发布构建

cargo make default --release 或 cargo make default --profile release

指定特定功能

cargomake default --feature <功能>

指定特定的 Rust 工具链

cargomake default +<工具链>

显示帮助并查看支持转发到 Cargo 的完整 CLI 参数列表

cargomake help

驱动程序包签名验证

可以通过将 WDK_BUILD_ENABLE_SIGNTOOL_VERIFY cargo-make 环境变量 设置为 true 来启用处理生成的 .sys 和 .cat 文件签名验证的任务。要使 signtool verify 正常工作，证书必须安装为 受信任的根证书颁发机构 的一部分。这些任务默认不启用，因为 WDR 的默认行为是使用生成的测试证书进行签名。这些测试证书通常仅安装在专用于测试驱动程序的计算机上的 受信任的根证书颁发机构，而不是个人开发机器，因为安装自己的根证书存在安全风险。

如果您理解这些含义并已安装测试证书，则可以按照以下方式验证签名

cargo make --env WDK_BUILD_ENABLE_SIGNTOOL_VERIFY=true

Crates.io 发布策略

在合并更改到 main 之后不会立即向 crates.io 发布。只有在社区请求或 windows-drivers-rs 团队认为发布具有足够价值时，才会进行发布。

商标声明

商标