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::LoadFile($yamlauthfile);
48 $defaultcasserver = $defaultcasserver->{'default'};
50 # Else, we fall back to casServerUrl syspref
51 $defaultcasserver = 'default';
52 $casservers = { 'default' => C4::Context->preference('casServerUrl') };
55 # Is there a configuration file for multiple cas servers?
57 return (-e qq($yamlauthfile));
60 # Returns configured CAS servers' list if multiple authentication is enabled
67 my ($query, $type) = @_;
68 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
69 $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
70 print $query->redirect( $cas->logout_url(url => $uri));
75 my ($query, $type) = @_;
76 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
77 print $query->redirect( $cas->login_url($uri));
80 # Returns CAS login URL with callback to the requesting URL
82 my ( $query, $key, $type ) = @_;
83 my ( $cas, $uri ) = _get_cas_and_service( $query, $key, $type );
84 return $cas->login_url($uri);
87 # Checks for password correctness
88 # In our case : is there a ticket, is it valid and does it match one of our users ?
90 $debug and warn "checkpw_cas";
91 my ($dbh, $ticket, $query, $type) = @_;
93 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
97 $debug and warn "Got ticket : $ticket";
99 # We try to validate it
100 my $val = $cas->service_validate($uri, $ticket );
103 if ( $val->is_success() ) {
105 my $userid = $val->user();
106 $debug and warn "User CAS authenticated as: $userid";
108 # 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
110 # Does it match one of our users ?
111 my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
112 $sth->execute($userid);
114 $retnumber = $sth->fetchrow;
115 return ( 1, $retnumber, $userid, $ticket );
117 $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
118 $sth->execute($userid);
120 $retnumber = $sth->fetchrow;
121 return ( 1, $retnumber, $userid, $ticket );
124 # If we reach this point, then the user is a valid CAS user, but not a Koha user
125 $debug and warn "User $userid is not a valid Koha user";
128 $debug and warn "Problem when validating ticket : $ticket";
129 $debug and warn "Authen::CAS::Client::Response::Error: " . $val->error() if $val->is_error();
130 $debug and warn "Authen::CAS::Client::Response::Failure: " . $val->message() if $val->is_failure();
131 $debug and warn Data::Dumper::Dumper($@) if $val->is_error() or $val->is_failure();
139 sub check_api_auth_cas {
140 $debug and warn "check_api_auth_cas";
141 my ($dbh, $PT, $query, $type) = @_;
143 my ( $cas, $uri ) = _get_cas_and_service($query, undef, $type);
145 # If we have a Proxy Ticket
147 my $r = $cas->proxy_validate( $uri, $PT );
150 if ( $r->is_success ) {
152 # We've got a username !
153 $debug and warn "User authenticated as: ", $r->user, "\n";
154 $debug and warn "Proxied through:\n";
155 $debug and warn " $_\n" for $r->proxies;
157 my $userid = $r->user;
159 # 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
161 # Does it match one of our users ?
162 my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
163 $sth->execute($userid);
165 $retnumber = $sth->fetchrow;
166 return ( 1, $retnumber, $userid, $PT );
168 $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
170 $sth->execute($userid);
172 $retnumber = $sth->fetchrow;
173 return ( 1, $retnumber, $userid, $PT );
176 # If we reach this point, then the user is a valid CAS user, but not a Koha user
177 $debug and warn "User $userid is not a valid Koha user";
180 $debug and warn "Proxy Ticket authentication failed";
187 # Get CAS handler and service URI
188 sub _get_cas_and_service {
190 my $key = shift; # optional
193 my $uri = _url_with_get_params($query, $type);
195 my $casparam = $defaultcasserver;
196 $casparam = $query->param('cas') if defined $query->param('cas');
197 $casparam = $key if defined $key;
198 my $cas = Authen::CAS::Client->new( $casservers->{$casparam} );
200 return ( $cas, $uri );
203 # Get the current URL with parameters contained directly into URL (GET params)
204 # This method replaces $query->url() which will give both GET and POST params
205 sub _url_with_get_params {
211 ? C4::Context->preference('OPACBaseURL')
212 : C4::Context->preference('staffClientBaseURL');
213 $uri_base_part .= get_script_name();
215 my $uri_params_part = '';
216 foreach my $param ( $query->url_param() ) {
217 # url_param() always returns parameters that were deleted by delete()
218 # This additional check ensure that parameter was not deleted.
219 my $uriPiece = $query->param($param);
221 $uri_params_part .= '&' if $uri_params_part;
222 $uri_params_part .= $param . '=';
223 $uri_params_part .= URI::Escape::uri_escape( $uriPiece );
226 $uri_base_part .= '?' if $uri_params_part;
228 return $uri_base_part . $uri_params_part;
232 sub logout_if_required {
234 # Check we havent been hit by a logout call
235 my $xml = $query->param('logoutRequest');
236 return 0 unless $xml;
238 my $dom = XML::LibXML->load_xml(string => $xml);
240 foreach my $node ($dom->findnodes('/samlp:LogoutRequest')){
241 # We got a cas single logout request from a cas server;
242 $ticket = $node->findvalue('./samlp:SessionIndex');
245 return 0 unless $ticket;
247 # We've been called as part of the single logout destroy the session associated with the cas ticket
248 my $params = C4::Auth::_get_session_params();
249 my $success = CGI::Session->find( $params->{dsn}, sub {delete_cas_session(@_, $ticket)}, $params->{dsn_args} );
251 sub delete_cas_session {
254 if ($session->param('cas_ticket') && $session->param('cas_ticket') eq $ticket ) {
260 print $query->header;
269 C4::Auth - Authenticates Koha users
273 use C4::Auth_with_cas;