X-Git-Url: http://git.rot13.org/?a=blobdiff_plain;f=C4%2FAuth_with_cas.pm;h=8cc8cde8accd1d4ff7efd20ca43ed7c85459895a;hb=dbcd0511e7580cce996965d54982bfcce7c97b14;hp=5d4c3e0a59d99fc1a133f0eae7e57c5d48388229;hpb=6a7d1f448d880c00253f3f8d6442a0dc601cffc6;p=koha.git

diff --git a/C4/Auth_with_cas.pm b/C4/Auth_with_cas.pm
index 5d4c3e0a59..8cc8cde8ac 100644
--- a/C4/Auth_with_cas.pm
+++ b/C4/Auth_with_cas.pm
@@ -4,108 +4,272 @@ package C4::Auth_with_cas;
 #
 # 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 2 of the License, or (at your option) any later
-# version.
+# 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.
+# 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, write to the Free Software Foundation, Inc., 59 Temple Place,
-# Suite 330, Boston, MA  02111-1307 USA
+# You should have received a copy of the GNU General Public License
+# along with Koha; if not, see <http://www.gnu.org/licenses>.
 
 use strict;
+use warnings;
 
 use C4::Debug;
 use C4::Context;
-use C4::Utils qw( :all );
+use Koha::AuthUtils qw(get_script_name);
 use Authen::CAS::Client;
-use CGI;
+use CGI qw ( -utf8 );
+use FindBin;
+use YAML;
 
 
-use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
+use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
 
 BEGIN {
-	require Exporter;
-	$VERSION = 3.03;	# set the version for version checking
-	$debug = $ENV{DEBUG};
-	@ISA    = qw(Exporter);
-	@EXPORT = qw(checkpw_cas login_cas logout_cas login_cas_url);
+    require Exporter;
+    $debug = $ENV{DEBUG};
+    @ISA   = qw(Exporter);
+    @EXPORT = qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
 }
