1 package C4::Auth_with_shibboleth;
3 # Copyright 2014 PTFS Europe
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>.
24 use Koha::AuthUtils qw(get_script_name);
27 use C4::Members::Messaging;
30 use List::MoreUtils qw(any);
32 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug);
39 qw(shib_ok logout_shib login_shib_url checkpw_shib get_login_shib);
42 # Check that shib config is not malformed
44 my $config = _get_shib_config();
53 # Logout from Shibboleth
57 my $return = _get_return($query);
58 print $query->redirect( $uri . "/Shibboleth.sso/Logout?return=$return" );
61 # Returns Shibboleth login URL with callback to the requesting URL
65 my $target = _get_return($query);
66 my $uri = _get_uri() . "/Shibboleth.sso/Login?target=" . $target;
71 # Returns shibboleth user login
74 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
75 # to contain the login match point of the shibboleth-authenticated user. This match
76 # point is configured in koha-conf.xml
78 # Shibboleth attributes are mapped into http environmement variables, so we're getting
79 # the match point of the user this way
81 # Get shibboleth config
82 my $config = _get_shib_config();
84 my $matchAttribute = $config->{mapping}->{ $config->{matchpoint} }->{is};
86 if ( any { /(^psgi\.|^plack\.)/i } keys %ENV ) {
87 $debug and warn $matchAttribute . " value: " . $ENV{"HTTP_".uc($matchAttribute)};
88 return $ENV{"HTTP_".uc($matchAttribute)} || '';
90 $debug and warn $matchAttribute . " value: " . $ENV{$matchAttribute};
91 return $ENV{$matchAttribute} || '';
95 # Checks for password correctness
96 # In our case : does the given attribute match one of our users ?
98 $debug and warn "checkpw_shib";
101 my $config = _get_shib_config();
102 $debug and warn "User Shibboleth-authenticated as: $match";
104 # Does the given shibboleth attribute value ($match) match a valid koha user ?
106 Koha::Database->new()->schema()->resultset('Borrower')
107 ->find( { $config->{matchpoint} => $match } );
108 if ( defined($borrower) ) {
109 if ($config->{'sync'}) {
110 _sync($borrower->borrowernumber, $config, $match);
112 return ( 1, $borrower->get_column('cardnumber'), $borrower->get_column('userid') );
115 if ( $config->{'autocreate'} ) {
116 return _autocreate( $config, $match );
118 # If we reach this point, the user is not a valid koha user
119 $debug and warn "User with $config->{matchpoint} of $match is not a valid Koha user";
125 my ( $config, $match ) = @_;
127 my %borrower = ( $config->{matchpoint} => $match );
129 while ( my ( $key, $entry ) = each %{$config->{'mapping'}} ) {
130 if ( any { /(^psgi|^plack)/i } keys %ENV ) {
131 $borrower{$key} = ( $entry->{'is'} && $ENV{"HTTP_" . uc($entry->{'is'}) } ) || $entry->{'content'} || '';
133 $borrower{$key} = ( $entry->{'is'} && $ENV{ $entry->{'is'} } ) || $entry->{'content'} || '';
137 my $patron = Koha::Patron->new( \%borrower )->store;
138 C4::Members::Messaging::SetMessagingPreferencesFromDefaults( { borrowernumber => $patron->borrowernumber, categorycode => $patron->categorycode } );
140 return ( 1, $patron->cardnumber, $patron->userid );
144 my ($borrowernumber, $config, $match ) = @_;
146 $borrower{'borrowernumber'} = $borrowernumber;
147 while ( my ( $key, $entry ) = each %{$config->{'mapping'}} ) {
148 if ( any { /(^psgi|^plack)/i } keys %ENV ) {
149 $borrower{$key} = ( $entry->{'is'} && $ENV{"HTTP_" . uc($entry->{'is'}) } ) || $entry->{'content'} || '';
151 $borrower{$key} = ( $entry->{'is'} && $ENV{ $entry->{'is'} } ) || $entry->{'content'} || '';
154 my $patron = Koha::Patrons->find( $borrowernumber );
155 $patron->set(\%borrower)->store;
160 my $protocol = "https://";
161 my $interface = C4::Context->interface;
162 $debug and warn "shibboleth interface: " . $interface;
165 if ( $interface eq 'intranet' ) {
167 $uri = C4::Context->preference('staffClientBaseURL') // '';
169 $debug and warn 'staffClientBaseURL not set!';
172 $uri = C4::Context->preference('OPACBaseURL') // '';
174 $debug and warn 'OPACBaseURL not set!';
178 if ($uri =~ /(.*):\/\/(.*)/) {
179 my $oldprotocol = $1;
180 if ($oldprotocol ne 'https') {
183 'Shibboleth requires OPACBaseURL/staffClientBaseURL to use the https protocol!';
187 my $return = $protocol . $uri;
194 my $uri_base_part = _get_uri() . get_script_name();
196 my $uri_params_part = '';
197 foreach my $param ( sort $query->url_param() ) {
198 # url_param() always returns parameters that were deleted by delete()
199 # This additional check ensure that parameter was not deleted.
200 my $uriPiece = $query->param($param);
202 $uri_params_part .= '&' if $uri_params_part;
203 $uri_params_part .= $param . '=';
204 $uri_params_part .= $uriPiece;
207 $uri_base_part .= '%3F' if $uri_params_part;
209 return $uri_base_part . URI::Escape::uri_escape_utf8($uri_params_part);
212 sub _get_shib_config {
213 my $config = C4::Context->config('shibboleth');
216 carp 'shibboleth config not defined' if $debug;
220 if ( $config->{matchpoint}
221 && defined( $config->{mapping}->{ $config->{matchpoint} }->{is} ) )
224 warn "koha borrower field to match: " . $config->{matchpoint};
225 warn "shibboleth attribute to match: "
226 . $config->{mapping}->{ $config->{matchpoint} }->{is};
231 if ( !$config->{matchpoint} ) {
232 carp 'shibboleth matchpoint not defined';
235 carp 'shibboleth matchpoint not mapped';
246 C4::Auth_with_shibboleth
250 use C4::Auth_with_shibboleth;
254 This module is specific to Shibboleth authentication in koha and relies heavily upon the native shibboleth service provider package in your operating system.
258 To use this type of authentication these additional packages are required:
272 shibboleth-sp2-schemas
276 We let the native shibboleth service provider packages handle all the complexities of shibboleth negotiation for us, and configuring this is beyond the scope of this documentation.
278 But to sum up, to get shibboleth working in koha, as a minimum you will need to:
284 Create some metadata for your koha instance (if you're in a single instance setup then the default metadata available at https://youraddress.com/Shibboleth.sso/Metadata should be adequate)
288 Swap metadata with your Identidy Provider (IdP)
292 Map their attributes to what you want to see in koha
296 Tell apache that we wish to allow koha to authenticate via shibboleth.
298 This is as simple as adding the below to your virtualhost config (for CGI running):
305 Or (for Plack running):
310 ShibUseEnvironment Off
314 IMPORTANT: Please note, if you are running in the plack configuration you should consult https://wiki.shibboleth.net/confluence/display/SHIB2/NativeSPSpoofChecking for security advice regarding header spoof checking settings. (See also bug 17776 on Bugzilla about enabling ShibUseHeaders.)
318 Configure koha to listen for shibboleth environment variables.
320 This is as simple as enabling B<useshibboleth> in koha-conf.xml:
322 <useshibboleth>1</useshibboleth>
326 Map shibboleth attributes to koha fields, and configure authentication match point in koha-conf.xml.
329 <matchpoint>userid</matchpoint> <!-- koha borrower field to match upon -->
331 <userid is="eduPersonID"></userid> <!-- koha borrower field to shibboleth attribute mapping -->
335 Note: The minimum you need here is a <matchpoint> block, containing a valid column name from the koha borrowers table, and a <mapping> block containing a relation between the chosen matchpoint and the shibboleth attribute name.
339 It should be as simple as that; you should now be able to login via shibboleth in the opac.
341 If you need more help configuring your B<S>ervice B<P>rovider to authenticate against a chosen B<Id>entity B<P>rovider then it might be worth taking a look at the community wiki L<page|http://wiki.koha-community.org/wiki/Shibboleth_Configuration>
347 Sends a logout signal to the native shibboleth service provider and then logs out of koha. Depending upon the native service provider configuration and identity provider capabilities this may or may not perform a single sign out action.
351 =head2 login_shib_url
353 Given a query, this will return a shibboleth login url with return code to page with given given query.
355 my $shibLoginURL = login_shib_url($query);
357 =head2 get_login_shib
359 Returns the shibboleth login attribute should it be found present in the http session
361 my $shib_login = get_login_shib();
365 Given a shib_login attribute, this routine checks for a matching local user and if found returns true, their cardnumber and their userid. If a match is not found, then this returns false.
367 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib( $shib_login );
373 A sugar function to that simply returns the current page URI with appropriate protocol attached
375 This routine is NOT exported
377 =head2 _get_shib_config
379 my $config = _get_shib_config();
381 A sugar function that checks for a valid shibboleth configuration, and if found returns a hashref of it's contents
383 This routine is NOT exported
387 my ( $retval, $retcard, $retuserid ) = _autocreate( $config, $match );
389 Given a shibboleth attribute reference and a userid this internal routine will add the given user to Koha and return their user credentials.
391 This routine is NOT exported