Bug 5336: (follow-up) remove unused new parameter to NewOrder() that slipped in
[koha.git] / C4 / Auth_with_cas.pm
index 694cbbb..46cb1ec 100644 (file)
@@ -13,88 +13,197 @@ package C4::Auth_with_cas;
 # 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, write to the Free Software Foundation, Inc.,
+# 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
 
 use strict;
+use warnings;
 
 use C4::Debug;
 use C4::Context;
-use C4::Utils qw( :all );
 use Authen::CAS::Client;
 use CGI;
+use FindBin;
 
 
 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
 
 BEGIN {
        require Exporter;
-       $VERSION = 3.03;        # set the version for version checking
+    $VERSION = 3.07.00.049;    # set the version for version checking
+       $debug = $ENV{DEBUG};
        @ISA    = qw(Exporter);
-       @EXPORT = qw( checkpw_cas login_cas logout_cas );
+       @EXPORT = qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
+}
+my $context = C4::Context->new() or die 'C4::Context->new failed';
+my $defaultcasserver;
+my $casservers;
+my $yamlauthfile = "../C4/Auth_cas_servers.yaml";
+
+
+# If there's a configuration for multiple cas servers, then we get it
+if (multipleAuth()) {
+    ($defaultcasserver, $casservers) = YAML::LoadFile(qq($FindBin::Bin/$yamlauthfile));
+    $defaultcasserver = $defaultcasserver->{'default'};
+} else {
+# Else, we fall back to casServerUrl syspref
+    $defaultcasserver = 'default';
+    $casservers = { 'default' => C4::Context->preference('casServerUrl') };
 }
 
+# Is there a configuration file for multiple cas servers?
+sub multipleAuth {
+    return (-e qq($FindBin::Bin/$yamlauthfile));
+}
 
-my $context = C4::Context->new()       or die 'C4::Context->new failed';
-my $casserver = C4::Context->config("usecasserver") or die 'No "usecasserver" in KOHA_CONF: ' . $ENV{KOHA_CONF};
+# 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);
-    warn $cas->logout_url();
-    print $query->redirect($cas->logout_url());
-
+    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
+    my $casparam = $query->param('cas');
+    # FIXME: This should be more generic and handle whatever parameters there might be
+    $uri .= "?cas=" . $casparam if (defined $casparam);
+    $casparam = $defaultcasserver if (not defined $casparam);
+    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    print $query->redirect( $cas->logout_url($uri));
 }
 
+# Login to CAS
 sub login_cas {
     my ($query) = @_;
-    my $cas = Authen::CAS::Client->new($casserver);
-    warn $cas->login_url(%ENV->{'SCRIPT_URI'});
-    print $query->redirect($cas->login_url(%ENV->{'SCRIPT_URI'})); 
+    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
+    my $casparam = $query->param('cas');
+    # FIXME: This should be more generic and handle whatever parameters there might be
+    $uri .= "?cas=" . $casparam if (defined $casparam);
+    $casparam = $defaultcasserver if (not defined $casparam);
+    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    print $query->redirect( $cas->login_url($uri));
+}
+
+# Returns CAS login URL with callback to the requesting URL
+sub login_cas_url {
+
+    my ($query, $key) = @_;
+    my $uri = C4::Context->preference('OPACBaseURL') . $query->url( -absolute => 1, -query => 1 );
+    my $casparam = $query->param('cas');
+    $casparam = $defaultcasserver if (not defined $casparam);
+    $casparam = $key if (defined $key);
+    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+    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 {
-    warn "checkpw_cas";
+    $debug and warn "checkpw_cas";
     my ($dbh, $ticket, $query) = @_;
     my $retnumber;
-    my $cas = Authen::CAS::Client->new($casserver);
-
+    my $uri = C4::Context->preference('OPACBaseURL') . $query->script_name();
+    my $casparam = $query->param('cas');
+    # FIXME: This should be more generic and handle whatever parameters there might be
+    $uri .= "?cas=" . $casparam if (defined $casparam);
+    $casparam = $defaultcasserver if (not defined $casparam);
+    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+
+    # If we got a ticket
     if ($ticket) {
-       warn "Got ticket : $ticket";
-       my $val = $cas->service_validate(%ENV->{'SCRIPT_URI'}, $ticket);
-       if( $val->is_success() ) {
-
-           my $userid = $val->user();
-           warn "User authenticated as: $userid";
-
-           my $sth = $dbh->prepare("select cardnumber from borrowers where userid=?");
-           $sth->execute($userid);
-           if ( $sth->rows ) {
-               $retnumber = $sth->fetchrow;
-           }
-           my $sth = $dbh->prepare("select userid from borrowers where cardnumber=?");
-           $sth->execute($userid);
-           if ( $sth->rows ) {
-               $retnumber = $sth->fetchrow;
-           }
-           return (1, $retnumber, $userid);
-       } else {
-           warn "Invalid session ticket";
-           return 0;
-       }
-
-    } else {
-       warn ("Don't have any ticket, let's go get one from the CAS server!");
-       my $url = $cas->login_url(%ENV->{'SCRIPT_URI'});
-       print $query->redirect($url);           
+        $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";
+
+            # 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 );
+            }
+            $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 "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;
+}
 
-    warn "We should not reach this point";
+# Proxy CAS auth
+sub check_api_auth_cas {
+    $debug and warn "check_api_auth_cas";
+    my ($dbh, $PT, $query) = @_;
+    my $retnumber;
+    my $url = C4::Context->preference('OPACBaseURL') . $query->script_name();
+
+    my $casparam = $query->param('cas');
+    $casparam = $defaultcasserver if (not defined $casparam);
+    my $cas = Authen::CAS::Client->new($casservers->{$casparam});
+
+    # If we have a Proxy Ticket
+    if ($PT) {
+        my $r = $cas->proxy_validate( $url, $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;
+
+            # 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 );
+            }
+            $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 );
+            }
+
+            # 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;
-    #return(1, $retnumber);
 }
 
+
 1;
 __END__
 
@@ -108,8 +217,6 @@ C4::Auth - Authenticates Koha users
 
 =cut
 
-=head1 KOHA_CONF <usecasserver>http://mycasserver/loginurl</usecasserver>
-
 =head1 SEE ALSO
 
 CGI(3)