Skip to content

Security: steadytao/surveyor

SECURITY.md

BANNER

Security Policy

If you believe you have found a security issue in Surveyor itself, please do not open a public issue or pull request.

Use GitHub private vulnerability reporting:

If that is not suitable, email is also acceptable:

  • security@steadytao.com

OpenPGP-encrypted email is highly preferred for sensitive matters. My public key and contact details are available at:

Supported Versions

The current supported version is:

Version Supported
v1.0.0 Yes
Earlier versions No

What Is in Scope

Surveyor is a defensive inventory and reporting tool. Security reports should therefore focus on vulnerabilities in Surveyor itself, not on ordinary weaknesses in the systems being scanned.

Examples that may be in scope:

  • unsafe handling of untrusted input
  • unintended network behaviour caused by Surveyor
  • exposure of credentials, tokens, or secrets
  • trust-boundary failures
  • privilege escalation in local or hosted use
  • materially incorrect behaviour caused by a reproducible defect that could lead users to make unsafe decisions

The important point is that the bug needs to be in Surveyor.

What Is Out of Scope

The following are generally out of scope:

  • vulnerabilities in scanned targets
  • ordinary TLS misconfiguration or legacy cryptography discovered by Surveyor as part of its intended function
  • disagreement with a classification outcome unless it is caused by a reproducible defect
  • incorrect conclusions caused by incomplete visibility, middleboxes, or opaque infrastructure where Surveyor is behaving as designed
  • dependency or platform issues outside this repository unless the report shows a vulnerability in how Surveyor uses them
  • reports that depend on unauthorised access or abuse of third-party systems

In short, Surveyor reporting a bad TLS deployment is not itself a security bug in Surveyor.

What Makes a Good Report

Please keep reports practical and reproducible.

Useful reports usually include:

  • affected version, commit, or branch, if known
  • a short explanation of the issue and why it is a vulnerability in Surveyor
  • the smallest possible reproduction
  • exact commands used
  • relevant config, output, logs, or traces
  • expected behaviour and actual behaviour
  • a patch or suggested fix, if you have one

The less guesswork required to reproduce the issue, the easier it is to verify and fix.

Disclosure

Surveyor is a personal open-source project. There is currently no bug bounty programme.

If a report is valid and results in a fix, I will not credit you publicly unless you ask me to. If you do want credit, please say so and include the name and handle to use.

Triage and Remediation Commitments

Surveyor treats confirmed exploitable vulnerabilities found through static analysis, dynamic analysis, manual review or external reports as release-blocking issues when they affect a proposed production release.

The project commits to the following minimum response standard once a vulnerability is confirmed:

  • critical and high severity issues are triaged immediately and fixed or mitigated as a priority
  • medium severity exploitable issues are fixed or mitigated within 60 days at the latest
  • low severity issues are still tracked and prioritised, but they do not carry the same remediation deadline

For the purposes of this policy, severity should follow the latest available CVSS assessment, whether from a widely used public database or a project-published assessment with disclosed inputs.

Analysis-Driven Findings

Surveyor runs static and dynamic analysis in CI and before release. Findings from tools such as staticcheck, gosec, govulncheck, race-enabled tests and fuzzing are treated as real engineering inputs, not advisory noise.

Confirmed medium and higher severity exploitable findings from static or dynamic analysis must be fixed in a timely way under the remediation commitments above.

There aren’t any published security advisories