samply/beam-enroll

Samply.Beam 端点注册工具

镜像概述和主要用途

本工具是https://github.com/samply/beam网络的配套工具，用于帮助新端点加入Samply.Beam网络。Samply.Beam是一个分布式任务代理，专为严格网络环境中的高效通信设计，提供跨网络边界的常用通信模式、端到端加密与签名、证书管理和验证功能，并基于REST API实现易用性。

Samply.Beam采用公钥加密技术实现认证、端到端加密和数据完整性保障，要求每个站点拥有"私钥"和公开的"公钥证书"。本工具用于生成私钥和证书签名请求(CSR)，CSR可提交给中央CA操作员以生成和签名公钥证书。

核心功能和特性

• 密钥生成：生成Samply.Beam所需的私钥文件
• CSR生成：创建证书签名请求，作为公钥证书的前置文件
• 多运行方式：支持Docker容器运行和本地编译运行
• 灵活配置：可指定输出文件名、代理ID和管理员***
• 安全保障：默认不覆盖现有私钥文件，需显式启用覆盖功能

使用场景和适用范围

适用于需要加入Samply.Beam网络的站点管理员，用于初始化节点的公钥加密基础设施：

• 新站点部署Samply.Beam代理时的初始配置
• 现有站点更换私钥或重新申请证书时使用
• 需要自动化生成CSR并提交给中央CA的场景

使用方法

前提条件

使用前需准备：

• 目标ProxyID（详见https://github.com/samply/beam）
• 环境变量$PROXY_ID（存储ProxyID）
• 环境变量$PRIVATEKEYFILENAME（存储输出私钥文件名，默认建议为$PROXY_ID_SHOR.priv.pem）

Docker运行

可使用Docker Registry中的预编译镜像：https://hub.docker.com/r/samply/beam-enroll

bash
docker run --rm -ti -v <beam代理路径>/pki:/etc/bridgehead/pki docker.xuanyuan.run/samply/beam-enroll:latest --output-file $PRIVATEKEYFILENAME --proxy-id $PROXY_ID
chmod 600 $PRIVATEKEYFILENAME

说明：将<beam代理路径>替换为实际的Samply.Beam代理目录路径，挂载卷用于将生成的密钥文件持久化到本地pki目录

本地编译运行

需安装Rust工具链（至少Rust 1.65版本）：

1. 克隆仓库：

bash
git clone https://github.com/samply/beam-enroll.git

2. 编译应用：

bash
cd beam-enroll && cargo build --release

3. 执行应用：

bash
./target/release/beam_enroll --proxy-id=$PROXY_ID

命令行选项

加密软件注意事项

本工具包含加密软件。您所在国家可能对加密软件的进口、持有、使用和再出口有限制。使用前请查阅所在国家关于加密软件的，确保合规。更多信息请访问[***]。