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