From 9ac47f794292b7a26d20d99a5be4cebb328d0d44 Mon Sep 17 00:00:00 2001 From: ssw Date: Sun, 13 Sep 2026 10:25:19 +0800 Subject: [PATCH] =?UTF-8?q?feat:=20=E5=87=AD=E6=8D=AE=E6=94=B9=20.env=20?= =?UTF-8?q?=E6=B3=A8=E5=85=A5=20+=20=E6=9C=AC=E5=9C=B0=E8=81=94=E8=B0=83?= =?UTF-8?q?=E8=84=9A=E6=9C=AC=20+=20nginx=20=E5=9F=9F=E5=90=8D=E8=BD=AC?= =?UTF-8?q?=E5=8F=91=E9=85=8D=E7=BD=AE?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 凭据管理 新增 .env.example(**进版本库**,只放本机/CI 演示默认值)与 scripts/load-env.sh (统一读取项目根 .env,已存在的环境变量优先)。三套既有 e2e 改为从 .env 取 口令与签名密钥,命令行不再出现任何密钥 —— 既避免误入库,也避开终端历史泄露。 本地联调 scripts/local-serve.sh start|stop|restart:按 .env 起停 nginx 与 demo 系统, 替代手工拼路径。 nginx 配置 nginx.test.conf 新增 18093(转发回显后端)+ 18094(sso_domain on + proxy_pass http://$proxy_backend_addr),并补 error_page 500 502 503 = @no_backend 兜底。 nginx.conf(生产模板)新增企业域名转发 server: server_name ~^(?.+dm)\.mayishangshu\.cn$,443 与 80 跳转各一个。 为什么不给空上游用 `if ($proxy_backend_addr = "")` 兜底:`if` 在 **rewrite** 阶段求值,而变量是 **access** 阶段才写入的 —— 合法子域名会被一起误判成 未解析。改用 error_page + 固定 body 标记(NO_BACKEND),顺带把「转发层兜底」 与「插件自己发的 404」区分开,e2e 断言才有意义。 --- .env.example | 22 +++++++++ scripts/load-env.sh | 50 ++++++++++++++++++++ scripts/local-serve.sh | 81 ++++++++++++++++++++++++++++++++ source/conf/nginx.conf | 49 +++++++++++++++++++ source/conf/nginx.test.conf | 52 ++++++++++++++++++++ tests/admin-oauth-clients-e2e.sh | 6 ++- tests/oauth2-e2e.sh | 8 +++- tests/oauth2-maxkey-e2e.sh | 6 ++- 8 files changed, 270 insertions(+), 4 deletions(-) create mode 100644 .env.example create mode 100755 scripts/load-env.sh create mode 100755 scripts/local-serve.sh diff --git a/.env.example b/.env.example new file mode 100644 index 0000000..53af834 --- /dev/null +++ b/.env.example @@ -0,0 +1,22 @@ +# --------------------------------------------------------------------------- +# .env 模板:**进版本库**。复制为 .env 后按需修改: +# cp .env.example .env +# +# 里面只放本机/CI 演示用的默认值,生产部署必须逐项覆盖。 +# --------------------------------------------------------------------------- + +# 管理台登录账号(admin 账号由 scripts/seed-data.sh 生成) +ADMIN_USER=admin +ADMIN_PASSWORD=123456 + +# 示例账号(OIDC password grant / 授权码流用例都在用它) +ALICE_PASSWORD=alice123 + +# JWT 签名密钥。生成:openssl rand -hex 32 +OAUTH_SIGNING_SECRET=local-test-secret-CHANGE-ME + +# issuer 必须与访问 host 完全一致,否则令牌校验失败 +OAUTH_ISSUER=http://127.0.0.1:18098 + +# 跨子域 SSO 时才需要;留空 = 不写 Domain(主机级 cookie) +OAUTH_COOKIE_DOMAIN= diff --git a/scripts/load-env.sh b/scripts/load-env.sh new file mode 100755 index 0000000..367f499 --- /dev/null +++ b/scripts/load-env.sh @@ -0,0 +1,50 @@ +#!/usr/bin/env bash +# ============================================================================ +# 载入项目根 .env(**不是**可执行脚本,只能被 source) +# +# . "$(dirname "$0")/load-env.sh" +# +# 设计要点: +# 1. **已存在的环境变量优先**:CI 或命令行显式传入的值不被 .env 覆盖, +# 方便 `ADMIN_PASSWORD=xxx bash scripts/run-local-e2e.sh` 临时改写。 +# 2. 纯 bash 解析,不依赖 python / docker:只要 KEY=VALUE 与注释/空行。 +# 值里的 `#` 与空格都保留(不做行内注释剥离,避免把口令里的 # 吃掉)。 +# 3. .env 缺失时给一次警告并继续:本机 e2e 有内置默认值, +# 不该因为「没复制 .env」就整个跑不起来。 +# ============================================================================ + +# 由调用方 source,这里不能用 BASH_SOURCE 之外的手段定位,也不能 exit +_LOAD_ENV_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +_LOAD_ENV_ROOT="$(cd "$_LOAD_ENV_DIR/.." && pwd)" +_LOAD_ENV_FILE="${SSO_ENV_FILE:-$_LOAD_ENV_ROOT/.env}" + +if [ -f "$_LOAD_ENV_FILE" ]; then + while IFS= read -r _line || [ -n "$_line" ]; do + case "$_line" in + ''|'#'*) continue ;; + esac + # 只认 KEY=VALUE 形式;去掉可选的 export 前缀 + _kv="${_line#export }" + case "$_kv" in + *=*) ;; + *) continue ;; + esac + _k="${_kv%%=*}" + _v="${_kv#*=}" + # 去掉首尾成对引号(.env 里写 "v" 或 'v' 都支持) + case "$_v" in + \"*\") _v="${_v#\"}"; _v="${_%\"}" ;; + \'*\') _v="${_v#\'}"; _v="${_%\'}" ;; + esac + [ -n "$_k" ] || continue + # 已存在的环境变量优先:${!_k+x} 判断「已设置」(含设为空串) + if [ -z "${!_k+x}" ]; then + export "$_k=$_v" + fi + done < "$_LOAD_ENV_FILE" + unset _line _kv _k _v +else + echo " [env] 未找到 $_LOAD_ENV_FILE(可选):cp .env.example .env 后按需修改" >&2 +fi + +unset _LOAD_ENV_DIR _LOAD_ENV_ROOT _LOAD_ENV_FILE diff --git a/scripts/local-serve.sh b/scripts/local-serve.sh new file mode 100755 index 0000000..24d68fc --- /dev/null +++ b/scripts/local-serve.sh @@ -0,0 +1,81 @@ +#!/usr/bin/env bash +# ============================================================================ +# 本地起停 SSO 网关(手工联调用,与 scripts/run-local-e2e.sh 同一套配置) +# +# 与 run-local-e2e.sh 的区别:那个跑完就停进程,这个是常驻, +# 用来开着浏览器点管理台、或者手工 curl 端点。 +# +# 用法: +# bash scripts/local-serve.sh start # 起(默认) +# bash scripts/local-serve.sh stop # 停 +# bash scripts/local-serve.sh restart +# +# 所有凭据来自项目根 .env(不进 git),命令行里不出现任何密钥。 +# ============================================================================ +set -euo pipefail + +HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +ROOT="$(cd "$HERE/.." && pwd)" +# shellcheck source=scripts/load-env.sh +. "$HERE/load-env.sh" + +NGINX_SRC="${NGINX_SRC:-/tmp/sso-build/src/nginx-1.30.4}" +NGINX_BIN="${NGINX_BIN:-$NGINX_SRC/objs/nginx}" +MODULE_DIR="$ROOT/source/rust/target/release" +if [ -f "$MODULE_DIR/libsso_gateway.dylib" ]; then + MODULE="$MODULE_DIR/libsso_gateway.dylib" +else + MODULE="$MODULE_DIR/libsso_gateway.so" +fi + +CONF="/tmp/sso-nginx-test.conf" +PID="/tmp/sso-nginx.pid" +SHELL_PID="/tmp/sso-nginx-shell.pid" +ERR_LOG="/tmp/sso-nginx-error.log" + +# 签名密钥 / issuer:缺省值兜底,正常情况都由 .env 提供 +export OAUTH_SIGNING_SECRET="${OAUTH_SIGNING_SECRET:-$(openssl rand -hex 32)}" +export OAUTH_ISSUER="${OAUTH_ISSUER:-http://127.0.0.1:18098}" +if [ -n "${OAUTH_COOKIE_DOMAIN:-}" ]; then export OAUTH_COOKIE_DOMAIN; fi + +stop() { + [ -f "$PID" ] && kill "$(cat "$PID")" 2>/dev/null || true + [ -f "$SHELL_PID" ] && kill "$(cat "$SHELL_PID")" 2>/dev/null || true + rm -f "$PID" "$SHELL_PID" + echo "stopped" +} + +case "${1:-start}" in + stop) stop; exit 0 ;; + restart) stop; sleep 0.5 ;; + start) ;; + *) echo "用法: bash $0 [start|stop|restart]" >&2; exit 2 ;; +esac + +[ -x "$NGINX_BIN" ] || { echo "!! nginx 二进制缺失:$NGINX_BIN" >&2; exit 1; } +[ -f "$MODULE" ] || { echo "!! Rust 模块缺失:$MODULE(先 cargo build --release)" >&2; exit 1; } +[ -f "$CONF" ] || { + # 没现成配置就复用 run-local-e2e.sh 的生成逻辑(它会连带物化种子数据) + echo "## 没有 $CONF,先跑一次 run-local-e2e.sh 生成配置 ..." + bash "$HERE/run-local-e2e.sh" --keep > /dev/null 2>&1 || true + if [ -f "$PID" ]; then kill "$(cat "$PID")" 2>/dev/null || true; fi + pkill -f "demo-system/app.py" 2>/dev/null || true + [ -f "$CONF" ] || { echo "!! 配置生成失败" >&2; exit 1; } +} + +"$NGINX_BIN" -c "$CONF" -g 'daemon off;' -e "$ERR_LOG" > /tmp/sso-nginx-stdout.log 2>&1 & +echo $! > "$SHELL_PID" + +for i in $(seq 1 20); do + code="$(curl -s -o /dev/null -w '%{http_code}' "${OAUTH_ISSUER}/.well-known/openid-configuration" || true)" + [ "$code" = "200" ] && break + sleep 0.5 +done +code="$(curl -s -o /dev/null -w '%{http_code}' "${OAUTH_ISSUER}/.well-known/openid-configuration" || true)" +if [ "$code" != "200" ]; then + echo "!! 网关未就绪(HTTP $code),日志:" >&2; tail -30 "$ERR_LOG" >&2; exit 1 +fi + +echo "started: $OAUTH_ISSUER (discovery=$code)" +echo " admin: ${ADMIN_USER:-admin} / (口令见 .env 的 ADMIN_PASSWORD)" +echo " 停止: bash $0 stop" diff --git a/source/conf/nginx.conf b/source/conf/nginx.conf index d9d4563..75fa35a 100644 --- a/source/conf/nginx.conf +++ b/source/conf/nginx.conf @@ -4,6 +4,7 @@ # 两个 server,对应两层能力: # sso.<域名> IdP + 管理台:签发令牌、管理账号与接入方 # *.<域名>(或 *.<子域>)IAP:转发前完成认证并注入 X-Auth-* +# *dm.<企业域名> 企业域名转发:子域名 → 后端(域名插件,申请/审核后写入 sub: 共享内存) # # 部署前必须替换:域名、证书路径、上游 proxy_pass 地址、OAUTH_* 环境变量。 # 本文件**不参与**本机 e2e(那是 conf/nginx.test.conf)。 @@ -160,4 +161,52 @@ http { server_name app.example.com; return 301 https://$host$request_uri; } + # ================================================================== + # 企业域名转发(域名插件 plugin-domain) + # + # 用户申请子域名 → 管理员审核放行 → sub:<子域名> 写入共享内存; + # 请求进来时 access 阶段解析 Host 得到后端地址,proxy_pass 据此转发。 + # + # ⚠️ 子域名**必须以 `dm` 结尾**(自动生成的形状是 `i<8位数字>dm`): + # 下面的正则捕获组是 `.+dm`,不以 dm 结尾的域名根本匹配不到本 server。 + # ⚠️ 后端地址是 `host:port`:若填域名而非 IP,需要配 resolver(见下)。 + # ================================================================== + server { + listen 443 ssl; + http2 on; + server_name ~^(?.+dm)\.mayishangshu\.cn$; + + ssl_certificate /usr/local/nginx/conf/tls/example.com/fullchain.cer; + ssl_certificate_key /usr/local/nginx/conf/tls/example.com/example.com.key; + ssl_protocols TLSv1.2 TLSv1.3; + + # 后端若写成域名,必须显式指定 DNS;写 IP:PORT 则不需要 + # resolver 223.5.5.5 valid=30s ipv6=off; + + location / { + # 转发开关:access 阶段查 sub: 共享内存,命中写入 $proxy_backend_addr, + # 未命中(不存在 / 待审核 / 已过期)直接 404 + sso_domain on; + + proxy_pass http://$proxy_backend_addr; + proxy_http_version 1.1; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; + + proxy_connect_timeout 5s; + proxy_send_timeout 300s; + proxy_read_timeout 300s; + } + } + + # 明文 80 跳转 + server { + listen 80; + server_name ~^(?.+dm)\.mayishangshu\.cn$; + return 301 https://$host$request_uri; + } } diff --git a/source/conf/nginx.test.conf b/source/conf/nginx.test.conf index 99e7ca8..91050fe 100644 --- a/source/conf/nginx.test.conf +++ b/source/conf/nginx.test.conf @@ -11,6 +11,8 @@ # 18099 IAP:受保护代理,注入 X-Auth-* 到 18097 回显后端(断言用) # 18097 echo-backend:把收到的请求头原样回显为 JSON(用于断言 IAP 注入) # 18095 IAP 接入 demo 业务系统:前置认证 + 注入 X-Auth-* → 18096 +# 18094 企业域名转发:sub: → $proxy_backend_addr(域名插件) +# 18093 域名转发的回显后端:回显收到的 Host 与 URI,供断言 # 18096 demo 系统本体(**不由 nginx 监听**,是 tests/demo-system/app.py # 自己起的进程;直连 18096 时它自己做 OAuth2 客户端,经 18095 访问时 # 网关已完成认证并注入身份,应用零改造) @@ -150,4 +152,54 @@ http { return 302 "http://127.0.0.1:18098/login?redirect=$scheme://$host$request_uri"; } } + # ------------------------------------------------------------------ + # 18093 域名转发回显后端:断言「子域名确实被转发到了目标后端」 + # ------------------------------------------------------------------ + server { + listen 18093; + location / { + default_type application/json; + return 200 '{"backend":"18093","host":"$host","uri":"$request_uri"}'; + } + } + + # ------------------------------------------------------------------ + # 18094 企业域名转发(域名插件) + # + # 与 IAP 的区别:IAP 判定的是「你是谁」,这里判定的是「你要去哪台后端」。 + # access 阶段从 Host 取子域名 → 查 sub: 共享内存 → 写入 $proxy_backend_addr, + # 由下面的 proxy_pass 转发;未命中(不存在 / 待审核 / 已过期)直接 404, + # 热路径**永不回源**。 + # + # 本机无 PCRE,故不写正则 server_name(生产的正则见 conf/nginx.conf): + # 子域名判定完全由插件按 Host 后缀完成,不依赖 server_name 匹配。 + # ------------------------------------------------------------------ + server { + listen 18094 default_server; + server_name _; + + location / { + # 转发开关(access 阶段解析 Host 并注入 $proxy_backend_addr) + sso_domain on; + + proxy_pass http://$proxy_backend_addr; + proxy_http_version 1.1; + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + + # 本机无 PCRE,只能用 `server_name _`,于是 zone 外的 Host 也会进到这里; + # 此时插件已 decline、$proxy_backend_addr 为空,空 upstream 会报 500。 + # 生产用正则 server_name(见 conf/nginx.conf),这类请求根本进不来。 + # + # ⚠️ 不能用 `if ($proxy_backend_addr = "")`:`if` 在 **rewrite** 阶段求值, + # 而变量是 **access** 阶段才写入的 —— 合法子域名会被一起判成未解析。 + error_page 500 502 503 = @no_backend; + } + + # 兜底:转发层没有可用后端(body 是固定标记,便于与插件自身的 404 区分) + location @no_backend { + return 404 "NO_BACKEND"; + } + } } diff --git a/tests/admin-oauth-clients-e2e.sh b/tests/admin-oauth-clients-e2e.sh index b69f600..c7faa10 100755 --- a/tests/admin-oauth-clients-e2e.sh +++ b/tests/admin-oauth-clients-e2e.sh @@ -18,12 +18,16 @@ # ADMIN_USER / ADMIN_PASS 可覆盖(默认取管理台初始账号 admin / 123456) # ============================================================================ set -u +# 口令等敏感值从项目根 .env 读(不进 git);已存在的环境变量优先。 +_ENV_HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +. "$_ENV_HERE/../scripts/load-env.sh" +unset _ENV_HERE BASE="${1:-http://127.0.0.1:18098}" ROOT="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)" DATA_DIR="${2:-$ROOT/source/data}" ADMIN_USER="${ADMIN_USER:-admin}" -ADMIN_PASS="${ADMIN_PASS:-123456}" +ADMIN_PASS="${ADMIN_PASS:-${ADMIN_PASSWORD:-123456}}" JAR="$(mktemp -t sso_admin_cookies.XXXXXX.txt)" trap 'rm -f "$JAR"' EXIT diff --git a/tests/oauth2-e2e.sh b/tests/oauth2-e2e.sh index 320c9ce..ebf8b72 100755 --- a/tests/oauth2-e2e.sh +++ b/tests/oauth2-e2e.sh @@ -19,6 +19,10 @@ # bash tests/oauth2-e2e.sh [IDP_BASE] [IAP_BASE] [DATA_DIR] # ============================================================================ set -u +# 口令等敏感值从项目根 .env 读(不进 git);已存在的环境变量优先。 +_ENV_HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +. "$_ENV_HERE/../scripts/load-env.sh" +unset _ENV_HERE BASE="${1:-http://127.0.0.1:18098}" IAP="${2:-http://127.0.0.1:18099}" @@ -142,7 +146,7 @@ fi echo "## 2. 登录建 SSO 会话(alice)" curl -s -D "$HDR" -o /dev/null -c "$JAR" -X POST "$BASE/login" \ --data-urlencode 'username=alice' \ - --data-urlencode 'password=alice123' \ + --data-urlencode "password=${ALICE_PASSWORD:-alice123}" \ --data-urlencode 'redirect=/' SSO="$(setcookie_val sso_sid "$HDR")" COOKIE_CT="$(python3 -c " @@ -230,7 +234,7 @@ fi # =========================================================================== echo "## 8. password grant(machine 客户端代资源所有者)" PW="$(curl -s -X POST "$BASE/oauth/token" -u "machine:$MSEC" \ - -d 'grant_type=password&username=alice&password=alice123&scope=openid profile email')" + -d "grant_type=password&username=alice&password=${ALICE_PASSWORD:-alice123}&scope=openid profile email")" PW_AT="$(dj "$PW" access_token)" PW_ID="$(dj "$PW" id_token)" PW_UI="$(curl -s -H "Authorization: Bearer $PW_AT" "$BASE/oauth/userinfo")" diff --git a/tests/oauth2-maxkey-e2e.sh b/tests/oauth2-maxkey-e2e.sh index 01aa7cb..2f60c95 100755 --- a/tests/oauth2-maxkey-e2e.sh +++ b/tests/oauth2-maxkey-e2e.sh @@ -21,6 +21,10 @@ # bash tests/oauth2-maxkey-e2e.sh [IDP_BASE] [DEMO_BASE] [IAP_DEMO_BASE] [DATA_DIR] # ============================================================================ set -u +# 口令等敏感值从项目根 .env 读(不进 git);已存在的环境变量优先。 +_ENV_HERE="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)" +. "$_ENV_HERE/../scripts/load-env.sh" +unset _ENV_HERE IDP="${1:-http://127.0.0.1:18098}" DEMO="${2:-http://127.0.0.1:18096}" @@ -146,7 +150,7 @@ if [ "$CODE" != "404" ] && [ "$CODE" != "000" ]; then ok "POST /sign/authz/oauth # A4. 登录 IdP 建立 SSO 会话(MaxKey 风格的客户端不会走 /login,这里只是为了拿到会话) curl -s -o /dev/null -D "$H1" -c "$JAR" -X POST "$IDP/login" \ - --data-urlencode "username=alice" --data-urlencode "password=alice123" \ + --data-urlencode "username=alice" --data-urlencode "password=${ALICE_PASSWORD:-alice123}" \ --data-urlencode "redirect=/" SSO="$(setcookie_val sso_sid "$H1")" if [ -n "$SSO" ]; then ok "IdP 登录成功,下发 SSO 会话 Cookie"; else bad "IdP 登录未下发会话 Cookie"; fi