docs: add IvorySQL 5 passwordcheck adaptation guide - #305
Open
messere1 wants to merge 4 commits into
Open
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new docs include a couple of scope/grammar ambiguities and the CN nav edit appears to introduce mixed line endings, which should be corrected before merging.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Adds new bilingual documentation for the passwordcheck contrib module in IvorySQL 5, and integrates it into the docs navigation and ecosystem overview tables so users can discover and follow build/config/validation steps.
Changes:
- Add new EN/CN
passwordcheckadaptation guides with build, configuration, validation, and limitations sections. - Register
passwordcheckin both EN/CN ecosystem overview tables. - Add
passwordcheckto both EN/CN navigation trees.
File summaries
| File | Description |
|---|---|
| EN/modules/ROOT/pages/master/ecosystem_components/passwordcheck.adoc | New EN guide for passwordcheck build/config/validation/limitations. |
| EN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc | Add passwordcheck row to EN ecosystem component table. |
| EN/modules/ROOT/nav.adoc | Add passwordcheck page to EN navigation. |
| CN/modules/ROOT/pages/master/ecosystem_components/passwordcheck.adoc | New CN guide for passwordcheck build/config/validation/limitations. |
| CN/modules/ROOT/pages/master/ecosystem_components/ecosystem_overview.adoc | Add passwordcheck row to CN ecosystem component table. |
| CN/modules/ROOT/nav.adoc | Add passwordcheck page to CN navigation. |
Review details
Suppressed comments (2)
EN/modules/ROOT/pages/master/ecosystem_components/passwordcheck.adoc:35
- The paragraph frames
LOADas a temporary one-session test, but the commands shown (ALTER SYSTEM+pg_reload_conf()) change the setting instance-wide. Reword to make the scope consistent with the example.
For a temporary test, a superuser can run `LOAD 'passwordcheck';` in one session. The minimum length defaults to 8 bytes and can be changed by a superuser:
CN/modules/ROOT/pages/master/ecosystem_components/passwordcheck.adoc:35
- 同一段落先强调“当前会话临时测试”，但后面的示例使用
ALTER SYSTEM+pg_reload_conf()，实际会修改实例级别配置。建议改写说明以避免读者误以为是会话级变更。
超级用户也可在当前会话执行 `LOAD 'passwordcheck';` 临时测试。最小长度默认为 8 字节，超级用户可调整：
- Files reviewed: 6/6 changed files
- Comments generated: 4
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
Comment on lines
+78
to
+79
| *** xref:master/ecosystem_components/set_user.adoc[set_user] | ||
| *** xref:master/ecosystem_components/passwordcheck.adoc[passwordcheck] |
|
|
||
| == 配置 | ||
|
|
||
| 如需在所有连接中一致执行密码策略，请在 `ivorysql.conf` 中将模块加入 `shared_preload_libraries` 并重启 IvorySQL： |
|
|
||
| == Overview | ||
|
|
||
| `passwordcheck` is a module shipped with the IvorySQL source tree. It rejects weak passwords when `CREATE ROLE`, `CREATE USER`, or `ALTER ROLE` receives a plaintext password. It is a lightweight baseline policy; deployments that need dictionary checks, password history, or centralized identity policy should use a dedicated authentication system. |
|
|
||
| == Configuration | ||
|
|
||
| For consistent enforcement, add the module to `shared_preload_libraries` in `ivorysql.conf` and restart IvorySQL: |
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
|
🚀 IvorySQL-Docs Preview Ready
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary\n\n- add bilingual build and configuration instructions for passwordcheck\n- document the module's actual plaintext password checks and pre-encrypted password limitation\n- include reproducible PostgreSQL and Oracle-compatible regression commands\n- add the component to both navigation files and ecosystem overview tables\n\n## Validation\n\nValidated on IvorySQL 5.6 / PostgreSQL 18.6:\n\n- PGPORT=5432 make installcheck — passed\n- PGPORT=1521 make oracle-installcheck — passed\n- manual weak and strong password cases — passed\n\nFixes IvorySQL/IvorySQL#1102