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::Debug;
  24 use C4::Context;
  25 use Koha::AuthUtils qw(get_script_name);
  26 use Authen::CAS::Client;
  27 use CGI qw ( -utf8 );
  28 use FindBin;
  29 use YAML;
  30
  31
  32 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
  33
  34 BEGIN {
  35         require Exporter;
  36         $debug = $ENV{DEBUG};
  37         @ISA    = qw(Exporter);
  38         @EXPORT = qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
  39 }
  40 my $defaultcasserver;
  41 my $casservers;
  42 my $yamlauthfile = C4::Context->config('intranetdir') . "/C4/Auth_cas_servers.yaml";
  43
  44
  45 # If there's a configuration for multiple cas servers, then we get it
  46 if (multipleAuth()) {
  47     ($defaultcasserver, $casservers) = YAML::LoadFile($yamlauthfile);
  48     $defaultcasserver = $defaultcasserver->{'default'};
  49 } else {
  50 # Else, we fall back to casServerUrl syspref
  51     $defaultcasserver = 'default';
  52     $casservers = { 'default' => C4::Context->preference('casServerUrl') };
  53 }
  54
  55 # Is there a configuration file for multiple cas servers?
  56 sub multipleAuth {
  57     return (-e qq($yamlauthfile));
  58 }
  59
  60 # Returns configured CAS servers' list if multiple authentication is enabled
  61 sub getMultipleAuth {
  62    return $casservers;
  63 }
  64
  65 # Logout from CAS
  66 sub logout_cas {
  67     my ($query, $type) = @_;
  68     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
  69     print $query->redirect( $cas->logout_url(url => $uri));
  70 }
  71
  72 # Login to CAS
  73 sub login_cas {
  74     my ($query, $type) = @_;
  75     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
  76     print $query->redirect( $cas->login_url($uri));
  77 }
  78
  79 # Returns CAS login URL with callback to the requesting URL
  80 sub login_cas_url {
  81     my ( $query, $key, $type ) = @_;
  82     my ( $cas, $uri ) = _get_cas_and_service( $query, $key, $type );
  83     return $cas->login_url($uri);
  84 }
  85
  86 # Checks for password correctness
  87 # In our case : is there a ticket, is it valid and does it match one of our users ?
  88 sub checkpw_cas {
  89     $debug and warn "checkpw_cas";
  90     my ($dbh, $ticket, $query, $type) = @_;
  91     my $retnumber;
  92     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
  93
  94     # If we got a ticket
  95     if ($ticket) {
  96         $debug and warn "Got ticket : $ticket";
  97
  98         # We try to validate it
  99         my $val = $cas->service_validate($uri, $ticket );
 100
 101         # If it's valid
 102         if ( $val->is_success() ) {
 103
 104             my $userid = $val->user();
 105             $debug and warn "User CAS authenticated as: $userid";
 106
 107             # Does it match one of our users ?
 108             my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
 109             $sth->execute($userid);
 110             if ( $sth->rows ) {
 111                 $retnumber = $sth->fetchrow;
 112                 return ( 1, $retnumber, $userid );
 113             }
 114             $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
 115             $sth->execute($userid);
 116             if ( $sth->rows ) {
 117                 $retnumber = $sth->fetchrow;
 118                 return ( 1, $retnumber, $userid );
 119             }
 120
 121             # If we reach this point, then the user is a valid CAS user, but not a Koha user
 122             $debug and warn "User $userid is not a valid Koha user";
 123
 124         } else {
 125             $debug and warn "Problem when validating ticket : $ticket";
 126             $debug and warn "Authen::CAS::Client::Response::Error: " . $val->error() if $val->is_error();
 127             $debug and warn "Authen::CAS::Client::Response::Failure: " . $val->message() if $val->is_failure();
 128             $debug and warn Data::Dumper::Dumper($@) if $val->is_error() or $val->is_failure();
 129             return 0;
 130         }
 131     }
 132     return 0;
 133 }
 134
 135 # Proxy CAS auth
 136 sub check_api_auth_cas {
 137     $debug and warn "check_api_auth_cas";
 138     my ($dbh, $PT, $query, $type) = @_;
 139     my $retnumber;
 140     my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
 141
 142     # If we have a Proxy Ticket
 143     if ($PT) {
 144         my $r = $cas->proxy_validate( $uri, $PT );
 145
 146         # If the PT is valid
 147         if ( $r->is_success ) {
 148
 149             # We've got a username !
 150             $debug and warn "User authenticated as: ", $r->user, "\n";
 151             $debug and warn "Proxied through:\n";
 152             $debug and warn "  $_\n" for $r->proxies;
 153
 154             my $userid = $r->user;
 155
 156             # Does it match one of our users ?
 157             my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
 158             $sth->execute($userid);
 159             if ( $sth->rows ) {
 160                 $retnumber = $sth->fetchrow;
 161                 return ( 1, $retnumber, $userid );
 162             }
 163             $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
 164             return $r->user;
 165             $sth->execute($userid);
 166             if ( $sth->rows ) {
 167                 $retnumber = $sth->fetchrow;
 168                 return ( 1, $retnumber, $userid );
 169             }
 170
 171             # If we reach this point, then the user is a valid CAS user, but not a Koha user
 172             $debug and warn "User $userid is not a valid Koha user";
 173
 174         } else {
 175             $debug and warn "Proxy Ticket authentication failed";
 176             return 0;
 177         }
 178     }
 179     return 0;
 180 }
 181
 182 # Get CAS handler and service URI
 183 sub _get_cas_and_service {
 184     my $query = shift;
 185     my $key   = shift;    # optional
 186     my $type  = shift;
 187
 188     my $uri = _url_with_get_params($query, $type);
 189
 190     my $casparam = $defaultcasserver;
 191     $casparam = $query->param('cas') if defined $query->param('cas');
 192     $casparam = $key if defined $key;
 193     my $cas = Authen::CAS::Client->new( $casservers->{$casparam} );
 194
 195     return ( $cas, $uri );
 196 }
 197
 198 # Get the current URL with parameters contained directly into URL (GET params)
 199 # This method replaces $query->url() which will give both GET and POST params
 200 sub _url_with_get_params {
 201     my $query = shift;
 202     my $type = shift;
 203
 204     my $uri_base_part = ($type eq 'opac') ?
 205                         C4::Context->preference('OPACBaseURL') . get_script_name() :
 206                         C4::Context->preference('staffClientBaseURL');
 207
 208     my $uri_params_part = '';
 209     foreach my $param ( $query->url_param() ) {
 210         # url_param() always returns parameters that were deleted by delete()
 211         # This additional check ensure that parameter was not deleted.
 212         my $uriPiece = $query->param($param);
 213         if ($uriPiece) {
 214             $uri_params_part .= '&' if $uri_params_part;
 215             $uri_params_part .= $param . '=';
 216             $uri_params_part .= URI::Escape::uri_escape( $uriPiece );
 217         }
 218     }
 219     $uri_base_part .= '?' if $uri_params_part;
 220
 221     return $uri_base_part . $uri_params_part;
 222 }
 223
 224 1;
 225 __END__
 226
 227 =head1 NAME
 228
 229 C4::Auth - Authenticates Koha users
 230
 231 =head1 SYNOPSIS
 232
 233   use C4::Auth_with_cas;
 234
 235 =cut
 236
 237 =head1 SEE ALSO
 238
 239 CGI(3)
 240
 241 Authen::CAS::Client
 242
 243 =cut