If you discover a security vulnerability in this project, please report it responsibly.
Do not open a public GitHub issue for security vulnerabilities.
Instead, use one of the following methods:
- GitHub Security Advisories (preferred): Go to the repository's Security tab and click "Report a vulnerability" to submit a private advisory.
- Email: Send details to the maintainers via the contact information in the repository profile.
Please include:
- A description of the vulnerability
- Steps to reproduce
- Potential impact
- Suggested fix (if you have one)
We will acknowledge receipt within 48 hours and provide a timeline for resolution.
This security policy covers:
- Skill code: SKILL.md manifests and sub-skill definitions
- Scripts: All Python scripts in
scripts/(onboard, doctor, schema) - Rules content: Markdown files in
rules/that may contain executable examples - CI/CD workflows: GitHub Actions workflow definitions
This skill interacts with SurrealDB instances and may be used alongside various AI agent frameworks. Follow these rules strictly:
- Never commit API keys, tokens, or passwords to the repository.
- Use environment variables for all credentials:
export SURREAL_USER="root" export SURREAL_PASS="root" export SURREAL_ENDPOINT="http://localhost:8000"
- The
.gitignorefile excludes.envfiles. Use.envfor local development credentials. - Scripts should read credentials from environment variables or CLI arguments, never from hardcoded values.
When working with SurrealDB instances:
- Development: Use default
root/rootcredentials only for local development. Never use these in production. - Production: Use SurrealDB's built-in access control system with properly scoped credentials.
- Connection strings: Never log or print full connection strings that include credentials.
- Scripts:
doctor.pyandschema.pyaccept credentials via CLI flags or environment variables and do not persist them.onboard.py --interactivemay write a local.envfile only after explicit user confirmation.
| Version | Supported |
|---|---|
| 1.x | Yes |
When using this skill with AI coding agents:
- Review any generated SurrealQL before executing it against production databases.
- Use read-only database credentials when running introspection scripts.
- Scope agent permissions to the minimum required namespace and database.
- Audit the
rules/security.mdguide for SurrealDB-specific hardening recommendations.