3 # This Koha test module is a stub!
4 # Add more tests here!!!
12 use List::MoreUtils qw/all any none/;
13 use Test::More tests => 17;
16 use t::lib::TestBuilder;
20 use Koha::AuthUtils qw/hash_password/;
23 use Koha::Auth::TwoFactorAuth;
26 use_ok('C4::Auth', qw( checkauth haspermission track_login_daily checkpw get_template_and_user checkpw_hash ));
29 my $schema = Koha::Database->schema;
30 my $builder = t::lib::TestBuilder->new;
32 # FIXME: SessionStorage defaults to mysql, but it seems to break transaction
34 t::lib::Mocks::mock_preference( 'SessionStorage', 'tmp' );
35 t::lib::Mocks::mock_preference( 'GDPR_Policy', '' ); # Disabled
37 # To silence useless warnings
38 $ENV{REMOTE_ADDR} = '127.0.0.1';
40 $schema->storage->txn_begin;
42 subtest 'checkauth() tests' => sub {
46 my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { flags => undef } });
48 # Mock a CGI object with real userid param
49 my $cgi = Test::MockObject->new();
54 if ( $var eq 'userid' ) { return $patron->userid; }
57 $cgi->mock( 'cookie', sub { return; } );
58 $cgi->mock( 'request_method', sub { return 'POST' } );
60 my $authnotrequired = 1;
61 my ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, $authnotrequired );
63 is( $userid, undef, 'checkauth() returns undef for userid if no logged in user (Bug 18275)' );
65 my $db_user_id = C4::Context->config('user');
66 my $db_user_pass = C4::Context->config('pass');
67 $cgi = Test::MockObject->new();
68 $cgi->mock( 'cookie', sub { return; } );
69 $cgi->mock( 'param', sub {
70 my ( $self, $param ) = @_;
71 if ( $param eq 'userid' ) { return $db_user_id; }
72 elsif ( $param eq 'password' ) { return $db_user_pass; }
75 $cgi->mock( 'request_method', sub { return 'POST' } );
76 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, $authnotrequired );
77 is ( $userid, undef, 'If DB user is used, it should not be logged in' );
79 my $is_allowed = C4::Auth::haspermission( $db_user_id, { can_do => 'everything' } );
81 # FIXME This belongs to t/db_dependent/Auth/haspermission.t but we do not want to c/p the pervious mock statements
82 ok( !$is_allowed, 'DB user should not have any permissions');
84 subtest 'Prevent authentication when sending credential via GET' => sub {
88 my $patron = $builder->build_object(
89 { class => 'Koha::Patrons', value => { flags => 1 } } );
90 my $password = 'password';
91 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
92 $patron->set_password( { password => $password } );
93 $cgi = Test::MockObject->new();
94 $cgi->mock( 'cookie', sub { return; } );
98 my ( $self, $param ) = @_;
99 if ( $param eq 'userid' ) { return $patron->userid; }
100 elsif ( $param eq 'password' ) { return $password; }
105 $cgi->mock( 'request_method', sub { return 'POST' } );
106 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired' );
107 is( $userid, $patron->userid, 'If librarian user is used and password with POST, they should be logged in' );
109 $cgi->mock( 'request_method', sub { return 'GET' } );
110 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired' );
111 is( $userid, undef, 'If librarian user is used and password with GET, they should not be logged in' );
114 subtest 'Template params tests (password_expired)' => sub {
118 my $password_expired;
120 my $patron_class = Test::MockModule->new('Koha::Patron');
121 $patron_class->mock( 'password_expired', sub { return $password_expired; } );
123 my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { flags => 1 } });
124 my $password = 'password';
125 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
126 $patron->set_password( { password => $password } );
128 my $cgi_mock = Test::MockModule->new('CGI')->mock( 'request_method', 'POST' );
130 $cgi->param( -name => 'userid', -value => $patron->userid );
131 $cgi->param( -name => 'password', -value => $password );
133 my $auth = Test::MockModule->new( 'C4::Auth' );
134 # Tests will fail if we hit safe_exit
135 $auth->mock( 'safe_exit', sub { return } );
137 my ( $userid, $cookie, $sessionID, $flags );
140 t::lib::Mocks::mock_preference( 'DumpTemplateVarsOpac', 1 );
141 # checkauth will redirect and safe_exit if not authenticated and not authorized
144 open STDOUT, '>', \$stdout;
146 # Password has expired
147 $password_expired = 1;
148 C4::Auth::checkauth( $cgi, 0, { catalogue => 1 } );
149 like( $stdout, qr{'password_has_expired' => 1}, 'password_has_expired is set to 1' );
155 subtest 'Two-factor authentication' => sub {
158 my $patron = $builder->build_object(
159 { class => 'Koha::Patrons', value => { flags => 1 } } );
160 my $password = 'password';
161 $patron->set_password( { password => $password } );
162 $cgi = Test::MockObject->new();
165 our ( $logout, $sessionID, $verified );
169 my ( $self, $param ) = @_;
170 if ( $param eq 'userid' ) { return $patron->userid; }
171 elsif ( $param eq 'password' ) { return $password; }
172 elsif ( $param eq 'otp_token' ) { return $otp_token; }
173 elsif ( $param eq 'logout.x' ) { return $logout; }
177 $cgi->mock( 'request_method', sub { return 'POST' } );
178 $cgi->mock( 'cookie', sub { return $sessionID } );
180 my $two_factor_auth = Test::MockModule->new( 'Koha::Auth::TwoFactorAuth' );
181 $two_factor_auth->mock( 'verify', sub {$verified} );
183 my ( $userid, $cookie, $flags );
184 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
190 C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
194 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 'disabled' );
195 $patron->auth_method('password')->store;
196 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
197 is( $userid, $patron->userid, 'Succesful login' );
198 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'Second auth not required' );
201 $patron->auth_method('two-factor')->store;
202 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
203 is( $userid, $patron->userid, 'Succesful login' );
204 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'Second auth not required' );
207 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 'enabled' );
208 t::lib::Mocks::mock_config('encryption_key', '1234tH1s=t&st');
209 $patron->auth_method('password')->store;
210 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
211 is( $userid, $patron->userid, 'Succesful login' );
212 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'Second auth not required' );
215 $patron->encode_secret('one_secret');
216 $patron->auth_method('two-factor');
218 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
219 is( $userid, $patron->userid, 'Succesful login' );
220 my $session = C4::Auth::get_session($sessionID);
221 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), 1, 'Second auth required' );
224 $otp_token = "wrong";
226 $patron->auth_method('two-factor')->store;
227 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
228 is( $userid, $patron->userid, 'Succesful login' );
229 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), 1, 'Second auth still required after wrong OTP token' );
233 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
234 is( $userid, $patron->userid, 'Succesful login' );
235 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), 0, 'Second auth no longer required if OTP token has been verified' );
238 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 'enforced' );
239 $patron->auth_method('password')->store;
240 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
241 is( $userid, $patron->userid, 'Succesful login' );
242 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA-setup'), 1, 'Setup 2FA required' );
245 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'opac' );
246 is( $userid, $patron->userid, 'Succesful login at the OPAC' );
247 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'No second auth required at the OPAC' );
250 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 'disabled' );
251 $session = C4::Auth::get_session($sessionID);
252 $session->param('waiting-for-2FA', 1);
254 my ($auth_status, undef ) = C4::Auth::check_cookie_auth($sessionID, undef );
255 is( $auth_status, 'ok', 'User authenticated, pref was disabled, access OK' );
256 $session->param('waiting-for-2FA', 0);
257 $session->param('waiting-for-2FA-setup', 1);
259 ($auth_status, undef ) = C4::Auth::check_cookie_auth($sessionID, undef );
260 is( $auth_status, 'ok', 'User waiting for 2FA setup, pref was disabled, access OK' );
263 C4::Context->_new_userenv; # For next tests
267 subtest 'track_login_daily tests' => sub {
271 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
272 my $userid = $patron->userid;
274 $patron->lastseen( undef );
277 my $cache = Koha::Caches->get_instance();
278 my $cache_key = "track_login_" . $patron->userid;
279 $cache->clear_from_cache($cache_key);
281 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '1' );
283 is( $patron->lastseen, undef, 'Patron should have not last seen when newly created' );
285 C4::Auth::track_login_daily( $userid );
286 $patron->_result()->discard_changes();
287 isnt( $patron->lastseen, undef, 'Patron should have last seen set when TrackLastPatronActivity = 1' );
289 sleep(1); # We need to wait a tiny bit to make sure the timestamp will be different
290 my $last_seen = $patron->lastseen;
291 C4::Auth::track_login_daily( $userid );
292 $patron->_result()->discard_changes();
293 is( $patron->lastseen, $last_seen, 'Patron last seen should still be unchanged' );
295 $cache->clear_from_cache($cache_key);
296 C4::Auth::track_login_daily( $userid );
297 $patron->_result()->discard_changes();
298 isnt( $patron->lastseen, $last_seen, 'Patron last seen should be changed if we cleared the cache' );
300 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '0' );
301 $patron->lastseen( undef )->store;
302 $cache->clear_from_cache($cache_key);
303 C4::Auth::track_login_daily( $userid );
304 $patron->_result()->discard_changes();
305 is( $patron->lastseen, undef, 'Patron should still have last seen unchanged when TrackLastPatronActivity = 0' );
309 subtest 'no_set_userenv parameter tests' => sub {
313 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
314 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
315 my $password = 'password';
317 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
318 $patron->set_password({ password => $password });
320 ok( checkpw( $patron->userid, $password, undef, undef, 1 ), 'checkpw returns true' );
321 is( C4::Context->userenv, undef, 'Userenv should be undef as required' );
322 C4::Context->_new_userenv('DUMMY SESSION');
323 C4::Context->set_userenv(0,0,0,'firstname','surname', $library->branchcode, 'Library 1', 0, '', '');
324 is( C4::Context->userenv->{branch}, $library->branchcode, 'Userenv gives correct branch' );
325 ok( checkpw( $patron->userid, $password, undef, undef, 1 ), 'checkpw returns true' );
326 is( C4::Context->userenv->{branch}, $library->branchcode, 'Userenv branch is preserved if no_set_userenv is true' );
327 ok( checkpw( $patron->userid, $password, undef, undef, 0 ), 'checkpw still returns true' );
328 isnt( C4::Context->userenv->{branch}, $library->branchcode, 'Userenv branch is overwritten if no_set_userenv is false' );
331 subtest 'checkpw lockout tests' => sub {
335 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
336 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
337 my $password = 'password';
338 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
339 t::lib::Mocks::mock_preference( 'FailedLoginAttempts', 1 );
340 $patron->set_password({ password => $password });
342 my ( $checkpw, undef, undef ) = checkpw( $patron->cardnumber, $password, undef, undef, 1 );
343 ok( $checkpw, 'checkpw returns true with right password when logging in via cardnumber' );
344 ( $checkpw, undef, undef ) = checkpw( $patron->userid, "wrong_password", undef, undef, 1 );
345 is( $checkpw, 0, 'checkpw returns false when given wrong password' );
346 $patron = $patron->get_from_storage;
347 is( $patron->account_locked, 1, "Account is locked from failed login");
348 ( $checkpw, undef, undef ) = checkpw( $patron->userid, $password, undef, undef, 1 );
349 is( $checkpw, undef, 'checkpw returns undef with right password when account locked' );
350 ( $checkpw, undef, undef ) = checkpw( $patron->cardnumber, $password, undef, undef, 1 );
351 is( $checkpw, undef, 'checkpw returns undefwith right password when logging in via cardnumber if account locked' );
355 # get_template_and_user tests
357 subtest 'get_template_and_user' => sub { # Tests for the language URL parameter
359 sub MockedCheckauth {
360 my ($query,$authnotrequired,$flagsrequired,$type) = @_;
362 my $userid = 'cobain';
364 # we don't need to bother about permissions for this test
366 superlibrarian => 1, acquisition => 0,
368 catalogue => 1, circulate => 0,
369 coursereserves => 0, editauthorities => 0,
371 parameters => 0, permissions => 0,
372 plugins => 0, reports => 0,
373 reserveforothers => 0, serials => 0,
374 staffaccess => 0, tools => 0,
378 my $session_cookie = $query->cookie(
379 -name => 'CGISESSID',
384 return ( $userid, [ $session_cookie ], $sessionID, $flags );
387 # Mock checkauth, build the scenario
388 my $auth = Test::MockModule->new( 'C4::Auth' );
389 $auth->mock( 'checkauth', \&MockedCheckauth );
391 # Make sure 'EnableOpacSearchHistory' is set
392 t::lib::Mocks::mock_preference('EnableOpacSearchHistory',1);
393 # Enable es-ES for the OPAC and staff interfaces
394 t::lib::Mocks::mock_preference('OPACLanguages','en,es-ES');
395 t::lib::Mocks::mock_preference('language','en,es-ES');
397 # we need a session cookie
398 $ENV{"SERVER_PORT"} = 80;
399 $ENV{"HTTP_COOKIE"} = 'CGISESSID=nirvana';
401 my $query = CGI->new;
402 $query->param('language','es-ES');
404 my ( $template, $loggedinuser, $cookies ) = get_template_and_user(
406 template_name => "about.tt",
409 authnotrequired => 1,
410 flagsrequired => { catalogue => 1 },
415 ok ( ( all { ref($_) eq 'CGI::Cookie' } @$cookies ),
416 'BZ9735: the cookies array is flat' );
418 # new query, with non-existent language (we only have en and es-ES)
419 $query->param('language','tomas');
421 ( $template, $loggedinuser, $cookies ) = get_template_and_user(
423 template_name => "about.tt",
426 authnotrequired => 1,
427 flagsrequired => { catalogue => 1 },
432 ok( ( none { $_->name eq 'KohaOpacLanguage' and $_->value eq 'tomas' } @$cookies ),
433 'BZ9735: invalid language, it is not set');
435 ok( ( any { $_->name eq 'KohaOpacLanguage' and $_->value eq 'en' } @$cookies ),
436 'BZ9735: invalid language, then default to en');
438 for my $template_name (
440 ../../../../../../../../../../../../../../../etc/passwd
441 test/../../../../../../../../../../../../../../etc/passwd
443 test/does_not_finished_by_tt_t
447 ( $template, $loggedinuser, $cookies ) = get_template_and_user(
449 template_name => $template_name,
452 authnotrequired => 1,
453 flagsrequired => { catalogue => 1 },
457 like ( $@, qr(bad template path), "The file $template_name should not be accessible" );
459 ( $template, $loggedinuser, $cookies ) = get_template_and_user(
461 template_name => 'errors/errorpage.tt',
464 authnotrequired => 1,
465 flagsrequired => { catalogue => 1 },
468 my $file_exists = ( -f $template->{filename} ) ? 1 : 0;
469 is ( $file_exists, 1, 'The file errors/errorpage.tt should be accessible (contains integers)' );
471 # Regression test for env opac search limit override
472 $ENV{"OPAC_SEARCH_LIMIT"} = "branch:CPL";
473 $ENV{"OPAC_LIMIT_OVERRIDE"} = 1;
475 ( $template, $loggedinuser, $cookies) = get_template_and_user(
477 template_name => 'opac-main.tt',
480 authnotrequired => 1,
483 is($template->{VARS}->{'opac_name'}, "CPL", "Opac name was set correctly");
484 is($template->{VARS}->{'opac_search_limit'}, "branch:CPL", "Search limit was set correctly");
486 $ENV{"OPAC_SEARCH_LIMIT"} = "branch:multibranch-19";
488 ( $template, $loggedinuser, $cookies) = get_template_and_user(
490 template_name => 'opac-main.tt',
493 authnotrequired => 1,
496 is($template->{VARS}->{'opac_name'}, "multibranch-19", "Opac name was set correctly");
497 is($template->{VARS}->{'opac_search_limit'}, "branch:multibranch-19", "Search limit was set correctly");
499 delete $ENV{"HTTP_COOKIE"};
502 # Check that there is always an OPACBaseURL set.
503 my $input = CGI->new();
504 my ( $template1, $borrowernumber, $cookie );
505 ( $template1, $borrowernumber, $cookie ) = get_template_and_user(
507 template_name => "opac-detail.tt",
510 authnotrequired => 1,
514 ok( ( any { 'OPACBaseURL' eq $_ } keys %{$template1->{VARS}} ),
515 'OPACBaseURL is in OPAC template' );
518 ( $template2, $borrowernumber, $cookie ) = get_template_and_user(
520 template_name => "catalogue/detail.tt",
523 authnotrequired => 1,
527 ok( ( any { 'OPACBaseURL' eq $_ } keys %{$template2->{VARS}} ),
528 'OPACBaseURL is in Staff template' );
530 my $hash1 = hash_password('password');
531 my $hash2 = hash_password('password');
533 ok(C4::Auth::checkpw_hash('password', $hash1), 'password validates with first hash');
534 ok(C4::Auth::checkpw_hash('password', $hash2), 'password validates with second hash');
536 subtest 'Check value of login_attempts in checkpw' => sub {
539 t::lib::Mocks::mock_preference('FailedLoginAttempts', 3);
541 # Only interested here in regular login
545 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
546 $patron->login_attempts(2);
547 $patron->password('123')->store; # yes, deliberately not hashed
549 is( $patron->account_locked, 0, 'Patron not locked' );
550 my @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
551 # Note: 123 will not be hashed to 123 !
552 is( $test[0], 0, 'checkpw should have failed' );
553 $patron->discard_changes; # refresh
554 is( $patron->login_attempts, 3, 'Login attempts increased' );
555 is( $patron->account_locked, 1, 'Check locked status' );
557 # And another try to go over the limit: different return value!
558 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
559 is( @test, 0, 'checkpw failed again and returns nothing now' );
560 $patron->discard_changes; # refresh
561 is( $patron->login_attempts, 3, 'Login attempts not increased anymore' );
563 # Administrative lockout cannot be undone?
564 # Pass the right password now (or: add a nice mock).
565 my $auth = Test::MockModule->new( 'C4::Auth' );
566 $auth->mock( 'checkpw_hash', sub { return 1; } ); # not for production :)
567 $patron->login_attempts(0)->store;
568 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
569 is( $test[0], 1, 'Build confidence in the mock' );
570 $patron->login_attempts(-1)->store;
571 is( $patron->account_locked, 1, 'Check administrative lockout' );
572 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
573 is( @test, 0, 'checkpw gave red' );
574 $patron->discard_changes; # refresh
575 is( $patron->login_attempts, -1, 'Still locked out' );
576 t::lib::Mocks::mock_preference('FailedLoginAttempts', ''); # disable
577 is( $patron->account_locked, 1, 'Check administrative lockout without pref' );
580 subtest 'Check value of login_attempts in checkpw' => sub {
583 t::lib::Mocks::mock_preference('FailedLoginAttempts', 3);
584 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
585 $patron->set_password({ password => '123', skip_validation => 1 });
587 my @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
588 is( $test[0], 1, 'Patron authenticated correctly' );
590 $patron->password_expiration_date('2020-01-01')->store;
591 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
592 is( $test[0], -2, 'Patron returned as expired correctly' );
596 subtest '_timeout_syspref' => sub {
600 t::lib::Mocks::mock_preference('timeout', "100");
601 is( C4::Auth::_timeout_syspref, 100, );
603 t::lib::Mocks::mock_preference('timeout', "2d");
604 is( C4::Auth::_timeout_syspref, 2*86400, );
606 t::lib::Mocks::mock_preference('timeout', "2D");
607 is( C4::Auth::_timeout_syspref, 2*86400, );
609 t::lib::Mocks::mock_preference('timeout', "10h");
610 is( C4::Auth::_timeout_syspref, 10*3600, );
612 t::lib::Mocks::mock_preference('timeout', "10x");
614 { is( C4::Auth::_timeout_syspref, 600, ); }
615 "The value of the system preference 'timeout' is not correct, defaulting to 600",
616 'Bad values throw a warning and fallback to 600';
619 subtest 'check_cookie_auth' => sub {
622 t::lib::Mocks::mock_preference('timeout', "1d"); # back to default
624 my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { flags => 1 } });
626 # Mock a CGI object with real userid param
627 my $cgi = Test::MockObject->new();
632 if ( $var eq 'userid' ) { return $patron->userid; }
635 $cgi->mock('multi_param', sub {return q{}} );
636 $cgi->mock( 'cookie', sub { return; } );
637 $cgi->mock( 'request_method', sub { return 'POST' } );
639 $ENV{REMOTE_ADDR} = '127.0.0.1';
641 # Setting authnotrequired=1 or we wont' hit the return but the end of the sub that prints headers
642 my ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 1 );
644 my ($auth_status, $session) = C4::Auth::check_cookie_auth($sessionID);
645 isnt( $auth_status, 'ok', 'check_cookie_auth should not return ok if the user has not been authenticated before if no permissions needed' );
646 is( $auth_status, 'anon', 'check_cookie_auth should return anon if the user has not been authenticated before and no permissions needed' );
648 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 1 );
650 ($auth_status, $session) = C4::Auth::check_cookie_auth($sessionID, {catalogue => 1});
651 isnt( $auth_status, 'ok', 'check_cookie_auth should not return ok if the user has not been authenticated before and permissions needed' );
652 is( $auth_status, 'anon', 'check_cookie_auth should return anon if the user has not been authenticated before and permissions needed' );
654 #FIXME We should have a test to cover 'failed' status when a user has logged in, but doesn't have permission
657 subtest 'checkauth & check_cookie_auth' => sub {
660 # flags = 4 => { catalogue => 1 }
661 my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { flags => 4 } });
662 my $password = 'password';
663 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
664 $patron->set_password( { password => $password } );
666 my $cgi_mock = Test::MockModule->new('CGI');
667 $cgi_mock->mock( 'request_method', sub { return 'POST' } );
671 my $auth = Test::MockModule->new( 'C4::Auth' );
672 # Tests will fail if we hit safe_exit
673 $auth->mock( 'safe_exit', sub { return } );
675 my ( $userid, $cookie, $sessionID, $flags );
677 # checkauth will redirect and safe_exit if not authenticated and not authorized
680 open STDOUT, '>', \$stdout;
681 C4::Auth::checkauth($cgi, 0, {catalogue => 1});
682 like( $stdout, qr{<title>\s*Log in to your account} );
683 $sessionID = ( $stdout =~ m{Set-Cookie: CGISESSID=((\d|\w)+);} ) ? $1 : undef;
688 my $first_sessionID = $sessionID;
690 $ENV{"HTTP_COOKIE"} = "CGISESSID=$sessionID";
691 # Not authenticated yet, checkauth didn't return the session
695 open STDOUT, '>', \$stdout;
696 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1} );
699 is( $sessionID, undef);
702 # Sending undefined fails obviously
703 my ( $auth_status, $session ) = C4::Auth::check_cookie_auth($sessionID, {catalogue => 1} );
704 is( $auth_status, 'failed' );
705 is( $session, undef );
707 # Simulating the login form submission
708 $cgi->param('userid', $patron->userid);
709 $cgi->param('password', $password);
712 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
713 is( $sessionID, $first_sessionID );
714 is( $userid, $patron->userid );
716 ( $auth_status, $session ) = C4::Auth::check_cookie_auth($sessionID, {catalogue => 1});
717 is( $auth_status, 'ok' );
718 is( $session->id, $first_sessionID );
721 $cgi->param('logout.x', 1);
722 $cgi->delete( 'userid', 'password' );
726 open STDOUT, '>', \$stdout;
727 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
730 is( $sessionID, undef );
731 is( $ENV{"HTTP_COOKIE"}, "CGISESSID=$first_sessionID", 'HTTP_COOKIE not unset' );
732 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $first_sessionID, {catalogue => 1} );
733 is( $auth_status, "expired");
734 is( $session, undef );
737 # Trying to access without sessionID
739 ( $auth_status, $session) = C4::Auth::check_cookie_auth(undef, {catalogue => 1});
740 is( $auth_status, 'failed' );
741 is( $session, undef );
743 # This will fail on permissions
744 undef $ENV{"HTTP_COOKIE"};
748 open STDOUT, '>', \$stdout;
749 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1} );
752 is( $userid, undef );
753 is( $sessionID, undef );
759 $cgi->param('userid', $patron->userid);
760 $cgi->param('password', $password);
761 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
762 is( $userid, $patron->userid );
763 $first_sessionID = $sessionID;
765 # Patron does not have the borrowers permission
766 # $ENV{"HTTP_COOKIE"} = "CGISESSID=$sessionID"; # not needed, we use $cgi here
770 open STDOUT, '>', \$stdout;
771 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {borrowers => 1} );
774 is( $userid, undef );
775 is( $sessionID, undef );
777 # When calling check_cookie_auth, the session will be deleted
778 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $first_sessionID, { borrowers => 1 } );
779 is( $auth_status, "failed" );
780 is( $session, undef );
781 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $first_sessionID, { borrowers => 1 } );
782 is( $auth_status, 'expired', 'Session no longer exists' );
784 # NOTE: It is not what the UI is doing.
785 # From the UI we are allowed to hit an unauthorized page then reuse the session to hit back authorized area.
786 # It is because check_cookie_auth is ALWAYS called from checkauth WITHOUT $flagsrequired
787 # It then return "ok", when the previous called got "failed"
789 # Try reusing the deleted session: since it does not exist, we should get a new one now when passing correct permissions
790 $cgi->cookie( -name => 'CGISESSID', value => $first_sessionID );
791 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
792 is( $userid, $patron->userid );
793 isnt( $sessionID, undef, 'Check if we have a sessionID' );
794 isnt( $sessionID, $first_sessionID, 'New value expected' );
795 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID, {catalogue => 1} );
796 is( $auth_status, "ok" );
797 is( $session->id, $sessionID, 'Same session' );
798 # Two additional tests on userenv
799 is( $C4::Context::context->{activeuser}, $session->id, 'Check if environment has been setup for session' );
800 is( C4::Context->userenv->{id}, $userid, 'Check userid in userenv' );
804 subtest 'Userenv clearing in check_cookie_auth' => sub {
805 # Note: We did already test userenv for a logged-in user in previous subtest
808 t::lib::Mocks::mock_preference( 'timeout', 600 );
811 # Create a new anonymous session by passing a fake session ID
812 $cgi->cookie( -name => 'CGISESSID', -value => 'fake_sessionID' );
813 my ($userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 1);
814 my ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID );
815 is( $auth_status, 'anon', 'Should be anonymous' );
816 is( $C4::Context::context->{activeuser}, $session->id, 'Check activeuser' );
817 is( defined C4::Context->userenv, 1, 'There should be a userenv' );
818 is( C4::Context->userenv->{id}, q{}, 'userid should be empty string' );
820 # Make the session expire now, check_cookie_auth will delete it
821 $session->param('lasttime', time() - 1200 );
823 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID );
824 is( $auth_status, 'expired', 'Should be expired' );
825 is( C4::Context->userenv, undef, 'Environment should be cleared too' );
827 # Show that we clear the userenv again: set up env and check deleted session
828 C4::Context->_new_userenv( $sessionID );
829 C4::Context->set_userenv; # empty
830 is( defined C4::Context->userenv, 1, 'There should be an empty userenv again' );
831 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID );
832 is( $auth_status, 'expired', 'Should be expired already' );
833 is( C4::Context->userenv, undef, 'Environment should be cleared again' );
836 subtest 'create_basic_session tests' => sub {
839 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
841 my $session = C4::Auth::create_basic_session({ patron => $patron, interface => 'opac' });
843 isnt($session->id, undef, 'A new sessionID was created');
844 is( $session->param('number'), $patron->borrowernumber, 'Session parameter number matches' );
845 is( $session->param('id'), $patron->userid, 'Session parameter id matches' );
846 is( $session->param('cardnumber'), $patron->cardnumber, 'Session parameter cardnumber matches' );
847 is( $session->param('firstname'), $patron->firstname, 'Session parameter firstname matches' );
848 is( $session->param('surname'), $patron->surname, 'Session parameter surname matches' );
849 is( $session->param('branch'), $patron->branchcode, 'Session parameter branch matches' );
850 is( $session->param('branchname'), $patron->library->branchname, 'Session parameter branchname matches' );
851 is( $session->param('flags'), $patron->flags, 'Session parameter flags matches' );
852 is( $session->param('emailaddress'), $patron->email, 'Session parameter emailaddress matches' );
853 is( $session->param('ip'), $session->remote_addr(), 'Session parameter ip matches' );
854 is( $session->param('interface'), 'opac', 'Session parameter interface matches' );
856 $session = C4::Auth::create_basic_session({ patron => $patron, interface => 'staff' });
857 is( $session->param('interface'), 'intranet', 'Staff interface gets converted to intranet' );
860 $schema->storage->txn_rollback;