C4/Auth.pm

   1 package C4::Auth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use strict;
  21 use warnings;
  22 use Carp qw( croak );
  23
  24 use Digest::MD5 qw( md5_base64 );
  25 use CGI::Session;
  26 use CGI::Session::ErrorHandler;
  27 use URI;
  28 use URI::QueryParam;
  29 use List::MoreUtils qw( uniq );
  30
  31 use C4::Context;
  32 use C4::Templates;    # to get the template
  33 use C4::Languages;
  34 use C4::Search::History;
  35 use Koha;
  36 use Koha::Logger;
  37 use Koha::Caches;
  38 use Koha::AuthUtils qw( get_script_name hash_password );
  39 use Koha::Auth::TwoFactorAuth;
  40 use Koha::Checkouts;
  41 use Koha::DateUtils qw( dt_from_string );
  42 use Koha::Library::Groups;
  43 use Koha::Libraries;
  44 use Koha::Cash::Registers;
  45 use Koha::Desks;
  46 use Koha::Patrons;
  47 use Koha::Patron::Consents;
  48 use List::MoreUtils qw( any );
  49 use Encode;
  50 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
  51 use Net::CIDR;
  52 use C4::Log qw( logaction );
  53 use Koha::CookieManager;
  54 use Koha::Token;
  55
  56 # use utf8;
  57
  58 use vars qw($ldap $cas $caslogout);
  59 our (@ISA, @EXPORT_OK);
  60 BEGIN {
  61     sub psgi_env { any { /^psgi\./ } keys %ENV }
  62
  63     sub safe_exit {
  64         if   (psgi_env) { die 'psgi:exit' }
  65         else            { exit }
  66     }
  67
  68     C4::Context->set_remote_address;
  69
  70     require Exporter;
  71     @ISA = qw(Exporter);
  72
  73     @EXPORT_OK = qw(
  74       checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
  75       get_all_subpermissions get_user_subpermissions track_login_daily in_iprange
  76       get_template_and_user haspermission
  77     );
  78
  79     $ldap      = C4::Context->config('useldapserver') || 0;
  80     $cas       = C4::Context->preference('casAuthentication');
  81     $caslogout = C4::Context->preference('casLogout');
  82
  83     if ($ldap) {
  84         require C4::Auth_with_ldap;
  85         import C4::Auth_with_ldap qw(checkpw_ldap);
  86     }
  87     if ($cas) {
  88         require C4::Auth_with_cas;    # no import
  89         import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
  90     }
  91
  92 }
  93
  94 =head1 NAME
  95
  96 C4::Auth - Authenticates Koha users
  97
  98 =head1 SYNOPSIS
  99
 100   use CGI qw ( -utf8 );
 101   use C4::Auth;
 102   use C4::Output;
 103
 104   my $query = CGI->new;
 105
 106   my ($template, $borrowernumber, $cookie)
 107     = get_template_and_user(
 108         {
 109             template_name   => "opac-main.tt",
 110             query           => $query,
 111       type            => "opac",
 112       authnotrequired => 0,
 113       flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
 114   }
 115     );
 116
 117   output_html_with_http_headers $query, $cookie, $template->output;
 118
 119 =head1 DESCRIPTION
 120
 121 The main function of this module is to provide
 122 authentification. However the get_template_and_user function has
 123 been provided so that a users login information is passed along
 124 automatically. This gets loaded into the template.
 125
 126 =head1 FUNCTIONS
 127
 128 =head2 get_template_and_user
 129
 130  my ($template, $borrowernumber, $cookie)
 131      = get_template_and_user(
 132        {
 133          template_name   => "opac-main.tt",
 134          query           => $query,
 135          type            => "opac",
 136          authnotrequired => 0,
 137          flagsrequired   => { catalogue => '*', tools => 'import_patrons' },
 138        }
 139      );
 140
 141 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
 142 to C<&checkauth> (in this module) to perform authentification.
 143 See C<&checkauth> for an explanation of these parameters.
 144
 145 The C<template_name> is then used to find the correct template for
 146 the page. The authenticated users details are loaded onto the
 147 template in the logged_in_user variable (which is a Koha::Patron object). Also the
 148 C<sessionID> is passed to the template. This can be used in templates
 149 if cookies are disabled. It needs to be put as and input to every
 150 authenticated page.
 151
 152 More information on the C<gettemplate> sub can be found in the
 153 Output.pm module.
 154
 155 =cut
 156
 157 sub get_template_and_user {
 158
 159     my $in = shift;
 160     my ( $user, $cookie, $sessionID, $flags );
 161     $cookie = [];
 162
 163     my $cookie_mgr = Koha::CookieManager->new;
 164
 165     # Get shibboleth login attribute
 166     my $shib = C4::Context->config('useshibboleth') && shib_ok();
 167     my $shib_login = $shib ? get_login_shib() : undef;
 168
 169     C4::Context->interface( $in->{type} );
 170
 171     $in->{'authnotrequired'} ||= 0;
 172
 173     # the following call includes a bad template check; might croak
 174     my $template = C4::Templates::gettemplate(
 175         $in->{'template_name'},
 176         $in->{'type'},
 177         $in->{'query'},
 178     );
 179
 180     if ( $in->{'template_name'} !~ m/maintenance/ ) {
 181         ( $user, $cookie, $sessionID, $flags ) = checkauth(
 182             $in->{'query'},
 183             $in->{'authnotrequired'},
 184             $in->{'flagsrequired'},
 185             $in->{'type'},
 186             undef,
 187             $in->{template_name},
 188         );
 189     }
 190
 191     # If we enforce GDPR and the user did not consent, redirect
 192     # Exceptions for consent page itself and SCI/SCO system
 193     if( $in->{type} eq 'opac' && $user &&
 194         $in->{'template_name'} !~ /^(opac-patron-consent|sc[io]\/)/ &&
 195         C4::Context->preference('GDPR_Policy') eq 'Enforced' )
 196     {
 197         my $consent = Koha::Patron::Consents->search({
 198             borrowernumber => getborrowernumber($user),
 199             type => 'GDPR_PROCESSING',
 200             given_on => { '!=', undef },
 201         })->next;
 202         if( !$consent ) {
 203             print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
 204             safe_exit;
 205         }
 206     }
 207
 208     if ( $in->{type} eq 'opac' && $user ) {
 209         my $is_sco_user;
 210         if ($sessionID){
 211             my $session = get_session($sessionID);
 212             if ($session){
 213                 $is_sco_user = $session->param('sco_user');
 214             }
 215         }
 216         my $kick_out;
 217
 218         if (
 219 # If the user logged in is the SCO user and they try to go out of the SCO module,
 220 # log the user out removing the CGISESSID cookie
 221             $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
 222             && (
 223                 $is_sco_user ||
 224                 (
 225                     C4::Context->preference('AutoSelfCheckID')
 226                     && $user eq C4::Context->preference('AutoSelfCheckID')
 227                 )
 228             )
 229           )
 230         {
 231             $kick_out = 1;
 232         }
 233         elsif (
 234 # If the user logged in is the SCI user and they try to go out of the SCI module,
 235 # kick them out unless it is SCO with a valid permission
 236 # or they are a superlibrarian
 237                $in->{template_name} !~ m|sci/|
 238             && haspermission( $user, { self_check => 'self_checkin_module' } )
 239             && !(
 240                 $in->{template_name} =~ m|sco/| && haspermission(
 241                     $user, { self_check => 'self_checkout_module' }
 242                 )
 243             )
 244             && $flags && $flags->{superlibrarian} != 1
 245           )
 246         {
 247             $kick_out = 1;
 248         }
 249
 250         if ($kick_out) {
 251             $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
 252                 $in->{query} );
 253             $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
 254                 -name     => 'CGISESSID',
 255                 -value    => '',
 256                 -HttpOnly => 1,
 257                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 258                 -sameSite => 'Lax',
 259             ));
 260
 261             $template->param(
 262                 loginprompt => 1,
 263                 script_name => get_script_name(),
 264             );
 265
 266             print $in->{query}->header(
 267                 {
 268                     type              => 'text/html',
 269                     charset           => 'utf-8',
 270                     cookie            => $cookie,
 271                     'X-Frame-Options' => 'SAMEORIGIN'
 272                 }
 273               ),
 274               $template->output;
 275             safe_exit;
 276         }
 277     }
 278
 279     my $borrowernumber;
 280     if ($user) {
 281
 282         # It's possible for $user to be the borrowernumber if they don't have a
 283         # userid defined (and are logging in through some other method, such
 284         # as SSL certs against an email address)
 285         my $patron;
 286         $borrowernumber = getborrowernumber($user) if defined($user);
 287         if ( !defined($borrowernumber) && defined($user) ) {
 288             $patron = Koha::Patrons->find( $user );
 289             if ($patron) {
 290                 $borrowernumber = $user;
 291
 292                 # A bit of a hack, but I don't know there's a nicer way
 293                 # to do it.
 294                 $user = $patron->firstname . ' ' . $patron->surname;
 295             }
 296         } else {
 297             $patron = Koha::Patrons->find( $borrowernumber );
 298             # FIXME What to do if $patron does not exist?
 299         }
 300
 301         # user info
 302         $template->param( loggedinusername   => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
 303         $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
 304         $template->param( logged_in_user     => $patron );
 305         $template->param( sessionID          => $sessionID );
 306
 307         if ( $in->{'type'} eq 'opac' ) {
 308             require Koha::Virtualshelves;
 309             my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
 310                 {
 311                     borrowernumber => $borrowernumber,
 312                     public         => 0,
 313                 }
 314             );
 315             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 316                 {
 317                     public => 1,
 318                 }
 319             );
 320             $template->param(
 321                 some_private_shelves => $some_private_shelves,
 322                 some_public_shelves  => $some_public_shelves,
 323             );
 324         }
 325
 326         my $all_perms = get_all_subpermissions();
 327
 328         my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
 329           editcatalogue updatecharges tools editauthorities serials reports acquisition clubs problem_reports);
 330
 331         # We are going to use the $flags returned by checkauth
 332         # to create the template's parameters that will indicate
 333         # which menus the user can access.
 334         if ( $flags && $flags->{superlibrarian} == 1 ) {
 335             $template->param( CAN_user_circulate        => 1 );
 336             $template->param( CAN_user_catalogue        => 1 );
 337             $template->param( CAN_user_parameters       => 1 );
 338             $template->param( CAN_user_borrowers        => 1 );
 339             $template->param( CAN_user_permissions      => 1 );
 340             $template->param( CAN_user_reserveforothers => 1 );
 341             $template->param( CAN_user_editcatalogue    => 1 );
 342             $template->param( CAN_user_updatecharges    => 1 );
 343             $template->param( CAN_user_acquisition      => 1 );
 344             $template->param( CAN_user_suggestions      => 1 );
 345             $template->param( CAN_user_tools            => 1 );
 346             $template->param( CAN_user_editauthorities  => 1 );
 347             $template->param( CAN_user_serials          => 1 );
 348             $template->param( CAN_user_reports          => 1 );
 349             $template->param( CAN_user_staffaccess      => 1 );
 350             $template->param( CAN_user_coursereserves   => 1 );
 351             $template->param( CAN_user_plugins          => 1 );
 352             $template->param( CAN_user_lists            => 1 );
 353             $template->param( CAN_user_clubs            => 1 );
 354             $template->param( CAN_user_ill              => 1 );
 355             $template->param( CAN_user_stockrotation    => 1 );
 356             $template->param( CAN_user_cash_management  => 1 );
 357             $template->param( CAN_user_problem_reports  => 1 );
 358             $template->param( CAN_user_recalls          => 1 );
 359
 360             foreach my $module ( keys %$all_perms ) {
 361                 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 362                     $template->param( "CAN_user_${module}_${subperm}" => 1 );
 363                 }
 364             }
 365         }
 366
 367         if ($flags) {
 368             foreach my $module ( keys %$all_perms ) {
 369                 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
 370                     foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
 371                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 372                     }
 373                 } elsif ( ref( $flags->{$module} ) ) {
 374                     foreach my $subperm ( keys %{ $flags->{$module} } ) {
 375                         $template->param( "CAN_user_${module}_${subperm}" => 1 );
 376                     }
 377                 }
 378             }
 379         }
 380
 381         if ($flags) {
 382             foreach my $module ( keys %$flags ) {
 383                 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
 384                     $template->param( "CAN_user_$module" => 1 );
 385                 }
 386             }
 387         }
 388
 389         # Logged-in opac search history
 390         # If the requested template is an opac one and opac search history is enabled
 391         if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
 392             my $dbh   = C4::Context->dbh;
 393             my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
 394             my $sth   = $dbh->prepare($query);
 395             $sth->execute($borrowernumber);
 396
 397             # If at least one search has already been performed
 398             if ( $sth->fetchrow_array > 0 ) {
 399
 400                 # We show the link in opac
 401                 $template->param( EnableOpacSearchHistory => 1 );
 402             }
 403             if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
 404             {
 405                 # And if there are searches performed when the user was not logged in,
 406                 # we add them to the logged-in search history
 407                 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 408                 if (@recentSearches) {
 409                     my $query = q{
 410                         INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type,  total, time )
 411                         VALUES (?, ?, ?, ?, ?, ?, ?)
 412                     };
 413                     my $sth = $dbh->prepare($query);
 414                     $sth->execute( $borrowernumber,
 415                         $in->{query}->cookie("CGISESSID"),
 416                         $_->{query_desc},
 417                         $_->{query_cgi},
 418                         $_->{type} || 'biblio',
 419                         $_->{total},
 420                         $_->{time},
 421                     ) foreach @recentSearches;
 422
 423                     # clear out the search history from the session now that
 424                     # we've saved it to the database
 425                  }
 426               }
 427               C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
 428
 429         } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
 430             $template->param( EnableSearchHistory => 1 );
 431         }
 432     }
 433     else {    # if this is an anonymous session, setup to display public lists...
 434
 435         # If shibboleth is enabled, and we're in an anonymous session, we should allow
 436         # the user to attempt login via shibboleth.
 437         if ($shib) {
 438             $template->param( shibbolethAuthentication => $shib,
 439                 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
 440             );
 441
 442             # If shibboleth is enabled and we have a shibboleth login attribute,
 443             # but we are in an anonymous session, then we clearly have an invalid
 444             # shibboleth koha account.
 445             if ($shib_login) {
 446                 $template->param( invalidShibLogin => '1' );
 447             }
 448         }
 449
 450         $template->param( sessionID => $sessionID );
 451
 452         if ( $in->{'type'} eq 'opac' ){
 453             require Koha::Virtualshelves;
 454             my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
 455                 {
 456                     public => 1,
 457                 }
 458             );
 459             $template->param(
 460                 some_public_shelves  => $some_public_shelves,
 461             );
 462
 463             # Set default branch if one has been passed by the environment.
 464             $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
 465         }
 466     }
 467
 468     # Sysprefs disabled via URL param
 469     # Note that value must be defined in order to override via ENV
 470     foreach my $syspref (
 471         qw(
 472             OPACUserCSS
 473             OPACUserJS
 474             IntranetUserCSS
 475             IntranetUserJS
 476             OpacAdditionalStylesheet
 477             opaclayoutstylesheet
 478             intranetcolorstylesheet
 479             intranetstylesheet
 480         )
 481       )
 482     {
 483         $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
 484           if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
 485     }
 486
 487     # Anonymous opac search history
 488     # If opac search history is enabled and at least one search has already been performed
 489     if ( C4::Context->preference('EnableOpacSearchHistory') ) {
 490         my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
 491         if (@recentSearches) {
 492             $template->param( EnableOpacSearchHistory => 1 );
 493         }
 494     }
 495
 496     if ( C4::Context->preference('dateformat') ) {
 497         $template->param( dateformat => C4::Context->preference('dateformat') );
 498     }
 499
 500     $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
 501
 502     # these template parameters are set the same regardless of $in->{'type'}
 503
 504     my $minPasswordLength = C4::Context->preference('minPasswordLength');
 505     $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
 506     $template->param(
 507         EnhancedMessagingPreferences                                       => C4::Context->preference('EnhancedMessagingPreferences'),
 508         GoogleJackets                                                      => C4::Context->preference("GoogleJackets"),
 509         OpenLibraryCovers                                                  => C4::Context->preference("OpenLibraryCovers"),
 510         KohaAdminEmailAddress                                              => "" . C4::Context->preference("KohaAdminEmailAddress"),
 511         LoginFirstname  => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
 512         LoginSurname    => C4::Context->userenv ? C4::Context->userenv->{"surname"}      : "Inconnu",
 513         emailaddress    => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
 514         TagsEnabled     => C4::Context->preference("TagsEnabled"),
 515         hide_marc       => C4::Context->preference("hide_marc"),
 516         item_level_itypes  => C4::Context->preference('item-level_itypes'),
 517         patronimages       => C4::Context->preference("patronimages"),
 518         singleBranchMode   => ( Koha::Libraries->search->count == 1 ),
 519         noItemTypeImages   => C4::Context->preference("noItemTypeImages"),
 520         marcflavour        => C4::Context->preference("marcflavour"),
 521         OPACBaseURL        => C4::Context->preference('OPACBaseURL'),
 522         minPasswordLength  => $minPasswordLength,
 523     );
 524     if ( $in->{'type'} eq "intranet" ) {
 525         $template->param(
 526             AmazonCoverImages                                                          => C4::Context->preference("AmazonCoverImages"),
 527             AutoLocation                                                               => C4::Context->preference("AutoLocation"),
 528             PatronAutoComplete                                                         => C4::Context->preference("PatronAutoComplete"),
 529             FRBRizeEditions                                                            => C4::Context->preference("FRBRizeEditions"),
 530             IndependentBranches                                                        => C4::Context->preference("IndependentBranches"),
 531             IntranetNav                                                                => C4::Context->preference("IntranetNav"),
 532             IntranetmainUserblock                                                      => C4::Context->preference("IntranetmainUserblock"),
 533             LibraryName                                                                => C4::Context->preference("LibraryName"),
 534             advancedMARCEditor                                                         => C4::Context->preference("advancedMARCEditor"),
 535             canreservefromotherbranches                                                => C4::Context->preference('canreservefromotherbranches'),
 536             intranetcolorstylesheet                                                    => C4::Context->preference("intranetcolorstylesheet"),
 537             IntranetFavicon                                                            => C4::Context->preference("IntranetFavicon"),
 538             intranetreadinghistory                                                     => C4::Context->preference("intranetreadinghistory"),
 539             intranetstylesheet                                                         => C4::Context->preference("intranetstylesheet"),
 540             IntranetUserCSS                                                            => C4::Context->preference("IntranetUserCSS"),
 541             IntranetUserJS                                                             => C4::Context->preference("IntranetUserJS"),
 542             suggestion                                                                 => C4::Context->preference("suggestion"),
 543             virtualshelves                                                             => C4::Context->preference("virtualshelves"),
 544             StaffSerialIssueDisplayCount                                               => C4::Context->preference("StaffSerialIssueDisplayCount"),
 545             EasyAnalyticalRecords                                                      => C4::Context->preference('EasyAnalyticalRecords'),
 546             LocalCoverImages                                                           => C4::Context->preference('LocalCoverImages'),
 547             OPACLocalCoverImages                                                       => C4::Context->preference('OPACLocalCoverImages'),
 548             AllowMultipleCovers                                                        => C4::Context->preference('AllowMultipleCovers'),
 549             EnableBorrowerFiles                                                        => C4::Context->preference('EnableBorrowerFiles'),
 550             UseCourseReserves                                                          => C4::Context->preference("UseCourseReserves"),
 551             useDischarge                                                               => C4::Context->preference('useDischarge'),
 552             pending_checkout_notes                                                     => Koha::Checkouts->search({ noteseen => 0 }),
 553             plugins_enabled                                                            => C4::Context->config("enable_plugins"),
 554         );
 555     }
 556     else {
 557         warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
 558
 559         #TODO : replace LibraryName syspref with 'system name', and remove this html processing
 560         my $LibraryNameTitle = C4::Context->preference("LibraryName");
 561         $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
 562         $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
 563
 564         # clean up the busc param in the session
 565         # if the page is not opac-detail and not the "add to list" page
 566         # and not the "edit comments" page
 567         if ( C4::Context->preference("OpacBrowseResults")
 568             && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
 569             my $pagename = $1;
 570             unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
 571                 or $pagename =~ /^showmarc$/
 572                 or $pagename =~ /^addbybiblionumber$/
 573                 or $pagename =~ /^review$/ )
 574             {
 575                 my $sessionSearch = get_session( $sessionID );
 576                 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
 577             }
 578         }
 579
 580         # variables passed from CGI: opac_css_override and opac_search_limits.
 581         my $opac_search_limit   = $ENV{'OPAC_SEARCH_LIMIT'};
 582         my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
 583         my $opac_name           = '';
 584         if (
 585             ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
 586             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
 587             ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
 588           ) {
 589             $opac_name = $1;    # opac_search_limit is a branch, so we use it.
 590         } elsif ( $in->{'query'}->param('multibranchlimit') ) {
 591             $opac_name = $in->{'query'}->param('multibranchlimit');
 592         } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
 593             $opac_name = C4::Context->userenv->{'branch'};
 594         }
 595
 596         my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
 597         $template->param(
 598             AnonSuggestions                       => "" . C4::Context->preference("AnonSuggestions"),
 599             LibrarySearchGroups                   => \@search_groups,
 600             opac_name                             => $opac_name,
 601             LibraryName                           => "" . C4::Context->preference("LibraryName"),
 602             LibraryNameTitle                      => "" . $LibraryNameTitle,
 603             OPACAmazonCoverImages                 => C4::Context->preference("OPACAmazonCoverImages"),
 604             OPACFRBRizeEditions                   => C4::Context->preference("OPACFRBRizeEditions"),
 605             OpacHighlightedWords                  => C4::Context->preference("OpacHighlightedWords"),
 606             OPACShelfBrowser                      => "" . C4::Context->preference("OPACShelfBrowser"),
 607             OPACURLOpenInNewWindow                => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
 608             OPACUserCSS                           => "" . C4::Context->preference("OPACUserCSS"),
 609             OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
 610             opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
 611             opac_search_limit                     => $opac_search_limit,
 612             opac_limit_override                   => $opac_limit_override,
 613             OpacBrowser                           => C4::Context->preference("OpacBrowser"),
 614             OpacCloud                             => C4::Context->preference("OpacCloud"),
 615             OpacKohaUrl                           => C4::Context->preference("OpacKohaUrl"),
 616             OpacPasswordChange                    => C4::Context->preference("OpacPasswordChange"),
 617             OPACPatronDetails                     => C4::Context->preference("OPACPatronDetails"),
 618             OPACPrivacy                           => C4::Context->preference("OPACPrivacy"),
 619             OPACFinesTab                          => C4::Context->preference("OPACFinesTab"),
 620             OpacTopissue                          => C4::Context->preference("OpacTopissue"),
 621             'Version'                             => C4::Context->preference('Version'),
 622             hidelostitems                         => C4::Context->preference("hidelostitems"),
 623             mylibraryfirst                        => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
 624             opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
 625             OpacFavicon                           => C4::Context->preference("OpacFavicon"),
 626             opaclanguagesdisplay                  => "" . C4::Context->preference("opaclanguagesdisplay"),
 627             opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
 628             OPACUserJS                            => C4::Context->preference("OPACUserJS"),
 629             opacuserlogin                         => "" . C4::Context->preference("opacuserlogin"),
 630             OpenLibrarySearch                     => C4::Context->preference("OpenLibrarySearch"),
 631             ShowReviewer                          => C4::Context->preference("ShowReviewer"),
 632             ShowReviewerPhoto                     => C4::Context->preference("ShowReviewerPhoto"),
 633             suggestion                            => "" . C4::Context->preference("suggestion"),
 634             virtualshelves                        => "" . C4::Context->preference("virtualshelves"),
 635             OPACSerialIssueDisplayCount           => C4::Context->preference("OPACSerialIssueDisplayCount"),
 636             SyndeticsClientCode                   => C4::Context->preference("SyndeticsClientCode"),
 637             SyndeticsEnabled                      => C4::Context->preference("SyndeticsEnabled"),
 638             SyndeticsCoverImages                  => C4::Context->preference("SyndeticsCoverImages"),
 639             SyndeticsTOC                          => C4::Context->preference("SyndeticsTOC"),
 640             SyndeticsSummary                      => C4::Context->preference("SyndeticsSummary"),
 641             SyndeticsEditions                     => C4::Context->preference("SyndeticsEditions"),
 642             SyndeticsExcerpt                      => C4::Context->preference("SyndeticsExcerpt"),
 643             SyndeticsReviews                      => C4::Context->preference("SyndeticsReviews"),
 644             SyndeticsAuthorNotes                  => C4::Context->preference("SyndeticsAuthorNotes"),
 645             SyndeticsAwards                       => C4::Context->preference("SyndeticsAwards"),
 646             SyndeticsSeries                       => C4::Context->preference("SyndeticsSeries"),
 647             SyndeticsCoverImageSize               => C4::Context->preference("SyndeticsCoverImageSize"),
 648             OPACLocalCoverImages                  => C4::Context->preference("OPACLocalCoverImages"),
 649             PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
 650             PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
 651             useDischarge                 => C4::Context->preference('useDischarge'),
 652         );
 653
 654         $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
 655     }
 656
 657     # Check if we were asked using parameters to force a specific language
 658     if ( defined $in->{'query'}->param('language') ) {
 659
 660         # Extract the language, let C4::Languages::getlanguage choose
 661         # what to do
 662         my $language = C4::Languages::getlanguage( $in->{'query'} );
 663         my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
 664         $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
 665     }
 666
 667     return ( $template, $borrowernumber, $cookie, $flags );
 668 }
 669
 670 =head2 checkauth
 671
 672   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 673
 674 Verifies that the user is authorized to run this script.  If
 675 the user is authorized, a (userid, cookie, session-id, flags)
 676 quadruple is returned.  If the user is not authorized but does
 677 not have the required privilege (see $flagsrequired below), it
 678 displays an error page and exits.  Otherwise, it displays the
 679 login page and exits.
 680
 681 Note that C<&checkauth> will return if and only if the user
 682 is authorized, so it should be called early on, before any
 683 unfinished operations (e.g., if you've opened a file, then
 684 C<&checkauth> won't close it for you).
 685
 686 C<$query> is the CGI object for the script calling C<&checkauth>.
 687
 688 The C<$noauth> argument is optional. If it is set, then no
 689 authorization is required for the script.
 690
 691 C<&checkauth> fetches user and session information from C<$query> and
 692 ensures that the user is authorized to run scripts that require
 693 authorization.
 694
 695 The C<$flagsrequired> argument specifies the required privileges
 696 the user must have if the username and password are correct.
 697 It should be specified as a reference-to-hash; keys in the hash
 698 should be the "flags" for the user, as specified in the Members
 699 intranet module. Any key specified must correspond to a "flag"
 700 in the userflags table. E.g., { circulate => 1 } would specify
 701 that the user must have the "circulate" privilege in order to
 702 proceed. To make sure that access control is correct, the
 703 C<$flagsrequired> parameter must be specified correctly.
 704
 705 Koha also has a concept of sub-permissions, also known as
 706 granular permissions.  This makes the value of each key
 707 in the C<flagsrequired> hash take on an additional
 708 meaning, i.e.,
 709
 710  1
 711
 712 The user must have access to all subfunctions of the module
 713 specified by the hash key.
 714
 715  *
 716
 717 The user must have access to at least one subfunction of the module
 718 specified by the hash key.
 719
 720  specific permission, e.g., 'export_catalog'
 721
 722 The user must have access to the specific subfunction list, which
 723 must correspond to a row in the permissions table.
 724
 725 The C<$type> argument specifies whether the template should be
 726 retrieved from the opac or intranet directory tree.  "opac" is
 727 assumed if it is not specified; however, if C<$type> is specified,
 728 "intranet" is assumed if it is not "opac".
 729
 730 If C<$query> does not have a valid session ID associated with it
 731 (i.e., the user has not logged in) or if the session has expired,
 732 C<&checkauth> presents the user with a login page (from the point of
 733 view of the original script, C<&checkauth> does not return). Once the
 734 user has authenticated, C<&checkauth> restarts the original script
 735 (this time, C<&checkauth> returns).
 736
 737 The login page is provided using a HTML::Template, which is set in the
 738 systempreferences table or at the top of this file. The variable C<$type>
 739 selects which template to use, either the opac or the intranet
 740 authentification template.
 741
 742 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 743 cookie should be sent back to the browser; it verifies that the user
 744 has authenticated.
 745
 746 =cut
 747
 748 sub _version_check {
 749     my $type  = shift;
 750     my $query = shift;
 751     my $version;
 752
 753     # If version syspref is unavailable, it means Koha is being installed,
 754     # and so we must redirect to OPAC maintenance page or to the WebInstaller
 755     # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
 756     if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
 757         warn "OPAC Install required, redirecting to maintenance";
 758         print $query->redirect("/cgi-bin/koha/maintenance.pl");
 759         safe_exit;
 760     }
 761     unless ( $version = C4::Context->preference('Version') ) {    # assignment, not comparison
 762         if ( $type ne 'opac' ) {
 763             warn "Install required, redirecting to Installer";
 764             print $query->redirect("/cgi-bin/koha/installer/install.pl");
 765         } else {
 766             warn "OPAC Install required, redirecting to maintenance";
 767             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 768         }
 769         safe_exit;
 770     }
 771
 772     # check that database and koha version are the same
 773     # there is no DB version, it's a fresh install,
 774     # go to web installer
 775     # there is a DB version, compare it to the code version
 776     my $kohaversion = Koha::version();
 777
 778     # remove the 3 last . to have a Perl number
 779     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
 780     Koha::Logger->get->debug("kohaversion : $kohaversion");
 781     if ( $version < $kohaversion ) {
 782         my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
 783         if ( $type ne 'opac' ) {
 784             warn sprintf( $warning, 'Installer' );
 785             print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
 786         } else {
 787             warn sprintf( "OPAC: " . $warning, 'maintenance' );
 788             print $query->redirect("/cgi-bin/koha/maintenance.pl");
 789         }
 790         safe_exit;
 791     }
 792 }
 793
 794 sub _timeout_syspref {
 795     my $default_timeout = 600;
 796     my $timeout = C4::Context->preference('timeout') || $default_timeout;
 797
 798     # value in days, convert in seconds
 799     if ( $timeout =~ /^(\d+)[dD]$/ ) {
 800         $timeout = $1 * 86400;
 801     }
 802     # value in hours, convert in seconds
 803     elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
 804         $timeout = $1 * 3600;
 805     }
 806     elsif ( $timeout !~ m/^\d+$/ ) {
 807         warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
 808         $timeout = $default_timeout;
 809     }
 810
 811     return $timeout;
 812 }
 813
 814 sub checkauth {
 815     my $query = shift;
 816
 817     # Get shibboleth login attribute
 818     my $shib = C4::Context->config('useshibboleth') && shib_ok();
 819     my $shib_login = $shib ? get_login_shib() : undef;
 820
 821     # $authnotrequired will be set for scripts which will run without authentication
 822     my $authnotrequired = shift;
 823     my $flagsrequired   = shift;
 824     my $type            = shift;
 825     my $emailaddress    = shift;
 826     my $template_name   = shift;
 827     my $params          = shift || {};    # do_not_print
 828     $type = 'opac' unless $type;
 829
 830     if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
 831         my @allowed_scripts_for_private_opac = qw(
 832           opac-memberentry.tt
 833           opac-registration-email-sent.tt
 834           opac-registration-confirmation.tt
 835           opac-memberentry-update-submitted.tt
 836           opac-password-recovery.tt
 837           opac-reset-password.tt
 838         );
 839         $authnotrequired = 0 unless grep { $_ eq $template_name }
 840           @allowed_scripts_for_private_opac;
 841     }
 842
 843     my $timeout = _timeout_syspref();
 844
 845     my $cookie_mgr = Koha::CookieManager->new;
 846
 847     _version_check( $type, $query );
 848
 849     # state variables
 850     my $auth_state = 'failed';
 851     my %info;
 852     my ( $userid, $cookie, $sessionID, $flags );
 853     $cookie = [];
 854     my $logout = $query->param('logout.x');
 855
 856     my $anon_search_history;
 857     my $cas_ticket = '';
 858     # This parameter is the name of the CAS server we want to authenticate against,
 859     # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
 860     my $casparam = $query->param('cas');
 861     my $q_userid = $query->param('userid') // '';
 862
 863     my $session;
 864     my $invalid_otp_token;
 865     my $require_2FA = ( C4::Context->preference('TwoFactorAuthentication') && $type ne "opac" ) ? 1 : 0;
 866
 867     # Basic authentication is incompatible with the use of Shibboleth,
 868     # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
 869     # and it may not be the attribute we want to use to match the koha login.
 870     #
 871     # Also, do not consider an empty REMOTE_USER.
 872     #
 873     # Finally, after those tests, we can assume (although if it would be better with
 874     # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
 875     # and we can affect it to $userid.
 876     if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
 877
 878         # Using Basic Authentication, no cookies required
 879         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 880             -name     => 'CGISESSID',
 881             -value    => '',
 882             -HttpOnly => 1,
 883             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 884             -sameSite => 'Lax',
 885         ));
 886     }
 887     elsif ( $emailaddress) {
 888         # the Google OpenID Connect passes an email address
 889     }
 890     elsif ( $sessionID = $query->cookie("CGISESSID") ) {    # assignment, not comparison
 891         my ( $return, $more_info );
 892         # NOTE: $flags in the following call is still undefined !
 893         ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
 894             { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
 895         );
 896
 897         if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
 898             $userid = $session->param('id');
 899         }
 900
 901         $auth_state =
 902             $return eq 'ok'                     ? 'completed'
 903           : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
 904           :                                       'failed';
 905
 906         # We are at the second screen if the waiting-for-2FA is set in session
 907         # and otp_token param has been passed
 908         if (   $require_2FA
 909             && $auth_state eq 'additional-auth-needed'
 910             && ( my $otp_token = $query->param('otp_token') ) )
 911         {
 912             my $patron    = Koha::Patrons->find( { userid => $userid } );
 913             my $auth      = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
 914             my $verified = $auth->verify($otp_token, 1);
 915             $auth->clear;
 916             if ( $verified ) {
 917                 # The token is correct, the user is fully logged in!
 918                 $auth_state = 'completed';
 919                 $session->param( 'waiting-for-2FA', 0 );
 920
 921                # This is an ugly trick to pass the test
 922                # $query->param('koha_login_context') && ( $q_userid ne $userid )
 923                # few lines later
 924                 $q_userid = $userid;
 925             }
 926             else {
 927                 $invalid_otp_token = 1;
 928             }
 929         }
 930
 931         if ( $auth_state eq 'completed' ) {
 932             Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
 933
 934             if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
 935                 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
 936                 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
 937             ) {
 938
 939                 #if a user enters an id ne to the id in the current session, we need to log them in...
 940                 #first we need to clear the anonymous session...
 941                 $anon_search_history = $session->param('search_history');
 942                 $session->delete();
 943                 $session->flush;
 944                 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 945                 C4::Context::_unset_userenv($sessionID);
 946                 $sessionID = undef;
 947                 undef $userid; # IMPORTANT: this assures us a new session in code below
 948                 $auth_state = 'failed';
 949             } elsif (!$logout) {
 950
 951                 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 952                     -name     => 'CGISESSID',
 953                     -value    => $session->id,
 954                     -HttpOnly => 1,
 955                     -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 956                     -sameSite => 'Lax',
 957                 ));
 958
 959                 $flags = haspermission( $userid, $flagsrequired );
 960                 unless ( $flags ) {
 961                     $auth_state = 'failed';
 962                     $info{'nopermission'} = 1;
 963                 }
 964             }
 965         } elsif ( !$logout ) {
 966             if ( $return eq 'expired' ) {
 967                 $info{timed_out} = 1;
 968             } elsif ( $return eq 'restricted' ) {
 969                 $info{oldip}        = $more_info->{old_ip};
 970                 $info{newip}        = $more_info->{new_ip};
 971                 $info{different_ip} = 1;
 972             } elsif ( $return eq 'password_expired' ) {
 973                 $info{password_has_expired} = 1;
 974             }
 975         }
 976     }
 977
 978     if ( $auth_state eq 'failed' || $logout ) {
 979         $sessionID = undef;
 980         $userid    = undef;
 981     }
 982
 983     if ($logout) {
 984
 985         # voluntary logout the user
 986         # check wether the user was using their shibboleth session or a local one
 987         my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
 988         if ( $session ) {
 989             $session->delete();
 990             $session->flush;
 991         }
 992         C4::Context::_unset_userenv($sessionID);
 993         $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 994
 995         if ($cas and $caslogout) {
 996             logout_cas($query, $type);
 997         }
 998
 999         # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
1000         if ( $shib and $shib_login and $shibSuccess) {
1001             logout_shib($query);
1002         }
1003
1004         $session   = undef;
1005         $auth_state = 'logout';
1006     }
1007
1008     unless ( $userid ) {
1009         #we initiate a session prior to checking for a username to allow for anonymous sessions...
1010         if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
1011             $session = get_session() or die "Auth ERROR: Cannot get_session()";
1012         }
1013
1014         # Save anonymous search history in new session so it can be retrieved
1015         # by get_template_and_user to store it in user's search history after
1016         # a successful login.
1017         if ($anon_search_history) {
1018             $session->param( 'search_history', $anon_search_history );
1019         }
1020
1021         $sessionID = $session->id;
1022         C4::Context->_new_userenv($sessionID);
1023         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1024             -name     => 'CGISESSID',
1025             -value    => $sessionID,
1026             -HttpOnly => 1,
1027             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1028             -sameSite => 'Lax',
1029         ));
1030         my $pki_field = C4::Context->preference('AllowPKIAuth');
1031         if ( !defined($pki_field) ) {
1032             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1033             $pki_field = 'None';
1034         }
1035         if ( ( $cas && $query->param('ticket') )
1036             || $q_userid
1037             || ( $shib && $shib_login )
1038             || $pki_field ne 'None'
1039             || $emailaddress )
1040         {
1041             my $password    = $query->param('password');
1042             my $shibSuccess = 0;
1043             my ( $return, $cardnumber );
1044
1045             # If shib is enabled and we have a shib login, does the login match a valid koha user
1046             if ( $shib && $shib_login ) {
1047                 my $retuserid;
1048
1049                 # Do not pass password here, else shib will not be checked in checkpw.
1050                 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1051                 $userid      = $retuserid;
1052                 $shibSuccess = $return;
1053                 $info{'invalidShibLogin'} = 1 unless ($return);
1054             }
1055
1056             # If shib login and match were successful, skip further login methods
1057             unless ($shibSuccess) {
1058                 if ( $cas && $query->param('ticket') ) {
1059                     my $retuserid;
1060                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1061                       checkpw( $userid, $password, $query, $type );
1062                     $userid = $retuserid;
1063                     $info{'invalidCasLogin'} = 1 unless ($return);
1064                 }
1065
1066                 elsif ( $emailaddress ) {
1067                     my $value = $emailaddress;
1068
1069                     # If we're looking up the email, there's a chance that the person
1070                     # doesn't have a userid. So if there is none, we pass along the
1071                     # borrower number, and the bits of code that need to know the user
1072                     # ID will have to be smart enough to handle that.
1073                     my $patrons = Koha::Patrons->search({ email => $value });
1074                     if ($patrons->count) {
1075
1076                         # First the userid, then the borrowernum
1077                         my $patron = $patrons->next;
1078                         $value = $patron->userid || $patron->borrowernumber;
1079                     } else {
1080                         undef $value;
1081                     }
1082                     $return = $value ? 1 : 0;
1083                     $userid = $value;
1084                 }
1085
1086                 elsif (
1087                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1088                     || ( $pki_field eq 'emailAddress'
1089                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1090                   )
1091                 {
1092                     my $value;
1093                     if ( $pki_field eq 'Common Name' ) {
1094                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1095                     }
1096                     elsif ( $pki_field eq 'emailAddress' ) {
1097                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1098
1099                         # If we're looking up the email, there's a chance that the person
1100                         # doesn't have a userid. So if there is none, we pass along the
1101                         # borrower number, and the bits of code that need to know the user
1102                         # ID will have to be smart enough to handle that.
1103                         my $patrons = Koha::Patrons->search({ email => $value });
1104                         if ($patrons->count) {
1105
1106                             # First the userid, then the borrowernum
1107                             my $patron = $patrons->next;
1108                             $value = $patron->userid || $patron->borrowernumber;
1109                         } else {
1110                             undef $value;
1111                         }
1112                     }
1113
1114                     $return = $value ? 1 : 0;
1115                     $userid = $value;
1116
1117                 }
1118                 else {
1119                     my $retuserid;
1120                     my $request_method = $query->request_method();
1121
1122                     if (
1123                         $request_method eq 'POST'
1124                         || ( C4::Context->preference('AutoSelfCheckID')
1125                             && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1126                       )
1127                     {
1128
1129                         ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1130                           checkpw( $q_userid, $password, $query, $type );
1131                         $userid = $retuserid if ($retuserid);
1132                         $info{'invalid_username_or_password'} = 1 unless ($return);
1133                     }
1134                 }
1135             }
1136
1137             # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1138             if (
1139                    $shib
1140                 && !$shibSuccess
1141                 && (
1142                     (
1143                         ( $type eq 'opac' )
1144                         && C4::Context->preference('OPACShibOnly')
1145                     )
1146                     || ( ( $type ne 'opac' )
1147                         && C4::Context->preference('staffShibOnly') )
1148                 )
1149               )
1150             {
1151                 $return = 0;
1152             }
1153
1154             # $return: 1 = valid user
1155             if ($return > 0) {
1156
1157                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1158                     $auth_state = "logged_in";
1159                 }
1160                 else {
1161                     $auth_state = 'failed';
1162                     # FIXME We could add $return = 0; or even delete the session?
1163                     # Currently return == 1 and we will fill session info later on,
1164                     # although we do present an authorization failure. (Yes, the
1165                     # authentication was actually correct.)
1166                     $info{'nopermission'} = 1;
1167                     C4::Context::_unset_userenv($sessionID);
1168                 }
1169                 my ( $borrowernumber, $firstname, $surname, $userflags,
1170                     $branchcode, $branchname, $emailaddress, $desk_id,
1171                     $desk_name, $register_id, $register_name );
1172
1173                 if ( $return == 1 ) {
1174                     my $select = "
1175                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1176                     branches.branchname    as branchname, email
1177                     FROM borrowers
1178                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1179                     ";
1180                     my $dbh = C4::Context->dbh;
1181                     my $sth = $dbh->prepare("$select where userid=?");
1182                     $sth->execute($userid);
1183                     unless ( $sth->rows ) {
1184                         $sth = $dbh->prepare("$select where cardnumber=?");
1185                         $sth->execute($cardnumber);
1186
1187                         unless ( $sth->rows ) {
1188                             $sth->execute($userid);
1189                         }
1190                     }
1191                     if ( $sth->rows ) {
1192                         ( $borrowernumber, $firstname, $surname, $userflags,
1193                             $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1194                     }
1195
1196                     # launch a sequence to check if we have a ip for the branch, i
1197                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1198
1199                     my $ip = $ENV{'REMOTE_ADDR'};
1200
1201                     # if they specify at login, use that
1202                     if ( $query->param('branch') ) {
1203                         $branchcode = $query->param('branch');
1204                         my $library = Koha::Libraries->find($branchcode);
1205                         $branchname = $library? $library->branchname: '';
1206                     }
1207                     if ( $query->param('desk_id') ) {
1208                         $desk_id = $query->param('desk_id');
1209                         my $desk = Koha::Desks->find($desk_id);
1210                         $desk_name = $desk ? $desk->desk_name : '';
1211                     }
1212                     if ( C4::Context->preference('UseCashRegisters') ) {
1213                         my $register =
1214                           $query->param('register_id')
1215                           ? Koha::Cash::Registers->find($query->param('register_id'))
1216                           : Koha::Cash::Registers->search(
1217                             { branch => $branchcode, branch_default => 1 },
1218                             { rows   => 1 } )->single;
1219                         $register_id   = $register->id   if ($register);
1220                         $register_name = $register->name if ($register);
1221                     }
1222                     my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1223                     if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1224
1225                         # we have to check they are coming from the right ip range
1226                         my $domain = $branches->{$branchcode}->{'branchip'};
1227                         $domain =~ s|\.\*||g;
1228                         if ( $ip !~ /^$domain/ ) {
1229                             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1230                                 -name     => 'CGISESSID',
1231                                 -value    => '',
1232                                 -HttpOnly => 1,
1233                                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1234                                 -sameSite => 'Lax',
1235                             ));
1236                             $info{'wrongip'} = 1;
1237                             $auth_state = "failed";
1238                         }
1239                     }
1240
1241                     if ( C4::Context->preference('AutoLocation') && $auth_state ne 'failed' ) {
1242                         foreach my $br ( uniq( $branchcode, keys %$branches ) ) {
1243
1244                             #     now we work with the treatment of ip
1245                             my $domain = $branches->{$br}->{'branchip'};
1246                             if ( $domain && $ip =~ /^$domain/ ) {
1247                                 $branchcode = $branches->{$br}->{'branchcode'};
1248
1249                                 # new op dev : add the branchname to the cookie
1250                                 $branchname = $branches->{$br}->{'branchname'};
1251                                 last;
1252                             }
1253                         }
1254                     }
1255
1256                     my $is_sco_user = 0;
1257                     if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1258                         $is_sco_user = 1;
1259                     }
1260
1261                     $session->param( 'number',       $borrowernumber );
1262                     $session->param( 'id',           $userid );
1263                     $session->param( 'cardnumber',   $cardnumber );
1264                     $session->param( 'firstname',    $firstname );
1265                     $session->param( 'surname',      $surname );
1266                     $session->param( 'branch',       $branchcode );
1267                     $session->param( 'branchname',   $branchname );
1268                     $session->param( 'desk_id',      $desk_id);
1269                     $session->param( 'desk_name',     $desk_name);
1270                     $session->param( 'flags',        $userflags );
1271                     $session->param( 'emailaddress', $emailaddress );
1272                     $session->param( 'ip',           $session->remote_addr() );
1273                     $session->param( 'lasttime',     time() );
1274                     $session->param( 'interface',    $type);
1275                     $session->param( 'shibboleth',   $shibSuccess );
1276                     $session->param( 'register_id',  $register_id );
1277                     $session->param( 'register_name',  $register_name );
1278                     $session->param( 'sco_user', $is_sco_user );
1279                 }
1280                 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1281                 C4::Context->set_userenv(
1282                     $session->param('number'),       $session->param('id'),
1283                     $session->param('cardnumber'),   $session->param('firstname'),
1284                     $session->param('surname'),      $session->param('branch'),
1285                     $session->param('branchname'),   $session->param('flags'),
1286                     $session->param('emailaddress'), $session->param('shibboleth'),
1287                     $session->param('desk_id'),      $session->param('desk_name'),
1288                     $session->param('register_id'),  $session->param('register_name')
1289                 );
1290
1291             }
1292             # $return: 0 = invalid user
1293             # reset to anonymous session
1294             else {
1295                 if ($userid) {
1296                     $info{'invalid_username_or_password'} = 1;
1297                     C4::Context::_unset_userenv($sessionID);
1298                 }
1299                 $session->param( 'lasttime', time() );
1300                 $session->param( 'ip',       $session->remote_addr() );
1301                 $session->param( 'sessiontype', 'anon' );
1302                 $session->param( 'interface', $type);
1303             }
1304         }    # END if ( $q_userid
1305         elsif ( $type eq "opac" ) {
1306
1307             # anonymous sessions are created only for the OPAC
1308
1309             # setting a couple of other session vars...
1310             $session->param( 'ip',          $session->remote_addr() );
1311             $session->param( 'lasttime',    time() );
1312             $session->param( 'sessiontype', 'anon' );
1313             $session->param( 'interface', $type);
1314         }
1315         $session->flush;
1316     }    # END unless ($userid)
1317
1318
1319     if ( $auth_state eq 'logged_in' ) {
1320         $auth_state = 'completed';
1321
1322         # Auth is completed unless an additional auth is needed
1323         if ( $require_2FA ) {
1324             my $patron = Koha::Patrons->find({userid => $userid});
1325             if ( $patron->auth_method eq 'two-factor' ) {
1326                 # Ask for the OTP token
1327                 $auth_state = 'additional-auth-needed';
1328                 $session->param('waiting-for-2FA', 1);
1329                 %info = ();# We remove the warnings/errors we may have set incorrectly before
1330             }
1331         }
1332     }
1333
1334     # finished authentification, now respond
1335     if ( $auth_state eq 'completed' || $authnotrequired ) {
1336         # successful login
1337         unless (@$cookie) {
1338             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1339                 -name     => 'CGISESSID',
1340                 -value    => '',
1341                 -HttpOnly => 1,
1342                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1343                 -sameSite => 'Lax',
1344             ));
1345         }
1346
1347         track_login_daily( $userid );
1348
1349         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1350         # request. We therefore redirect the user to the requested page again without the login parameters.
1351         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1352         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1353             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1354             $uri->query_param_delete('userid');
1355             $uri->query_param_delete('password');
1356             $uri->query_param_delete('koha_login_context');
1357             unless ( $params->{do_not_print} ) {
1358                 print $query->redirect( -uri => $uri->as_string, -cookie => $cookie, -status => '303 See other' );
1359                 safe_exit;
1360             }
1361         }
1362
1363         return ( $userid, $cookie, $sessionID, $flags );
1364     }
1365
1366     #
1367     #
1368     # AUTH rejected, show the login/password template, after checking the DB.
1369     #
1370     #
1371
1372     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1373
1374     # get the inputs from the incoming query
1375     my @inputs = ();
1376     my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1377     foreach my $name ( param $query) {
1378         next if grep { $name eq $_ } @inputs_to_clean;
1379         my @value = $query->multi_param($name);
1380         push @inputs, { name => $name, value => $_ } for @value;
1381     }
1382
1383     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1384     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1385     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1386
1387     my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1388     my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1389     $template->param(
1390         login                                 => 1,
1391         INPUTS                                => \@inputs,
1392         script_name                           => get_script_name(),
1393         casAuthentication                     => C4::Context->preference("casAuthentication"),
1394         shibbolethAuthentication              => $shib,
1395         suggestion                            => C4::Context->preference("suggestion"),
1396         virtualshelves                        => C4::Context->preference("virtualshelves"),
1397         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1398         LibraryNameTitle                      => "" . $LibraryNameTitle,
1399         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1400         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1401         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1402         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1403         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1404         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1405         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1406         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1407         IntranetNav                           => C4::Context->preference("IntranetNav"),
1408         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1409         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1410         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1411         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1412         AutoLocation                          => C4::Context->preference("AutoLocation"),
1413         wrongip                               => $info{'wrongip'},
1414         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1415         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1416         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1417         too_many_login_attempts               => ( $patron and $patron->account_locked ),
1418         password_has_expired                  => ( $patron and $patron->password_expired ),
1419     );
1420
1421     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1422     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1423     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1424     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1425     if ( $auth_state eq 'additional-auth-needed' ) {
1426         $template->param(
1427             TwoFA_prompt => 1,
1428             invalid_otp_token => $invalid_otp_token,
1429         );
1430     }
1431
1432     if ( $type eq 'opac' ) {
1433         require Koha::Virtualshelves;
1434         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1435             {
1436                 public => 1,
1437             }
1438         );
1439         $template->param(
1440             some_public_shelves  => $some_public_shelves,
1441         );
1442     }
1443
1444     if ($cas) {
1445
1446         # Is authentication against multiple CAS servers enabled?
1447         require C4::Auth_with_cas;
1448         if ( multipleAuth() && !$casparam ) {
1449             my $casservers = getMultipleAuth();
1450             my @tmplservers;
1451             foreach my $key ( keys %$casservers ) {
1452                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1453             }
1454             $template->param(
1455                 casServersLoop => \@tmplservers
1456             );
1457         } else {
1458             $template->param(
1459                 casServerUrl => login_cas_url($query, undef, $type),
1460             );
1461         }
1462
1463         $template->param(
1464             invalidCasLogin => $info{'invalidCasLogin'}
1465         );
1466     }
1467
1468     if ($shib) {
1469         #If shibOnly is enabled just go ahead and redirect directly
1470         if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1471             my $redirect_url = login_shib_url( $query );
1472             print $query->redirect( -uri => "$redirect_url", -status => 303 );
1473             safe_exit;
1474         }
1475
1476         $template->param(
1477             shibbolethAuthentication => $shib,
1478             shibbolethLoginUrl       => login_shib_url($query),
1479         );
1480     }
1481
1482     if (C4::Context->preference('GoogleOpenIDConnect')) {
1483         if ($query->param("OpenIDConnectFailed")) {
1484             my $reason = $query->param('OpenIDConnectFailed');
1485             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1486         }
1487     }
1488
1489     $template->param(
1490         LibraryName => C4::Context->preference("LibraryName"),
1491     );
1492     $template->param(%info);
1493
1494     if ( $params->{do_not_print} ) {
1495         # This must be used for testing purpose only!
1496         return ( undef, undef, undef, undef, $template );
1497     }
1498
1499     print $query->header(
1500         {   type              => 'text/html',
1501             charset           => 'utf-8',
1502             cookie            => $cookie,
1503             'X-Frame-Options' => 'SAMEORIGIN',
1504             -sameSite => 'Lax'
1505         }
1506       ),
1507       $template->output;
1508     safe_exit;
1509 }
1510
1511 =head2 check_api_auth
1512
1513   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1514
1515 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1516 cookie, determine if the user has the privileges specified by C<$userflags>.
1517
1518 C<check_api_auth> is is meant for authenticating users of web services, and
1519 consequently will always return and will not attempt to redirect the user
1520 agent.
1521
1522 If a valid session cookie is already present, check_api_auth will return a status
1523 of "ok", the cookie, and the Koha session ID.
1524
1525 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1526 parameters and create a session cookie and Koha session if the supplied credentials
1527 are OK.
1528
1529 Possible return values in C<$status> are:
1530
1531 =over
1532
1533 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1534
1535 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1536
1537 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1538
1539 =item "expired -- session cookie has expired; API user should resubmit userid and password
1540
1541 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1542
1543 =item "additional-auth-needed -- User is in an authentication process that is not finished
1544
1545 =back
1546
1547 =cut
1548
1549 sub check_api_auth {
1550
1551     my $query         = shift;
1552     my $flagsrequired = shift;
1553     my $timeout = _timeout_syspref();
1554
1555     unless ( C4::Context->preference('Version') ) {
1556
1557         # database has not been installed yet
1558         return ( "maintenance", undef, undef );
1559     }
1560     my $kohaversion = Koha::version();
1561     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1562     if ( C4::Context->preference('Version') < $kohaversion ) {
1563
1564         # database in need of version update; assume that
1565         # no API should be called while databsae is in
1566         # this condition.
1567         return ( "maintenance", undef, undef );
1568     }
1569
1570     my ( $sessionID, $session );
1571     unless ( $query->param('userid') ) {
1572         $sessionID = $query->cookie("CGISESSID");
1573     }
1574     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1575
1576         my $return;
1577         ( $return, $session, undef ) = check_cookie_auth(
1578             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1579
1580         return ( $return, undef, undef ) # Cookie auth failed
1581             if $return ne "ok";
1582
1583         my $cookie = $query->cookie(
1584             -name     => 'CGISESSID',
1585             -value    => $session->id,
1586             -HttpOnly => 1,
1587             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1588             -sameSite => 'Lax'
1589         );
1590         return ( $return, $cookie, $session ); # return == 'ok' here
1591
1592     } else {
1593
1594         # new login
1595         my $userid   = $query->param('userid');
1596         my $password = $query->param('password');
1597         my ( $return, $cardnumber, $cas_ticket );
1598
1599         # Proxy CAS auth
1600         if ( $cas && $query->param('PT') ) {
1601             my $retuserid;
1602
1603             # In case of a CAS authentication, we use the ticket instead of the password
1604             my $PT = $query->param('PT');
1605             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query );    # EXTERNAL AUTH
1606         } else {
1607
1608             # User / password auth
1609             unless ( $userid and $password ) {
1610
1611                 # caller did something wrong, fail the authenticateion
1612                 return ( "failed", undef, undef );
1613             }
1614             my $newuserid;
1615             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1616         }
1617
1618         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1619             my $session = get_session("");
1620             return ( "failed", undef, undef ) unless $session;
1621
1622             my $sessionID = $session->id;
1623             C4::Context->_new_userenv($sessionID);
1624             my $cookie = $query->cookie(
1625                 -name     => 'CGISESSID',
1626                 -value    => $sessionID,
1627                 -HttpOnly => 1,
1628                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1629                 -sameSite => 'Lax'
1630             );
1631             if ( $return == 1 ) {
1632                 my (
1633                     $borrowernumber, $firstname,  $surname,
1634                     $userflags,      $branchcode, $branchname,
1635                     $emailaddress
1636                 );
1637                 my $dbh = C4::Context->dbh;
1638                 my $sth =
1639                   $dbh->prepare(
1640 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1641                   );
1642                 $sth->execute($userid);
1643                 (
1644                     $borrowernumber, $firstname,  $surname,
1645                     $userflags,      $branchcode, $branchname,
1646                     $emailaddress
1647                 ) = $sth->fetchrow if ( $sth->rows );
1648
1649                 unless ( $sth->rows ) {
1650                     my $sth = $dbh->prepare(
1651 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1652                     );
1653                     $sth->execute($cardnumber);
1654                     (
1655                         $borrowernumber, $firstname,  $surname,
1656                         $userflags,      $branchcode, $branchname,
1657                         $emailaddress
1658                     ) = $sth->fetchrow if ( $sth->rows );
1659
1660                     unless ( $sth->rows ) {
1661                         $sth->execute($userid);
1662                         (
1663                             $borrowernumber, $firstname,  $surname,       $userflags,
1664                             $branchcode,     $branchname, $emailaddress
1665                         ) = $sth->fetchrow if ( $sth->rows );
1666                     }
1667                 }
1668
1669                 my $ip = $ENV{'REMOTE_ADDR'};
1670
1671                 # if they specify at login, use that
1672                 if ( $query->param('branch') ) {
1673                     $branchcode = $query->param('branch');
1674                     my $library = Koha::Libraries->find($branchcode);
1675                     $branchname = $library? $library->branchname: '';
1676                 }
1677                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1678                 foreach my $br ( keys %$branches ) {
1679
1680                     #     now we work with the treatment of ip
1681                     my $domain = $branches->{$br}->{'branchip'};
1682                     if ( $domain && $ip =~ /^$domain/ ) {
1683                         $branchcode = $branches->{$br}->{'branchcode'};
1684
1685                         # new op dev : add the branchname to the cookie
1686                         $branchname    = $branches->{$br}->{'branchname'};
1687                     }
1688                 }
1689                 $session->param( 'number',       $borrowernumber );
1690                 $session->param( 'id',           $userid );
1691                 $session->param( 'cardnumber',   $cardnumber );
1692                 $session->param( 'firstname',    $firstname );
1693                 $session->param( 'surname',      $surname );
1694                 $session->param( 'branch',       $branchcode );
1695                 $session->param( 'branchname',   $branchname );
1696                 $session->param( 'flags',        $userflags );
1697                 $session->param( 'emailaddress', $emailaddress );
1698                 $session->param( 'ip',           $session->remote_addr() );
1699                 $session->param( 'lasttime',     time() );
1700                 $session->param( 'interface',    'api'  );
1701             }
1702             $session->param( 'cas_ticket', $cas_ticket);
1703             C4::Context->set_userenv(
1704                 $session->param('number'),       $session->param('id'),
1705                 $session->param('cardnumber'),   $session->param('firstname'),
1706                 $session->param('surname'),      $session->param('branch'),
1707                 $session->param('branchname'),   $session->param('flags'),
1708                 $session->param('emailaddress'), $session->param('shibboleth'),
1709                 $session->param('desk_id'),      $session->param('desk_name'),
1710                 $session->param('register_id'),  $session->param('register_name')
1711             );
1712             return ( "ok", $cookie, $sessionID );
1713         } else {
1714             return ( "failed", undef, undef );
1715         }
1716     }
1717 }
1718
1719 =head2 check_cookie_auth
1720
1721   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1722
1723 Given a CGISESSID cookie set during a previous login to Koha, determine
1724 if the user has the privileges specified by C<$userflags>. C<$userflags>
1725 is passed unaltered into C<haspermission> and as such accepts all options
1726 avaiable to that routine with the one caveat that C<check_api_auth> will
1727 also allow 'undef' to be passed and in such a case the permissions check
1728 will be skipped altogether.
1729
1730 C<check_cookie_auth> is meant for authenticating special services
1731 such as tools/upload-file.pl that are invoked by other pages that
1732 have been authenticated in the usual way.
1733
1734 Possible return values in C<$status> are:
1735
1736 =over
1737
1738 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1739
1740 =item "anon" -- user not authenticated but valid for anonymous session.
1741
1742 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1743
1744 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1745
1746 =item "expired -- session cookie has expired; API user should resubmit userid and password
1747
1748 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1749
1750 =back
1751
1752 =cut
1753
1754 sub check_cookie_auth {
1755     my $sessionID     = shift;
1756     my $flagsrequired = shift;
1757     my $params        = shift;
1758
1759     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1760
1761     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1762
1763     unless ( $skip_version_check ) {
1764         unless ( C4::Context->preference('Version') ) {
1765
1766             # database has not been installed yet
1767             return ( "maintenance", undef );
1768         }
1769         my $kohaversion = Koha::version();
1770         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1771         if ( C4::Context->preference('Version') < $kohaversion ) {
1772
1773             # database in need of version update; assume that
1774             # no API should be called while databsae is in
1775             # this condition.
1776             return ( "maintenance", undef );
1777         }
1778     }
1779
1780     # see if we have a valid session cookie already
1781     # however, if a userid parameter is present (i.e., from
1782     # a form submission, assume that any current cookie
1783     # is to be ignored
1784     unless ( $sessionID ) {
1785         return ( "failed", undef );
1786     }
1787     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1788     my $session   = get_session($sessionID);
1789     if ($session) {
1790         my $userid   = $session->param('id');
1791         my $ip       = $session->param('ip');
1792         my $lasttime = $session->param('lasttime');
1793         my $timeout = _timeout_syspref();
1794
1795         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1796             # time out
1797             $session->delete();
1798             $session->flush;
1799             return ("expired", undef);
1800
1801         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1802             # IP address changed
1803             $session->delete();
1804             $session->flush;
1805             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1806
1807         } elsif ( $userid ) {
1808             $session->param( 'lasttime', time() );
1809             my $patron = Koha::Patrons->find({ userid => $userid });
1810             $patron = Koha::Patron->find({ cardnumber => $userid }) unless $patron;
1811             return ("password_expired", undef ) if $patron->password_expired;
1812             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1813             if ($flags) {
1814                 C4::Context->_new_userenv($sessionID);
1815                 C4::Context->interface($session->param('interface'));
1816                 C4::Context->set_userenv(
1817                     $session->param('number'),       $session->param('id') // '',
1818                     $session->param('cardnumber'),   $session->param('firstname'),
1819                     $session->param('surname'),      $session->param('branch'),
1820                     $session->param('branchname'),   $session->param('flags'),
1821                     $session->param('emailaddress'), $session->param('shibboleth'),
1822                     $session->param('desk_id'),      $session->param('desk_name'),
1823                     $session->param('register_id'),  $session->param('register_name')
1824                 );
1825                 return ( "additional-auth-needed", $session )
1826                     if $session->param('waiting-for-2FA');
1827
1828                 return ( "ok", $session );
1829             } else {
1830                 $session->delete();
1831                 $session->flush;
1832                 return ( "failed", undef );
1833             }
1834
1835         } else {
1836             C4::Context->_new_userenv($sessionID);
1837             C4::Context->interface($session->param('interface'));
1838             C4::Context->set_userenv( undef, q{} );
1839             return ( "anon", $session );
1840         }
1841     } else {
1842         return ( "expired", undef );
1843     }
1844 }
1845
1846 =head2 get_session
1847
1848   use CGI::Session;
1849   my $session = get_session($sessionID);
1850
1851 Given a session ID, retrieve the CGI::Session object used to store
1852 the session's state.  The session object can be used to store
1853 data that needs to be accessed by different scripts during a
1854 user's session.
1855
1856 If the C<$sessionID> parameter is an empty string, a new session
1857 will be created.
1858
1859 =cut
1860
1861 sub _get_session_params {
1862     my $storage_method = C4::Context->preference('SessionStorage');
1863     if ( $storage_method eq 'mysql' ) {
1864         my $dbh = C4::Context->dbh;
1865         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1866     }
1867     elsif ( $storage_method eq 'Pg' ) {
1868         my $dbh = C4::Context->dbh;
1869         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1870     }
1871     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1872         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1873         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1874     }
1875     else {
1876         # catch all defaults to tmp should work on all systems
1877         my $dir = C4::Context::temporary_directory;
1878         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1879         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1880     }
1881 }
1882
1883 sub get_session {
1884     my $sessionID      = shift;
1885     my $params = _get_session_params();
1886     my $session;
1887     if( $sessionID ) { # find existing
1888         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1889         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1890     } else {
1891         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1892         # no need to flush here
1893     }
1894     return $session;
1895 }
1896
1897
1898 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1899 # (or something similar)
1900 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1901 # not having a userenv defined could cause a crash.
1902 sub checkpw {
1903     my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1904     $type = 'opac' unless $type;
1905
1906     # Get shibboleth login attribute
1907     my $shib       = C4::Context->config('useshibboleth') && shib_ok();
1908     my $shib_login = $shib ? get_login_shib() : undef;
1909
1910     my @return;
1911     my $patron;
1912     if ( defined $userid ) {
1913         $patron = Koha::Patrons->find( { userid     => $userid } );
1914         $patron = Koha::Patrons->find( { cardnumber => $userid } ) unless $patron;
1915     }
1916     my $check_internal_as_fallback = 0;
1917     my $passwd_ok                  = 0;
1918
1919     # Note: checkpw_* routines returns:
1920     # 1 if auth is ok
1921     # 0 if auth is nok
1922     # -1 if user bind failed (LDAP only)
1923
1924     if ( $patron and ( $patron->account_locked ) ) {
1925
1926         # Nothing to check, account is locked
1927     } elsif ( $ldap && defined($password) ) {
1928         my ( $retval, $retcard, $retuserid );
1929         ( $retval, $retcard, $retuserid, $patron ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1930         if ( $retval == 1 ) {
1931             @return    = ( $retval, $retcard, $retuserid, $patron );
1932             $passwd_ok = 1;
1933         }
1934         $check_internal_as_fallback = 1 if $retval == 0;
1935
1936     } elsif ( $cas && $query && $query->param('ticket') ) {
1937
1938         # In case of a CAS authentication, we use the ticket instead of the password
1939         my $ticket = $query->param('ticket');
1940         $query->delete('ticket');                                   # remove ticket to come back to original URL
1941         my ( $retval, $retcard, $retuserid, $cas_ticket, $patron ) = checkpw_cas( $ticket, $query, $type );    # EXTERNAL AUTH
1942         if ( $retval ) {
1943             @return = ( $retval, $retcard, $retuserid, $patron, $cas_ticket );
1944         } else {
1945             @return = (0);
1946         }
1947         $passwd_ok = $retval;
1948     }
1949
1950     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1951     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1952     # time around.
1953     elsif ( $shib && $shib_login && !$password ) {
1954
1955         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1956         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1957         # shibboleth-authenticated user
1958
1959         # Then, we check if it matches a valid koha user
1960         if ($shib_login) {
1961             my ( $retval, $retcard, $retuserid, $patron ) =
1962                 C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1963             if ($retval) {
1964                 @return = ( $retval, $retcard, $retuserid, $patron );
1965             }
1966             $passwd_ok = $retval;
1967         }
1968     } else {
1969         $check_internal_as_fallback = 1;
1970     }
1971
1972     # INTERNAL AUTH
1973     if ( $check_internal_as_fallback ) {
1974         @return = checkpw_internal( $userid, $password, $no_set_userenv);
1975         push( @return, $patron );
1976         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1977     }
1978
1979     if ($patron) {
1980         if ($passwd_ok) {
1981             $patron->update( { login_attempts => 0 } );
1982             if ( $patron->password_expired ) {
1983                 @return = ( -2, $patron );
1984             }
1985         } elsif ( !$patron->account_locked ) {
1986             $patron->update( { login_attempts => $patron->login_attempts + 1 } );
1987         }
1988     }
1989
1990     # Optionally log success or failure
1991     if ( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1992         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1993     } elsif ( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1994         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1995     }
1996
1997     return @return;
1998 }
1999
2000 sub checkpw_internal {
2001     my ( $userid, $password, $no_set_userenv ) = @_;
2002
2003     $password = Encode::encode( 'UTF-8', $password )
2004       if Encode::is_utf8($password);
2005
2006     my $dbh = C4::Context->dbh;
2007     my $sth =
2008       $dbh->prepare(
2009         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2010       );
2011     $sth->execute($userid);
2012     if ( $sth->rows ) {
2013         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2014             $surname, $branchcode, $branchname, $flags )
2015           = $sth->fetchrow;
2016
2017         if ( checkpw_hash( $password, $stored_hash ) ) {
2018
2019             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2020                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2021             return 1, $cardnumber, $userid;
2022         }
2023     }
2024     $sth =
2025       $dbh->prepare(
2026         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2027       );
2028     $sth->execute($userid);
2029     if ( $sth->rows ) {
2030         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2031             $surname, $branchcode, $branchname, $flags )
2032           = $sth->fetchrow;
2033
2034         if ( checkpw_hash( $password, $stored_hash ) ) {
2035
2036             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2037                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2038             return 1, $cardnumber, $userid;
2039         }
2040     }
2041     return 0;
2042 }
2043
2044 sub checkpw_hash {
2045     my ( $password, $stored_hash ) = @_;
2046
2047     return if $stored_hash eq '!';
2048
2049     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2050     my $hash;
2051     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2052         $hash = hash_password( $password, $stored_hash );
2053     } else {
2054         $hash = md5_base64($password);
2055     }
2056     return $hash eq $stored_hash;
2057 }
2058
2059 =head2 getuserflags
2060
2061     my $authflags = getuserflags($flags, $userid, [$dbh]);
2062
2063 Translates integer flags into permissions strings hash.
2064
2065 C<$flags> is the integer userflags value ( borrowers.userflags )
2066 C<$userid> is the members.userid, used for building subpermissions
2067 C<$authflags> is a hashref of permissions
2068
2069 =cut
2070
2071 sub getuserflags {
2072     my $flags  = shift;
2073     my $userid = shift;
2074     my $dbh    = @_ ? shift : C4::Context->dbh;
2075     my $userflags;
2076     {
2077         # I don't want to do this, but if someone logs in as the database
2078         # user, it would be preferable not to spam them to death with
2079         # numeric warnings. So, we make $flags numeric.
2080         no warnings 'numeric';
2081         $flags += 0;
2082     }
2083     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2084     $sth->execute;
2085
2086     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2087         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2088             $userflags->{$flag} = 1;
2089         }
2090         else {
2091             $userflags->{$flag} = 0;
2092         }
2093     }
2094
2095     # get subpermissions and merge with top-level permissions
2096     my $user_subperms = get_user_subpermissions($userid);
2097     foreach my $module ( keys %$user_subperms ) {
2098         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
2099         $userflags->{$module} = $user_subperms->{$module};
2100     }
2101
2102     return $userflags;
2103 }
2104
2105 =head2 get_user_subpermissions
2106
2107   $user_perm_hashref = get_user_subpermissions($userid);
2108
2109 Given the userid (note, not the borrowernumber) of a staff user,
2110 return a hashref of hashrefs of the specific subpermissions
2111 accorded to the user.  An example return is
2112
2113  {
2114     tools => {
2115         export_catalog => 1,
2116         import_patrons => 1,
2117     }
2118  }
2119
2120 The top-level hash-key is a module or function code from
2121 userflags.flag, while the second-level key is a code
2122 from permissions.
2123
2124 The results of this function do not give a complete picture
2125 of the functions that a staff user can access; it is also
2126 necessary to check borrowers.flags.
2127
2128 =cut
2129
2130 sub get_user_subpermissions {
2131     my $userid = shift;
2132
2133     my $dbh = C4::Context->dbh;
2134     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2135                              FROM user_permissions
2136                              JOIN permissions USING (module_bit, code)
2137                              JOIN userflags ON (module_bit = bit)
2138                              JOIN borrowers USING (borrowernumber)
2139                              WHERE userid = ?" );
2140     $sth->execute($userid);
2141
2142     my $user_perms = {};
2143     while ( my $perm = $sth->fetchrow_hashref ) {
2144         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2145     }
2146     return $user_perms;
2147 }
2148
2149 =head2 get_all_subpermissions
2150
2151   my $perm_hashref = get_all_subpermissions();
2152
2153 Returns a hashref of hashrefs defining all specific
2154 permissions currently defined.  The return value
2155 has the same structure as that of C<get_user_subpermissions>,
2156 except that the innermost hash value is the description
2157 of the subpermission.
2158
2159 =cut
2160
2161 sub get_all_subpermissions {
2162     my $dbh = C4::Context->dbh;
2163     my $sth = $dbh->prepare( "SELECT flag, code
2164                              FROM permissions
2165                              JOIN userflags ON (module_bit = bit)" );
2166     $sth->execute();
2167
2168     my $all_perms = {};
2169     while ( my $perm = $sth->fetchrow_hashref ) {
2170         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2171     }
2172     return $all_perms;
2173 }
2174
2175 =head2 haspermission
2176
2177   $flagsrequired = '*';                                 # Any permission at all
2178   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2179   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2180   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2181   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2182   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2183
2184   $flags = ($userid, $flagsrequired);
2185
2186 C<$userid> the userid of the member
2187 C<$flags> is a query structure similar to that used by SQL::Abstract that
2188 denotes the combination of flags required. It is a required parameter.
2189
2190 The main logic of this method is that things in arrays are OR'ed, and things
2191 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2192
2193 Returns member's flags or 0 if a permission is not met.
2194
2195 =cut
2196
2197 sub _dispatch {
2198     my ($required, $flags) = @_;
2199
2200     my $ref = ref($required);
2201     if ($ref eq '') {
2202         if ($required eq '*') {
2203             return 0 unless ( $flags or ref( $flags ) );
2204         } else {
2205             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2206         }
2207     } elsif ($ref eq 'HASH') {
2208         foreach my $key (keys %{$required}) {
2209             next if $flags == 1;
2210             my $require = $required->{$key};
2211             my $rflags  = $flags->{$key};
2212             return 0 unless _dispatch($require, $rflags);
2213         }
2214     } elsif ($ref eq 'ARRAY') {
2215         my $satisfied = 0;
2216         foreach my $require ( @{$required} ) {
2217             my $rflags =
2218               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2219               ? $flags->{$require}
2220               : $flags;
2221             $satisfied++ if _dispatch( $require, $rflags );
2222         }
2223         return 0 unless $satisfied;
2224     } else {
2225         croak "Unexpected structure found: $ref";
2226     }
2227
2228     return $flags;
2229 };
2230
2231 sub haspermission {
2232     my ( $userid, $flagsrequired ) = @_;
2233
2234     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2235     #  unless defined($flagsrequired);
2236
2237     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2238     $sth->execute($userid);
2239     my $row = $sth->fetchrow();
2240     my $flags = getuserflags( $row, $userid );
2241
2242     return $flags unless defined($flagsrequired);
2243     return $flags if $flags->{superlibrarian};
2244     return _dispatch($flagsrequired, $flags);
2245
2246     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2247 }
2248
2249 =head2 in_iprange
2250
2251   $flags = ($iprange);
2252
2253 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2254
2255 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2256
2257 =cut
2258
2259 sub in_iprange {
2260     my ($iprange) = @_;
2261     my $result = 1;
2262     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2263     if (scalar @allowedipranges > 0) {
2264         my @rangelist;
2265         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2266         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2267      }
2268      return $result ? 1 : 0;
2269 }
2270
2271 sub getborrowernumber {
2272     my ($userid) = @_;
2273     my $userenv = C4::Context->userenv;
2274     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2275         return $userenv->{number};
2276     }
2277     my $dbh = C4::Context->dbh;
2278     for my $field ( 'userid', 'cardnumber' ) {
2279         my $sth =
2280           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2281         $sth->execute($userid);
2282         if ( $sth->rows ) {
2283             my ($bnumber) = $sth->fetchrow;
2284             return $bnumber;
2285         }
2286     }
2287     return 0;
2288 }
2289
2290 =head2 track_login_daily
2291
2292     track_login_daily( $userid );
2293
2294 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2295
2296 =cut
2297
2298 sub track_login_daily {
2299     my $userid = shift;
2300     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2301
2302     my $cache     = Koha::Caches->get_instance();
2303     my $cache_key = "track_login_" . $userid;
2304     my $cached    = $cache->get_from_cache($cache_key);
2305     my $today = dt_from_string()->ymd;
2306     return if $cached && $cached eq $today;
2307
2308     my $patron = Koha::Patrons->find({ userid => $userid });
2309     return unless $patron;
2310     $patron->track_login;
2311     $cache->set_in_cache( $cache_key, $today );
2312 }
2313
2314 END { }    # module clean-up code here (global destructor)
2315 1;
2316 __END__
2317
2318 =head1 SEE ALSO
2319
2320 CGI(3)
2321
2322 C4::Output(3)
2323
2324 Crypt::Eksblowfish::Bcrypt(3)
2325
2326 Digest::MD5(3)
2327
2328 =cut