1 package C4::Auth_with_cas;
3 # Copyright 2009 BibLibre SARL
5 # This file is part of Koha.
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.
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.
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>.
25 use Koha::AuthUtils qw(get_script_name);
26 use Authen::CAS::Client;
32 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
38 @EXPORT = qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
42 my $yamlauthfile = C4::Context->config('intranetdir') . "/C4/Auth_cas_servers.yaml";
45 # If there's a configuration for multiple cas servers, then we get it
47 ($defaultcasserver, $casservers) = YAML::XS::LoadFile($yamlauthfile);
48 $defaultcasserver = $defaultcasserver->{'default'};
50 # Else, we fall back to casServerUrl syspref
51 $defaultcasserver = 'default';
52 $casservers = { 'default' => C4::Context->preference('casServerUrl') };
59 # Is there a configuration file for multiple cas servers?
61 return (-e qq($yamlauthfile));
64 # Returns configured CAS servers' list if multiple authentication is enabled
71 my ($query, $type) = @_;
72 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
73 $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
74 my $logout_url = $cas->logout_url(url => $uri);
75 $logout_url = _fix_logout_url($logout_url);
76 print $query->redirect( $logout_url );
81 my ($query, $type) = @_;
82 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
83 print $query->redirect( $cas->login_url($uri));
86 # Returns CAS login URL with callback to the requesting URL
88 my ( $query, $key, $type ) = @_;
89 my ( $cas, $uri ) = _get_cas_and_service( $query, $key, $type );
90 return $cas->login_url($uri);
93 # Checks for password correctness
94 # In our case : is there a ticket, is it valid and does it match one of our users ?
96 $debug and warn "checkpw_cas";
97 my ($dbh, $ticket, $query, $type) = @_;
99 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
103 $debug and warn "Got ticket : $ticket";
105 # We try to validate it
106 my $val = $cas->service_validate($uri, $ticket );
109 if ( $val->is_success() ) {
111 my $userid = $val->user();
112 $debug and warn "User CAS authenticated as: $userid";
114 # 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
116 # Does it match one of our users ?
117 my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
118 $sth->execute($userid);
120 $retnumber = $sth->fetchrow;
121 return ( 1, $retnumber, $userid, $ticket );
123 $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
124 $sth->execute($userid);
126 $retnumber = $sth->fetchrow;
127 return ( 1, $retnumber, $userid, $ticket );
130 # If we reach this point, then the user is a valid CAS user, but not a Koha user
131 $debug and warn "User $userid is not a valid Koha user";
134 $debug and warn "Problem when validating ticket : $ticket";
135 $debug and warn "Authen::CAS::Client::Response::Error: " . $val->error() if $val->is_error();
136 $debug and warn "Authen::CAS::Client::Response::Failure: " . $val->message() if $val->is_failure();
137 $debug and warn Data::Dumper::Dumper($@) if $val->is_error() or $val->is_failure();
145 sub check_api_auth_cas {
146 $debug and warn "check_api_auth_cas";
147 my ($dbh, $PT, $query, $type) = @_;
149 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
151 # If we have a Proxy Ticket
153 my $r = $cas->proxy_validate( $uri, $PT );
156 if ( $r->is_success ) {
158 # We've got a username !
159 $debug and warn "User authenticated as: ", $r->user, "\n";
160 $debug and warn "Proxied through:\n";
161 $debug and warn " $_\n" for $r->proxies;
163 my $userid = $r->user;
165 # 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
167 # Does it match one of our users ?
168 my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
169 $sth->execute($userid);
171 $retnumber = $sth->fetchrow;
172 return ( 1, $retnumber, $userid, $PT );
174 $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
176 $sth->execute($userid);
178 $retnumber = $sth->fetchrow;
179 return ( 1, $retnumber, $userid, $PT );
182 # If we reach this point, then the user is a valid CAS user, but not a Koha user
183 $debug and warn "User $userid is not a valid Koha user";
186 $debug and warn "Proxy Ticket authentication failed";
193 # Get CAS handler and service URI
194 sub _get_cas_and_service {
196 my $key = shift; # optional
199 my $uri = _url_with_get_params($query, $type);
201 my $casparam = $defaultcasserver;
202 $casparam = $query->param('cas') if defined $query->param('cas');
203 $casparam = $key if defined $key;
204 my $cas = Authen::CAS::Client->new( $casservers->{$casparam} );
206 return ( $cas, $uri );
209 # Fix the logout URL when the cas server is 3.0 or superior
210 sub _fix_logout_url {
212 if (C4::Context->preference('casServerVersion') eq '3') {
213 $url =~ s/url=/service=/;
218 # Get the current URL with parameters contained directly into URL (GET params)
219 # This method replaces $query->url() which will give both GET and POST params
220 sub _url_with_get_params {
226 ? C4::Context->preference('OPACBaseURL')
227 : C4::Context->preference('staffClientBaseURL');
228 $uri_base_part .= get_script_name();
230 my $uri_params_part = '';
231 foreach my $param ( $query->url_param() ) {
232 # url_param() always returns parameters that were deleted by delete()
233 # This additional check ensure that parameter was not deleted.
234 my $uriPiece = $query->param($param);
236 $uri_params_part .= '&' if $uri_params_part;
237 $uri_params_part .= $param . '=';
238 $uri_params_part .= URI::Escape::uri_escape( $uriPiece );
241 $uri_base_part .= '?' if $uri_params_part;
243 return $uri_base_part . $uri_params_part;
246 =head2 logout_if_required
248 If using CAS, this subroutine will trigger single-signout of the CAS server.
252 sub logout_if_required {
254 # Check we havent been hit by a logout call
255 my $xml = $query->param('logoutRequest');
256 return 0 unless $xml;
258 my $dom = XML::LibXML->load_xml(string => $xml);
260 foreach my $node ($dom->findnodes('/samlp:LogoutRequest')){
261 # We got a cas single logout request from a cas server;
262 $ticket = $node->findvalue('./samlp:SessionIndex');
265 return 0 unless $ticket;
267 # We've been called as part of the single logout destroy the session associated with the cas ticket
268 my $params = C4::Auth::_get_session_params();
269 my $success = CGI::Session->find( $params->{dsn}, sub {delete_cas_session(@_, $ticket)}, $params->{dsn_args} );
271 print $query->header;
275 sub delete_cas_session {
278 if ($session->param('cas_ticket') && $session->param('cas_ticket') eq $ticket ) {
289 C4::Auth - Authenticates Koha users
293 use C4::Auth_with_cas;