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