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
  30 use C4::Context;
  31 use C4::Templates;    # to get the template
  32 use C4::Languages;
  33 use C4::Search::History;
  34 use Koha;
  35 use Koha::Logger;
  36 use Koha::Caches;
  37 use Koha::AuthUtils qw( get_script_name hash_password );
  38 use Koha::Auth::TwoFactorAuth;
  39 use Koha::Checkouts;
  40 use Koha::DateUtils qw( dt_from_string );
  41 use Koha::Library::Groups;
  42 use Koha::Libraries;
  43 use Koha::Cash::Registers;
  44 use Koha::Desks;
  45 use Koha::Patrons;
  46 use Koha::Patron::Consents;
  47 use List::MoreUtils qw( any );
  48 use Encode;
  49 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
  50 use Net::CIDR;
  51 use C4::Log qw( logaction );
  52 use Koha::CookieManager;
  53
  54 # use utf8;
  55
  56 use vars qw($ldap $cas $caslogout);
  57 our (@ISA, @EXPORT_OK);
  58
  59 #NOTE: The utility of keeping the safe_exit function is that it can be easily re-defined in unit tests and plugins
  60 sub safe_exit {
  61     # It's fine for us to "exit" because CGI::Compile (used in Plack::App::WrapCGI) redefines "exit" for us automatically.
  62     # Since we only seem to use C4::Auth::safe_exit in a CGI context, we don't actually need PSGI detection at all here.
  63     exit;
  64 }
  65
  66
  67 BEGIN {
  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     $type = 'opac' unless $type;
 828
 829     if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
 830         my @allowed_scripts_for_private_opac = qw(
 831           opac-memberentry.tt
 832           opac-registration-email-sent.tt
 833           opac-registration-confirmation.tt
 834           opac-memberentry-update-submitted.tt
 835           opac-password-recovery.tt
 836           opac-reset-password.tt
 837         );
 838         $authnotrequired = 0 unless grep { $_ eq $template_name }
 839           @allowed_scripts_for_private_opac;
 840     }
 841
 842     my $timeout = _timeout_syspref();
 843
 844     my $cookie_mgr = Koha::CookieManager->new;
 845
 846     _version_check( $type, $query );
 847
 848     # state variables
 849     my $loggedin = 0;
 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         $loggedin = 1;
 887     }
 888     elsif ( $emailaddress) {
 889         # the Google OpenID Connect passes an email address
 890     }
 891     elsif ( $sessionID = $query->cookie("CGISESSID") ) {    # assignment, not comparison
 892         my ( $return, $more_info );
 893         # NOTE: $flags in the following call is still undefined !
 894         ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
 895             { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
 896         );
 897
 898         if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
 899             $userid = $session->param('id');
 900         }
 901
 902         $auth_state =
 903             $return eq 'ok'                     ? 'completed'
 904           : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
 905           :                                       'failed';
 906
 907         # We are at the second screen if the waiting-for-2FA is set in session
 908         # and otp_token param has been passed
 909         if (   $require_2FA
 910             && $auth_state eq 'additional-auth-needed'
 911             && ( my $otp_token = $query->param('otp_token') ) )
 912         {
 913             my $patron    = Koha::Patrons->find( { userid => $userid } );
 914             my $auth      = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
 915             my $verified = $auth->verify($otp_token, 1);
 916             $auth->clear;
 917             if ( $verified ) {
 918                 # The token is correct, the user is fully logged in!
 919                 $auth_state = 'completed';
 920                 $session->param( 'waiting-for-2FA', 0 );
 921
 922                # This is an ugly trick to pass the test
 923                # $query->param('koha_login_context') && ( $q_userid ne $userid )
 924                # few lines later
 925                 $q_userid = $userid;
 926             }
 927             else {
 928                 $invalid_otp_token = 1;
 929             }
 930         }
 931
 932         if ( $auth_state eq 'completed' ) {
 933             Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
 934
 935             if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
 936                 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
 937                 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
 938             ) {
 939
 940                 #if a user enters an id ne to the id in the current session, we need to log them in...
 941                 #first we need to clear the anonymous session...
 942                 $anon_search_history = $session->param('search_history');
 943                 $session->delete();
 944                 $session->flush;
 945                 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 946                 C4::Context::_unset_userenv($sessionID);
 947                 $sessionID = undef;
 948             } elsif (!$logout) {
 949
 950                 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 951                     -name     => 'CGISESSID',
 952                     -value    => $session->id,
 953                     -HttpOnly => 1,
 954                     -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 955                     -sameSite => 'Lax',
 956                 ));
 957
 958                 $flags = haspermission( $userid, $flagsrequired );
 959                 unless ( $flags ) {
 960                     $auth_state = 'failed';
 961                     $info{'nopermission'} = 1;
 962                 }
 963             }
 964         } elsif ( !$logout ) {
 965             if ( $return eq 'expired' ) {
 966                 $info{timed_out} = 1;
 967             } elsif ( $return eq 'restricted' ) {
 968                 $info{oldip}        = $more_info->{old_ip};
 969                 $info{newip}        = $more_info->{new_ip};
 970                 $info{different_ip} = 1;
 971             } elsif ( $return eq 'password_expired' ) {
 972                 $info{password_has_expired} = 1;
 973             }
 974         }
 975     }
 976
 977     if ( $auth_state eq 'failed' || $logout ) {
 978         $sessionID = undef;
 979         $userid    = undef;
 980     }
 981
 982     if ($logout) {
 983
 984         # voluntary logout the user
 985         # check wether the user was using their shibboleth session or a local one
 986         my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
 987         if ( $session ) {
 988             $session->delete();
 989             $session->flush;
 990         }
 991         C4::Context::_unset_userenv($sessionID);
 992         $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 993
 994         if ($cas and $caslogout) {
 995             logout_cas($query, $type);
 996         }
 997
 998         # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
 999         if ( $shib and $shib_login and $shibSuccess) {
1000             logout_shib($query);
1001         }
1002
1003         $session   = undef;
1004         $auth_state = 'logout';
1005     }
1006
1007     unless ( $userid ) {
1008         #we initiate a session prior to checking for a username to allow for anonymous sessions...
1009         if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
1010             $session = get_session() or die "Auth ERROR: Cannot get_session()";
1011         }
1012
1013         # Save anonymous search history in new session so it can be retrieved
1014         # by get_template_and_user to store it in user's search history after
1015         # a successful login.
1016         if ($anon_search_history) {
1017             $session->param( 'search_history', $anon_search_history );
1018         }
1019
1020         $sessionID = $session->id;
1021         C4::Context->_new_userenv($sessionID);
1022         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1023             -name     => 'CGISESSID',
1024             -value    => $sessionID,
1025             -HttpOnly => 1,
1026             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1027             -sameSite => 'Lax',
1028         ));
1029         my $pki_field = C4::Context->preference('AllowPKIAuth');
1030         if ( !defined($pki_field) ) {
1031             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1032             $pki_field = 'None';
1033         }
1034         if ( ( $cas && $query->param('ticket') )
1035             || $q_userid
1036             || ( $shib && $shib_login )
1037             || $pki_field ne 'None'
1038             || $emailaddress )
1039         {
1040             my $password    = $query->param('password');
1041             my $shibSuccess = 0;
1042             my ( $return, $cardnumber );
1043
1044             # If shib is enabled and we have a shib login, does the login match a valid koha user
1045             if ( $shib && $shib_login ) {
1046                 my $retuserid;
1047
1048                 # Do not pass password here, else shib will not be checked in checkpw.
1049                 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1050                 $userid      = $retuserid;
1051                 $shibSuccess = $return;
1052                 $info{'invalidShibLogin'} = 1 unless ($return);
1053             }
1054
1055             # If shib login and match were successful, skip further login methods
1056             unless ($shibSuccess) {
1057                 if ( $cas && $query->param('ticket') ) {
1058                     my $retuserid;
1059                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1060                       checkpw( $userid, $password, $query, $type );
1061                     $userid = $retuserid;
1062                     $info{'invalidCasLogin'} = 1 unless ($return);
1063                 }
1064
1065                 elsif ( $emailaddress ) {
1066                     my $value = $emailaddress;
1067
1068                     # If we're looking up the email, there's a chance that the person
1069                     # doesn't have a userid. So if there is none, we pass along the
1070                     # borrower number, and the bits of code that need to know the user
1071                     # ID will have to be smart enough to handle that.
1072                     my $patrons = Koha::Patrons->search({ email => $value });
1073                     if ($patrons->count) {
1074
1075                         # First the userid, then the borrowernum
1076                         my $patron = $patrons->next;
1077                         $value = $patron->userid || $patron->borrowernumber;
1078                     } else {
1079                         undef $value;
1080                     }
1081                     $return = $value ? 1 : 0;
1082                     $userid = $value;
1083                 }
1084
1085                 elsif (
1086                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1087                     || ( $pki_field eq 'emailAddress'
1088                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1089                   )
1090                 {
1091                     my $value;
1092                     if ( $pki_field eq 'Common Name' ) {
1093                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1094                     }
1095                     elsif ( $pki_field eq 'emailAddress' ) {
1096                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1097
1098                         # If we're looking up the email, there's a chance that the person
1099                         # doesn't have a userid. So if there is none, we pass along the
1100                         # borrower number, and the bits of code that need to know the user
1101                         # ID will have to be smart enough to handle that.
1102                         my $patrons = Koha::Patrons->search({ email => $value });
1103                         if ($patrons->count) {
1104
1105                             # First the userid, then the borrowernum
1106                             my $patron = $patrons->next;
1107                             $value = $patron->userid || $patron->borrowernumber;
1108                         } else {
1109                             undef $value;
1110                         }
1111                     }
1112
1113                     $return = $value ? 1 : 0;
1114                     $userid = $value;
1115
1116                 }
1117                 else {
1118                     my $retuserid;
1119                     my $request_method = $query->request_method();
1120
1121                     if (
1122                         $request_method eq 'POST'
1123                         || ( C4::Context->preference('AutoSelfCheckID')
1124                             && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1125                       )
1126                     {
1127
1128                         ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1129                           checkpw( $q_userid, $password, $query, $type );
1130                         $userid = $retuserid if ($retuserid);
1131                         $info{'invalid_username_or_password'} = 1 unless ($return);
1132                     }
1133                 }
1134             }
1135
1136             # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1137             if (
1138                    $shib
1139                 && !$shibSuccess
1140                 && (
1141                     (
1142                         ( $type eq 'opac' )
1143                         && C4::Context->preference('OPACShibOnly')
1144                     )
1145                     || ( ( $type ne 'opac' )
1146                         && C4::Context->preference('staffShibOnly') )
1147                 )
1148               )
1149             {
1150                 $return = 0;
1151             }
1152
1153             # $return: 1 = valid user
1154             if ($return > 0) {
1155
1156                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1157                     $auth_state = "logged_in";
1158                 }
1159                 else {
1160                     $info{'nopermission'} = 1;
1161                     C4::Context::_unset_userenv($sessionID);
1162                 }
1163                 my ( $borrowernumber, $firstname, $surname, $userflags,
1164                     $branchcode, $branchname, $emailaddress, $desk_id,
1165                     $desk_name, $register_id, $register_name );
1166
1167                 if ( $return == 1 ) {
1168                     my $select = "
1169                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1170                     branches.branchname    as branchname, email
1171                     FROM borrowers
1172                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1173                     ";
1174                     my $dbh = C4::Context->dbh;
1175                     my $sth = $dbh->prepare("$select where userid=?");
1176                     $sth->execute($userid);
1177                     unless ( $sth->rows ) {
1178                         $sth = $dbh->prepare("$select where cardnumber=?");
1179                         $sth->execute($cardnumber);
1180
1181                         unless ( $sth->rows ) {
1182                             $sth->execute($userid);
1183                         }
1184                     }
1185                     if ( $sth->rows ) {
1186                         ( $borrowernumber, $firstname, $surname, $userflags,
1187                             $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1188                     }
1189
1190                     # launch a sequence to check if we have a ip for the branch, i
1191                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1192
1193                     my $ip = $ENV{'REMOTE_ADDR'};
1194
1195                     # if they specify at login, use that
1196                     if ( $query->param('branch') ) {
1197                         $branchcode = $query->param('branch');
1198                         my $library = Koha::Libraries->find($branchcode);
1199                         $branchname = $library? $library->branchname: '';
1200                     }
1201                     if ( $query->param('desk_id') ) {
1202                         $desk_id = $query->param('desk_id');
1203                         my $desk = Koha::Desks->find($desk_id);
1204                         $desk_name = $desk ? $desk->desk_name : '';
1205                     }
1206                     if ( C4::Context->preference('UseCashRegisters') ) {
1207                         my $register =
1208                           $query->param('register_id')
1209                           ? Koha::Cash::Registers->find($query->param('register_id'))
1210                           : Koha::Cash::Registers->search(
1211                             { branch => $branchcode, branch_default => 1 },
1212                             { rows   => 1 } )->single;
1213                         $register_id   = $register->id   if ($register);
1214                         $register_name = $register->name if ($register);
1215                     }
1216                     my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1217                     if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1218
1219                         # we have to check they are coming from the right ip range
1220                         my $domain = $branches->{$branchcode}->{'branchip'};
1221                         $domain =~ s|\.\*||g;
1222                         if ( $ip !~ /^$domain/ ) {
1223                             $loggedin = 0;
1224                             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1225                                 -name     => 'CGISESSID',
1226                                 -value    => '',
1227                                 -HttpOnly => 1,
1228                                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1229                                 -sameSite => 'Lax',
1230                             ));
1231                             $info{'wrongip'} = 1;
1232                         }
1233                     }
1234
1235                     foreach my $br ( keys %$branches ) {
1236
1237                         #     now we work with the treatment of ip
1238                         my $domain = $branches->{$br}->{'branchip'};
1239                         if ( $domain && $ip =~ /^$domain/ ) {
1240                             $branchcode = $branches->{$br}->{'branchcode'};
1241
1242                             # new op dev : add the branchname to the cookie
1243                             $branchname    = $branches->{$br}->{'branchname'};
1244                         }
1245                     }
1246
1247                     my $is_sco_user = 0;
1248                     if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1249                         $is_sco_user = 1;
1250                     }
1251
1252                     $session->param( 'number',       $borrowernumber );
1253                     $session->param( 'id',           $userid );
1254                     $session->param( 'cardnumber',   $cardnumber );
1255                     $session->param( 'firstname',    $firstname );
1256                     $session->param( 'surname',      $surname );
1257                     $session->param( 'branch',       $branchcode );
1258                     $session->param( 'branchname',   $branchname );
1259                     $session->param( 'desk_id',      $desk_id);
1260                     $session->param( 'desk_name',     $desk_name);
1261                     $session->param( 'flags',        $userflags );
1262                     $session->param( 'emailaddress', $emailaddress );
1263                     $session->param( 'ip',           $session->remote_addr() );
1264                     $session->param( 'lasttime',     time() );
1265                     $session->param( 'interface',    $type);
1266                     $session->param( 'shibboleth',   $shibSuccess );
1267                     $session->param( 'register_id',  $register_id );
1268                     $session->param( 'register_name',  $register_name );
1269                     $session->param( 'sco_user', $is_sco_user );
1270                 }
1271                 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1272                 C4::Context->set_userenv(
1273                     $session->param('number'),       $session->param('id'),
1274                     $session->param('cardnumber'),   $session->param('firstname'),
1275                     $session->param('surname'),      $session->param('branch'),
1276                     $session->param('branchname'),   $session->param('flags'),
1277                     $session->param('emailaddress'), $session->param('shibboleth'),
1278                     $session->param('desk_id'),      $session->param('desk_name'),
1279                     $session->param('register_id'),  $session->param('register_name')
1280                 );
1281
1282             }
1283             # $return: 0 = invalid user
1284             # reset to anonymous session
1285             else {
1286                 if ($userid) {
1287                     $info{'invalid_username_or_password'} = 1;
1288                     C4::Context::_unset_userenv($sessionID);
1289                 }
1290                 $session->param( 'lasttime', time() );
1291                 $session->param( 'ip',       $session->remote_addr() );
1292                 $session->param( 'sessiontype', 'anon' );
1293                 $session->param( 'interface', $type);
1294             }
1295         }    # END if ( $q_userid
1296         elsif ( $type eq "opac" ) {
1297
1298             # anonymous sessions are created only for the OPAC
1299
1300             # setting a couple of other session vars...
1301             $session->param( 'ip',          $session->remote_addr() );
1302             $session->param( 'lasttime',    time() );
1303             $session->param( 'sessiontype', 'anon' );
1304             $session->param( 'interface', $type);
1305         }
1306         $session->flush;
1307     }    # END unless ($userid)
1308
1309
1310     if ( $auth_state eq 'logged_in' ) {
1311         $auth_state = 'completed';
1312
1313         # Auth is completed unless an additional auth is needed
1314         if ( $require_2FA ) {
1315             my $patron = Koha::Patrons->find({userid => $userid});
1316             if ( $patron->auth_method eq 'two-factor' ) {
1317                 # Ask for the OTP token
1318                 $auth_state = 'additional-auth-needed';
1319                 $session->param('waiting-for-2FA', 1);
1320                 %info = ();# We remove the warnings/errors we may have set incorrectly before
1321             }
1322         }
1323     }
1324
1325     # finished authentification, now respond
1326     if ( $auth_state eq 'completed' || $authnotrequired ) {
1327         # successful login
1328         unless (@$cookie) {
1329             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1330                 -name     => 'CGISESSID',
1331                 -value    => '',
1332                 -HttpOnly => 1,
1333                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1334                 -sameSite => 'Lax',
1335             ));
1336         }
1337
1338         track_login_daily( $userid );
1339
1340         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1341         # request. We therefore redirect the user to the requested page again without the login parameters.
1342         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1343         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1344             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1345             $uri->query_param_delete('userid');
1346             $uri->query_param_delete('password');
1347             $uri->query_param_delete('koha_login_context');
1348             print $query->redirect(-uri => $uri->as_string, -cookie => $cookie, -status=>'303 See other');
1349             exit;
1350         }
1351
1352         return ( $userid, $cookie, $sessionID, $flags );
1353     }
1354
1355     #
1356     #
1357     # AUTH rejected, show the login/password template, after checking the DB.
1358     #
1359     #
1360
1361     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1362
1363     # get the inputs from the incoming query
1364     my @inputs = ();
1365     my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1366     foreach my $name ( param $query) {
1367         next if grep { $name eq $_ } @inputs_to_clean;
1368         my @value = $query->multi_param($name);
1369         push @inputs, { name => $name, value => $_ } for @value;
1370     }
1371
1372     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1373     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1374     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1375
1376     my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1377     my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1378     $template->param(
1379         login                                 => 1,
1380         INPUTS                                => \@inputs,
1381         script_name                           => get_script_name(),
1382         casAuthentication                     => C4::Context->preference("casAuthentication"),
1383         shibbolethAuthentication              => $shib,
1384         suggestion                            => C4::Context->preference("suggestion"),
1385         virtualshelves                        => C4::Context->preference("virtualshelves"),
1386         LibraryName                           => "" . C4::Context->preference("LibraryName"),
1387         LibraryNameTitle                      => "" . $LibraryNameTitle,
1388         opacuserlogin                         => C4::Context->preference("opacuserlogin"),
1389         OpacFavicon                           => C4::Context->preference("OpacFavicon"),
1390         opacreadinghistory                    => C4::Context->preference("opacreadinghistory"),
1391         opaclanguagesdisplay                  => C4::Context->preference("opaclanguagesdisplay"),
1392         OPACUserJS                            => C4::Context->preference("OPACUserJS"),
1393         opacbookbag                           => "" . C4::Context->preference("opacbookbag"),
1394         OpacCloud                             => C4::Context->preference("OpacCloud"),
1395         OpacTopissue                          => C4::Context->preference("OpacTopissue"),
1396         OpacAuthorities                       => C4::Context->preference("OpacAuthorities"),
1397         OpacBrowser                           => C4::Context->preference("OpacBrowser"),
1398         TagsEnabled                           => C4::Context->preference("TagsEnabled"),
1399         OPACUserCSS                           => C4::Context->preference("OPACUserCSS"),
1400         intranetcolorstylesheet               => C4::Context->preference("intranetcolorstylesheet"),
1401         intranetstylesheet                    => C4::Context->preference("intranetstylesheet"),
1402         IntranetNav                           => C4::Context->preference("IntranetNav"),
1403         IntranetFavicon                       => C4::Context->preference("IntranetFavicon"),
1404         IntranetUserCSS                       => C4::Context->preference("IntranetUserCSS"),
1405         IntranetUserJS                        => C4::Context->preference("IntranetUserJS"),
1406         IndependentBranches                   => C4::Context->preference("IndependentBranches"),
1407         AutoLocation                          => C4::Context->preference("AutoLocation"),
1408         wrongip                               => $info{'wrongip'},
1409         PatronSelfRegistration                => C4::Context->preference("PatronSelfRegistration"),
1410         PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1411         opac_css_override                     => $ENV{'OPAC_CSS_OVERRIDE'},
1412         too_many_login_attempts               => ( $patron and $patron->account_locked ),
1413         password_has_expired                  => ( $patron and $patron->password_expired ),
1414     );
1415
1416     $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1417     $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1418     $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1419     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1420     if ( $auth_state eq 'additional-auth-needed' ) {
1421         my $patron = Koha::Patrons->find( { userid => $userid } );
1422         $template->param(
1423             TwoFA_prompt => 1,
1424             invalid_otp_token => $invalid_otp_token,
1425             notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1426         );
1427     }
1428
1429     if ( $type eq 'opac' ) {
1430         require Koha::Virtualshelves;
1431         my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1432             {
1433                 public => 1,
1434             }
1435         );
1436         $template->param(
1437             some_public_shelves  => $some_public_shelves,
1438         );
1439     }
1440
1441     if ($cas) {
1442
1443         # Is authentication against multiple CAS servers enabled?
1444         require C4::Auth_with_cas;
1445         if ( multipleAuth() && !$casparam ) {
1446             my $casservers = getMultipleAuth();
1447             my @tmplservers;
1448             foreach my $key ( keys %$casservers ) {
1449                 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1450             }
1451             $template->param(
1452                 casServersLoop => \@tmplservers
1453             );
1454         } else {
1455             $template->param(
1456                 casServerUrl => login_cas_url($query, undef, $type),
1457             );
1458         }
1459
1460         $template->param(
1461             invalidCasLogin => $info{'invalidCasLogin'}
1462         );
1463     }
1464
1465     if ($shib) {
1466         #If shibOnly is enabled just go ahead and redirect directly
1467         if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1468             my $redirect_url = login_shib_url( $query );
1469             print $query->redirect( -uri => "$redirect_url", -status => 303 );
1470             safe_exit;
1471         }
1472
1473         $template->param(
1474             shibbolethAuthentication => $shib,
1475             shibbolethLoginUrl       => login_shib_url($query),
1476         );
1477     }
1478
1479     if (C4::Context->preference('GoogleOpenIDConnect')) {
1480         if ($query->param("OpenIDConnectFailed")) {
1481             my $reason = $query->param('OpenIDConnectFailed');
1482             $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1483         }
1484     }
1485
1486     $template->param(
1487         LibraryName => C4::Context->preference("LibraryName"),
1488     );
1489     $template->param(%info);
1490
1491     #    $cookie = $query->cookie(CGISESSID => $session->id
1492     #   );
1493     print $query->header(
1494         {   type              => 'text/html',
1495             charset           => 'utf-8',
1496             cookie            => $cookie,
1497             'X-Frame-Options' => 'SAMEORIGIN',
1498             -sameSite => 'Lax'
1499         }
1500       ),
1501       $template->output;
1502     safe_exit;
1503 }
1504
1505 =head2 check_api_auth
1506
1507   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1508
1509 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1510 cookie, determine if the user has the privileges specified by C<$userflags>.
1511
1512 C<check_api_auth> is is meant for authenticating users of web services, and
1513 consequently will always return and will not attempt to redirect the user
1514 agent.
1515
1516 If a valid session cookie is already present, check_api_auth will return a status
1517 of "ok", the cookie, and the Koha session ID.
1518
1519 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1520 parameters and create a session cookie and Koha session if the supplied credentials
1521 are OK.
1522
1523 Possible return values in C<$status> are:
1524
1525 =over
1526
1527 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1528
1529 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1530
1531 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1532
1533 =item "expired -- session cookie has expired; API user should resubmit userid and password
1534
1535 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1536
1537 =item "additional-auth-needed -- User is in an authentication process that is not finished
1538
1539 =back
1540
1541 =cut
1542
1543 sub check_api_auth {
1544
1545     my $query         = shift;
1546     my $flagsrequired = shift;
1547     my $timeout = _timeout_syspref();
1548
1549     unless ( C4::Context->preference('Version') ) {
1550
1551         # database has not been installed yet
1552         return ( "maintenance", undef, undef );
1553     }
1554     my $kohaversion = Koha::version();
1555     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1556     if ( C4::Context->preference('Version') < $kohaversion ) {
1557
1558         # database in need of version update; assume that
1559         # no API should be called while databsae is in
1560         # this condition.
1561         return ( "maintenance", undef, undef );
1562     }
1563
1564     my ( $sessionID, $session );
1565     unless ( $query->param('userid') ) {
1566         $sessionID = $query->cookie("CGISESSID");
1567     }
1568     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1569
1570         my $return;
1571         ( $return, $session, undef ) = check_cookie_auth(
1572             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1573
1574         return ( $return, undef, undef ) # Cookie auth failed
1575             if $return ne "ok";
1576
1577         my $cookie = $query->cookie(
1578             -name     => 'CGISESSID',
1579             -value    => $session->id,
1580             -HttpOnly => 1,
1581             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1582             -sameSite => 'Lax'
1583         );
1584         return ( $return, $cookie, $session ); # return == 'ok' here
1585
1586     } else {
1587
1588         # new login
1589         my $userid   = $query->param('userid');
1590         my $password = $query->param('password');
1591         my ( $return, $cardnumber, $cas_ticket );
1592
1593         # Proxy CAS auth
1594         if ( $cas && $query->param('PT') ) {
1595             my $retuserid;
1596
1597             # In case of a CAS authentication, we use the ticket instead of the password
1598             my $PT = $query->param('PT');
1599             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query );    # EXTERNAL AUTH
1600         } else {
1601
1602             # User / password auth
1603             unless ( $userid and $password ) {
1604
1605                 # caller did something wrong, fail the authenticateion
1606                 return ( "failed", undef, undef );
1607             }
1608             my $newuserid;
1609             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1610         }
1611
1612         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1613             my $session = get_session("");
1614             return ( "failed", undef, undef ) unless $session;
1615
1616             my $sessionID = $session->id;
1617             C4::Context->_new_userenv($sessionID);
1618             my $cookie = $query->cookie(
1619                 -name     => 'CGISESSID',
1620                 -value    => $sessionID,
1621                 -HttpOnly => 1,
1622                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1623                 -sameSite => 'Lax'
1624             );
1625             if ( $return == 1 ) {
1626                 my (
1627                     $borrowernumber, $firstname,  $surname,
1628                     $userflags,      $branchcode, $branchname,
1629                     $emailaddress
1630                 );
1631                 my $dbh = C4::Context->dbh;
1632                 my $sth =
1633                   $dbh->prepare(
1634 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1635                   );
1636                 $sth->execute($userid);
1637                 (
1638                     $borrowernumber, $firstname,  $surname,
1639                     $userflags,      $branchcode, $branchname,
1640                     $emailaddress
1641                 ) = $sth->fetchrow if ( $sth->rows );
1642
1643                 unless ( $sth->rows ) {
1644                     my $sth = $dbh->prepare(
1645 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1646                     );
1647                     $sth->execute($cardnumber);
1648                     (
1649                         $borrowernumber, $firstname,  $surname,
1650                         $userflags,      $branchcode, $branchname,
1651                         $emailaddress
1652                     ) = $sth->fetchrow if ( $sth->rows );
1653
1654                     unless ( $sth->rows ) {
1655                         $sth->execute($userid);
1656                         (
1657                             $borrowernumber, $firstname,  $surname,       $userflags,
1658                             $branchcode,     $branchname, $emailaddress
1659                         ) = $sth->fetchrow if ( $sth->rows );
1660                     }
1661                 }
1662
1663                 my $ip = $ENV{'REMOTE_ADDR'};
1664
1665                 # if they specify at login, use that
1666                 if ( $query->param('branch') ) {
1667                     $branchcode = $query->param('branch');
1668                     my $library = Koha::Libraries->find($branchcode);
1669                     $branchname = $library? $library->branchname: '';
1670                 }
1671                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1672                 foreach my $br ( keys %$branches ) {
1673
1674                     #     now we work with the treatment of ip
1675                     my $domain = $branches->{$br}->{'branchip'};
1676                     if ( $domain && $ip =~ /^$domain/ ) {
1677                         $branchcode = $branches->{$br}->{'branchcode'};
1678
1679                         # new op dev : add the branchname to the cookie
1680                         $branchname    = $branches->{$br}->{'branchname'};
1681                     }
1682                 }
1683                 $session->param( 'number',       $borrowernumber );
1684                 $session->param( 'id',           $userid );
1685                 $session->param( 'cardnumber',   $cardnumber );
1686                 $session->param( 'firstname',    $firstname );
1687                 $session->param( 'surname',      $surname );
1688                 $session->param( 'branch',       $branchcode );
1689                 $session->param( 'branchname',   $branchname );
1690                 $session->param( 'flags',        $userflags );
1691                 $session->param( 'emailaddress', $emailaddress );
1692                 $session->param( 'ip',           $session->remote_addr() );
1693                 $session->param( 'lasttime',     time() );
1694                 $session->param( 'interface',    'api'  );
1695             }
1696             $session->param( 'cas_ticket', $cas_ticket);
1697             C4::Context->set_userenv(
1698                 $session->param('number'),       $session->param('id'),
1699                 $session->param('cardnumber'),   $session->param('firstname'),
1700                 $session->param('surname'),      $session->param('branch'),
1701                 $session->param('branchname'),   $session->param('flags'),
1702                 $session->param('emailaddress'), $session->param('shibboleth'),
1703                 $session->param('desk_id'),      $session->param('desk_name'),
1704                 $session->param('register_id'),  $session->param('register_name')
1705             );
1706             return ( "ok", $cookie, $sessionID );
1707         } else {
1708             return ( "failed", undef, undef );
1709         }
1710     }
1711 }
1712
1713 =head2 check_cookie_auth
1714
1715   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1716
1717 Given a CGISESSID cookie set during a previous login to Koha, determine
1718 if the user has the privileges specified by C<$userflags>. C<$userflags>
1719 is passed unaltered into C<haspermission> and as such accepts all options
1720 avaiable to that routine with the one caveat that C<check_api_auth> will
1721 also allow 'undef' to be passed and in such a case the permissions check
1722 will be skipped altogether.
1723
1724 C<check_cookie_auth> is meant for authenticating special services
1725 such as tools/upload-file.pl that are invoked by other pages that
1726 have been authenticated in the usual way.
1727
1728 Possible return values in C<$status> are:
1729
1730 =over
1731
1732 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1733
1734 =item "anon" -- user not authenticated but valid for anonymous session.
1735
1736 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1737
1738 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1739
1740 =item "expired -- session cookie has expired; API user should resubmit userid and password
1741
1742 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1743
1744 =back
1745
1746 =cut
1747
1748 sub check_cookie_auth {
1749     my $sessionID     = shift;
1750     my $flagsrequired = shift;
1751     my $params        = shift;
1752
1753     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1754
1755     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1756
1757     unless ( $skip_version_check ) {
1758         unless ( C4::Context->preference('Version') ) {
1759
1760             # database has not been installed yet
1761             return ( "maintenance", undef );
1762         }
1763         my $kohaversion = Koha::version();
1764         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1765         if ( C4::Context->preference('Version') < $kohaversion ) {
1766
1767             # database in need of version update; assume that
1768             # no API should be called while databsae is in
1769             # this condition.
1770             return ( "maintenance", undef );
1771         }
1772     }
1773
1774     # see if we have a valid session cookie already
1775     # however, if a userid parameter is present (i.e., from
1776     # a form submission, assume that any current cookie
1777     # is to be ignored
1778     unless ( $sessionID ) {
1779         return ( "failed", undef );
1780     }
1781     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1782     my $session   = get_session($sessionID);
1783     if ($session) {
1784         my $userid   = $session->param('id');
1785         my $ip       = $session->param('ip');
1786         my $lasttime = $session->param('lasttime');
1787         my $timeout = _timeout_syspref();
1788
1789         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1790             # time out
1791             $session->delete();
1792             $session->flush;
1793             return ("expired", undef);
1794
1795         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1796             # IP address changed
1797             $session->delete();
1798             $session->flush;
1799             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1800
1801         } elsif ( $userid ) {
1802             $session->param( 'lasttime', time() );
1803             my $patron = Koha::Patrons->find({ userid => $userid });
1804             $patron = Koha::Patron->find({ cardnumber => $userid }) unless $patron;
1805             return ("password_expired", undef ) if $patron->password_expired;
1806             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1807             if ($flags) {
1808                 C4::Context->_new_userenv($sessionID);
1809                 C4::Context->interface($session->param('interface'));
1810                 C4::Context->set_userenv(
1811                     $session->param('number'),       $session->param('id') // '',
1812                     $session->param('cardnumber'),   $session->param('firstname'),
1813                     $session->param('surname'),      $session->param('branch'),
1814                     $session->param('branchname'),   $session->param('flags'),
1815                     $session->param('emailaddress'), $session->param('shibboleth'),
1816                     $session->param('desk_id'),      $session->param('desk_name'),
1817                     $session->param('register_id'),  $session->param('register_name')
1818                 );
1819                 return ( "additional-auth-needed", $session )
1820                     if $session->param('waiting-for-2FA');
1821
1822                 return ( "ok", $session );
1823             } else {
1824                 $session->delete();
1825                 $session->flush;
1826                 return ( "failed", undef );
1827             }
1828
1829         } else {
1830             C4::Context->_new_userenv($sessionID);
1831             C4::Context->interface($session->param('interface'));
1832             C4::Context->set_userenv( undef, q{} );
1833             return ( "anon", $session );
1834         }
1835     } else {
1836         return ( "expired", undef );
1837     }
1838 }
1839
1840 =head2 get_session
1841
1842   use CGI::Session;
1843   my $session = get_session($sessionID);
1844
1845 Given a session ID, retrieve the CGI::Session object used to store
1846 the session's state.  The session object can be used to store
1847 data that needs to be accessed by different scripts during a
1848 user's session.
1849
1850 If the C<$sessionID> parameter is an empty string, a new session
1851 will be created.
1852
1853 =cut
1854
1855 sub _get_session_params {
1856     my $storage_method = C4::Context->preference('SessionStorage');
1857     if ( $storage_method eq 'mysql' ) {
1858         my $dbh = C4::Context->dbh;
1859         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1860     }
1861     elsif ( $storage_method eq 'Pg' ) {
1862         my $dbh = C4::Context->dbh;
1863         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1864     }
1865     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1866         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1867         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1868     }
1869     else {
1870         # catch all defaults to tmp should work on all systems
1871         my $dir = C4::Context::temporary_directory;
1872         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1873         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1874     }
1875 }
1876
1877 sub get_session {
1878     my $sessionID      = shift;
1879     my $params = _get_session_params();
1880     my $session;
1881     if( $sessionID ) { # find existing
1882         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1883         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1884     } else {
1885         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1886         # no need to flush here
1887     }
1888     return $session;
1889 }
1890
1891
1892 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1893 # (or something similar)
1894 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1895 # not having a userenv defined could cause a crash.
1896 sub checkpw {
1897     my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1898     $type = 'opac' unless $type;
1899
1900     # Get shibboleth login attribute
1901     my $shib = C4::Context->config('useshibboleth') && shib_ok();
1902     my $shib_login = $shib ? get_login_shib() : undef;
1903
1904     my @return;
1905     my $patron;
1906     if ( defined $userid ){
1907         $patron = Koha::Patrons->find({ userid => $userid });
1908         $patron = Koha::Patrons->find({ cardnumber => $userid }) unless $patron;
1909     }
1910     my $check_internal_as_fallback = 0;
1911     my $passwd_ok = 0;
1912     # Note: checkpw_* routines returns:
1913     # 1 if auth is ok
1914     # 0 if auth is nok
1915     # -1 if user bind failed (LDAP only)
1916
1917     if ( $patron and ( $patron->account_locked )  ) {
1918         # Nothing to check, account is locked
1919     } elsif ($ldap && defined($password)) {
1920         my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1921         if ( $retval == 1 ) {
1922             @return = ( $retval, $retcard, $retuserid );
1923             $passwd_ok = 1;
1924         }
1925         $check_internal_as_fallback = 1 if $retval == 0;
1926
1927     } elsif ( $cas && $query && $query->param('ticket') ) {
1928
1929         # In case of a CAS authentication, we use the ticket instead of the password
1930         my $ticket = $query->param('ticket');
1931         $query->delete('ticket');                                   # remove ticket to come back to original URL
1932         my ( $retval, $retcard, $retuserid, $cas_ticket ) = checkpw_cas( $ticket, $query, $type );    # EXTERNAL AUTH
1933         if ( $retval ) {
1934             @return = ( $retval, $retcard, $retuserid, $cas_ticket );
1935         } else {
1936             @return = (0);
1937         }
1938         $passwd_ok = $retval;
1939     }
1940
1941     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1942     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1943     # time around.
1944     elsif ( $shib && $shib_login && !$password ) {
1945
1946         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1947         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1948         # shibboleth-authenticated user
1949
1950         # Then, we check if it matches a valid koha user
1951         if ($shib_login) {
1952             my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1953             if ( $retval ) {
1954                 @return = ( $retval, $retcard, $retuserid );
1955             }
1956             $passwd_ok = $retval;
1957         }
1958     } else {
1959         $check_internal_as_fallback = 1;
1960     }
1961
1962     # INTERNAL AUTH
1963     if ( $check_internal_as_fallback ) {
1964         @return = checkpw_internal( $userid, $password, $no_set_userenv);
1965         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1966     }
1967
1968     if( $patron ) {
1969         if ( $passwd_ok ) {
1970             $patron->update({ login_attempts => 0 });
1971             if( $patron->password_expired ){
1972                 @return = (-2);
1973             }
1974         } elsif( !$patron->account_locked ) {
1975             $patron->update({ login_attempts => $patron->login_attempts + 1 });
1976         }
1977     }
1978
1979     # Optionally log success or failure
1980     if( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1981         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1982     } elsif( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1983         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1984     }
1985
1986     return @return;
1987 }
1988
1989 sub checkpw_internal {
1990     my ( $userid, $password, $no_set_userenv ) = @_;
1991
1992     $password = Encode::encode( 'UTF-8', $password )
1993       if Encode::is_utf8($password);
1994
1995     my $dbh = C4::Context->dbh;
1996     my $sth =
1997       $dbh->prepare(
1998         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1999       );
2000     $sth->execute($userid);
2001     if ( $sth->rows ) {
2002         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2003             $surname, $branchcode, $branchname, $flags )
2004           = $sth->fetchrow;
2005
2006         if ( checkpw_hash( $password, $stored_hash ) ) {
2007
2008             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2009                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2010             return 1, $cardnumber, $userid;
2011         }
2012     }
2013     $sth =
2014       $dbh->prepare(
2015         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2016       );
2017     $sth->execute($userid);
2018     if ( $sth->rows ) {
2019         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2020             $surname, $branchcode, $branchname, $flags )
2021           = $sth->fetchrow;
2022
2023         if ( checkpw_hash( $password, $stored_hash ) ) {
2024
2025             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2026                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2027             return 1, $cardnumber, $userid;
2028         }
2029     }
2030     return 0;
2031 }
2032
2033 sub checkpw_hash {
2034     my ( $password, $stored_hash ) = @_;
2035
2036     return if $stored_hash eq '!';
2037
2038     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2039     my $hash;
2040     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2041         $hash = hash_password( $password, $stored_hash );
2042     } else {
2043         $hash = md5_base64($password);
2044     }
2045     return $hash eq $stored_hash;
2046 }
2047
2048 =head2 getuserflags
2049
2050     my $authflags = getuserflags($flags, $userid, [$dbh]);
2051
2052 Translates integer flags into permissions strings hash.
2053
2054 C<$flags> is the integer userflags value ( borrowers.userflags )
2055 C<$userid> is the members.userid, used for building subpermissions
2056 C<$authflags> is a hashref of permissions
2057
2058 =cut
2059
2060 sub getuserflags {
2061     my $flags  = shift;
2062     my $userid = shift;
2063     my $dbh    = @_ ? shift : C4::Context->dbh;
2064     my $userflags;
2065     {
2066         # I don't want to do this, but if someone logs in as the database
2067         # user, it would be preferable not to spam them to death with
2068         # numeric warnings. So, we make $flags numeric.
2069         no warnings 'numeric';
2070         $flags += 0;
2071     }
2072     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2073     $sth->execute;
2074
2075     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2076         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2077             $userflags->{$flag} = 1;
2078         }
2079         else {
2080             $userflags->{$flag} = 0;
2081         }
2082     }
2083
2084     # get subpermissions and merge with top-level permissions
2085     my $user_subperms = get_user_subpermissions($userid);
2086     foreach my $module ( keys %$user_subperms ) {
2087         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
2088         $userflags->{$module} = $user_subperms->{$module};
2089     }
2090
2091     return $userflags;
2092 }
2093
2094 =head2 get_user_subpermissions
2095
2096   $user_perm_hashref = get_user_subpermissions($userid);
2097
2098 Given the userid (note, not the borrowernumber) of a staff user,
2099 return a hashref of hashrefs of the specific subpermissions
2100 accorded to the user.  An example return is
2101
2102  {
2103     tools => {
2104         export_catalog => 1,
2105         import_patrons => 1,
2106     }
2107  }
2108
2109 The top-level hash-key is a module or function code from
2110 userflags.flag, while the second-level key is a code
2111 from permissions.
2112
2113 The results of this function do not give a complete picture
2114 of the functions that a staff user can access; it is also
2115 necessary to check borrowers.flags.
2116
2117 =cut
2118
2119 sub get_user_subpermissions {
2120     my $userid = shift;
2121
2122     my $dbh = C4::Context->dbh;
2123     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2124                              FROM user_permissions
2125                              JOIN permissions USING (module_bit, code)
2126                              JOIN userflags ON (module_bit = bit)
2127                              JOIN borrowers USING (borrowernumber)
2128                              WHERE userid = ?" );
2129     $sth->execute($userid);
2130
2131     my $user_perms = {};
2132     while ( my $perm = $sth->fetchrow_hashref ) {
2133         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2134     }
2135     return $user_perms;
2136 }
2137
2138 =head2 get_all_subpermissions
2139
2140   my $perm_hashref = get_all_subpermissions();
2141
2142 Returns a hashref of hashrefs defining all specific
2143 permissions currently defined.  The return value
2144 has the same structure as that of C<get_user_subpermissions>,
2145 except that the innermost hash value is the description
2146 of the subpermission.
2147
2148 =cut
2149
2150 sub get_all_subpermissions {
2151     my $dbh = C4::Context->dbh;
2152     my $sth = $dbh->prepare( "SELECT flag, code
2153                              FROM permissions
2154                              JOIN userflags ON (module_bit = bit)" );
2155     $sth->execute();
2156
2157     my $all_perms = {};
2158     while ( my $perm = $sth->fetchrow_hashref ) {
2159         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2160     }
2161     return $all_perms;
2162 }
2163
2164 =head2 haspermission
2165
2166   $flagsrequired = '*';                                 # Any permission at all
2167   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2168   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2169   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2170   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2171   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2172
2173   $flags = ($userid, $flagsrequired);
2174
2175 C<$userid> the userid of the member
2176 C<$flags> is a query structure similar to that used by SQL::Abstract that
2177 denotes the combination of flags required. It is a required parameter.
2178
2179 The main logic of this method is that things in arrays are OR'ed, and things
2180 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2181
2182 Returns member's flags or 0 if a permission is not met.
2183
2184 =cut
2185
2186 sub _dispatch {
2187     my ($required, $flags) = @_;
2188
2189     my $ref = ref($required);
2190     if ($ref eq '') {
2191         if ($required eq '*') {
2192             return 0 unless ( $flags or ref( $flags ) );
2193         } else {
2194             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2195         }
2196     } elsif ($ref eq 'HASH') {
2197         foreach my $key (keys %{$required}) {
2198             next if $flags == 1;
2199             my $require = $required->{$key};
2200             my $rflags  = $flags->{$key};
2201             return 0 unless _dispatch($require, $rflags);
2202         }
2203     } elsif ($ref eq 'ARRAY') {
2204         my $satisfied = 0;
2205         foreach my $require ( @{$required} ) {
2206             my $rflags =
2207               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2208               ? $flags->{$require}
2209               : $flags;
2210             $satisfied++ if _dispatch( $require, $rflags );
2211         }
2212         return 0 unless $satisfied;
2213     } else {
2214         croak "Unexpected structure found: $ref";
2215     }
2216
2217     return $flags;
2218 };
2219
2220 sub haspermission {
2221     my ( $userid, $flagsrequired ) = @_;
2222
2223     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2224     #  unless defined($flagsrequired);
2225
2226     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2227     $sth->execute($userid);
2228     my $row = $sth->fetchrow();
2229     my $flags = getuserflags( $row, $userid );
2230
2231     return $flags unless defined($flagsrequired);
2232     return $flags if $flags->{superlibrarian};
2233     return _dispatch($flagsrequired, $flags);
2234
2235     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2236 }
2237
2238 =head2 in_iprange
2239
2240   $flags = ($iprange);
2241
2242 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2243
2244 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2245
2246 =cut
2247
2248 sub in_iprange {
2249     my ($iprange) = @_;
2250     my $result = 1;
2251     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2252     if (scalar @allowedipranges > 0) {
2253         my @rangelist;
2254         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2255         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2256      }
2257      return $result ? 1 : 0;
2258 }
2259
2260 sub getborrowernumber {
2261     my ($userid) = @_;
2262     my $userenv = C4::Context->userenv;
2263     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2264         return $userenv->{number};
2265     }
2266     my $dbh = C4::Context->dbh;
2267     for my $field ( 'userid', 'cardnumber' ) {
2268         my $sth =
2269           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2270         $sth->execute($userid);
2271         if ( $sth->rows ) {
2272             my ($bnumber) = $sth->fetchrow;
2273             return $bnumber;
2274         }
2275     }
2276     return 0;
2277 }
2278
2279 =head2 track_login_daily
2280
2281     track_login_daily( $userid );
2282
2283 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2284
2285 =cut
2286
2287 sub track_login_daily {
2288     my $userid = shift;
2289     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2290
2291     my $cache     = Koha::Caches->get_instance();
2292     my $cache_key = "track_login_" . $userid;
2293     my $cached    = $cache->get_from_cache($cache_key);
2294     my $today = dt_from_string()->ymd;
2295     return if $cached && $cached eq $today;
2296
2297     my $patron = Koha::Patrons->find({ userid => $userid });
2298     return unless $patron;
2299     $patron->track_login;
2300     $cache->set_in_cache( $cache_key, $today );
2301 }
2302
2303 END { }    # module clean-up code here (global destructor)
2304 1;
2305 __END__
2306
2307 =head1 SEE ALSO
2308
2309 CGI(3)
2310
2311 C4::Output(3)
2312
2313 Crypt::Eksblowfish::Bcrypt(3)
2314
2315 Digest::MD5(3)
2316
2317 =cut