Skip to content

Commit

Permalink
Merge pull request #74 from jmarcil/master
Browse files Browse the repository at this point in the history 
Update README.md
  • Loading branch information
@jmarcil
jmarcil authored Mar 16, 2020
2 parents 0dacd0d + 9989d08 commit 8bb3a19
Showing 1 changed file with 52 additions and 43 deletions.
95 changes: 52 additions & 43 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,14 +3,14 @@ phpcs-security-audit v3

<div aria-hidden="true">

[![License: GPLv3](https://poser.pugx.org/pheromone/phpcs-security-audit/license)](https://github.com/FloeDesignTechnologies/phpcs-security-audit/blob/master/LICENSE)
[![Minimum PHP Version](https://img.shields.io/packagist/php-v/pheromone/phpcs-security-audit.svg?maxAge=3600)](https://packagist.org/packages/pheromone/phpcs-security-audit)
[![Latest Stable Version](https://poser.pugx.org/pheromone/phpcs-security-audit/v/stable)](https://packagist.org/packages/pheromone/phpcs-security-audit)
[![Release Date of the Latest Version](https://img.shields.io/github/release-date/FloeDesignTechnologies/phpcs-security-audit.svg?maxAge=1800)](https://github.com/FloeDesignTechnologies/phpcs-security-audit/releases)
:construction:
[![Latest Unstable Version](https://img.shields.io/badge/unstable-dev--master-e68718.svg?maxAge=2419200)](https://packagist.org/packages/pheromone/phpcs-security-audit#dev-master)
[![Packagist Downloads](https://img.shields.io/packagist/dt/Pheromone/phpcs-security-audit)](https://packagist.org/packages/pheromone/phpcs-security-audit)
[![Last Commit to Unstable](https://img.shields.io/github/last-commit/FloeDesignTechnologies/phpcs-security-audit/master.svg)](https://github.com/FloeDesignTechnologies/phpcs-security-audit/commits/master)
[![Travis Build Success](https://img.shields.io/travis/FloeDesignTechnologies/phpcs-security-audit)](https://travis-ci.org/github/FloeDesignTechnologies/phpcs-security-audit)

[![License: GPLv3](https://poser.pugx.org/pheromone/phpcs-security-audit/license)](https://github.com/FloeDesignTechnologies/phpcs-security-audit/blob/master/LICENSE)
[![Minimum PHP Version](https://img.shields.io/packagist/php-v/pheromone/phpcs-security-audit.svg?maxAge=3600)](https://packagist.org/packages/pheromone/phpcs-security-audit)

</div>

Expand All @@ -24,7 +24,7 @@ The tool also checks for CVE issues and security advisories related to the CMS/f

The main reason for this project being an extension of PHP_CodeSniffer is to have easy integration into continuous integration systems. It also allows for finding security bugs that are not detected with some object oriented analysis (such as [PHPMD](http://phpmd.org/)).

phpcs-security-audit in its beginning was backed by Pheromone (later on named Floe design + technologies) and written by [Jonathan Marcil](https://twitter.com/jonathanmarcil).
phpcs-security-audit in its beginning was backed by Pheromone (later on named Floe Design + Technologies) and written by [Jonathan Marcil](https://twitter.com/jonathanmarcil).



Expand All @@ -34,7 +34,7 @@ Install
Requires [PHP CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer/) version 3.1.0 or higher with PHP 5.4 or higher.

The easiest way to install is using [Composer](https://getcomposer.org/):
```bash
```
#WARNING: this currently doesn't work up until the v3 package is released
#See Contribute section bellow for git clone instruction
composer require --dev pheromone/phpcs-security-audit
Expand All @@ -43,7 +43,7 @@ composer require --dev pheromone/phpcs-security-audit
This will also install the [DealerDirect Composer PHPCS plugin](https://github.com/Dealerdirect/phpcodesniffer-composer-installer/) which will register the `Security` standard with PHP_CodeSniffer.

Now run:
```bash
```
./vendor/bin/phpcs -i
```

Expand Down Expand Up @@ -96,21 +96,51 @@ Customize
As with the normal PHP CodeSniffer rules, customization is provided in the XML files that are in the top folder of the project.

These global parameters are used in many rules:
* ParanoiaMode: set to 1 to add more checks. 0 for less.
* CmsFramework: set to the name of a folder containings rules and Utils.php (such as Drupal7, Symfony2).
* ParanoiaMode: set to 0 to reduce false positive. set to 1 (default) to be a lot more verbose.
* CmsFramework: set to the name of a folder containings rules and Utils.php (such as Drupal7) to target a specific framework.

They can be set in a custom ruleset `phpcs.xml[.dist]` XML file or from the command line for permanent config with `--config-set` or at runtime with `--runtime-set`. Note that the XML overrides all CLI options so remove it if you want to use it. The CLI usage is as follows:
```bash
They can be set in a custom ruleset XML file (such as `example_drupal7_ruleset.xml`), from the command line for permanent config with `--config-set` or at runtime with `--runtime-set`. Note that the XML overrides all CLI options so remove it if you want to use it. The CLI usage is as follows:
```
phpcs --runtime-set ParanoiaMode 0 --extensions=php --standard=./vendor/pheromone/phpcs-security-audit/example_base_ruleset.xml tests.php
```

In some case you can force the paranoia mode on or off with the parameter `forceParanoia` inside the XML rule.
For some rules, you can force the paranoia mode on or off with the parameter `forceParanoia` inside the XML file.


Specialize
Contribute
----------
It is possible to install with a `git clone` and play with it in the same folder.
```
composer install
./vendor/bin/phpcs --standard=example_base_ruleset.xml --extensions=php tests.php
```

By default it should set PHPCS to look in the current folder:
```
PHP CodeSniffer Config installed_paths set to ../../../
```

If for any reason you need to change this (should work out of the box) you will need to `phpcs --config-set installed_paths` as explained in [PHP_CodeSniffer docs](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#setting-the-installed-standard-paths).

If you want to fork and help or just do your own sniffs you can use the utilities provided by phpcs-security-audit rules in order to facilitate the process.
Master can contain breaking changes, so people are better off relying on releases for stable versions.

Those release packages are available [here on GitHub](releases) or on [Packagist](https://packagist.org/packages/pheromone/phpcs-security-audit).

Some guidelines if you want to create new rules::
* Ensure that `ParanoiaMode` controls how verbose your sniff is:
* If the sniff is only some of the time a valid security concern, run it when `paranoia=true` only.
* Warnings are generally issued instead of Errors for most-of-the-time concerns when `paranoia=false`.
* Errors are always generated when you are sure about user input being used.
* Prefer false positives (annoying results) over false negatives (missing results).
* `paranoia=false` should solve false positive, otherwise warn on anything remotely suspicious.
* Include at least one test that triggers your sniff into `tests.php`.
* Keep the test as a one liner, it doesn't need to make sense.
* Don't forget to include your new sniff in the `example_base_ruleset.xml` and `example_drupal7_ruleset.xml` when it applies.


#### Specialize

If you want to support a specific code base or framework beyond XML configuration, you can use the utilities provided by phpcs-security-audit to facilitate the process.

Let's say you have a custom CMS function that is taking user input from `$_GET` when a function call to `get_param()` is done.

Expand All @@ -135,49 +165,28 @@ Don't forget to set the occurrence of param "CmsFramework" in your XML base conf

You are not required to do your own sniffs for the modification to be useful, since you are specifying what is a user input for other rules, but you could use the newly created directory to do so.

If you implement any public cms/framework customization please make a pull request to help the project grows.
In the same fashion, you can also reduce the number of false positive by adding mitigation functions. Those are functions that serve as security controls (either explicitly in the function or by a side effect) that lower the risks. A good example is `htmlentities` for XSS. See `is_XSS_mitigation` function in `Drupal7/Utils.php`.

If you implement any public CMS/Framework customization please make a pull request to help the project grows.

Contribute
----------
It is possible to install with a `git clone` and play with it in the same folder.
```
composer install
./vendor/bin/phpcs --standard=example_base_ruleset.xml --extensions=php tests.php
```
#### Test

By default it should set PHPCS to look in the current folder:
```
PHP CodeSniffer Config installed_paths set to ../../../
```
The tool now support unit testing with `composer test`.

If for any reason you need to change this (should work out of the box) you will need to `phpcs --config-set installed_paths` as explained in [PHP_CodeSniffer docs](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#setting-the-installed-standard-paths).

Master can contain breaking changes, so people are better off relying on releases for stable versions.

Those release packages are available [here on GitHub](releases) or on [Packagist](https://packagist.org/packages/pheromone/phpcs-security-audit).
To test for a specific sniff, use `composer test -- --filter RULENAME` (without the `Sniff` part).

Some guidelines if you want to create new rules::
* Ensure that `ParanoiaMode` controls how verbose your sniff is:
* If the sniff is only some of the time a valid security concern, run it when `paranoia=true` only.
* Warnings are generally issued instead of Errors for most-of-the-time concerns when `paranoia=false`.
* Errors are always generated when you are sure about user input being used.
* Prefer false positives (annoying results) over false negatives (missing results).
* `paranoia=false` should solve false positive, otherwise warn on anything remotely suspicious.
* Include at least one test that triggers your sniff into `tests.php`.
* Keep the test as a one liner, it doesn't need to make sense.
* Don't forget to include your new sniff in the `example_base_ruleset.xml` and `example_drupal7_ruleset.xml` when it applies.
To create a test, create a folder with RULENAME. Inside, have a `RULENAMEUnitTest.inc` file for the code to be scanned and `RULENAMEUnitTest.php` file for the PHPCS validation of findings. For the rule to support a given CMS/Framework, it needs to have a inc file with the following: `RULENAMEUnitTest.CMSFRAMEWORK.inc`. See `Security/Tests/BadFunctions` for a complete example.


Annoyances
----------

As with any security tool, this one comes with it's share of annoyance. At first a focus on finding vulnerabilities will be done, but later it is planned to have a phase where efforts will be towards reducing annoyances, in particular with the number of false positives.

* It's a generator of false positives. This can actually help you learn what are the weak functions in PHP. Paranoia mode will fix that by doing a major cut-off on warnings when set to 0.
* It's a generator of false positives created for people doing secure code reviews. It can help you learn what are the weak functions in PHP but can be counter productive in CI/CD environments. Set `ParanoiaMode` to `0` for a major cut-off on warnings.
* This tool was created around 10 years ago. Some of its parts might look outdated, and support for old PHP code will still be present. The reality is that many code base scanned with it might be as old as the tool.
* It's slow. On big Drupal modules and core it can take too much time (and RAM, reconfigure `cli/php.ini` to use 512M if needed) to run. Not sure if it's because of bugs in PHPCS or this set of rules, but will be investigated last. Meanwhile you can configure PHPCS to ignore big contrib modules (and run another instance of PHPCS for `.info` parsing only for them). An example is og taking hours, usually everything runs under 1-2 minutes and sometimes around 5 minute. You can try using the `--parallel=8` (or another number) option to try and speed things up on supported OSes. Possible work-around is to use `phpcs --ignore=folder` to skip scanning of those parts.
* For Drupal advisories checking: a module with multiple versions might be secure if a lesser fixed version exists and you'll still get the error or warning. Keep everything updated at latest as recommended on Drupal's website.
* For Drupal advisories checking: a module with multiple versions might be secure if a lesser fixed version exists and you'll still get the error or warning. Keep everything updated on latest as recommended on Drupal's website.



0 comments on commit 8bb3a19

Please sign in to comment.