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