joomla/cve

Joomla CVE Package

2.0.0 2022-08-15 14:06 UTC

This package is auto-updated.

Last update: 2022-09-21 17:04:47 UTC


README

Latest Stable Version Total Downloads Latest Unstable Version License

Requires PHP 7 >= 7.3 or PHP 8 < 8.2

Using the CVE Package

tbd

Instantiating CVE

Instantiating CVE Service is easy:

use Joomla\Cve\CveService;

$cve = new CveService;

This creates a basic Github object that can be used to access publicly available resources on mitre.org.

In most cases it is necessary to specify additional options. This can be done by injecting in a Registry object with your preferred options. Support is available for optionally providing a custom CVE account username and password, as well as a custom URL for the CVE API server (as would be the case for testing purposes).

use Joomla\Cve\CveService;
use Joomla\Registry\Registry;

$options = new Registry;
$options->set('api.org', 'cve_org');
$options->set('api.username', 'cve_username');
$options->set('api.key', 'cve_key');
$options->set('api.url', 'http://localhost:3000');

$cve = new CveService($options);

Available Options

Option key Description
api.key The key associated with the user to access the API.
api.org The organisation represented by the user.
api.url The URL for the API calls, defaults to 'https://cveawg.mitre.org/api'. Set it to 'http://localhost:3000' for integration tests against the cveawg Docker container.
api.username The username for the CVE account.
userAgent The user agent to use for requests. Defaults to 'Joomla-CVE/2.0'

Installation via Composer

Add "joomla/cve": "~2.0@dev" to the require block in your composer.json and then run composer install.

{
	"require": {
		"joomla/cve": "~2.0@dev"
	}
}

Alternatively, you can simply run the following from the command line:

composer require joomla/cve "~2.0@dev"

If you want to include the test sources, use

composer require --prefer-source joomla/cve "~2.0"