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