danbettles / defence
A simple intrusion detection/prevention system framework for PHP apps
Requires
- php: ^8.1
- danbettles/gestalt: ^4.0
- psr/log: ^2.0.0|^3.0.0
- symfony/http-foundation: ^4.4.7|^5.0|^6.0
Requires (Dev)
- danbettles/codesniffer-standard: ^2.0.0
- phpstan/phpstan: ^1.10.66
- phpunit/phpunit: ^9.6.18
- squizlabs/php_codesniffer: ^3.9.1
Suggests
- ext-curl: If you want to use `SlackLogger`.
README
A simple intrusion detection/prevention system framework written in PHP.
Defence is used principally to:
- 🛡️ Prevent a suspicious-looking request getting deeper into an application's code and potentially exploiting vulnerabilities.
- 🌱 Avoid wasting further system resources on unfriendly user activity.
Recently, we have found Defence to be been extremely helpful in quickly mitigating the effects of overzealous bots, particularly those involved in information-gathering for AI. Excessive and/or faulty requests can negatively affect the experience of other users of the system and waste resources—including electricity.
Warning
Defence does not eliminate the need to filter user-input in your application. While some of the included filters do indeed validate user input, they take a very high-level view. Their aim is to detect obviously suspect values given a very basic understanding of what they're looking at. For example, the included ID-parameter filter knows only that certain parameters must contain only digits or a blank; the filter is useful because it can quickly and easily prevent SQL injection, but the value may still be invalid as far as your app is concerned.
We recommend you read Architecture before Getting Started. Otherwise, the documentation starts here.