一种后量子信号协议，使开发超安全的客户端到服务器和p2p应用程序变得简单

白皮书

Citadel协议的白皮书可在以下仓库中找到：此处。注意：自2022年7月以来，此白皮书尚未更新。虽然协议与白皮书中所述非常相似，但已有所发展。白皮书将很快与源代码同步。

文档

有关构建应用程序的示例，请参阅文档

构建说明

编译库需要OpenSSL和Clang。查看.gituhub中的CI文件，以获取在裸机上编译代码的示例。或者，您可以使用以下命令设置环境

cargo make install

测试说明

在citadel_sdk中运行单元测试时，您必须使用Makefile。Makefile包含特殊标志和环境变量，用于与cargo test接口。首先，安装cargo make

cargo install --force cargo-make

要本地运行测试并进行有限设置，运行

cargo make test-local

要运行需要设置SQL和/或redis服务器的全面测试集（请检查Makefile.toml中的描述以帮助设置环境变量），运行

cargo make test

WASM（仅开发WIP）

目标三元组wasm32-wasi是支持WIP。应执行以下命令以编译到wasm

# Allows execution of `cargo wasi test --package citadel_pqcrypto`
cargo install cargo-wasi
# install wasmtime
curl https://wasmtime.dev/install.sh -sSf | bash
# get the include/build files
wget https://github.com/WebAssembly/wasi-sdk/releases/download/wasi-sdk-12/wasi-sysroot-12.0.tar.gz
tar -xvzf wasi-sysroot-12.0.tar.gz
rm wasi-sysroot-12.0.tar.gz
# Set environment variables
export WASI_SDK_DIR="$(pwd)/wasi-sysroot"
export WASMTIME_HOME="$(pwd)/.wasmtime"
export PATH="$WASMTIME_HOME/bin:$PATH"
export RUSTFLAGS="--cfg tokio_unstable"
# If on Mac M1, make sure to use the clang/ar provided by homebrew. Make sure to replace <LATEST_VERSION>
export PATH="/opt/homebrew/Cellar/llvm/<LATEST_VERSION>/bin/:$PATH"
export AR="/opt/homebrew/Cellar/llvm/<LATEST_VERSION>/bin/llvm-ar"
export CC="/opt/homebrew/Cellar/llvm/<LATEST_VERSION>/bin/clang"

此外，在检查/编译时还应启用wasm功能。

免责声明

本项目尚未经过第三方审计。虽然一些基础的密码学原语来自经过验证的Open Quantum Safe (OQS) 项目和/或PQClean项目，但Kyber库尚未接受审计（尽管已知的答案测试通过）。

因此，我们建议，如果您选择使用此库并接受其使用相关的风险，您应使用混合密码学，通过使用TLS或QUIC作为底层协议来确保协议的安全性至少与椭圆曲线密码学相当。

作者

Thomas Braun - 创始人

贡献

欢迎贡献！在过去5年中，我一直是唯一的开发者，需要更多的人来帮助生态系统繁荣。