signify-nz / composer-security-checker

为您的 composer.lock 文件提供安全检查器

1.0.0 2021-12-22 02:09 UTC

This package is not auto-updated.

Last update: 2024-09-12 14:13:08 UTC


README

Build Status Scrutinizer Code Quality codecov

Composer 安全检查器

灵感来源于 sensiolabs/security-checkerfabpot/local-php-security-checker

Composer 安全检查器提供了一个 API,用于检查您的 PHP 应用程序是否具有已知的安全漏洞依赖项。它使用的是 PHP 安全公告数据库,与 fabpot/local-php-security-checkerSymfony CLI 使用的是同一个数据库。

例如,对于具有仪表板的程序,如果在检测到漏洞时显示清晰的警告,这可能会很有用。

安装

通过 composer 安装

composer require signify-nz/composer-security-checker

用法

只需实例化一个 SecurityChecker 对象,并在调用 check 时传入您的 composer.lock 文件的绝对路径,它将返回一个数组,包含适用于该锁定文件依赖项的漏洞。

use Signify\SecurityChecker\SecurityChecker;
$checker = new SecurityChecker();
$vulnerabilities = $checker->check('/path/to/composer.lock');

如果要从检查中省略开发依赖项,只需将 false 作为第二个参数传递。

use Signify\SecurityChecker\SecurityChecker;
$checker = new SecurityChecker();
$vulnerabilities = $checker->check('/path/to/composer.lock', false);

如果您已经将 composer.lock 文件解析成关联数组,可以将它传递给 check 调用

use Signify\SecurityChecker\SecurityChecker;
$checker = new SecurityChecker();
$composerLockArray = json_decode(file_get_contents('/path/to/composer.lock'), true);
$vulnerabilities = $checker->check($composerLockArray);

配置选项

您可以将一些配置选项传递给构造函数,以确定检查器的行为。

use Signify\SecurityChecker\SecurityChecker;
$options = [
    /* Set your configuration using below options */
];
$checker = new SecurityChecker($options);
$vulnerabilities = $checker->check('/path/to/composer.lock');

您可以设置的选项列在这个表中。