KO | EN

GitLite

Minimalist Open Source Repository Search Engine

gitlite — search

#developer-tools #typescript #dsh #dsh-plugin #ai-agent #codex #ai-agents #deepseek-harness #claude-code #cli #react #mcp

rats-tls

★ 51 Open GitHub ↗

RATS architecture based TLS using librats

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

# Building

## Build Requirements

- git
- make
- autoconf
- libtool
- gcc
- g++
- openssl-devel / libssl-dev (only needed in host/tdx mode)
- libcbor-devel / libcbor-dev (only needed in host/tdx mode)
- cargo (only needed in host mode)
- SGX driver, Intel SGX SDK & PSW: Please refer to this [guide](https://download.01.org/intel-sgx/sgx-linux/2.18/docs/Intel_SGX_SW_Installation_Guide_for_Linux.pdf) to install.
  - Requires Intel SGX SDK and PSW version >= 2.18
- [SGX DCAP](https://github.com/intel/SGXDataCenterAttestationPrimitives): please download and install the packages from this [page](https://download.01.org/intel-sgx/sgx-dcap/#version#linux/distro).
  - ubuntu 18.04: `libsgx-dcap-quote-verify-dev`, `libsgx-dcap-ql-dev`, `libsgx-uae-service`
  - Requires Intel DCAP version >= 1.15
- For TDX support, please refer to [linux-sgx](https://github.com/intel/linux-sgx) README to build the packages.

## Build and Install

Please follow the command to build RATS TLS from the latested source code on your system.

1. Download the latest source code of RATS TLS

```shell
mkdir -p "$WORKSPACE"
cd "$WORKSPACE"
git clone https://github.com/inclavare-containers/rats-tls
```

2. Build and install RATS TLS

```shell
cd rats-tls
cmake -DBUILD_SAMPLES=on -H. -Bbuild
make -C build install
```

`{rats-tls-server,rats-tls-client}` will be installed to `/usr/share/rats-tls/samples/{rats-tls-server,rats-tls-client}` on your system. All instances are placed in `/usr/local/lib/rats-tls`.

If you want to build instances related to sgx(sgx\_ecdsa, sgx\_ecdsa\_qve, sgx\_la), please type the following command.

```shell
cmake -DRATS_TLS_BUILD_MODE="sgx" -DBUILD_SAMPLES=on -H. -Bbuild
make -C build install
```

If you want to run instances on libos occlum, please type the following command.

```shell
cmake -DRATS_TLS_BUILD_MODE="occlum" -DBUILD_SAMPLES=on -H. -Bbuild
make -C build install
```

If you want to run TDX instances, please type the following command.
```shell
cmake -DRATS_TLS_BUILD_MODE="tdx" -DBUILD_SAMPLES=on -H. -Bbuild
make -C build install
```

Note that [SGX LVI mitigation](https://software.intel.com/security-software-guidance/advisory-guidance/load-value-injection) is enabled by default. You can set macro `SGX_LVI_MITIGATION` to `0` to disable SGX LVI mitigation.

# RUN

Right now, RATS TLS supports the following instance types:

| Priority    | Tls Wrapper instances |     Attester instances     |     Verifier instances     | Crypto Wrapper Instance |
| ----------- | --------------------- | -------------------------- | -------------------------- | ----------------------- |
| 0         | nulltls               | nullattester               | nullverifier               | nullcrypto              |
| 15        | openssl               | sgx\_la                    | sgx\_la                    | openssl                 |
| 20        | openssl               | csv                        | csv                        | openssl                 |
| 35        | openssl               | sev                        | sev                        | openssl                 |
| 42        | openssl               | sev\_snp                   | sev\_snp                   | openssl                 |
| 42        | openssl               | tdx\_ecdsa                 | tdx\_ecdsa                 | openssl                 |
| 52        | openssl               | sgx\_ecdsa                 | sgx\_ecdsa                 | openssl                 |
| 53        | openssl               | sgx\_ecdsa                 | sgx\_ecdsa\_qve            | openssl                 |

For instance priority, the higher, the stronger. By default, RATS TLS will select the **highest priority** instance to use.

## Run RATS TLS server

```
cd /usr/share/rats-tls/samples
./rats-tls-server
```

By default, the listening port is 1234. -p option can be used to specify the listening port.

## Run RATS TLS client
```
cd /usr/share/rats-tls/samples
./rats-tls-client
```

**Notice: special prerequisites for TDX remote attestation in bios configuration and hardware capability.**

Check msr 0x503, return value must be 0:
```
sudo rdmsr 0x503s
```

Note that if you want to run SEV-SNP remote attestation, please refer to [link](https://github.com/AMDESE/AMDSEV/tree/sev-snp-devel) to set up the host and guest Linux kernel, qemu and ovmf bios used for launching SEV-SNP guest.

**Notice: special prerequisites for SEV(-ES) remote attestation in software capability.**

- Kernel support SEV(-ES) runtime attestation, please manually apply [these patches](https://github.com/haosanzi/attestation-evidence-broker/tree/master/hack/README.md).
- Start the [attestation evidence broker](https://github.com/haosanzi/attestation-evidence-broker/blob/master/README.md) service in host.

**Notice: special prerequisites for CSV(2) remote attestation in software capability.**

- Kernel support CSV(2) runtime attestation, please manually apply these patches [1](https://gitee.com/anolis/cloud-kernel/pulls/108) and [2](https://gitee.com/anolis/cloud-kernel/pulls/412).

## Specify the instance type

The options of rats-tls-server are as followed:

```shell
OPTIONS:
   --attester/-a value   set the type of quote attester
   --verifier/-v value   set the type of quote verifier
   --tls/-t value        set the type of tls wrapper
   --crypto/-c value     set the type of crypto wrapper
   --mutual/-m           set to enable mutual attestation
   --log-level/-l        set the log level
   --ip/-i               set the listening ip address
   --port/-p             set the listening tcp port
   --product-enclave/-P  set to enable product enclave
   --verdictd/-E         set to connect verdictd based on EAA protocol
```

You can set command line parameters to specify different configurations.

For example:

```shell
./rats-tls-server --tls openssl
./rats-tls-server --attester sgx_ecdsa
./rats-tls-server --attester sgx_ecdsa_qve
./rats-tls-server --attester sgx_la
./rats-tls-server --attester tdx_ecdsa
./rats-tls-server --crypto openssl
```

RATS TLS's log level can be set through `-l` option with 6 levels: `off`, `fatal`, `error`, `warn`, `info`, and `debug`. The default level is `error`. The most verbose level is `debug`.

For example:

```
./rats-tls-server -l debug
```

RATS TLS server binds `127.0.0.1:1234` by default. You can use `-i` and `-p` options to set custom configuration.

```shell
./rats-tls-server -i [ip_addr] -p [port]
```

## Mutual attestation

You can use `-m` option to enable mutual attestation.

```shell
./rats-tls-server -m
./rats-tls-client -m
```

## Enable bootstrap debugging

In the early bootstrap of rats-tls, the debug message is mute by default. In order to enable it, please explicitly set the environment variable `RATS_TLS_GLOBAL_LOG_LEVEL=<log_level>`, where \<log_level\> is same as the values of the option `-l`.

# Deployment

## Occlum LibOS

Please refer to [this guide](docs/run_rats_tls_with_occlum.md) to run Rats Tls with [Occlum](https://github.com/occlum/occlum) and [rune](https://github.com/inclavare-containers/inclavare-containers/tree/master/rune).

## Non-SGX Enviroment

In non-sgx enviroment, it's possible to show the error messages as below when running the command `./rats-tls-client --attester sgx_ecdsa`. According to Intel DCAP's implementation, when calling to sgx_qv_get_quote_supplemental_data_size(),
if the libsgx_urts library is present, it will try to load QvE firstly. If failed, the verification will be launched by QVL. So the error info can be ignored and have no impact on the final attestation result.

```
[load_qve ../sgx_dcap_quoteverify.cpp:209] Error, call sgx_create_enclave for QvE fail [load_qve], SGXError:2006.
[sgx_qv_get_quote_supplemental_data_size ../sgx_dcap_quoteverify.cpp:527] Error, failed to load QvE.
```

# Third Party Dependencies

Direct Dependencies

rats-tls

Explore Similar Repositories

Was this content helpful?

Recent Feedback

Download README