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