Rust bindings to the microsoft/ms-tpm-20-ref C library.
All features are disabled by default.
vendored- Compile OpenSSL from source (corresponds toopenssl/vendored)
If no pre-compiled libtpm.a is specified by setting the TPM_LIB_DIR env-var,
this crate will compile microsoft/ms-tpm-20-ref from source. Thankfully, that
code is plain C, without any additional external dependencies, and so long as
you have a C compiler installed, the build script should be able to build it
without issue.
That said, building OpenSSL may be a bit more tricky. See the openssl crate
documentation for instructions on how to build + link against OpenSSL:
https://docs.rs/openssl/latest/openssl/#building
This crate is NOT associated with the https://github.com/tpm-rs project.
This crate wraps the existing C-based TPM codebase, only rewriting the generic "platform" layer in Rust, without porting the underlying "engine" to Rust.
For a pure Rust implementation of the TPM 2.0 specification, see (and support!) the effort over at https://github.com/tpm-rs/tpm-rs.
At this time, the only supported version of microsoft/ms-tpm-20-ref that this
crate can compile + link against is revision 1.38.
This particular revision was selected in order to maintain compatibility with the vTPM device used in Hyper-V.
In the future, this crate may be updated to support compiling + linking against
alternate versions of microsoft/ms-tpm-20-ref, though at this time, there is
no concrete roadmap as to when that is going to happen.
If you are interested in extending ms-tpm-20-ref-rs to work with multiple
alternate versions of microsoft/ms-tpm-20-ref, please feel free to reach out
by opening a GitHub Issue.
While the underlying microsoft/ms-tpm-20-ref library does support multiple
different crypto backends, at this time, the only supported crypto backend is
OpenSSL 3.x.
This particular backend was selected in order to seamlessly integrate
ms-tpm-20-ref-rs into a larger codebase that was already using OpenSSL 3.x.
In the future, this crate may be updated to support linking against alternate crypto backends, though at this time, there is no concrete roadmap as to when that is going to happen.
If you are interested in extending ms-tpm-20-ref-rs to work with
alternate crypto backends, please feel free to reach out by opening a
GitHub Issue.
At this time, microsoft/ms-tpm-20-ref makes no guarantees as to the stability
of its saved state across major revisions. This applies to both volatile
(in-memory), and non-volatile (nvram) state.
As such, ms-tpm-20-ref-rs makes the exact same guarantees wrt. saved state.
If you are interested as to why this is the case, and why it is not trivial to support inter-revision migration, see docs/upgrade_138_to_162.md.
This project welcomes contributions and suggestions. Most contributions require you to agree to a Contributor License Agreement (CLA) declaring that you have the right to, and actually do, grant us the rights to use your contribution. For details, visit https://cla.opensource.microsoft.com.
When you submit a pull request, a CLA bot will automatically determine whether you need to provide a CLA and decorate the PR appropriately (e.g., status check, comment). Simply follow the instructions provided by the bot. You will only need to do this once across all repos using our CLA.
This project has adopted the Microsoft Open Source Code of Conduct. For more information see the Code of Conduct FAQ or contact opencode@microsoft.com with any additional questions or comments.
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.