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