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 => 16;
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 {
157 my $patron = $builder->build_object(
158 { class => 'Koha::Patrons', value => { flags => 1 } } );
159 my $password = 'password';
160 $patron->set_password( { password => $password } );
161 $cgi = Test::MockObject->new();
164 our ( $logout, $sessionID, $verified );
168 my ( $self, $param ) = @_;
169 if ( $param eq 'userid' ) { return $patron->userid; }
170 elsif ( $param eq 'password' ) { return $password; }
171 elsif ( $param eq 'otp_token' ) { return $otp_token; }
172 elsif ( $param eq 'logout.x' ) { return $logout; }
176 $cgi->mock( 'request_method', sub { return 'POST' } );
177 $cgi->mock( 'cookie', sub { return $sessionID } );
179 my $two_factor_auth = Test::MockModule->new( 'Koha::Auth::TwoFactorAuth' );
180 $two_factor_auth->mock( 'verify', sub {$verified} );
182 my ( $userid, $cookie, $flags );
183 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
189 C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
193 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 0 );
194 $patron->auth_method('password')->store;
195 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
196 is( $userid, $patron->userid, 'Succesful login' );
197 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'Second auth not required' );
200 $patron->auth_method('two-factor')->store;
201 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
202 is( $userid, $patron->userid, 'Succesful login' );
203 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'Second auth not required' );
206 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 1 );
207 t::lib::Mocks::mock_config('encryption_key', '1234tH1s=t&st');
208 $patron->auth_method('password')->store;
209 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
210 is( $userid, $patron->userid, 'Succesful login' );
211 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'Second auth not required' );
214 $patron->encode_secret('one_secret');
215 $patron->auth_method('two-factor');
217 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
218 is( $userid, $patron->userid, 'Succesful login' );
219 my $session = C4::Auth::get_session($sessionID);
220 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), 1, 'Second auth required' );
223 $otp_token = "wrong";
225 $patron->auth_method('two-factor')->store;
226 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
227 is( $userid, $patron->userid, 'Succesful login' );
228 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), 1, 'Second auth still required after wrong OTP token' );
232 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'intranet' );
233 is( $userid, $patron->userid, 'Succesful login' );
234 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), 0, 'Second auth no longer required if OTP token has been verified' );
237 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 'authrequired', undef, 'opac' );
238 is( $userid, $patron->userid, 'Succesful login at the OPAC' );
239 is( C4::Auth::get_session($sessionID)->param('waiting-for-2FA'), undef, 'No second auth required at the OPAC' );
241 t::lib::Mocks::mock_preference( 'TwoFactorAuthentication', 0 );
244 C4::Context->_new_userenv; # For next tests
248 subtest 'track_login_daily tests' => sub {
252 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
253 my $userid = $patron->userid;
255 $patron->lastseen( undef );
258 my $cache = Koha::Caches->get_instance();
259 my $cache_key = "track_login_" . $patron->userid;
260 $cache->clear_from_cache($cache_key);
262 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '1' );
264 is( $patron->lastseen, undef, 'Patron should have not last seen when newly created' );
266 C4::Auth::track_login_daily( $userid );
267 $patron->_result()->discard_changes();
268 isnt( $patron->lastseen, undef, 'Patron should have last seen set when TrackLastPatronActivity = 1' );
270 sleep(1); # We need to wait a tiny bit to make sure the timestamp will be different
271 my $last_seen = $patron->lastseen;
272 C4::Auth::track_login_daily( $userid );
273 $patron->_result()->discard_changes();
274 is( $patron->lastseen, $last_seen, 'Patron last seen should still be unchanged' );
276 $cache->clear_from_cache($cache_key);
277 C4::Auth::track_login_daily( $userid );
278 $patron->_result()->discard_changes();
279 isnt( $patron->lastseen, $last_seen, 'Patron last seen should be changed if we cleared the cache' );
281 t::lib::Mocks::mock_preference( 'TrackLastPatronActivity', '0' );
282 $patron->lastseen( undef )->store;
283 $cache->clear_from_cache($cache_key);
284 C4::Auth::track_login_daily( $userid );
285 $patron->_result()->discard_changes();
286 is( $patron->lastseen, undef, 'Patron should still have last seen unchanged when TrackLastPatronActivity = 0' );
290 subtest 'no_set_userenv parameter tests' => sub {
294 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
295 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
296 my $password = 'password';
298 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
299 $patron->set_password({ password => $password });
301 ok( checkpw( $patron->userid, $password, undef, undef, 1 ), 'checkpw returns true' );
302 is( C4::Context->userenv, undef, 'Userenv should be undef as required' );
303 C4::Context->_new_userenv('DUMMY SESSION');
304 C4::Context->set_userenv(0,0,0,'firstname','surname', $library->branchcode, 'Library 1', 0, '', '');
305 is( C4::Context->userenv->{branch}, $library->branchcode, 'Userenv gives correct branch' );
306 ok( checkpw( $patron->userid, $password, undef, undef, 1 ), 'checkpw returns true' );
307 is( C4::Context->userenv->{branch}, $library->branchcode, 'Userenv branch is preserved if no_set_userenv is true' );
308 ok( checkpw( $patron->userid, $password, undef, undef, 0 ), 'checkpw still returns true' );
309 isnt( C4::Context->userenv->{branch}, $library->branchcode, 'Userenv branch is overwritten if no_set_userenv is false' );
312 subtest 'checkpw lockout tests' => sub {
316 my $library = $builder->build_object( { class => 'Koha::Libraries' } );
317 my $patron = $builder->build_object( { class => 'Koha::Patrons' } );
318 my $password = 'password';
319 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
320 t::lib::Mocks::mock_preference( 'FailedLoginAttempts', 1 );
321 $patron->set_password({ password => $password });
323 my ( $checkpw, undef, undef ) = checkpw( $patron->cardnumber, $password, undef, undef, 1 );
324 ok( $checkpw, 'checkpw returns true with right password when logging in via cardnumber' );
325 ( $checkpw, undef, undef ) = checkpw( $patron->userid, "wrong_password", undef, undef, 1 );
326 is( $checkpw, 0, 'checkpw returns false when given wrong password' );
327 $patron = $patron->get_from_storage;
328 is( $patron->account_locked, 1, "Account is locked from failed login");
329 ( $checkpw, undef, undef ) = checkpw( $patron->userid, $password, undef, undef, 1 );
330 is( $checkpw, undef, 'checkpw returns undef with right password when account locked' );
331 ( $checkpw, undef, undef ) = checkpw( $patron->cardnumber, $password, undef, undef, 1 );
332 is( $checkpw, undef, 'checkpw returns undefwith right password when logging in via cardnumber if account locked' );
336 # get_template_and_user tests
338 subtest 'get_template_and_user' => sub { # Tests for the language URL parameter
340 sub MockedCheckauth {
341 my ($query,$authnotrequired,$flagsrequired,$type) = @_;
343 my $userid = 'cobain';
345 # we don't need to bother about permissions for this test
347 superlibrarian => 1, acquisition => 0,
349 catalogue => 1, circulate => 0,
350 coursereserves => 0, editauthorities => 0,
352 parameters => 0, permissions => 0,
353 plugins => 0, reports => 0,
354 reserveforothers => 0, serials => 0,
355 staffaccess => 0, tools => 0,
359 my $session_cookie = $query->cookie(
360 -name => 'CGISESSID',
365 return ( $userid, [ $session_cookie ], $sessionID, $flags );
368 # Mock checkauth, build the scenario
369 my $auth = Test::MockModule->new( 'C4::Auth' );
370 $auth->mock( 'checkauth', \&MockedCheckauth );
372 # Make sure 'EnableOpacSearchHistory' is set
373 t::lib::Mocks::mock_preference('EnableOpacSearchHistory',1);
374 # Enable es-ES for the OPAC and staff interfaces
375 t::lib::Mocks::mock_preference('OPACLanguages','en,es-ES');
376 t::lib::Mocks::mock_preference('language','en,es-ES');
378 # we need a session cookie
379 $ENV{"SERVER_PORT"} = 80;
380 $ENV{"HTTP_COOKIE"} = 'CGISESSID=nirvana';
382 my $query = CGI->new;
383 $query->param('language','es-ES');
385 my ( $template, $loggedinuser, $cookies ) = get_template_and_user(
387 template_name => "about.tt",
390 authnotrequired => 1,
391 flagsrequired => { catalogue => 1 },
396 ok ( ( all { ref($_) eq 'CGI::Cookie' } @$cookies ),
397 'BZ9735: the cookies array is flat' );
399 # new query, with non-existent language (we only have en and es-ES)
400 $query->param('language','tomas');
402 ( $template, $loggedinuser, $cookies ) = get_template_and_user(
404 template_name => "about.tt",
407 authnotrequired => 1,
408 flagsrequired => { catalogue => 1 },
413 ok( ( none { $_->name eq 'KohaOpacLanguage' and $_->value eq 'tomas' } @$cookies ),
414 'BZ9735: invalid language, it is not set');
416 ok( ( any { $_->name eq 'KohaOpacLanguage' and $_->value eq 'en' } @$cookies ),
417 'BZ9735: invalid language, then default to en');
419 for my $template_name (
421 ../../../../../../../../../../../../../../../etc/passwd
422 test/../../../../../../../../../../../../../../etc/passwd
424 test/does_not_finished_by_tt_t
428 ( $template, $loggedinuser, $cookies ) = get_template_and_user(
430 template_name => $template_name,
433 authnotrequired => 1,
434 flagsrequired => { catalogue => 1 },
438 like ( $@, qr(bad template path), "The file $template_name should not be accessible" );
440 ( $template, $loggedinuser, $cookies ) = get_template_and_user(
442 template_name => 'errors/errorpage.tt',
445 authnotrequired => 1,
446 flagsrequired => { catalogue => 1 },
449 my $file_exists = ( -f $template->{filename} ) ? 1 : 0;
450 is ( $file_exists, 1, 'The file errors/errorpage.tt should be accessible (contains integers)' );
452 # Regression test for env opac search limit override
453 $ENV{"OPAC_SEARCH_LIMIT"} = "branch:CPL";
454 $ENV{"OPAC_LIMIT_OVERRIDE"} = 1;
456 ( $template, $loggedinuser, $cookies) = get_template_and_user(
458 template_name => 'opac-main.tt',
461 authnotrequired => 1,
464 is($template->{VARS}->{'opac_name'}, "CPL", "Opac name was set correctly");
465 is($template->{VARS}->{'opac_search_limit'}, "branch:CPL", "Search limit was set correctly");
467 $ENV{"OPAC_SEARCH_LIMIT"} = "branch:multibranch-19";
469 ( $template, $loggedinuser, $cookies) = get_template_and_user(
471 template_name => 'opac-main.tt',
474 authnotrequired => 1,
477 is($template->{VARS}->{'opac_name'}, "multibranch-19", "Opac name was set correctly");
478 is($template->{VARS}->{'opac_search_limit'}, "branch:multibranch-19", "Search limit was set correctly");
480 delete $ENV{"HTTP_COOKIE"};
483 # Check that there is always an OPACBaseURL set.
484 my $input = CGI->new();
485 my ( $template1, $borrowernumber, $cookie );
486 ( $template1, $borrowernumber, $cookie ) = get_template_and_user(
488 template_name => "opac-detail.tt",
491 authnotrequired => 1,
495 ok( ( any { 'OPACBaseURL' eq $_ } keys %{$template1->{VARS}} ),
496 'OPACBaseURL is in OPAC template' );
499 ( $template2, $borrowernumber, $cookie ) = get_template_and_user(
501 template_name => "catalogue/detail.tt",
504 authnotrequired => 1,
508 ok( ( any { 'OPACBaseURL' eq $_ } keys %{$template2->{VARS}} ),
509 'OPACBaseURL is in Staff template' );
511 my $hash1 = hash_password('password');
512 my $hash2 = hash_password('password');
514 ok(C4::Auth::checkpw_hash('password', $hash1), 'password validates with first hash');
515 ok(C4::Auth::checkpw_hash('password', $hash2), 'password validates with second hash');
517 subtest 'Check value of login_attempts in checkpw' => sub {
520 t::lib::Mocks::mock_preference('FailedLoginAttempts', 3);
522 # Only interested here in regular login
526 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
527 $patron->login_attempts(2);
528 $patron->password('123')->store; # yes, deliberately not hashed
530 is( $patron->account_locked, 0, 'Patron not locked' );
531 my @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
532 # Note: 123 will not be hashed to 123 !
533 is( $test[0], 0, 'checkpw should have failed' );
534 $patron->discard_changes; # refresh
535 is( $patron->login_attempts, 3, 'Login attempts increased' );
536 is( $patron->account_locked, 1, 'Check locked status' );
538 # And another try to go over the limit: different return value!
539 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
540 is( @test, 0, 'checkpw failed again and returns nothing now' );
541 $patron->discard_changes; # refresh
542 is( $patron->login_attempts, 3, 'Login attempts not increased anymore' );
544 # Administrative lockout cannot be undone?
545 # Pass the right password now (or: add a nice mock).
546 my $auth = Test::MockModule->new( 'C4::Auth' );
547 $auth->mock( 'checkpw_hash', sub { return 1; } ); # not for production :)
548 $patron->login_attempts(0)->store;
549 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
550 is( $test[0], 1, 'Build confidence in the mock' );
551 $patron->login_attempts(-1)->store;
552 is( $patron->account_locked, 1, 'Check administrative lockout' );
553 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
554 is( @test, 0, 'checkpw gave red' );
555 $patron->discard_changes; # refresh
556 is( $patron->login_attempts, -1, 'Still locked out' );
557 t::lib::Mocks::mock_preference('FailedLoginAttempts', ''); # disable
558 is( $patron->account_locked, 1, 'Check administrative lockout without pref' );
561 subtest 'Check value of login_attempts in checkpw' => sub {
564 t::lib::Mocks::mock_preference('FailedLoginAttempts', 3);
565 my $patron = $builder->build_object({ class => 'Koha::Patrons' });
566 $patron->set_password({ password => '123', skip_validation => 1 });
568 my @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
569 is( $test[0], 1, 'Patron authenticated correctly' );
571 $patron->password_expiration_date('2020-01-01')->store;
572 @test = checkpw( $patron->userid, '123', undef, 'opac', 1 );
573 is( $test[0], -2, 'Patron returned as expired correctly' );
577 subtest '_timeout_syspref' => sub {
581 t::lib::Mocks::mock_preference('timeout', "100");
582 is( C4::Auth::_timeout_syspref, 100, );
584 t::lib::Mocks::mock_preference('timeout', "2d");
585 is( C4::Auth::_timeout_syspref, 2*86400, );
587 t::lib::Mocks::mock_preference('timeout', "2D");
588 is( C4::Auth::_timeout_syspref, 2*86400, );
590 t::lib::Mocks::mock_preference('timeout', "10h");
591 is( C4::Auth::_timeout_syspref, 10*3600, );
593 t::lib::Mocks::mock_preference('timeout', "10x");
595 { is( C4::Auth::_timeout_syspref, 600, ); }
596 "The value of the system preference 'timeout' is not correct, defaulting to 600",
597 'Bad values throw a warning and fallback to 600';
600 subtest 'check_cookie_auth' => sub {
603 t::lib::Mocks::mock_preference('timeout', "1d"); # back to default
605 my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { flags => 1 } });
607 # Mock a CGI object with real userid param
608 my $cgi = Test::MockObject->new();
613 if ( $var eq 'userid' ) { return $patron->userid; }
616 $cgi->mock('multi_param', sub {return q{}} );
617 $cgi->mock( 'cookie', sub { return; } );
618 $cgi->mock( 'request_method', sub { return 'POST' } );
620 $ENV{REMOTE_ADDR} = '127.0.0.1';
622 # Setting authnotrequired=1 or we wont' hit the return but the end of the sub that prints headers
623 my ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 1 );
625 my ($auth_status, $session) = C4::Auth::check_cookie_auth($sessionID);
626 isnt( $auth_status, 'ok', 'check_cookie_auth should not return ok if the user has not been authenticated before if no permissions needed' );
627 is( $auth_status, 'anon', 'check_cookie_auth should return anon if the user has not been authenticated before and no permissions needed' );
629 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth( $cgi, 1 );
631 ($auth_status, $session) = C4::Auth::check_cookie_auth($sessionID, {catalogue => 1});
632 isnt( $auth_status, 'ok', 'check_cookie_auth should not return ok if the user has not been authenticated before and permissions needed' );
633 is( $auth_status, 'anon', 'check_cookie_auth should return anon if the user has not been authenticated before and permissions needed' );
635 #FIXME We should have a test to cover 'failed' status when a user has logged in, but doesn't have permission
638 subtest 'checkauth & check_cookie_auth' => sub {
641 # flags = 4 => { catalogue => 1 }
642 my $patron = $builder->build_object({ class => 'Koha::Patrons', value => { flags => 4 } });
643 my $password = 'password';
644 t::lib::Mocks::mock_preference( 'RequireStrongPassword', 0 );
645 $patron->set_password( { password => $password } );
647 my $cgi_mock = Test::MockModule->new('CGI');
648 $cgi_mock->mock( 'request_method', sub { return 'POST' } );
652 my $auth = Test::MockModule->new( 'C4::Auth' );
653 # Tests will fail if we hit safe_exit
654 $auth->mock( 'safe_exit', sub { return } );
656 my ( $userid, $cookie, $sessionID, $flags );
658 # checkauth will redirect and safe_exit if not authenticated and not authorized
661 open STDOUT, '>', \$stdout;
662 C4::Auth::checkauth($cgi, 0, {catalogue => 1});
663 like( $stdout, qr{<title>\s*Log in to your account} );
664 $sessionID = ( $stdout =~ m{Set-Cookie: CGISESSID=((\d|\w)+);} ) ? $1 : undef;
669 my $first_sessionID = $sessionID;
671 $ENV{"HTTP_COOKIE"} = "CGISESSID=$sessionID";
672 # Not authenticated yet, checkauth didn't return the session
676 open STDOUT, '>', \$stdout;
677 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1} );
680 is( $sessionID, undef);
683 # Sending undefined fails obviously
684 my ( $auth_status, $session ) = C4::Auth::check_cookie_auth($sessionID, {catalogue => 1} );
685 is( $auth_status, 'failed' );
686 is( $session, undef );
688 # Simulating the login form submission
689 $cgi->param('userid', $patron->userid);
690 $cgi->param('password', $password);
693 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
694 is( $sessionID, $first_sessionID );
695 is( $userid, $patron->userid );
697 ( $auth_status, $session ) = C4::Auth::check_cookie_auth($sessionID, {catalogue => 1});
698 is( $auth_status, 'ok' );
699 is( $session->id, $first_sessionID );
702 $cgi->param('logout.x', 1);
703 $cgi->delete( 'userid', 'password' );
707 open STDOUT, '>', \$stdout;
708 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
711 is( $sessionID, undef );
712 is( $ENV{"HTTP_COOKIE"}, "CGISESSID=$first_sessionID", 'HTTP_COOKIE not unset' );
713 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $first_sessionID, {catalogue => 1} );
714 is( $auth_status, "expired");
715 is( $session, undef );
718 # Trying to access without sessionID
720 ( $auth_status, $session) = C4::Auth::check_cookie_auth(undef, {catalogue => 1});
721 is( $auth_status, 'failed' );
722 is( $session, undef );
724 # This will fail on permissions
725 undef $ENV{"HTTP_COOKIE"};
729 open STDOUT, '>', \$stdout;
730 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1} );
733 is( $userid, undef );
734 is( $sessionID, undef );
740 $cgi->param('userid', $patron->userid);
741 $cgi->param('password', $password);
742 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
743 is( $userid, $patron->userid );
744 $first_sessionID = $sessionID;
746 # Patron does not have the borrowers permission
747 # $ENV{"HTTP_COOKIE"} = "CGISESSID=$sessionID"; # not needed, we use $cgi here
751 open STDOUT, '>', \$stdout;
752 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {borrowers => 1} );
755 is( $userid, undef );
756 is( $sessionID, undef );
758 # When calling check_cookie_auth, the session will be deleted
759 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $first_sessionID, { borrowers => 1 } );
760 is( $auth_status, "failed" );
761 is( $session, undef );
762 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $first_sessionID, { borrowers => 1 } );
763 is( $auth_status, 'expired', 'Session no longer exists' );
765 # NOTE: It is not what the UI is doing.
766 # From the UI we are allowed to hit an unauthorized page then reuse the session to hit back authorized area.
767 # It is because check_cookie_auth is ALWAYS called from checkauth WITHOUT $flagsrequired
768 # It then return "ok", when the previous called got "failed"
770 # Try reusing the deleted session: since it does not exist, we should get a new one now when passing correct permissions
771 $cgi->cookie( -name => 'CGISESSID', value => $first_sessionID );
772 ( $userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 0, {catalogue => 1});
773 is( $userid, $patron->userid );
774 isnt( $sessionID, undef, 'Check if we have a sessionID' );
775 isnt( $sessionID, $first_sessionID, 'New value expected' );
776 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID, {catalogue => 1} );
777 is( $auth_status, "ok" );
778 is( $session->id, $sessionID, 'Same session' );
779 # Two additional tests on userenv
780 is( $C4::Context::context->{activeuser}, $session->id, 'Check if environment has been setup for session' );
781 is( C4::Context->userenv->{id}, $userid, 'Check userid in userenv' );
785 subtest 'Userenv clearing in check_cookie_auth' => sub {
786 # Note: We did already test userenv for a logged-in user in previous subtest
789 t::lib::Mocks::mock_preference( 'timeout', 600 );
792 # Create a new anonymous session by passing a fake session ID
793 $cgi->cookie( -name => 'CGISESSID', -value => 'fake_sessionID' );
794 my ($userid, $cookie, $sessionID, $flags ) = C4::Auth::checkauth($cgi, 1);
795 my ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID );
796 is( $auth_status, 'anon', 'Should be anonymous' );
797 is( $C4::Context::context->{activeuser}, $session->id, 'Check activeuser' );
798 is( defined C4::Context->userenv, 1, 'There should be a userenv' );
799 is( C4::Context->userenv->{id}, q{}, 'userid should be empty string' );
801 # Make the session expire now, check_cookie_auth will delete it
802 $session->param('lasttime', time() - 1200 );
804 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID );
805 is( $auth_status, 'expired', 'Should be expired' );
806 is( C4::Context->userenv, undef, 'Environment should be cleared too' );
808 # Show that we clear the userenv again: set up env and check deleted session
809 C4::Context->_new_userenv( $sessionID );
810 C4::Context->set_userenv; # empty
811 is( defined C4::Context->userenv, 1, 'There should be an empty userenv again' );
812 ( $auth_status, $session) = C4::Auth::check_cookie_auth( $sessionID );
813 is( $auth_status, 'expired', 'Should be expired already' );
814 is( C4::Context->userenv, undef, 'Environment should be cleared again' );
817 $schema->storage->txn_rollback;