OnionJuggler

符合 POSIX 规范的 shell 脚本，功能丰富的洋葱服务管理器，适用于类 Unix 操作系统

OnionJuggler 是一套轻量依赖、可移植的脚本和文档集合，旨在帮助服务运营者管理其洋葱服务。

警告：请勿信任此仓库，请在其他位置备份你的 hs 密钥。本项目尚未发布，仅作开发用途。

本仓库快速链接：git.io/onionjuggler

介绍

图片

tui-dialog tui-whiptail cli

历史

本项目的灵感来源于出色的 OnionShare CLI Python 脚本，它实现了临时洋葱服务，无需写入磁盘即可运行，并能轻松在 Tails 或 Whonix 上使用。之后，看到 RaspiBlitz 针对树莓派的洋葱服务 bash 脚本，便萌生了将其移植到所有 Debian 发行版的想法。随着想法逐渐成熟，仅依赖 GNU Bash 和 Linux 成为了单点故障1 2，因此让脚本符合 POSIX 规范，兼容所有类 Unix 系统，成为了最终目标。

目标

本项目的目标：

简化洋葱服务管理，从启用服务到为其添加客户端授权，提供完整的手动编辑配置文件功能，但减少输入量。
展示洋葱服务管理远不止仅仅使用 Web 服务器来托管页面。
从源代码层面（自由开源软件）到实际效果，让任何人都能在任何操作系统、Shell 或服务管理器上运行代码，减少单点故障。

减少单点故障：

内核：从占主导地位的 Linux 扩展到 BSD 及其他类 Unix 系统。
Shell：从占主导地位的 Bash 扩展到任何 POSIX Shell，如 ksh、(y,d)ash 和 Zsh（模拟 sh）。
服务管理器：从占主导地位的 Systemd 扩展到 RC、OpenRC、SysVinit、Runit。

编辑 Tor 配置文件（torrc）并不困难，但自动化可以解决配置错误的问题，并带来以下好处：

通过运行单行命令节省时间
通过拒绝无效配置来避免停机，确保应用前配置正确
完全统一
提供图形界面帮助新手

特性

启用服务 - 创建目录（如果不存在）（HiddenServiceDir），选择洋葱版本（HiddenServiceVersion），自定义套接字类型（unix 或 tcp），支持任意数量的虚拟端口和目标地址（HiddenServicePort）。
禁用服务 - 从 torrc 中移除服务配置；服务将不再可访问，但可随时重新启用。可选择彻底清除服务，删除配置和目录，永久删除其密钥。
更新服务地址 - 专注于私有洋葱服务；如果地址泄露，可更改其主机名，请注意所有已授权的客户端将被断开，服务密钥将被永久删除。
凭据 - 显示主机名、客户端、torrc 配置块、二维码编码的主机名。
洋葱认证 - 仅适用于 v3 洋葱服务。这依赖于客户端和服务端的配置，基于密钥对工作：客户端持有私钥部分（由客户端自行生成（更安全）或由服务运营者提供），洋葱服务运营者持有公钥部分。具体包括：
- 服务端 - 生成密钥对或导入公钥部分；列出客户端名称及其公钥（位于 <HiddenServiceDir>/authorized_clients/<client>.auth）。如果配置了任何客户端，则服务必须通过认证才能访问。
- 客户端 - 生成密钥对或导入公钥部分；列出您的 <ClientOnionAuthDir>/<SOME_ONION>.auth_private。
洋葱定位 - 针对公开洋葱服务，可通过 nginx、apache2 和 HTML 标头属性将普通网络用户重定向到洋葱服务。
操作安全 - Operation Security
- Unix 套接字 - 支持通过 Unix 套接字启用洋葱服务，以避免本地主机绕过。
Web 服务器 - 使用 Nginx 或 Apache2 Web 服务器配合隐藏服务提供文件服务。
易用性 - 项目兼容两种对话框：dialog 和 whiptail。
批量操作 - 某些命令支持使用参数 @all 来包含所有服务或客户端，具体取决于选项 --service 或；也支持列出参数和，命令将循环变量并应用组合操作。

需求

通用：
- 类 Unix 系统。
- 超级用户权限，用于以 root 身份调用命令以及 tor 用户
必需程序：
- sh - 任何 POSIX Shell：dash 0.5.4+、bash 2.03+、ksh 88+、mksh R28+、yash 2.29+、BusyBox ash 1.1.3+、zsh 3.1.9+（zsh --emulate sh）等。
- tor >= 0.3.5.7
- grep >= 0.9
- sed
- openssl >= 1.1（客户端认证 - 需要算法 x25519，因此不能使用 LibreSSL）
- basez >= 1.6.2（客户端认证）
- git（构建）
- dialog/whiptail（TUI）
- nginx/apache2（Web 服务器）
可选程序：
- (lib)qrencode >= 4.1.1（列出）
开发程序：
- pandoc（手册）
- shellcheck（代码审查）

兼容性

主要针对 Debian 系统（包括 Whonix）进行了测试。

可在 OpenBSD 上运行：

认证 -> 如果从源代码构建 basez（因为 ports 中没有）。
Web -> nginx 或 apache；OpenBSD 的 httpd 配置难以干净地移除服务块。

关于其他操作系统，请参见 etc/onionjuggler 中为您的操作系统预定义的配置。它们并未全部经过测试。

使用说明

克隆仓库

git clone https://github.com/nyxnor/onionjuggler.git
cd onionjuggler

搭建环境

在克隆的仓库内运行以下命令，以创建 Tor 目录、生成手册页并将脚本复制到 PATH：

./configure.sh --install

设置自定义变量

您不应修改 /etc/onionjuggler/onionjuggler.conf 的默认配置，因为它会在每次更新时被修改。您的本地配置应放在 /etc/onionjuggler/conf.d/*.conf 中；此文件夹中的配置会按词法顺序解析，最后出现的值将覆盖默认值。

使用方法

每个配置和脚本都有各自的手册页和帮助信息，这是全面学习 OnionJuggler 的最佳方式。

在执行任何修改脚本之前，建议先查看已配置的选项。每个脚本都有 --getconf 选项，用于打印当前由 OnionJuggler 读取的配置：

onionjuggler-cli --getconf

您也可以在不进行修改的情况下获取命令行选项，以检查赋值是否正确：

onionjuggler-cli --getopt --service=example --hs-version=3

要使用 TUI，只需运行：

onionjuggler-tui

要在 CLI 上创建服务：

onionjuggler-cli --on --service=terminator --socket=tcp --hs-version=3 --port="80:127.0.0.1:80"

更多功能请阅读手册页。

被收录于

TorBox >= v.0.5.0

onionjuggler

最受欢迎