Skip to content

SECURITY.md

Latest commit

 

History

History
54 lines (37 loc) · 1.63 KB

SECURITY.md

File metadata and controls

54 lines (37 loc) · 1.63 KB

Security Policy

Supported Versions

Version Supported
0.1.x ✅

Reporting a Vulnerability

If you discover a security vulnerability within snip, please send an email to the maintainer. All security vulnerabilities will be promptly addressed.

Please include the following:

  • Type of vulnerability
  • Full paths of source file(s) related to the vulnerability
  • Location of the affected source code
  • Any special configuration required to reproduce the issue
  • Step-by-step instructions to reproduce the issue
  • Proof-of-concept or exploit code (if possible)
  • Impact of the issue

What to Expect

  • Acknowledgment: Within 48 hours, you'll receive acknowledgment of your report
  • Timeline: We aim to provide a timeline for when the vulnerability will be addressed
  • Updates: You'll be notified of the fix and when a new version is released

Security Best Practices

When using snip:

  1. Review before running — Always preview snippets before execution
  2. Trusted sources only — Only run snippets from trusted sources
  3. GitHub tokens — Never commit GitHub tokens to your snippets
  4. Local storage — Snippets are stored locally in ~/.snip/ by default

Allowed Use Cases

snip is designed to:

  • Save and execute your own code snippets
  • Search and organize reusable commands
  • Share snippets via GitHub Gists (with your consent)

Prohibited Use

  • Executing malicious code
  • Storing credentials or secrets
  • Automating unauthorized access
  • Any use that violates applicable laws

Thank you for helping keep snip and its users safe!