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