Skip to content

Security: hckhanh/fast-url

SECURITY.md

Security Policy

Supported Versions

We release patches for security vulnerabilities. Currently supported versions:

Version Supported
4.x.x
< 4.0

Reporting a Vulnerability

We take the security of fast-url seriously. If you believe you have found a security vulnerability, please report it to us as described below.

Please do NOT:

  • Open a public GitHub issue for security vulnerabilities
  • Disclose the vulnerability publicly before it has been addressed

Please DO:

Report security vulnerabilities by email to: [email protected]

Please include the following information in your report:

  • Type of vulnerability (e.g., XSS, injection, etc.)
  • Full paths of source file(s) related to the vulnerability
  • Location of the affected source code (tag/branch/commit or direct URL)
  • Step-by-step instructions to reproduce the issue
  • Proof-of-concept or exploit code (if possible)
  • Impact of the vulnerability, including how an attacker might exploit it

What to expect:

  1. Acknowledgment: We will acknowledge receipt of your vulnerability report within 48 hours
  2. Communication: We will keep you informed about our progress throughout the process
  3. Assessment: We will investigate and confirm the vulnerability within 7 days
  4. Fix: We will work on a fix and release timeline
  5. Disclosure: Once the vulnerability is patched, we will publicly disclose it, crediting you (unless you prefer to remain anonymous)

Security Best Practices

When using fast-url in your applications:

  1. Keep Dependencies Updated: Regularly update to the latest version of fast-url to receive security patches
  2. Input Validation: While fast-url handles URL encoding automatically, always validate user input before passing it to URL building functions
  3. Use TypeScript: Take advantage of TypeScript's type safety to catch potential issues at compile time
  4. Review URLs: In security-sensitive contexts, review generated URLs before using them in production

Scope

The following are considered in scope for security reports:

  • URL injection vulnerabilities
  • Parameter encoding bypass
  • XSS vectors through URL construction
  • Path traversal vulnerabilities
  • Any behavior that could lead to security issues in applications using fast-url

Out of Scope

The following are generally not considered security vulnerabilities:

  • Issues requiring physical access to a user's device
  • Social engineering attacks
  • Issues in outdated/unsupported versions
  • Theoretical vulnerabilities without proven exploit path

Attribution

We believe in recognizing security researchers who help keep our project safe. If you report a valid security vulnerability, we will:

  • Credit you in the release notes (unless you prefer to remain anonymous)
  • List you in our security acknowledgments
  • Provide updates on the fix and release timeline

Contact

For any questions about this security policy, please contact: [email protected]

Learn More

For general bugs and feature requests, please use our GitHub Issues.

There aren’t any published security advisories