Skip to content

Security: SahirVhora/starlearn

Security

SECURITY.md

Security Policy

Supported Versions

This project is actively maintained. Security updates are applied to the latest release.

Reporting a Vulnerability

If you discover a security vulnerability, please report it responsibly.

DO NOT open a public GitHub issue for security vulnerabilities.

How to Report

  1. Email: Send details to security@sahirvhora.com
  2. Include:
    • Description of the vulnerability
    • Steps to reproduce
    • Potential impact
    • Suggested fix (if any)

What to Expect

  • Acknowledgment: Within 48 hours
  • Initial assessment: Within 1 week
  • Fix timeline: Depends on severity
    • Critical: 24-48 hours
    • High: 1 week
    • Medium: 2 weeks
    • Low: Next release cycle

Disclosure Policy

  • Vulnerabilities will be disclosed publicly after a fix is available
  • Credit will be given to reporters (unless anonymity requested)
  • Coordinated disclosure preferred

Security Best Practices

This project follows security best practices:

  • Dependencies are monitored via Dependabot
  • No secrets or credentials in source code
  • Input validation on all user-facing endpoints
  • HTTPS enforced for all web services
  • Regular security audits

Security Updates

Security updates are released as patch versions. Subscribe to releases to stay informed.

License

This security policy is part of the project's MIT license.

StarLearn can request AI hints from OpenRouter using a user-provided API key stored locally in the browser.

API Keys

  • Do not hard-code OpenRouter keys in the repository.
  • Do not paste keys into issues, pull requests, screenshots, or demo videos.
  • Browser-stored keys are intended for personal use. Avoid using them on shared school or library devices.
  • Rotate any key that is accidentally exposed.

Learner Privacy

  • Avoid entering children's full names, school names, addresses, or other identifying details.
  • AI hints should be reviewed by a parent or teacher when accuracy matters.
  • Progress tracking should remain local unless a future backend adds explicit consent and retention controls.

There aren't any published security advisories