3 # Created as wrapper for CSRF and JWT 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
10 # under the terms of the GNU General Public License as published by
11 # the Free Software Foundation; either version 3 of the License, or
12 # (at your option) any later version.
14 # Koha is distributed in the hope that it will be useful, but
15 # WITHOUT ANY WARRANTY; without even the implied warranty of
16 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
17 # GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License
20 # along with Koha; if not, see <http://www.gnu.org/licenses>.
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 # generate/check CSRF token with defaults and session id
38 my $csrf_token = $tokenizer->generate_csrf({ session_id => $x });
39 my $result = $tokenizer->check_csrf({
40 session_id => $x, token => $token,
45 Designed for providing general tokens.
46 Created due to the need for a nonblocking call to Bytes::Random::Secure
47 when generating a CSRF token.
52 use Bytes::Random::Secure ();
53 use String::Random ();
56 use Digest::MD5 qw(md5_base64);
57 use Encode qw( encode );
58 use Koha::Exceptions::Token;
59 use base qw(Class::Accessor);
60 use constant HMAC_SHA1_LENGTH => 20;
61 use constant CSRF_EXPIRY_HOURS => 8; # 8 hours instead of 7 days..
67 Create object (via Class::Accessor).
73 return $class->SUPER::new();
78 my $token = $tokenizer->generate({ length => 20 });
79 my $csrf_token = $tokenizer->generate({
80 type => 'CSRF', id => $id, secret => $secret,
82 my $jwt = $tokenizer->generate({
83 type => 'JWT, id => $id, secret => $secret,
86 Generate several types of tokens. Now includes CSRF.
87 For non-CSRF tokens an optional pattern parameter overrides length.
88 Room for future extension.
90 Pattern parameter could be write down using this subset of regular expressions:
91 \w Alphanumeric + "_".
93 \W Printable characters other than those in \w.
94 \D Printable characters other than those in \d.
95 . Printable characters.
105 my ( $self, $params ) = @_;
106 if( $params->{type} && $params->{type} eq 'CSRF' ) {
107 $self->{lasttoken} = _gen_csrf( $params );
108 } elsif( $params->{type} && $params->{type} eq 'JWT' ) {
109 $self->{lasttoken} = _gen_jwt( $params );
111 $self->{lasttoken} = _gen_rand( $params );
113 return $self->{lasttoken};
118 Like: generate({ type => 'CSRF', ... })
119 Note: id defaults to userid from context, secret to database password.
120 session_id is mandatory; it is combined with id.
125 my ( $self, $params ) = @_;
126 return if !$params->{session_id};
127 $params = _add_default_csrf_params( $params );
128 return $self->generate({ %$params, type => 'CSRF' });
133 Like: generate({ type => 'JWT', ... })
134 Note that JWT is designed to encode a structure but here we are actually only allowing a value
135 that will be store in the key 'id'.
140 my ( $self, $params ) = @_;
141 return if !$params->{id};
142 $params = _add_default_jwt_params( $params );
143 return $self->generate({ %$params, type => 'JWT' });
148 my $result = $tokenizer->check({
149 type => 'CSRF', id => $id, token => $token,
152 Check several types of tokens. Now includes CSRF.
153 Room for future extension.
158 my ( $self, $params ) = @_;
159 if( $params->{type} && $params->{type} eq 'CSRF' ) {
160 return _chk_csrf( $params );
162 elsif( $params->{type} && $params->{type} eq 'JWT' ) {
163 return _chk_jwt( $params );
170 Like: check({ type => 'CSRF', ... })
171 Note: id defaults to userid from context, secret to database password.
172 session_id is mandatory; it is combined with id.
177 my ( $self, $params ) = @_;
178 return if !$params->{session_id};
179 $params = _add_default_csrf_params( $params );
180 return $self->check({ %$params, type => 'CSRF' });
185 Like: check({ type => 'JWT', id => $id, token => $token })
187 Will return true if the token contains the passed id
192 my ( $self, $params ) = @_;
193 $params = _add_default_jwt_params( $params );
194 return $self->check({ %$params, type => 'JWT' });
199 $tokenizer->decode_jwt({ type => 'JWT', token => $token })
201 Will return the value of the id stored in the token.
205 my ( $self, $params ) = @_;
206 $params = _add_default_jwt_params( $params );
207 return _decode_jwt( $params );
210 # --- Internal routines ---
212 sub _add_default_csrf_params {
214 $params->{session_id} //= '';
215 if( !$params->{id} ) {
216 $params->{id} = Encode::encode( 'UTF-8', C4::Context->userenv->{id} . $params->{session_id} );
218 $params->{id} .= $params->{session_id};
220 $params->{id} //= Encode::encode( 'UTF-8', C4::Context->userenv->{id} );
221 my $pw = C4::Context->config('pass');
222 $params->{secret} //= md5_base64( Encode::encode( 'UTF-8', $pw ) ),
228 # Since WWW::CSRF::generate_csrf_token does not use the NonBlocking
229 # parameter of Bytes::Random::Secure, we are passing random bytes from
230 # a non blocking source to WWW::CSRF via its Random parameter.
233 return if !$params->{id} || !$params->{secret};
236 my $randomizer = Bytes::Random::Secure->new( NonBlocking => 1 );
237 # this is most fundamental: do not use /dev/random since it is
238 # blocking, but use /dev/urandom !
239 my $random = $randomizer->bytes( HMAC_SHA1_LENGTH );
240 my $token = WWW::CSRF::generate_csrf_token(
241 $params->{id}, $params->{secret}, { Random => $random },
249 return if !$params->{id} || !$params->{secret} || !$params->{token};
251 my $csrf_status = WWW::CSRF::check_csrf_token(
255 { MaxAge => $params->{MaxAge} // ( CSRF_EXPIRY_HOURS * 3600 ) },
257 return $csrf_status == WWW::CSRF::CSRF_OK();
262 my $length = $params->{length} || 1;
263 $length = 1 unless $length > 0;
264 my $pattern = $params->{pattern} // '.{'.$length.'}'; # pattern overrides length parameter
268 $token = String::Random::random_regex( $pattern );
270 Koha::Exceptions::Token::BadPattern->throw($@) if $@;
274 sub _add_default_jwt_params {
276 my $pw = C4::Context->config('pass');
277 $params->{secret} //= md5_base64( Encode::encode( 'UTF-8', $pw ) ),
283 return if !$params->{id} || !$params->{secret};
285 return Mojo::JWT->new(
286 claims => { id => $params->{id} },
287 secret => $params->{secret}
293 return if !$params->{id} || !$params->{secret} || !$params->{token};
295 my $claims = Mojo::JWT->new(secret => $params->{secret})->decode($params->{token});
297 return 1 if exists $claims->{id} && $claims->{id} == $params->{id};
302 return if !$params->{token} || !$params->{secret};
304 my $claims = Mojo::JWT->new(secret => $params->{secret})->decode($params->{token});
306 return $claims->{id};
311 Marcel de Rooy, Rijksmuseum Amsterdam, The Netherlands