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

白皮书

可以在此处找到 Citadel 协议的白皮书：[GitHub 仓库](https://github.com/avarok-cybersecurity/citadel-protocol/blob/ab66949b4c5d624881611517193cdf0bb74c606e/citadel_io/The_Citadel_Protocol.pdf)。注意：自2022年7月以来，此白皮书未更新。虽然协议与白皮书中所涵盖的内容非常相似，但已有所发展。白皮书将在不久的将来与源代码同步。

文档

有关构建应用的示例，请查看[文档](https://avarok-cybersecurity.github.io/Citadel-Protocol/docs/)

构建说明

为了编译库，需要 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年中，我一直是最主要的开发者，需要更多的人来帮助生态系统繁荣发展。