rootshell/cvss-calculator

A PHP library for calculating CVSS security scores.

1.4.4 2024-02-27 11:27 UTC

Requires

• php: ^8.1 || ^8.2 || ^8.3
• ext-json: *

Requires (Dev)

• doctrine/coding-standard: ^12.0
• infection/infection: ^0.27.8
• php-coveralls/php-coveralls: ^2.7.0
• phpunit/phpunit: ^10.4.2
• vimeo/psalm: ^5.16.0

MIT

• security
• calculator
• cvss

README

rootshell/cvss-calculator is a PHP library for translating a CVSS security vector into its relative score. Current support is for CVSS2, CVSS3, CVSS3.1 and CVSS4.0.

This project adheres to a Contributor Code of Conduct. By participating in this project and its community, you are expected to uphold this code.

Installation

The preferred method of installation is via Composer. Run the following command to install the package and add it as a requirement to your project's composer.json:

composer require rootshell/cvss-calculator

Usage

The Cvss calculator can be called statically and pass a CVSS string. A CvssResult Object will be returned with the three result types.

If the vector is invalid A CvssException will be thrown.

use Rootshell\Cvss\Cvss;
use Rootshell\Cvss\Exceptions\CvssException;

try {
$result = Cvss::generateScores('CVSS:3.1/AV:A/AC:L/PR:L/UI:N/S:U/C:H/I:H/A:H');
} catch (CvssException $e) {
    return 'Error!';
}

echo $result->baseScore; // 8.0
echo $result->temporalScore; // 8.0
echo $result->environmentalScore; // 8.0

Copyright and License

The rootshell/cvss-calculator library is copyright © Rootshell Security LTD and licensed for use under the MIT License (MIT). Please see LICENSE for more information.