https://github.com/joomla-framework/cve-api
Joomla Framework CVE package
https://github.com/joomla-framework/cve-api
Last synced: about 1 year ago
JSON representation
Joomla Framework CVE package
- Host: GitHub
- URL: https://github.com/joomla-framework/cve-api
- Owner: joomla-framework
- License: gpl-2.0
- Created: 2021-01-28T15:00:35.000Z (over 5 years ago)
- Default Branch: 3.x-dev
- Last Pushed: 2024-10-08T21:11:36.000Z (over 1 year ago)
- Last Synced: 2025-04-13T07:56:18.986Z (about 1 year ago)
- Language: PHP
- Size: 79.1 KB
- Stars: 0
- Watchers: 9
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
README
# The CVE Package [](https://ci.joomla.org/joomla-framework/cve-api)
[](https://packagist.org/packages/joomla/cve)
[](https://packagist.org/packages/joomla/cve)
[](https://packagist.org/packages/joomla/cve)
[](https://packagist.org/packages/joomla/cve)
> Requires PHP 7 >= 7.3 or PHP 8 < 8.2
## Using the CVE Package
tbd
### Instantiating CVE
Instantiating CVE Service is easy:
```php
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](https://cveawg.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).
```php
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`.
```json
{
"require": {
"joomla/cve": "~2.0@dev"
}
}
```
Alternatively, you can simply run the following from the command line:
```sh
composer require joomla/cve "~2.0@dev"
```
If you want to include the test sources, use
```sh
composer require --prefer-source joomla/cve "~2.0"
```