harald/teepot
1
0
Fork 0
mirror of https://github.com/matter-labs/teepot.git synced 2025-07-25 00:34:46 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: add README files for teepot-related crates

Browse source 
- Added comprehensive README files for the following new crates:
  - `teepot`
  - `teepot-tdx-attest-rs`
  - `teepot-tdx-attest-sys`
  - `teepot-tee-quote-verification-rs`
  - `teepot-vault`
- Each includes an overview, usage examples, installation instructions, and licensing details.
This commit is contained in:
Harald Hoyer 2025-06-25 09:47:38 +02:00
parent 18ed1aa769
commit ddbf099e45
Signed by: harald
GPG key ID: F519A1143B3FBE32
5 changed files with 583 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

46
crates/teepot-tdx-attest-sys/README.md Normal file
View file

@ -0,0 +1,46 @@
# teepot-tdx-attest-sys
[![Crates.io](https://img.shields.io/crates/v/teepot-tdx-attest-sys.svg)](https://crates.io/crates/teepot-tdx-attest-sys)
[![Documentation](https://docs.rs/teepot-tdx-attest-sys/badge.svg)](https://docs.rs/teepot-tdx-attest-sys)
[![License](https://img.shields.io/crates/l/teepot-tdx-attest-sys.svg)](https://github.com/matter-labs/teepot/blob/main/crates/teepot-tdx-attest-sys/License.txt)
Raw FFI bindings to Intel TDX Attestation Library (`libtdx_attest`).
This crate provides low-level FFI bindings for Intel Trust Domain Extensions (TDX) attestation functionality. It is a fork of the original [tdx-attest-sys](https://github.com/intel/SGXDataCenterAttestationPrimitives) crate from Intel's SGX Data Center Attestation Primitives.
## Prerequisites
Before using this crate, you need to install:
- Intel® SGX DCAP Driver
- Intel® SGX SDK
- Intel® SGX DCAP Packages
- Intel® SGX DCAP PCCS (Provisioning Certificate Caching Service)
Please refer to the [SGX DCAP Linux installation guide](https://download.01.org/intel-sgx/latest/dcap-latest/linux/docs/Intel_SGX_SW_Installation_Guide_for_Linux.pdf) for detailed installation instructions.
## Usage
Add this to your `Cargo.toml`:
```toml
[dependencies]
teepot-tdx-attest-sys = "0.1.0"
```
This crate provides raw FFI bindings. For a more ergonomic Rust API, consider using a higher-level wrapper crate.
## Building
The crate uses `bindgen` to generate Rust bindings from the C headers during build time. Make sure you have:
- The TDX attestation library (`libtdx_attest`) installed on your system
- If using Intel SGX SDK, set the `SGX_SDK` environment variable to point to your SDK installation
## License
This project is licensed under the BSD-3-Clause License. See the [License.txt](License.txt) file for details.
## Repository
This crate is part of the [Teepot](https://github.com/matter-labs/teepot) project.