Document security #119
Merged
Document security #119
Conversation
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
Add detailed security policy documentation to address issue #35 about end-user security guarantees and limitations. Changes: - Add SECURITY.md with comprehensive security documentation covering: - Built-in security guarantees (no disk/network access, sandboxed execution) - Known limitations (DoS vulnerabilities, no resource limits) - Data injection risks and XSS concerns - Third-party extension security considerations - Production deployment recommendations with code examples - Security best practices and audit status - Update README.md to reference security documentation - Add Security section to table of contents - Add Security section with key highlights and link to SECURITY.md The security documentation provides transparency about what protections users can rely on and what additional safeguards they need to implement when processing untrusted templates in production environments. Fixes #35
Expand the comparison section in SECURITY.md to provide comprehensive analysis of security differences between the Go and Ruby implementations. Enhancements: - Add detailed comparison of production battle-testing - Document Ruby's built-in resource limiting capabilities (render_score_limit, render_length_limit, assign_score_limit) - Compare memory safety and type system characteristics - Analyze community security review differences - Add "Bottom Line: Which to Choose?" decision guide - Provide specific recommendations for when to use each implementation - Include must-implement safeguards for Go with untrusted templates This gives users clear guidance on which implementation to choose based on their security requirements and use case. Related to #35
Update security documentation to reflect that FRender (merged in v1.4.0) provides timeout and output size limiting capabilities for untrusted templates. Changes to SECURITY.md: - Add "Mitigation via FRender" section explaining available protections - Replace goroutine-based timeout example with proper FRender+context approach - Add comprehensive FRender examples for timeouts, size limits, and combined protection - Update Ruby comparison to show Go now has timeout/size limiting via FRender - Revise "Bottom Line: Which to Choose?" with more balanced comparison - Update best practices to recommend FRender for untrusted templates - Cross-reference docs/FRender.md for detailed examples Changes to README.md: - Update security section to mention FRender resource limiting - Link to FRender documentation for implementation details - Remove outdated claim of "no built-in" limits (now available via FRender) Key improvements: - FRender provides proper cancellation (stops rendering, not just detection) - Output size limiting equivalent to Ruby's render_length_limit - No resource leaks from continuing goroutines - Composable writer pattern for flexible security controls The Go implementation now has comparable timeout and output limiting to Ruby, though Ruby still has advantages in automatic complexity scoring. Related to #35
Add Claude Code co-authorship to SECURITY.md version history.
osteele
deleted the
claude/add-project-documentation-011CUv7P3YWoPCESsrQa6XDx
branch
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.
Checklist
make testpasses.make lintpasses.