3 # Copyright 2000-2002 Katipo Communications
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>.
22 use Digest::MD5 qw(md5_base64);
24 use JSON qw/encode_json/;
30 use C4::Templates; # to get the template
32 use C4::Search::History;
35 use Koha::AuthUtils qw(get_script_name hash_password);
36 use Koha::DateUtils qw(dt_from_string);
37 use Koha::Library::Groups;
40 use POSIX qw/strftime/;
41 use List::MoreUtils qw/ any /;
42 use Encode qw( encode is_utf8);
45 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $shib $shib_login);
48 sub psgi_env { any { /^psgi\./ } keys %ENV }
51 if (psgi_env) { die 'psgi:exit' }
57 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
58 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
59 &get_all_subpermissions &get_user_subpermissions track_login_daily
61 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
62 $ldap = C4::Context->config('useldapserver') || 0;
63 $cas = C4::Context->preference('casAuthentication');
64 $shib = C4::Context->config('useshibboleth') || 0;
65 $caslogout = C4::Context->preference('casLogout');
66 require C4::Auth_with_cas; # no import
69 require C4::Auth_with_ldap;
70 import C4::Auth_with_ldap qw(checkpw_ldap);
73 require C4::Auth_with_shibboleth;
74 import C4::Auth_with_shibboleth
75 qw(shib_ok checkpw_shib logout_shib login_shib_url get_login_shib);
77 # Check for good config
80 # Get shibboleth login attribute
81 $shib_login = get_login_shib();
84 # Bad config, disable shibboleth
90 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required);
97 C4::Auth - Authenticates Koha users
101 use CGI qw ( -utf8 );
107 my ($template, $borrowernumber, $cookie)
108 = get_template_and_user(
110 template_name => "opac-main.tt",
113 authnotrequired => 0,
114 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
118 output_html_with_http_headers $query, $cookie, $template->output;
122 The main function of this module is to provide
123 authentification. However the get_template_and_user function has
124 been provided so that a users login information is passed along
125 automatically. This gets loaded into the template.
129 =head2 get_template_and_user
131 my ($template, $borrowernumber, $cookie)
132 = get_template_and_user(
134 template_name => "opac-main.tt",
137 authnotrequired => 0,
138 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
142 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
143 to C<&checkauth> (in this module) to perform authentification.
144 See C<&checkauth> for an explanation of these parameters.
146 The C<template_name> is then used to find the correct template for
147 the page. The authenticated users details are loaded onto the
148 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
149 C<sessionID> is passed to the template. This can be used in templates
150 if cookies are disabled. It needs to be put as and input to every
153 More information on the C<gettemplate> sub can be found in the
158 sub get_template_and_user {
161 my ( $user, $cookie, $sessionID, $flags );
163 C4::Context->interface( $in->{type} );
165 $in->{'authnotrequired'} ||= 0;
167 # the following call includes a bad template check; might croak
168 my $template = C4::Templates::gettemplate(
169 $in->{'template_name'},
174 if ( $in->{'template_name'} !~ m/maintenance/ ) {
175 ( $user, $cookie, $sessionID, $flags ) = checkauth(
177 $in->{'authnotrequired'},
178 $in->{'flagsrequired'},
183 if ( $in->{type} eq 'opac' && $user ) {
187 # If the user logged in is the SCO user and they try to go out of the SCO module,
188 # log the user out removing the CGISESSID cookie
189 $in->{template_name} !~ m|sco/|
190 && C4::Context->preference('AutoSelfCheckID')
191 && $user eq C4::Context->preference('AutoSelfCheckID')
197 # If the user logged in is the SCI user and they try to go out of the SCI module,
198 # kick them out unless it is SCO with a valid permission
199 # or they are a superlibrarian
200 $in->{template_name} !~ m|sci/|
201 && haspermission( $user, { self_check => 'self_checkin_module' } )
203 $in->{template_name} =~ m|sco/| && haspermission(
204 $user, { self_check => 'self_checkout_module' }
207 && $flags && $flags->{superlibrarian} != 1
214 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
216 $cookie = $in->{query}->cookie(
217 -name => 'CGISESSID',
225 script_name => get_script_name(),
228 print $in->{query}->header(
233 'X-Frame-Options' => 'SAMEORIGIN'
244 # It's possible for $user to be the borrowernumber if they don't have a
245 # userid defined (and are logging in through some other method, such
246 # as SSL certs against an email address)
248 $borrowernumber = getborrowernumber($user) if defined($user);
249 if ( !defined($borrowernumber) && defined($user) ) {
250 $patron = Koha::Patrons->find( $user );
252 $borrowernumber = $user;
254 # A bit of a hack, but I don't know there's a nicer way
256 $user = $patron->firstname . ' ' . $patron->surname;
259 $patron = Koha::Patrons->find( $borrowernumber );
260 # FIXME What to do if $patron does not exist?
264 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
265 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
266 $template->param( logged_in_user => $patron );
267 $template->param( sessionID => $sessionID );
269 if ( $in->{'type'} eq 'opac' ) {
270 require Koha::Virtualshelves;
271 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
273 borrowernumber => $borrowernumber,
277 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
283 some_private_shelves => $some_private_shelves,
284 some_public_shelves => $some_public_shelves,
288 $template->param( "USER_INFO" => $patron->unblessed ) if $borrowernumber != 0;
290 my $all_perms = get_all_subpermissions();
292 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
293 editcatalogue updatecharges management tools editauthorities serials reports acquisition clubs);
295 # We are going to use the $flags returned by checkauth
296 # to create the template's parameters that will indicate
297 # which menus the user can access.
298 if ( $flags && $flags->{superlibrarian} == 1 ) {
299 $template->param( CAN_user_circulate => 1 );
300 $template->param( CAN_user_catalogue => 1 );
301 $template->param( CAN_user_parameters => 1 );
302 $template->param( CAN_user_borrowers => 1 );
303 $template->param( CAN_user_permissions => 1 );
304 $template->param( CAN_user_reserveforothers => 1 );
305 $template->param( CAN_user_editcatalogue => 1 );
306 $template->param( CAN_user_updatecharges => 1 );
307 $template->param( CAN_user_acquisition => 1 );
308 $template->param( CAN_user_management => 1 );
309 $template->param( CAN_user_tools => 1 );
310 $template->param( CAN_user_editauthorities => 1 );
311 $template->param( CAN_user_serials => 1 );
312 $template->param( CAN_user_reports => 1 );
313 $template->param( CAN_user_staffaccess => 1 );
314 $template->param( CAN_user_plugins => 1 );
315 $template->param( CAN_user_coursereserves => 1 );
316 $template->param( CAN_user_clubs => 1 );
317 $template->param( CAN_user_ill => 1 );
319 foreach my $module ( keys %$all_perms ) {
320 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
321 $template->param( "CAN_user_${module}_${subperm}" => 1 );
327 foreach my $module ( keys %$all_perms ) {
328 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
329 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
330 $template->param( "CAN_user_${module}_${subperm}" => 1 );
332 } elsif ( ref( $flags->{$module} ) ) {
333 foreach my $subperm ( keys %{ $flags->{$module} } ) {
334 $template->param( "CAN_user_${module}_${subperm}" => 1 );
341 foreach my $module ( keys %$flags ) {
342 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
343 $template->param( "CAN_user_$module" => 1 );
344 if ( $module eq "parameters" ) {
345 $template->param( CAN_user_management => 1 );
351 # Logged-in opac search history
352 # If the requested template is an opac one and opac search history is enabled
353 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
354 my $dbh = C4::Context->dbh;
355 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
356 my $sth = $dbh->prepare($query);
357 $sth->execute($borrowernumber);
359 # If at least one search has already been performed
360 if ( $sth->fetchrow_array > 0 ) {
362 # We show the link in opac
363 $template->param( EnableOpacSearchHistory => 1 );
365 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
367 # And if there are searches performed when the user was not logged in,
368 # we add them to the logged-in search history
369 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
370 if (@recentSearches) {
371 my $dbh = C4::Context->dbh;
373 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
374 VALUES (?, ?, ?, ?, ?, ?, ?)
376 my $sth = $dbh->prepare($query);
377 $sth->execute( $borrowernumber,
378 $in->{query}->cookie("CGISESSID"),
381 $_->{type} || 'biblio',
384 ) foreach @recentSearches;
386 # clear out the search history from the session now that
387 # we've saved it to the database
390 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
392 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
393 $template->param( EnableSearchHistory => 1 );
396 else { # if this is an anonymous session, setup to display public lists...
398 # If shibboleth is enabled, and we're in an anonymous session, we should allow
399 # the user to attempt login via shibboleth.
401 $template->param( shibbolethAuthentication => $shib,
402 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
405 # If shibboleth is enabled and we have a shibboleth login attribute,
406 # but we are in an anonymous session, then we clearly have an invalid
407 # shibboleth koha account.
409 $template->param( invalidShibLogin => '1' );
413 $template->param( sessionID => $sessionID );
415 if ( $in->{'type'} eq 'opac' ){
416 require Koha::Virtualshelves;
417 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
423 some_public_shelves => $some_public_shelves,
428 # Anonymous opac search history
429 # If opac search history is enabled and at least one search has already been performed
430 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
431 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
432 if (@recentSearches) {
433 $template->param( EnableOpacSearchHistory => 1 );
437 if ( C4::Context->preference('dateformat') ) {
438 $template->param( dateformat => C4::Context->preference('dateformat') );
441 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
443 # these template parameters are set the same regardless of $in->{'type'}
445 # Set the using_https variable for templates
446 # FIXME Under Plack the CGI->https method always returns 'OFF'
447 my $https = $in->{query}->https();
448 my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
450 my $minPasswordLength = C4::Context->preference('minPasswordLength');
451 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
453 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
454 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
455 GoogleJackets => C4::Context->preference("GoogleJackets"),
456 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
457 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
458 LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"} : undef ),
459 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
460 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
461 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
462 TagsEnabled => C4::Context->preference("TagsEnabled"),
463 hide_marc => C4::Context->preference("hide_marc"),
464 item_level_itypes => C4::Context->preference('item-level_itypes'),
465 patronimages => C4::Context->preference("patronimages"),
466 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
467 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
468 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
469 using_https => $using_https,
470 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
471 marcflavour => C4::Context->preference("marcflavour"),
472 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
473 minPasswordLength => $minPasswordLength,
475 if ( $in->{'type'} eq "intranet" ) {
477 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
478 AutoLocation => C4::Context->preference("AutoLocation"),
479 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
480 CircAutocompl => C4::Context->preference("CircAutocompl"),
481 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
482 IndependentBranches => C4::Context->preference("IndependentBranches"),
483 IntranetNav => C4::Context->preference("IntranetNav"),
484 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
485 LibraryName => C4::Context->preference("LibraryName"),
486 LoginBranchname => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
487 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
488 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
489 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
490 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
491 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
492 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
493 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
494 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
495 intranetbookbag => C4::Context->preference("intranetbookbag"),
496 suggestion => C4::Context->preference("suggestion"),
497 virtualshelves => C4::Context->preference("virtualshelves"),
498 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
499 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
500 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
501 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
502 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
503 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
504 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
505 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
506 useDischarge => C4::Context->preference('useDischarge')
510 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
512 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
513 my $LibraryNameTitle = C4::Context->preference("LibraryName");
514 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
515 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
517 # clean up the busc param in the session
518 # if the page is not opac-detail and not the "add to list" page
519 # and not the "edit comments" page
520 if ( C4::Context->preference("OpacBrowseResults")
521 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
523 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
524 or $pagename =~ /^addbybiblionumber$/
525 or $pagename =~ /^review$/ ) {
526 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
527 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
531 # variables passed from CGI: opac_css_override and opac_search_limits.
532 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
533 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
536 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
537 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
538 ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
540 $opac_name = $1; # opac_search_limit is a branch, so we use it.
541 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
542 $opac_name = $in->{'query'}->param('multibranchlimit');
543 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
544 $opac_name = C4::Context->userenv->{'branch'};
547 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' });
549 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
550 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
551 LibrarySearchGroups => \@search_groups,
552 opac_name => $opac_name,
553 LibraryName => "" . C4::Context->preference("LibraryName"),
554 LibraryNameTitle => "" . $LibraryNameTitle,
555 LoginBranchname => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
556 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
557 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
558 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
559 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
560 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
561 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
562 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
563 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
564 opac_search_limit => $opac_search_limit,
565 opac_limit_override => $opac_limit_override,
566 OpacBrowser => C4::Context->preference("OpacBrowser"),
567 OpacCloud => C4::Context->preference("OpacCloud"),
568 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
569 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
570 OpacNav => "" . C4::Context->preference("OpacNav"),
571 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
572 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
573 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
574 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
575 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
576 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
577 OpacTopissue => C4::Context->preference("OpacTopissue"),
578 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
579 'Version' => C4::Context->preference('Version'),
580 hidelostitems => C4::Context->preference("hidelostitems"),
581 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
582 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
583 opacbookbag => "" . C4::Context->preference("opacbookbag"),
584 opaccredits => "" . C4::Context->preference("opaccredits"),
585 OpacFavicon => C4::Context->preference("OpacFavicon"),
586 opacheader => "" . C4::Context->preference("opacheader"),
587 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
588 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
589 OPACUserJS => C4::Context->preference("OPACUserJS"),
590 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
591 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
592 ShowReviewer => C4::Context->preference("ShowReviewer"),
593 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
594 suggestion => "" . C4::Context->preference("suggestion"),
595 virtualshelves => "" . C4::Context->preference("virtualshelves"),
596 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
597 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
598 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
599 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
600 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
601 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
602 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
603 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
604 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
605 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
606 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
607 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
608 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
609 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
610 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
611 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
612 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
613 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
614 useDischarge => C4::Context->preference('useDischarge'),
617 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
620 # Check if we were asked using parameters to force a specific language
621 if ( defined $in->{'query'}->param('language') ) {
623 # Extract the language, let C4::Languages::getlanguage choose
625 my $language = C4::Languages::getlanguage( $in->{'query'} );
626 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
627 if ( ref $cookie eq 'ARRAY' ) {
628 push @{$cookie}, $languagecookie;
630 $cookie = [ $cookie, $languagecookie ];
634 return ( $template, $borrowernumber, $cookie, $flags );
639 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
641 Verifies that the user is authorized to run this script. If
642 the user is authorized, a (userid, cookie, session-id, flags)
643 quadruple is returned. If the user is not authorized but does
644 not have the required privilege (see $flagsrequired below), it
645 displays an error page and exits. Otherwise, it displays the
646 login page and exits.
648 Note that C<&checkauth> will return if and only if the user
649 is authorized, so it should be called early on, before any
650 unfinished operations (e.g., if you've opened a file, then
651 C<&checkauth> won't close it for you).
653 C<$query> is the CGI object for the script calling C<&checkauth>.
655 The C<$noauth> argument is optional. If it is set, then no
656 authorization is required for the script.
658 C<&checkauth> fetches user and session information from C<$query> and
659 ensures that the user is authorized to run scripts that require
662 The C<$flagsrequired> argument specifies the required privileges
663 the user must have if the username and password are correct.
664 It should be specified as a reference-to-hash; keys in the hash
665 should be the "flags" for the user, as specified in the Members
666 intranet module. Any key specified must correspond to a "flag"
667 in the userflags table. E.g., { circulate => 1 } would specify
668 that the user must have the "circulate" privilege in order to
669 proceed. To make sure that access control is correct, the
670 C<$flagsrequired> parameter must be specified correctly.
672 Koha also has a concept of sub-permissions, also known as
673 granular permissions. This makes the value of each key
674 in the C<flagsrequired> hash take on an additional
679 The user must have access to all subfunctions of the module
680 specified by the hash key.
684 The user must have access to at least one subfunction of the module
685 specified by the hash key.
687 specific permission, e.g., 'export_catalog'
689 The user must have access to the specific subfunction list, which
690 must correspond to a row in the permissions table.
692 The C<$type> argument specifies whether the template should be
693 retrieved from the opac or intranet directory tree. "opac" is
694 assumed if it is not specified; however, if C<$type> is specified,
695 "intranet" is assumed if it is not "opac".
697 If C<$query> does not have a valid session ID associated with it
698 (i.e., the user has not logged in) or if the session has expired,
699 C<&checkauth> presents the user with a login page (from the point of
700 view of the original script, C<&checkauth> does not return). Once the
701 user has authenticated, C<&checkauth> restarts the original script
702 (this time, C<&checkauth> returns).
704 The login page is provided using a HTML::Template, which is set in the
705 systempreferences table or at the top of this file. The variable C<$type>
706 selects which template to use, either the opac or the intranet
707 authentification template.
709 C<&checkauth> returns a user ID, a cookie, and a session ID. The
710 cookie should be sent back to the browser; it verifies that the user
720 # If version syspref is unavailable, it means Koha is being installed,
721 # and so we must redirect to OPAC maintenance page or to the WebInstaller
722 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
723 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
724 warn "OPAC Install required, redirecting to maintenance";
725 print $query->redirect("/cgi-bin/koha/maintenance.pl");
728 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
729 if ( $type ne 'opac' ) {
730 warn "Install required, redirecting to Installer";
731 print $query->redirect("/cgi-bin/koha/installer/install.pl");
733 warn "OPAC Install required, redirecting to maintenance";
734 print $query->redirect("/cgi-bin/koha/maintenance.pl");
739 # check that database and koha version are the same
740 # there is no DB version, it's a fresh install,
741 # go to web installer
742 # there is a DB version, compare it to the code version
743 my $kohaversion = Koha::version();
745 # remove the 3 last . to have a Perl number
746 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
747 $debug and print STDERR "kohaversion : $kohaversion\n";
748 if ( $version < $kohaversion ) {
749 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
750 if ( $type ne 'opac' ) {
751 warn sprintf( $warning, 'Installer' );
752 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
754 warn sprintf( "OPAC: " . $warning, 'maintenance' );
755 print $query->redirect("/cgi-bin/koha/maintenance.pl");
763 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
764 printf $fh join( "\n", @_ );
768 sub _timeout_syspref {
769 my $timeout = C4::Context->preference('timeout') || 600;
771 # value in days, convert in seconds
772 if ( $timeout =~ /(\d+)[dD]/ ) {
773 $timeout = $1 * 86400;
780 $debug and warn "Checking Auth";
781 # $authnotrequired will be set for scripts which will run without authentication
782 my $authnotrequired = shift;
783 my $flagsrequired = shift;
785 my $emailaddress = shift;
786 $type = 'opac' unless $type;
788 my $dbh = C4::Context->dbh;
789 my $timeout = _timeout_syspref();
791 _version_check( $type, $query );
796 my ( $userid, $cookie, $sessionID, $flags );
797 my $logout = $query->param('logout.x');
799 my $anon_search_history;
801 # This parameter is the name of the CAS server we want to authenticate against,
802 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
803 my $casparam = $query->param('cas');
804 my $q_userid = $query->param('userid') // '';
808 # Basic authentication is incompatible with the use of Shibboleth,
809 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
810 # and it may not be the attribute we want to use to match the koha login.
812 # Also, do not consider an empty REMOTE_USER.
814 # Finally, after those tests, we can assume (although if it would be better with
815 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
816 # and we can affect it to $userid.
817 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
819 # Using Basic Authentication, no cookies required
820 $cookie = $query->cookie(
821 -name => 'CGISESSID',
828 elsif ( $emailaddress) {
829 # the Google OpenID Connect passes an email address
831 elsif ( $sessionID = $query->cookie("CGISESSID") )
832 { # assignment, not comparison
833 $session = get_session($sessionID);
834 C4::Context->_new_userenv($sessionID);
835 my ( $ip, $lasttime, $sessiontype );
838 $s_userid = $session->param('id') // '';
839 C4::Context->set_userenv(
840 $session->param('number'), $s_userid,
841 $session->param('cardnumber'), $session->param('firstname'),
842 $session->param('surname'), $session->param('branch'),
843 $session->param('branchname'), $session->param('flags'),
844 $session->param('emailaddress'), $session->param('branchprinter'),
845 $session->param('shibboleth')
847 C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
848 C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
849 C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
850 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
851 $ip = $session->param('ip');
852 $lasttime = $session->param('lasttime');
854 $sessiontype = $session->param('sessiontype') || '';
856 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
857 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
858 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
861 #if a user enters an id ne to the id in the current session, we need to log them in...
862 #first we need to clear the anonymous session...
863 $debug and warn "query id = $q_userid but session id = $s_userid";
864 $anon_search_history = $session->param('search_history');
867 C4::Context->_unset_userenv($sessionID);
873 # voluntary logout the user
874 # check wether the user was using their shibboleth session or a local one
875 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
878 C4::Context->_unset_userenv($sessionID);
880 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
884 if ($cas and $caslogout) {
885 logout_cas($query, $type);
888 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
889 if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
891 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
895 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
898 $info{'timed_out'} = 1;
903 C4::Context->_unset_userenv($sessionID);
905 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
909 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
911 # Different ip than originally logged in from
912 $info{'oldip'} = $ip;
913 $info{'newip'} = $ENV{'REMOTE_ADDR'};
914 $info{'different_ip'} = 1;
917 C4::Context->_unset_userenv($sessionID);
919 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
924 $cookie = $query->cookie(
925 -name => 'CGISESSID',
926 -value => $session->id,
929 $session->param( 'lasttime', time() );
930 unless ( $sessiontype && $sessiontype eq 'anon' ) { #if this is an anonymous session, we want to update the session, but not behave as if they are logged in...
931 $flags = haspermission( $userid, $flagsrequired );
935 $info{'nopermission'} = 1;
940 unless ( $userid || $sessionID ) {
941 #we initiate a session prior to checking for a username to allow for anonymous sessions...
942 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
944 # Save anonymous search history in new session so it can be retrieved
945 # by get_template_and_user to store it in user's search history after
946 # a successful login.
947 if ($anon_search_history) {
948 $session->param( 'search_history', $anon_search_history );
951 $sessionID = $session->id;
952 C4::Context->_new_userenv($sessionID);
953 $cookie = $query->cookie(
954 -name => 'CGISESSID',
955 -value => $session->id,
958 my $pki_field = C4::Context->preference('AllowPKIAuth');
959 if ( !defined($pki_field) ) {
960 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
963 if ( ( $cas && $query->param('ticket') )
965 || ( $shib && $shib_login )
966 || $pki_field ne 'None'
969 my $password = $query->param('password');
971 my ( $return, $cardnumber );
973 # If shib is enabled and we have a shib login, does the login match a valid koha user
974 if ( $shib && $shib_login && $type eq 'opac' ) {
977 # Do not pass password here, else shib will not be checked in checkpw.
978 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $q_userid, undef, $query );
979 $userid = $retuserid;
980 $shibSuccess = $return;
981 $info{'invalidShibLogin'} = 1 unless ($return);
984 # If shib login and match were successful, skip further login methods
985 unless ($shibSuccess) {
986 if ( $cas && $query->param('ticket') ) {
988 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
989 checkpw( $dbh, $userid, $password, $query, $type );
990 $userid = $retuserid;
991 $info{'invalidCasLogin'} = 1 unless ($return);
994 elsif ( $emailaddress ) {
995 my $value = $emailaddress;
997 # If we're looking up the email, there's a chance that the person
998 # doesn't have a userid. So if there is none, we pass along the
999 # borrower number, and the bits of code that need to know the user
1000 # ID will have to be smart enough to handle that.
1001 my $patrons = Koha::Patrons->search({ email => $value });
1002 if ($patrons->count) {
1004 # First the userid, then the borrowernum
1005 my $patron = $patrons->next;
1006 $value = $patron->userid || $patron->borrowernumber;
1010 $return = $value ? 1 : 0;
1015 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1016 || ( $pki_field eq 'emailAddress'
1017 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1021 if ( $pki_field eq 'Common Name' ) {
1022 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1024 elsif ( $pki_field eq 'emailAddress' ) {
1025 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1027 # If we're looking up the email, there's a chance that the person
1028 # doesn't have a userid. So if there is none, we pass along the
1029 # borrower number, and the bits of code that need to know the user
1030 # ID will have to be smart enough to handle that.
1031 my $patrons = Koha::Patrons->search({ email => $value });
1032 if ($patrons->count) {
1034 # First the userid, then the borrowernum
1035 my $patron = $patrons->next;
1036 $value = $patron->userid || $patron->borrowernumber;
1042 $return = $value ? 1 : 0;
1048 ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1049 checkpw( $dbh, $q_userid, $password, $query, $type );
1050 $userid = $retuserid if ($retuserid);
1051 $info{'invalid_username_or_password'} = 1 unless ($return);
1055 # $return: 1 = valid user
1058 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1059 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1063 $info{'nopermission'} = 1;
1064 C4::Context->_unset_userenv($sessionID);
1066 my ( $borrowernumber, $firstname, $surname, $userflags,
1067 $branchcode, $branchname, $branchprinter, $emailaddress );
1069 if ( $return == 1 ) {
1071 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1072 branches.branchname as branchname,
1073 branches.branchprinter as branchprinter,
1076 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1078 my $sth = $dbh->prepare("$select where userid=?");
1079 $sth->execute($userid);
1080 unless ( $sth->rows ) {
1081 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1082 $sth = $dbh->prepare("$select where cardnumber=?");
1083 $sth->execute($cardnumber);
1085 unless ( $sth->rows ) {
1086 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1087 $sth->execute($userid);
1088 unless ( $sth->rows ) {
1089 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1094 ( $borrowernumber, $firstname, $surname, $userflags,
1095 $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1096 $debug and print STDERR "AUTH_3 results: " .
1097 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1099 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1102 # launch a sequence to check if we have a ip for the branch, i
1103 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1105 my $ip = $ENV{'REMOTE_ADDR'};
1107 # if they specify at login, use that
1108 if ( $query->param('branch') ) {
1109 $branchcode = $query->param('branch');
1110 my $library = Koha::Libraries->find($branchcode);
1111 $branchname = $library? $library->branchname: '';
1113 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1114 if ( $type ne 'opac' and C4::Context->boolean_preference('AutoLocation') ) {
1116 # we have to check they are coming from the right ip range
1117 my $domain = $branches->{$branchcode}->{'branchip'};
1118 $domain =~ s|\.\*||g;
1119 if ( $ip !~ /^$domain/ ) {
1121 $cookie = $query->cookie(
1122 -name => 'CGISESSID',
1126 $info{'wrongip'} = 1;
1130 foreach my $br ( keys %$branches ) {
1132 # now we work with the treatment of ip
1133 my $domain = $branches->{$br}->{'branchip'};
1134 if ( $domain && $ip =~ /^$domain/ ) {
1135 $branchcode = $branches->{$br}->{'branchcode'};
1137 # new op dev : add the branchprinter and branchname in the cookie
1138 $branchprinter = $branches->{$br}->{'branchprinter'};
1139 $branchname = $branches->{$br}->{'branchname'};
1142 $session->param( 'number', $borrowernumber );
1143 $session->param( 'id', $userid );
1144 $session->param( 'cardnumber', $cardnumber );
1145 $session->param( 'firstname', $firstname );
1146 $session->param( 'surname', $surname );
1147 $session->param( 'branch', $branchcode );
1148 $session->param( 'branchname', $branchname );
1149 $session->param( 'flags', $userflags );
1150 $session->param( 'emailaddress', $emailaddress );
1151 $session->param( 'ip', $session->remote_addr() );
1152 $session->param( 'lasttime', time() );
1153 $session->param( 'shibboleth', $shibSuccess );
1154 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1156 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1157 C4::Context->set_userenv(
1158 $session->param('number'), $session->param('id'),
1159 $session->param('cardnumber'), $session->param('firstname'),
1160 $session->param('surname'), $session->param('branch'),
1161 $session->param('branchname'), $session->param('flags'),
1162 $session->param('emailaddress'), $session->param('branchprinter'),
1163 $session->param('shibboleth')
1167 # $return: 0 = invalid user
1168 # reset to anonymous session
1170 $debug and warn "Login failed, resetting anonymous session...";
1172 $info{'invalid_username_or_password'} = 1;
1173 C4::Context->_unset_userenv($sessionID);
1175 $session->param( 'lasttime', time() );
1176 $session->param( 'ip', $session->remote_addr() );
1177 $session->param( 'sessiontype', 'anon' );
1179 } # END if ( $q_userid
1180 elsif ( $type eq "opac" ) {
1182 # if we are here this is an anonymous session; add public lists to it and a few other items...
1183 # anonymous sessions are created only for the OPAC
1184 $debug and warn "Initiating an anonymous session...";
1186 # setting a couple of other session vars...
1187 $session->param( 'ip', $session->remote_addr() );
1188 $session->param( 'lasttime', time() );
1189 $session->param( 'sessiontype', 'anon' );
1191 } # END unless ($userid)
1193 # finished authentification, now respond
1194 if ( $loggedin || $authnotrequired )
1198 $cookie = $query->cookie(
1199 -name => 'CGISESSID',
1205 track_login_daily( $userid );
1207 return ( $userid, $cookie, $sessionID, $flags );
1212 # AUTH rejected, show the login/password template, after checking the DB.
1216 # get the inputs from the incoming query
1218 foreach my $name ( param $query) {
1219 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1220 my @value = $query->multi_param($name);
1221 push @inputs, { name => $name, value => $_ } for @value;
1224 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1226 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1227 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1228 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1230 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1231 my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1233 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1234 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1237 script_name => get_script_name(),
1238 casAuthentication => C4::Context->preference("casAuthentication"),
1239 shibbolethAuthentication => $shib,
1240 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1241 suggestion => C4::Context->preference("suggestion"),
1242 virtualshelves => C4::Context->preference("virtualshelves"),
1243 LibraryName => "" . C4::Context->preference("LibraryName"),
1244 LibraryNameTitle => "" . $LibraryNameTitle,
1245 opacuserlogin => C4::Context->preference("opacuserlogin"),
1246 OpacNav => C4::Context->preference("OpacNav"),
1247 OpacNavRight => C4::Context->preference("OpacNavRight"),
1248 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1249 opaccredits => C4::Context->preference("opaccredits"),
1250 OpacFavicon => C4::Context->preference("OpacFavicon"),
1251 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1252 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1253 OPACUserJS => C4::Context->preference("OPACUserJS"),
1254 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1255 OpacCloud => C4::Context->preference("OpacCloud"),
1256 OpacTopissue => C4::Context->preference("OpacTopissue"),
1257 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1258 OpacBrowser => C4::Context->preference("OpacBrowser"),
1259 opacheader => C4::Context->preference("opacheader"),
1260 TagsEnabled => C4::Context->preference("TagsEnabled"),
1261 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1262 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1263 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1264 intranetbookbag => C4::Context->preference("intranetbookbag"),
1265 IntranetNav => C4::Context->preference("IntranetNav"),
1266 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1267 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1268 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1269 IndependentBranches => C4::Context->preference("IndependentBranches"),
1270 AutoLocation => C4::Context->preference("AutoLocation"),
1271 wrongip => $info{'wrongip'},
1272 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1273 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1274 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1275 too_many_login_attempts => ( $patron and $patron->account_locked )
1278 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1279 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1280 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1281 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1283 if ( $type eq 'opac' ) {
1284 require Koha::Virtualshelves;
1285 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1291 some_public_shelves => $some_public_shelves,
1297 # Is authentication against multiple CAS servers enabled?
1298 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1299 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1301 foreach my $key ( keys %$casservers ) {
1302 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1305 casServersLoop => \@tmplservers
1309 casServerUrl => login_cas_url($query, undef, $type),
1314 invalidCasLogin => $info{'invalidCasLogin'}
1320 shibbolethAuthentication => $shib,
1321 shibbolethLoginUrl => login_shib_url($query),
1325 if (C4::Context->preference('GoogleOpenIDConnect')) {
1326 if ($query->param("OpenIDConnectFailed")) {
1327 my $reason = $query->param('OpenIDConnectFailed');
1328 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1333 LibraryName => C4::Context->preference("LibraryName"),
1335 $template->param(%info);
1337 # $cookie = $query->cookie(CGISESSID => $session->id
1339 print $query->header(
1340 { type => 'text/html',
1343 'X-Frame-Options' => 'SAMEORIGIN'
1350 =head2 check_api_auth
1352 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1354 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1355 cookie, determine if the user has the privileges specified by C<$userflags>.
1357 C<check_api_auth> is is meant for authenticating users of web services, and
1358 consequently will always return and will not attempt to redirect the user
1361 If a valid session cookie is already present, check_api_auth will return a status
1362 of "ok", the cookie, and the Koha session ID.
1364 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1365 parameters and create a session cookie and Koha session if the supplied credentials
1368 Possible return values in C<$status> are:
1372 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1374 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1376 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1378 =item "expired -- session cookie has expired; API user should resubmit userid and password
1384 sub check_api_auth {
1387 my $flagsrequired = shift;
1388 my $dbh = C4::Context->dbh;
1389 my $timeout = _timeout_syspref();
1391 unless ( C4::Context->preference('Version') ) {
1393 # database has not been installed yet
1394 return ( "maintenance", undef, undef );
1396 my $kohaversion = Koha::version();
1397 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1398 if ( C4::Context->preference('Version') < $kohaversion ) {
1400 # database in need of version update; assume that
1401 # no API should be called while databsae is in
1403 return ( "maintenance", undef, undef );
1406 # FIXME -- most of what follows is a copy-and-paste
1407 # of code from checkauth. There is an obvious need
1408 # for refactoring to separate the various parts of
1409 # the authentication code, but as of 2007-11-19 this
1410 # is deferred so as to not introduce bugs into the
1411 # regular authentication code for Koha 3.0.
1413 # see if we have a valid session cookie already
1414 # however, if a userid parameter is present (i.e., from
1415 # a form submission, assume that any current cookie
1417 my $sessionID = undef;
1418 unless ( $query->param('userid') ) {
1419 $sessionID = $query->cookie("CGISESSID");
1421 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1422 my $session = get_session($sessionID);
1423 C4::Context->_new_userenv($sessionID);
1425 C4::Context->set_userenv(
1426 $session->param('number'), $session->param('id'),
1427 $session->param('cardnumber'), $session->param('firstname'),
1428 $session->param('surname'), $session->param('branch'),
1429 $session->param('branchname'), $session->param('flags'),
1430 $session->param('emailaddress'), $session->param('branchprinter')
1433 my $ip = $session->param('ip');
1434 my $lasttime = $session->param('lasttime');
1435 my $userid = $session->param('id');
1436 if ( $lasttime < time() - $timeout ) {
1441 C4::Context->_unset_userenv($sessionID);
1444 return ( "expired", undef, undef );
1445 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1447 # IP address changed
1450 C4::Context->_unset_userenv($sessionID);
1453 return ( "expired", undef, undef );
1455 my $cookie = $query->cookie(
1456 -name => 'CGISESSID',
1457 -value => $session->id,
1460 $session->param( 'lasttime', time() );
1461 my $flags = haspermission( $userid, $flagsrequired );
1463 return ( "ok", $cookie, $sessionID );
1467 C4::Context->_unset_userenv($sessionID);
1470 return ( "failed", undef, undef );
1474 return ( "expired", undef, undef );
1479 my $userid = $query->param('userid');
1480 my $password = $query->param('password');
1481 my ( $return, $cardnumber, $cas_ticket );
1484 if ( $cas && $query->param('PT') ) {
1486 $debug and print STDERR "## check_api_auth - checking CAS\n";
1488 # In case of a CAS authentication, we use the ticket instead of the password
1489 my $PT = $query->param('PT');
1490 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1493 # User / password auth
1494 unless ( $userid and $password ) {
1496 # caller did something wrong, fail the authenticateion
1497 return ( "failed", undef, undef );
1500 ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $dbh, $userid, $password, $query );
1503 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1504 my $session = get_session("");
1505 return ( "failed", undef, undef ) unless $session;
1507 my $sessionID = $session->id;
1508 C4::Context->_new_userenv($sessionID);
1509 my $cookie = $query->cookie(
1510 -name => 'CGISESSID',
1511 -value => $sessionID,
1514 if ( $return == 1 ) {
1516 $borrowernumber, $firstname, $surname,
1517 $userflags, $branchcode, $branchname,
1518 $branchprinter, $emailaddress
1522 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname,branches.branchprinter as branchprinter, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1524 $sth->execute($userid);
1526 $borrowernumber, $firstname, $surname,
1527 $userflags, $branchcode, $branchname,
1528 $branchprinter, $emailaddress
1529 ) = $sth->fetchrow if ( $sth->rows );
1531 unless ( $sth->rows ) {
1532 my $sth = $dbh->prepare(
1533 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, branches.branchprinter as branchprinter, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1535 $sth->execute($cardnumber);
1537 $borrowernumber, $firstname, $surname,
1538 $userflags, $branchcode, $branchname,
1539 $branchprinter, $emailaddress
1540 ) = $sth->fetchrow if ( $sth->rows );
1542 unless ( $sth->rows ) {
1543 $sth->execute($userid);
1545 $borrowernumber, $firstname, $surname, $userflags,
1546 $branchcode, $branchname, $branchprinter, $emailaddress
1547 ) = $sth->fetchrow if ( $sth->rows );
1551 my $ip = $ENV{'REMOTE_ADDR'};
1553 # if they specify at login, use that
1554 if ( $query->param('branch') ) {
1555 $branchcode = $query->param('branch');
1556 my $library = Koha::Libraries->find($branchcode);
1557 $branchname = $library? $library->branchname: '';
1559 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1560 foreach my $br ( keys %$branches ) {
1562 # now we work with the treatment of ip
1563 my $domain = $branches->{$br}->{'branchip'};
1564 if ( $domain && $ip =~ /^$domain/ ) {
1565 $branchcode = $branches->{$br}->{'branchcode'};
1567 # new op dev : add the branchprinter and branchname in the cookie
1568 $branchprinter = $branches->{$br}->{'branchprinter'};
1569 $branchname = $branches->{$br}->{'branchname'};
1572 $session->param( 'number', $borrowernumber );
1573 $session->param( 'id', $userid );
1574 $session->param( 'cardnumber', $cardnumber );
1575 $session->param( 'firstname', $firstname );
1576 $session->param( 'surname', $surname );
1577 $session->param( 'branch', $branchcode );
1578 $session->param( 'branchname', $branchname );
1579 $session->param( 'flags', $userflags );
1580 $session->param( 'emailaddress', $emailaddress );
1581 $session->param( 'ip', $session->remote_addr() );
1582 $session->param( 'lasttime', time() );
1584 $session->param( 'cas_ticket', $cas_ticket);
1585 C4::Context->set_userenv(
1586 $session->param('number'), $session->param('id'),
1587 $session->param('cardnumber'), $session->param('firstname'),
1588 $session->param('surname'), $session->param('branch'),
1589 $session->param('branchname'), $session->param('flags'),
1590 $session->param('emailaddress'), $session->param('branchprinter')
1592 return ( "ok", $cookie, $sessionID );
1594 return ( "failed", undef, undef );
1599 =head2 check_cookie_auth
1601 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1603 Given a CGISESSID cookie set during a previous login to Koha, determine
1604 if the user has the privileges specified by C<$userflags>.
1606 C<check_cookie_auth> is meant for authenticating special services
1607 such as tools/upload-file.pl that are invoked by other pages that
1608 have been authenticated in the usual way.
1610 Possible return values in C<$status> are:
1614 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1616 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1618 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1620 =item "expired -- session cookie has expired; API user should resubmit userid and password
1626 sub check_cookie_auth {
1628 my $flagsrequired = shift;
1631 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1632 my $dbh = C4::Context->dbh;
1633 my $timeout = _timeout_syspref();
1635 unless ( C4::Context->preference('Version') ) {
1637 # database has not been installed yet
1638 return ( "maintenance", undef );
1640 my $kohaversion = Koha::version();
1641 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1642 if ( C4::Context->preference('Version') < $kohaversion ) {
1644 # database in need of version update; assume that
1645 # no API should be called while databsae is in
1647 return ( "maintenance", undef );
1650 # FIXME -- most of what follows is a copy-and-paste
1651 # of code from checkauth. There is an obvious need
1652 # for refactoring to separate the various parts of
1653 # the authentication code, but as of 2007-11-23 this
1654 # is deferred so as to not introduce bugs into the
1655 # regular authentication code for Koha 3.0.
1657 # see if we have a valid session cookie already
1658 # however, if a userid parameter is present (i.e., from
1659 # a form submission, assume that any current cookie
1661 unless ( defined $cookie and $cookie ) {
1662 return ( "failed", undef );
1664 my $sessionID = $cookie;
1665 my $session = get_session($sessionID);
1666 C4::Context->_new_userenv($sessionID);
1668 C4::Context->set_userenv(
1669 $session->param('number'), $session->param('id'),
1670 $session->param('cardnumber'), $session->param('firstname'),
1671 $session->param('surname'), $session->param('branch'),
1672 $session->param('branchname'), $session->param('flags'),
1673 $session->param('emailaddress'), $session->param('branchprinter')
1676 my $ip = $session->param('ip');
1677 my $lasttime = $session->param('lasttime');
1678 my $userid = $session->param('id');
1679 if ( $lasttime < time() - $timeout ) {
1684 C4::Context->_unset_userenv($sessionID);
1687 return ("expired", undef);
1688 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1690 # IP address changed
1693 C4::Context->_unset_userenv($sessionID);
1696 return ( "expired", undef );
1698 $session->param( 'lasttime', time() );
1699 my $flags = haspermission( $userid, $flagsrequired );
1701 return ( "ok", $sessionID );
1705 C4::Context->_unset_userenv($sessionID);
1708 return ( "failed", undef );
1712 return ( "expired", undef );
1719 my $session = get_session($sessionID);
1721 Given a session ID, retrieve the CGI::Session object used to store
1722 the session's state. The session object can be used to store
1723 data that needs to be accessed by different scripts during a
1726 If the C<$sessionID> parameter is an empty string, a new session
1731 sub _get_session_params {
1732 my $storage_method = C4::Context->preference('SessionStorage');
1733 if ( $storage_method eq 'mysql' ) {
1734 my $dbh = C4::Context->dbh;
1735 return { dsn => "driver:MySQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1737 elsif ( $storage_method eq 'Pg' ) {
1738 my $dbh = C4::Context->dbh;
1739 return { dsn => "driver:PostgreSQL;serializer:yaml;id:md5", dsn_args => { Handle => $dbh } };
1741 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1742 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1743 return { dsn => "driver:memcached;serializer:yaml;id:md5", dsn_args => { Memcached => $memcached } };
1746 # catch all defaults to tmp should work on all systems
1747 my $dir = File::Spec->tmpdir;
1748 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1749 return { dsn => "driver:File;serializer:yaml;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1754 my $sessionID = shift;
1755 my $params = _get_session_params();
1756 return new CGI::Session( $params->{dsn}, $sessionID, $params->{dsn_args} );
1760 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1761 # (or something similar)
1762 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1763 # not having a userenv defined could cause a crash.
1765 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1766 $type = 'opac' unless $type;
1769 my $patron = Koha::Patrons->find({ userid => $userid });
1770 my $check_internal_as_fallback = 0;
1772 # Note: checkpw_* routines returns:
1775 # -1 if user bind failed (LDAP only)
1777 if ( $patron and $patron->account_locked ) {
1778 # Nothing to check, account is locked
1779 } elsif ($ldap && defined($password)) {
1780 $debug and print STDERR "## checkpw - checking LDAP\n";
1781 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1782 if ( $retval == 1 ) {
1783 @return = ( $retval, $retcard, $retuserid );
1786 $check_internal_as_fallback = 1 if $retval == 0;
1788 } elsif ( $cas && $query && $query->param('ticket') ) {
1789 $debug and print STDERR "## checkpw - checking CAS\n";
1791 # In case of a CAS authentication, we use the ticket instead of the password
1792 my $ticket = $query->param('ticket');
1793 $query->delete('ticket'); # remove ticket to come back to original URL
1794 my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1796 @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1800 $passwd_ok = $retval;
1803 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1804 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1806 elsif ( $shib && $shib_login && !$password ) {
1808 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1810 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1811 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1812 # shibboleth-authenticated user
1814 # Then, we check if it matches a valid koha user
1816 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1818 @return = ( $retval, $retcard, $retuserid );
1820 $passwd_ok = $retval;
1823 $check_internal_as_fallback = 1;
1827 if ( $check_internal_as_fallback ) {
1828 @return = checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1829 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1834 $patron->update({ login_attempts => 0 });
1836 $patron->update({ login_attempts => $patron->login_attempts + 1 });
1842 sub checkpw_internal {
1843 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1845 $password = Encode::encode( 'UTF-8', $password )
1846 if Encode::is_utf8($password);
1850 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1852 $sth->execute($userid);
1854 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1855 $surname, $branchcode, $branchname, $flags )
1858 if ( checkpw_hash( $password, $stored_hash ) ) {
1860 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1861 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1862 return 1, $cardnumber, $userid;
1867 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1869 $sth->execute($userid);
1871 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1872 $surname, $branchcode, $branchname, $flags )
1875 if ( checkpw_hash( $password, $stored_hash ) ) {
1877 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1878 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1879 return 1, $cardnumber, $userid;
1886 my ( $password, $stored_hash ) = @_;
1888 return if $stored_hash eq '!';
1890 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1892 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1893 $hash = hash_password( $password, $stored_hash );
1895 $hash = md5_base64($password);
1897 return $hash eq $stored_hash;
1902 my $authflags = getuserflags($flags, $userid, [$dbh]);
1904 Translates integer flags into permissions strings hash.
1906 C<$flags> is the integer userflags value ( borrowers.userflags )
1907 C<$userid> is the members.userid, used for building subpermissions
1908 C<$authflags> is a hashref of permissions
1915 my $dbh = @_ ? shift : C4::Context->dbh;
1918 # I don't want to do this, but if someone logs in as the database
1919 # user, it would be preferable not to spam them to death with
1920 # numeric warnings. So, we make $flags numeric.
1921 no warnings 'numeric';
1924 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1927 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1928 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1929 $userflags->{$flag} = 1;
1932 $userflags->{$flag} = 0;
1936 # get subpermissions and merge with top-level permissions
1937 my $user_subperms = get_user_subpermissions($userid);
1938 foreach my $module ( keys %$user_subperms ) {
1939 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1940 $userflags->{$module} = $user_subperms->{$module};
1946 =head2 get_user_subpermissions
1948 $user_perm_hashref = get_user_subpermissions($userid);
1950 Given the userid (note, not the borrowernumber) of a staff user,
1951 return a hashref of hashrefs of the specific subpermissions
1952 accorded to the user. An example return is
1956 export_catalog => 1,
1957 import_patrons => 1,
1961 The top-level hash-key is a module or function code from
1962 userflags.flag, while the second-level key is a code
1965 The results of this function do not give a complete picture
1966 of the functions that a staff user can access; it is also
1967 necessary to check borrowers.flags.
1971 sub get_user_subpermissions {
1974 my $dbh = C4::Context->dbh;
1975 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1976 FROM user_permissions
1977 JOIN permissions USING (module_bit, code)
1978 JOIN userflags ON (module_bit = bit)
1979 JOIN borrowers USING (borrowernumber)
1980 WHERE userid = ?" );
1981 $sth->execute($userid);
1983 my $user_perms = {};
1984 while ( my $perm = $sth->fetchrow_hashref ) {
1985 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1990 =head2 get_all_subpermissions
1992 my $perm_hashref = get_all_subpermissions();
1994 Returns a hashref of hashrefs defining all specific
1995 permissions currently defined. The return value
1996 has the same structure as that of C<get_user_subpermissions>,
1997 except that the innermost hash value is the description
1998 of the subpermission.
2002 sub get_all_subpermissions {
2003 my $dbh = C4::Context->dbh;
2004 my $sth = $dbh->prepare( "SELECT flag, code
2006 JOIN userflags ON (module_bit = bit)" );
2010 while ( my $perm = $sth->fetchrow_hashref ) {
2011 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2016 =head2 haspermission
2018 $flags = ($userid, $flagsrequired);
2020 C<$userid> the userid of the member
2021 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
2023 Returns member's flags or 0 if a permission is not met.
2028 my ( $userid, $flagsrequired ) = @_;
2029 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2030 $sth->execute($userid);
2031 my $row = $sth->fetchrow();
2032 my $flags = getuserflags( $row, $userid );
2034 return $flags if $flags->{superlibrarian};
2036 foreach my $module ( keys %$flagsrequired ) {
2037 my $subperm = $flagsrequired->{$module};
2038 if ( $subperm eq '*' ) {
2039 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
2042 ( defined $flags->{$module} and
2043 $flags->{$module} == 1 )
2045 ( ref( $flags->{$module} ) and
2046 exists $flags->{$module}->{$subperm} and
2047 $flags->{$module}->{$subperm} == 1 )
2053 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2056 sub getborrowernumber {
2058 my $userenv = C4::Context->userenv;
2059 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2060 return $userenv->{number};
2062 my $dbh = C4::Context->dbh;
2063 for my $field ( 'userid', 'cardnumber' ) {
2065 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2066 $sth->execute($userid);
2068 my ($bnumber) = $sth->fetchrow;
2075 =head2 track_login_daily
2077 track_login_daily( $userid );
2079 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2083 sub track_login_daily {
2085 return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2087 my $cache = Koha::Caches->get_instance();
2088 my $cache_key = "track_login_" . $userid;
2089 my $cached = $cache->get_from_cache($cache_key);
2090 my $today = dt_from_string()->ymd;
2091 return if $cached && $cached eq $today;
2093 my $patron = Koha::Patrons->find({ userid => $userid });
2094 return unless $patron;
2095 $patron->track_login;
2096 $cache->set_in_cache( $cache_key, $today );
2099 END { } # module clean-up code here (global destructor)
2109 Crypt::Eksblowfish::Bcrypt(3)