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