Skip to main content

Documentation Index

Fetch the complete documentation index at: https://vulhunt-docs.binarly.io/llms.txt

Use this file to discover all available pages before exploring further.

Each scope can return a finding with details about a vulnerability. A finding improves explainability by attaching comprehensive information such as CVSS scores, advisories, evidence (including decompiled code and annotations), and other metadata. Findings are created using one of the methods provided by VulHunt listed below:
MethodDescriptionParametersReturn Type
result:noneCreates a vulnerability finding with no severityTableResult object
result:infoCreates a vulnerability finding with no severity (alias for result:none)TableResult object
result:unspecifiedCreates a vulnerability finding with unspecified severityTableResult object
result:lowCreates a vulnerability finding with low severityTableResult object
result:mediumCreates a vulnerability finding with medium severityTableResult object
result:highCreates a vulnerability finding with high severityTableResult object
result:criticalCreates a vulnerability finding with critical severityTableResult object
result:patchCreates a finding indicating that a patch has been identifiedTableResult object
result:malwareCreates a finding indicating that malware has been identifiedTableResult object
Each method accepts a table with the following fields:
FieldDescriptionTypeRequiredBTP Only
nameCVE ID or unique identifierstringYesNo
descriptionCVE description or finding summarystringYesNo
provenanceProvenance detailsProvenanceTableNoYes
cwesTable of CWE identifiersstring[]NoYes
mbcsTable of MBC identifiersstring[]NoYes
cvssCVSS scoreCVSSNoYes
advisoryURL to the advisorystringNoYes
identifiersTable of identifiers (e.g. CVE, GHSA, OSV…)string[]NoYes
variantsTable of variants of this finding{[string]:VariantTable}NoYes
patchURL to the patchstringNoYes
sourceURL to the source file or repositorystringNoYes
evidenceEvidence detailsEvidenceYesNo
notesNotes related to the finding{[string]: string}NoYes
referencesAdditional references{[string]: string}NoYes
The “BTP Only” column indicates fields that are only relevant when a VulHunt rule is executed on the Binarly Transparency Platform.

​
Reference

​
name

CVE ID or unique identifier for the vulnerability finding.

​
description

A short summary or description of the vulnerability or finding.

​
provenance

A ProvenanceTable describing the origin and context of a component related to the finding.

​
cwes

A table of CWE identifiers associated with the finding.

​
mbcs

A table of MBC (Malware Behavior Catalog) identifiers associated with the finding.

​
cvss

The CVSS information for the finding.

​
advisory

URL to the official advisory related to the vulnerability.

​
identifiers

A table of identifiers for the finding (e.g., CVE, GHSA, OSV, etc.).

​
variants

A list or map of variant objects describing related vulnerabilities or variations.

​
patch

URL to the patch that addresses the vulnerability.

​
source

URL to the source file or repository where the vulnerability was found.

​
evidence

Evidence details supporting the finding, such as code snippets or annotations.

​
notes

Notes related to the vulnerability or the finding, provided as a table of title/text pairs.

​
references

Additional references related to the vulnerability, provided as a table of title/URL pairs.

​
Example

return result:critical{
  name = "CVE-2024-5535",
  description = "Buffer over-read in the `SSL_select_next_proto` function of OpenSSL",
  provenance = {
    kind = "posix.ELF",
    linkage = "project",
    vendor = "openssl",
    product = "openssl",
    license = "Apache-2.0",
    affected_versions = {
      "<1.0.2zk", "<1.1.1za", "<3.0.15", "<3.1.7", "<3.2.3", "<3.3.2"
    }
  },
  cwes = {"CWE-200"},
  mbcs = {"OC0006", "B0011"},
  cvss = cvss:v3_1{
    base = "9.1",
    exploitability = "3.9",
    impact = "5.2",
    vector = "AV:N/AC:L/PR:N/UI:N/S:U/C:H/I:N/A:H"
  },
  advisory = "https://openssl-library.org/news/secadv/20240627.txt",
  identifiers = {"CVE-2024-5535", "GHSA-4fc7-mvrr-wv2c"},
  variants = {
    ["OpenSSL"] = {
      severity = "low",
      references = {
        ["OpenSSL Advisory"] = "https://openssl-library.org/news/secadv/20240627.txt"
      },
      notes = {
        ["Note"] = "OpenSSL calculated severity differs from CISA-ADP calculations"
      }
    }
  },
  patch = "https://github.com/openssl/openssl/commit/e86ac436f0bd54d4517745483e2315650fae7b2c.patch",
  source = "https://github.com/openssl/openssl/blob/openssl-3.0.12/ssl/ssl_lib.c",
  evidence = {
    functions = {
      [context.address] = {
        annotate:prototype(prototype),
        annotate:at{
          location = context.address,
          message = "The `SSL_select_next_proto` function does not properly validate the client buffer (5th parameter)."
        },
        annotate:at{
          location = address,
          message = "Passing an empty buffer can result in a crash or memory leak due to the return of an invalid memory pointer."
        }
      }
    }
  }
}