C4/Auth.pm

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