+my $defaultcasserver;
+my $casservers;
+my $yamlauthfile = C4::Context->config('intranetdir') . "/C4/Auth_cas_servers.yaml";
 
 
-my $context = C4::Context->new() 	or die 'C4::Context->new failed';
-my $casserver = C4::Context->preference('casServerUrl');
+# If there's a configuration for multiple cas servers, then we get it
+if (multipleAuth()) {
+    ($defaultcasserver, $casservers) = YAML::LoadFile($yamlauthfile);
+    $defaultcasserver = $defaultcasserver->{'default'};
+} else {
+# Else, we fall back to casServerUrl syspref
+    $defaultcasserver = 'default';
+    $casservers = { 'default' => C4::Context->preference('casServerUrl') };
+}
+
+=head1 Subroutines
+
+=cut
+
+# Is there a configuration file for multiple cas servers?
+sub multipleAuth {
+    return (-e qq($yamlauthfile));
+}
+
+# Returns configured CAS servers' list if multiple authentication is enabled
+sub getMultipleAuth {
+   return $casservers; 
+}
 
 # Logout from CAS
 sub logout_cas {
-    my ($query) = @_;
-    my $cas = Authen::CAS::Client->new($casserver);
-    print $query->redirect($cas->logout_url(url => %ENV->{'SCRIPT_URI'}));
+    my ($query, $type) = @_;
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
+    $uri =~ s/\?logout\.x=1//; # We don't want to keep triggering a logout, if we got here, the borrower is already logged out of Koha
+    print $query->redirect( $cas->logout_url(url => $uri));
 }
 
 # Login to CAS
 sub login_cas {
-    my ($query) = @_;
-    my $cas = Authen::CAS::Client->new($casserver);
-    print $query->redirect($cas->login_url(%ENV->{'SCRIPT_URI'})); 
+    my ($query, $type) = @_;
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
+    print $query->redirect( $cas->login_url($uri));
 }
 
 # Returns CAS login URL with callback to the requesting URL
 sub login_cas_url {
-    my $cas = Authen::CAS::Client->new($casserver);
-    return $cas->login_url(%ENV->{'SCRIPT_URI'});
+    my ( $query, $key, $type ) = @_;
+    my ( $cas, $uri ) = _get_cas_and_service( $query, $key, $type );
+    return $cas->login_url($uri);
 }
 
 # Checks for password correctness
 # In our case : is there a ticket, is it valid and does it match one of our users ?
 sub checkpw_cas {
     $debug and warn "checkpw_cas";
-    my ($dbh, $ticket, $query) = @_;
+    my ($dbh, $ticket, $query, $type) = @_;
     my $retnumber;
-    my $cas = Authen::CAS::Client->new($casserver);
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
 
     # If we got a ticket
     if ($ticket) {
-	$debug and warn "Got ticket : $ticket";
-	
-	# We try to validate it
-	my $val = $cas->service_validate(%ENV->{'SCRIPT_URI'}, $ticket);
-	
-	# If it's valid
-	if( $val->is_success() ) {
-
-	    my $userid = $val->user();
-	    $debug and warn "User CAS authenticated as: $userid";
-
-	    # Does it match one of our users ?
-    	    my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
-    	    $sth->execute($userid);
-    	    if ( $sth->rows ) {
-		$retnumber = $sth->fetchrow;
-		return (1, $retnumber, $userid);
-	    }
-	    my $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
-	    $sth->execute($userid);
-	    if ( $sth->rows ) {
-	    	$retnumber = $sth->fetchrow;
-		return (1, $retnumber, $userid);
-	    }
-	    
-	    # If we reach this point, then the user is a valid CAS user, but not a Koha user
-	    $debug and warn "User $userid is not a valid Koha user";
-
-    	} else {
-    	    $debug and warn "Invalid session ticket : $ticket";
-    	    return 0;
-	}
+        $debug and warn "Got ticket : $ticket";
+
+        # We try to validate it
+        my $val = $cas->service_validate($uri, $ticket );
+
+        # If it's valid
+        if ( $val->is_success() ) {
+
+            my $userid = $val->user();
+            $debug and warn "User CAS authenticated as: $userid";
+
+            # we should store the CAS ticekt too, we need this for single logout https://apereo.github.io/cas/4.2.x/protocol/CAS-Protocol-Specification.html#233-single-logout
+
+            # Does it match one of our users ?
+            my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
+            $sth->execute($userid);
+            if ( $sth->rows ) {
+                $retnumber = $sth->fetchrow;
+                return ( 1, $retnumber, $userid, $ticket );
+            }
+            $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
+            $sth->execute($userid);
+            if ( $sth->rows ) {
+                $retnumber = $sth->fetchrow;
+                return ( 1, $retnumber, $userid, $ticket );
+            }
+
+            # If we reach this point, then the user is a valid CAS user, but not a Koha user
+            $debug and warn "User $userid is not a valid Koha user";
+
+        } else {
+            $debug and warn "Problem when validating ticket : $ticket";
+            $debug and warn "Authen::CAS::Client::Response::Error: " . $val->error() if $val->is_error();
+            $debug and warn "Authen::CAS::Client::Response::Failure: " . $val->message() if $val->is_failure();
+            $debug and warn Data::Dumper::Dumper($@) if $val->is_error() or $val->is_failure();
+            return 0;
+        }
+    }
+    return 0;
+}
+
+# Proxy CAS auth
+sub check_api_auth_cas {
+    $debug and warn "check_api_auth_cas";
+    my ($dbh, $PT, $query, $type) = @_;
+    my $retnumber;
+    my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
+
+    # If we have a Proxy Ticket
+    if ($PT) {
+        my $r = $cas->proxy_validate( $uri, $PT );
+
+        # If the PT is valid
+        if ( $r->is_success ) {
+
+            # We've got a username !
+            $debug and warn "User authenticated as: ", $r->user, "\n";
+            $debug and warn "Proxied through:\n";
+            $debug and warn "  $_\n" for $r->proxies;
+
+            my $userid = $r->user;
+
+            # we should store the CAS ticket too, we need this for single logout https://apereo.github.io/cas/4.2.x/protocol/CAS-Protocol-Specification.html#233-single-logout
+
+            # Does it match one of our users ?
+            my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
+            $sth->execute($userid);
+            if ( $sth->rows ) {
+                $retnumber = $sth->fetchrow;
+                return ( 1, $retnumber, $userid, $PT );
+            }
+            $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
+            return $r->user;
+            $sth->execute($userid);
+            if ( $sth->rows ) {
+                $retnumber = $sth->fetchrow;
+                return ( 1, $retnumber, $userid, $PT );
+            }
+
+            # If we reach this point, then the user is a valid CAS user, but not a Koha user
+            $debug and warn "User $userid is not a valid Koha user";
+
+        } else {
+            $debug and warn "Proxy Ticket authentication failed";
+            return 0;
+        }
     }
     return 0;
 }
 
