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     my $params          = shift || {};    # do_not_print
 828     $type = 'opac' unless $type;
 829
 830     if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
 831         my @allowed_scripts_for_private_opac = qw(
 832           opac-memberentry.tt
 833           opac-registration-email-sent.tt
 834           opac-registration-confirmation.tt
 835           opac-memberentry-update-submitted.tt
 836           opac-password-recovery.tt
 837           opac-reset-password.tt
 838         );
 839         $authnotrequired = 0 unless grep { $_ eq $template_name }
 840           @allowed_scripts_for_private_opac;
 841     }
 842
 843     my $timeout = _timeout_syspref();
 844
 845     my $cookie_mgr = Koha::CookieManager->new;
 846
 847     _version_check( $type, $query );
 848
 849     # state variables
 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     }
 887     elsif ( $emailaddress) {
 888         # the Google OpenID Connect passes an email address
 889     }
 890     elsif ( $sessionID = $query->cookie("CGISESSID") ) {    # assignment, not comparison
 891         my ( $return, $more_info );
 892         # NOTE: $flags in the following call is still undefined !
 893         ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
 894             { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
 895         );
 896
 897         if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
 898             $userid = $session->param('id');
 899         }
 900
 901         $auth_state =
 902             $return eq 'ok'                     ? 'completed'
 903           : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
 904           :                                       'failed';
 905
 906         # We are at the second screen if the waiting-for-2FA is set in session
 907         # and otp_token param has been passed
 908         if (   $require_2FA
 909             && $auth_state eq 'additional-auth-needed'
 910             && ( my $otp_token = $query->param('otp_token') ) )
 911         {
 912             my $patron    = Koha::Patrons->find( { userid => $userid } );
 913             my $auth      = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
 914             my $verified = $auth->verify($otp_token, 1);
 915             $auth->clear;
 916             if ( $verified ) {
 917                 # The token is correct, the user is fully logged in!
 918                 $auth_state = 'completed';
 919                 $session->param( 'waiting-for-2FA', 0 );
 920
 921                # This is an ugly trick to pass the test
 922                # $query->param('koha_login_context') && ( $q_userid ne $userid )
 923                # few lines later
 924                 $q_userid = $userid;
 925             }
 926             else {
 927                 $invalid_otp_token = 1;
 928             }
 929         }
 930
 931         if ( $auth_state eq 'completed' ) {
 932             Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
 933
 934             if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
 935                 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
 936                 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
 937             ) {
 938
 939                 #if a user enters an id ne to the id in the current session, we need to log them in...
 940                 #first we need to clear the anonymous session...
 941                 $anon_search_history = $session->param('search_history');
 942                 $session->delete();
 943                 $session->flush;
 944                 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 945                 C4::Context::_unset_userenv($sessionID);
 946                 $sessionID = undef;
 947                 undef $userid; # IMPORTANT: this assures us a new session in code below
 948                 $auth_state = 'failed';
 949             } elsif (!$logout) {
 950
 951                 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
 952                     -name     => 'CGISESSID',
 953                     -value    => $session->id,
 954                     -HttpOnly => 1,
 955                     -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
 956                     -sameSite => 'Lax',
 957                 ));
 958
 959                 $flags = haspermission( $userid, $flagsrequired );
 960                 unless ( $flags ) {
 961                     $auth_state = 'failed';
 962                     $info{'nopermission'} = 1;
 963                 }
 964             }
 965         } elsif ( !$logout ) {
 966             if ( $return eq 'expired' ) {
 967                 $info{timed_out} = 1;
 968             } elsif ( $return eq 'restricted' ) {
 969                 $info{oldip}        = $more_info->{old_ip};
 970                 $info{newip}        = $more_info->{new_ip};
 971                 $info{different_ip} = 1;
 972             } elsif ( $return eq 'password_expired' ) {
 973                 $info{password_has_expired} = 1;
 974             }
 975         }
 976     }
 977
 978     if ( $auth_state eq 'failed' || $logout ) {
 979         $sessionID = undef;
 980         $userid    = undef;
 981     }
 982
 983     if ($logout) {
 984
 985         # voluntary logout the user
 986         # check wether the user was using their shibboleth session or a local one
 987         my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
 988         if ( $session ) {
 989             $session->delete();
 990             $session->flush;
 991         }
 992         C4::Context::_unset_userenv($sessionID);
 993         $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
 994
 995         if ($cas and $caslogout) {
 996             logout_cas($query, $type);
 997         }
 998
 999         # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
1000         if ( $shib and $shib_login and $shibSuccess) {
1001             logout_shib($query);
1002         }
1003
1004         $session   = undef;
1005         $auth_state = 'logout';
1006     }
1007
1008     unless ( $userid ) {
1009         #we initiate a session prior to checking for a username to allow for anonymous sessions...
1010         if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
1011             $session = get_session() or die "Auth ERROR: Cannot get_session()";
1012         }
1013
1014         # Save anonymous search history in new session so it can be retrieved
1015         # by get_template_and_user to store it in user's search history after
1016         # a successful login.
1017         if ($anon_search_history) {
1018             $session->param( 'search_history', $anon_search_history );
1019         }
1020
1021         $sessionID = $session->id;
1022         C4::Context->_new_userenv($sessionID);
1023         $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1024             -name     => 'CGISESSID',
1025             -value    => $sessionID,
1026             -HttpOnly => 1,
1027             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1028             -sameSite => 'Lax',
1029         ));
1030         my $pki_field = C4::Context->preference('AllowPKIAuth');
1031         if ( !defined($pki_field) ) {
1032             print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1033             $pki_field = 'None';
1034         }
1035         if ( ( $cas && $query->param('ticket') )
1036             || $q_userid
1037             || ( $shib && $shib_login )
1038             || $pki_field ne 'None'
1039             || $emailaddress )
1040         {
1041             my $password    = $query->param('password');
1042             my $shibSuccess = 0;
1043             my ( $return, $cardnumber );
1044
1045             # If shib is enabled and we have a shib login, does the login match a valid koha user
1046             if ( $shib && $shib_login ) {
1047                 my $retuserid;
1048
1049                 # Do not pass password here, else shib will not be checked in checkpw.
1050                 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1051                 $userid      = $retuserid;
1052                 $shibSuccess = $return;
1053                 $info{'invalidShibLogin'} = 1 unless ($return);
1054             }
1055
1056             # If shib login and match were successful, skip further login methods
1057             unless ($shibSuccess) {
1058                 if ( $cas && $query->param('ticket') ) {
1059                     my $retuserid;
1060                     ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1061                       checkpw( $userid, $password, $query, $type );
1062                     $userid = $retuserid;
1063                     $info{'invalidCasLogin'} = 1 unless ($return);
1064                 }
1065
1066                 elsif ( $emailaddress ) {
1067                     my $value = $emailaddress;
1068
1069                     # If we're looking up the email, there's a chance that the person
1070                     # doesn't have a userid. So if there is none, we pass along the
1071                     # borrower number, and the bits of code that need to know the user
1072                     # ID will have to be smart enough to handle that.
1073                     my $patrons = Koha::Patrons->search({ email => $value });
1074                     if ($patrons->count) {
1075
1076                         # First the userid, then the borrowernum
1077                         my $patron = $patrons->next;
1078                         $value = $patron->userid || $patron->borrowernumber;
1079                     } else {
1080                         undef $value;
1081                     }
1082                     $return = $value ? 1 : 0;
1083                     $userid = $value;
1084                 }
1085
1086                 elsif (
1087                     ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1088                     || ( $pki_field eq 'emailAddress'
1089                         && $ENV{'SSL_CLIENT_S_DN_Email'} )
1090                   )
1091                 {
1092                     my $value;
1093                     if ( $pki_field eq 'Common Name' ) {
1094                         $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1095                     }
1096                     elsif ( $pki_field eq 'emailAddress' ) {
1097                         $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1098
1099                         # If we're looking up the email, there's a chance that the person
1100                         # doesn't have a userid. So if there is none, we pass along the
1101                         # borrower number, and the bits of code that need to know the user
1102                         # ID will have to be smart enough to handle that.
1103                         my $patrons = Koha::Patrons->search({ email => $value });
1104                         if ($patrons->count) {
1105
1106                             # First the userid, then the borrowernum
1107                             my $patron = $patrons->next;
1108                             $value = $patron->userid || $patron->borrowernumber;
1109                         } else {
1110                             undef $value;
1111                         }
1112                     }
1113
1114                     $return = $value ? 1 : 0;
1115                     $userid = $value;
1116
1117                 }
1118                 else {
1119                     my $retuserid;
1120                     my $request_method = $query->request_method();
1121
1122                     if (
1123                         $request_method eq 'POST'
1124                         || ( C4::Context->preference('AutoSelfCheckID')
1125                             && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1126                       )
1127                     {
1128
1129                         ( $return, $cardnumber, $retuserid, $cas_ticket ) =
1130                           checkpw( $q_userid, $password, $query, $type );
1131                         $userid = $retuserid if ($retuserid);
1132                         $info{'invalid_username_or_password'} = 1 unless ($return);
1133                     }
1134                 }
1135             }
1136
1137             # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1138             if (
1139                    $shib
1140                 && !$shibSuccess
1141                 && (
1142                     (
1143                         ( $type eq 'opac' )
1144                         && C4::Context->preference('OPACShibOnly')
1145                     )
1146                     || ( ( $type ne 'opac' )
1147                         && C4::Context->preference('staffShibOnly') )
1148                 )
1149               )
1150             {
1151                 $return = 0;
1152             }
1153
1154             # $return: 1 = valid user
1155             if ($return > 0) {
1156
1157                 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1158                     $auth_state = "logged_in";
1159                 }
1160                 else {
1161                     $auth_state = 'failed';
1162                     # FIXME We could add $return = 0; or even delete the session?
1163                     # Currently return == 1 and we will fill session info later on,
1164                     # although we do present an authorization failure. (Yes, the
1165                     # authentication was actually correct.)
1166                     $info{'nopermission'} = 1;
1167                     C4::Context::_unset_userenv($sessionID);
1168                 }
1169                 my ( $borrowernumber, $firstname, $surname, $userflags,
1170                     $branchcode, $branchname, $emailaddress, $desk_id,
1171                     $desk_name, $register_id, $register_name );
1172
1173                 if ( $return == 1 ) {
1174                     my $select = "
1175                     SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1176                     branches.branchname    as branchname, email
1177                     FROM borrowers
1178                     LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1179                     ";
1180                     my $dbh = C4::Context->dbh;
1181                     my $sth = $dbh->prepare("$select where userid=?");
1182                     $sth->execute($userid);
1183                     unless ( $sth->rows ) {
1184                         $sth = $dbh->prepare("$select where cardnumber=?");
1185                         $sth->execute($cardnumber);
1186
1187                         unless ( $sth->rows ) {
1188                             $sth->execute($userid);
1189                         }
1190                     }
1191                     if ( $sth->rows ) {
1192                         ( $borrowernumber, $firstname, $surname, $userflags,
1193                             $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1194                     }
1195
1196                     # launch a sequence to check if we have a ip for the branch, i
1197                     # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1198
1199                     my $ip = $ENV{'REMOTE_ADDR'};
1200
1201                     # if they specify at login, use that
1202                     if ( $query->param('branch') ) {
1203                         $branchcode = $query->param('branch');
1204                         my $library = Koha::Libraries->find($branchcode);
1205                         $branchname = $library? $library->branchname: '';
1206                     }
1207                     if ( $query->param('desk_id') ) {
1208                         $desk_id = $query->param('desk_id');
1209                         my $desk = Koha::Desks->find($desk_id);
1210                         $desk_name = $desk ? $desk->desk_name : '';
1211                     }
1212                     if ( C4::Context->preference('UseCashRegisters') ) {
1213                         my $register =
1214                           $query->param('register_id')
1215                           ? Koha::Cash::Registers->find($query->param('register_id'))
1216                           : Koha::Cash::Registers->search(
1217                             { branch => $branchcode, branch_default => 1 },
1218                             { rows   => 1 } )->single;
1219                         $register_id   = $register->id   if ($register);
1220                         $register_name = $register->name if ($register);
1221                     }
1222                     my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1223                     if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1224
1225                         # we have to check they are coming from the right ip range
1226                         my $domain = $branches->{$branchcode}->{'branchip'};
1227                         $domain =~ s|\.\*||g;
1228                         if ( $ip !~ /^$domain/ ) {
1229                             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1230                                 -name     => 'CGISESSID',
1231                                 -value    => '',
1232                                 -HttpOnly => 1,
1233                                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1234                                 -sameSite => 'Lax',
1235                             ));
1236                             $info{'wrongip'} = 1;
1237                         }
1238                     }
1239
1240                     foreach my $br ( keys %$branches ) {
1241
1242                         #     now we work with the treatment of ip
1243                         my $domain = $branches->{$br}->{'branchip'};
1244                         if ( $domain && $ip =~ /^$domain/ ) {
1245                             $branchcode = $branches->{$br}->{'branchcode'};
1246
1247                             # new op dev : add the branchname to the cookie
1248                             $branchname    = $branches->{$br}->{'branchname'};
1249                         }
1250                     }
1251
1252                     my $is_sco_user = 0;
1253                     if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1254                         $is_sco_user = 1;
1255                     }
1256
1257                     $session->param( 'number',       $borrowernumber );
1258                     $session->param( 'id',           $userid );
1259                     $session->param( 'cardnumber',   $cardnumber );
1260                     $session->param( 'firstname',    $firstname );
1261                     $session->param( 'surname',      $surname );
1262                     $session->param( 'branch',       $branchcode );
1263                     $session->param( 'branchname',   $branchname );
1264                     $session->param( 'desk_id',      $desk_id);
1265                     $session->param( 'desk_name',     $desk_name);
1266                     $session->param( 'flags',        $userflags );
1267                     $session->param( 'emailaddress', $emailaddress );
1268                     $session->param( 'ip',           $session->remote_addr() );
1269                     $session->param( 'lasttime',     time() );
1270                     $session->param( 'interface',    $type);
1271                     $session->param( 'shibboleth',   $shibSuccess );
1272                     $session->param( 'register_id',  $register_id );
1273                     $session->param( 'register_name',  $register_name );
1274                     $session->param( 'sco_user', $is_sco_user );
1275                 }
1276                 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1277                 C4::Context->set_userenv(
1278                     $session->param('number'),       $session->param('id'),
1279                     $session->param('cardnumber'),   $session->param('firstname'),
1280                     $session->param('surname'),      $session->param('branch'),
1281                     $session->param('branchname'),   $session->param('flags'),
1282                     $session->param('emailaddress'), $session->param('shibboleth'),
1283                     $session->param('desk_id'),      $session->param('desk_name'),
1284                     $session->param('register_id'),  $session->param('register_name')
1285                 );
1286
1287             }
1288             # $return: 0 = invalid user
1289             # reset to anonymous session
1290             else {
1291                 if ($userid) {
1292                     $info{'invalid_username_or_password'} = 1;
1293                     C4::Context::_unset_userenv($sessionID);
1294                 }
1295                 $session->param( 'lasttime', time() );
1296                 $session->param( 'ip',       $session->remote_addr() );
1297                 $session->param( 'sessiontype', 'anon' );
1298                 $session->param( 'interface', $type);
1299             }
1300         }    # END if ( $q_userid
1301         elsif ( $type eq "opac" ) {
1302
1303             # anonymous sessions are created only for the OPAC
1304
1305             # setting a couple of other session vars...
1306             $session->param( 'ip',          $session->remote_addr() );
1307             $session->param( 'lasttime',    time() );
1308             $session->param( 'sessiontype', 'anon' );
1309             $session->param( 'interface', $type);
1310         }
1311         $session->flush;
1312     }    # END unless ($userid)
1313
1314
1315     if ( $auth_state eq 'logged_in' ) {
1316         $auth_state = 'completed';
1317
1318         # Auth is completed unless an additional auth is needed
1319         if ( $require_2FA ) {
1320             my $patron = Koha::Patrons->find({userid => $userid});
1321             if ( $patron->auth_method eq 'two-factor' ) {
1322                 # Ask for the OTP token
1323                 $auth_state = 'additional-auth-needed';
1324                 $session->param('waiting-for-2FA', 1);
1325                 %info = ();# We remove the warnings/errors we may have set incorrectly before
1326             }
1327         }
1328     }
1329
1330     # finished authentification, now respond
1331     if ( $auth_state eq 'completed' || $authnotrequired ) {
1332         # successful login
1333         unless (@$cookie) {
1334             $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1335                 -name     => 'CGISESSID',
1336                 -value    => '',
1337                 -HttpOnly => 1,
1338                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1339                 -sameSite => 'Lax',
1340             ));
1341         }
1342
1343         track_login_daily( $userid );
1344
1345         # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1346         # request. We therefore redirect the user to the requested page again without the login parameters.
1347         # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1348         if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1349             my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1350             $uri->query_param_delete('userid');
1351             $uri->query_param_delete('password');
1352             $uri->query_param_delete('koha_login_context');
1353             unless ( $params->{do_not_print} ) {
1354                 print $query->redirect( -uri => $uri->as_string, -cookie => $cookie, -status => '303 See other' );
1355                 safe_exit;
1356             }
1357         }
1358
1359         return ( $userid, $cookie, $sessionID, $flags );
1360     }
1361
1362     #
1363     #
1364     # AUTH rejected, show the login/password template, after checking the DB.
1365     #
1366     #
1367
1368     my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1369
1370     # get the inputs from the incoming query
1371     my @inputs = ();
1372     my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1373     foreach my $name ( param $query) {
1374         next if grep { $name eq $_ } @inputs_to_clean;
1375         my @value = $query->multi_param($name);
1376         push @inputs, { name => $name, value => $_ } for @value;
1377     }
1378
1379     my $LibraryNameTitle = C4::Context->preference("LibraryName");
1380     $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1381     $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1382
1383     my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1384     my $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     if ( $params->{do_not_print} ) {
1491         # This must be used for testing purpose only!
1492         return ( undef, undef, undef, undef, $template );
1493     }
1494
1495     print $query->header(
1496         {   type              => 'text/html',
1497             charset           => 'utf-8',
1498             cookie            => $cookie,
1499             'X-Frame-Options' => 'SAMEORIGIN',
1500             -sameSite => 'Lax'
1501         }
1502       ),
1503       $template->output;
1504     safe_exit;
1505 }
1506
1507 =head2 check_api_auth
1508
1509   ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1510
1511 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1512 cookie, determine if the user has the privileges specified by C<$userflags>.
1513
1514 C<check_api_auth> is is meant for authenticating users of web services, and
1515 consequently will always return and will not attempt to redirect the user
1516 agent.
1517
1518 If a valid session cookie is already present, check_api_auth will return a status
1519 of "ok", the cookie, and the Koha session ID.
1520
1521 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1522 parameters and create a session cookie and Koha session if the supplied credentials
1523 are OK.
1524
1525 Possible return values in C<$status> are:
1526
1527 =over
1528
1529 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1530
1531 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1532
1533 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1534
1535 =item "expired -- session cookie has expired; API user should resubmit userid and password
1536
1537 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1538
1539 =item "additional-auth-needed -- User is in an authentication process that is not finished
1540
1541 =back
1542
1543 =cut
1544
1545 sub check_api_auth {
1546
1547     my $query         = shift;
1548     my $flagsrequired = shift;
1549     my $timeout = _timeout_syspref();
1550
1551     unless ( C4::Context->preference('Version') ) {
1552
1553         # database has not been installed yet
1554         return ( "maintenance", undef, undef );
1555     }
1556     my $kohaversion = Koha::version();
1557     $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1558     if ( C4::Context->preference('Version') < $kohaversion ) {
1559
1560         # database in need of version update; assume that
1561         # no API should be called while databsae is in
1562         # this condition.
1563         return ( "maintenance", undef, undef );
1564     }
1565
1566     my ( $sessionID, $session );
1567     unless ( $query->param('userid') ) {
1568         $sessionID = $query->cookie("CGISESSID");
1569     }
1570     if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1571
1572         my $return;
1573         ( $return, $session, undef ) = check_cookie_auth(
1574             $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1575
1576         return ( $return, undef, undef ) # Cookie auth failed
1577             if $return ne "ok";
1578
1579         my $cookie = $query->cookie(
1580             -name     => 'CGISESSID',
1581             -value    => $session->id,
1582             -HttpOnly => 1,
1583             -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1584             -sameSite => 'Lax'
1585         );
1586         return ( $return, $cookie, $session ); # return == 'ok' here
1587
1588     } else {
1589
1590         # new login
1591         my $userid   = $query->param('userid');
1592         my $password = $query->param('password');
1593         my ( $return, $cardnumber, $cas_ticket );
1594
1595         # Proxy CAS auth
1596         if ( $cas && $query->param('PT') ) {
1597             my $retuserid;
1598
1599             # In case of a CAS authentication, we use the ticket instead of the password
1600             my $PT = $query->param('PT');
1601             ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query );    # EXTERNAL AUTH
1602         } else {
1603
1604             # User / password auth
1605             unless ( $userid and $password ) {
1606
1607                 # caller did something wrong, fail the authenticateion
1608                 return ( "failed", undef, undef );
1609             }
1610             my $newuserid;
1611             ( $return, $cardnumber, $newuserid, $cas_ticket ) = checkpw( $userid, $password, $query );
1612         }
1613
1614         if ( $return and haspermission( $userid, $flagsrequired ) ) {
1615             my $session = get_session("");
1616             return ( "failed", undef, undef ) unless $session;
1617
1618             my $sessionID = $session->id;
1619             C4::Context->_new_userenv($sessionID);
1620             my $cookie = $query->cookie(
1621                 -name     => 'CGISESSID',
1622                 -value    => $sessionID,
1623                 -HttpOnly => 1,
1624                 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1625                 -sameSite => 'Lax'
1626             );
1627             if ( $return == 1 ) {
1628                 my (
1629                     $borrowernumber, $firstname,  $surname,
1630                     $userflags,      $branchcode, $branchname,
1631                     $emailaddress
1632                 );
1633                 my $dbh = C4::Context->dbh;
1634                 my $sth =
1635                   $dbh->prepare(
1636 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1637                   );
1638                 $sth->execute($userid);
1639                 (
1640                     $borrowernumber, $firstname,  $surname,
1641                     $userflags,      $branchcode, $branchname,
1642                     $emailaddress
1643                 ) = $sth->fetchrow if ( $sth->rows );
1644
1645                 unless ( $sth->rows ) {
1646                     my $sth = $dbh->prepare(
1647 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1648                     );
1649                     $sth->execute($cardnumber);
1650                     (
1651                         $borrowernumber, $firstname,  $surname,
1652                         $userflags,      $branchcode, $branchname,
1653                         $emailaddress
1654                     ) = $sth->fetchrow if ( $sth->rows );
1655
1656                     unless ( $sth->rows ) {
1657                         $sth->execute($userid);
1658                         (
1659                             $borrowernumber, $firstname,  $surname,       $userflags,
1660                             $branchcode,     $branchname, $emailaddress
1661                         ) = $sth->fetchrow if ( $sth->rows );
1662                     }
1663                 }
1664
1665                 my $ip = $ENV{'REMOTE_ADDR'};
1666
1667                 # if they specify at login, use that
1668                 if ( $query->param('branch') ) {
1669                     $branchcode = $query->param('branch');
1670                     my $library = Koha::Libraries->find($branchcode);
1671                     $branchname = $library? $library->branchname: '';
1672                 }
1673                 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1674                 foreach my $br ( keys %$branches ) {
1675
1676                     #     now we work with the treatment of ip
1677                     my $domain = $branches->{$br}->{'branchip'};
1678                     if ( $domain && $ip =~ /^$domain/ ) {
1679                         $branchcode = $branches->{$br}->{'branchcode'};
1680
1681                         # new op dev : add the branchname to the cookie
1682                         $branchname    = $branches->{$br}->{'branchname'};
1683                     }
1684                 }
1685                 $session->param( 'number',       $borrowernumber );
1686                 $session->param( 'id',           $userid );
1687                 $session->param( 'cardnumber',   $cardnumber );
1688                 $session->param( 'firstname',    $firstname );
1689                 $session->param( 'surname',      $surname );
1690                 $session->param( 'branch',       $branchcode );
1691                 $session->param( 'branchname',   $branchname );
1692                 $session->param( 'flags',        $userflags );
1693                 $session->param( 'emailaddress', $emailaddress );
1694                 $session->param( 'ip',           $session->remote_addr() );
1695                 $session->param( 'lasttime',     time() );
1696                 $session->param( 'interface',    'api'  );
1697             }
1698             $session->param( 'cas_ticket', $cas_ticket);
1699             C4::Context->set_userenv(
1700                 $session->param('number'),       $session->param('id'),
1701                 $session->param('cardnumber'),   $session->param('firstname'),
1702                 $session->param('surname'),      $session->param('branch'),
1703                 $session->param('branchname'),   $session->param('flags'),
1704                 $session->param('emailaddress'), $session->param('shibboleth'),
1705                 $session->param('desk_id'),      $session->param('desk_name'),
1706                 $session->param('register_id'),  $session->param('register_name')
1707             );
1708             return ( "ok", $cookie, $sessionID );
1709         } else {
1710             return ( "failed", undef, undef );
1711         }
1712     }
1713 }
1714
1715 =head2 check_cookie_auth
1716
1717   ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1718
1719 Given a CGISESSID cookie set during a previous login to Koha, determine
1720 if the user has the privileges specified by C<$userflags>. C<$userflags>
1721 is passed unaltered into C<haspermission> and as such accepts all options
1722 avaiable to that routine with the one caveat that C<check_api_auth> will
1723 also allow 'undef' to be passed and in such a case the permissions check
1724 will be skipped altogether.
1725
1726 C<check_cookie_auth> is meant for authenticating special services
1727 such as tools/upload-file.pl that are invoked by other pages that
1728 have been authenticated in the usual way.
1729
1730 Possible return values in C<$status> are:
1731
1732 =over
1733
1734 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1735
1736 =item "anon" -- user not authenticated but valid for anonymous session.
1737
1738 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1739
1740 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1741
1742 =item "expired -- session cookie has expired; API user should resubmit userid and password
1743
1744 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1745
1746 =back
1747
1748 =cut
1749
1750 sub check_cookie_auth {
1751     my $sessionID     = shift;
1752     my $flagsrequired = shift;
1753     my $params        = shift;
1754
1755     my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1756
1757     my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1758
1759     unless ( $skip_version_check ) {
1760         unless ( C4::Context->preference('Version') ) {
1761
1762             # database has not been installed yet
1763             return ( "maintenance", undef );
1764         }
1765         my $kohaversion = Koha::version();
1766         $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1767         if ( C4::Context->preference('Version') < $kohaversion ) {
1768
1769             # database in need of version update; assume that
1770             # no API should be called while databsae is in
1771             # this condition.
1772             return ( "maintenance", undef );
1773         }
1774     }
1775
1776     # see if we have a valid session cookie already
1777     # however, if a userid parameter is present (i.e., from
1778     # a form submission, assume that any current cookie
1779     # is to be ignored
1780     unless ( $sessionID ) {
1781         return ( "failed", undef );
1782     }
1783     C4::Context::_unset_userenv($sessionID); # remove old userenv first
1784     my $session   = get_session($sessionID);
1785     if ($session) {
1786         my $userid   = $session->param('id');
1787         my $ip       = $session->param('ip');
1788         my $lasttime = $session->param('lasttime');
1789         my $timeout = _timeout_syspref();
1790
1791         if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1792             # time out
1793             $session->delete();
1794             $session->flush;
1795             return ("expired", undef);
1796
1797         } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1798             # IP address changed
1799             $session->delete();
1800             $session->flush;
1801             return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1802
1803         } elsif ( $userid ) {
1804             $session->param( 'lasttime', time() );
1805             my $patron = Koha::Patrons->find({ userid => $userid });
1806             $patron = Koha::Patron->find({ cardnumber => $userid }) unless $patron;
1807             return ("password_expired", undef ) if $patron->password_expired;
1808             my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1809             if ($flags) {
1810                 C4::Context->_new_userenv($sessionID);
1811                 C4::Context->interface($session->param('interface'));
1812                 C4::Context->set_userenv(
1813                     $session->param('number'),       $session->param('id') // '',
1814                     $session->param('cardnumber'),   $session->param('firstname'),
1815                     $session->param('surname'),      $session->param('branch'),
1816                     $session->param('branchname'),   $session->param('flags'),
1817                     $session->param('emailaddress'), $session->param('shibboleth'),
1818                     $session->param('desk_id'),      $session->param('desk_name'),
1819                     $session->param('register_id'),  $session->param('register_name')
1820                 );
1821                 return ( "additional-auth-needed", $session )
1822                     if $session->param('waiting-for-2FA');
1823
1824                 return ( "ok", $session );
1825             } else {
1826                 $session->delete();
1827                 $session->flush;
1828                 return ( "failed", undef );
1829             }
1830
1831         } else {
1832             C4::Context->_new_userenv($sessionID);
1833             C4::Context->interface($session->param('interface'));
1834             C4::Context->set_userenv( undef, q{} );
1835             return ( "anon", $session );
1836         }
1837     } else {
1838         return ( "expired", undef );
1839     }
1840 }
1841
1842 =head2 get_session
1843
1844   use CGI::Session;
1845   my $session = get_session($sessionID);
1846
1847 Given a session ID, retrieve the CGI::Session object used to store
1848 the session's state.  The session object can be used to store
1849 data that needs to be accessed by different scripts during a
1850 user's session.
1851
1852 If the C<$sessionID> parameter is an empty string, a new session
1853 will be created.
1854
1855 =cut
1856
1857 sub _get_session_params {
1858     my $storage_method = C4::Context->preference('SessionStorage');
1859     if ( $storage_method eq 'mysql' ) {
1860         my $dbh = C4::Context->dbh;
1861         return { dsn => "serializer:yamlxs;driver:MySQL;id:md5", dsn_args => { Handle => $dbh } };
1862     }
1863     elsif ( $storage_method eq 'Pg' ) {
1864         my $dbh = C4::Context->dbh;
1865         return { dsn => "serializer:yamlxs;driver:PostgreSQL;id:md5", dsn_args => { Handle => $dbh } };
1866     }
1867     elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1868         my $memcached = Koha::Caches->get_instance()->memcached_cache;
1869         return { dsn => "serializer:yamlxs;driver:memcached;id:md5", dsn_args => { Memcached => $memcached } };
1870     }
1871     else {
1872         # catch all defaults to tmp should work on all systems
1873         my $dir = C4::Context::temporary_directory;
1874         my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1875         return { dsn => "serializer:yamlxs;driver:File;id:md5", dsn_args => { Directory => "$dir/cgisess_$instance" } };
1876     }
1877 }
1878
1879 sub get_session {
1880     my $sessionID      = shift;
1881     my $params = _get_session_params();
1882     my $session;
1883     if( $sessionID ) { # find existing
1884         CGI::Session::ErrorHandler->set_error( q{} ); # clear error, cpan issue #111463
1885         $session = CGI::Session->load( $params->{dsn}, $sessionID, $params->{dsn_args} );
1886     } else {
1887         $session = CGI::Session->new( $params->{dsn}, $sessionID, $params->{dsn_args} );
1888         # no need to flush here
1889     }
1890     return $session;
1891 }
1892
1893
1894 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1895 # (or something similar)
1896 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1897 # not having a userenv defined could cause a crash.
1898 sub checkpw {
1899     my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1900     $type = 'opac' unless $type;
1901
1902     # Get shibboleth login attribute
1903     my $shib       = C4::Context->config('useshibboleth') && shib_ok();
1904     my $shib_login = $shib ? get_login_shib() : undef;
1905
1906     my @return;
1907     my $patron;
1908     if ( defined $userid ) {
1909         $patron = Koha::Patrons->find( { userid     => $userid } );
1910         $patron = Koha::Patrons->find( { cardnumber => $userid } ) unless $patron;
1911     }
1912     my $check_internal_as_fallback = 0;
1913     my $passwd_ok                  = 0;
1914
1915     # Note: checkpw_* routines returns:
1916     # 1 if auth is ok
1917     # 0 if auth is nok
1918     # -1 if user bind failed (LDAP only)
1919
1920     if ( $patron and ( $patron->account_locked ) ) {
1921
1922         # Nothing to check, account is locked
1923     } elsif ( $ldap && defined($password) ) {
1924         my ( $retval, $retcard, $retuserid );
1925         ( $retval, $retcard, $retuserid, $patron ) = checkpw_ldap(@_);    # EXTERNAL AUTH
1926         if ( $retval == 1 ) {
1927             @return    = ( $retval, $retcard, $retuserid, $patron );
1928             $passwd_ok = 1;
1929         }
1930         $check_internal_as_fallback = 1 if $retval == 0;
1931
1932     } elsif ( $cas && $query && $query->param('ticket') ) {
1933
1934         # In case of a CAS authentication, we use the ticket instead of the password
1935         my $ticket = $query->param('ticket');
1936         $query->delete('ticket');                                   # remove ticket to come back to original URL
1937         my ( $retval, $retcard, $retuserid, $cas_ticket, $patron ) = checkpw_cas( $ticket, $query, $type );    # EXTERNAL AUTH
1938         if ( $retval ) {
1939             @return = ( $retval, $retcard, $retuserid, $patron, $cas_ticket );
1940         } else {
1941             @return = (0);
1942         }
1943         $passwd_ok = $retval;
1944     }
1945
1946     # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1947     # Check for password to asertain whether we want to be testing against shibboleth or another method this
1948     # time around.
1949     elsif ( $shib && $shib_login && !$password ) {
1950
1951         # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1952         # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1953         # shibboleth-authenticated user
1954
1955         # Then, we check if it matches a valid koha user
1956         if ($shib_login) {
1957             my ( $retval, $retcard, $retuserid, $patron ) =
1958                 C4::Auth_with_shibboleth::checkpw_shib($shib_login);    # EXTERNAL AUTH
1959             if ($retval) {
1960                 @return = ( $retval, $retcard, $retuserid, $patron );
1961             }
1962             $passwd_ok = $retval;
1963         }
1964     } else {
1965         $check_internal_as_fallback = 1;
1966     }
1967
1968     # INTERNAL AUTH
1969     if ( $check_internal_as_fallback ) {
1970         @return = checkpw_internal( $userid, $password, $no_set_userenv);
1971         push( @return, $patron );
1972         $passwd_ok = 1 if $return[0] > 0; # 1 or 2
1973     }
1974
1975     if ($patron) {
1976         if ($passwd_ok) {
1977             $patron->update( { login_attempts => 0 } );
1978             if ( $patron->password_expired ) {
1979                 @return = ( -2, $patron );
1980             }
1981         } elsif ( !$patron->account_locked ) {
1982             $patron->update( { login_attempts => $patron->login_attempts + 1 } );
1983         }
1984     }
1985
1986     # Optionally log success or failure
1987     if ( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
1988         logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
1989     } elsif ( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
1990         logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
1991     }
1992
1993     return @return;
1994 }
1995
1996 sub checkpw_internal {
1997     my ( $userid, $password, $no_set_userenv ) = @_;
1998
1999     $password = Encode::encode( 'UTF-8', $password )
2000       if Encode::is_utf8($password);
2001
2002     my $dbh = C4::Context->dbh;
2003     my $sth =
2004       $dbh->prepare(
2005         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2006       );
2007     $sth->execute($userid);
2008     if ( $sth->rows ) {
2009         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2010             $surname, $branchcode, $branchname, $flags )
2011           = $sth->fetchrow;
2012
2013         if ( checkpw_hash( $password, $stored_hash ) ) {
2014
2015             C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2016                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2017             return 1, $cardnumber, $userid;
2018         }
2019     }
2020     $sth =
2021       $dbh->prepare(
2022         "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2023       );
2024     $sth->execute($userid);
2025     if ( $sth->rows ) {
2026         my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2027             $surname, $branchcode, $branchname, $flags )
2028           = $sth->fetchrow;
2029
2030         if ( checkpw_hash( $password, $stored_hash ) ) {
2031
2032             C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2033                 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2034             return 1, $cardnumber, $userid;
2035         }
2036     }
2037     return 0;
2038 }
2039
2040 sub checkpw_hash {
2041     my ( $password, $stored_hash ) = @_;
2042
2043     return if $stored_hash eq '!';
2044
2045     # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2046     my $hash;
2047     if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2048         $hash = hash_password( $password, $stored_hash );
2049     } else {
2050         $hash = md5_base64($password);
2051     }
2052     return $hash eq $stored_hash;
2053 }
2054
2055 =head2 getuserflags
2056
2057     my $authflags = getuserflags($flags, $userid, [$dbh]);
2058
2059 Translates integer flags into permissions strings hash.
2060
2061 C<$flags> is the integer userflags value ( borrowers.userflags )
2062 C<$userid> is the members.userid, used for building subpermissions
2063 C<$authflags> is a hashref of permissions
2064
2065 =cut
2066
2067 sub getuserflags {
2068     my $flags  = shift;
2069     my $userid = shift;
2070     my $dbh    = @_ ? shift : C4::Context->dbh;
2071     my $userflags;
2072     {
2073         # I don't want to do this, but if someone logs in as the database
2074         # user, it would be preferable not to spam them to death with
2075         # numeric warnings. So, we make $flags numeric.
2076         no warnings 'numeric';
2077         $flags += 0;
2078     }
2079     my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2080     $sth->execute;
2081
2082     while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2083         if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2084             $userflags->{$flag} = 1;
2085         }
2086         else {
2087             $userflags->{$flag} = 0;
2088         }
2089     }
2090
2091     # get subpermissions and merge with top-level permissions
2092     my $user_subperms = get_user_subpermissions($userid);
2093     foreach my $module ( keys %$user_subperms ) {
2094         next if $userflags->{$module} == 1;    # user already has permission for everything in this module
2095         $userflags->{$module} = $user_subperms->{$module};
2096     }
2097
2098     return $userflags;
2099 }
2100
2101 =head2 get_user_subpermissions
2102
2103   $user_perm_hashref = get_user_subpermissions($userid);
2104
2105 Given the userid (note, not the borrowernumber) of a staff user,
2106 return a hashref of hashrefs of the specific subpermissions
2107 accorded to the user.  An example return is
2108
2109  {
2110     tools => {
2111         export_catalog => 1,
2112         import_patrons => 1,
2113     }
2114  }
2115
2116 The top-level hash-key is a module or function code from
2117 userflags.flag, while the second-level key is a code
2118 from permissions.
2119
2120 The results of this function do not give a complete picture
2121 of the functions that a staff user can access; it is also
2122 necessary to check borrowers.flags.
2123
2124 =cut
2125
2126 sub get_user_subpermissions {
2127     my $userid = shift;
2128
2129     my $dbh = C4::Context->dbh;
2130     my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2131                              FROM user_permissions
2132                              JOIN permissions USING (module_bit, code)
2133                              JOIN userflags ON (module_bit = bit)
2134                              JOIN borrowers USING (borrowernumber)
2135                              WHERE userid = ?" );
2136     $sth->execute($userid);
2137
2138     my $user_perms = {};
2139     while ( my $perm = $sth->fetchrow_hashref ) {
2140         $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2141     }
2142     return $user_perms;
2143 }
2144
2145 =head2 get_all_subpermissions
2146
2147   my $perm_hashref = get_all_subpermissions();
2148
2149 Returns a hashref of hashrefs defining all specific
2150 permissions currently defined.  The return value
2151 has the same structure as that of C<get_user_subpermissions>,
2152 except that the innermost hash value is the description
2153 of the subpermission.
2154
2155 =cut
2156
2157 sub get_all_subpermissions {
2158     my $dbh = C4::Context->dbh;
2159     my $sth = $dbh->prepare( "SELECT flag, code
2160                              FROM permissions
2161                              JOIN userflags ON (module_bit = bit)" );
2162     $sth->execute();
2163
2164     my $all_perms = {};
2165     while ( my $perm = $sth->fetchrow_hashref ) {
2166         $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2167     }
2168     return $all_perms;
2169 }
2170
2171 =head2 haspermission
2172
2173   $flagsrequired = '*';                                 # Any permission at all
2174   $flagsrequired = 'a_flag';                            # a_flag must be satisfied (all subpermissions)
2175   $flagsrequired = [ 'a_flag', 'b_flag' ];              # a_flag OR b_flag must be satisfied
2176   $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 };     # a_flag AND b_flag must be satisfied
2177   $flagsrequired = { 'a_flag' => 'sub_a' };             # sub_a of a_flag must be satisfied
2178   $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2179
2180   $flags = ($userid, $flagsrequired);
2181
2182 C<$userid> the userid of the member
2183 C<$flags> is a query structure similar to that used by SQL::Abstract that
2184 denotes the combination of flags required. It is a required parameter.
2185
2186 The main logic of this method is that things in arrays are OR'ed, and things
2187 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2188
2189 Returns member's flags or 0 if a permission is not met.
2190
2191 =cut
2192
2193 sub _dispatch {
2194     my ($required, $flags) = @_;
2195
2196     my $ref = ref($required);
2197     if ($ref eq '') {
2198         if ($required eq '*') {
2199             return 0 unless ( $flags or ref( $flags ) );
2200         } else {
2201             return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2202         }
2203     } elsif ($ref eq 'HASH') {
2204         foreach my $key (keys %{$required}) {
2205             next if $flags == 1;
2206             my $require = $required->{$key};
2207             my $rflags  = $flags->{$key};
2208             return 0 unless _dispatch($require, $rflags);
2209         }
2210     } elsif ($ref eq 'ARRAY') {
2211         my $satisfied = 0;
2212         foreach my $require ( @{$required} ) {
2213             my $rflags =
2214               ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2215               ? $flags->{$require}
2216               : $flags;
2217             $satisfied++ if _dispatch( $require, $rflags );
2218         }
2219         return 0 unless $satisfied;
2220     } else {
2221         croak "Unexpected structure found: $ref";
2222     }
2223
2224     return $flags;
2225 };
2226
2227 sub haspermission {
2228     my ( $userid, $flagsrequired ) = @_;
2229
2230     #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2231     #  unless defined($flagsrequired);
2232
2233     my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2234     $sth->execute($userid);
2235     my $row = $sth->fetchrow();
2236     my $flags = getuserflags( $row, $userid );
2237
2238     return $flags unless defined($flagsrequired);
2239     return $flags if $flags->{superlibrarian};
2240     return _dispatch($flagsrequired, $flags);
2241
2242     #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2243 }
2244
2245 =head2 in_iprange
2246
2247   $flags = ($iprange);
2248
2249 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2250
2251 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2252
2253 =cut
2254
2255 sub in_iprange {
2256     my ($iprange) = @_;
2257     my $result = 1;
2258     my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2259     if (scalar @allowedipranges > 0) {
2260         my @rangelist;
2261         eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2262         eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2263      }
2264      return $result ? 1 : 0;
2265 }
2266
2267 sub getborrowernumber {
2268     my ($userid) = @_;
2269     my $userenv = C4::Context->userenv;
2270     if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2271         return $userenv->{number};
2272     }
2273     my $dbh = C4::Context->dbh;
2274     for my $field ( 'userid', 'cardnumber' ) {
2275         my $sth =
2276           $dbh->prepare("select borrowernumber from borrowers where $field=?");
2277         $sth->execute($userid);
2278         if ( $sth->rows ) {
2279             my ($bnumber) = $sth->fetchrow;
2280             return $bnumber;
2281         }
2282     }
2283     return 0;
2284 }
2285
2286 =head2 track_login_daily
2287
2288     track_login_daily( $userid );
2289
2290 Wraps the call to $patron->track_login, the method used to update borrowers.lastseen. We only call track_login once a day.
2291
2292 =cut
2293
2294 sub track_login_daily {
2295     my $userid = shift;
2296     return if !$userid || !C4::Context->preference('TrackLastPatronActivity');
2297
2298     my $cache     = Koha::Caches->get_instance();
2299     my $cache_key = "track_login_" . $userid;
2300     my $cached    = $cache->get_from_cache($cache_key);
2301     my $today = dt_from_string()->ymd;
2302     return if $cached && $cached eq $today;
2303
2304     my $patron = Koha::Patrons->find({ userid => $userid });
2305     return unless $patron;
2306     $patron->track_login;
2307     $cache->set_in_cache( $cache_key, $today );
2308 }
2309
2310 END { }    # module clean-up code here (global destructor)
2311 1;
2312 __END__
2313
2314 =head1 SEE ALSO
2315
2316 CGI(3)
2317
2318 C4::Output(3)
2319
2320 Crypt::Eksblowfish::Bcrypt(3)
2321
2322 Digest::MD5(3)
2323
2324 =cut