Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[3.x] Update README/SECURITY #5

Open
wants to merge 3 commits into
base: 3.x-dev
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 9 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,13 @@
# The CVE Package [![Build Status](https://ci.joomla.org/api/badges/joomla-framework/cve-api/status.svg?ref=refs/heads/2.0-dev)](https://ci.joomla.org/joomla-framework/cve-api)
# The CVE Package [![Build Status](https://ci.joomla.org/api/badges/joomla-framework/cve-api/status.svg?ref=refs/heads/3.x-dev)](https://ci.joomla.org/joomla-framework/cve-api)

[![Latest Stable Version](https://poser.pugx.org/joomla/cve/v/stable)](https://packagist.org/packages/joomla/cve)
[![Total Downloads](https://poser.pugx.org/joomla/cve/downloads)](https://packagist.org/packages/joomla/cve)
[![Latest Unstable Version](https://poser.pugx.org/joomla/cve/v/unstable)](https://packagist.org/packages/joomla/cve)
[![License](https://poser.pugx.org/joomla/cve/license)](https://packagist.org/packages/joomla/cve)

> Requires PHP 7 >= 7.3 or PHP 8 < 8.2
## Requirements

* PHP 8.1 or later

## Using the CVE Package

Expand Down Expand Up @@ -50,28 +52,28 @@ Option key | Description
`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'
`userAgent` | The user agent to use for requests. Defaults to 'Joomla-CVE/3.0'

## Installation via Composer

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

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

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

```sh
composer require joomla/cve "~2.0@dev"
composer require joomla/cve "~3.0"
```

If you want to include the test sources, use

```sh
composer require --prefer-source joomla/cve "~2.0"
composer require --prefer-source joomla/cve "~3.0"
```
1 change: 1 addition & 0 deletions SECURITY.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ These versions are currently being supported with security updates:

| Version | Supported |
| ------- | ------------------ |
| 3.x.x | :white_check_mark: |
| 2.0.x | :white_check_mark: |

## Reporting a Vulnerability
Expand Down
2 changes: 1 addition & 1 deletion src/CveService.php
Original file line number Diff line number Diff line change
Expand Up @@ -54,7 +54,7 @@ public function __construct(Registry $options = null, Http $client = null)

// Setup the default user agent if not already set.
if ($this->getOption('userAgent') === null) {
$this->setOption('userAgent', 'Joomla-CVE/2.0');
$this->setOption('userAgent', 'Joomla-CVE/3.0');
}

// Setup the default API url if not already set.
Expand Down