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

白皮书

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

文档

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

构建说明

为了编译库，需要OpenSSL和Clang。查看.github中的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年中，我一直是唯一的开发者，需要更多的人来帮助使生态系统繁荣。