C4/Auth.pm

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