Skip to content

feat: 支持系统管理员用户名随机化配置 #9999 - #1024

Merged
dengyh merged 1 commit into
TencentBlueKing:masterfrom
steven-changs:feature/admin-randomization
Nov 19, 2026
Merged

dengyh merged 1 commit into
TencentBlueKing:masterfrom
steven-changs:feature/admin-randomization

Conversation

@steven-changs

Copy link
Copy Markdown
Collaborator
  • 新增 bkflow/utils/admin.py 工具函数,从环境变量 BK_ADMIN_USERNAME 读取配置
  • 修改 env.py、config/default.py、module_settings.py 添加配置传递
  • 修改11处硬编码,使用 get_admin_username() 替代硬编码值:
    • migrate_itsm_workflow.py: 1处
    • plugin_resolver.py: 3处
    • plugin_schema_service.py: 4处
    • open_plugin_catalog.py: 1处
    • env.py: 1处 (BK_APIGW_MANAGER_MAINTAINERS)
    • config/default.py: 1处 (INIT_SUPERUSER)
  • 添加单元测试 tests/utils/test_admin.py,覆盖默认值和配置值场景
  • 支持降级:未配置时使用 'admin' 作为默认值
  • 兼容历史遗留值:admin、bk_admin

@tencentblueking-adm

tencentblueking-adm commented Nov 17, 2026 •

Copy link
Copy Markdown

CLA assistant check
Thank you for your submission! We really appreciate it. Like many open source projects, we ask that you sign our Contributor License Agreement before we can accept your contribution.


gys_stevenchangs_pmc seems not to be a GitHub user. You need a GitHub account to be able to sign the CLA. If you have already a GitHub account, please add the email address used for this commit to your account.
You have signed the CLA already but the status is still pending? Let us recheck it.

@steven-changs
steven-changs force-pushed the feature/admin-randomization branch from 0bc869c to d02980b Compare November 17, 2026 03:04
@github-actions

github-actions Bot commented Nov 17, 2026 •

Copy link
Copy Markdown

🔎 AI 代码审查

📌 a50bac4964bd · 🧪 未执行测试

Warning

⚠️ 有 1 项问题需要处理或确认

请优先查看下方待处理问题。

🆕 新增 🔴 仍存在 ✅ 已修复 ❔ 待确认
1 0 2 0

🚩 待处理问题

🟠 P2 · is_admin_username 无条件将 admin/bk_admin 视为管理员,随机化安全目标被架空

📍 bkflow/utils/admin.py:65 · 🏷️ F-189f5242a01f · 🆕 新增

新增的 is_admin_username() 在 BK_ADMIN_USERNAME 已被随机化为非可猜测值(如 xK9f2)时,仍因 legacy_admins = ["admin", "bk_admin"] 无条件返回 True。触发条件:任何管理员身份判断路径调用该函数(当前快照中仅 tests/utils/test_admin.py 引用,尚未接入生产鉴权,属潜在缺陷);本 PR 的明确目标就是「随机化管理员用户名」以避免可猜测的 admin(见历史 F-d80241bc2746)。调用链:is_admin_username(username) → legacy_admins=["admin","bk_admin"] → if username in legacy_admins: return True。影响:即使运维把管理员名随机化,攻击者/历史账号 admin、bk_admin 仍被认定为管理员,随机化的安全收益被完全抵消;一旦该函数被接入权限或越权判断(其命名与测试表明正是为此设计),即构成实际越权。最小修复:仅在未配置自定义管理员时才回退 legacy 值,例如 legacy 兼容只在 get_admin_username() == "admin" 时启用;或移除 legacy 白名单,仅以当前配置管理员为准。

🔁 历史复核

✅ 已修复(静态代码确认) · 管理员用户名字段环境变量名大小写不一致,随机化配置静默失效

📍 env.py:189 · 🏷️ F-d80241bc2746 · P2

env.py 第 191 行已改为 os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin"),大写 UPPER_SNAKE_CASE 变量现在优先读取,运维按项目约定设置 BK_ADMIN_USERNAME 后不再被静默忽略,随机化配置生效,核心大小写不一致问题已修复。

🧩 当前代码证据

env.py:191

BK_ADMIN_USERNAME = os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin")
✅ 已修复(静态代码确认) · ITSM 租户初始化默认操作员由 bk_admin 变为 admin,默认部署语义改变

📍 bkflow/contrib/itsm_workflow/management/commands/migrate_itsm_workflow.py:36 · 🏷️ F-9847f1d9bd3b · P2

migrate_itsm_workflow.py 第 40-41 行新增回退逻辑:get_admin_username() 返回默认值 admin 时回退为历史兼容值 bk_admin,默认部署(未配置 bkAdminUsername/BK_ADMIN_USERNAME)下 ITSM4 system_create/system_migrate 的 operator 恢复为 bk_admin,不再静默变为 admin,历史兼容语义已修复。

🧩 当前代码证据

