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