windows-drivers-rs

该仓库是Rust crate的集合，使开发者能够使用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：对Windows开发工具包（WDK）中可用的API的直接FFI绑定。这包括从 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 配置。

入门

构建要求

• 通过 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. 创建一个新的 Cargo 包，包含 lib crate

   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
}

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()?
'''

cargo make

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

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

cargomake default

执行默认任务时，只需cargo make即可，因为default任务默认是隐含的。

参数转发

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

示例

对于特定目标

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 发布策略

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

商标声明

商标本项目可能包含项目、产品或服务的商标或徽标。Microsoft商标或徽标的授权使用必须遵守Microsoft的商标和品牌指南。在此项目的修改版本中使用Microsoft商标或徽标不得引起混淆或暗示Microsoft的赞助。任何第三方商标或徽标的用途均受该第三方政策约束。