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