Skip to content

docs: Name the timestamp protocol Set-AuthenticodeSignature actually uses #198

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

Merged
tablackburn merged 1 commit into from
Aug 28, 2026
+13 −2
Merged

docs: Name the timestamp protocol Set-AuthenticodeSignature actually uses #198

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 12 additions & 1 deletion PowerShellBuild/build.properties.ps1
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@
# Whether to overwrite existing markdown files and use comment based help as the source of truth
Overwrite = $false

# Exclude the parameters marked with `DontShow` in the parameter attribute from the help content.

Check warning on line 130 in PowerShellBuild/build.properties.ps1

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (Dont) Suggestions: (dent, dint, doit, dolt, dona)
# Value passed to New-MarkdownCommandHelp.
ExcludeDontShow = $false

Expand Down Expand Up @@ -171,10 +171,10 @@

# Name of the environment variable that holds the Base64-encoded PFX certificate.
# Used by the EnvVar source and as the presence-detection key for Auto.
CertificateEnvVar = 'SIGNCERTIFICATE'

Check warning on line 174 in PowerShellBuild/build.properties.ps1

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (SIGNCERTIFICATE)

# Name of the environment variable that holds the PFX password (EnvVar source).
CertificatePasswordEnvVar = 'CERTIFICATEPASSWORD'

Check warning on line 177 in PowerShellBuild/build.properties.ps1

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (CERTIFICATEPASSWORD)

# File system path to a PFX/P12 certificate file (PfxFile source).
PfxFilePath = $null
Expand Down Expand Up @@ -207,7 +207,18 @@
# rather than a check layered on afterwards.
SkipCertificateValidation = $false

# RFC 3161 timestamp server URI embedded in Authenticode signatures.
# Timestamp server URI embedded in Authenticode signatures, so a signature
# stays valid after the signing certificate expires.
#
# This is passed to Set-AuthenticodeSignature -TimestampServer, which uses the
# legacy Authenticode timestamp protocol -- the timestamp lands in the signature
# as a PKCS#9 counter-signature (1.2.840.113549.1.9.6), not as an RFC 3161 token

Check warning on line 215 in PowerShellBuild/build.properties.ps1

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (PKCS) Suggestions: (pacs, pecs, pics, Pecs, pcs)
# (1.3.6.1.4.1.311.3.3.1). That is signtool's /t rather than /tr. Verified on both

Check warning on line 216 in PowerShellBuild/build.properties.ps1

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (signtool's) Suggestions: (signor's, signal's, signora's, signpost's, signatory's)
# PowerShell 7 and Windows PowerShell 5.1; see psake/PowerShellBuild#196.
#
# It matters when choosing a different provider: several publish separate
# endpoints for the two protocols, and an RFC 3161 only endpoint will not answer
# this request. The default below serves both.
TimestampServer = 'http://timestamp.digicert.com'

# Authenticode hash algorithm. Valid values: SHA256, SHA384, SHA512, SHA1.
Expand Down
2 changes: 1 addition & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
> example.

<p align="center">
<img src="media/psaketaskmodule-256x256.png" alt="Logo">

Check warning on line 28 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (psaketaskmodule)
</p>

## Status - Work in progress
Expand Down Expand Up @@ -90,10 +90,10 @@
| Setting | Default value | Description |
|-------------------------------------------------------------|---------------------------------------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
| $PSBPreference.General.ProjectRoot | `$env:BHProjectPath` | Root directory for the project |
| $PSBPreference.General.SrcRootDir | `$env:BHPSModulePath` | Root directory for the module |

Check warning on line 93 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| $PSBPreference.General.ModuleName | `$env:BHProjectName` | The name of the module. This should match the basename of the PSD1 file |
| $PSBPreference.General.ModuleVersion | `\<computed>` | The version of the module |
| $PSBPreference.General.ModuleManifestPath | `$env:BHPSModuleManifest` | Path to the module manifest (PSD1) |

