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

白皮书

Citadel协议的白皮书可以在仓库 此处 找到。注意：自2022年7月以来，该白皮书未更新。虽然该协议与白皮书中所涵盖的内容非常相似，但它已经有所发展。白皮书将在不久的将来与源代码同步。

文档

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

构建说明

为了编译库，需要OpenSSL和Clang。查看.gitub中的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作为底层协议来确保协议至少与椭圆曲线密码学一样安全。

作者

托马斯·布朗 - 创始人

贡献

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