docs: enhance cargo-wdk README with signing and verification details #608
Conversation
krishnakumar4a4
changed the title
There was a problem hiding this comment.
Pull request overview
This pull request enhances the README documentation for the cargo-wdk tool by reorganizing and expanding the signing and verification sections. The changes split the combined "Signing and Verification" section into separate sections and add a new section with detailed instructions for installing self-signed certificates on target machines.
Changes:
- Split "Signing and Verification" into separate "Signing" and "Verification" sections for improved clarity
- Enhanced signing section with details about certificate location checking and automatic certificate generation
- Added new "Installing self signed certificate (non-prod case)" section with step-by-step installation instructions
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| #### Installing self signed certificate (non-prod case) | ||
|
|
||
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with self signed certificate instead of production certificate (CA issued). We need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. |
There was a problem hiding this comment.
This sentence is incomplete and grammatically incorrect. There's a period after "CA issued" that should either be a comma, or the sentence should be restructured. Consider revising to: "Since the driver and catalog files are signed with a self-signed certificate instead of a production certificate (CA issued), we need to manually add a copy of this certificate in the Trusted Root Certification Authorities store on the target machine where you want to install the driver."
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with self signed certificate instead of production certificate (CA issued). We need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. | |
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self-signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with a self-signed certificate instead of a production certificate (CA issued), we need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. |
| #### Installing self signed certificate (non-prod case) | ||
|
|
||
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with self signed certificate instead of production certificate (CA issued). We need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. |
There was a problem hiding this comment.
There's an inconsistency in hyphenation: "self signed" should be "self-signed" to match the usage in the rest of the document (see line 95 where "self-signed certificate" is correctly hyphenated). The term should be consistently hyphenated throughout.
| #### Installing self signed certificate (non-prod case) | |
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with self signed certificate instead of production certificate (CA issued). We need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. | |
| #### Installing self-signed certificate (non-prod case) | |
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self-signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with self-signed certificate instead of production certificate (CA issued). We need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. |
|
|
||
| To install the certificate on Windows, double‑click the certificate file and choose "Install Certificate". In the wizard, select the store location (Local Machine is recommended), choose "Place all certificates in the following store", browse to "Trusted Root Certification Authorities", then complete the wizard. | ||
|
|
||
|
|
There was a problem hiding this comment.
There's an extra blank line here. The document should maintain consistent spacing. In other parts of the README, there's only one blank line between sections.
|
|
||
| The driver package that gets generated at `target\<profile>\<project-name>-package` post build also includes the self signed certificate `WDRLocalTestCert.cer`. Since the driver and catalog files are signed with self signed certificate instead of production certificate (CA issued). We need to manually add a copy of this certificate in the `Trusted Root Certification Authorities` store on the target machine where you want to install the driver. | ||
|
|
||
| To install the certificate on Windows, double‑click the certificate file and choose "Install Certificate". In the wizard, select the store location (Local Machine is recommended), choose "Place all certificates in the following store", browse to "Trusted Root Certification Authorities", then complete the wizard. |
There was a problem hiding this comment.
The non-standard character '‑' (non-breaking hyphen, Unicode U+2011) is used in "double‑click" instead of a standard hyphen '-'. This should be replaced with a standard ASCII hyphen for consistency and to avoid potential rendering issues in different contexts.
| To install the certificate on Windows, double‑click the certificate file and choose "Install Certificate". In the wizard, select the store location (Local Machine is recommended), choose "Place all certificates in the following store", browse to "Trusted Root Certification Authorities", then complete the wizard. | |
| To install the certificate on Windows, double-click the certificate file and choose "Install Certificate". In the wizard, select the store location (Local Machine is recommended), choose "Place all certificates in the following store", browse to "Trusted Root Certification Authorities", then complete the wizard. |
|
|
||
| If no certificate is found, `build` automatically creates a self-signed certificate, uses it for signing, and adds it to `WDRTestCertStore` for reuse in subsequent builds. | ||
|
|
||
| #### Verification |
There was a problem hiding this comment.
| #### Verification | |
| #### Signature Verification |
Better to explicitly state what kind of verification it is since it is no longer part of a heading that has the word "Signing" in it.
Codecov Report✅ All modified and coverable lines are covered by tests.
Additional details and impacted files@@ Coverage Diff @@
## main #608 +/- ##
==========================================
- Coverage 82.66% 77.41% -5.26%
==========================================
Files 25 24 -1
Lines 7137 4853 -2284
Branches 7137 4853 -2284
==========================================
- Hits 5900 3757 -2143
+ Misses 1108 979 -129
+ Partials 129 117 -12 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
|
@copilot create a new commit to apply changes based on the comments in this thread |
3 participants
This pull request updates the documentation in
crates/cargo-wdk/README.mdto clarify and expand instructions related to driver signing, signature verification, and installing self-signed certificates. The changes provide more detailed guidance for users working with self-signed certificates and explain the manual steps required for verification and installation.Documentation improvements:
buildlocates or generates the signing certificate (WDRLocalTestCert) in theWDRTestCertStore, and noted that the certificate is included in the driver package output.WDRLocalTestCert.certo the "Trusted Root Certification Authorities" store on Windows.