3 # Created as wrapper for CSRF tokens, but designed for more general use
5 # Copyright 2016 Rijksmuseum
7 # This file is part of Koha.
9 # Koha is free software; you can redistribute it and/or modify it under the
10 # terms of the GNU General Public License as published by the Free Software
11 # Foundation; either version 3 of the License, or (at your option) any later
14 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
15 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
16 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
18 # You should have received a copy of the GNU General Public License along
19 # with Koha; if not, write to the Free Software Foundation, Inc.,
20 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
24 Koha::Token - Tokenizer
29 my $tokenizer = Koha::Token->new;
30 my $token = $tokenizer->generate({ length => 20 });
32 # safely generate a CSRF token (nonblocking)
33 my $csrf_token = $tokenizer->generate({
34 type => 'CSRF', id => $id, secret => $secret,
37 # or check a CSRF token
38 my $result = $tokenizer->check_csrf({
39 id => $id, secret => $secret, token => $token,
44 Designed for providing general tokens.
45 Created due to the need for a nonblocking call to Bytes::Random::Secure
46 when generating a CSRF token.
51 use Bytes::Random::Secure ();
52 use String::Random ();
54 use Digest::MD5 qw(md5_base64);
55 use Encode qw( encode );
56 use base qw(Class::Accessor);
57 use constant HMAC_SHA1_LENGTH => 20;
58 use constant CSRF_EXPIRY_HOURS => 8; # 8 hours instead of 7 days..
64 Create object (via Class::Accessor).
70 return $class->SUPER::new();
75 my $token = $tokenizer->generate({ length => 20 });
76 my $csrf_token = $tokenizer->generate({
77 type => 'CSRF', id => $id,
80 Generate several types of tokens. Now includes CSRF.
81 Room for future extension.
86 my ( $self, $params ) = @_;
87 if( $params->{type} && $params->{type} eq 'CSRF' ) {
88 $self->{lasttoken} = _gen_csrf( {
89 id => Encode::encode( 'UTF-8', C4::Context->userenv->{id} . $params->{id} ),
90 secret => md5_base64( Encode::encode( 'UTF-8', C4::Context->config('pass') ) ),
93 $self->{lasttoken} = _gen_rand( $params );
95 return $self->{lasttoken};
100 Shortcut for: generate({ type => 'CSRF', ... })
105 my ( $self, $params ) = @_;
106 return unless $params->{id};
107 return $self->generate({ %$params, type => 'CSRF' });
112 my $result = $tokenizer->check({
113 type => 'CSRF', id => $id, token => $token,
116 Check several types of tokens. Now includes CSRF.
117 Room for future extension.
122 my ( $self, $params ) = @_;
123 if( $params->{type} && $params->{type} eq 'CSRF' ) {
124 return _chk_csrf( $params );
131 Shortcut for: check({ type => 'CSRF', ... })
136 my ( $self, $params ) = @_;
137 return $self->check({ %$params, type => 'CSRF' });
140 # --- Internal routines ---
144 # Since WWW::CSRF::generate_csrf_token does not use the NonBlocking
145 # parameter of Bytes::Random::Secure, we are passing random bytes from
146 # a non blocking source to WWW::CSRF via its Random parameter.
149 return if !$params->{id} || !$params->{secret};
152 my $randomizer = Bytes::Random::Secure->new( NonBlocking => 1 );
153 # this is most fundamental: do not use /dev/random since it is
154 # blocking, but use /dev/urandom !
155 my $random = $randomizer->bytes( HMAC_SHA1_LENGTH );
156 my $token = WWW::CSRF::generate_csrf_token(
157 $params->{id}, $params->{secret}, { Random => $random },
165 return if !$params->{id} || !$params->{token};
167 my $id = Encode::encode( 'UTF-8', C4::Context->userenv->{id} . $params->{id} );
168 my $secret = md5_base64( Encode::encode( 'UTF-8', C4::Context->config('pass') ) );
169 my $csrf_status = WWW::CSRF::check_csrf_token(
170 $id, $secret, $params->{token},
171 { MaxAge => $params->{MaxAge} // ( CSRF_EXPIRY_HOURS * 3600 ) },
173 return $csrf_status == WWW::CSRF::CSRF_OK();
178 my $length = $params->{length} || 1;
179 $length = 1 unless $length > 0;
181 return String::Random::random_string( '.' x $length );
186 Marcel de Rooy, Rijksmuseum Amsterdam, The Netherlands