From 857df4086f0ce448ed9e581b96b6e8abc768ebb6 Mon Sep 17 00:00:00 2001
From: Alexandr Stelnykovych <stenya@gmail.com>
Date: Tue, 28 Jan 2025 14:26:44 +0200
Subject: [PATCH] [kext] Fix dev build documentation (releasing procedure)
---
windows_kext/README.md | 4 +++
windows_kext/release/README.md | 34 ++++++++++++--------
windows_kext/release/src/main.rs | 10 ++++--
windows_kext/release/templates/build_cab.ps1 | 2 +-
4 files changed, 32 insertions(+), 18 deletions(-)
diff --git a/windows_kext/README.md b/windows_kext/README.md
index 0e4daa80..4d2628b9 100644
--- a/windows_kext/README.md
+++ b/windows_kext/README.md
@@ -9,6 +9,10 @@ Implementation of Safing's Portmaster Windows kernel extension in Rust.
- [Release](release/README.md) -> Guide how to do a release build.
- [Windows Filtering Platform - MS](https://learn.microsoft.com/en-us/windows-hardware/drivers/network/roadmap-for-developing-wfp-callout-drivers) -> The driver is build on top of WFP.
+### Building (For release)
+
+Please refer to [release/README.md](release/README.md) for details about the release procedure.
+
### Building (For testing and development)
The Windows Portmaster Kernel Extension is currently only developed and tested for the amd64 (64-bit) architecture.
diff --git a/windows_kext/release/README.md b/windows_kext/release/README.md
index 319bbd2c..d9e7692a 100644
--- a/windows_kext/release/README.md
+++ b/windows_kext/release/README.md
@@ -1,25 +1,31 @@
# Kext release tool
-### Generate the zip file
+## Generate the zip file
+
+- Make sure the deriver version in `kextinterface/version.txt` is up to date
-- Make sure `kextinterface/version.txt` is up to date
- Execute: `cargo run`
- * This will generate release `kext_release_vX-X-X.zip` file. Which contains all the necessary files to make the release.
+ _This will generate release `portmaster-kext-release-bundle-vX-X-X-X.zip` file. Which contains all the necessary files to make the release._
-### Generate the cab file
+## Generate the cab file
-- Copy the zip and extract it on a windows machine.
- * Visual Studio 2022 and WDK need to be installed.
-- From VS Command Prompt / PowerShell run:
-```
-cd kext_release_v.../
-./build_cab.bat
-```
-> Script is written for VS `$SDK_Version = "10.0.22621.0"`. If different version is used update the script.
+ **Precondition:** Visual Studio 2022 and WDK need to be installed.
-- Sing the cab file
+- copy the zip and extract it on a windows machine.
-### Let Microsoft Sign
+- update `.\build_cab.ps1`: set correct SDK version you use.
+ _e.g.: $SDK_Version = "10.0.26100.0" (see in `C:\Program Files (x86)\Windows Kits\10\Lib`)_
+
+- Use "Developer PowerShell for VS":
+
+ ```powershell
+ cd portmaster-kext-release-bundle-v...
+ .\build_cab.ps1
+ ```
+
+- Sing the the output cab file: `portmaster-kext-release-bundle-v...\PortmasterKext_v....cab`
+
+## Let Microsoft Sign
- Go to https://partner.microsoft.com/en-us/dashboard/hardware/driver/New
- Enter "PortmasterKext vX.X.X #1" as the product name
diff --git a/windows_kext/release/src/main.rs b/windows_kext/release/src/main.rs
index b956322f..81bf1e81 100644
--- a/windows_kext/release/src/main.rs
+++ b/windows_kext/release/src/main.rs
@@ -10,13 +10,17 @@ static LIB_PATH: &'static str = "./build/x86_64-pc-windows-msvc/release/driver.l
fn main() {
build_driver();
- println!(
- "Building kext v{}-{}-{} #{}",
+
+ let filename = format!(
+ "portmaster-kext-release-bundle-v{}-{}-{}-{}.zip",
VERSION[0], VERSION[1], VERSION[2], VERSION[3]
);
+ println!("Building KEXT: {}", filename);
+
// Create Zip that will hold all the release files and scripts.
- let file = File::create("portmaster-kext-release-bundle.zip").unwrap();
+ let file = File::create(&filename).unwrap();
+
let mut zip = zip::ZipWriter::new(file);
// Write files to zip
diff --git a/windows_kext/release/templates/build_cab.ps1 b/windows_kext/release/templates/build_cab.ps1
index aefce048..802a4103 100644
--- a/windows_kext/release/templates/build_cab.ps1
+++ b/windows_kext/release/templates/build_cab.ps1
@@ -1,7 +1,7 @@
# Remove previous cab build
Remove-Item -Path "PortmasterKext_v2-0-0.cab" -ErrorAction SilentlyContinue
-$SDK_Version = "10.0.22621.0"
+$SDK_Version = "10.0.26100.0"
# Build metadata file
rc -I "C:\Program Files (x86)\Windows Kits\10\Include\$SDK_Version\um" `