clique-sibyl-commonlib

Usage

[dependencies]
clique-sibyl-commonlib = { git = "https://github.com/CliqueOfficial/clique-sibyl-commonlib.git", tag = "v2.5.1" }

Features

Supports four features: rustls-0_20, rustls-0_21, rustls-0_22, rustls-0_23 and wasm. If you need to enable rustls, specify the corresponding feature based on the version of rustls you intend to use.

Currently, only rustls-0_23 is supported fully. rustls-0_20, rustls-0_21, rustls-0_22 are supported partially. Hence, we recommend using rustls-0_23 if you need to use rustls.

# use rustls-0_23
[dependencies]
clique-sibyl-commonlib = { git = "https://github.com/CliqueOfficial/clique-sibyl-commonlib.git", tag = "v2.5.1", features = "rustls-0_23" }

TLS Config

Support creating TLS config for both client and server.

You can use TLS config without client authentication. Or you can use TLS config with client authentication (also known as "mutual TLS" / "mTLS").

• TLS config without client authentication:
  clique_sibyl_commonlib::tls::config::create_tls_server_config_without_client_auth clique_sibyl_commonlib::tls::config::create_tls_client_config_without_client_auth
• TLS config with client authentication:
  clique_sibyl_commonlib::tls::config::create_tls_server_config_with_client_auth clique_sibyl_commonlib::tls::config::create_tls_client_config_with_client_auth clique_sibyl_commonlib::tls::config::create_mtls_config

This TLS config can help you to verify the attestation in the certificate during TLS handshake.

And you can find examples in ./tests/actix, ./gramine-examples/actix-example, ./gramine-examples/axum-example to see how to integrate this crate with server and client.

Attestation Verifier

You can use clique_sibyl_commonlib::attestation::verify_attestation to verify the attestation.

WASM

Install WASM toolchains:

cargo install wasm-bindgen-cli
rustup target add wasm32-unknown-unknown

Build WASM:

cargo build --target wasm32-unknown-unknown --release --features wasm

# For Node.js CommonJS module
wasm-bindgen target/wasm32-unknown-unknown/release/clique_sibyl_commonlib.wasm --out-dir ./wasm/pkg-node --target nodejs

# For web
wasm-bindgen target/wasm32-unknown-unknown/release/clique_sibyl_commonlib.wasm --out-dir ./wasm/pkg-web --target web

# For Node.js ESM module
wasm-bindgen target/wasm32-unknown-unknown/release/clique_sibyl_commonlib.wasm --out-dir ./wasm/pkg-node-esm --target experimental-nodejs-module

Install node.js:

sudo apt update
sudo apt install nodejs
sudo apt install npm

Test WASM for node.js:

cd wasm/wasm-node-test
node index.js

Tests

cargo t
cargo t actix -- --nocapture
cargo t actix --features "rustls-0_23" -- --nocapture

Examples

You can explore examples located in ./tests/actix, ./gramine-examples/actix-example, ./gramine-examples/axum-example to see how to integrate this crate with Actix server / client, and Axum server / client.