bkflow/contrib/itsm_workflow/management/commands/migrate_itsm_workflow.py:41

            username = "bk_admin"

📎 审查边界

未运行任何测试、构建或部署,结论仅为静态分析。blueapps(4.15.8) 对 INIT_SUPERUSER 的实际消费逻辑(init_superuser 的创建/授权、多租户下的隔离行为)为外部依赖,不在本快照内,无法验证随机化后首次部署的超管创建语义。migrate_itsm_workflow 的 operator 经 get_client_by_username→bkapi_client_core→ITSM4 网关,属外部实现,无法验证随机化后 operator 是否会被 ITSM4 侧拒绝或改变归属。app_desc.yaml 仍未声明 BK_ADMIN_USERNAME/bkAdminUsername 环境变量(历史 finding 的部署声明建议未落地),但不影响本次大小写修复的判定。bkflow/utils/admin.py 的 get_admin_username 文档声称读取两个环境变量的优先级,实际仅读取 settings.BK_ADMIN_USERNAME,优先级逻辑由 env.py 承担,属文档与实现的分层差异,未作为缺陷报告。

📋 审查范围与验证说明

仅辅助人工审查;未执行测试,也不代表已满足合入或发布条件。

快照过滤了 13 个大文件、链接或工具配置文件;diff 仍包含其修改。


💡 本报告辅助人工审查,结论绑定上述提交。

@steven-changs
steven-changs force-pushed the feature/admin-randomization branch 3 times, most recently from 4429a1f to 47f336e Compare November 17, 2026 03:21
@github-actions

Copy link
Copy Markdown

🔁 AI 代码审查复核

📌 47f336ecb1b0 · 🧪 未执行测试

对上轮审查的逐项回复:

🔴 仍存在 · 管理员用户名字段环境变量名大小写不一致,随机化配置静默失效

📍 env.py:189 · 🏷️ F-d80241bc2746 · P2

仍存在:env.py 仍以小驼峰读取 os.getenv("bkAdminUsername", "admin"),与 bkflow/utils/admin.py 文档「从环境变量 BK_ADMIN_USERNAME 读取」及项目 UPPER_SNAKE_CASE 约定不一致。触发条件:运维按文档设置大写 BK_ADMIN_USERNAME 后,env.py 读不到,值静默回退为 admin。影响:config/default.py 的 INIT_SUPERUSER=[env.BK_ADMIN_USERNAME]、BK_ADMIN_USERNAME 及 module_settings.py 均取到回退值 admin,首次部署仍创建可猜测 admin 超管,随机化失效;get_admin_username() 各调用点同样使用 admin。最小修复:改为 os.getenv("BK_ADMIN_USERNAME", "admin") 并同步 app_desc.yaml 声明。

🧩 当前代码证据

env.py:189

BK_ADMIN_USERNAME = os.getenv("bkAdminUsername", "admin")

以上为静态代码复核,未运行测试;无法确认项继续保留,不自动关闭讨论。

@steven-changs
steven-changs force-pushed the feature/admin-randomization branch from 47f336e to 50b06e5 Compare November 17, 2026 03:30
@github-actions

Copy link
Copy Markdown

🔁 AI 代码审查复核

📌 50b06e561db6 · 🧪 未执行测试

对上轮审查的逐项回复:

✅ 已修复(静态代码确认) · 管理员用户名字段环境变量名大小写不一致,随机化配置静默失效

📍 env.py:189 · 🏷️ F-d80241bc2746 · P2

历史问题已修复:env.py 现改为优先读取大写 `BK_ADMIN_USERNAME`,再兼容小驼峰 `bkAdminUsername`,与 bkflow/utils/admin.py 文档及项目 UPPER_SNAKE_CASE 约定一致,随机化不再静默失效。

🧩 当前代码证据

env.py:190

BK_ADMIN_USERNAME = os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin")

以上为静态代码复核,未运行测试;无法确认项继续保留,不自动关闭讨论。

@steven-changs
steven-changs force-pushed the feature/admin-randomization branch from 50b06e5 to 595a8d1 Compare November 17, 2026 03:48
@github-actions

Copy link
Copy Markdown

🔁 AI 代码审查复核

📌 595a8d1ab864 · 🧪 未执行测试

对上轮审查的逐项回复:

🔴 仍存在 · 管理员用户名字段环境变量名大小写不一致,随机化配置静默失效

📍 env.py:189 · 🏷️ F-d80241bc2746 · P2

