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>.
22 use Digest::MD5 qw(md5_base64);
24 use JSON qw/encode_json/;
30 use C4::Templates; # to get the template
32 use C4::Search::History;
35 use Koha::AuthUtils qw(get_script_name hash_password);
37 use Koha::LibraryCategories;
38 use POSIX qw/strftime/;
39 use List::MoreUtils qw/ any /;
40 use Encode qw( encode is_utf8);
43 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $shib $shib_login);
46 sub psgi_env { any { /^psgi\./ } keys %ENV }
49 if (psgi_env) { die 'psgi:exit' }
55 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
56 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
57 &get_all_subpermissions &get_user_subpermissions
59 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
60 $ldap = C4::Context->config('useldapserver') || 0;
61 $cas = C4::Context->preference('casAuthentication');
62 $shib = C4::Context->config('useshibboleth') || 0;
63 $caslogout = C4::Context->preference('casLogout');
64 require C4::Auth_with_cas; # no import
67 require C4::Auth_with_ldap;
68 import C4::Auth_with_ldap qw(checkpw_ldap);
71 require C4::Auth_with_shibboleth;
72 import C4::Auth_with_shibboleth
73 qw(shib_ok checkpw_shib logout_shib login_shib_url get_login_shib);
75 # Check for good config
78 # Get shibboleth login attribute
79 $shib_login = get_login_shib();
82 # Bad config, disable shibboleth
88 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
95 C4::Auth - Authenticates Koha users
105 my ($template, $borrowernumber, $cookie)
106 = get_template_and_user(
108 template_name => "opac-main.tt",
111 authnotrequired => 0,
112 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
116 output_html_with_http_headers $query, $cookie, $template->output;
120 The main function of this module is to provide
121 authentification. However the get_template_and_user function has
122 been provided so that a users login information is passed along
123 automatically. This gets loaded into the template.
127 =head2 get_template_and_user
129 my ($template, $borrowernumber, $cookie)
130 = get_template_and_user(
132 template_name => "opac-main.tt",
135 authnotrequired => 0,
136 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
140 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
141 to C<&checkauth> (in this module) to perform authentification.
142 See C<&checkauth> for an explanation of these parameters.
144 The C<template_name> is then used to find the correct template for
145 the page. The authenticated users details are loaded onto the
146 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
147 C<sessionID> is passed to the template. This can be used in templates
148 if cookies are disabled. It needs to be put as and input to every
151 More information on the C<gettemplate> sub can be found in the
156 sub get_template_and_user {
159 my ( $user, $cookie, $sessionID, $flags );
161 C4::Context->interface( $in->{type} );
163 my $safe_chars = 'a-zA-Z0-9_\-\/';
164 die "bad template path" unless $in->{'template_name'} =~ m/^[$safe_chars]+\.tt$/ig; #sanitize input
166 $in->{'authnotrequired'} ||= 0;
167 my $template = C4::Templates::gettemplate(
168 $in->{'template_name'},
174 if ( $in->{'template_name'} !~ m/maintenance/ ) {
175 ( $user, $cookie, $sessionID, $flags ) = checkauth(
177 $in->{'authnotrequired'},
178 $in->{'flagsrequired'},
184 # If the user logged in is the SCO user and he tries to go out the SCO module, log the user out removing the CGISESSID cookie
185 if ( $in->{type} eq 'opac' and $in->{template_name} !~ m|sco/| ) {
186 if ( C4::Context->preference('AutoSelfCheckID') && $user eq C4::Context->preference('AutoSelfCheckID') ) {
187 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac', $in->{query} );
188 my $cookie = $in->{query}->cookie(
189 -name => 'CGISESSID',
197 script_name => get_script_name(),
199 print $in->{query}->header(
200 { type => 'text/html',
203 'X-Frame-Options' => 'SAMEORIGIN'
215 # It's possible for $user to be the borrowernumber if they don't have a
216 # userid defined (and are logging in through some other method, such
217 # as SSL certs against an email address)
219 $borrowernumber = getborrowernumber($user) if defined($user);
220 if ( !defined($borrowernumber) && defined($user) ) {
221 $borrower = C4::Members::GetMember( borrowernumber => $user );
223 $borrowernumber = $user;
225 # A bit of a hack, but I don't know there's a nicer way
227 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
230 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
234 $template->param( loggedinusername => $user );
235 $template->param( loggedinusernumber => $borrowernumber );
236 $template->param( sessionID => $sessionID );
238 if ( $in->{'type'} eq 'opac' ) {
239 require Koha::Virtualshelves;
240 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
242 borrowernumber => $borrowernumber,
246 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
252 some_private_shelves => $some_private_shelves,
253 some_public_shelves => $some_public_shelves,
257 $template->param( "USER_INFO" => $borrower );
259 my $all_perms = get_all_subpermissions();
261 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
262 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
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 foreach my $module ( keys %$all_perms ) {
287 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
288 $template->param( "CAN_user_${module}_${subperm}" => 1 );
294 foreach my $module ( keys %$all_perms ) {
295 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
296 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
297 $template->param( "CAN_user_${module}_${subperm}" => 1 );
299 } elsif ( ref( $flags->{$module} ) ) {
300 foreach my $subperm ( keys %{ $flags->{$module} } ) {
301 $template->param( "CAN_user_${module}_${subperm}" => 1 );
308 foreach my $module ( keys %$flags ) {
309 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
310 $template->param( "CAN_user_$module" => 1 );
311 if ( $module eq "parameters" ) {
312 $template->param( CAN_user_management => 1 );
318 # Logged-in opac search history
319 # If the requested template is an opac one and opac search history is enabled
320 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
321 my $dbh = C4::Context->dbh;
322 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
323 my $sth = $dbh->prepare($query);
324 $sth->execute($borrowernumber);
326 # If at least one search has already been performed
327 if ( $sth->fetchrow_array > 0 ) {
329 # We show the link in opac
330 $template->param( EnableOpacSearchHistory => 1 );
333 # And if there are searches performed when the user was not logged in,
334 # we add them to the logged-in search history
335 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
336 if (@recentSearches) {
337 my $dbh = C4::Context->dbh;
339 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
340 VALUES (?, ?, ?, ?, ?, ?, ?)
343 my $sth = $dbh->prepare($query);
344 $sth->execute( $borrowernumber,
345 $in->{query}->cookie("CGISESSID"),
348 $_->{type} || 'biblio',
351 ) foreach @recentSearches;
353 # clear out the search history from the session now that
354 # we've saved it to the database
355 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
357 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
358 $template->param( EnableSearchHistory => 1 );
361 else { # if this is an anonymous session, setup to display public lists...
363 # If shibboleth is enabled, and we're in an anonymous session, we should allow
364 # the user to attempt login via shibboleth.
366 $template->param( shibbolethAuthentication => $shib,
367 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
370 # If shibboleth is enabled and we have a shibboleth login attribute,
371 # but we are in an anonymous session, then we clearly have an invalid
372 # shibboleth koha account.
374 $template->param( invalidShibLogin => '1' );
378 $template->param( sessionID => $sessionID );
380 if ( $in->{'type'} eq 'opac' ){
381 require Koha::Virtualshelves;
382 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
388 some_public_shelves => $some_public_shelves,
393 # Anonymous opac search history
394 # If opac search history is enabled and at least one search has already been performed
395 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
396 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
397 if (@recentSearches) {
398 $template->param( EnableOpacSearchHistory => 1 );
402 if ( C4::Context->preference('dateformat') ) {
403 $template->param( dateformat => C4::Context->preference('dateformat') );
406 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
408 # these template parameters are set the same regardless of $in->{'type'}
410 # Set the using_https variable for templates
411 # FIXME Under Plack the CGI->https method always returns 'OFF'
412 my $https = $in->{query}->https();
413 my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
416 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
417 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
418 GoogleJackets => C4::Context->preference("GoogleJackets"),
419 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
420 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
421 LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"} : undef ),
422 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
423 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
424 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
425 loggedinpersona => C4::Context->userenv ? C4::Context->userenv->{"persona"} : undef,
426 TagsEnabled => C4::Context->preference("TagsEnabled"),
427 hide_marc => C4::Context->preference("hide_marc"),
428 item_level_itypes => C4::Context->preference('item-level_itypes'),
429 patronimages => C4::Context->preference("patronimages"),
430 singleBranchMode => ( Koha::Libraries->search->count == 1 ),
431 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
432 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
433 using_https => $using_https,
434 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
435 marcflavour => C4::Context->preference("marcflavour"),
436 persona => C4::Context->preference("persona"),
437 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
439 if ( $in->{'type'} eq "intranet" ) {
441 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
442 AutoLocation => C4::Context->preference("AutoLocation"),
443 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
444 CircAutocompl => C4::Context->preference("CircAutocompl"),
445 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
446 IndependentBranches => C4::Context->preference("IndependentBranches"),
447 IntranetNav => C4::Context->preference("IntranetNav"),
448 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
449 LibraryName => C4::Context->preference("LibraryName"),
450 LoginBranchname => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
451 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
452 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
453 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
454 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
455 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
456 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
457 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
458 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
459 intranetbookbag => C4::Context->preference("intranetbookbag"),
460 suggestion => C4::Context->preference("suggestion"),
461 virtualshelves => C4::Context->preference("virtualshelves"),
462 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
463 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
464 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
465 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
466 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
467 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
468 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
469 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
470 useDischarge => C4::Context->preference('useDischarge'),
474 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
476 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
477 my $LibraryNameTitle = C4::Context->preference("LibraryName");
478 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
479 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
481 # clean up the busc param in the session
482 # if the page is not opac-detail and not the "add to list" page
483 # and not the "edit comments" page
484 if ( C4::Context->preference("OpacBrowseResults")
485 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
487 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
488 or $pagename =~ /^addbybiblionumber$/
489 or $pagename =~ /^review$/ ) {
490 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
491 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
495 # variables passed from CGI: opac_css_override and opac_search_limits.
496 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
497 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
500 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
501 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
502 ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
504 $opac_name = $1; # opac_search_limit is a branch, so we use it.
505 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
506 $opac_name = $in->{'query'}->param('multibranchlimit');
507 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
508 $opac_name = C4::Context->userenv->{'branch'};
511 my $library_categories = Koha::LibraryCategories->search({categorytype => 'searchdomain', show_in_pulldown => 1}, { order_by => ['categorytype', 'categorycode']});
513 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
514 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
515 BranchCategoriesLoop => $library_categories,
516 opac_name => $opac_name,
517 LibraryName => "" . C4::Context->preference("LibraryName"),
518 LibraryNameTitle => "" . $LibraryNameTitle,
519 LoginBranchname => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
520 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
521 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
522 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
523 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
524 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
525 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
526 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
527 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
528 opac_search_limit => $opac_search_limit,
529 opac_limit_override => $opac_limit_override,
530 OpacBrowser => C4::Context->preference("OpacBrowser"),
531 OpacCloud => C4::Context->preference("OpacCloud"),
532 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
533 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
534 OpacNav => "" . C4::Context->preference("OpacNav"),
535 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
536 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
537 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
538 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
539 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
540 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
541 OpacTopissue => C4::Context->preference("OpacTopissue"),
542 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
543 'Version' => C4::Context->preference('Version'),
544 hidelostitems => C4::Context->preference("hidelostitems"),
545 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
546 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
547 opacbookbag => "" . C4::Context->preference("opacbookbag"),
548 opaccredits => "" . C4::Context->preference("opaccredits"),
549 OpacFavicon => C4::Context->preference("OpacFavicon"),
550 opacheader => "" . C4::Context->preference("opacheader"),
551 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
552 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
553 OPACUserJS => C4::Context->preference("OPACUserJS"),
554 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
555 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
556 ShowReviewer => C4::Context->preference("ShowReviewer"),
557 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
558 suggestion => "" . C4::Context->preference("suggestion"),
559 virtualshelves => "" . C4::Context->preference("virtualshelves"),
560 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
561 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
562 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
563 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
564 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
565 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
566 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
567 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
568 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
569 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
570 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
571 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
572 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
573 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
574 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
575 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
576 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
577 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
578 useDischarge => C4::Context->preference('useDischarge'),
581 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
584 # Check if we were asked using parameters to force a specific language
585 if ( defined $in->{'query'}->param('language') ) {
587 # Extract the language, let C4::Languages::getlanguage choose
589 my $language = C4::Languages::getlanguage( $in->{'query'} );
590 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
591 if ( ref $cookie eq 'ARRAY' ) {
592 push @{$cookie}, $languagecookie;
594 $cookie = [ $cookie, $languagecookie ];
598 return ( $template, $borrowernumber, $cookie, $flags );
603 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
605 Verifies that the user is authorized to run this script. If
606 the user is authorized, a (userid, cookie, session-id, flags)
607 quadruple is returned. If the user is not authorized but does
608 not have the required privilege (see $flagsrequired below), it
609 displays an error page and exits. Otherwise, it displays the
610 login page and exits.
612 Note that C<&checkauth> will return if and only if the user
613 is authorized, so it should be called early on, before any
614 unfinished operations (e.g., if you've opened a file, then
615 C<&checkauth> won't close it for you).
617 C<$query> is the CGI object for the script calling C<&checkauth>.
619 The C<$noauth> argument is optional. If it is set, then no
620 authorization is required for the script.
622 C<&checkauth> fetches user and session information from C<$query> and
623 ensures that the user is authorized to run scripts that require
626 The C<$flagsrequired> argument specifies the required privileges
627 the user must have if the username and password are correct.
628 It should be specified as a reference-to-hash; keys in the hash
629 should be the "flags" for the user, as specified in the Members
630 intranet module. Any key specified must correspond to a "flag"
631 in the userflags table. E.g., { circulate => 1 } would specify
632 that the user must have the "circulate" privilege in order to
633 proceed. To make sure that access control is correct, the
634 C<$flagsrequired> parameter must be specified correctly.
636 Koha also has a concept of sub-permissions, also known as
637 granular permissions. This makes the value of each key
638 in the C<flagsrequired> hash take on an additional
643 The user must have access to all subfunctions of the module
644 specified by the hash key.
648 The user must have access to at least one subfunction of the module
649 specified by the hash key.
651 specific permission, e.g., 'export_catalog'
653 The user must have access to the specific subfunction list, which
654 must correspond to a row in the permissions table.
656 The C<$type> argument specifies whether the template should be
657 retrieved from the opac or intranet directory tree. "opac" is
658 assumed if it is not specified; however, if C<$type> is specified,
659 "intranet" is assumed if it is not "opac".
661 If C<$query> does not have a valid session ID associated with it
662 (i.e., the user has not logged in) or if the session has expired,
663 C<&checkauth> presents the user with a login page (from the point of
664 view of the original script, C<&checkauth> does not return). Once the
665 user has authenticated, C<&checkauth> restarts the original script
666 (this time, C<&checkauth> returns).
668 The login page is provided using a HTML::Template, which is set in the
669 systempreferences table or at the top of this file. The variable C<$type>
670 selects which template to use, either the opac or the intranet
671 authentification template.
673 C<&checkauth> returns a user ID, a cookie, and a session ID. The
674 cookie should be sent back to the browser; it verifies that the user
684 # If version syspref is unavailable, it means Koha is being installed,
685 # and so we must redirect to OPAC maintenance page or to the WebInstaller
686 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
687 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
688 warn "OPAC Install required, redirecting to maintenance";
689 print $query->redirect("/cgi-bin/koha/maintenance.pl");
692 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
693 if ( $type ne 'opac' ) {
694 warn "Install required, redirecting to Installer";
695 print $query->redirect("/cgi-bin/koha/installer/install.pl");
697 warn "OPAC Install required, redirecting to maintenance";
698 print $query->redirect("/cgi-bin/koha/maintenance.pl");
703 # check that database and koha version are the same
704 # there is no DB version, it's a fresh install,
705 # go to web installer
706 # there is a DB version, compare it to the code version
707 my $kohaversion = Koha::version();
709 # remove the 3 last . to have a Perl number
710 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
711 $debug and print STDERR "kohaversion : $kohaversion\n";
712 if ( $version < $kohaversion ) {
713 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
714 if ( $type ne 'opac' ) {
715 warn sprintf( $warning, 'Installer' );
716 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
718 warn sprintf( "OPAC: " . $warning, 'maintenance' );
719 print $query->redirect("/cgi-bin/koha/maintenance.pl");
727 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
728 printf $fh join( "\n", @_ );
732 sub _timeout_syspref {
733 my $timeout = C4::Context->preference('timeout') || 600;
735 # value in days, convert in seconds
736 if ( $timeout =~ /(\d+)[dD]/ ) {
737 $timeout = $1 * 86400;
744 $debug and warn "Checking Auth";
746 # $authnotrequired will be set for scripts which will run without authentication
747 my $authnotrequired = shift;
748 my $flagsrequired = shift;
751 $type = 'opac' unless $type;
753 my $dbh = C4::Context->dbh;
754 my $timeout = _timeout_syspref();
756 _version_check( $type, $query );
761 my ( $userid, $cookie, $sessionID, $flags );
762 my $logout = $query->param('logout.x');
764 my $anon_search_history;
766 # This parameter is the name of the CAS server we want to authenticate against,
767 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
768 my $casparam = $query->param('cas');
769 my $q_userid = $query->param('userid') // '';
771 # Basic authentication is incompatible with the use of Shibboleth,
772 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
773 # and it may not be the attribute we want to use to match the koha login.
775 # Also, do not consider an empty REMOTE_USER.
777 # Finally, after those tests, we can assume (although if it would be better with
778 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
779 # and we can affect it to $userid.
780 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
782 # Using Basic Authentication, no cookies required
783 $cookie = $query->cookie(
784 -name => 'CGISESSID',
793 # we don't want to set a session because we are being called by a persona callback
795 elsif ( $sessionID = $query->cookie("CGISESSID") )
796 { # assignment, not comparison
797 my $session = get_session($sessionID);
798 C4::Context->_new_userenv($sessionID);
799 my ( $ip, $lasttime, $sessiontype );
802 $s_userid = $session->param('id') // '';
803 C4::Context->set_userenv(
804 $session->param('number'), $s_userid,
805 $session->param('cardnumber'), $session->param('firstname'),
806 $session->param('surname'), $session->param('branch'),
807 $session->param('branchname'), $session->param('flags'),
808 $session->param('emailaddress'), $session->param('branchprinter'),
809 $session->param('persona'), $session->param('shibboleth')
811 C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
812 C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
813 C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
814 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
815 $ip = $session->param('ip');
816 $lasttime = $session->param('lasttime');
818 $sessiontype = $session->param('sessiontype') || '';
820 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
821 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
822 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
825 #if a user enters an id ne to the id in the current session, we need to log them in...
826 #first we need to clear the anonymous session...
827 $debug and warn "query id = $q_userid but session id = $s_userid";
828 $anon_search_history = $session->param('search_history');
831 C4::Context->_unset_userenv($sessionID);
837 # voluntary logout the user
838 # check wether the user was using their shibboleth session or a local one
839 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
842 C4::Context->_unset_userenv($sessionID);
844 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
848 if ($cas and $caslogout) {
849 logout_cas($query, $type);
852 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
853 if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
855 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
859 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
862 $info{'timed_out'} = 1;
867 C4::Context->_unset_userenv($sessionID);
869 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
873 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
875 # Different ip than originally logged in from
876 $info{'oldip'} = $ip;
877 $info{'newip'} = $ENV{'REMOTE_ADDR'};
878 $info{'different_ip'} = 1;
881 C4::Context->_unset_userenv($sessionID);
883 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
888 $cookie = $query->cookie(
889 -name => 'CGISESSID',
890 -value => $session->id,
893 $session->param( 'lasttime', time() );
894 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...
895 $flags = haspermission( $userid, $flagsrequired );
899 $info{'nopermission'} = 1;
904 unless ( $userid || $sessionID ) {
906 #we initiate a session prior to checking for a username to allow for anonymous sessions...
907 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
909 # Save anonymous search history in new session so it can be retrieved
910 # by get_template_and_user to store it in user's search history after
911 # a successful login.
912 if ($anon_search_history) {
913 $session->param( 'search_history', $anon_search_history );
916 my $sessionID = $session->id;
917 C4::Context->_new_userenv($sessionID);
918 $cookie = $query->cookie(
919 -name => 'CGISESSID',
920 -value => $session->id,
924 my $pki_field = C4::Context->preference('AllowPKIAuth');
925 if ( !defined($pki_field) ) {
926 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
929 if ( ( $cas && $query->param('ticket') )
931 || ( $shib && $shib_login )
932 || $pki_field ne 'None'
935 my $password = $query->param('password');
938 my ( $return, $cardnumber );
940 # If shib is enabled and we have a shib login, does the login match a valid koha user
941 if ( $shib && $shib_login && $type eq 'opac' ) {
944 # Do not pass password here, else shib will not be checked in checkpw.
945 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, undef, $query );
946 $userid = $retuserid;
947 $shibSuccess = $return;
948 $info{'invalidShibLogin'} = 1 unless ($return);
951 # If shib login and match were successful, skip further login methods
952 unless ($shibSuccess) {
953 if ( $cas && $query->param('ticket') ) {
955 ( $return, $cardnumber, $retuserid ) =
956 checkpw( $dbh, $userid, $password, $query, $type );
957 $userid = $retuserid;
958 $info{'invalidCasLogin'} = 1 unless ($return);
962 my $value = $persona;
964 # If we're looking up the email, there's a chance that the person
965 # doesn't have a userid. So if there is none, we pass along the
966 # borrower number, and the bits of code that need to know the user
967 # ID will have to be smart enough to handle that.
969 my @users_info = C4::Members::GetBorrowersWithEmail($value);
972 # First the userid, then the borrowernum
973 $value = $users_info[0][1] || $users_info[0][0];
978 $return = $value ? 1 : 0;
983 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
984 || ( $pki_field eq 'emailAddress'
985 && $ENV{'SSL_CLIENT_S_DN_Email'} )
989 if ( $pki_field eq 'Common Name' ) {
990 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
992 elsif ( $pki_field eq 'emailAddress' ) {
993 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
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.
1000 my @users_info = C4::Members::GetBorrowersWithEmail($value);
1003 # First the userid, then the borrowernum
1004 $value = $users_info[0][1] || $users_info[0][0];
1010 $return = $value ? 1 : 0;
1016 ( $return, $cardnumber, $retuserid ) =
1017 checkpw( $dbh, $userid, $password, $query, $type );
1018 $userid = $retuserid if ($retuserid);
1019 $info{'invalid_username_or_password'} = 1 unless ($return);
1023 # $return: 1 = valid user, 2 = superlibrarian
1026 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1027 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1031 $info{'nopermission'} = 1;
1032 C4::Context->_unset_userenv($sessionID);
1034 my ( $borrowernumber, $firstname, $surname, $userflags,
1035 $branchcode, $branchname, $branchprinter, $emailaddress );
1037 if ( $return == 1 ) {
1039 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1040 branches.branchname as branchname,
1041 branches.branchprinter as branchprinter,
1044 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1046 my $sth = $dbh->prepare("$select where userid=?");
1047 $sth->execute($userid);
1048 unless ( $sth->rows ) {
1049 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1050 $sth = $dbh->prepare("$select where cardnumber=?");
1051 $sth->execute($cardnumber);
1053 unless ( $sth->rows ) {
1054 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1055 $sth->execute($userid);
1056 unless ( $sth->rows ) {
1057 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1062 ( $borrowernumber, $firstname, $surname, $userflags,
1063 $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1064 $debug and print STDERR "AUTH_3 results: " .
1065 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1067 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1070 # launch a sequence to check if we have a ip for the branch, i
1071 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1073 my $ip = $ENV{'REMOTE_ADDR'};
1075 # if they specify at login, use that
1076 if ( $query->param('branch') ) {
1077 $branchcode = $query->param('branch');
1078 my $library = Koha::Libraries->find($branchcode);
1079 $branchname = $library? $library->branchname: '';
1081 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1082 if ( C4::Context->boolean_preference('IndependentBranches') && C4::Context->boolean_preference('Autolocation') ) {
1084 # we have to check they are coming from the right ip range
1085 my $domain = $branches->{$branchcode}->{'branchip'};
1086 if ( $ip !~ /^$domain/ ) {
1088 $info{'wrongip'} = 1;
1092 foreach my $br ( keys %$branches ) {
1094 # now we work with the treatment of ip
1095 my $domain = $branches->{$br}->{'branchip'};
1096 if ( $domain && $ip =~ /^$domain/ ) {
1097 $branchcode = $branches->{$br}->{'branchcode'};
1099 # new op dev : add the branchprinter and branchname in the cookie
1100 $branchprinter = $branches->{$br}->{'branchprinter'};
1101 $branchname = $branches->{$br}->{'branchname'};
1104 $session->param( 'number', $borrowernumber );
1105 $session->param( 'id', $userid );
1106 $session->param( 'cardnumber', $cardnumber );
1107 $session->param( 'firstname', $firstname );
1108 $session->param( 'surname', $surname );
1109 $session->param( 'branch', $branchcode );
1110 $session->param( 'branchname', $branchname );
1111 $session->param( 'flags', $userflags );
1112 $session->param( 'emailaddress', $emailaddress );
1113 $session->param( 'ip', $session->remote_addr() );
1114 $session->param( 'lasttime', time() );
1115 $session->param( 'shibboleth', $shibSuccess );
1116 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1118 elsif ( $return == 2 ) {
1120 #We suppose the user is the superlibrarian
1121 $borrowernumber = 0;
1122 $session->param( 'number', 0 );
1123 $session->param( 'id', C4::Context->config('user') );
1124 $session->param( 'cardnumber', C4::Context->config('user') );
1125 $session->param( 'firstname', C4::Context->config('user') );
1126 $session->param( 'surname', C4::Context->config('user') );
1127 $session->param( 'branch', 'NO_LIBRARY_SET' );
1128 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1129 $session->param( 'flags', 1 );
1130 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1131 $session->param( 'ip', $session->remote_addr() );
1132 $session->param( 'lasttime', time() );
1135 $session->param( 'persona', 1 );
1137 C4::Context->set_userenv(
1138 $session->param('number'), $session->param('id'),
1139 $session->param('cardnumber'), $session->param('firstname'),
1140 $session->param('surname'), $session->param('branch'),
1141 $session->param('branchname'), $session->param('flags'),
1142 $session->param('emailaddress'), $session->param('branchprinter'),
1143 $session->param('persona'), $session->param('shibboleth')
1147 # $return: 0 = invalid user
1148 # reset to anonymous session
1150 $debug and warn "Login failed, resetting anonymous session...";
1152 $info{'invalid_username_or_password'} = 1;
1153 C4::Context->_unset_userenv($sessionID);
1155 $session->param( 'lasttime', time() );
1156 $session->param( 'ip', $session->remote_addr() );
1157 $session->param( 'sessiontype', 'anon' );
1159 } # END if ( $userid = $query->param('userid') )
1160 elsif ( $type eq "opac" ) {
1162 # if we are here this is an anonymous session; add public lists to it and a few other items...
1163 # anonymous sessions are created only for the OPAC
1164 $debug and warn "Initiating an anonymous session...";
1166 # setting a couple of other session vars...
1167 $session->param( 'ip', $session->remote_addr() );
1168 $session->param( 'lasttime', time() );
1169 $session->param( 'sessiontype', 'anon' );
1171 } # END unless ($userid)
1173 # finished authentification, now respond
1174 if ( $loggedin || $authnotrequired )
1178 $cookie = $query->cookie(
1179 -name => 'CGISESSID',
1188 SET lastseen = NOW()
1193 return ( $userid, $cookie, $sessionID, $flags );
1198 # AUTH rejected, show the login/password template, after checking the DB.
1202 # get the inputs from the incoming query
1204 foreach my $name ( param $query) {
1205 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1206 my $value = $query->param($name);
1207 push @inputs, { name => $name, value => $value };
1210 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1211 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1212 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1214 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1215 my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1217 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1218 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1221 script_name => get_script_name(),
1222 casAuthentication => C4::Context->preference("casAuthentication"),
1223 shibbolethAuthentication => $shib,
1224 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1225 suggestion => C4::Context->preference("suggestion"),
1226 virtualshelves => C4::Context->preference("virtualshelves"),
1227 LibraryName => "" . C4::Context->preference("LibraryName"),
1228 LibraryNameTitle => "" . $LibraryNameTitle,
1229 opacuserlogin => C4::Context->preference("opacuserlogin"),
1230 OpacNav => C4::Context->preference("OpacNav"),
1231 OpacNavRight => C4::Context->preference("OpacNavRight"),
1232 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1233 opaccredits => C4::Context->preference("opaccredits"),
1234 OpacFavicon => C4::Context->preference("OpacFavicon"),
1235 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1236 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1237 OPACUserJS => C4::Context->preference("OPACUserJS"),
1238 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1239 OpacCloud => C4::Context->preference("OpacCloud"),
1240 OpacTopissue => C4::Context->preference("OpacTopissue"),
1241 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1242 OpacBrowser => C4::Context->preference("OpacBrowser"),
1243 opacheader => C4::Context->preference("opacheader"),
1244 TagsEnabled => C4::Context->preference("TagsEnabled"),
1245 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1246 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1247 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1248 intranetbookbag => C4::Context->preference("intranetbookbag"),
1249 IntranetNav => C4::Context->preference("IntranetNav"),
1250 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1251 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1252 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1253 IndependentBranches => C4::Context->preference("IndependentBranches"),
1254 AutoLocation => C4::Context->preference("AutoLocation"),
1255 wrongip => $info{'wrongip'},
1256 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1257 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1258 persona => C4::Context->preference("Persona"),
1259 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1262 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1263 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1264 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1266 if ( $type eq 'opac' ) {
1267 require Koha::Virtualshelves;
1268 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1274 some_public_shelves => $some_public_shelves,
1280 # Is authentication against multiple CAS servers enabled?
1281 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1282 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1284 foreach my $key ( keys %$casservers ) {
1285 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1288 casServersLoop => \@tmplservers
1292 casServerUrl => login_cas_url($query, undef, $type),
1297 invalidCasLogin => $info{'invalidCasLogin'}
1303 shibbolethAuthentication => $shib,
1304 shibbolethLoginUrl => login_shib_url($query),
1308 if (C4::Context->preference('GoogleOpenIDConnect')) {
1309 if ($query->param("OpenIDConnectFailed")) {
1310 my $reason = $query->param('OpenIDConnectFailed');
1311 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1316 LibraryName => C4::Context->preference("LibraryName"),
1318 $template->param(%info);
1320 # $cookie = $query->cookie(CGISESSID => $session->id
1322 print $query->header(
1323 { type => 'text/html',
1326 'X-Frame-Options' => 'SAMEORIGIN'
1333 =head2 check_api_auth
1335 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1337 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1338 cookie, determine if the user has the privileges specified by C<$userflags>.
1340 C<check_api_auth> is is meant for authenticating users of web services, and
1341 consequently will always return and will not attempt to redirect the user
1344 If a valid session cookie is already present, check_api_auth will return a status
1345 of "ok", the cookie, and the Koha session ID.
1347 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1348 parameters and create a session cookie and Koha session if the supplied credentials
1351 Possible return values in C<$status> are:
1355 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1357 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1359 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1361 =item "expired -- session cookie has expired; API user should resubmit userid and password
1367 sub check_api_auth {
1369 my $flagsrequired = shift;
1371 my $dbh = C4::Context->dbh;
1372 my $timeout = _timeout_syspref();
1374 unless ( C4::Context->preference('Version') ) {
1376 # database has not been installed yet
1377 return ( "maintenance", undef, undef );
1379 my $kohaversion = Koha::version();
1380 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1381 if ( C4::Context->preference('Version') < $kohaversion ) {
1383 # database in need of version update; assume that
1384 # no API should be called while databsae is in
1386 return ( "maintenance", undef, undef );
1389 # FIXME -- most of what follows is a copy-and-paste
1390 # of code from checkauth. There is an obvious need
1391 # for refactoring to separate the various parts of
1392 # the authentication code, but as of 2007-11-19 this
1393 # is deferred so as to not introduce bugs into the
1394 # regular authentication code for Koha 3.0.
1396 # see if we have a valid session cookie already
1397 # however, if a userid parameter is present (i.e., from
1398 # a form submission, assume that any current cookie
1400 my $sessionID = undef;
1401 unless ( $query->param('userid') ) {
1402 $sessionID = $query->cookie("CGISESSID");
1404 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1405 my $session = get_session($sessionID);
1406 C4::Context->_new_userenv($sessionID);
1408 C4::Context->set_userenv(
1409 $session->param('number'), $session->param('id'),
1410 $session->param('cardnumber'), $session->param('firstname'),
1411 $session->param('surname'), $session->param('branch'),
1412 $session->param('branchname'), $session->param('flags'),
1413 $session->param('emailaddress'), $session->param('branchprinter')
1416 my $ip = $session->param('ip');
1417 my $lasttime = $session->param('lasttime');
1418 my $userid = $session->param('id');
1419 if ( $lasttime < time() - $timeout ) {
1424 C4::Context->_unset_userenv($sessionID);
1427 return ( "expired", undef, undef );
1428 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1430 # IP address changed
1433 C4::Context->_unset_userenv($sessionID);
1436 return ( "expired", undef, undef );
1438 my $cookie = $query->cookie(
1439 -name => 'CGISESSID',
1440 -value => $session->id,
1443 $session->param( 'lasttime', time() );
1444 my $flags = haspermission( $userid, $flagsrequired );
1446 return ( "ok", $cookie, $sessionID );
1450 C4::Context->_unset_userenv($sessionID);
1453 return ( "failed", undef, undef );
1457 return ( "expired", undef, undef );
1462 my $userid = $query->param('userid');
1463 my $password = $query->param('password');
1464 my ( $return, $cardnumber );
1467 if ( $cas && $query->param('PT') ) {
1469 $debug and print STDERR "## check_api_auth - checking CAS\n";
1471 # In case of a CAS authentication, we use the ticket instead of the password
1472 my $PT = $query->param('PT');
1473 ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1476 # User / password auth
1477 unless ( $userid and $password ) {
1479 # caller did something wrong, fail the authenticateion
1480 return ( "failed", undef, undef );
1482 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1485 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1486 my $session = get_session("");
1487 return ( "failed", undef, undef ) unless $session;
1489 my $sessionID = $session->id;
1490 C4::Context->_new_userenv($sessionID);
1491 my $cookie = $query->cookie(
1492 -name => 'CGISESSID',
1493 -value => $sessionID,
1496 if ( $return == 1 ) {
1498 $borrowernumber, $firstname, $surname,
1499 $userflags, $branchcode, $branchname,
1500 $branchprinter, $emailaddress
1504 "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=?"
1506 $sth->execute($userid);
1508 $borrowernumber, $firstname, $surname,
1509 $userflags, $branchcode, $branchname,
1510 $branchprinter, $emailaddress
1511 ) = $sth->fetchrow if ( $sth->rows );
1513 unless ( $sth->rows ) {
1514 my $sth = $dbh->prepare(
1515 "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=?"
1517 $sth->execute($cardnumber);
1519 $borrowernumber, $firstname, $surname,
1520 $userflags, $branchcode, $branchname,
1521 $branchprinter, $emailaddress
1522 ) = $sth->fetchrow if ( $sth->rows );
1524 unless ( $sth->rows ) {
1525 $sth->execute($userid);
1527 $borrowernumber, $firstname, $surname, $userflags,
1528 $branchcode, $branchname, $branchprinter, $emailaddress
1529 ) = $sth->fetchrow if ( $sth->rows );
1533 my $ip = $ENV{'REMOTE_ADDR'};
1535 # if they specify at login, use that
1536 if ( $query->param('branch') ) {
1537 $branchcode = $query->param('branch');
1538 my $library = Koha::Libraries->find($branchcode);
1539 $branchname = $library? $library->branchname: '';
1541 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1542 foreach my $br ( keys %$branches ) {
1544 # now we work with the treatment of ip
1545 my $domain = $branches->{$br}->{'branchip'};
1546 if ( $domain && $ip =~ /^$domain/ ) {
1547 $branchcode = $branches->{$br}->{'branchcode'};
1549 # new op dev : add the branchprinter and branchname in the cookie
1550 $branchprinter = $branches->{$br}->{'branchprinter'};
1551 $branchname = $branches->{$br}->{'branchname'};
1554 $session->param( 'number', $borrowernumber );
1555 $session->param( 'id', $userid );
1556 $session->param( 'cardnumber', $cardnumber );
1557 $session->param( 'firstname', $firstname );
1558 $session->param( 'surname', $surname );
1559 $session->param( 'branch', $branchcode );
1560 $session->param( 'branchname', $branchname );
1561 $session->param( 'flags', $userflags );
1562 $session->param( 'emailaddress', $emailaddress );
1563 $session->param( 'ip', $session->remote_addr() );
1564 $session->param( 'lasttime', time() );
1565 } elsif ( $return == 2 ) {
1567 #We suppose the user is the superlibrarian
1568 $session->param( 'number', 0 );
1569 $session->param( 'id', C4::Context->config('user') );
1570 $session->param( 'cardnumber', C4::Context->config('user') );
1571 $session->param( 'firstname', C4::Context->config('user') );
1572 $session->param( 'surname', C4::Context->config('user') );
1573 $session->param( 'branch', 'NO_LIBRARY_SET' );
1574 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1575 $session->param( 'flags', 1 );
1576 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1577 $session->param( 'ip', $session->remote_addr() );
1578 $session->param( 'lasttime', time() );
1580 C4::Context->set_userenv(
1581 $session->param('number'), $session->param('id'),
1582 $session->param('cardnumber'), $session->param('firstname'),
1583 $session->param('surname'), $session->param('branch'),
1584 $session->param('branchname'), $session->param('flags'),
1585 $session->param('emailaddress'), $session->param('branchprinter')
1587 return ( "ok", $cookie, $sessionID );
1589 return ( "failed", undef, undef );
1594 =head2 check_cookie_auth
1596 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1598 Given a CGISESSID cookie set during a previous login to Koha, determine
1599 if the user has the privileges specified by C<$userflags>.
1601 C<check_cookie_auth> is meant for authenticating special services
1602 such as tools/upload-file.pl that are invoked by other pages that
1603 have been authenticated in the usual way.
1605 Possible return values in C<$status> are:
1609 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1611 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1613 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1615 =item "expired -- session cookie has expired; API user should resubmit userid and password
1621 sub check_cookie_auth {
1623 my $flagsrequired = shift;
1626 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1627 my $dbh = C4::Context->dbh;
1628 my $timeout = _timeout_syspref();
1630 unless ( C4::Context->preference('Version') ) {
1632 # database has not been installed yet
1633 return ( "maintenance", undef );
1635 my $kohaversion = Koha::version();
1636 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1637 if ( C4::Context->preference('Version') < $kohaversion ) {
1639 # database in need of version update; assume that
1640 # no API should be called while databsae is in
1642 return ( "maintenance", undef );
1645 # FIXME -- most of what follows is a copy-and-paste
1646 # of code from checkauth. There is an obvious need
1647 # for refactoring to separate the various parts of
1648 # the authentication code, but as of 2007-11-23 this
1649 # is deferred so as to not introduce bugs into the
1650 # regular authentication code for Koha 3.0.
1652 # see if we have a valid session cookie already
1653 # however, if a userid parameter is present (i.e., from
1654 # a form submission, assume that any current cookie
1656 unless ( defined $cookie and $cookie ) {
1657 return ( "failed", undef );
1659 my $sessionID = $cookie;
1660 my $session = get_session($sessionID);
1661 C4::Context->_new_userenv($sessionID);
1663 C4::Context->set_userenv(
1664 $session->param('number'), $session->param('id'),
1665 $session->param('cardnumber'), $session->param('firstname'),
1666 $session->param('surname'), $session->param('branch'),
1667 $session->param('branchname'), $session->param('flags'),
1668 $session->param('emailaddress'), $session->param('branchprinter')
1671 my $ip = $session->param('ip');
1672 my $lasttime = $session->param('lasttime');
1673 my $userid = $session->param('id');
1674 if ( $lasttime < time() - $timeout ) {
1679 C4::Context->_unset_userenv($sessionID);
1682 return ("expired", undef);
1683 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1685 # IP address changed
1688 C4::Context->_unset_userenv($sessionID);
1691 return ( "expired", undef );
1693 $session->param( 'lasttime', time() );
1694 my $flags = haspermission( $userid, $flagsrequired );
1696 return ( "ok", $sessionID );
1700 C4::Context->_unset_userenv($sessionID);
1703 return ( "failed", undef );
1707 return ( "expired", undef );
1714 my $session = get_session($sessionID);
1716 Given a session ID, retrieve the CGI::Session object used to store
1717 the session's state. The session object can be used to store
1718 data that needs to be accessed by different scripts during a
1721 If the C<$sessionID> parameter is an empty string, a new session
1727 my $sessionID = shift;
1728 my $storage_method = C4::Context->preference('SessionStorage');
1729 my $dbh = C4::Context->dbh;
1731 if ( $storage_method eq 'mysql' ) {
1732 $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1734 elsif ( $storage_method eq 'Pg' ) {
1735 $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1737 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1738 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1739 $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => $memcached } );
1742 # catch all defaults to tmp should work on all systems
1743 my $dir = File::Spec->tmpdir;
1744 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1745 $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => "$dir/cgisess_$instance" } );
1751 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1752 # (or something similar)
1753 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1754 # not having a userenv defined could cause a crash.
1756 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1757 $type = 'opac' unless $type;
1759 $debug and print STDERR "## checkpw - checking LDAP\n";
1760 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1761 return 0 if $retval == -1; # Incorrect password for LDAP login attempt
1762 ($retval) and return ( $retval, $retcard, $retuserid );
1765 if ( $cas && $query && $query->param('ticket') ) {
1766 $debug and print STDERR "## checkpw - checking CAS\n";
1768 # In case of a CAS authentication, we use the ticket instead of the password
1769 my $ticket = $query->param('ticket');
1770 $query->delete('ticket'); # remove ticket to come back to original URL
1771 my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1772 ($retval) and return ( $retval, $retcard, $retuserid );
1776 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1777 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1779 if ( $shib && $shib_login && !$password ) {
1781 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1783 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1784 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1785 # shibboleth-authenticated user
1787 # Then, we check if it matches a valid koha user
1789 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1790 ($retval) and return ( $retval, $retcard, $retuserid );
1796 return checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1799 sub checkpw_internal {
1800 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1802 $password = Encode::encode( 'UTF-8', $password )
1803 if Encode::is_utf8($password);
1805 if ( $userid && $userid eq C4::Context->config('user') ) {
1806 if ( $password && $password eq C4::Context->config('pass') ) {
1808 # Koha superuser account
1809 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1819 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1821 $sth->execute($userid);
1823 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1824 $surname, $branchcode, $branchname, $flags )
1827 if ( checkpw_hash( $password, $stored_hash ) ) {
1829 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1830 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1831 return 1, $cardnumber, $userid;
1836 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1838 $sth->execute($userid);
1840 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1841 $surname, $branchcode, $branchname, $flags )
1844 if ( checkpw_hash( $password, $stored_hash ) ) {
1846 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1847 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1848 return 1, $cardnumber, $userid;
1851 if ( $userid && $userid eq 'demo'
1852 && "$password" eq 'demo'
1853 && C4::Context->config('demo') )
1856 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1857 # some features won't be effective : modify systempref, modify MARC structure,
1864 my ( $password, $stored_hash ) = @_;
1866 return if $stored_hash eq '!';
1868 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1870 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1871 $hash = hash_password( $password, $stored_hash );
1873 $hash = md5_base64($password);
1875 return $hash eq $stored_hash;
1880 my $authflags = getuserflags($flags, $userid, [$dbh]);
1882 Translates integer flags into permissions strings hash.
1884 C<$flags> is the integer userflags value ( borrowers.userflags )
1885 C<$userid> is the members.userid, used for building subpermissions
1886 C<$authflags> is a hashref of permissions
1893 my $dbh = @_ ? shift : C4::Context->dbh;
1896 # I don't want to do this, but if someone logs in as the database
1897 # user, it would be preferable not to spam them to death with
1898 # numeric warnings. So, we make $flags numeric.
1899 no warnings 'numeric';
1902 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1905 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1906 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1907 $userflags->{$flag} = 1;
1910 $userflags->{$flag} = 0;
1914 # get subpermissions and merge with top-level permissions
1915 my $user_subperms = get_user_subpermissions($userid);
1916 foreach my $module ( keys %$user_subperms ) {
1917 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1918 $userflags->{$module} = $user_subperms->{$module};
1924 =head2 get_user_subpermissions
1926 $user_perm_hashref = get_user_subpermissions($userid);
1928 Given the userid (note, not the borrowernumber) of a staff user,
1929 return a hashref of hashrefs of the specific subpermissions
1930 accorded to the user. An example return is
1934 export_catalog => 1,
1935 import_patrons => 1,
1939 The top-level hash-key is a module or function code from
1940 userflags.flag, while the second-level key is a code
1943 The results of this function do not give a complete picture
1944 of the functions that a staff user can access; it is also
1945 necessary to check borrowers.flags.
1949 sub get_user_subpermissions {
1952 my $dbh = C4::Context->dbh;
1953 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1954 FROM user_permissions
1955 JOIN permissions USING (module_bit, code)
1956 JOIN userflags ON (module_bit = bit)
1957 JOIN borrowers USING (borrowernumber)
1958 WHERE userid = ?" );
1959 $sth->execute($userid);
1961 my $user_perms = {};
1962 while ( my $perm = $sth->fetchrow_hashref ) {
1963 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1968 =head2 get_all_subpermissions
1970 my $perm_hashref = get_all_subpermissions();
1972 Returns a hashref of hashrefs defining all specific
1973 permissions currently defined. The return value
1974 has the same structure as that of C<get_user_subpermissions>,
1975 except that the innermost hash value is the description
1976 of the subpermission.
1980 sub get_all_subpermissions {
1981 my $dbh = C4::Context->dbh;
1982 my $sth = $dbh->prepare( "SELECT flag, code
1984 JOIN userflags ON (module_bit = bit)" );
1988 while ( my $perm = $sth->fetchrow_hashref ) {
1989 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1994 =head2 haspermission
1996 $flags = ($userid, $flagsrequired);
1998 C<$userid> the userid of the member
1999 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
2001 Returns member's flags or 0 if a permission is not met.
2006 my ( $userid, $flagsrequired ) = @_;
2007 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2008 $sth->execute($userid);
2009 my $row = $sth->fetchrow();
2010 my $flags = getuserflags( $row, $userid );
2011 if ( $userid eq C4::Context->config('user') ) {
2013 # Super User Account from /etc/koha.conf
2014 $flags->{'superlibrarian'} = 1;
2016 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
2018 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
2019 $flags->{'superlibrarian'} = 1;
2022 return $flags if $flags->{superlibrarian};
2024 foreach my $module ( keys %$flagsrequired ) {
2025 my $subperm = $flagsrequired->{$module};
2026 if ( $subperm eq '*' ) {
2027 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
2030 ( defined $flags->{$module} and
2031 $flags->{$module} == 1 )
2033 ( ref( $flags->{$module} ) and
2034 exists $flags->{$module}->{$subperm} and
2035 $flags->{$module}->{$subperm} == 1 )
2041 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2044 sub getborrowernumber {
2046 my $userenv = C4::Context->userenv;
2047 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2048 return $userenv->{number};
2050 my $dbh = C4::Context->dbh;
2051 for my $field ( 'userid', 'cardnumber' ) {
2053 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2054 $sth->execute($userid);
2056 my ($bnumber) = $sth->fetchrow;
2063 END { } # module clean-up code here (global destructor)
2073 Crypt::Eksblowfish::Bcrypt(3)