Check warning on line 96 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (BHPS) Suggestions: (baps, bops, bhp, BHP, bps)
| $PSBPreference.Build.OutDir | `$projectRoot/Output` | Output directory when building the module |
| $PSBPreference.Build.ModuleOutDir | `$outDir/$moduleName/$moduleVersion` | `For internal use only. Do not overwrite. Use '$PSBPreference.Build.OutDir' to set output directory` |
| $PSBPreference.Build.CompileModule | `$false` | Controls whether to "compile" module into single PSM1 or not |
Expand Down Expand Up @@ -124,10 +124,10 @@
| $PSBPreference.Help.ConvertReadMeToAboutHelp | `$false` | Convert project readme into the module about file |
| $PSBPreference.Docs.RootDir | `$projectRoot/docs` | Directory PlatyPS markdown documentation will be saved to. Other content in this directory, such as a README or an images folder, is left alone. |
| $PSBPreference.Docs.Overwrite | `$false` | Overwrite the markdown files in the docs folder using the comment based help as the source of truth. |
| $PSBPreference.Docs.ExcludeDontShow | `$false` | Exclude the parameters marked with `DontShow` in the parameter attribute from the help content. |

Check warning on line 127 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (Dont) Suggestions: (dent, dint, doit, dolt, dona)
| $PSBPreference.Docs.UseFullTypeName | `$false` | Indicates that the target document will use a full type name instead of a short name for parameters. |
| $PSBPreference.Publish.PSRepository | `PSGallery` | PowerShell repository name to publish |
| $PSBPreference.Publish.PSRepositoryApiKey | `$env:PSGALLERY_API_KEY` | API key to authenticate to PowerShell repository with |

Check warning on line 130 in README.md

View workflow job for this annotation

GitHub Actions / CI / Run Linters 

Unknown word (PSGALLERY) Suggestions: (psaltery, spaller, psaltry, psalter, psalters)
| $PSBPreference.Publish.PSRepositoryCredential | `$null` | Credential to authenticate to PowerShell repository with. Overrides `$psRepositoryApiKey` if defined |
| $PSBPreference.Sign.Enabled | `$false` | Enable/disable Authenticode signing of the built module. Must be `$true` for any of the signing or catalog tasks to run. |
| $PSBPreference.Sign.CertificateSource | `Auto` | How the code-signing certificate is resolved. Valid values are `Auto`, `Store`, `Thumbprint`, `EnvVar`, and `PfxFile`. See [Code signing](#code-signing). |
Expand All @@ -139,7 +139,7 @@
| $PSBPreference.Sign.PfxFilePassword | `$null` | Password for the PFX/P12 file as a `SecureString`. Used by the `PfxFile` certificate source. |
| $PSBPreference.Sign.Certificate | `$null` | A pre-resolved `X509Certificate2` object to sign with. When set, `CertificateSource` is ignored, which suits Azure Key Vault, an HSM, or another custom provider. |
| $PSBPreference.Sign.SkipCertificateValidation | `$false` | Relax certificate validity checking. Skips every check for `EnvVar` and `PfxFile`, private key included. See [Code signing](#code-signing). |
| $PSBPreference.Sign.TimestampServer | `http://timestamp.digicert.com` | RFC 3161 timestamp server URI embedded in the signature so that it stays valid after the certificate expires. |
| $PSBPreference.Sign.TimestampServer | `http://timestamp.digicert.com` | Timestamp server URI embedded in the signature so it stays valid after the certificate expires. Legacy Authenticode protocol, not RFC 3161. |
| $PSBPreference.Sign.HashAlgorithm | `SHA256` | Authenticode hash algorithm. Valid values are `SHA256`, `SHA384`, `SHA512`, and `SHA1`. `SHA1` is deprecated. |
| $PSBPreference.Sign.FilesToSign | `@('*.psd1', '*.psm1', '*.ps1')` | Glob patterns of file names to sign, searched recursively under the module output directory. |
| $PSBPreference.Sign.Catalog.Enabled | `$false` | Enable/disable creation and signing of a Windows catalog (`.cat`) file. Also requires `$PSBPreference.Sign.Enabled` to be `$true`. |
Expand Down
Loading