/ 
Dancer2-Plugin-CSRF-1.01
River stage zero No dependents
/ Dancer2::Plugin::CSRF

NAME

Dancer2::Plugin::CSRF - CSRF tokens generation and validation

VERSION

Version 1.0

SYNOPSIS

  use Dancer2::Plugin::CSRF;

	hook before => sub {
		# ..
		if ( request->is_post() ) {
			my $csrf_token = param('csrf_token');
			if ( !$csrf_token || !validate_csrf_token($csrf_token) ) {
				redirect '/?error=invalid_csrf_token';
			}
			# ...
		}
	};

	get '/someform' => sub {
		template 'someform',
			{
			csrf_token => get_csrf_token(),
			};
	};

DESCRIPTION

This module provides two methods get_csrf_token() and validate_csrf_token($token).

Master token stored in session. CSRF tokens generated using master token and page uri.

CONFIGURATION

Configuration can be done in your Dancer2 config file. It requires no configuration, but you can change a key name (in session) for master token.

plugins:
  CSRF:
    session_key_name: 'plugin.csrf'

SUBROUTINES/METHODS

get_csrf_token

Generates csrf token for a current page, returns it.

validate_csrf_token

Validates passed csrf token for a form page, returns true if token is valid.

AUTHOR

Oleg Nurtdinov, <jumpercc at cpan.org>

BUGS

Please report any bugs or feature requests to bug-dancer2-plugin-csrf at rt.cpan.org, or through the web interface at http://rt.cpan.org/NoAuth/ReportBug.html?Queue=Dancer2-Plugin-CSRF. I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.

SUPPORT

You can find documentation for this module with the perldoc command.

perldoc Dancer2::Plugin::CSRF

You can also look for information at:

LICENSE AND COPYRIGHT

Copyright 2016 Oleg Nurtdinov.

This program is free software; you can redistribute it and/or modify it under the terms of the the Artistic License (2.0). You may obtain a copy of the full license at:

http://www.perlfoundation.org/artistic_license_2_0

Any use, modification, and distribution of the Standard or Modified Versions is governed by this Artistic License. By using, modifying or distributing the Package, you accept this license. Do not use, modify, or distribute the Package, if you do not accept this license.

If your Modified Version has been derived from a Modified Version made by someone other than you, you are nevertheless required to ensure that your Modified Version complies with the requirements of this license.

This license does not grant you the right to use any trademark, service mark, tradename, or logo of the Copyright Holder.

This license includes the non-exclusive, worldwide, free-of-charge patent license to make, have made, use, offer to sell, sell, import and otherwise transfer the Package with respect to any patent claims licensable by the Copyright Holder that are necessarily infringed by the Package. If you institute patent litigation (including a cross-claim or counterclaim) against any party alleging that the Package constitutes direct or contributory patent infringement, then this Artistic License to you shall terminate on the date that such litigation is filed.

Disclaimer of Warranty: THE PACKAGE IS PROVIDED BY THE COPYRIGHT HOLDER AND CONTRIBUTORS "AS IS' AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES. THE IMPLIED WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT ARE DISCLAIMED TO THE EXTENT PERMITTED BY YOUR LOCAL LAW. UNLESS REQUIRED BY LAW, NO COPYRIGHT HOLDER OR CONTRIBUTOR WILL BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES ARISING IN ANY WAY OUT OF THE USE OF THE PACKAGE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.