The Magento related Security Advisories Database references known security vulnerabilities in various Magento Versions and 3rd Party Modules. This database must not serve as the primary source of information for security issues, it is not authoritative for any referenced software, but it allows to centralize information for convenience and easy consumption.
This project is completely community driven.
The Idea and Format is "copied" from https://github.com/FriendsOfPHP/security-advisories
Examples where you can see them used:
- https://www.versioneye.com/php/dweeves:magmi/0.7.19
- https://www.versioneye.com/php/connect20:mage_all_latest/1.9.2.0
The Magento related security advisories database is free and unencumbered software released into the public domain.
You can browse the database entries on Placeholder, which need to be replaced
This is a Placeholder, too.
Contributing security advisories is as easy as it can get:
-
You can contribute a new entry by sending a pull request or by creating a file directly via the Github interface;
-
Create a directory based on the Composer name of the software where the security issue exists (use
connect20/aw_blog
for an security issue in the aheadWorks Blog extension for instance); -
Each security issue must be saved in a file where the name is the CVE identifier (preferred) or the date when the security issue was announced followed by an increment (
2012-12-12-1
for instance); -
The file is in the YAML format and must contain the following entries (have a look at existing entries for examples):
-
title
: A text that describes the security issue in a few words; -
link
: A link to the official security issue announcement; -
reference
: A unique reference to identify the software (the only supported scheme iscomposer://
followed by the Composer identifier); -
branches
: A hash of affected branches, where the name is the branch name (like2.0.x
), and the value is a hash with the following entries:-
time
: The date when the security issue was fixed (most of the time the date of the commit that fixed the issue (2012-08-27 19:17:44
) -- this information must be as accurate as possible as it is used to determined if a software is affected or not; -
versions
: An array of constraints describing affected versions for this branch (this is the same format as the one used for Composer --[>=2.0.0,<2.0.17]
).
-
-
-
If you have a CVE identifier, add it under the
cve
key. -
Make sure your file validates by running
php validator.php
from the root of this project. This script needs some dependencies to be installed via composer, so you need to runcomposer install
before.
If some affected code is available through different Composer entries (like when you have read-only subtree splits of a main repository), duplicate the information in several files.