Skip to content

docs: add security documentation for FFI trust model and API key handling (closes #69)#162

Merged
s2x merged 1 commit into
mainfrom
docs/issue-69-security-documentation
Jul 7, 2026
Merged

docs: add security documentation for FFI trust model and API key handling (closes #69)#162
s2x merged 1 commit into
mainfrom
docs/issue-69-security-documentation

Conversation

@s2x

@s2x s2x commented Jul 7, 2026

Copy link
Copy Markdown
Contributor

Description

Closes #69

Changes

  • README.md: Added Security section with 5 subsections (Trust Model, Input Validation, Memory Limits, File Permissions, Supply Chain) and Known Security Limitations table (SEC-001, SEC-002, SEC-004, SEC-008, SEC-012)
  • SECURITY.md: Updated vulnerability disclosure with response-time commitment (48h), FFI Security Model, Supply Chain, and API Key Safety sections; cross-reference to README Security section
  • OpenAIDenseEmbedding.php: Updated PHPDoc to reference SECURITY.md for API key handling guidelines; example uses getenv() pattern
  • QwenDenseEmbedding.php: Same PHPDoc updates as OpenAI
  • CHANGELOG.md: Added DOC-010 entry

Testing

  • php -l syntax check on all modified PHP files (no errors)
  • All .phpt tests pass (pre-existing failure in bug_0006 is FFI-library missing, unrelated)
  • No test database leftovers

Code Review

  • Passed subagent code review
  • All review comments addressed (3 issues fixed: DOC-010 section placement, duplicate Security sections, SEC range wording)

…ling (closes #69)

- Add Security section to README with 5 subsections (Trust Model, Input
  Validation, Memory Limits, File Permissions, Supply Chain) + Known Security
  Limitations table (SEC-001 through SEC-012)
- Update SECURITY.md with vulnerability disclosure response-time commitment,
  FFI security model, supply chain notes, and API key safety guidance
- Update OpenAIDenseEmbedding and QwenDenseEmbedding PHPDoc to reference
  SECURITY.md for API key handling; examples use getenv() pattern
@s2x s2x self-assigned this Jul 7, 2026
@s2x
s2x merged commit 4ebd664 into main Jul 7, 2026
3 checks passed
@s2x
s2x deleted the docs/issue-69-security-documentation branch July 7, 2026 13:01
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.

DOC-010: Missing Security Documentation

1 participant