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