C4/Auth.pm

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