CoseSignTool is a platform-agnostic command line application to create and validate COSE signatures.
CoseHandler is a .NET library of static functions that mirror the functionality of CoseSignTool. Or to put it more accurately, CoseSignTool is a command line shell for CoseHandler.
CoseSignTool and CoseHandler support three commands/methods:
- Sign: Creates a COSE signature for a file or stream. This signature is saved in a separate file from the source payload, but you may optionally include a copy of the source payload in the signature file.
- Validate: Validates that a COSE signature is properly formed, has a valid certificate chain, and matches the source payload or its hash.
- Get: Reads the source payload from a COSE signature and returns the original text, or writes it to file or console.
The CoseSign1, CoseSign1.Abstractions, and CoseSign1.Certicates libraries provide the underlying functionality for CoseSignTool and CoseHandler, and can be called directly for more advanced scenarios.
'COSE' refers to CBOR Object Signing and Encryption, which is the de-facto standard for signing Software Bills of Materials (SBOM). It is also used to provide secure authentication for web and Internet Of Things(IOT) application, and is suitable for signing scripts and other text content. CBOR refers to the Concise Binary Object Representation Internet standard.
The US Executive Order on Improving the Nation’s Cybersecurity of May 12, 2021 requires an SBOM for any software or firmare product in use by the US government. This also includes the libraries and tools those products are built with. Even in consumer software, an SBOM helps you protect your customers from supply chain attacks by enabling you to quickly check the version numbers of all the products in your software supply chain. CoseSignTool, CoseHandler, and the CoseSign1 libraries are the Microsoft solution for signing SBOMs and, we believe, the most powerful and convenient solution currently on the market.
Downloadable versions are available in GitHub releases of this repository. Separate page lists the features and how to use them: CoseSignTool.md.
Download and extract the folder with the compiled binaries, then make CoseSignTool available on the $PATH.
# download and uzip the release
mkdir -p ~/cosesigntool
curl -L https://github.com/microsoft/CoseSignTool/releases/latest/download/CoseSignTool-Linux-release.zip -o ~/cosesigntool/release.zip
unzip ~/cosesigntool/release.zip -d ~/cosesigntool
# move the directory to a stable location
mv ~/cosesigntool/release ~/.local/bin/cosesigntool
export PATH="$PATH":~/.local/bin/cosesigntool
# cleanup of files
rm -rf ~/cosesigntool
# run the binary
CoseSignTool
> *** CoseSignTool ***
> A tool for signing, validating, and getting payload from Cose signatures.See Linux, but make sure to download CoseSignTool-MacOS-release.zip instead.
Similar to Linux or MacOS you could use PowerShell to download the release, extract and move it to the desired location and to add it to the Path like shown in the example below:
PS C:\Users\johndoe> Invoke-WebRequest -Uri https://github.com/microsoft/CoseSignTool/releases/latest/download/CoseSignTool-Windows-release.zip -OutFile C:\Users\johndoe\release.zip
PS C:\Users\johndoe> Expand-Archive C:\Users\johndoe\release.zip -DestinationPath C:\Users\johndoe
PS C:\Users\johndoe> Rename-Item -Path "C:\Users\johndoe\release" -NewName "cosesigntool"
PS C:\Users\johndoe> Move-Item -Path C:\Users\johndoe\cosesigntool -Destination C:\Users\johndoe\AppData\Local\
PS C:\Users\johndoe> $env:Path += ";C:\Users\johndoe\AppData\Local\cosesigntool"
PS C:\Users\johndoe> CoseSignTool
*** CoseSignTool ***
A tool for signing, validating, and getting payload from Cose signatures.Download a specific version from releases. There will be a fully signed version on NuGet.org soon, but this is just a pre-release, so there's only the open source version available for now.
If you have the option of calling it from a .NET application, go to CoseHandler.md You can also use indirect signatures, where the signature can be validated against a hash of the payload content instead of requiring the full payload. For advanced topics such as time stamping, see Advanced
You would like to help? Great! First check to make sure the work isn't already planned, then...
- If you find a bug or have a feature reccomendation, log an issue.
- If you would like to contribute actual code to the repo or comment on the pull requests of others, read our contributor guidelines and style guidelines, and then make your contribution.
This is an alpha release, so there are some planned features that are not yet in the product, and you may encounter some bugs. If you do, please report them here.
The planned work is currently tracked only in an internal Microsoft ADO instance but will be moved to Github Issues soon. In the meantime, here is some of the work currently planned.
- Add suport for SCITT time stamping
- Enable specifying a mandatory cert chain root for validation
- Simplify digest signing scenario
- Support batch operations in CoseSignTool to reduce file and cert store reads
- Publish single file version of CoseSignTool
- Cache certificate store reads for faster performance
- Ensure type safety on cert store and file reads
- Investigate specific compilation by platform for possible performance gains
- Expand code coverage in unit and integration tests
- Enable secure strings for manual password entry
- Move work item tracking to public Github repo
- Re-organize the CoseSignTool unit tests for better readability
CoseSignTool runs on .NET 8. It depends on the libraries from this package and Microsoft.Extensions.Configuration.CommandLine from NuGet package version 7.0.0.
The libraries depend on System.Formats.Cbor version 7.0.0, System.Security.Cryptography.Cose version 7.0.0, and System.Runtime.Caching version 7.0.0 via NuGet package. Do not attempt to use later versions of System.Formats.Cbor or System.Security.Cryptography.Cose, as this breaks some of the fundamental data structures the libraries depend on.
The API libraries all run on .NET Standard 2.0.
This project may contain trademarks or logos for projects, products, or services. Authorized use of Microsoft trademarks or logos is subject to and must follow Microsoft’s Trademark & Brand Guidelines. Use of Microsoft trademarks or logos in modified versions of this project must not cause confusion or imply Microsoft sponsorship. Any use of third-party trademarks or logos are subject to those third-party’s policies.