Koha/t/Auth_with_shibboleth.t
Nick Clemens d4589500d1
Bug 24065: Fail shib login if multiple users matched
Ideally you could test against active shib, but is a small code change and
covered by tests and should be readable

To test:
prove -v t/Auth_with_shibboleth.t

Signed-off-by: Liz Rea <wizzyrea@gmail.com>
Signed-off-by: Marcel de Rooy <m.de.rooy@rijksmuseum.nl>
Signed-off-by: Martin Renvoize <martin.renvoize@ptfs-europe.com>
2019-11-21 11:33:11 +00:00

413 lines
12 KiB
Perl

#!/usr/bin/perl
# This file is part of Koha.
#
# Koha is free software; you can redistribute it and/or modify it
# under the terms of the GNU General Public License as published by
# the Free Software Foundation; either version 3 of the License, or
# (at your option) any later version.
#
# Koha is distributed in the hope that it will be useful, but
# WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with Koha; if not, see <http://www.gnu.org/licenses>.
use Modern::Perl;
$| = 1;
use Module::Load::Conditional qw/check_install/;
use Test::More;
use Test::MockModule;
use Test::Warn;
use CGI;
use C4::Context;
BEGIN {
if ( check_install( module => 'Test::DBIx::Class' ) ) {
plan tests => 17;
}
else {
plan skip_all => "Need Test::DBIx::Class";
}
}
use Test::DBIx::Class {
schema_class => 'Koha::Schema',
connect_info => [ 'dbi:SQLite:dbname=:memory:', '', '' ]
};
# Mock Variables
my $matchpoint = 'userid';
my $autocreate = 0;
my $sync = 0;
my %mapping = (
'userid' => { 'is' => 'uid' },
'surname' => { 'is' => 'sn' },
'dateexpiry' => { 'is' => 'exp' },
'categorycode' => { 'is' => 'cat' },
'address' => { 'is' => 'add' },
'city' => { 'is' => 'city' },
);
$ENV{'uid'} = "test1234";
$ENV{'sn'} = undef;
$ENV{'exp'} = undef;
$ENV{'cat'} = undef;
$ENV{'add'} = undef;
$ENV{'city'} = undef;
# Setup Mocks
## Mock Context
my $context = new Test::MockModule('C4::Context');
### Mock ->config
$context->mock( 'config', \&mockedConfig );
### Mock ->preference
my $OPACBaseURL = "testopac.com";
my $staffClientBaseURL = "teststaff.com";
$context->mock( 'preference', \&mockedPref );
### Mock ->tz
$context->mock( 'timezone', sub { return 'local'; } );
### Mock ->interface
my $interface = 'opac';
$context->mock( 'interface', \&mockedInterface );
## Mock Database
my $database = new Test::MockModule('Koha::Database');
### Mock ->schema
$database->mock( 'schema', \&mockedSchema );
# Tests
##############################################################
# Can module load
use C4::Auth_with_shibboleth;
require_ok('C4::Auth_with_shibboleth');
$C4::Auth_with_shibboleth::debug = '0';
# Subroutine tests
## shib_ok
subtest "shib_ok tests" => sub {
plan tests => 5;
my $result;
# correct config, no debug
is( shib_ok(), '1', "good config" );
# bad config, no debug
$matchpoint = undef;
warnings_are { $result = shib_ok() }
[ { carped => 'shibboleth matchpoint not defined' }, ],
"undefined matchpoint = fatal config, warning given";
is( $result, '0', "bad config" );
$matchpoint = 'email';
warnings_are { $result = shib_ok() }
[ { carped => 'shibboleth matchpoint not mapped' }, ],
"unmapped matchpoint = fatal config, warning given";
is( $result, '0', "bad config" );
# add test for undefined shibboleth block
reset_config();
};
## logout_shib
#my $query = CGI->new();
#is(logout_shib($query),"https://".$opac."/Shibboleth.sso/Logout?return="."https://".$opac,"logout_shib");
## login_shib_url
my $query_string = 'language=en-GB';
$ENV{QUERY_STRING} = $query_string;
$ENV{SCRIPT_NAME} = '/cgi-bin/koha/opac-user.pl';
my $query = CGI->new($query_string);
is(
login_shib_url($query),
'https://testopac.com'
. '/Shibboleth.sso/Login?target='
. 'https://testopac.com/cgi-bin/koha/opac-user.pl?'
. $query_string,
"login shib url"
);
## get_login_shib
subtest "get_login_shib tests" => sub {
plan tests => 4;
my $login;
# good config
## debug off
$C4::Auth_with_shibboleth::debug = '0';
warnings_are { $login = get_login_shib() }[],
"good config with debug off, no warnings received";
is( $login, "test1234",
"good config with debug off, attribute value returned" );
## debug on
$C4::Auth_with_shibboleth::debug = '1';
warnings_are { $login = get_login_shib() }[
"koha borrower field to match: userid",
"shibboleth attribute to match: uid",
"uid value: test1234"
],
"good config with debug enabled, correct warnings received";
is( $login, "test1234",
"good config with debug enabled, attribute value returned" );
# bad config - with shib_ok implemented, we should never reach this sub with a bad config
};
## checkpw_shib
subtest "checkpw_shib tests" => sub {
plan tests => 24;
my $shib_login;
my ( $retval, $retcard, $retuserid );
# Setup Mock Database Data
fixtures_ok [
'Borrower' => [
[qw/cardnumber userid surname address city email/],
[qw/testcardnumber test1234 renvoize myaddress johnston /],
[qw/testcardnumber1 test12345 clamp1 myaddress quechee kid@clamp.io/],
[qw/testcardnumber2 test123456 clamp2 myaddress quechee kid@clamp.io/],
],
'Category' => [ [qw/categorycode default_privacy/], [qw/S never/], ]
],
'Installed some custom fixtures via the Populate fixture class';
# debug off
$C4::Auth_with_shibboleth::debug = '0';
# good user
$shib_login = "test1234";
warnings_are {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[], "good user with no debug";
is( $retval, "1", "user authenticated" );
is( $retcard, "testcardnumber", "expected cardnumber returned" );
is( $retuserid, "test1234", "expected userid returned" );
# bad user
$shib_login = 'martin';
warnings_are {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[], "bad user with no debug";
is( $retval, "0", "user not authenticated" );
# duplicated matchpoint
$matchpoint = 'email';
$mapping{'email'} = { is => 'email' };
$shib_login = 'kid@clamp.io';
warnings_are {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[], "bad user with no debug";
is( $retval, "0", "user not authenticated if duplicated matchpoint" );
$C4::Auth_with_shibboleth::debug = '1';
warnings_are {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[
q/checkpw_shib/,
q/koha borrower field to match: email/,
q/shibboleth attribute to match: email/,
q/User Shibboleth-authenticated as: kid@clamp.io/,
q/There are several users with email of kid@clamp.io, matchpoints must be unique/
], "duplicated matchpoint warned with debug";
$C4::Auth_with_shibboleth::debug = '0';
reset_config();
# autocreate user
$autocreate = 1;
$shib_login = 'test4321';
$ENV{'uid'} = 'test4321';
$ENV{'sn'} = "pika";
$ENV{'exp'} = "2017";
$ENV{'cat'} = "S";
$ENV{'add'} = 'Address';
$ENV{'city'} = 'City';
warnings_are {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[], "new user added with no debug";
is( $retval, "1", "user authenticated" );
is( $retuserid, "test4321", "expected userid returned" );
ok my $new_user = ResultSet('Borrower')
->search( { 'userid' => 'test4321' }, { rows => 1 } ), "new user found";
is_fields [qw/surname dateexpiry address city/], $new_user->next,
[qw/pika 2017 Address City/],
'Found $new_users surname';
$autocreate = 0;
# sync user
$sync = 1;
$ENV{'city'} = 'AnotherCity';
warnings_are {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[], "good user with sync";
ok my $sync_user = ResultSet('Borrower')
->search( { 'userid' => 'test4321' }, { rows => 1 } ), "sync user found";
is_fields [qw/surname dateexpiry address city/], $sync_user->next,
[qw/pika 2017 Address AnotherCity/],
'Found $sync_user synced city';
$sync = 0;
# debug on
$C4::Auth_with_shibboleth::debug = '1';
# good user
$shib_login = "test1234";
warnings_exist {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[
qr/checkpw_shib/,
qr/koha borrower field to match: userid/,
qr/shibboleth attribute to match: uid/,
qr/User Shibboleth-authenticated as:/
],
"good user with debug enabled";
is( $retval, "1", "user authenticated" );
is( $retcard, "testcardnumber", "expected cardnumber returned" );
is( $retuserid, "test1234", "expected userid returned" );
# bad user
$shib_login = "martin";
warnings_exist {
( $retval, $retcard, $retuserid ) = checkpw_shib($shib_login);
}
[
qr/checkpw_shib/,
qr/koha borrower field to match: userid/,
qr/shibboleth attribute to match: uid/,
qr/User Shibboleth-authenticated as:/,
qr/not a valid Koha user/
],
"bad user with debug enabled";
is( $retval, "0", "user not authenticated" );
};
## _get_uri - opac
$OPACBaseURL = "testopac.com";
is( C4::Auth_with_shibboleth::_get_uri(),
"https://testopac.com", "https opac uri returned" );
$OPACBaseURL = "http://testopac.com";
my $result;
warnings_are { $result = C4::Auth_with_shibboleth::_get_uri() }[
"shibboleth interface: $interface",
"Shibboleth requires OPACBaseURL/staffClientBaseURL to use the https protocol!"
],
"improper protocol - received expected warning";
is( $result, "https://testopac.com", "https opac uri returned" );
$OPACBaseURL = "https://testopac.com";
is( C4::Auth_with_shibboleth::_get_uri(),
"https://testopac.com", "https opac uri returned" );
$OPACBaseURL = undef;
warnings_are { $result = C4::Auth_with_shibboleth::_get_uri() }
[ "shibboleth interface: $interface", "OPACBaseURL not set!" ],
"undefined OPACBaseURL - received expected warning";
is( $result, "https://", "https $interface uri returned" );
## _get_uri - intranet
$interface = 'intranet';
$staffClientBaseURL = "teststaff.com";
is( C4::Auth_with_shibboleth::_get_uri(),
"https://teststaff.com", "https $interface uri returned" );
$staffClientBaseURL = "http://teststaff.com";
warnings_are { $result = C4::Auth_with_shibboleth::_get_uri() }[
"shibboleth interface: $interface",
"Shibboleth requires OPACBaseURL/staffClientBaseURL to use the https protocol!"
],
"improper protocol - received expected warning";
is( $result, "https://teststaff.com", "https $interface uri returned" );
$staffClientBaseURL = "https://teststaff.com";
is( C4::Auth_with_shibboleth::_get_uri(),
"https://teststaff.com", "https $interface uri returned" );
$staffClientBaseURL = undef;
warnings_are { $result = C4::Auth_with_shibboleth::_get_uri() }
[ "shibboleth interface: $interface", "staffClientBaseURL not set!" ],
"undefined staffClientBaseURL - received expected warning";
is( $result, "https://", "https $interface uri returned" );
## _get_shib_config
# Internal helper function, covered in tests above
sub mockedConfig {
my $param = shift;
my %shibboleth = (
'autocreate' => $autocreate,
'sync' => $sync,
'matchpoint' => $matchpoint,
'mapping' => \%mapping
);
return \%shibboleth;
}
sub mockedPref {
my $param = $_[1];
my $return;
if ( $param eq 'OPACBaseURL' ) {
$return = $OPACBaseURL;
}
if ( $param eq 'staffClientBaseURL' ) {
$return = $staffClientBaseURL;
}
return $return;
}
sub mockedInterface {
return $interface;
}
sub mockedSchema {
return Schema();
}
## Convenience method to reset config
sub reset_config {
$matchpoint = 'userid';
$autocreate = 0;
$sync = 0;
%mapping = (
'userid' => { 'is' => 'uid' },
'surname' => { 'is' => 'sn' },
'dateexpiry' => { 'is' => 'exp' },
'categorycode' => { 'is' => 'cat' },
'address' => { 'is' => 'add' },
'city' => { 'is' => 'city' },
);
$ENV{'uid'} = "test1234";
$ENV{'sn'} = undef;
$ENV{'exp'} = undef;
$ENV{'cat'} = undef;
$ENV{'add'} = undef;
$ENV{'city'} = undef;
return 1;
}