+# Get CAS handler and service URI
+sub _get_cas_and_service {
+    my $query = shift;
+    my $key   = shift;    # optional
+    my $type  = shift;
+
+    my $uri = _url_with_get_params($query, $type);
+
+    my $casparam = $defaultcasserver;
+    $casparam = $query->param('cas') if defined $query->param('cas');
+    $casparam = $key if defined $key;
+    my $cas = Authen::CAS::Client->new( $casservers->{$casparam} );
+
+    return ( $cas, $uri );
+}
+
+# Get the current URL with parameters contained directly into URL (GET params)
+# This method replaces $query->url() which will give both GET and POST params
+sub _url_with_get_params {
+    my $query = shift;
+    my $type = shift;
+
+    my $uri_base_part =
+      ( $type eq 'opac' )
+      ? C4::Context->preference('OPACBaseURL')
+      : C4::Context->preference('staffClientBaseURL');
+    $uri_base_part .= get_script_name();
+
+    my $uri_params_part = '';
+    foreach my $param ( $query->url_param() ) {
+        # url_param() always returns parameters that were deleted by delete()
+        # This additional check ensure that parameter was not deleted.
+        my $uriPiece = $query->param($param);
+        if ($uriPiece) {
+            $uri_params_part .= '&' if $uri_params_part;
+            $uri_params_part .= $param . '=';
+            $uri_params_part .= URI::Escape::uri_escape( $uriPiece );
+        }
+    }
+    $uri_base_part .= '?' if $uri_params_part;
+
+    return $uri_base_part . $uri_params_part;
+}
+
+=head2 logout_if_required
+
+    If using CAS, this subroutine will trigger single-signout of the CAS server.
+
+=cut
+
+sub logout_if_required {
+    my ( $query ) = @_;
+    # Check we havent been hit by a logout call
+    my $xml = $query->param('logoutRequest');
+    return 0 unless $xml;
+
+    my $dom = XML::LibXML->load_xml(string => $xml);
+    my $ticket;
+    foreach my $node ($dom->findnodes('/samlp:LogoutRequest')){
+        # We got a cas single logout request from a cas server;
+        $ticket = $node->findvalue('./samlp:SessionIndex');
+    }
+
+    return 0 unless $ticket;
+
+    # We've been called as part of the single logout destroy the session associated with the cas ticket
+    my $params = C4::Auth::_get_session_params();
+    my $success = CGI::Session->find( $params->{dsn}, sub {delete_cas_session(@_, $ticket)}, $params->{dsn_args} );
+
+    sub delete_cas_session {
+        my $session = shift;
+        my $ticket = shift;
+        if ($session->param('cas_ticket') && $session->param('cas_ticket') eq $ticket ) {
+            $session->delete;
+            $session->flush;
+        }
+    }
+
+    print $query->header;
+    exit;
+}
+
 1;
 __END__