masterro / laravel-xss-filter
Filter user input for XSS but don't touch other html
Installs: 143 114
Dependents: 1
Suggesters: 0
Security: 0
Stars: 41
Watchers: 3
Forks: 5
Open Issues: 0
Requires
- php: >=7.4
- laravel/framework: ^6.20.26|^7.30.6|^8.0|^9.0|^10.0|^11.0
Requires (Dev)
- orchestra/testbench: ^v4.0|^v5.0|^v6.0|^v7.0|^8.0|^9.0
README
XSS Filter/Sanitizer for Laravel
Configure once and forget about XSS attacks!
Laravel 5.4+ Middleware to filter user inputs from XSS and iframes and other embed elements.
It does not remove the html, it is only escaped script tags and embeds.
However, by default, it does delete inline event listeners such as onclick.
Optionally they also can be escaped (set escape_inline_listeners to true in xss-filter.php config file).
For example
<html>
<head>
<script src="app.js"></script>
<script>window.init()</script>
<meta name="test" />
<script>
let Iframe = new Iframe('#iframe');
</script>
<head>
<body>
<div class="hover" onhover="show()" data-a="b"><p onclick="click"><span class="span" ondblclick="hide()"></span>Aawfawfaw f awf aw </p></div>
<iframe id="iframe">Not supported!</iframe>
</body>
</html>
will be transformed to
<html> <head> <script src="app.js"></script> <script>window.init()</script> <meta name="test" /> <script> let Iframe = new Iframe('#iframe'); </script> <head> <body> <div class="hover" data-a="b"><p ><span class="span" ></span>Aawfawfaw f awf aw </p></div> <iframe id="iframe">Not supported!</iframe> </body> </html>
This allows to render html in views based on users' input and don't be afraid of XSS attacks and embed elements.
Installation
Step 1: Composer
From command line
composer require masterro/laravel-xss-filter
Step 2: register Service provider and Facade(optional) (for Laravel 5.4)
For your Laravel app, open config/app.php and, within the providers array, append:
MasterRO\LaravelXSSFilter\XSSFilterServiceProvider::class
within the aliases array, append:
'XSSCleaner' => MasterRO\LaravelXSSFilter\XSSCleanerFacade::class
Step 3: publish configs (optional)
From command line
php artisan vendor:publish --provider="MasterRO\LaravelXSSFilter\XSSFilterServiceProvider"
Step 4: Middleware
You can register \MasterRO\LaravelXSSFilter\FilterXSS::class for filtering in global middleware stack, group middleware stack or for specific routes.
Have a look at Laravel's middleware documentation, if you need any help.
Usage
After adding middleware, every request will be filtered.
If you need to specify attributes that should not be filtered add them to xss-filter.except config. By default, filter excepts password and password_confirmation fields.
If you want to clean some value in other place (i.e. Controller) you can use XSSCleaner Facade.
$clean = XSSCleaner::clean($string);
Runtime configuration
XSSCleaner::config() ->allowElement('iframe') ->allowMediaHosts(['youtube.com']) ->blockElement('a'); $clean = XSSCleaner::clean($string);