Skip to content

feat(cargo-wdk): support hyphen-prefixed signtool args #737

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
Shravan Vasista (svasista-ms) wants to merge 2 commits into
base: main
Choose a base branch
from
+47 −46
Open

feat(cargo-wdk): support hyphen-prefixed signtool args #737

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
9acf0be
feat(cargo-wdk): enable `allow_hyphen_values` for `--signtool-args` a…
svasista-ms Sep 11, 2026
b91932b
fix(cargo-wdk): redact hyphen-prefixed signtool passwords
svasista-ms Sep 11, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
77 changes: 40 additions & 37 deletions crates/cargo-wdk/src/actions/build/package_task.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ pub enum SignMode {
/// certificate and default switches. When non-empty, auto generation
/// is skipped and the caller owns the full signtool command line
/// (certificate selection, digest, etc.).
signtool_args: Vec<String>,
signtool_args: Option<Vec<String>>,
},
}

Expand Down Expand Up @@ -288,25 +288,26 @@ impl<'a> PackageTask<'a> {
info!("Sign mode is 'off'; skipping signing");
return Ok(());
};
let sign_args = if signtool_args.is_empty() {
self.generate_certificate()?;
self.copy(&self.src_cert_file_path, &self.dest_cert_file_path)?;
// Default WDR test-cert switches.
[
"/v",
"/s",
WDR_TEST_CERT_STORE,
"/n",
WDR_LOCAL_TEST_CERT,
"/t",
DEFAULT_TIMESTAMP_URL,
"/fd",
"SHA256",
]
.map(ToString::to_string)
.to_vec()
} else {
signtool_args.clone()
let sign_args = match signtool_args {
Some(args) if !args.is_empty() => args.clone(),

@gurry Gurinder Singh (gurry) Sep 17, 2026

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do empty custom args make sense for signtool? If yes, then we should not have the if !args.is_empty() check

_ => {
self.generate_certificate()?;
self.copy(&self.src_cert_file_path, &self.dest_cert_file_path)?;
// Default WDR test-cert switches.
[
"/v",
"/s",
WDR_TEST_CERT_STORE,
"/n",
WDR_LOCAL_TEST_CERT,
"/t",
DEFAULT_TIMESTAMP_URL,
"/fd",
"SHA256",
]
.map(ToString::to_string)
.to_vec()
}
};
self.run_signtool_sign(&self.dest_driver_binary_path, &sign_args)?;
self.run_signtool_sign(&self.dest_cat_file_path, &sign_args)?;
Expand Down Expand Up @@ -555,17 +556,19 @@ impl<'a> PackageTask<'a> {

let arg_refs: Vec<&str> = args.iter().map(String::as_str).collect();

// Determine the indices of password values (the token right after each
// `/p`) so they can be redacted by `run_with_redaction` in the logs.
// `value_index < file_operand_index` ensures a value token
// actually follows `/p` and that it is never the trailing file operand.
// Determine the indices of password values so they can be redacted by
// `run_with_redaction` in the logs.
// `value_index < file_operand_index` ensures a value token actually
// follows `-p` or `/p` and that it is never the trailing file operand.
let file_operand_index = arg_refs.len() - 1;
let redaction_indices: Vec<usize> = arg_refs
.iter()
.enumerate()
.filter_map(|(i, arg)| {
let value_index = i + 1;
(arg.eq_ignore_ascii_case("/p") && value_index < file_operand_index)
(arg.strip_prefix(['-', '/'])
.is_some_and(|arg| arg.eq_ignore_ascii_case("p"))
&& value_index < file_operand_index)
.then_some(value_index)
})
.collect();
Expand Down Expand Up @@ -724,7 +727,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: None,
target_platform: TargetPlatform::Universal,
Expand All @@ -740,7 +743,7 @@ mod tests {
task.sign_mode,
SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
}
);
assert!(!task.sample_class);
Expand Down Expand Up @@ -793,7 +796,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: None,
target_platform: TargetPlatform::Universal,
Expand Down Expand Up @@ -824,7 +827,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: None,
target_platform: TargetPlatform::Universal,
Expand Down Expand Up @@ -864,7 +867,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: None,
target_platform: TargetPlatform::Universal,
Expand Down Expand Up @@ -922,7 +925,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: None,
target_platform: TargetPlatform::Universal,
Expand Down Expand Up @@ -967,7 +970,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: Some(Vec::new()),
target_platform: TargetPlatform::Universal,
Expand Down Expand Up @@ -1009,7 +1012,7 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
inf2cat_args: Some(vec![
"/os:10_x64,10_CO_X64".to_string(),
Expand Down Expand Up @@ -1182,7 +1185,7 @@ mod tests {
"sign",
"/f",
"cert.pfx",
"/P",
"-P",
"secret",
"/fd",
"SHA256",
Expand All @@ -1200,7 +1203,7 @@ mod tests {
let signtool_args = [
"/f".to_string(),
"cert.pfx".to_string(),
"/P".to_string(),
"-P".to_string(),
"secret".to_string(),
"/fd".to_string(),
"SHA256".to_string(),
Expand Down Expand Up @@ -1260,14 +1263,14 @@ mod tests {
sample_class: false,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: vec![
signtool_args: Some(vec![
"/s".to_string(),
"MyStore".to_string(),
"/n".to_string(),
"MyCert".to_string(),
"/fd".to_string(),
"SHA256".to_string(),
],
]),
},
inf2cat_args: None,
target_platform: TargetPlatform::Universal,
Expand Down
2 changes: 1 addition & 1 deletion crates/cargo-wdk/src/actions/build/tests.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1719,7 +1719,7 @@
let run_result = build_action.expect("Failed to init build action").run();
assert!(
run_result.is_ok(),
"build action failed unexpectedly: {run_result:?}"

Check failure

Code scanning / CodeQL

Cleartext logging of sensitive information High test

This operation writes
self.generate_certificate()
Loading
to a log file.
);
}

Expand Down Expand Up @@ -1792,7 +1792,7 @@
let run_result = run_build_action(build_action);
assert!(
run_result.is_ok(),
"build action with env failed unexpectedly: {run_result:?}"

Check failure

Code scanning / CodeQL

Cleartext logging of sensitive information High test

This operation writes
self.generate_certificate()
Loading
to a log file.
);
}

Expand Down Expand Up @@ -1841,7 +1841,7 @@
sample_class,
sign_mode: SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
},
locked: false,
features: Features::default(),
Expand Down
12 changes: 5 additions & 7 deletions crates/cargo-wdk/src/cli.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,8 @@ pub struct BuildArgs {
#[arg(
long,
value_name = "ARGS",
// `signtool` args can be `-` prefixed.
allow_hyphen_values = true,
Comment thread
svasista-ms marked this conversation as resolved.
value_parser = parse_passthrough_args,
help_heading = "Driver Signing"
)]
Expand Down Expand Up @@ -198,11 +200,7 @@ impl BuildArgs {
}
SignModeArg::Test => Ok(SignMode::Test {
verify_signature: self.verify_signature,
signtool_args: self
.signtool_args
.clone()
.map(|parsed| parsed.0)
.unwrap_or_default(),
signtool_args: self.signtool_args.clone().map(|parsed| parsed.0),
}),
}
}
Expand Down Expand Up @@ -514,7 +512,7 @@ mod tests {
args.sign_mode().expect("mapping should succeed"),
SignMode::Test {
verify_signature: false,
signtool_args: Vec::new(),
signtool_args: None,
}
);
}
Expand All @@ -527,7 +525,7 @@ mod tests {
args.sign_mode().expect("mapping should succeed"),
SignMode::Test {
verify_signature: true,
signtool_args: vec!["/fd".to_string(), "SHA256".to_string()],
signtool_args: Some(vec!["/fd".to_string(), "SHA256".to_string()]),
}
);
}
Expand Down
2 changes: 1 addition & 1 deletion crates/cargo-wdk/tests/build_command_test.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -470,7 +470,7 @@ mod signtool_args {
&project_path,
Some(&[
"--signtool-args",
"/s WDRCustomTestStore /n WDRCustomTestCert /fd SHA256",
"-s WDRCustomTestStore /n WDRCustomTestCert -fd SHA256",
]),
None,
);
Expand Down
Loading