This interface is used to provide a property one can "match" against. This can be for example something string-based (such as name) or others structures like a software identifier.

PropertyProvider

interface PropertyProvider<T : Property<*>>

This interface is used to provide a property one can "match" against. This can be for example a name or a version.

PropertySource

enum PropertySource : Enum<PropertySource>

PurlProperty

class PurlProperty(value: Purl) : Property<Purl>

A property that represents a PURL value.

PurlPropertyProvider

object PurlPropertyProvider : PropertyProvider<PurlProperty>

The PurlPropertyProvider is a PropertyProvider that provides the CPE of a product as a PurlProperty.

StringProperty

class StringProperty(value: String, source: PropertySource) : Property<String>

A property that represents a string value.

VendorProperty

typealias VendorProperty = StringProperty

A property that presents a vendor.

VendorPropertyProvider

object VendorPropertyProvider : PropertyProvider<VendorProperty>

The VendorPropertyProvider is a PropertyProvider that provides the vendor of a product as a VendorProperty.

Properties

dashUnderscoreRegex

val dashUnderscoreRegex: <Error class: unknown class>

Functions

confidenceMatching

fun Purl.confidenceMatching(other: Purl): MatchingConfidence

Matches PURLs with confidence.

gatherComponentProperties

fun <T : Property<*>> PropertyProvider<T>.gatherComponentProperties(node: Node): Map<PropertySource, T>

This extension function is used to gather all properties from a PropertyProvider for a Node (component).

gatherVulnerableProperties

fun <T : Property<*>> PropertyProvider<T>.gatherVulnerableProperties(vulnerable: ProductWithBranches): Map<PropertySource, T>

This extension function is used to gather all properties from a PropertyProvider for a ProductWithBranches.

toProductProperty

fun Vers.toProductProperty(source: PropertySource): ProductVersionProperty

A little helper extension to convert a Vers to a ProductVersionProperty (using ProductVersion.Range).

toProductVersion

fun String.toProductVersion(): ProductVersion.Fixed

A little helper extension to convert a string to a ProductVersion.Fixed.

toProperty

fun Cpe.toProperty(): CpeProperty

A little helper extension to convert a Cpe to a CpeProperty.

fun Purl.toProperty(): PurlProperty

A little helper extension to convert a Purl to a PurlProperty.

fun ProductVersion.toProperty(source: PropertySource): ProductVersionProperty

A little helper extension to convert a ProductVersion to a ProductVersionProperty.

fun String.toProperty(source: PropertySource): StringProperty

A little helper extension to convert a nullable string to a StringProperty.