Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/lightswitch05/php-version-audit
Audit your PHP version for known CVEs and patches
https://github.com/lightswitch05/php-version-audit
audit composer-package cves docker-image hacktoberfest php php-library php-security security security-audit security-scanner
Last synced: 4 days ago
JSON representation
Audit your PHP version for known CVEs and patches
- Host: GitHub
- URL: https://github.com/lightswitch05/php-version-audit
- Owner: lightswitch05
- License: apache-2.0
- Created: 2019-11-21T17:54:51.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2024-12-08T02:43:32.000Z (4 days ago)
- Last Synced: 2024-12-08T03:25:16.776Z (4 days ago)
- Topics: audit, composer-package, cves, docker-image, hacktoberfest, php, php-library, php-security, security, security-audit, security-scanner
- Language: PHP
- Homepage: https://www.github.developerdan.com/php-version-audit/
- Size: 9.45 MB
- Stars: 113
- Watchers: 6
- Forks: 17
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-hacking-lists - lightswitch05/php-version-audit - Audit your PHP version for known CVEs and patches (PHP)
README
# PHP Version Audit
[](https://www.github.developerdan.com/php-version-audit/)
[](https://github.com/lightswitch05/php-version-audit)
[](https://github.com/lightswitch05/php-version-audit/actions/workflows/auto-updates.yml?query=workflow%3A%22Auto+Updates%22)
[](https://packagist.org/packages/lightswitch05/php-version-audit)
[](https://hub.docker.com/r/lightswitch05/php-version-audit)
[](https://github.com/lightswitch05/php-version-audit/blob/master/LICENSE)
[](https://github.com/lightswitch05/php-version-audit/commits/master)
[](https://github.com/lightswitch05/php-version-audit/commits/master)
PHP Version Audit is a convenience tool to easily check a given PHP version against a regularly updated
list of CVE exploits, new releases, and end of life dates.
**PHP Version Audit is not:** exploit detection/mitigation, vendor-specific version tracking, a replacement for
staying informed on PHP releases and security exploits.
> * [Features](#features)
> * [Example](#example)
> * [Usage](#usage)
> * [Docker](#docker)
> * [CLI](#cli)
> * [Direct Invocation](#direct-invocation)
> * [JSON Rules](#json-rules)
> * [Options](#options)
> * [Output](#output)
> * [Project Goals](#project-goals)
> * [Acknowledgments & License](#acknowledgments--license)
## Features:
* List known CVEs for a given version of PHP
* Check either the runtime version of PHP, or a supplied version
* Display end-of-life dates for a given version of PHP
* Display new releases for a given version of PHP with configurable specificity (latest/minor/patch)
* Patch: 7.3.0 -> 7.3.33
* Minor: 7.3.0 -> 7.4.27
* Latest: 7.3.0 -> 8.1.1
* Rules automatically updated twice a day. Information is sourced directly from php.net - you'll never be waiting on someone like me to merge a pull request before getting the latest patch information.
* Multiple interfaces: CLI (via PHP Composer), Docker, direct code import
* Easily scriptable for use with CI/CD workflows. All Docker/CLI outputs are in JSON format to be consumed with your favorite tools - such as [jq](https://stedolan.github.io/jq/).
* Configurable exit conditions. Use CLI flags like `--fail-security` to set a failure exit code if the given version of PHP has a known CVE or is no longer receiving security updates.
* Zero dependencies
## Example:
docker run --rm -t lightswitch05/php-version-audit:latest --version=8.0.12
{
"auditVersion": "8.0.12",
"hasVulnerabilities": true,
"hasSecuritySupport": true,
"hasActiveSupport": true,
"isLatestPatchVersion": false,
"isLatestMinorVersion": false,
"isLatestVersion": false,
"latestPatchVersion": "8.0.14",
"latestMinorVersion": "8.1.1",
"latestVersion": "8.1.1",
"activeSupportEndDate": "2022-11-26T00:00:00+0000",
"securitySupportEndDate": "2023-11-26T00:00:00+0000",
"rulesLastUpdatedDate": "2022-01-18T02:13:52+0000",
"vulnerabilities": {
"CVE-2021-21707": {
"id": "CVE-2021-21707",
"baseScore": 5.3,
"publishedDate": "2021-11-29T07:15:00+0000",
"lastModifiedDate": "2022-01-04T16:12:00+0000",
"description": "In PHP versions 7.3.x below 7.3.33, 7.4.x below 7.4.26 and 8.0.x below 8.0.13, certain XML parsing functions, like simplexml_load_file(), URL-decode the filename passed to them. If that filename contains URL-encoded NUL character, this may cause the function to interpret this as the end of the filename, thus interpreting the filename differently from what the user intended, which may lead it to reading a different file than intended."
}
}
}
## Usage
### Docker
Running with docker is the preferred and easiest way to use PHP Version Audit.
Check a specific version of PHP using Docker:
docker run --rm -t lightswitch05/php-version-audit:latest --version=8.1.1
Check the host's PHP version using Docker:
docker run --rm -t lightswitch05/php-version-audit:latest --version=$(php -r 'echo phpversion();')
Run behind an HTTPS proxy (for use on restricted networks). Requires a volume mount of a directory with your trusted cert (with .crt extension) - see [update-ca-certificates](https://manpages.debian.org/buster/ca-certificates/update-ca-certificates.8.en.html) for more details.
docker run --rm -t -e https_proxy='https://your.proxy.server:port/' --volume /full/path/to/trusted/certs/directory:/usr/local/share/ca-certificates lightswitch05/php-version-audit:latest --version=8.1.1
### CLI
Not using docker? Not a problem. It is a couple more steps, but it is just as easy to run directly.
Install the package via composer:
composer require lightswitch05/php-version-audit:~1.0
Execute the PHP script, checking the run-time version of PHP:
./vendor/bin/php-version-audit
Produce an exit code if any CVEs are found:
./vendor/bin/php-version-audit --fail-security
### Direct Invocation
Want to integrate with PHP Version Audit? That's certainly possible. A word caution, this is a very early release. I do not have any plans for breaking changes, but I'm also not committed to keeping the interface as-is if there are new features to implement. Docker/CLI is certainly the preferred method over direct invocation.
$phpVersionAudit = new lightswitch05\PhpVersionAudit\Application(phpversion(), false);
$phpVersionAudit->hasVulnerabilities(); #=> true
$phpVersionAudit->getLatestPatchVersion(); #=> '8.1.1'
### JSON Rules
The data used to drive PHP Version Audit is automatically updated on a regular basis and is hosted on GitHub pages. This is the real meat-and-potatoes of PHP Version Audit, and you can consume it directly for use in other tools. If you choose to do this, please respect the project license by giving proper attribution notices. Also, I ask any implementations to read the `lastUpdatedDate` and fail if it has become out of date (2+ weeks). This should not happen since it is automatically updated... but we all know how fragile software is.
Get the latest PHP 8.1 release version directly from the rules using [curl](https://curl.haxx.se/) and [jq](https://stedolan.github.io/jq/):
curl -s https://www.github.developerdan.com/php-version-audit/rules-v1.json | jq '.latestVersions["8.1"]'
### Options
usage: php-version-audit [--help] [--version=PHP_VERSION]
[--fail-security] [--fail-support]
[--fail-patch] [--fail-latest]
[--no-update] [--silent]
[--v]
optional arguments:
--help show this help message and exit.
--version set the PHP Version to run against. Defaults to the runtime version. This is required when running with docker.
--fail-security generate a 10 exit code if any CVEs are found, or security support has ended.
--fail-support generate a 20 exit code if the version of PHP no longer gets active (bug) support.
--fail-patch generate a 30 exit code if there is a newer patch-level release.
--fail-latest generate a 40 exit code if there is a newer release.
--no-update do not download the latest rules. NOT RECOMMENDED!
--silent do not write any error messages to STDERR.
--v Set verbosity. v=warnings, vv=info, vvv=debug. Default is error. All logging writes to STDERR.
### Output
* auditVersion: string - The version of PHP that is being audited.
* hasVulnerabilities: bool - If the auditVersion has any known CVEs or not.
* hasSecuritySupport: bool - If the auditVersion is still receiving security updates.
* hasActiveSupport: bool - If the auditVersion is still receiving active support (bug updates).
* isLatestPatchVersion: bool - If auditVersion is the latest patch-level release (8.0.x).
* isLatestMinorVersion: bool - If auditVersion is the latest minor-level release (8.x.x).
* isLatestVersion: bool - If auditVersion is the latest release (x.x.x).
* latestPatchVersion: string - The latest patch-level version for auditVersion.
* latestMinorVersion: string - The latest minor-level version for auditVersion.
* latestVersion: string - The latest PHP version.
* activeSupportEndDate: string|null - ISO8601 formatted date for the end of active support for auditVersion (bug fixes).
* securitySupportEndDate: string - ISO8601 formatted date for the end of security support for auditVersion.
* rulesLastUpdatedDate: string - ISO8601 formatted date for the last time the rules were auto-updated (twice a day)..
* vulnerabilities: object - CVEs known to affect auditVersion with details about the CVE. CVE Details might be null for recently discovered CVEs.
## Project Goals:
* Always use update-to-date information and fail if it becomes too stale. Since this tool is designed to help its users stay informed, it must in turn fail if it becomes outdated.
* Fail if the requested information is unavailable. ex. getting the support end date of PHP version 6.0, or 5.7.0. Again, since this tool is designed to help its users stay informed, it must in turn fail if the requested information is unavailable.
* Work in both open and closed networks (as long as the tool is up-to-date).
* Minimal footprint and dependencies.
* Runtime support for the oldest supported version of PHP. If you are using this tool with an unsupported version of PHP, then you already have all the answers that this tool can give you: Yes, you have vulnerabilities and are out of date. Of course that is just for the run-time, it is still the goal of this project to supply information about any reasonable version of PHP.
## Acknowledgments & License
* This project is released under the [Apache License 2.0](https://raw.githubusercontent.com/lightswitch05/php-version-audit/master/LICENSE).
* The accuracy of the information provided by this project cannot be verified or guaranteed. All functions are provided as convenience only and should not be used for reliability, accuracy, or punctuality.
* The logo was created using Colin Viebrock's [PHP Logo](https://www.php.net/download-logos.php) as the base image, released under [Creative Commons Attribution-Share Alike 4.0 International](https://creativecommons.org/licenses/by-sa/4.0/). The logo has been modified from its original form to include overlay graphics.
* This project and the use of the modified PHP logo is not endorsed by Colin Viebrock.
* This project and the use of the PHP name is not endorsed by The PHP Group.
* CVE details and descriptions are downloaded from National Institute of Standard and Technology's [National Vulnerability Database](https://nvd.nist.gov/). This project and the use of CVE information is not endorsed by NIST or the NVD. CVE details are provided as convenience only. The accuracy of the information cannot be verified.
* PHP release details and support dates are parsed from ChangeLogs ([4](https://www.php.net/ChangeLog-4.php), [5](https://www.php.net/ChangeLog-5.php), [7](https://www.php.net/ChangeLog-7.php), [8](https://www.php.net/ChangeLog-8.php)) as well as [Supported Versions](https://www.php.net/supported-versions.php) and [EOL dates](https://www.php.net/eol.php). The accuracy of the information cannot be verified.