git.stella-ops.org/publish-platform/StellaOps.BinaryIndex.Contracts.xml

<?xml version="1.0"?>
<doc>
    <assembly>
        <name>StellaOps.BinaryIndex.Contracts</name>
    </assembly>
    <members>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest">
            <summary>
            Request to resolve vulnerability status for a binary.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.Package">
            <summary>
            Package URL (PURL) or CPE identifier.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.FilePath">
            <summary>
            File path within container/filesystem.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.BuildId">
            <summary>
            ELF Build-ID, PE CodeView GUID, or Mach-O UUID.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.Hashes">
            <summary>
            Hash values for matching.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.Fingerprint">
            <summary>
            Fingerprint bytes (Base64-encoded).
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.FingerprintAlgorithm">
            <summary>
            Fingerprint algorithm if fingerprint provided (e.g., "combined", "tlsh", "ssdeep").
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.CveId">
            <summary>
            CVE to check (optional, for targeted queries). If not provided, checks all known CVEs.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionRequest.DistroRelease">
            <summary>
            Distro hint for fix status lookup (e.g., "debian:bookworm").
            </summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionHashes">
            <summary>
            Hash values for binary matching.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionHashes.FileSha256">
            <summary>SHA-256 hash of the entire file.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionHashes.TextSha256">
            <summary>SHA-256 hash of the .text section.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionHashes.Blake3">
            <summary>BLAKE3 hash (future-proof).</summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse">
            <summary>
            Response from vulnerability resolution.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.Package">
            <summary>Package identifier from request.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.Status">
            <summary>Resolution status.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.FixedVersion">
            <summary>Version where fix was applied (if status is Fixed).</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.Evidence">
            <summary>Evidence supporting the resolution.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.AttestationDsse">
            <summary>DSSE attestation envelope (Base64-encoded JSON).</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.ResolvedAt">
            <summary>Timestamp when resolution was computed.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.FromCache">
            <summary>Whether result was served from cache.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.VulnResolutionResponse.CveId">
            <summary>CVE ID if a specific CVE was queried.</summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionStatus">
            <summary>
            Resolution status enumeration.
            </summary>
        </member>
        <member name="F:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionStatus.Fixed">
            <summary>Vulnerability is fixed in this binary (backport detected).</summary>
        </member>
        <member name="F:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionStatus.Vulnerable">
            <summary>Binary is vulnerable.</summary>
        </member>
        <member name="F:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionStatus.NotAffected">
            <summary>Binary is not affected by this CVE.</summary>
        </member>
        <member name="F:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionStatus.Unknown">
            <summary>Resolution status unknown.</summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence">
            <summary>
            Evidence supporting a resolution decision.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.MatchType">
            <summary>Match method used (build_id, fingerprint, hash_exact).</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.Confidence">
            <summary>Confidence score (0.0-1.0).</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.DistroAdvisoryId">
            <summary>Distro advisory ID (e.g., DSA-5343-1, RHSA-2024:1234).</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.PatchHash">
            <summary>SHA-256 of the security patch.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.MatchedFingerprintIds">
            <summary>List of matched fingerprint IDs.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.FunctionDiffSummary">
            <summary>Summary of function-level differences.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.SourcePackage">
            <summary>Source package name.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.ResolutionEvidence.FixMethod">
            <summary>Detection method (security_feed, changelog, patch_header).</summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionRequest">
            <summary>
            Batch request for resolving multiple vulnerabilities.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionRequest.Items">
            <summary>List of resolution requests.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionRequest.Options">
            <summary>Resolution options.</summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.BatchResolutionOptions">
            <summary>
            Options for batch resolution.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchResolutionOptions.BypassCache">
            <summary>Bypass cache and perform fresh lookups.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchResolutionOptions.IncludeDsseAttestation">
            <summary>Include DSSE attestation in responses.</summary>
        </member>
        <member name="T:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionResponse">
            <summary>
            Response from batch vulnerability resolution.
            </summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionResponse.Results">
            <summary>List of resolution results.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionResponse.TotalCount">
            <summary>Total items processed.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionResponse.CacheHits">
            <summary>Number of items served from cache.</summary>
        </member>
        <member name="P:StellaOps.BinaryIndex.Contracts.Resolution.BatchVulnResolutionResponse.ProcessingTimeMs">
            <summary>Processing time in milliseconds.</summary>
        </member>
    </members>
</doc>