owasp/csrf-protector-php

CSRF protector php, a standalone php library for csrf mitigation in web applications. Easy to integrate in any php web app.

Saturday, March 17, 2018
by mebjas
Repository
12 Watchers
114 Stars
13,080 Installations

PHP
0 Dependents
0 Suggesters
50 Forks
16 Open issues
11 Versions
19 % Grown

The README.md

CSRF Protector

CSRF protector php, a standalone php library for csrf mitigation in web applications. Easy to integrate in any php web app., _(*1)

Add to your project using packagist

Add a composer.json file to your project directory ```json { "require": { "owasp/csrf-protector-php": "dev-master" } }, _(*2)

Then open terminal (or command prompt), move to project directory and run
```shell
composer install

## Or alternatively

php composer.phar install

This will add CSRFP (library will be downloaded at ./vendor/owasp/csrf-protector-php) to your project directory. View packagist.org for more help with composer!, _(*3)

Configuration

For composer installations: Copy the config.sample.php file into your root folder at config/csrf_config.php For non-composer installations: Copy the libs/csrf/config.sample.php file into libs/csrf/config.php Edit config accordingly. See Detailed Information link below., _(*4)

Link to wiki - Editing Configurations & Mandatory requirements before using this library, _(*5)

How to use

<?php
include_once __DIR__ .'/vendor/owasp/csrf-protector-php/libs/csrf/csrfprotector.php';

// Initialise CSRFProtector library
csrfProtector::init();

simply include the library and call the init() function!, _(*6)

More information

Discussions

Join Discussions at Google Group \ OWASP \ CSRF Protector, _(*7)

For any other queries contact me at: minhazav@gamil.com | minhaz@owasp.org, _(*8)

How to contribute?

General steps

Fork the repo
Create your branch
Commit your changes
Create a pull request

More?

Well, there are various ways to contribute to this project. Find a few of them listed below: - Found a bug? Raise a bug in the issue page. Please make sure it's not a duplicate of an existing issue. - Have a feature request? Raise one at the issue page. As mentioned above please do a basic check if this enhancement exists in the mentioned link. - Want to contribute code to this project? - The best way to start is by picking up one of the existing issues with Up For Grab label. - Leave a comment, that you intend to help on this > then fork > and then send a pull request to master branch., _(*9)

FAQ:

What happens if token expires? - https://github.com/mebjas/CSRF-Protector-PHP/wiki/what-if-token-expires
Secure flag in a cookie? - https://github.com/mebjas/CSRF-Protector-PHP/issues/54
[Deprecated] ~NoJS support? - https://github.com/mebjas/CSRF-Protector-PHP/tree/nojs-support~