C4/Auth_with_cas.pm

   1 package C4::Auth_with_cas;
   2
   3 # Copyright 2009 BibLibre SARL
   4 #
   5 # This file is part of Koha.
   6 #
   7 # Koha is free software; you can redistribute it and/or modify it
   8 # under the terms of the GNU General Public License as published by
   9 # the Free Software Foundation; either version 3 of the License, or
  10 # (at your option) any later version.
  11 #
  12 # Koha is distributed in the hope that it will be useful, but
  13 # WITHOUT ANY WARRANTY; without even the implied warranty of
  14 # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
  15 # GNU General Public License for more details.
  16 #
  17 # You should have received a copy of the GNU General Public License
  18 # along with Koha; if not, see <http://www.gnu.org/licenses>.
  19
  20 use strict;
  21 use warnings;
  22
  23 use C4::Context;
  24 use Koha::AuthUtils qw( get_script_name );
  25 use Authen::CAS::Client;
  26 use CGI qw ( -utf8 );
  27 use YAML::XS;
  28
  29 use Koha::Logger;
  30
  31 our (@ISA, @EXPORT_OK);
  32
  33 BEGIN {
  34     require Exporter;
  35     @ISA   = qw(Exporter);
  36     @EXPORT_OK = qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
  37 }
  38 my $defaultcasserver;
  39 my $casservers;
  40 my $yamlauthfile = C4::Context->config('intranetdir') . "/C4/Auth_cas_servers.yaml";
  41
  42
  43 # If there's a configuration for multiple cas servers, then we get it
  44 if (multipleAuth()) {
  45     ($defaultcasserver, $casservers) = YAML::XS::LoadFile($yamlauthfile);
  46     $defaultcasserver = $defaultcasserver->{'default'};
  47 } else {
  48 # Else, we fall back to casServerUrl syspref
  49     $defaultcasserver = 'default';
  50     $casservers = { 'default' => C4::Context->preference('casServerUrl') };
  51 }
  52
  53 =head1 Subroutines
  54
  55 =cut
  56
  57 # Is there a configuration file for multiple cas servers?
  58 sub multipleAuth {
  59     return (-e qq($yamlauthfile));
  60 }
  61
  62 # Returns configured CAS servers' list if multiple authentication is enabled
  63 sub getMultipleAuth {
  64    return $casservers;
  65 }
  66
  67 # Logout from CAS
  68 sub logout_cas {
  69     my ( $query, $type ) = @_;
  70     my ( $cas,   $uri )  = _get_cas_and_service( $query, undef, $type );
  71
  72     # We don't want to keep triggering a logout, if we got here,
  73     # the borrower is already logged out of Koha
  74     $uri =~ s/\?logout\.x=1//;
  75
  76     my $logout_url = $cas->logout_url( url => $uri );
  77     $logout_url =~ s/url=/service=/
  78       if C4::Context->preference('casServerVersion') eq '3';
  79
  80     print $query->redirect($logout_url);
  81 }
  82
  83
  84 # Login to CAS
  85 sub login_cas {
  86     my ($query, $type) = @_;
  87     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
  88     print $query->redirect( $cas->login_url($uri));
  89 }
  90
  91 # Returns CAS login URL with callback to the requesting URL
  92 sub login_cas_url {
  93     my ( $query, $key, $type ) = @_;
  94     my ( $cas, $uri ) = _get_cas_and_service( $query, $key, $type );
  95     return $cas->login_url($uri);
  96 }
  97
  98 # Checks for password correctness
  99 # In our case : is there a ticket, is it valid and does it match one of our users ?
 100 sub checkpw_cas {
 101     my ($dbh, $ticket, $query, $type) = @_;
 102     my $retnumber;
 103     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
 104
 105     # If we got a ticket
 106     if ($ticket) {
 107
 108         # We try to validate it
 109         my $val = $cas->service_validate($uri, $ticket );
 110
 111         # If it's valid
 112         if ( $val->is_success() ) {
 113
 114             my $userid = $val->user();
 115
 116             # 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
 117
 118             # Does it match one of our users ?
 119             my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
 120             $sth->execute($userid);
 121             if ( $sth->rows ) {
 122                 $retnumber = $sth->fetchrow;
 123                 return ( 1, $retnumber, $userid, $ticket );
 124             }
 125             $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
 126             $sth->execute($userid);
 127             if ( $sth->rows ) {
 128                 $retnumber = $sth->fetchrow;
 129                 return ( 1, $retnumber, $userid, $ticket );
 130             }
 131
 132             # If we reach this point, then the user is a valid CAS user, but not a Koha user
 133             Koha::Logger->get->info("User $userid is not a valid Koha user");
 134
 135         } else {
 136             my $logger = Koha::Logger->get;
 137             $logger->debug("Problem when validating ticket : $ticket");
 138             $logger->debug("Authen::CAS::Client::Response::Error: " . $val->error()) if $val->is_error();
 139             $logger->debug("Authen::CAS::Client::Response::Failure: " . $val->message()) if $val->is_failure();
 140             $logger->debug(Data::Dumper::Dumper($@)) if $val->is_error() or $val->is_failure();
 141             return 0;
 142         }
 143     }
 144     return 0;
 145 }
 146
 147 # Proxy CAS auth
 148 sub check_api_auth_cas {
 149     my ($dbh, $PT, $query, $type) = @_;
 150     my $retnumber;
 151     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
 152
 153     # If we have a Proxy Ticket
 154     if ($PT) {
 155         my $r = $cas->proxy_validate( $uri, $PT );
 156
 157         # If the PT is valid
 158         if ( $r->is_success ) {
 159
 160             # We've got a username !
 161             my $userid = $r->user;
 162
 163             # 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
 164
 165             # Does it match one of our users ?
 166             my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
 167             $sth->execute($userid);
 168             if ( $sth->rows ) {
 169                 $retnumber = $sth->fetchrow;
 170                 return ( 1, $retnumber, $userid, $PT );
 171             }
 172             $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
 173             return $r->user;
 174             $sth->execute($userid);
 175             if ( $sth->rows ) {
 176                 $retnumber = $sth->fetchrow;
 177                 return ( 1, $retnumber, $userid, $PT );
 178             }
 179
 180             # If we reach this point, then the user is a valid CAS user, but not a Koha user
 181             Koha::Logger->get->info("User $userid is not a valid Koha user");
 182
 183         } else {
 184             Koha::Logger->get->debug("Proxy Ticket authentication failed");
 185             return 0;
 186         }
 187     }
 188     return 0;
 189 }
 190
 191 # Get CAS handler and service URI
 192 sub _get_cas_and_service {
 193     my $query = shift;
 194     my $key   = shift;    # optional
 195     my $type  = shift;
 196
 197     my $uri = _url_with_get_params($query, $type);
 198
 199     my $casparam = $defaultcasserver;
 200     $casparam = $query->param('cas') if defined $query->param('cas');
 201     $casparam = $key if defined $key;
 202     my $cas = Authen::CAS::Client->new( $casservers->{$casparam} );
 203
 204     return ( $cas, $uri );
 205 }
 206
 207 # Get the current URL with parameters contained directly into URL (GET params)
 208 # This method replaces $query->url() which will give both GET and POST params
 209 sub _url_with_get_params {
 210     my $query = shift;
 211     my $type = shift;
 212
 213     my $uri_base_part =
 214       ( $type eq 'opac' )
 215       ? C4::Context->preference('OPACBaseURL')
 216       : C4::Context->preference('staffClientBaseURL');
 217     $uri_base_part .= get_script_name();
 218
 219     my $uri_params_part = '';
 220     foreach my $param ( $query->url_param() ) {
 221         # url_param() always returns parameters that were deleted by delete()
 222         # This additional check ensure that parameter was not deleted.
 223         my $uriPiece = $query->param($param);
 224         if ($uriPiece) {
 225             $uri_params_part .= '&' if $uri_params_part;
 226             $uri_params_part .= $param . '=';
 227             $uri_params_part .= URI::Escape::uri_escape( $uriPiece );
 228         }
 229     }
 230     $uri_base_part .= '?' if $uri_params_part;
 231
 232     return $uri_base_part . $uri_params_part;
 233 }
 234
 235 =head2 logout_if_required
 236
 237     If using CAS, this subroutine will trigger single-signout of the CAS server.
 238
 239 =cut
 240
 241 sub logout_if_required {
 242     my ( $query ) = @_;
 243     # Check we havent been hit by a logout call
 244     my $xml = $query->param('logoutRequest');
 245     return 0 unless $xml;
 246
 247     my $dom = XML::LibXML->load_xml(string => $xml);
 248     my $ticket;
 249     foreach my $node ($dom->findnodes('/samlp:LogoutRequest')){
 250         # We got a cas single logout request from a cas server;
 251         $ticket = $node->findvalue('./samlp:SessionIndex');
 252     }
 253
 254     return 0 unless $ticket;
 255
 256     # We've been called as part of the single logout destroy the session associated with the cas ticket
 257     my $params = C4::Auth::_get_session_params();
 258     my $success = CGI::Session->find( $params->{dsn}, sub {delete_cas_session(@_, $ticket)}, $params->{dsn_args} );
 259
 260     print $query->header;
 261     exit;
 262 }
 263
 264 sub delete_cas_session {
 265     my $session = shift;
 266     my $ticket = shift;
 267     if ($session->param('cas_ticket') && $session->param('cas_ticket') eq $ticket ) {
 268         $session->delete;
 269         $session->flush;
 270     }
 271 }
 272
 273 1;
 274 __END__
 275
 276 =head1 NAME
 277
 278 C4::Auth - Authenticates Koha users
 279
 280 =head1 SYNOPSIS
 281
 282   use C4::Auth_with_cas;
 283
 284 =cut
 285
 286 =head1 SEE ALSO
 287
 288 CGI(3)
 289
 290 Authen::CAS::Client
 291
 292 =cut