Skip to content

Security: x1n-Q/SecScan

SECURITY.md

Security Policy

Supported Versions

Version Supported
1.x Yes
older versions No

Reporting a Vulnerability

Please do not report security vulnerabilities in public issues.

Use one of these private channels instead:

  • GitHub Security Advisories, if enabled for the repository
  • direct maintainer contact, if listed in the repository profile

Include:

  • a clear description of the issue
  • affected version or commit
  • impact and likely severity
  • steps to reproduce
  • logs, proof of concept, or screenshots if needed

Response Targets

  • initial acknowledgment within 72 hours
  • first triage decision within 7 days
  • remediation timing depends on severity and complexity

Safe Testing Rules

Test only on:

  • your own systems
  • isolated labs
  • environments where you have explicit permission

Do not use this project to scan or probe third-party infrastructure without authorization.

Repository Abuse Boundary

This repository includes code that can run active security checks. To keep the project on the defensive side of the line, maintainers should reject contributions that add or normalize:

  • credential theft
  • spyware or keylogging
  • persistence or lateral movement
  • exploit chaining for unauthorized access
  • covert exfiltration
  • stealth, anti-forensics, or attribution removal
  • default scanning of arbitrary internet targets without user intent

Known Operational Risk Areas

The most sensitive parts of this repository are the active web and network scanners, including wrappers for Sqlmap, Nmap, OWASP ZAP, and the built-in Dirb, Nikto, and XssPy style checks.

These features are useful in authorized testing, but they should be documented carefully and kept opt-in.

Secrets Handling

Never commit:

  • personal access tokens
  • API keys
  • session cookies
  • scan targets that are confidential
  • raw reports containing customer secrets

For public branches and releases, sample or demo content must use obviously synthetic placeholders. Do not commit provider-shaped tokens such as AWS keys, GitHub PATs, Stripe keys, session cookies, or private-key blocks, even when they are meant as fake examples.

If you need positive local secret-scanner findings for testing, keep that detector bait in ignored files such as .env.local and do not push it.

Gitleaks Scanner Safety

This repository includes Gitleaks, a secrets scanner that detects accidentally committed credentials.

How it protects you:

  • Scans your repository history for exposed secrets
  • Masks secrets in all output (never shows full values)
  • Automatically cleans report files after scanning
  • Warns you with location and secret type

If Gitleaks finds secrets:

  1. Stop immediately - do not push/share the code
  2. Rotate the exposed credential in all systems
  3. Use git-filter-repo to remove from history
  4. Force-push the cleaned history to your repository
  5. Notify team members who may have pulled the code

If a secret is accidentally committed, rotate it immediately and remove it from follow-up history where possible.

Further Reading

There aren't any published security advisories