定位:身份层(IdP + IAP),不含动态域名转发 / LLM 上游代理 / 用量计费。 代码(source/rust,nginx 动态模块 + Rust,单进程零外部依赖) - IdP:authorization_code(含 PKCE)/ refresh_token / client_credentials / password 四种 grant,含 discovery / introspect / userinfo / jwks 占位 - IAP:access 阶段门禁,注入 X-Auth-* 到后端,客户端伪造同名头被覆盖 - MaxKey 互通:/oauth/v20/* 与 /oauth2.0/* 别名 + context-path 归一化 + 扁平字段 - 管理接口:账号(含角色/部门/用户组)与 OAuth 接入方注册表,热写穿共享内存 - 模块改名 ngx_http_sso_module,指令 sso_state / sso_data_dir / sso_api / sso_iap, Cookie sso_sid(终端用户)与 sso_admin_session(管理员)两套身份两套会话 配置(source/conf) - nginx.conf 生产模板(TLS、IAP 子域、含 auth_sub 的日志格式) - nginx.test.conf 本机验证配置(明文 18095-18099) - tls/README.md 证书约定与公钥比对校验 前端(source/www/admin.html) - 三 tab:账号管理 / 接入方 / 接入指南;去掉审核队列、域名、LLM 上游、用量统计 测试与脚本 - tests/ 三套端到端:协议基线 14 项 · MaxKey 互通与接入 24 项 · 管理接口 31 项,全绿 - tests/demo-system 演示业务系统(Python 标准库),覆盖应用自建客户端与 IAP 零改造两种姿势 - scripts/run-local-e2e.sh 本机一键起停;scripts/seed-data.sh 物化运行时数据目录 文档 - README.md 概览与快速开始;CLAUDE.md 硬约定与排障速查 - docs/design.md 完整设计;docs/roadmap.md 待执行任务(v2 RS256+JWKS、用户管理界面)
2.3 KiB
2.3 KiB
Contributing Guidelines
The following is a set of guidelines for contributing. We really appreciate that you are considering contributing!
Table Of Contents
Ask a Question
Please ask your question on github using discussions.
Contributing
Report a Bug
To report a bug, open an issue on GitHub with the label bug using the available bug report issue template. Please ensure the issue has not already been reported.
Suggest an Enhancement
To suggest an enhancement, please create an issue on GitHub with the label enhancement using the available feature issue template.
Open a Pull Request
- Fork the repo, create a branch, submit a PR when your changes are tested and ready for review.
- Fill in our pull request template
Note: if you’d like to implement a new feature, please consider creating a feature request issue first to start a discussion about the feature.
Style Guides
Git Style Guide
- Keep a clean, concise and meaningful git commit history on your branch, rebasing locally and squashing before submitting a PR
- Use the Conventional Commits format when writing a commit message, so that changelogs can be automatically generated
- Follow the guidelines of writing a good commit message as described here and summarised in the next few points
- In the subject line, use the present tense ("Add feature" not "Added feature")
- In the subject line, use the imperative mood ("Move cursor to..." not "Moves cursor to...")
- Limit the subject line to 72 characters or less
- Reference issues and pull requests liberally after the subject line
- Add more detailed description in the body of the git message (
git commit -ato give you more space and time in your text editor to write a good message instead ofgit commit -am)
Rust Style Guide
- Rust code should be checked in after
cargo fmthas been run. - The code style broadly complies with the official Rust Style Guide.
- Where feasible, include unit tests.