Class OwaspApiEntry

Namespace

Kuestenlogik.Bowire.Security.Scanner

Assembly

Kuestenlogik.Bowire.Security.Scanner.dll

One entry in the OWASP API Security Top 10 (2023) taxonomy.

public sealed record OwaspApiEntry : IEquatable<OwaspApiEntry>

Inheritance

object

OwaspApiEntry

Implements

IEquatable<OwaspApiEntry>

Inherited Members

object.GetType()

object.Equals(object, object)

object.ReferenceEquals(object, object)

Constructors

OwaspApiEntry(string, string, string, string)

One entry in the OWASP API Security Top 10 (2023) taxonomy.

public OwaspApiEntry(string Id, string Tag, string Title, string Reference)

Parameters

Id string

Canonical id, e.g. API8:2023.

Tag string

Representative finding tag for this entry, e.g. API8-2023-SECMISCONF — the shape carried by OwaspApi. Roll-up matches on the numeric APIn-2023- prefix, so any tag sharing that prefix maps to this entry regardless of its short suffix.

Title string

Human-readable entry title.

Reference string

Canonical OWASP reference URL.

Properties

Id

Canonical id, e.g. API8:2023.

public string Id { get; init; }

Property Value

string

Prefix

The APIn-2023- prefix a finding tag must start with to roll up to this entry. The trailing dash disambiguates API1 from API10 (API10-2023-… does not start with API1-2023-).

public string Prefix { get; }

Property Value

string

Reference

Canonical OWASP reference URL.

public string Reference { get; init; }

Property Value

string

Tag

Representative finding tag for this entry, e.g. API8-2023-SECMISCONF — the shape carried by OwaspApi. Roll-up matches on the numeric APIn-2023- prefix, so any tag sharing that prefix maps to this entry regardless of its short suffix.

public string Tag { get; init; }

Property Value

string

Title

Human-readable entry title.

public string Title { get; init; }

Property Value

string

Methods

Deconstruct(out string, out string, out string, out string)

public void Deconstruct(out string Id, out string Tag, out string Title, out string Reference)

Parameters

Id string

Tag string

Title string

Reference string

Equals(OwaspApiEntry?)

public bool Equals(OwaspApiEntry? other)

Parameters

other OwaspApiEntry

Returns

bool

Equals(object?)

public override bool Equals(object? obj)

Parameters

obj object

Returns

bool

GetHashCode()

public override int GetHashCode()

Returns

int

ToString()

public override string ToString()

Returns

string

Operators

operator ==(OwaspApiEntry?, OwaspApiEntry?)

public static bool operator ==(OwaspApiEntry? left, OwaspApiEntry? right)

Parameters

left OwaspApiEntry

right OwaspApiEntry

Returns

bool

operator !=(OwaspApiEntry?, OwaspApiEntry?)

public static bool operator !=(OwaspApiEntry? left, OwaspApiEntry? right)

Parameters

left OwaspApiEntry

right OwaspApiEntry

Returns

bool