3 # Copyright 2000-2002 Katipo Communications
5 # This file is part of Koha.
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.
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.
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>.
24 use Digest::MD5 qw( md5_base64 );
26 use CGI::Session::ErrorHandler;
29 use List::MoreUtils qw( uniq );
32 use C4::Templates; # to get the template
34 use C4::Search::History;
38 use Koha::AuthUtils qw( get_script_name hash_password );
39 use Koha::Auth::TwoFactorAuth;
41 use Koha::DateUtils qw( dt_from_string );
42 use Koha::Library::Groups;
44 use Koha::Cash::Registers;
47 use Koha::Patron::Consents;
48 use List::MoreUtils qw( any );
50 use C4::Auth_with_shibboleth qw( shib_ok get_login_shib login_shib_url logout_shib checkpw_shib );
52 use C4::Log qw( logaction );
53 use Koha::CookieManager;
54 use Koha::Auth::Permissions;
60 use vars qw($ldap $cas $caslogout);
61 our (@ISA, @EXPORT_OK);
63 #NOTE: The utility of keeping the safe_exit function is that it can be easily re-defined in unit tests and plugins
65 # It's fine for us to "exit" because CGI::Compile (used in Plack::App::WrapCGI) redefines "exit" for us automatically.
66 # Since we only seem to use C4::Auth::safe_exit in a CGI context, we don't actually need PSGI detection at all here.
72 C4::Context->set_remote_address;
78 checkauth check_api_auth get_session check_cookie_auth checkpw checkpw_internal checkpw_hash
79 get_all_subpermissions get_cataloguing_page_permissions get_user_subpermissions in_iprange
80 get_template_and_user haspermission create_basic_session
83 $ldap = C4::Context->config('useldapserver') || 0;
84 $cas = C4::Context->preference('casAuthentication');
85 $caslogout = C4::Context->preference('casLogout');
88 require C4::Auth_with_ldap;
89 import C4::Auth_with_ldap qw(checkpw_ldap);
92 require C4::Auth_with_cas; # no import
93 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url logout_if_required multipleAuth getMultipleAuth);
100 C4::Auth - Authenticates Koha users
104 use CGI qw ( -utf8 );
108 my $query = CGI->new;
110 my ($template, $borrowernumber, $cookie)
111 = get_template_and_user(
113 template_name => "opac-main.tt",
116 authnotrequired => 0,
117 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
121 output_html_with_http_headers $query, $cookie, $template->output;
125 The main function of this module is to provide
126 authentification. However the get_template_and_user function has
127 been provided so that a users login information is passed along
128 automatically. This gets loaded into the template.
132 =head2 get_template_and_user
134 my ($template, $borrowernumber, $cookie)
135 = get_template_and_user(
137 template_name => "opac-main.tt",
140 authnotrequired => 0,
141 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
145 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
146 to C<&checkauth> (in this module) to perform authentification.
147 See C<&checkauth> for an explanation of these parameters.
149 The C<template_name> is then used to find the correct template for
150 the page. The authenticated users details are loaded onto the
151 template in the logged_in_user variable (which is a Koha::Patron object). Also the
152 C<sessionID> is passed to the template. This can be used in templates
153 if cookies are disabled. It needs to be put as and input to every
156 More information on the C<gettemplate> sub can be found in the
161 sub get_template_and_user {
164 my ( $user, $cookie, $sessionID, $flags );
167 my $cookie_mgr = Koha::CookieManager->new;
169 # Get shibboleth login attribute
170 my $shib = C4::Context->config('useshibboleth') && shib_ok();
171 my $shib_login = $shib ? get_login_shib() : undef;
173 C4::Context->interface( $in->{type} );
175 $in->{'authnotrequired'} ||= 0;
177 # the following call includes a bad template check; might croak
178 my $template = C4::Templates::gettemplate(
179 $in->{'template_name'},
184 if ( $in->{'template_name'} !~ m/maintenance/ ) {
185 ( $user, $cookie, $sessionID, $flags ) = checkauth(
187 $in->{'authnotrequired'},
188 $in->{'flagsrequired'},
191 $in->{template_name},
195 # If we enforce GDPR and the user did not consent, redirect
196 # Exceptions for consent page itself and SCI/SCO system
197 if( $in->{type} eq 'opac' && $user &&
198 $in->{'template_name'} !~ /^(opac-page|opac-patron-consent|sc[io]\/)/ &&
199 C4::Context->preference('PrivacyPolicyConsent') eq 'Enforced' )
201 my $consent = Koha::Patron::Consents->search({
202 borrowernumber => getborrowernumber($user),
203 type => 'GDPR_PROCESSING',
204 given_on => { '!=', undef },
207 print $in->{query}->redirect(-uri => '/cgi-bin/koha/opac-patron-consent.pl', -cookie => $cookie);
212 if ( $in->{type} eq 'opac' && $user ) {
215 my $session = get_session($sessionID);
217 $is_sco_user = $session->param('sco_user');
223 # If the user logged in is the SCO user and they try to go out of the SCO module,
224 # log the user out removing the CGISESSID cookie
225 $in->{template_name} !~ m|sco/| && $in->{template_name} !~ m|errors/errorpage.tt|
229 C4::Context->preference('AutoSelfCheckID')
230 && $user eq C4::Context->preference('AutoSelfCheckID')
238 # If the user logged in is the SCI user and they try to go out of the SCI module,
239 # kick them out unless it is SCO with a valid permission
240 # or they are a superlibrarian
241 $in->{template_name} !~ m|sci/|
242 && haspermission( $user, { self_check => 'self_checkin_module' } )
244 $in->{template_name} =~ m|sco/| && haspermission(
245 $user, { self_check => 'self_checkout_module' }
248 && $flags && $flags->{superlibrarian} != 1
255 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac',
257 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
258 -name => 'CGISESSID',
261 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
265 #NOTE: This JWT should only be used by the self-check controllers
266 $cookie = $cookie_mgr->replace_in_list( $cookie, $in->{query}->cookie(
270 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
274 my $auth_error = $in->{query}->param('auth_error');
278 script_name => get_script_name(),
279 auth_error => $auth_error,
282 print $in->{query}->header(
287 'X-Frame-Options' => 'SAMEORIGIN'
299 # It's possible for $user to be the borrowernumber if they don't have a
300 # userid defined (and are logging in through some other method, such
301 # as SSL certs against an email address)
302 $borrowernumber = getborrowernumber($user) if defined($user);
303 if ( !defined($borrowernumber) && defined($user) ) {
304 $patron = Koha::Patrons->find( $user );
306 $borrowernumber = $user;
308 # A bit of a hack, but I don't know there's a nicer way
310 $user = $patron->firstname . ' ' . $patron->surname;
313 $patron = Koha::Patrons->find( $borrowernumber );
314 # FIXME What to do if $patron does not exist?
317 if ( $in->{'type'} eq 'opac' ) {
318 require Koha::Virtualshelves;
319 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
321 borrowernumber => $borrowernumber,
325 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
331 some_private_shelves => $some_private_shelves,
332 some_public_shelves => $some_public_shelves,
336 # We are going to use the $flags returned by checkauth
337 # to create the template's parameters that will indicate
338 # which menus the user can access.
339 my $authz = Koha::Auth::Permissions->get_authz_from_flags({ flags => $flags });
340 foreach my $permission ( keys %{ $authz } ){
341 $template->param( $permission => $authz->{$permission} );
344 # Logged-in opac search history
345 # If the requested template is an opac one and opac search history is enabled
346 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
347 my $dbh = C4::Context->dbh;
348 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
349 my $sth = $dbh->prepare($query);
350 $sth->execute($borrowernumber);
352 # If at least one search has already been performed
353 if ( $sth->fetchrow_array > 0 ) {
355 # We show the link in opac
356 $template->param( EnableOpacSearchHistory => 1 );
358 if (C4::Context->preference('LoadSearchHistoryToTheFirstLoggedUser'))
360 # And if there are searches performed when the user was not logged in,
361 # we add them to the logged-in search history
362 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
363 if (@recentSearches) {
365 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
366 VALUES (?, ?, ?, ?, ?, ?, ?)
368 my $sth = $dbh->prepare($query);
369 $sth->execute( $borrowernumber,
370 $in->{query}->cookie("CGISESSID"),
373 $_->{type} || 'biblio',
376 ) foreach @recentSearches;
378 # clear out the search history from the session now that
379 # we've saved it to the database
382 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
384 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
385 $template->param( EnableSearchHistory => 1 );
388 else { # if this is an anonymous session, setup to display public lists...
390 # If shibboleth is enabled, and we're in an anonymous session, we should allow
391 # the user to attempt login via shibboleth.
393 $template->param( shibbolethAuthentication => $shib,
394 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
397 # If shibboleth is enabled and we have a shibboleth login attribute,
398 # but we are in an anonymous session, then we clearly have an invalid
399 # shibboleth koha account.
401 $template->param( invalidShibLogin => '1' );
405 if ( $in->{'type'} eq 'opac' ){
406 require Koha::Virtualshelves;
407 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
413 some_public_shelves => $some_public_shelves,
416 # Set default branch if one has been passed by the environment.
417 $template->param( default_branch => $ENV{OPAC_BRANCH_DEFAULT} ) if $ENV{OPAC_BRANCH_DEFAULT};
421 # Sysprefs disabled via URL param
422 # Note that value must be defined in order to override via ENV
423 foreach my $syspref (
429 OpacAdditionalStylesheet
431 intranetcolorstylesheet
436 $ENV{"OVERRIDE_SYSPREF_$syspref"} = q{}
437 if $in->{'query'}->param("DISABLE_SYSPREF_$syspref");
440 # Anonymous opac search history
441 # If opac search history is enabled and at least one search has already been performed
442 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
443 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
444 if (@recentSearches) {
445 $template->param( EnableOpacSearchHistory => 1 );
449 if ( C4::Context->preference('dateformat') ) {
450 $template->param( dateformat => C4::Context->preference('dateformat') );
453 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
455 # these template parameters are set the same regardless of $in->{'type'}
457 my $minPasswordLength = C4::Context->preference('minPasswordLength');
458 $minPasswordLength = 3 if not $minPasswordLength or $minPasswordLength < 3;
460 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
461 GoogleJackets => C4::Context->preference("GoogleJackets"),
462 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
463 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
464 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
465 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
466 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
467 TagsEnabled => C4::Context->preference("TagsEnabled"),
468 hide_marc => C4::Context->preference("hide_marc"),
469 item_level_itypes => C4::Context->preference('item-level_itypes'),
470 patronimages => C4::Context->preference("patronimages"),
471 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
472 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
473 marcflavour => C4::Context->preference("marcflavour"),
474 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
475 minPasswordLength => $minPasswordLength,
477 if ( $in->{'type'} eq "intranet" ) {
480 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
481 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
482 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
483 AutoLocation => C4::Context->preference("AutoLocation"),
484 can_see_cataloguing_module => haspermission( $user, get_cataloguing_page_permissions() ) ? 1 : 0,
485 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
486 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
487 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
488 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
489 IndependentBranches => C4::Context->preference("IndependentBranches"),
490 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
491 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
492 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
493 IntranetNav => C4::Context->preference("IntranetNav"),
494 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
495 IntranetReadingHistoryHolds => C4::Context->preference("IntranetReadingHistoryHolds"),
496 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
497 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
498 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
499 LibraryName => C4::Context->preference("LibraryName"),
500 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
501 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
502 PatronAutoComplete => C4::Context->preference("PatronAutoComplete"),
503 pending_checkout_notes => Koha::Checkouts->search( { noteseen => 0 } ),
504 plugins_enabled => C4::Context->config("enable_plugins"),
505 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
506 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
507 useDischarge => C4::Context->preference('useDischarge'),
508 virtualshelves => C4::Context->preference("virtualshelves"),
512 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
514 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
515 my $LibraryNameTitle = C4::Context->preference("LibraryName");
516 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
517 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
519 # clean up the busc param in the session
520 # if the page is not opac-detail and not the "add to list" page
521 # and not the "edit comments" page
522 if ( C4::Context->preference("OpacBrowseResults")
523 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
525 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
526 or $pagename =~ /^showmarc$/
527 or $pagename =~ /^addbybiblionumber$/
528 or $pagename =~ /^review$/ )
530 my $sessionSearch = get_session( $sessionID );
531 $sessionSearch->clear( ["busc"] ) if $sessionSearch;
535 # variables passed from CGI: opac_css_override and opac_search_limits.
536 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
537 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
540 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:([\w-]+)/ ) ||
541 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:([\w-]+)/ ) ||
542 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /multibranchlimit:(\w+)/ )
544 $opac_name = $1; # opac_search_limit is a branch, so we use it.
545 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
546 $opac_name = $in->{'query'}->param('multibranchlimit');
547 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
548 $opac_name = C4::Context->userenv->{'branch'};
551 # Decide if the patron can make suggestions in the OPAC
552 my $can_make_suggestions;
553 if ( C4::Context->preference('Suggestion') && C4::Context->preference('AnonSuggestions') ) {
554 $can_make_suggestions = 1;
555 } elsif ( C4::Context->userenv && C4::Context->userenv->{'number'} ) {
556 $can_make_suggestions = Koha::Patrons->find(C4::Context->userenv->{'number'})->category->can_make_suggestions;
559 my @search_groups = Koha::Library::Groups->get_search_groups({ interface => 'opac' })->as_list;
561 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
562 LibrarySearchGroups => \@search_groups,
563 opac_name => $opac_name,
564 LibraryName => "" . C4::Context->preference("LibraryName"),
565 LibraryNameTitle => "" . $LibraryNameTitle,
566 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
567 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
568 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
569 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
570 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
571 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
572 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
573 opac_search_limit => $opac_search_limit,
574 opac_limit_override => $opac_limit_override,
575 OpacBrowser => C4::Context->preference("OpacBrowser"),
576 OpacCloud => C4::Context->preference("OpacCloud"),
577 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
578 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
579 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
580 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
581 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
582 OpacTopissue => C4::Context->preference("OpacTopissue"),
583 'Version' => C4::Context->preference('Version'),
584 hidelostitems => C4::Context->preference("hidelostitems"),
585 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
586 opacbookbag => "" . C4::Context->preference("opacbookbag"),
587 OpacFavicon => C4::Context->preference("OpacFavicon"),
588 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
589 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
590 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
591 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
592 ShowReviewer => C4::Context->preference("ShowReviewer"),
593 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
594 suggestion => $can_make_suggestions,
595 virtualshelves => "" . C4::Context->preference("virtualshelves"),
596 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
597 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
598 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
599 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
600 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
601 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
602 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
603 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
604 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
605 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
606 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
607 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
608 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
609 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
610 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
611 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
612 useDischarge => C4::Context->preference('useDischarge'),
615 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
618 # Check if we were asked using parameters to force a specific language
619 if ( defined $in->{'query'}->param('language') ) {
621 # Extract the language, let C4::Languages::getlanguage choose
623 my $language = C4::Languages::getlanguage( $in->{'query'} );
624 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
625 $cookie = $cookie_mgr->replace_in_list( $cookie, $languagecookie );
629 $template->param( loggedinusername => $user ); # OBSOLETE - Do not reuse this in template, use logged_in_user.userid instead
630 $template->param( loggedinusernumber => $borrowernumber ); # FIXME Should be replaced with logged_in_user.borrowernumber
631 $template->param( logged_in_user => $patron );
632 $template->param( sessionID => $sessionID );
634 return ( $template, $borrowernumber, $cookie, $flags );
639 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
641 Verifies that the user is authorized to run this script. If
642 the user is authorized, a (userid, cookie, session-id, flags)
643 quadruple is returned. If the user is not authorized but does
644 not have the required privilege (see $flagsrequired below), it
645 displays an error page and exits. Otherwise, it displays the
646 login page and exits.
648 Note that C<&checkauth> will return if and only if the user
649 is authorized, so it should be called early on, before any
650 unfinished operations (e.g., if you've opened a file, then
651 C<&checkauth> won't close it for you).
653 C<$query> is the CGI object for the script calling C<&checkauth>.
655 The C<$noauth> argument is optional. If it is set, then no
656 authorization is required for the script.
658 C<&checkauth> fetches user and session information from C<$query> and
659 ensures that the user is authorized to run scripts that require
662 The C<$flagsrequired> argument specifies the required privileges
663 the user must have if the username and password are correct.
664 It should be specified as a reference-to-hash; keys in the hash
665 should be the "flags" for the user, as specified in the Members
666 intranet module. Any key specified must correspond to a "flag"
667 in the userflags table. E.g., { circulate => 1 } would specify
668 that the user must have the "circulate" privilege in order to
669 proceed. To make sure that access control is correct, the
670 C<$flagsrequired> parameter must be specified correctly.
672 Koha also has a concept of sub-permissions, also known as
673 granular permissions. This makes the value of each key
674 in the C<flagsrequired> hash take on an additional
679 The user must have access to all subfunctions of the module
680 specified by the hash key.
684 The user must have access to at least one subfunction of the module
685 specified by the hash key.
687 specific permission, e.g., 'export_catalog'
689 The user must have access to the specific subfunction list, which
690 must correspond to a row in the permissions table.
692 The C<$type> argument specifies whether the template should be
693 retrieved from the opac or intranet directory tree. "opac" is
694 assumed if it is not specified; however, if C<$type> is specified,
695 "intranet" is assumed if it is not "opac".
697 If C<$query> does not have a valid session ID associated with it
698 (i.e., the user has not logged in) or if the session has expired,
699 C<&checkauth> presents the user with a login page (from the point of
700 view of the original script, C<&checkauth> does not return). Once the
701 user has authenticated, C<&checkauth> restarts the original script
702 (this time, C<&checkauth> returns).
704 The login page is provided using a HTML::Template, which is set in the
705 systempreferences table or at the top of this file. The variable C<$type>
706 selects which template to use, either the opac or the intranet
707 authentification template.
709 C<&checkauth> returns a user ID, a cookie, and a session ID. The
710 cookie should be sent back to the browser; it verifies that the user
720 # If version syspref is unavailable, it means Koha is being installed,
721 # and so we must redirect to OPAC maintenance page or to the WebInstaller
722 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
723 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
724 warn "OPAC Install required, redirecting to maintenance";
725 print $query->redirect("/cgi-bin/koha/maintenance.pl");
728 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
729 if ( $type ne 'opac' ) {
730 warn "Install required, redirecting to Installer";
731 print $query->redirect("/cgi-bin/koha/installer/install.pl");
733 warn "OPAC Install required, redirecting to maintenance";
734 print $query->redirect("/cgi-bin/koha/maintenance.pl");
739 # check that database and koha version are the same
740 # there is no DB version, it's a fresh install,
741 # go to web installer
742 # there is a DB version, compare it to the code version
743 my $kohaversion = Koha::version();
745 # remove the 3 last . to have a Perl number
746 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
747 Koha::Logger->get->debug("kohaversion : $kohaversion");
748 if ( $version < $kohaversion ) {
749 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
750 if ( $type ne 'opac' ) {
751 warn sprintf( $warning, 'Installer' );
752 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
754 warn sprintf( "OPAC: " . $warning, 'maintenance' );
755 print $query->redirect("/cgi-bin/koha/maintenance.pl");
761 sub _timeout_syspref {
762 my $default_timeout = 600;
763 my $timeout = C4::Context->preference('timeout') || $default_timeout;
765 # value in days, convert in seconds
766 if ( $timeout =~ /^(\d+)[dD]$/ ) {
767 $timeout = $1 * 86400;
769 # value in hours, convert in seconds
770 elsif ( $timeout =~ /^(\d+)[hH]$/ ) {
771 $timeout = $1 * 3600;
773 elsif ( $timeout !~ m/^\d+$/ ) {
774 warn "The value of the system preference 'timeout' is not correct, defaulting to $default_timeout";
775 $timeout = $default_timeout;
784 # Get shibboleth login attribute
785 my $shib = C4::Context->config('useshibboleth') && shib_ok();
786 my $shib_login = $shib ? get_login_shib() : undef;
788 # $authnotrequired will be set for scripts which will run without authentication
789 my $authnotrequired = shift;
790 my $flagsrequired = shift;
792 my $emailaddress = shift;
793 my $template_name = shift;
794 my $params = shift || {}; # do_not_print
795 $type = 'opac' unless $type;
797 if ( $type eq 'opac' && !C4::Context->preference("OpacPublic") ) {
798 my @allowed_scripts_for_private_opac = qw(
800 opac-registration-email-sent.tt
801 opac-registration-confirmation.tt
802 opac-memberentry-update-submitted.tt
803 opac-password-recovery.tt
804 opac-reset-password.tt
807 $authnotrequired = 0 unless grep { $_ eq $template_name }
808 @allowed_scripts_for_private_opac;
811 my $timeout = _timeout_syspref();
813 my $cookie_mgr = Koha::CookieManager->new;
815 _version_check( $type, $query );
818 my $auth_state = 'failed';
820 my ( $userid, $cookie, $sessionID, $flags );
822 my $logout = $query->param('logout.x');
824 my $anon_search_history;
826 # This parameter is the name of the CAS server we want to authenticate against,
827 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
828 my $casparam = $query->param('cas');
829 my $q_userid = $query->param('userid') // '';
832 my $invalid_otp_token;
834 ( $type ne "opac" # Only available for the staff interface
835 && C4::Context->preference('TwoFactorAuthentication') ne "disabled" ) # If "enabled" or "enforced"
838 # Basic authentication is incompatible with the use of Shibboleth,
839 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
840 # and it may not be the attribute we want to use to match the koha login.
842 # Also, do not consider an empty REMOTE_USER.
844 # Finally, after those tests, we can assume (although if it would be better with
845 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
846 # and we can affect it to $userid.
847 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
849 # Using Basic Authentication, no cookies required
850 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
851 -name => 'CGISESSID',
854 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
858 elsif ( $emailaddress) {
859 # the Google OpenID Connect passes an email address
861 elsif ( $sessionID = $query->cookie("CGISESSID") ) { # assignment, not comparison
862 my ( $return, $more_info );
863 # NOTE: $flags in the following call is still undefined !
864 ( $return, $session, $more_info ) = check_cookie_auth( $sessionID, $flags,
865 { remote_addr => $ENV{REMOTE_ADDR}, skip_version_check => 1 }
868 if ( $return eq 'ok' || $return eq 'additional-auth-needed' ) {
869 $userid = $session->param('id');
873 $return eq 'ok' ? 'completed'
874 : $return eq 'additional-auth-needed' ? 'additional-auth-needed'
877 # We are at the second screen if the waiting-for-2FA is set in session
878 # and otp_token param has been passed
880 && $auth_state eq 'additional-auth-needed'
881 && ( my $otp_token = $query->param('otp_token') ) )
883 my $patron = Koha::Patrons->find( { userid => $userid } );
884 my $auth = Koha::Auth::TwoFactorAuth->new( { patron => $patron } );
885 my $verified = $auth->verify($otp_token);
888 # The token is correct, the user is fully logged in!
889 $auth_state = 'completed';
890 $session->param( 'waiting-for-2FA', 0 );
891 $session->param( 'waiting-for-2FA-setup', 0 );
893 # This is an ugly trick to pass the test
894 # $query->param('koha_login_context') && ( $q_userid ne $userid )
899 $invalid_otp_token = 1;
903 if ( $auth_state eq 'completed' ) {
904 Koha::Logger->get->debug(sprintf "AUTH_SESSION: (%s)\t%s %s - %s", map { $session->param($_) || q{} } qw(cardnumber firstname surname branch));
906 if ( ( $query->param('koha_login_context') && ( $q_userid ne $userid ) )
907 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
908 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
911 #if a user enters an id ne to the id in the current session, we need to log them in...
912 #first we need to clear the anonymous session...
913 $anon_search_history = $session->param('search_history');
916 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
917 C4::Context::_unset_userenv($sessionID);
919 undef $userid; # IMPORTANT: this assures us a new session in code below
920 $auth_state = 'failed';
923 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
924 -name => 'CGISESSID',
925 -value => $session->id,
927 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
931 $flags = haspermission( $userid, $flagsrequired );
933 $auth_state = 'failed';
934 $info{'nopermission'} = 1;
937 } elsif ( !$logout ) {
938 if ( $return eq 'expired' ) {
939 $info{timed_out} = 1;
940 } elsif ( $return eq 'restricted' ) {
941 $info{oldip} = $more_info->{old_ip};
942 $info{newip} = $more_info->{new_ip};
943 $info{different_ip} = 1;
944 } elsif ( $return eq 'password_expired' ) {
945 $info{password_has_expired} = 1;
950 if ( $auth_state eq 'failed' || $logout ) {
957 # voluntary logout the user
958 # check wether the user was using their shibboleth session or a local one
959 my $shibSuccess = C4::Context->userenv ? C4::Context->userenv->{'shibboleth'} : undef;
964 C4::Context::_unset_userenv($sessionID);
965 $cookie = $cookie_mgr->clear_unless( $query->cookie, @$cookie );
967 if ($cas and $caslogout) {
968 logout_cas($query, $type);
971 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
972 if ( $shib and $shib_login and $shibSuccess) {
977 $auth_state = 'logout';
981 #we initiate a session prior to checking for a username to allow for anonymous sessions...
982 if( !$session or !$sessionID ) { # if we cleared sessionID, we need a new session
983 $session = get_session() or die "Auth ERROR: Cannot get_session()";
986 # Save anonymous search history in new session so it can be retrieved
987 # by get_template_and_user to store it in user's search history after
988 # a successful login.
989 if ($anon_search_history) {
990 $session->param( 'search_history', $anon_search_history );
993 $sessionID = $session->id;
994 C4::Context->_new_userenv($sessionID);
995 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
996 -name => 'CGISESSID',
997 -value => $sessionID,
999 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1002 my $pki_field = C4::Context->preference('AllowPKIAuth');
1003 if ( !defined($pki_field) ) {
1004 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
1005 $pki_field = 'None';
1007 if ( ( $cas && $query->param('ticket') )
1009 || ( $shib && $shib_login )
1010 || $pki_field ne 'None'
1013 my $password = $query->param('password');
1014 my $shibSuccess = 0;
1015 my ( $return, $cardnumber );
1017 # If shib is enabled and we have a shib login, does the login match a valid koha user
1018 if ( $shib && $shib_login ) {
1021 # Do not pass password here, else shib will not be checked in checkpw.
1022 ( $return, $cardnumber, $retuserid ) = checkpw( $q_userid, undef, $query );
1023 $userid = $retuserid;
1024 $shibSuccess = $return;
1025 $info{'invalidShibLogin'} = 1 unless ($return);
1028 # If shib login and match were successful, skip further login methods
1029 unless ($shibSuccess) {
1030 if ( $cas && $query->param('ticket') ) {
1033 ( $return, $cardnumber, $retuserid, $patron, $cas_ticket ) =
1034 checkpw( $userid, $password, $query, $type );
1035 $userid = $retuserid;
1036 $info{'invalidCasLogin'} = 1 unless ($return);
1039 elsif ( $emailaddress ) {
1040 my $value = $emailaddress;
1042 # If we're looking up the email, there's a chance that the person
1043 # doesn't have a userid. So if there is none, we pass along the
1044 # borrower number, and the bits of code that need to know the user
1045 # ID will have to be smart enough to handle that.
1046 my $patrons = Koha::Patrons->search({ email => $value });
1047 if ($patrons->count) {
1049 # First the userid, then the borrowernum
1050 my $patron = $patrons->next;
1051 $value = $patron->userid || $patron->borrowernumber;
1055 $return = $value ? 1 : 0;
1060 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
1061 || ( $pki_field eq 'emailAddress'
1062 && $ENV{'SSL_CLIENT_S_DN_Email'} )
1066 if ( $pki_field eq 'Common Name' ) {
1067 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
1069 elsif ( $pki_field eq 'emailAddress' ) {
1070 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
1072 # If we're looking up the email, there's a chance that the person
1073 # doesn't have a userid. So if there is none, we pass along the
1074 # borrower number, and the bits of code that need to know the user
1075 # ID will have to be smart enough to handle that.
1076 my $patrons = Koha::Patrons->search({ email => $value });
1077 if ($patrons->count) {
1079 # First the userid, then the borrowernum
1080 my $patron = $patrons->next;
1081 $value = $patron->userid || $patron->borrowernumber;
1087 $return = $value ? 1 : 0;
1093 my $request_method = $query->request_method // q{};
1096 $request_method eq 'POST'
1097 || ( C4::Context->preference('AutoSelfCheckID')
1098 && $q_userid eq C4::Context->preference('AutoSelfCheckID') )
1103 ( $return, $cardnumber, $retuserid, $patron, $cas_ticket ) =
1104 checkpw( $q_userid, $password, $query, $type );
1105 $userid = $retuserid if ($retuserid);
1106 $info{'invalid_username_or_password'} = 1 unless ($return);
1111 # If shib configured and shibOnly enabled, we should ignore anything other than a shibboleth type login.
1118 && C4::Context->preference('OPACShibOnly')
1120 || ( ( $type ne 'opac' )
1121 && C4::Context->preference('staffShibOnly') )
1128 # $return: 1 = valid user
1129 if( $return && $return > 0 ) {
1131 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1132 $auth_state = "logged_in";
1135 $auth_state = 'failed';
1136 # FIXME We could add $return = 0; or even delete the session?
1137 # Currently return == 1 and we will fill session info later on,
1138 # although we do present an authorization failure. (Yes, the
1139 # authentication was actually correct.)
1140 $info{'nopermission'} = 1;
1141 C4::Context::_unset_userenv($sessionID);
1143 my ( $borrowernumber, $firstname, $surname, $userflags,
1144 $branchcode, $branchname, $emailaddress, $desk_id,
1145 $desk_name, $register_id, $register_name );
1147 if ( $return == 1 ) {
1149 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1150 branches.branchname as branchname, email
1152 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1154 my $dbh = C4::Context->dbh;
1155 my $sth = $dbh->prepare("$select where userid=?");
1156 $sth->execute($userid);
1157 unless ( $sth->rows ) {
1158 $sth = $dbh->prepare("$select where cardnumber=?");
1159 $sth->execute($cardnumber);
1161 unless ( $sth->rows ) {
1162 $sth->execute($userid);
1166 ( $borrowernumber, $firstname, $surname, $userflags,
1167 $branchcode, $branchname, $emailaddress ) = $sth->fetchrow;
1170 # launch a sequence to check if we have a ip for the branch, i
1171 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1173 my $ip = $ENV{'REMOTE_ADDR'};
1175 # if they specify at login, use that
1176 my $patron = Koha::Patrons->find({userid => $userid});
1177 if ( $query->param('branch') && ( haspermission($userid, { 'loggedinlibrary'=> 1 }) || $patron->is_superlibrarian ) ) {
1178 $branchcode = $query->param('branch');
1179 my $library = Koha::Libraries->find($branchcode);
1180 $branchname = $library? $library->branchname: '';
1182 if ( $query->param('desk_id') ) {
1183 $desk_id = $query->param('desk_id');
1184 my $desk = Koha::Desks->find($desk_id);
1185 $desk_name = $desk ? $desk->desk_name : '';
1187 if ( C4::Context->preference('UseCashRegisters') ) {
1189 $query->param('register_id')
1190 ? Koha::Cash::Registers->find($query->param('register_id'))
1191 : Koha::Cash::Registers->search(
1192 { branch => $branchcode, branch_default => 1 },
1193 { rows => 1 } )->single;
1194 $register_id = $register->id if ($register);
1195 $register_name = $register->name if ($register);
1197 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1198 if ( $type ne 'opac' and C4::Context->preference('AutoLocation') ) {
1200 # we have to check they are coming from the right ip range
1201 my $domain = $branches->{$branchcode}->{'branchip'};
1202 $domain =~ s|\.\*||g;
1203 if ( $ip !~ /^$domain/ ) {
1204 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1205 -name => 'CGISESSID',
1208 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1211 $info{'wrongip'} = 1;
1212 $auth_state = "failed";
1216 if ( C4::Context->preference('AutoLocation') && $auth_state ne 'failed' ) {
1217 foreach my $br ( uniq( $branchcode, keys %$branches ) ) {
1219 # now we work with the treatment of ip
1220 my $domain = $branches->{$br}->{'branchip'};
1221 if ( $domain && $ip =~ /^$domain/ ) {
1222 $branchcode = $branches->{$br}->{'branchcode'};
1224 # new op dev : add the branchname to the cookie
1225 $branchname = $branches->{$br}->{'branchname'};
1231 my $is_sco_user = 0;
1232 if ( $query->param('sco_user_login') && ( $query->param('sco_user_login') eq '1' ) ){
1236 $session->param( 'number', $borrowernumber );
1237 $session->param( 'id', $userid );
1238 $session->param( 'cardnumber', $cardnumber );
1239 $session->param( 'firstname', $firstname );
1240 $session->param( 'surname', $surname );
1241 $session->param( 'branch', $branchcode );
1242 $session->param( 'branchname', $branchname );
1243 $session->param( 'desk_id', $desk_id);
1244 $session->param( 'desk_name', $desk_name);
1245 $session->param( 'flags', $userflags );
1246 $session->param( 'emailaddress', $emailaddress );
1247 $session->param( 'ip', $session->remote_addr() );
1248 $session->param( 'lasttime', time() );
1249 $session->param( 'interface', $type);
1250 $session->param( 'shibboleth', $shibSuccess );
1251 $session->param( 'register_id', $register_id );
1252 $session->param( 'register_name', $register_name );
1253 $session->param( 'sco_user', $is_sco_user );
1255 $session->param('cas_ticket', $cas_ticket) if $cas_ticket;
1256 C4::Context->set_userenv(
1257 $session->param('number'), $session->param('id'),
1258 $session->param('cardnumber'), $session->param('firstname'),
1259 $session->param('surname'), $session->param('branch'),
1260 $session->param('branchname'), $session->param('flags'),
1261 $session->param('emailaddress'), $session->param('shibboleth'),
1262 $session->param('desk_id'), $session->param('desk_name'),
1263 $session->param('register_id'), $session->param('register_name')
1267 # $return: 0 = invalid user
1268 # reset to anonymous session
1271 $info{'invalid_username_or_password'} = 1;
1272 C4::Context::_unset_userenv($sessionID);
1274 $session->param( 'lasttime', time() );
1275 $session->param( 'ip', $session->remote_addr() );
1276 $session->param( 'sessiontype', 'anon' );
1277 $session->param( 'interface', $type);
1279 } # END if ( $q_userid
1280 elsif ( $type eq "opac" ) {
1282 # anonymous sessions are created only for the OPAC
1284 # setting a couple of other session vars...
1285 $session->param( 'ip', $session->remote_addr() );
1286 $session->param( 'lasttime', time() );
1287 $session->param( 'sessiontype', 'anon' );
1288 $session->param( 'interface', $type);
1291 } # END unless ($userid)
1294 if ( $auth_state eq 'logged_in' ) {
1295 $auth_state = 'completed';
1297 # Auth is completed unless an additional auth is needed
1298 if ( $require_2FA ) {
1299 my $patron = Koha::Patrons->find({userid => $userid});
1300 if ( C4::Context->preference('TwoFactorAuthentication') eq "enforced" && $patron->auth_method eq 'password' ) {
1301 $auth_state = 'setup-additional-auth-needed';
1302 $session->param('waiting-for-2FA-setup', 1);
1303 %info = ();# We remove the warnings/errors we may have set incorrectly before
1304 } elsif ( $patron->auth_method eq 'two-factor' ) {
1305 # Ask for the OTP token
1306 $auth_state = 'additional-auth-needed';
1307 $session->param('waiting-for-2FA', 1);
1308 %info = ();# We remove the warnings/errors we may have set incorrectly before
1313 # finished authentification, now respond
1314 if ( $auth_state eq 'completed' || $authnotrequired ) {
1317 $cookie = $cookie_mgr->replace_in_list( $cookie, $query->cookie(
1318 -name => 'CGISESSID',
1321 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1326 my $patron = $userid ? Koha::Patrons->find({ userid => $userid }) : undef;
1327 $patron->update_lastseen('login') if $patron;
1329 # In case, that this request was a login attempt, we want to prevent that users can repost the opac login
1330 # request. We therefore redirect the user to the requested page again without the login parameters.
1331 # See Post/Redirect/Get (PRG) design pattern: https://en.wikipedia.org/wiki/Post/Redirect/Get
1332 if ( $type eq "opac" && $query->param('koha_login_context') && $query->param('koha_login_context') ne 'sco' && $query->param('password') && $query->param('userid') ) {
1333 my $uri = URI->new($query->url(-relative=>1, -query_string=>1));
1334 $uri->query_param_delete('userid');
1335 $uri->query_param_delete('password');
1336 $uri->query_param_delete('koha_login_context');
1337 unless ( $params->{do_not_print} ) {
1338 print $query->redirect( -uri => $uri->as_string, -cookie => $cookie, -status => '303 See other' );
1343 return ( $userid, $cookie, $sessionID, $flags );
1348 # AUTH rejected, show the login/password template, after checking the DB.
1352 my $patron = Koha::Patrons->find({ userid => $q_userid }); # Not necessary logged in!
1354 # get the inputs from the incoming query
1356 my @inputs_to_clean = qw( userid password ticket logout.x otp_token );
1357 foreach my $name ( param $query) {
1358 next if grep { $name eq $_ } @inputs_to_clean;
1359 my @value = $query->multi_param($name);
1360 push @inputs, { name => $name, value => $_ } for @value;
1363 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1364 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1365 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1367 my $auth_template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1368 my $auth_error = $query->param('auth_error');
1369 my $template = C4::Templates::gettemplate( $auth_template_name, $type, $query );
1373 script_name => get_script_name(),
1374 casAuthentication => C4::Context->preference("casAuthentication"),
1375 shibbolethAuthentication => $shib,
1376 suggestion => C4::Context->preference("suggestion"),
1377 virtualshelves => C4::Context->preference("virtualshelves"),
1378 LibraryName => "" . C4::Context->preference("LibraryName"),
1379 LibraryNameTitle => "" . $LibraryNameTitle,
1380 opacuserlogin => C4::Context->preference("opacuserlogin"),
1381 OpacFavicon => C4::Context->preference("OpacFavicon"),
1382 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1383 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1384 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1385 OpacCloud => C4::Context->preference("OpacCloud"),
1386 OpacTopissue => C4::Context->preference("OpacTopissue"),
1387 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1388 OpacBrowser => C4::Context->preference("OpacBrowser"),
1389 TagsEnabled => C4::Context->preference("TagsEnabled"),
1390 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1391 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1392 IntranetNav => C4::Context->preference("IntranetNav"),
1393 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1394 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1395 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1396 IndependentBranches => C4::Context->preference("IndependentBranches"),
1397 AutoLocation => C4::Context->preference("AutoLocation"),
1398 wrongip => $info{'wrongip'},
1399 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1400 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1401 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1402 too_many_login_attempts => ( $patron and $patron->account_locked ),
1403 password_has_expired => ( $patron and $patron->password_expired ),
1404 auth_error => $auth_error,
1407 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1408 $template->param( SCI_login => 1 ) if ( $query->param('sci_user_login') );
1409 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1410 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1411 if ( $auth_state eq 'additional-auth-needed' ) {
1412 my $patron = Koha::Patrons->find( { userid => $userid } );
1415 invalid_otp_token => $invalid_otp_token,
1416 notice_email_address => $patron->notice_email_address, # We could also pass logged_in_user if necessary
1420 if ( $auth_state eq 'setup-additional-auth-needed' ) {
1426 if ( $type eq 'opac' ) {
1427 require Koha::Virtualshelves;
1428 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1434 some_public_shelves => $some_public_shelves,
1440 # Is authentication against multiple CAS servers enabled?
1441 require C4::Auth_with_cas;
1442 if ( multipleAuth() && !$casparam ) {
1443 my $casservers = getMultipleAuth();
1445 foreach my $key ( keys %$casservers ) {
1446 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1449 casServersLoop => \@tmplservers
1453 casServerUrl => login_cas_url($query, undef, $type),
1458 invalidCasLogin => $info{'invalidCasLogin'}
1463 #If shibOnly is enabled just go ahead and redirect directly
1464 if ( (($type eq 'opac') && C4::Context->preference('OPACShibOnly')) || (($type ne 'opac') && C4::Context->preference('staffShibOnly')) ) {
1465 my $redirect_url = login_shib_url( $query );
1466 print $query->redirect( -uri => "$redirect_url", -status => 303 );
1471 shibbolethAuthentication => $shib,
1472 shibbolethLoginUrl => login_shib_url($query),
1476 if (C4::Context->preference('GoogleOpenIDConnect')) {
1477 if ($query->param("OpenIDConnectFailed")) {
1478 my $reason = $query->param('OpenIDConnectFailed');
1479 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1484 LibraryName => C4::Context->preference("LibraryName"),
1486 sessionID => $session->id,
1489 if ( $params->{do_not_print} ) {
1490 # This must be used for testing purpose only!
1491 return ( undef, undef, undef, undef, $template );
1494 print $query->header(
1495 { type => 'text/html',
1498 'X-Frame-Options' => 'SAMEORIGIN',
1506 =head2 check_api_auth
1508 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1510 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1511 cookie, determine if the user has the privileges specified by C<$userflags>.
1513 C<check_api_auth> is is meant for authenticating users of web services, and
1514 consequently will always return and will not attempt to redirect the user
1517 If a valid session cookie is already present, check_api_auth will return a status
1518 of "ok", the cookie, and the Koha session ID.
1520 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1521 parameters and create a session cookie and Koha session if the supplied credentials
1524 Possible return values in C<$status> are:
1528 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1530 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1532 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1534 =item "expired -- session cookie has expired; API user should resubmit userid and password
1536 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1538 =item "additional-auth-needed -- User is in an authentication process that is not finished
1544 sub check_api_auth {
1547 my $flagsrequired = shift;
1548 my $timeout = _timeout_syspref();
1550 unless ( C4::Context->preference('Version') ) {
1552 # database has not been installed yet
1553 return ( "maintenance", undef, undef );
1555 my $kohaversion = Koha::version();
1556 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1557 if ( C4::Context->preference('Version') < $kohaversion ) {
1559 # database in need of version update; assume that
1560 # no API should be called while databsae is in
1562 return ( "maintenance", undef, undef );
1565 my ( $sessionID, $session );
1566 unless ( $query->param('userid') ) {
1567 $sessionID = $query->cookie("CGISESSID");
1569 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1572 ( $return, $session, undef ) = check_cookie_auth(
1573 $sessionID, $flagsrequired, { remote_addr => $ENV{REMOTE_ADDR} } );
1575 return ( $return, undef, undef ) # Cookie auth failed
1578 my $cookie = $query->cookie(
1579 -name => 'CGISESSID',
1580 -value => $session->id,
1582 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1585 return ( $return, $cookie, $session ); # return == 'ok' here
1590 my $userid = $query->param('userid');
1591 my $password = $query->param('password');
1592 my ( $return, $cardnumber, $cas_ticket );
1595 if ( $cas && $query->param('PT') ) {
1598 # In case of a CAS authentication, we use the ticket instead of the password
1599 my $PT = $query->param('PT');
1600 ( $return, $cardnumber, $userid, $cas_ticket ) = check_api_auth_cas( $PT, $query ); # EXTERNAL AUTH
1603 # User / password auth
1604 unless ( $userid and $password ) {
1606 # caller did something wrong, fail the authenticateion
1607 return ( "failed", undef, undef );
1611 ( $return, $cardnumber, $newuserid, $patron, $cas_ticket ) = checkpw( $userid, $password, $query );
1614 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1615 my $session = get_session("");
1616 return ( "failed", undef, undef ) unless $session;
1618 my $sessionID = $session->id;
1619 C4::Context->_new_userenv($sessionID);
1620 my $cookie = $query->cookie(
1621 -name => 'CGISESSID',
1622 -value => $sessionID,
1624 -secure => ( C4::Context->https_enabled() ? 1 : 0 ),
1627 if ( $return == 1 ) {
1629 $borrowernumber, $firstname, $surname,
1630 $userflags, $branchcode, $branchname,
1633 my $dbh = C4::Context->dbh;
1636 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where userid=?"
1638 $sth->execute($userid);
1640 $borrowernumber, $firstname, $surname,
1641 $userflags, $branchcode, $branchname,
1643 ) = $sth->fetchrow if ( $sth->rows );
1645 unless ( $sth->rows ) {
1646 my $sth = $dbh->prepare(
1647 "select borrowernumber, firstname, surname, flags, borrowers.branchcode, branches.branchname as branchname, email from borrowers left join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1649 $sth->execute($cardnumber);
1651 $borrowernumber, $firstname, $surname,
1652 $userflags, $branchcode, $branchname,
1654 ) = $sth->fetchrow if ( $sth->rows );
1656 unless ( $sth->rows ) {
1657 $sth->execute($userid);
1659 $borrowernumber, $firstname, $surname, $userflags,
1660 $branchcode, $branchname, $emailaddress
1661 ) = $sth->fetchrow if ( $sth->rows );
1665 my $ip = $ENV{'REMOTE_ADDR'};
1667 # if they specify at login, use that
1668 if ( $query->param('branch') ) {
1669 $branchcode = $query->param('branch');
1670 my $library = Koha::Libraries->find($branchcode);
1671 $branchname = $library? $library->branchname: '';
1673 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search->as_list };
1674 foreach my $br ( keys %$branches ) {
1676 # now we work with the treatment of ip
1677 my $domain = $branches->{$br}->{'branchip'};
1678 if ( $domain && $ip =~ /^$domain/ ) {
1679 $branchcode = $branches->{$br}->{'branchcode'};
1681 # new op dev : add the branchname to the cookie
1682 $branchname = $branches->{$br}->{'branchname'};
1685 $session->param( 'number', $borrowernumber );
1686 $session->param( 'id', $userid );
1687 $session->param( 'cardnumber', $cardnumber );
1688 $session->param( 'firstname', $firstname );
1689 $session->param( 'surname', $surname );
1690 $session->param( 'branch', $branchcode );
1691 $session->param( 'branchname', $branchname );
1692 $session->param( 'flags', $userflags );
1693 $session->param( 'emailaddress', $emailaddress );
1694 $session->param( 'ip', $session->remote_addr() );
1695 $session->param( 'lasttime', time() );
1696 $session->param( 'interface', 'api' );
1698 $session->param( 'cas_ticket', $cas_ticket);
1699 C4::Context->set_userenv(
1700 $session->param('number'), $session->param('id'),
1701 $session->param('cardnumber'), $session->param('firstname'),
1702 $session->param('surname'), $session->param('branch'),
1703 $session->param('branchname'), $session->param('flags'),
1704 $session->param('emailaddress'), $session->param('shibboleth'),
1705 $session->param('desk_id'), $session->param('desk_name'),
1706 $session->param('register_id'), $session->param('register_name')
1708 return ( "ok", $cookie, $sessionID );
1710 return ( "failed", undef, undef );
1715 =head2 check_cookie_auth
1717 ($status, $sessionId) = check_cookie_auth($cookie, $userflags);
1719 Given a CGISESSID cookie set during a previous login to Koha, determine
1720 if the user has the privileges specified by C<$userflags>. C<$userflags>
1721 is passed unaltered into C<haspermission> and as such accepts all options
1722 avaiable to that routine with the one caveat that C<check_api_auth> will
1723 also allow 'undef' to be passed and in such a case the permissions check
1724 will be skipped altogether.
1726 C<check_cookie_auth> is meant for authenticating special services
1727 such as tools/upload-file.pl that are invoked by other pages that
1728 have been authenticated in the usual way.
1730 Possible return values in C<$status> are:
1734 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1736 =item "anon" -- user not authenticated but valid for anonymous session.
1738 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1740 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1742 =item "expired -- session cookie has expired; API user should resubmit userid and password
1744 =item "restricted" -- The IP has changed (if SessionRestrictionByIP)
1750 sub check_cookie_auth {
1751 my $sessionID = shift;
1752 my $flagsrequired = shift;
1755 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1757 my $skip_version_check = $params->{skip_version_check}; # Only for checkauth
1759 unless ( $skip_version_check ) {
1760 unless ( C4::Context->preference('Version') ) {
1762 # database has not been installed yet
1763 return ( "maintenance", undef );
1765 my $kohaversion = Koha::version();
1766 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1767 if ( C4::Context->preference('Version') < $kohaversion ) {
1769 # database in need of version update; assume that
1770 # no API should be called while databsae is in
1772 return ( "maintenance", undef );
1776 # see if we have a valid session cookie already
1777 # however, if a userid parameter is present (i.e., from
1778 # a form submission, assume that any current cookie
1780 unless ( $sessionID ) {
1781 return ( "failed", undef );
1783 C4::Context::_unset_userenv($sessionID); # remove old userenv first
1784 my $session = get_session($sessionID);
1786 my $userid = $session->param('id');
1787 my $ip = $session->param('ip');
1788 my $lasttime = $session->param('lasttime');
1789 my $timeout = _timeout_syspref();
1791 if ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
1795 return ("expired", undef);
1797 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1798 # IP address changed
1801 return ( "restricted", undef, { old_ip => $ip, new_ip => $remote_addr});
1803 } elsif ( $userid ) {
1804 $session->param( 'lasttime', time() );
1805 my $patron = Koha::Patrons->find({ userid => $userid });
1807 # If the user modify their own userid
1808 # Better than 500 but we could do better
1809 unless ( $patron ) {
1812 return ("expired", undef);
1815 $patron = Koha::Patrons->find({ cardnumber => $userid })
1817 return ("password_expired", undef ) if $patron->password_expired;
1818 my $flags = defined($flagsrequired) ? haspermission( $userid, $flagsrequired ) : 1;
1820 C4::Context->_new_userenv($sessionID);
1821 if ( !C4::Context->interface ) {
1822 # No need to override the interface, most often set by get_template_and_user
1823 C4::Context->interface( $session->param('interface') );
1825 C4::Context->set_userenv(
1826 $session->param('number'), $session->param('id') // '',
1827 $session->param('cardnumber'), $session->param('firstname'),
1828 $session->param('surname'), $session->param('branch'),
1829 $session->param('branchname'), $session->param('flags'),
1830 $session->param('emailaddress'), $session->param('shibboleth'),
1831 $session->param('desk_id'), $session->param('desk_name'),
1832 $session->param('register_id'), $session->param('register_name')
1834 if ( C4::Context->preference('TwoFactorAuthentication') ne 'disabled' ) {
1835 return ( "additional-auth-needed", $session )
1836 if $session->param('waiting-for-2FA');
1838 return ( "setup-additional-auth-needed", $session )
1839 if $session->param('waiting-for-2FA-setup');
1842 return ( "ok", $session );
1846 return ( "failed", undef );
1850 C4::Context->_new_userenv($sessionID);
1851 C4::Context->interface($session->param('interface'));
1852 C4::Context->set_userenv( undef, q{} );
1853 return ( "anon", $session );
1856 return ( "expired", undef );
1863 my $session = get_session($sessionID);
1865 Given a session ID, retrieve the CGI::Session object used to store
1866 the session's state. The session object can be used to store
1867 data that needs to be accessed by different scripts during a
1870 If the C<$sessionID> parameter is an empty string, a new session
1875 #NOTE: We're keeping this for backwards compatibility
1876 sub _get_session_params {
1877 return Koha::Session->_get_session_params();
1880 #NOTE: We're keeping this for backwards compatibility
1882 my $sessionID = shift;
1883 my $session = Koha::Session->get_session( { sessionID => $sessionID } );
1887 =head2 create_basic_session
1889 my $session = create_basic_session({ patron => $patron, interface => $interface });
1891 Creates a session and adds all basic parameters for a session to work
1895 sub create_basic_session {
1897 my $patron = $params->{patron};
1898 my $interface = $params->{interface};
1900 $interface = 'intranet' if $interface eq 'staff';
1902 my $session = get_session("");
1904 $session->param( 'number', $patron->borrowernumber );
1905 $session->param( 'id', $patron->userid );
1906 $session->param( 'cardnumber', $patron->cardnumber );
1907 $session->param( 'firstname', $patron->firstname );
1908 $session->param( 'surname', $patron->surname );
1909 $session->param( 'branch', $patron->branchcode );
1910 $session->param( 'branchname', $patron->library->branchname );
1911 $session->param( 'flags', $patron->flags );
1912 $session->param( 'emailaddress', $patron->email );
1913 $session->param( 'ip', $session->remote_addr() );
1914 $session->param( 'lasttime', time() );
1915 $session->param( 'interface', $interface);
1921 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1922 # (or something similar)
1923 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1924 # not having a userenv defined could cause a crash.
1926 my ( $userid, $password, $query, $type, $no_set_userenv ) = @_;
1927 $type = 'opac' unless $type;
1929 # Get shibboleth login attribute
1930 my $shib = C4::Context->config('useshibboleth') && shib_ok();
1931 my $shib_login = $shib ? get_login_shib() : undef;
1935 if ( defined $userid ) {
1936 $patron = Koha::Patrons->find( { userid => $userid } );
1937 $patron = Koha::Patrons->find( { cardnumber => $userid } ) unless $patron;
1939 my $check_internal_as_fallback = 0;
1942 # Note: checkpw_* routines returns:
1945 # -1 if user bind failed (LDAP only)
1947 if ( $patron and ( $patron->account_locked ) ) {
1949 # Nothing to check, account is locked
1950 } elsif ( $ldap && defined($password) ) {
1951 my ( $retval, $retcard, $retuserid );
1952 ( $retval, $retcard, $retuserid, $patron ) = checkpw_ldap(@_); # EXTERNAL AUTH
1953 if ( $retval == 1 ) {
1954 @return = ( $retval, $retcard, $retuserid, $patron );
1957 $check_internal_as_fallback = 1 if $retval == 0;
1959 } elsif ( $cas && $query && $query->param('ticket') ) {
1961 # In case of a CAS authentication, we use the ticket instead of the password
1962 my $ticket = $query->param('ticket');
1963 $query->delete('ticket'); # remove ticket to come back to original URL
1964 my ( $retval, $retcard, $retuserid, $cas_ticket, $patron ) =
1965 checkpw_cas( $ticket, $query, $type ); # EXTERNAL AUTH
1967 @return = ( $retval, $retcard, $retuserid, $patron, $cas_ticket );
1971 $passwd_ok = $retval;
1974 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1975 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1977 elsif ( $shib && $shib_login && !$password ) {
1979 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1980 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1981 # shibboleth-authenticated user
1983 # Then, we check if it matches a valid koha user
1985 my ( $retval, $retcard, $retuserid, $patron ) =
1986 C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1988 @return = ( $retval, $retcard, $retuserid, $patron );
1990 $passwd_ok = $retval;
1993 $check_internal_as_fallback = 1;
1997 if ($check_internal_as_fallback) {
1998 @return = checkpw_internal( $userid, $password, $no_set_userenv );
1999 push( @return, $patron );
2000 $passwd_ok = 1 if $return[0] > 0; # 1 or 2
2005 $patron->update( { login_attempts => 0 } );
2006 if ( $patron->password_expired ) {
2007 @return = ( -2, $patron );
2009 } elsif ( !$patron->account_locked ) {
2010 $patron->update( { login_attempts => $patron->login_attempts + 1 } );
2014 # Optionally log success or failure
2015 if ( $patron && $passwd_ok && C4::Context->preference('AuthSuccessLog') ) {
2016 logaction( 'AUTH', 'SUCCESS', $patron->id, "Valid password for $userid", $type );
2017 } elsif ( !$passwd_ok && C4::Context->preference('AuthFailureLog') ) {
2018 logaction( 'AUTH', 'FAILURE', $patron ? $patron->id : 0, "Wrong password for $userid", $type );
2024 sub checkpw_internal {
2025 my ( $userid, $password, $no_set_userenv ) = @_;
2027 $password = Encode::encode( 'UTF-8', $password )
2028 if Encode::is_utf8($password);
2030 my $dbh = C4::Context->dbh;
2033 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
2035 $sth->execute($userid);
2037 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2038 $surname, $branchcode, $branchname, $flags )
2041 if ( checkpw_hash( $password, $stored_hash ) ) {
2043 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
2044 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2045 return 1, $cardnumber, $userid;
2050 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
2052 $sth->execute($userid);
2054 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
2055 $surname, $branchcode, $branchname, $flags )
2058 if ( checkpw_hash( $password, $stored_hash ) ) {
2060 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
2061 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
2062 return 1, $cardnumber, $userid;
2069 my ( $password, $stored_hash ) = @_;
2071 return if $stored_hash eq '!';
2073 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
2075 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
2076 $hash = hash_password( $password, $stored_hash );
2078 $hash = md5_base64($password);
2080 return $hash eq $stored_hash;
2085 my $authflags = getuserflags($flags, $userid, [$dbh]);
2087 Translates integer flags into permissions strings hash.
2089 C<$flags> is the integer userflags value ( borrowers.userflags )
2090 C<$userid> is the members.userid, used for building subpermissions
2091 C<$authflags> is a hashref of permissions
2098 my $dbh = @_ ? shift : C4::Context->dbh;
2101 # I don't want to do this, but if someone logs in as the database
2102 # user, it would be preferable not to spam them to death with
2103 # numeric warnings. So, we make $flags numeric.
2104 no warnings 'numeric';
2107 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
2110 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
2111 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
2112 $userflags->{$flag} = 1;
2115 $userflags->{$flag} = 0;
2119 # get subpermissions and merge with top-level permissions
2120 my $user_subperms = get_user_subpermissions($userid);
2121 foreach my $module ( keys %$user_subperms ) {
2122 next if $userflags->{$module} == 1; # user already has permission for everything in this module
2123 $userflags->{$module} = $user_subperms->{$module};
2129 =head2 get_user_subpermissions
2131 $user_perm_hashref = get_user_subpermissions($userid);
2133 Given the userid (note, not the borrowernumber) of a staff user,
2134 return a hashref of hashrefs of the specific subpermissions
2135 accorded to the user. An example return is
2139 export_catalog => 1,
2140 import_patrons => 1,
2144 The top-level hash-key is a module or function code from
2145 userflags.flag, while the second-level key is a code
2148 The results of this function do not give a complete picture
2149 of the functions that a staff user can access; it is also
2150 necessary to check borrowers.flags.
2154 sub get_user_subpermissions {
2157 my $dbh = C4::Context->dbh;
2158 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
2159 FROM user_permissions
2160 JOIN permissions USING (module_bit, code)
2161 JOIN userflags ON (module_bit = bit)
2162 JOIN borrowers USING (borrowernumber)
2163 WHERE userid = ?" );
2164 $sth->execute($userid);
2166 my $user_perms = {};
2167 while ( my $perm = $sth->fetchrow_hashref ) {
2168 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2173 =head2 get_all_subpermissions
2175 my $perm_hashref = get_all_subpermissions();
2177 Returns a hashref of hashrefs defining all specific
2178 permissions currently defined. The return value
2179 has the same structure as that of C<get_user_subpermissions>,
2180 except that the innermost hash value is the description
2181 of the subpermission.
2185 sub get_all_subpermissions {
2186 my $dbh = C4::Context->dbh;
2187 my $sth = $dbh->prepare( "SELECT flag, code
2189 JOIN userflags ON (module_bit = bit)" );
2193 while ( my $perm = $sth->fetchrow_hashref ) {
2194 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
2199 =head2 get_cataloguing_page_permissions
2201 my $required_permissions = get_cataloguing_page_permissions();
2203 Returns the required permissions to access the main cataloguing page. Useful for building
2204 the global I<can_see_cataloguing_module> template variable, and also for reusing in
2205 I<cataloging-home.pl>.
2209 sub get_cataloguing_page_permissions {
2211 my @cataloguing_tools_subperms = qw(
2218 marc_modification_templates
2226 { editcatalogue => '*' }, { tools => \@cataloguing_tools_subperms },
2227 C4::Context->preference('StockRotation') ? { stockrotation => 'manage_rotas' } : ()
2231 =head2 haspermission
2233 $flagsrequired = '*'; # Any permission at all
2234 $flagsrequired = 'a_flag'; # a_flag must be satisfied (all subpermissions)
2235 $flagsrequired = [ 'a_flag', 'b_flag' ]; # a_flag OR b_flag must be satisfied
2236 $flagsrequired = { 'a_flag => 1, 'b_flag' => 1 }; # a_flag AND b_flag must be satisfied
2237 $flagsrequired = { 'a_flag' => 'sub_a' }; # sub_a of a_flag must be satisfied
2238 $flagsrequired = { 'a_flag' => [ 'sub_a, 'sub_b' ] }; # sub_a OR sub_b of a_flag must be satisfied
2239 $flagsrequired = { 'a_flag' => { 'sub_a' => 1, 'sub_b' => 1 } }; # sub_a AND sub_b of a_flag must be satisfied
2241 $flags = ($userid, $flagsrequired);
2243 C<$userid> the userid of the member
2244 C<$flags> is a query structure similar to that used by SQL::Abstract that
2245 denotes the combination of flags required. It is a required parameter.
2247 The main logic of this method is that things in arrays are OR'ed, and things
2248 in hashes are AND'ed. The `*` character can be used, at any depth, to denote `ANY`
2250 Returns member's flags or 0 if a permission is not met.
2255 my ($required, $flags) = @_;
2257 my $ref = ref($required);
2259 if ($required eq '*') {
2260 return 0 unless ( $flags or ref( $flags ) );
2262 return 0 unless ( $flags and (!ref( $flags ) || $flags->{$required} ));
2264 } elsif ($ref eq 'HASH') {
2265 foreach my $key (keys %{$required}) {
2266 next if $flags == 1;
2267 my $require = $required->{$key};
2268 my $rflags = $flags->{$key};
2269 return 0 unless _dispatch($require, $rflags);
2271 } elsif ($ref eq 'ARRAY') {
2273 foreach my $require ( @{$required} ) {
2275 ( ref($flags) && !ref($require) && ( $require ne '*' ) )
2276 ? $flags->{$require}
2278 $satisfied++ if _dispatch( $require, $rflags );
2280 return 0 unless $satisfied;
2282 croak "Unexpected structure found: $ref";
2289 my ( $userid, $flagsrequired ) = @_;
2291 #Koha::Exceptions::WrongParameter->throw('$flagsrequired should not be undef')
2292 # unless defined($flagsrequired);
2294 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2295 $sth->execute($userid);
2296 my $row = $sth->fetchrow();
2297 my $flags = getuserflags( $row, $userid );
2299 return $flags unless defined($flagsrequired);
2300 return $flags if $flags->{superlibrarian};
2301 return _dispatch($flagsrequired, $flags);
2303 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2308 $flags = ($iprange);
2310 C<$iprange> A space separated string describing an IP range. Can include single IPs or ranges
2312 Returns 1 if the remote address is in the provided iprange, or 0 otherwise.
2319 my @allowedipranges = $iprange ? split(' ', $iprange) : ();
2320 if (scalar @allowedipranges > 0) {
2322 eval { @rangelist = Net::CIDR::range2cidr(@allowedipranges); }; return 0 if $@;
2323 eval { $result = Net::CIDR::cidrlookup($ENV{'REMOTE_ADDR'}, @rangelist) } || Koha::Logger->get->warn('cidrlookup failed for ' . join(' ',@rangelist) );
2325 return $result ? 1 : 0;
2328 sub getborrowernumber {
2330 my $userenv = C4::Context->userenv;
2331 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2332 return $userenv->{number};
2334 my $dbh = C4::Context->dbh;
2335 for my $field ( 'userid', 'cardnumber' ) {
2337 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2338 $sth->execute($userid);
2340 my ($bnumber) = $sth->fetchrow;
2347 END { } # module clean-up code here (global destructor)
2357 Crypt::Eksblowfish::Bcrypt(3)