{"id":13531745,"url":"https://github.com/FloeDesignTechnologies/phpcs-security-audit","last_synced_at":"2025-04-01T20:30:29.852Z","repository":{"id":11353257,"uuid":"13784950","full_name":"FloeDesignTechnologies/phpcs-security-audit","owner":"FloeDesignTechnologies","description":"phpcs-security-audit is a set of PHP_CodeSniffer rules that finds vulnerabilities and weaknesses related to security in PHP code","archived":false,"fork":false,"pushed_at":"2023-01-05T14:30:01.000Z","size":219,"stargazers_count":710,"open_issues_count":27,"forks_count":85,"subscribers_count":44,"default_branch":"master","last_synced_at":"2024-10-30T03:37:10.323Z","etag":null,"topics":["php","php-codesniffer","phpcs","security","static-code-analysis"],"latest_commit_sha":null,"homepage":"","language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/FloeDesignTechnologies.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":"Security/Sniffs/BadFunctions/AssertsSniff.php","support":null}},"created_at":"2013-10-22T20:26:44.000Z","updated_at":"2024-09-19T16:47:50.000Z","dependencies_parsed_at":"2023-01-13T16:28:13.352Z","dependency_job_id":null,"html_url":"https://github.com/FloeDesignTechnologies/phpcs-security-audit","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FloeDesignTechnologies%2Fphpcs-security-audit","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FloeDesignTechnologies%2Fphpcs-security-audit/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FloeDesignTechnologies%2Fphpcs-security-audit/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FloeDesignTechnologies%2Fphpcs-security-audit/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FloeDesignTechnologies","download_url":"https://codeload.github.com/FloeDesignTechnologies/phpcs-security-audit/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":246709921,"owners_count":20821296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["php","php-codesniffer","phpcs","security","static-code-analysis"],"created_at":"2024-08-01T07:01:05.308Z","updated_at":"2025-04-01T20:30:29.442Z","avatar_url":"https://github.com/FloeDesignTechnologies.png","language":"PHP","readme":"phpcs-security-audit v3\n=======================\n\n\u003cdiv aria-hidden=\"true\"\u003e\n\n[![License: GPLv3](https://poser.pugx.org/pheromone/phpcs-security-audit/license)](https://github.com/FloeDesignTechnologies/phpcs-security-audit/blob/master/LICENSE)\n[![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)\n[![Latest Stable Version](https://poser.pugx.org/pheromone/phpcs-security-audit/v/stable)](https://packagist.org/packages/pheromone/phpcs-security-audit)\n[![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)\n[![Packagist Downloads](https://img.shields.io/packagist/dt/Pheromone/phpcs-security-audit)](https://packagist.org/packages/pheromone/phpcs-security-audit)\n[![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)\n[![Travis Build Success](https://img.shields.io/travis/FloeDesignTechnologies/phpcs-security-audit)](https://travis-ci.org/github/FloeDesignTechnologies/phpcs-security-audit)\n\n\n\u003c/div\u003e\n\nAbout\n-----\nphpcs-security-audit is a set of [PHP_CodeSniffer](https://github.com/squizlabs/PHP_CodeSniffer) rules that finds vulnerabilities and weaknesses related to security in PHP code.\n\nIt currently has core PHP rules as well as Drupal 7 specific rules.\n\nThe tool also checks for CVE issues and security advisories related to the CMS/framework. This enables you to follow the versioning of components during static code analysis.\n\nThe 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/)).\n\nphpcs-security-audit in its beginning was backed by Pheromone (later on named Floe Design + Technologies) and written by [Jonathan Marcil](https://twitter.com/jonathanmarcil).\n\n\n\nInstall\n-------\n\nRequires [PHP CodeSniffer](http://pear.php.net/package/PHP_CodeSniffer/) version 3.1.0 or higher with PHP 5.4 or higher.\n\nThe easiest way to install is using [Composer](https://getcomposer.org/):\n```\n#WARNING: this currently doesn't work up until the v3 package is released\n#See Contribute section bellow for git clone instruction\ncomposer require --dev pheromone/phpcs-security-audit\n```\n\nThis will also install the [DealerDirect Composer PHPCS plugin](https://github.com/Dealerdirect/phpcodesniffer-composer-installer/) which will register the `Security` standard with PHP_CodeSniffer.\n\nNow run:\n```\n./vendor/bin/phpcs -i\n```\n\nIf all went right, you should see `Security` listed in the list of installed coding standards.\n\nIf you want to integrate it all with Jenkins, go see http://jenkins-php.org/ for extensive help.\n\n\nUsage\n-----\n\nSimply set the standard to `Security` or point to any XML ruleset file and to a folder to scan:\n```\nphpcs --extensions=php,inc,lib,module,info --standard=./vendor/pheromone/phpcs-security-audit/example_base_ruleset.xml /your/php/files/\n```\n\nSpecifying extensions is important since, for example, PHP code is within `.module` files in Drupal.\n\nTo have a quick example of output you can use the provided `tests.php` file:\n```\n$ phpcs --extensions=php,inc,lib,module,info --standard=./vendor/pheromone/phpcs-security-audit/example_base_ruleset.xml ./vendor/pheromone/phpcs-security-audit/tests.php\n\nFILE: tests.php\n--------------------------------------------------------------------------------\nFOUND 18 ERRORS AND 36 WARNINGS AFFECTING 44 LINES\n--------------------------------------------------------------------------------\n\n  6 | WARNING | Possible XSS detected with . on echo\n  6 | ERROR   | Easy XSS detected because of direct user input with $_POST on echo\n  9 | WARNING | Usage of preg_replace with /e modifier is not recommended.\n 10 | WARNING | Usage of preg_replace with /e modifier is not recommended.\n 10 | ERROR   | User input and /e modifier found in preg_replace, remote code execution possible.\n 11 | ERROR   | User input found in preg_replace, /e modifier could be used for malicious intent.\n   ...\n```\n\n#### Drupal note\n\nFor the Drupal AdvisoriesContrib you need to change your `/etc/php5/cli/php.ini` to have:\n```\nshort_open_tag = On\n```\nin order to get rid of \"No PHP code was found in this file\" warnings.\n\nPlease note that only Drupal modules downloaded from drupal.org are supported. If you are using contrib module but from another source, the version checking probably won't work and will generate a warning.\n\n\nCustomize\n---------\nAs with the normal PHP CodeSniffer rules, customization is provided in the XML files that are in the top folder of the project.\n\nThese global parameters are used in many rules:\n* ParanoiaMode: set to 0 to reduce false positive. set to 1 (default) to be a lot more verbose.\n* CmsFramework: set to the name of a folder containings rules and Utils.php (such as Drupal7) to target a specific framework.\n\nThey 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:\n```\nphpcs --runtime-set ParanoiaMode 0 --extensions=php --standard=./vendor/pheromone/phpcs-security-audit/example_base_ruleset.xml tests.php\n```\n\nFor some rules, you can force the paranoia mode on or off with the parameter `forceParanoia` inside the XML file.\n\n\nContribute\n----------\nIt is possible to install with a `git clone` and play with it in the same folder.\n```\ncomposer install\n./vendor/bin/phpcs --standard=example_base_ruleset.xml --extensions=php tests.php\n```\n\nBy default it should set PHPCS to look in the current folder:\n```\nPHP CodeSniffer Config installed_paths set to ../../../\n```\n\nIf 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).\n\nMaster can contain breaking changes, so people are better off relying on releases for stable versions.\n\nThose release packages are available [here on GitHub](releases) or on [Packagist](https://packagist.org/packages/pheromone/phpcs-security-audit).\n\nSome guidelines if you want to create new rules::\n* Ensure that `ParanoiaMode` controls how verbose your sniff is:\n\t* If the sniff is only some of the time a valid security concern, run it when `paranoia=true` only.\n\t* Warnings are generally issued instead of Errors for most-of-the-time concerns when `paranoia=false`.\n\t* Errors are always generated when you are sure about user input being used.\n* Prefer false positives (annoying results) over false negatives (missing results).\n\t* `paranoia=false` should solve false positive, otherwise warn on anything remotely suspicious.\n* Include at least one test that triggers your sniff into `tests.php`.\n\t* Keep the test as a one liner, it doesn't need to make sense.\n* Don't forget to include your new sniff in the `example_base_ruleset.xml` and `example_drupal7_ruleset.xml` when it applies.\n\n\n#### Specialize\n\nIf 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.\n\nLet's say you have a custom CMS function that is taking user input from `$_GET` when a function call to `get_param()` is done.\n\nYou have to create a new Folder in `Sniffs/` that will be the name of your framework. Then you'll need\nto create a file named `Utils.php` that will actually be the function that will specialise the generic sniffs. To guide you, just copy the file from another folder such as `Drupal7/`.\n\nThe main function you'll want to change is `is_direct_user_input` where you'll want to return TRUE when `get_param()` is seen:\n```php\n\tpublic static function is_direct_user_input($var) {\n\t\tif (parent::is_direct_user_input($var)) {\n\t\t\treturn TRUE;\n\t\t} else {\n\t\t\tif ($var == 'get_param') {\n\t\t\t\treturn TRUE;\n\t\t\t}\n\t\t}\n\t\treturn FALSE;\n\t}\n```\n\nDon't forget to set the occurrence of param \"CmsFramework\" in your XML base configuration in order to select your newly added utilities.\n\nYou 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.\n\nIn 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`.\n\nIf you implement any public CMS/Framework customization please make a pull request to help the project grows.\n\n#### Test\n\nThe tool now support unit testing with `composer test`.\n\nTo test for a specific sniff, use `composer test -- --filter RULENAME` (without the `Sniff` part).\n\nTo 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.\n\n\nAnnoyances\n----------\n\nAs 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.\n\n* 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.\n* 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.\n* 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.\n* 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.\n\n\n\n","funding_links":[],"categories":["Tools","PHP","Static Code Analysis","PHP (184)"],"sub_categories":["Static Analysis"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFloeDesignTechnologies%2Fphpcs-security-audit","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FFloeDesignTechnologies%2Fphpcs-security-audit","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FFloeDesignTechnologies%2Fphpcs-security-audit/lists"}