回归复现。当前 env.py 第 189 行又改为 os.getenv("bkAdminUsername", "admin"),仅读取小驼峰变量,不再优先读取大写 BK_ADMIN_USERNAME(历史修复为 os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin"))。运维按项目 UPPER_SNAKE_CASE 约定设置 BK_ADMIN_USERNAME 后仍被静默忽略,config/default.py 的 INIT_SUPERUSER、get_admin_username() 及其全部调用点回退为 admin,随机化目标失效;且 app_desc.yaml 仍未声明该环境变量。判定 open(回归)。

🧩 当前代码证据

env.py:189

BK_ADMIN_USERNAME = os.getenv("bkAdminUsername", "admin")

🔴 仍存在 · ITSM 租户初始化默认操作员由 bk_admin 变为 admin,默认部署语义改变

📍 bkflow/contrib/itsm_workflow/management/commands/migrate_itsm_workflow.py:36 · 🏷️ F-9847f1d9bd3b · P2

仍存在。migrate_itsm_workflow.py 第 36 行仍使用 get_admin_username()(默认 admin)作为 ITSM4 system_create/system_migrate 的 operator,旧代码硬编码 bk_admin。默认部署(未设置 bkAdminUsername)下 operator 由 bk_admin 变为 admin,与 ITSM4 侧既有按 bk_admin 注册/鉴权或审计归属语义的兼容性风险未消除。判定 open。

🧩 当前代码证据

bkflow/contrib/itsm_workflow/management/commands/migrate_itsm_workflow.py:36

client = get_client_by_username(get_admin_username(), stage=settings.BK_APIGW_STAGE_NAME)

以上为静态代码复核,未运行测试;无法确认项继续保留,不自动关闭讨论。

@codecov-commenter

codecov-commenter commented Nov 17, 2026 •

Copy link
Copy Markdown

Codecov Report

❌ Patch coverage is 68.96552% with 9 lines in your changes missing coverage. Please review.
✅ Project coverage is 86.62%. Comparing base (4cf05da) to head (a50bac4).
⚠️ Report is 3 commits behind head on master.

Files with missing lines Patch % Lines
bkflow/utils/admin.py 30.76% 9 Missing ⚠️
Additional details and impacted files
@@            Coverage Diff             @@
##           master    #1024      +/-   ##
==========================================
- Coverage   86.64%   86.62%   -0.03%     
==========================================
  Files         373      374       +1     
  Lines       25186    25211      +25     
==========================================
+ Hits        21823    21839      +16     
- Misses       3363     3372       +9     

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@steven-changs
steven-changs force-pushed the feature/admin-randomization branch from 595a8d1 to a50bac4 Compare November 17, 2026 06:08
- 新增 bkflow/utils/admin.py 工具函数,从环境变量 BK_ADMIN_USERNAME 读取配置
- 修改 env.py、config/default.py、module_settings.py 添加配置传递
- 修改11处硬编码,使用 get_admin_username() 替代硬编码值:
  * migrate_itsm_workflow.py: 1处
  * plugin_resolver.py: 3处
  * plugin_schema_service.py: 4处
  * open_plugin_catalog.py: 1处
  * env.py: 1处 (BK_APIGW_MANAGER_MAINTAINERS)
  * config/default.py: 1处 (INIT_SUPERUSER)
- 添加单元测试 tests/utils/test_admin.py,覆盖默认值和配置值场景
- 支持降级:未配置时使用 'admin' 作为默认值
- 兼容历史遗留值:admin、bk_admin
@github-actions

Copy link
Copy Markdown

🔁 AI 代码审查复核

📌 a50bac4964bd · 🧪 未执行测试

对上轮审查的逐项回复:

✅ 已修复(静态代码确认) · 管理员用户名字段环境变量名大小写不一致,随机化配置静默失效

📍 env.py:189 · 🏷️ F-d80241bc2746 · P2

env.py 第 191 行已改为 os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin"),大写 UPPER_SNAKE_CASE 变量现在优先读取,运维按项目约定设置 BK_ADMIN_USERNAME 后不再被静默忽略,随机化配置生效,核心大小写不一致问题已修复。

🧩 当前代码证据

env.py:191

BK_ADMIN_USERNAME = os.getenv("BK_ADMIN_USERNAME") or os.getenv("bkAdminUsername", "admin")
✅ 已修复(静态代码确认) · ITSM 租户初始化默认操作员由 bk_admin 变为 admin,默认部署语义改变

📍 bkflow/contrib/itsm_workflow/management/commands/migrate_itsm_workflow.py:36 · 🏷️ F-9847f1d9bd3b · P2

migrate_itsm_workflow.py 第 40-41 行新增回退逻辑:get_admin_username() 返回默认值 admin 时回退为历史兼容值 bk_admin,默认部署(未配置 bkAdminUsername/BK_ADMIN_USERNAME)下 ITSM4 system_create/system_migrate 的 operator 恢复为 bk_admin,不再静默变为 admin,历史兼容语义已修复。

🧩 当前代码证据

bkflow/contrib/itsm_workflow/management/commands/migrate_itsm_workflow.py:41

            username = "bk_admin"

以上为静态代码复核,未运行测试;无法确认项继续保留,不自动关闭讨论。

@dengyh
dengyh merged commit 7008e95 into TencentBlueKing:master Nov 19, 2026
9 of 10 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants