docs(security): clarify insecure transport policy - #2910
docs(security): clarify insecure transport policy#2910Ching Wei Kang (WilliamK112) wants to merge 3 commits into
Conversation
There was a problem hiding this comment.
🟡 Changes recommended
The new docs contract test is brittle to Markdown formatting and doesn’t explicitly guard against the original misleading sentence reappearing.
Once you've addressed the issues Copilot identified, you can request another Copilot review.
Pull request overview
Updates APM enterprise security documentation to accurately describe how insecure HTTP dependencies are governed (manifest + CLI gating, not policy transport enforcement), and adds a unit test to prevent the previously misleading claim from reappearing.
Changes:
- Clarifies in
enterprise/security.mdthatapm-policy.ymlhas no dedicatedallow_insecurefield and that dependency allow/deny patterns are identity-based (not HTTPS enforcement). - Adds an example restrictive dependency allow list with an explicit warning that it does not enforce HTTPS.
- Adds a docs contract test to lock in the corrected guidance.
File summaries
| File | Description |
|---|---|
| docs/src/content/docs/enterprise/security.md | Rewrites “Recommended hardening” guidance to correctly separate policy identity controls from insecure-transport (HTTP) approvals. |
| tests/unit/test_tls_docs_scope.py | Adds a regression/contract test that asserts the corrected security-doc wording remains present. |
Review details
- Files reviewed: 2/2 changed files
- Comments generated: 1
- Review effort level: Lite
💡 Add a code-review agent skill or configure MCP servers for context-aware, tailored reviews. Learn more in the docs.
|
A duplicate-PR audit surfaced one terminology issue, now corrected in |
Description
Corrects the Recommended hardening guidance so it matches APM's current transport and policy behavior.
The previous sentence said organizations could forbid
allow_insecure: true“via the policy allow list.” That is not a control the policy engine provides: dependency allow/deny patterns match scheme-blind canonical package identities. The defaultgithub.comhost is omitted while non-default hosts are retained, so policy can restrict package and host identity but cannot distinguish an HTTP source from an HTTPS source for the same canonical host and path.This update:
apm-policy.ymlhas no dedicatedallow_insecurefieldallow_insecure: trueand insecure CLI flags in standard CI when an organization wants an HTTPS-only ruleregistry_source.allow_non_registrycontrols source routing, not transport securityFixes #2346
Type of change
Testing
pytest -q tests/unit/test_tls_docs_scope.py(9 passed)git diff --checkSpec conformance (OpenAPM v0.1)