Files
sso/tests/admin-oauth-clients-e2e.sh
T
ssw 9ac47f7942 feat: 凭据改 .env 注入 + 本地联调脚本 + nginx 域名转发配置
凭据管理
  新增 .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 ~^(?<subdomain>.+dm)\.mayishangshu\.cn$,443 与 80 跳转各一个。

  为什么不给空上游用 `if ($proxy_backend_addr = "")` 兜底:`if` 在 **rewrite**
  阶段求值,而变量是 **access** 阶段才写入的 —— 合法子域名会被一起误判成
  未解析。改用 error_page + 固定 body 标记(NO_BACKEND),顺带把「转发层兜底」
  与「插件自己发的 404」区分开,e2e 断言才有意义。
2026-09-13 10:25:19 +08:00

212 lines
12 KiB
Bash
Executable File
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
#!/usr/bin/env bash
# ============================================================================
# 管理接口端到端验证:OAuth 接入方(客户端注册表)管理
#
# 覆盖:
# - 未登录访问管理接口被拒(401),登录后可读写
# - 列表 / 新建 / 更新(保留密钥)/ 重置密钥 / 删除
# - **热生效**:新建完立刻能发起授权,不需要重启网关
# (这条专门盯住「写穿共享内存」——曾经把旧值原样写回,表现为
# 管理台显示已保存、授权时却报未知 client_id)
# - 参数校验:非法回调地址 / 非法授权类型 / 授权码模式缺回调
# - 公开客户端不持有密钥,且自动剔除 client_credentials / password
#
# 前置:网关以 source/conf/nginx.test.conf 运行(见 scripts/run-local-e2e.sh)
# 依赖:curl、python3
#
# 用法:bash tests/admin-oauth-clients-e2e.sh [IDP_BASE] [DATA_DIR]
# 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:-${ADMIN_PASSWORD:-123456}}"
JAR="$(mktemp -t sso_admin_cookies.XXXXXX.txt)"
trap 'rm -f "$JAR"' EXIT
PASS=0; FAIL=0
ok() { echo " ✅ $1"; PASS=$((PASS+1)); }
bad() { echo " ❌ $1"; FAIL=$((FAIL+1)); }
need() { command -v "$1" >/dev/null 2>&1 || { echo "缺少依赖: $1"; exit 2; }; }
need curl; need python3
echo "==> IdP: $BASE"
echo "==> data: $DATA_DIR"
echo "==> admin: $ADMIN_USER"
# ---------- JSON 取值:`jget <json> <点路径>` ----------
# 支持顶层与 data 下的字段,例如 client_secret / data.client_secret /
# data.items.0.client_id
jget() { printf '%s' "$1" | python3 -c "
import sys,json
path=[k for k in sys.argv[1].split('.') if k]
try: d=json.loads(sys.stdin.read())
except Exception: print(''); raise SystemExit
for k in path:
if isinstance(d,dict): d=d.get(k)
elif isinstance(d,list) and k.isdigit(): d=d[int(k)] if int(k)<len(d) else None
else: d=None
if d is None: break
print('' if d is None else (d if isinstance(d,str) else json.dumps(d)))
" "$2"; }
# 带会话的请求:`areq <METHOD> <PATH> [JSON_BODY]` → 输出响应体
areq() {
local m="$1" p="$2" b="${3:-}"
if [ -n "$b" ]; then
curl -s -b "$JAR" -X "$m" "$BASE$p" -H 'Content-Type: application/json' -d "$b"
else
curl -s -b "$JAR" -X "$m" "$BASE$p"
fi
}
# 同上,只取 HTTP 状态码
acode() {
local m="$1" p="$2" b="${3:-}"
if [ -n "$b" ]; then
curl -s -o /dev/null -w '%{http_code}' -b "$JAR" -X "$m" "$BASE$p" -H 'Content-Type: application/json' -d "$b"
else
curl -s -o /dev/null -w '%{http_code}' -b "$JAR" -X "$m" "$BASE$p"
fi
}
CID="e2e-app"
CID2="e2e-public"
REDIRECT="http://127.0.0.1:19999/callback"
# ---------- 0. 未登录:管理接口一律拒绝 ----------
echo "==> [0] 未登录拒绝"
code="$(curl -s -o /dev/null -w '%{http_code}' "$BASE/api/admin/oauth-clients")"
[ "$code" = "401" ] && ok "未登录读列表 → 401" || bad "未登录读列表应为 401,实际 $code"
code="$(curl -s -o /dev/null -w '%{http_code}' -X POST "$BASE/api/admin/oauth-clients/save" \
-H 'Content-Type: application/json' -d "{\"client_id\":\"$CID\"}")"
[ "$code" = "401" ] && ok "未登录保存 → 401" || bad "未登录保存应为 401,实际 $code"
# ---------- 1. 管理员登录 ----------
echo "==> [1] 管理员登录"
LOGIN="$(curl -s -c "$JAR" -X POST "$BASE/api/admin/login" -H 'Content-Type: application/json' \
-d "{\"username\":\"$ADMIN_USER\",\"password\":\"$ADMIN_PASS\"}")"
if [ "$(jget "$LOGIN" data.username)" = "$ADMIN_USER" ]; then
ok "登录成功(${ADMIN_USER})"
else
bad "登录失败:$LOGIN"
echo "!! 无法继续(管理接口需要管理员会话)"; exit 1
fi
# 清掉上次运行的残留,保证脚本可重复执行
areq POST /api/admin/oauth-clients/delete "{\"client_id\":\"$CID\"}" >/dev/null
areq POST /api/admin/oauth-clients/delete "{\"client_id\":\"$CID2\"}" >/dev/null
# ---------- 2. 列表 ----------
echo "==> [2] 列表与端点"
LIST="$(areq GET /api/admin/oauth-clients)"
if printf '%s' "$LIST" | grep -q '"grafana"'; then
ok "列表含种子客户端 grafana"
else
bad "列表缺少种子客户端:$LIST"
fi
ISS="$(jget "$LIST" data.issuer)"
[ -n "$ISS" ] && ok "返回 issuer:$ISS" || bad "未返回 issuer"
EP="$(jget "$LIST" data.endpoints.authorize_v20)"
case "$EP" in */oauth/v20/authorize) ok "返回 MaxKey 端点别名:$EP" ;; *) bad "MaxKey 端点别名异常:$EP" ;; esac
# ---------- 3. 新建机密客户端 ----------
echo "==> [3] 新建机密客户端"
SAVE="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"$CID\",\"name\":\"e2e 机密应用\",\"redirect_uris\":\"$REDIRECT\",\"grant_types\":\"authorization_code,refresh_token\",\"scopes\":\"openid profile\",\"confidential\":true}")"
SECRET="$(jget "$SAVE" data.client_secret)"
[ "${SECRET#cs_}" != "$SECRET" ] && ok "已生成客户端密钥(cs_ 前缀)" || bad "密钥异常:$SECRET"
[ "$(jget "$SAVE" data.existed)" = "false" ] && ok "标记 existed=false(新建)" || bad "existed 标记异常:$SAVE"
[ "$(jget "$SAVE" data.confidential)" = "true" ] && ok "类型为机密客户端" || bad "confidential 异常:$SAVE"
# ---------- 4. 热生效:立刻可发起授权(不需要重启网关) ----------
echo "==> [4] 热生效(写穿共享内存)"
LOC="$(curl -s -o /dev/null -w '%{redirect_url}' -G "$BASE/oauth/authorize" \
--data-urlencode "response_type=code" \
--data-urlencode "client_id=$CID" \
--data-urlencode "redirect_uri=$REDIRECT")"
case "$LOC" in
*/login?redirect=*) ok "新客户端立刻被识别(302 → 登录页)" ;;
*) bad "新客户端未被热加载,Location=$LOC" ;;
esac
# 对照:未注册的 client_id 必须是 invalid_client
BODY="$(curl -s -G "$BASE/oauth/authorize" \
--data-urlencode "response_type=code" \
--data-urlencode "client_id=no-such-client" \
--data-urlencode "redirect_uri=$REDIRECT")"
case "$BODY" in *invalid_client*) ok "未知 client_id → invalid_client(对照)" ;; *) bad "未知 client_id 未报 invalid_client:$BODY" ;; esac
# 未注册的回调地址必须被拒
BODY="$(curl -s -G "$BASE/oauth/authorize" \
--data-urlencode "response_type=code" \
--data-urlencode "client_id=$CID" \
--data-urlencode "redirect_uri=http://evil.example.com/cb")"
case "$BODY" in *invalid_redirect_uri*) ok "未注册回调地址 → invalid_redirect_uri" ;; *) bad "回调地址白名单失效:$BODY" ;; esac
# ---------- 5. 更新:密钥留空 = 保留原值 ----------
echo "==> [5] 更新保留密钥"
SAVE2="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"$CID\",\"name\":\"e2e 机密应用(改名)\",\"redirect_uris\":\"$REDIRECT\",\"grant_types\":\"authorization_code\",\"scopes\":\"openid\",\"confidential\":true}")"
[ "$(jget "$SAVE2" data.client_secret)" = "$SECRET" ] && ok "未传密钥时保留原密钥" || bad "密钥被意外改写:$SAVE2"
[ "$(jget "$SAVE2" data.existed)" = "true" ] && ok "标记 existed=true(更新)" || bad "existed 标记异常:$SAVE2"
[ "$(jget "$SAVE2" data.name)" = "e2e 机密应用(改名)" ] && ok "名称已更新" || bad "名称未更新:$SAVE2"
# ---------- 6. 参数校验 ----------
echo "==> [6] 参数校验"
BODY="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"e2e-bad\",\"redirect_uris\":\"javascript:alert(1)\",\"confidential\":true}")"
case "$BODY" in *"必须是 http(s)"*) ok "非 http(s) 回调被拒" ;; *) bad "非法回调未被拒:$BODY" ;; esac
BODY="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"e2e-bad\",\"redirect_uris\":\"http://127.0.0.1:1/cb#frag\",\"confidential\":true}")"
case "$BODY" in *fragment*) ok "带 #fragment 的回调被拒" ;; *) bad "fragment 未被拒:$BODY" ;; esac
BODY="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"e2e-bad\",\"redirect_uris\":\"http://127.0.0.1:1/cb\",\"grant_types\":\"urn:ietf:params:oauth:grant-type:device_code\",\"confidential\":true}")"
case "$BODY" in *"不支持的授权类型"*) ok "未知授权类型被拒" ;; *) bad "未知授权类型未被拒:$BODY" ;; esac
BODY="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"e2e-bad\",\"grant_types\":\"authorization_code\",\"confidential\":true}")"
case "$BODY" in *"回调地址"*) ok "授权码模式缺回调被拒" ;; *) bad "缺回调未被拒:$BODY" ;; esac
code="$(acode GET /api/admin/oauth-clients)"
[ "$code" = "200" ] && ok "校验失败未污染注册表(列表仍可读)" || bad "列表异常:$code"
printf '%s' "$(areq GET /api/admin/oauth-clients)" | grep -q 'e2e-bad' && bad "被拒的 e2e-bad 竟然入库了" || ok "被拒的客户端没有入库"
# ---------- 7. 公开客户端:无密钥 + 剔除不可用授权类型 ----------
echo "==> [7] 公开客户端"
SAVE3="$(areq POST /api/admin/oauth-clients/save "{\"client_id\":\"$CID2\",\"name\":\"e2e 公开应用\",\"redirect_uris\":\"$REDIRECT\",\"grant_types\":\"authorization_code,client_credentials,password\",\"scopes\":\"openid\",\"confidential\":false}")"
[ -z "$(jget "$SAVE3" data.client_secret)" ] && ok "公开客户端不生成密钥" || bad "公开客户端竟然有密钥:$SAVE3"
GT="$(jget "$SAVE3" data.grant_types)"
case "$GT" in
*client_credentials*|*password*) bad "公开客户端仍带不可用授权类型:$GT" ;;
*) ok "已剔除 client_credentials / password:$GT" ;;
esac
# ---------- 8. 重置密钥 ----------
echo "==> [8] 重置密钥"
ROT="$(areq POST /api/admin/oauth-clients/rotate "{\"client_id\":\"$CID\"}")"
NEW="$(jget "$ROT" data.client_secret)"
[ "${NEW#cs_}" != "$NEW" ] && ok "重置返回新密钥(cs_ 前缀)" || bad "重置未返回密钥:$ROT"
[ "$NEW" != "$SECRET" ] && ok "新密钥与旧密钥不同" || bad "新密钥与旧密钥相同"
BODY="$(areq POST /api/admin/oauth-clients/rotate "{\"client_id\":\"$CID2\"}")"
case "$BODY" in *"公开客户端"*) ok "公开客户端拒绝重置密钥" ;; *) bad "公开客户端重置未报错:$BODY" ;; esac
BODY="$(areq POST /api/admin/oauth-clients/rotate '{"client_id":"no-such-client"}')"
case "$BODY" in *"不存在"*) ok "重置不存在的客户端报错" ;; *) bad "重置不存在客户端未报错:$BODY" ;; esac
# ---------- 9. 删除 ----------
echo "==> [9] 删除"
DEL="$(areq POST /api/admin/oauth-clients/delete "{\"client_id\":\"$CID\"}")"
case "$DEL" in *已删除*) ok "删除成功" ;; *) bad "删除失败:$DEL" ;; esac
printf '%s' "$(areq GET /api/admin/oauth-clients)" | grep -q "\"$CID\"" && bad "删除后列表仍含 $CID" || ok "删除后列表不再含 $CID"
BODY="$(curl -s -G "$BASE/oauth/authorize" \
--data-urlencode "response_type=code" \
--data-urlencode "client_id=$CID" \
--data-urlencode "redirect_uri=$REDIRECT")"
case "$BODY" in *invalid_client*) ok "删除后授权请求即失效(invalid_client)" ;; *) bad "删除后仍能授权:$BODY" ;; esac
BODY="$(areq POST /api/admin/oauth-clients/delete '{"client_id":"no-such-client"}')"
case "$BODY" in *"不存在"*) ok "删除不存在的客户端报错" ;; *) bad "删除不存在客户端未报错:$BODY" ;; esac
# 收尾:清掉本次用的公开客户端
areq POST /api/admin/oauth-clients/delete "{\"client_id\":\"$CID2\"}" >/dev/null
echo
echo "==> 汇总:通过 ${PASS},失败 ${FAIL}"
[ "$FAIL" = "0" ] || exit 1