README.md

SHIELDFY Web Application Firewall Detector

This is a simple package for Web Application Firewall Detection. It supports CloudFlare, Incapsula, ModSecurity, and Shieldfy out of the box.

Table Of Contents

• Usage
• Installation
• Changelog
• Support
• Contributing & Protocols
• Security Vulnerabilities
• License

Usage

Usage is pretty easy and straightforward:

$firewalls = [
    new \Shieldfy\Firewall\CloudFlare(),
    new \Shieldfy\Firewall\Incapsula(),
    new \Shieldfy\Firewall\ModSecurity(),
    new \Shieldfy\Firewall\Shieldfy(),
];

$detector = new \Shieldfy\Detector(... $firewalls);

foreach ( $detector->detect('http://www.example.com') as $firewall => $status ) {
    // do something, perhaps displaying the status ?
}

At the Command Line

# php bin/waf-detector.php http://example.org

Installation

Install the package via composer:

composer require shieldfy/waf-detector

Changelog

Refer to the Changelog for a full history of the project.

Support

The following support channels are available at your fingertips:

• Help on Email

Contributing & Protocols

Thank you for considering contributing to this project! The contribution guide can be found in CONTRIBUTING.md.

Bug reports, feature requests, and pull requests are very welcome.

• Versioning
• Pull Requests
• Coding Standards

Security Vulnerabilities

If you discover a security vulnerability within this project, please send an e-mail to security@shieldfy.com. All security vulnerabilities will be promptly addressed.

License

This software is released under MIT LICENSE.

(c) 2016 Shieldfy, Some rights reserved.