@pandatix/js-cvss/dist/cvss40.d.ts

JavaScript implementation of the CVSS (Common Vulnerability Scoring System) standard from FIRST.ORG.

/**
 * Implementation of the CVSS v4.0 specification (https://www.first.org/cvss/v4.0/specification-document).
 */
export declare class CVSS40 {
    private _metrics;
    /**
     * Construct a CVSS v4.0 object, and parse the vector if provided.
     * If not, the Base metrics is set to the default values (score = 0).
     *
     * @param vector The vector to parse.
     * @throws When the vector is invalid.
     */
    constructor(vector?: string);
    /**
     * Parse the provided vector.
     * Makes use of the regex for code simplicity, but we could use the
     * `metrics` constant to provide better accurate error messages.
     *
     * @param vector The vector to parse.
     * @throws When the vector is invalid.
     */
    private parse;
    /**
     * Return the vector string representation of the CVSS v4.0 object.
     *
     * @return The vector string representation.
     */
    Vector(): string;
    /**
     * Get the metric value given its value (e.g. 'AV').
     *
     * @param metric The metric to get the value of.
     * @return The corresponding metric value.
     * @throws Metric does not exist.
     */
    Get(metric: string): string;
    /**
     * Set the metric value given its key and value (e.g. 'AV' and 'L').
     *
     * @param metric The metric to set the value of.
     * @param value The corresponding metric value.
     * @throws Metric does not exist or has an invalid value.
     */
    Set(metric: string, value: string): void;
    /**
     * Compute the CVSS v4.0 Score of the current object, given its metrics and their
     * corresponding values.
     *
     * The implementation internals are largely based upon https://github.com/pandatix/go-cvss
     * submodule 40.
     *
     * @return The score (between 0.0 and 10.0 both included).
     */
    Score(): number;
    /**
     * Gives the nomenclature of the current CVSS v4.0 object i.e. its structure
     * according to the Base, Threat and Environmental metric groups.
     *
     * @return The nomenclature string.
     */
    Nomenclature(): string;
    private getReal;
    private macrovector;
    private static severityDistance;
    private static getValue;
    private static roundup;
    /**
     * Give the corresponding rating of the provided score.
     *
     * @param score The score to rate.
     * @return The rating.
     * @throws When the score is out of bounds.
     */
    static Rating(score: number): 'CRITICAL' | 'HIGH' | 'MEDIUM' | 'LOW' | 'NONE';
}