C4/Auth.pm

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