Skip to content

Latest commit

 

History

History
45 lines (31 loc) · 1.9 KB

README.md

File metadata and controls

45 lines (31 loc) · 1.9 KB
Raw

Roave Security Advisories

Build Status Downloads

This package ensures that your application doesn't have installed dependencies with known security vulnerabilities.

Installation

composer require roave/security-advisories:dev-master

Usage

This package does not provide any API or usable classes: its only purpose is to prevent installation of software with known and documented security issues. Simply add "roave/security-advisories": "dev-master" to your composer.json "require" section and you will not be able to harm yourself with software with known security vulnerabilities.

For example, try following:

composer require roave/security-advisories:dev-master
# following commands will fail:
composer require symfony/symfony:2.5.2
composer require zendframework/zendframework:2.3.1

The checks are only executed when adding a new dependency via composer require or when running composer update: deploying an application with a valid composer.lock and via composer install won't trigger any security versions checking.

Stability

This package can only be required in its dev-master version: there will never be stable/tagged versions because of the nature of the problem being targeted. Security issues are in fact a moving target, and locking your project to a specific tagged version of the package would not make any sense.

This package is therefore only suited for installation in the root of your deployable project.

Sources

This package extracts information about existing security issues in various composer projects from the FriendsOfPHP/security-advisories repository.