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::Branch; # GetBranches
33 use C4::Search::History;
35 use Koha::AuthUtils qw(get_script_name hash_password);
36 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 ( $user && 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 BranchesLoop => GetBranchesLoop($opac_name),
516 BranchCategoriesLoop => $library_categories,
517 opac_name => $opac_name,
518 LibraryName => "" . C4::Context->preference("LibraryName"),
519 LibraryNameTitle => "" . $LibraryNameTitle,
520 LoginBranchname => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
521 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
522 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
523 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
524 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
525 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
526 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
527 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
528 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
529 opac_search_limit => $opac_search_limit,
530 opac_limit_override => $opac_limit_override,
531 OpacBrowser => C4::Context->preference("OpacBrowser"),
532 OpacCloud => C4::Context->preference("OpacCloud"),
533 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
534 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
535 OpacNav => "" . C4::Context->preference("OpacNav"),
536 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
537 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
538 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
539 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
540 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
541 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
542 OpacTopissue => C4::Context->preference("OpacTopissue"),
543 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
544 'Version' => C4::Context->preference('Version'),
545 hidelostitems => C4::Context->preference("hidelostitems"),
546 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
547 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
548 opacbookbag => "" . C4::Context->preference("opacbookbag"),
549 opaccredits => "" . C4::Context->preference("opaccredits"),
550 OpacFavicon => C4::Context->preference("OpacFavicon"),
551 opacheader => "" . C4::Context->preference("opacheader"),
552 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
553 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
554 OPACUserJS => C4::Context->preference("OPACUserJS"),
555 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
556 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
557 ShowReviewer => C4::Context->preference("ShowReviewer"),
558 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
559 suggestion => "" . C4::Context->preference("suggestion"),
560 virtualshelves => "" . C4::Context->preference("virtualshelves"),
561 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
562 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
563 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
564 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
565 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
566 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
567 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
568 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
569 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
570 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
571 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
572 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
573 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
574 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
575 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
576 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
577 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
578 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
579 useDischarge => C4::Context->preference('useDischarge'),
582 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
585 # Check if we were asked using parameters to force a specific language
586 if ( defined $in->{'query'}->param('language') ) {
588 # Extract the language, let C4::Languages::getlanguage choose
590 my $language = C4::Languages::getlanguage( $in->{'query'} );
591 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
592 if ( ref $cookie eq 'ARRAY' ) {
593 push @{$cookie}, $languagecookie;
595 $cookie = [ $cookie, $languagecookie ];
599 return ( $template, $borrowernumber, $cookie, $flags );
604 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
606 Verifies that the user is authorized to run this script. If
607 the user is authorized, a (userid, cookie, session-id, flags)
608 quadruple is returned. If the user is not authorized but does
609 not have the required privilege (see $flagsrequired below), it
610 displays an error page and exits. Otherwise, it displays the
611 login page and exits.
613 Note that C<&checkauth> will return if and only if the user
614 is authorized, so it should be called early on, before any
615 unfinished operations (e.g., if you've opened a file, then
616 C<&checkauth> won't close it for you).
618 C<$query> is the CGI object for the script calling C<&checkauth>.
620 The C<$noauth> argument is optional. If it is set, then no
621 authorization is required for the script.
623 C<&checkauth> fetches user and session information from C<$query> and
624 ensures that the user is authorized to run scripts that require
627 The C<$flagsrequired> argument specifies the required privileges
628 the user must have if the username and password are correct.
629 It should be specified as a reference-to-hash; keys in the hash
630 should be the "flags" for the user, as specified in the Members
631 intranet module. Any key specified must correspond to a "flag"
632 in the userflags table. E.g., { circulate => 1 } would specify
633 that the user must have the "circulate" privilege in order to
634 proceed. To make sure that access control is correct, the
635 C<$flagsrequired> parameter must be specified correctly.
637 Koha also has a concept of sub-permissions, also known as
638 granular permissions. This makes the value of each key
639 in the C<flagsrequired> hash take on an additional
644 The user must have access to all subfunctions of the module
645 specified by the hash key.
649 The user must have access to at least one subfunction of the module
650 specified by the hash key.
652 specific permission, e.g., 'export_catalog'
654 The user must have access to the specific subfunction list, which
655 must correspond to a row in the permissions table.
657 The C<$type> argument specifies whether the template should be
658 retrieved from the opac or intranet directory tree. "opac" is
659 assumed if it is not specified; however, if C<$type> is specified,
660 "intranet" is assumed if it is not "opac".
662 If C<$query> does not have a valid session ID associated with it
663 (i.e., the user has not logged in) or if the session has expired,
664 C<&checkauth> presents the user with a login page (from the point of
665 view of the original script, C<&checkauth> does not return). Once the
666 user has authenticated, C<&checkauth> restarts the original script
667 (this time, C<&checkauth> returns).
669 The login page is provided using a HTML::Template, which is set in the
670 systempreferences table or at the top of this file. The variable C<$type>
671 selects which template to use, either the opac or the intranet
672 authentification template.
674 C<&checkauth> returns a user ID, a cookie, and a session ID. The
675 cookie should be sent back to the browser; it verifies that the user
685 # If version syspref is unavailable, it means Koha is being installed,
686 # and so we must redirect to OPAC maintenance page or to the WebInstaller
687 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
688 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
689 warn "OPAC Install required, redirecting to maintenance";
690 print $query->redirect("/cgi-bin/koha/maintenance.pl");
693 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
694 if ( $type ne 'opac' ) {
695 warn "Install required, redirecting to Installer";
696 print $query->redirect("/cgi-bin/koha/installer/install.pl");
698 warn "OPAC Install required, redirecting to maintenance";
699 print $query->redirect("/cgi-bin/koha/maintenance.pl");
704 # check that database and koha version are the same
705 # there is no DB version, it's a fresh install,
706 # go to web installer
707 # there is a DB version, compare it to the code version
708 my $kohaversion = Koha::version();
710 # remove the 3 last . to have a Perl number
711 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
712 $debug and print STDERR "kohaversion : $kohaversion\n";
713 if ( $version < $kohaversion ) {
714 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
715 if ( $type ne 'opac' ) {
716 warn sprintf( $warning, 'Installer' );
717 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
719 warn sprintf( "OPAC: " . $warning, 'maintenance' );
720 print $query->redirect("/cgi-bin/koha/maintenance.pl");
728 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
729 printf $fh join( "\n", @_ );
733 sub _timeout_syspref {
734 my $timeout = C4::Context->preference('timeout') || 600;
736 # value in days, convert in seconds
737 if ( $timeout =~ /(\d+)[dD]/ ) {
738 $timeout = $1 * 86400;
745 $debug and warn "Checking Auth";
747 # $authnotrequired will be set for scripts which will run without authentication
748 my $authnotrequired = shift;
749 my $flagsrequired = shift;
752 $type = 'opac' unless $type;
754 my $dbh = C4::Context->dbh;
755 my $timeout = _timeout_syspref();
757 _version_check( $type, $query );
762 my ( $userid, $cookie, $sessionID, $flags );
763 my $logout = $query->param('logout.x');
765 my $anon_search_history;
767 # This parameter is the name of the CAS server we want to authenticate against,
768 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
769 my $casparam = $query->param('cas');
770 my $q_userid = $query->param('userid') // '';
772 # Basic authentication is incompatible with the use of Shibboleth,
773 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
774 # and it may not be the attribute we want to use to match the koha login.
776 # Also, do not consider an empty REMOTE_USER.
778 # Finally, after those tests, we can assume (although if it would be better with
779 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
780 # and we can affect it to $userid.
781 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
783 # Using Basic Authentication, no cookies required
784 $cookie = $query->cookie(
785 -name => 'CGISESSID',
794 # we don't want to set a session because we are being called by a persona callback
796 elsif ( $sessionID = $query->cookie("CGISESSID") )
797 { # assignment, not comparison
798 my $session = get_session($sessionID);
799 C4::Context->_new_userenv($sessionID);
800 my ( $ip, $lasttime, $sessiontype );
803 $s_userid = $session->param('id') // '';
804 C4::Context->set_userenv(
805 $session->param('number'), $s_userid,
806 $session->param('cardnumber'), $session->param('firstname'),
807 $session->param('surname'), $session->param('branch'),
808 $session->param('branchname'), $session->param('flags'),
809 $session->param('emailaddress'), $session->param('branchprinter'),
810 $session->param('persona'), $session->param('shibboleth')
812 C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
813 C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
814 C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
815 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
816 $ip = $session->param('ip');
817 $lasttime = $session->param('lasttime');
819 $sessiontype = $session->param('sessiontype') || '';
821 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
822 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
823 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
826 #if a user enters an id ne to the id in the current session, we need to log them in...
827 #first we need to clear the anonymous session...
828 $debug and warn "query id = $q_userid but session id = $s_userid";
829 $anon_search_history = $session->param('search_history');
832 C4::Context->_unset_userenv($sessionID);
838 # voluntary logout the user
839 # check wether the user was using their shibboleth session or a local one
840 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
843 C4::Context->_unset_userenv($sessionID);
845 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
849 if ($cas and $caslogout) {
850 logout_cas($query, $type);
853 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
854 if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
856 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
860 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
863 $info{'timed_out'} = 1;
868 C4::Context->_unset_userenv($sessionID);
870 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
874 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
876 # Different ip than originally logged in from
877 $info{'oldip'} = $ip;
878 $info{'newip'} = $ENV{'REMOTE_ADDR'};
879 $info{'different_ip'} = 1;
882 C4::Context->_unset_userenv($sessionID);
884 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
889 $cookie = $query->cookie(
890 -name => 'CGISESSID',
891 -value => $session->id,
894 $session->param( 'lasttime', time() );
895 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...
896 $flags = haspermission( $userid, $flagsrequired );
900 $info{'nopermission'} = 1;
905 unless ( $userid || $sessionID ) {
907 #we initiate a session prior to checking for a username to allow for anonymous sessions...
908 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
910 # Save anonymous search history in new session so it can be retrieved
911 # by get_template_and_user to store it in user's search history after
912 # a successful login.
913 if ($anon_search_history) {
914 $session->param( 'search_history', $anon_search_history );
917 my $sessionID = $session->id;
918 C4::Context->_new_userenv($sessionID);
919 $cookie = $query->cookie(
920 -name => 'CGISESSID',
921 -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, $q_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, $q_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
1025 # If DB user is logged in
1026 $userid ||= $q_userid if $return == 2;
1028 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1029 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1033 $info{'nopermission'} = 1;
1034 C4::Context->_unset_userenv($sessionID);
1036 my ( $borrowernumber, $firstname, $surname, $userflags,
1037 $branchcode, $branchname, $branchprinter, $emailaddress );
1039 if ( $return == 1 ) {
1041 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1042 branches.branchname as branchname,
1043 branches.branchprinter as branchprinter,
1046 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1048 my $sth = $dbh->prepare("$select where userid=?");
1049 $sth->execute($userid);
1050 unless ( $sth->rows ) {
1051 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1052 $sth = $dbh->prepare("$select where cardnumber=?");
1053 $sth->execute($cardnumber);
1055 unless ( $sth->rows ) {
1056 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1057 $sth->execute($userid);
1058 unless ( $sth->rows ) {
1059 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1064 ( $borrowernumber, $firstname, $surname, $userflags,
1065 $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1066 $debug and print STDERR "AUTH_3 results: " .
1067 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1069 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1072 # launch a sequence to check if we have a ip for the branch, i
1073 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1075 my $ip = $ENV{'REMOTE_ADDR'};
1077 # if they specify at login, use that
1078 if ( $query->param('branch') ) {
1079 $branchcode = $query->param('branch');
1080 $branchname = GetBranchName($branchcode);
1083 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1084 if ( $type ne 'opac' and C4::Context->boolean_preference('AutoLocation') ) {
1086 # we have to check they are coming from the right ip range
1087 my $domain = $branches->{$branchcode}->{'branchip'};
1088 $domain =~ s|\.\*||g;
1089 if ( $ip !~ /^$domain/ ) {
1091 $cookie = $query->cookie(
1092 -name => 'CGISESSID',
1096 $info{'wrongip'} = 1;
1101 foreach my $br ( keys %$branches ) {
1103 # now we work with the treatment of ip
1104 my $domain = $branches->{$br}->{'branchip'};
1105 if ( $domain && $ip =~ /^$domain/ ) {
1106 $branchcode = $branches->{$br}->{'branchcode'};
1108 # new op dev : add the branchprinter and branchname in the cookie
1109 $branchprinter = $branches->{$br}->{'branchprinter'};
1110 $branchname = $branches->{$br}->{'branchname'};
1113 $session->param( 'number', $borrowernumber );
1114 $session->param( 'id', $userid );
1115 $session->param( 'cardnumber', $cardnumber );
1116 $session->param( 'firstname', $firstname );
1117 $session->param( 'surname', $surname );
1118 $session->param( 'branch', $branchcode );
1119 $session->param( 'branchname', $branchname );
1120 $session->param( 'flags', $userflags );
1121 $session->param( 'emailaddress', $emailaddress );
1122 $session->param( 'ip', $session->remote_addr() );
1123 $session->param( 'lasttime', time() );
1124 $session->param( 'shibboleth', $shibSuccess );
1125 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1127 elsif ( $return == 2 ) {
1129 #We suppose the user is the superlibrarian
1130 $borrowernumber = 0;
1131 $session->param( 'number', 0 );
1132 $session->param( 'id', C4::Context->config('user') );
1133 $session->param( 'cardnumber', C4::Context->config('user') );
1134 $session->param( 'firstname', C4::Context->config('user') );
1135 $session->param( 'surname', C4::Context->config('user') );
1136 $session->param( 'branch', 'NO_LIBRARY_SET' );
1137 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1138 $session->param( 'flags', 1 );
1139 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1140 $session->param( 'ip', $session->remote_addr() );
1141 $session->param( 'lasttime', time() );
1144 $session->param( 'persona', 1 );
1146 C4::Context->set_userenv(
1147 $session->param('number'), $session->param('id'),
1148 $session->param('cardnumber'), $session->param('firstname'),
1149 $session->param('surname'), $session->param('branch'),
1150 $session->param('branchname'), $session->param('flags'),
1151 $session->param('emailaddress'), $session->param('branchprinter'),
1152 $session->param('persona'), $session->param('shibboleth')
1156 # $return: 0 = invalid user
1157 # reset to anonymous session
1159 $debug and warn "Login failed, resetting anonymous session...";
1161 $info{'invalid_username_or_password'} = 1;
1162 C4::Context->_unset_userenv($sessionID);
1164 $session->param( 'lasttime', time() );
1165 $session->param( 'ip', $session->remote_addr() );
1166 $session->param( 'sessiontype', 'anon' );
1168 } # END if ( $q_userid
1169 elsif ( $type eq "opac" ) {
1171 # if we are here this is an anonymous session; add public lists to it and a few other items...
1172 # anonymous sessions are created only for the OPAC
1173 $debug and warn "Initiating an anonymous session...";
1175 # setting a couple of other session vars...
1176 $session->param( 'ip', $session->remote_addr() );
1177 $session->param( 'lasttime', time() );
1178 $session->param( 'sessiontype', 'anon' );
1180 } # END unless ($userid)
1182 # finished authentification, now respond
1183 if ( $loggedin || $authnotrequired )
1187 $cookie = $query->cookie(
1188 -name => 'CGISESSID',
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 branchloop => GetBranchesLoop(),
1218 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1219 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1222 script_name => get_script_name(),
1223 casAuthentication => C4::Context->preference("casAuthentication"),
1224 shibbolethAuthentication => $shib,
1225 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1226 suggestion => C4::Context->preference("suggestion"),
1227 virtualshelves => C4::Context->preference("virtualshelves"),
1228 LibraryName => "" . C4::Context->preference("LibraryName"),
1229 LibraryNameTitle => "" . $LibraryNameTitle,
1230 opacuserlogin => C4::Context->preference("opacuserlogin"),
1231 OpacNav => C4::Context->preference("OpacNav"),
1232 OpacNavRight => C4::Context->preference("OpacNavRight"),
1233 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1234 opaccredits => C4::Context->preference("opaccredits"),
1235 OpacFavicon => C4::Context->preference("OpacFavicon"),
1236 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1237 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1238 OPACUserJS => C4::Context->preference("OPACUserJS"),
1239 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1240 OpacCloud => C4::Context->preference("OpacCloud"),
1241 OpacTopissue => C4::Context->preference("OpacTopissue"),
1242 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1243 OpacBrowser => C4::Context->preference("OpacBrowser"),
1244 opacheader => C4::Context->preference("opacheader"),
1245 TagsEnabled => C4::Context->preference("TagsEnabled"),
1246 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1247 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1248 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1249 intranetbookbag => C4::Context->preference("intranetbookbag"),
1250 IntranetNav => C4::Context->preference("IntranetNav"),
1251 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1252 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1253 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1254 IndependentBranches => C4::Context->preference("IndependentBranches"),
1255 AutoLocation => C4::Context->preference("AutoLocation"),
1256 wrongip => $info{'wrongip'},
1257 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1258 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1259 persona => C4::Context->preference("Persona"),
1260 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1263 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1264 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1265 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1267 if ( $type eq 'opac' ) {
1268 require Koha::Virtualshelves;
1269 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1275 some_public_shelves => $some_public_shelves,
1281 # Is authentication against multiple CAS servers enabled?
1282 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1283 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1285 foreach my $key ( keys %$casservers ) {
1286 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1289 casServersLoop => \@tmplservers
1293 casServerUrl => login_cas_url($query, undef, $type),
1298 invalidCasLogin => $info{'invalidCasLogin'}
1304 shibbolethAuthentication => $shib,
1305 shibbolethLoginUrl => login_shib_url($query),
1309 if (C4::Context->preference('GoogleOpenIDConnect')) {
1310 if ($query->param("OpenIDConnectFailed")) {
1311 my $reason = $query->param('OpenIDConnectFailed');
1312 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1317 LibraryName => C4::Context->preference("LibraryName"),
1319 $template->param(%info);
1321 # $cookie = $query->cookie(CGISESSID => $session->id
1323 print $query->header(
1324 { type => 'text/html',
1327 'X-Frame-Options' => 'SAMEORIGIN'
1334 =head2 check_api_auth
1336 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1338 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1339 cookie, determine if the user has the privileges specified by C<$userflags>.
1341 C<check_api_auth> is is meant for authenticating users of web services, and
1342 consequently will always return and will not attempt to redirect the user
1345 If a valid session cookie is already present, check_api_auth will return a status
1346 of "ok", the cookie, and the Koha session ID.
1348 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1349 parameters and create a session cookie and Koha session if the supplied credentials
1352 Possible return values in C<$status> are:
1356 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1358 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1360 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1362 =item "expired -- session cookie has expired; API user should resubmit userid and password
1368 sub check_api_auth {
1370 my $flagsrequired = shift;
1372 my $dbh = C4::Context->dbh;
1373 my $timeout = _timeout_syspref();
1375 unless ( C4::Context->preference('Version') ) {
1377 # database has not been installed yet
1378 return ( "maintenance", undef, undef );
1380 my $kohaversion = Koha::version();
1381 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1382 if ( C4::Context->preference('Version') < $kohaversion ) {
1384 # database in need of version update; assume that
1385 # no API should be called while databsae is in
1387 return ( "maintenance", undef, undef );
1390 # FIXME -- most of what follows is a copy-and-paste
1391 # of code from checkauth. There is an obvious need
1392 # for refactoring to separate the various parts of
1393 # the authentication code, but as of 2007-11-19 this
1394 # is deferred so as to not introduce bugs into the
1395 # regular authentication code for Koha 3.0.
1397 # see if we have a valid session cookie already
1398 # however, if a userid parameter is present (i.e., from
1399 # a form submission, assume that any current cookie
1401 my $sessionID = undef;
1402 unless ( $query->param('userid') ) {
1403 $sessionID = $query->cookie("CGISESSID");
1405 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1406 my $session = get_session($sessionID);
1407 C4::Context->_new_userenv($sessionID);
1409 C4::Context->set_userenv(
1410 $session->param('number'), $session->param('id'),
1411 $session->param('cardnumber'), $session->param('firstname'),
1412 $session->param('surname'), $session->param('branch'),
1413 $session->param('branchname'), $session->param('flags'),
1414 $session->param('emailaddress'), $session->param('branchprinter')
1417 my $ip = $session->param('ip');
1418 my $lasttime = $session->param('lasttime');
1419 my $userid = $session->param('id');
1420 if ( $lasttime < time() - $timeout ) {
1425 C4::Context->_unset_userenv($sessionID);
1428 return ( "expired", undef, undef );
1429 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1431 # IP address changed
1434 C4::Context->_unset_userenv($sessionID);
1437 return ( "expired", undef, undef );
1439 my $cookie = $query->cookie(
1440 -name => 'CGISESSID',
1441 -value => $session->id,
1444 $session->param( 'lasttime', time() );
1445 my $flags = haspermission( $userid, $flagsrequired );
1447 return ( "ok", $cookie, $sessionID );
1451 C4::Context->_unset_userenv($sessionID);
1454 return ( "failed", undef, undef );
1458 return ( "expired", undef, undef );
1463 my $userid = $query->param('userid');
1464 my $password = $query->param('password');
1465 my ( $return, $cardnumber );
1468 if ( $cas && $query->param('PT') ) {
1470 $debug and print STDERR "## check_api_auth - checking CAS\n";
1472 # In case of a CAS authentication, we use the ticket instead of the password
1473 my $PT = $query->param('PT');
1474 ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1477 # User / password auth
1478 unless ( $userid and $password ) {
1480 # caller did something wrong, fail the authenticateion
1481 return ( "failed", undef, undef );
1483 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1486 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1487 my $session = get_session("");
1488 return ( "failed", undef, undef ) unless $session;
1490 my $sessionID = $session->id;
1491 C4::Context->_new_userenv($sessionID);
1492 my $cookie = $query->cookie(
1493 -name => 'CGISESSID',
1494 -value => $sessionID,
1497 if ( $return == 1 ) {
1499 $borrowernumber, $firstname, $surname,
1500 $userflags, $branchcode, $branchname,
1501 $branchprinter, $emailaddress
1505 "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=?"
1507 $sth->execute($userid);
1509 $borrowernumber, $firstname, $surname,
1510 $userflags, $branchcode, $branchname,
1511 $branchprinter, $emailaddress
1512 ) = $sth->fetchrow if ( $sth->rows );
1514 unless ( $sth->rows ) {
1515 my $sth = $dbh->prepare(
1516 "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=?"
1518 $sth->execute($cardnumber);
1520 $borrowernumber, $firstname, $surname,
1521 $userflags, $branchcode, $branchname,
1522 $branchprinter, $emailaddress
1523 ) = $sth->fetchrow if ( $sth->rows );
1525 unless ( $sth->rows ) {
1526 $sth->execute($userid);
1528 $borrowernumber, $firstname, $surname, $userflags,
1529 $branchcode, $branchname, $branchprinter, $emailaddress
1530 ) = $sth->fetchrow if ( $sth->rows );
1534 my $ip = $ENV{'REMOTE_ADDR'};
1536 # if they specify at login, use that
1537 if ( $query->param('branch') ) {
1538 $branchcode = $query->param('branch');
1539 $branchname = GetBranchName($branchcode);
1541 my $branches = GetBranches();
1543 foreach my $br ( keys %$branches ) {
1545 # now we work with the treatment of ip
1546 my $domain = $branches->{$br}->{'branchip'};
1547 if ( $domain && $ip =~ /^$domain/ ) {
1548 $branchcode = $branches->{$br}->{'branchcode'};
1550 # new op dev : add the branchprinter and branchname in the cookie
1551 $branchprinter = $branches->{$br}->{'branchprinter'};
1552 $branchname = $branches->{$br}->{'branchname'};
1555 $session->param( 'number', $borrowernumber );
1556 $session->param( 'id', $userid );
1557 $session->param( 'cardnumber', $cardnumber );
1558 $session->param( 'firstname', $firstname );
1559 $session->param( 'surname', $surname );
1560 $session->param( 'branch', $branchcode );
1561 $session->param( 'branchname', $branchname );
1562 $session->param( 'flags', $userflags );
1563 $session->param( 'emailaddress', $emailaddress );
1564 $session->param( 'ip', $session->remote_addr() );
1565 $session->param( 'lasttime', time() );
1566 } elsif ( $return == 2 ) {
1568 #We suppose the user is the superlibrarian
1569 $session->param( 'number', 0 );
1570 $session->param( 'id', C4::Context->config('user') );
1571 $session->param( 'cardnumber', C4::Context->config('user') );
1572 $session->param( 'firstname', C4::Context->config('user') );
1573 $session->param( 'surname', C4::Context->config('user') );
1574 $session->param( 'branch', 'NO_LIBRARY_SET' );
1575 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1576 $session->param( 'flags', 1 );
1577 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1578 $session->param( 'ip', $session->remote_addr() );
1579 $session->param( 'lasttime', time() );
1581 C4::Context->set_userenv(
1582 $session->param('number'), $session->param('id'),
1583 $session->param('cardnumber'), $session->param('firstname'),
1584 $session->param('surname'), $session->param('branch'),
1585 $session->param('branchname'), $session->param('flags'),
1586 $session->param('emailaddress'), $session->param('branchprinter')
1588 return ( "ok", $cookie, $sessionID );
1590 return ( "failed", undef, undef );
1595 =head2 check_cookie_auth
1597 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1599 Given a CGISESSID cookie set during a previous login to Koha, determine
1600 if the user has the privileges specified by C<$userflags>.
1602 C<check_cookie_auth> is meant for authenticating special services
1603 such as tools/upload-file.pl that are invoked by other pages that
1604 have been authenticated in the usual way.
1606 Possible return values in C<$status> are:
1610 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1612 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1614 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1616 =item "expired -- session cookie has expired; API user should resubmit userid and password
1622 sub check_cookie_auth {
1624 my $flagsrequired = shift;
1626 my $dbh = C4::Context->dbh;
1627 my $timeout = _timeout_syspref();
1629 unless ( C4::Context->preference('Version') ) {
1631 # database has not been installed yet
1632 return ( "maintenance", undef );
1634 my $kohaversion = Koha::version();
1635 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1636 if ( C4::Context->preference('Version') < $kohaversion ) {
1638 # database in need of version update; assume that
1639 # no API should be called while databsae is in
1641 return ( "maintenance", undef );
1644 # FIXME -- most of what follows is a copy-and-paste
1645 # of code from checkauth. There is an obvious need
1646 # for refactoring to separate the various parts of
1647 # the authentication code, but as of 2007-11-23 this
1648 # is deferred so as to not introduce bugs into the
1649 # regular authentication code for Koha 3.0.
1651 # see if we have a valid session cookie already
1652 # however, if a userid parameter is present (i.e., from
1653 # a form submission, assume that any current cookie
1655 unless ( defined $cookie and $cookie ) {
1656 return ( "failed", undef );
1658 my $sessionID = $cookie;
1659 my $session = get_session($sessionID);
1660 C4::Context->_new_userenv($sessionID);
1662 C4::Context->set_userenv(
1663 $session->param('number'), $session->param('id'),
1664 $session->param('cardnumber'), $session->param('firstname'),
1665 $session->param('surname'), $session->param('branch'),
1666 $session->param('branchname'), $session->param('flags'),
1667 $session->param('emailaddress'), $session->param('branchprinter')
1670 my $ip = $session->param('ip');
1671 my $lasttime = $session->param('lasttime');
1672 my $userid = $session->param('id');
1673 if ( $lasttime < time() - $timeout ) {
1678 C4::Context->_unset_userenv($sessionID);
1681 return ("expired", undef);
1682 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1684 # IP address changed
1687 C4::Context->_unset_userenv($sessionID);
1690 return ( "expired", undef );
1692 $session->param( 'lasttime', time() );
1693 my $flags = haspermission( $userid, $flagsrequired );
1695 return ( "ok", $sessionID );
1699 C4::Context->_unset_userenv($sessionID);
1702 return ( "failed", undef );
1706 return ( "expired", undef );
1713 my $session = get_session($sessionID);
1715 Given a session ID, retrieve the CGI::Session object used to store
1716 the session's state. The session object can be used to store
1717 data that needs to be accessed by different scripts during a
1720 If the C<$sessionID> parameter is an empty string, a new session
1726 my $sessionID = shift;
1727 my $storage_method = C4::Context->preference('SessionStorage');
1728 my $dbh = C4::Context->dbh;
1730 if ( $storage_method eq 'mysql' ) {
1731 $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1733 elsif ( $storage_method eq 'Pg' ) {
1734 $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1736 elsif ( $storage_method eq 'memcached' && C4::Context->ismemcached ) {
1737 $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1740 # catch all defaults to tmp should work on all systems
1741 my $dir = File::Spec->tmpdir;
1742 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1743 $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => "$dir/cgisess_$instance" } );
1749 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1750 # (or something similar)
1751 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1752 # not having a userenv defined could cause a crash.
1754 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1755 $type = 'opac' unless $type;
1757 $debug and print STDERR "## checkpw - checking LDAP\n";
1758 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1759 return 0 if $retval == -1; # Incorrect password for LDAP login attempt
1760 ($retval) and return ( $retval, $retcard, $retuserid );
1763 if ( $cas && $query && $query->param('ticket') ) {
1764 $debug and print STDERR "## checkpw - checking CAS\n";
1766 # In case of a CAS authentication, we use the ticket instead of the password
1767 my $ticket = $query->param('ticket');
1768 $query->delete('ticket'); # remove ticket to come back to original URL
1769 my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1770 ($retval) and return ( $retval, $retcard, $retuserid );
1774 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1775 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1777 if ( $shib && $shib_login && !$password ) {
1779 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1781 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1782 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1783 # shibboleth-authenticated user
1785 # Then, we check if it matches a valid koha user
1787 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1788 ($retval) and return ( $retval, $retcard, $retuserid );
1794 return checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1797 sub checkpw_internal {
1798 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1800 $password = Encode::encode( 'UTF-8', $password )
1801 if Encode::is_utf8($password);
1803 if ( $userid && $userid eq C4::Context->config('user') ) {
1804 if ( $password && $password eq C4::Context->config('pass') ) {
1806 # Koha superuser account
1807 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1817 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1819 $sth->execute($userid);
1821 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1822 $surname, $branchcode, $branchname, $flags )
1825 if ( checkpw_hash( $password, $stored_hash ) ) {
1827 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1828 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1829 return 1, $cardnumber, $userid;
1834 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1836 $sth->execute($userid);
1838 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1839 $surname, $branchcode, $branchname, $flags )
1842 if ( checkpw_hash( $password, $stored_hash ) ) {
1844 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1845 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1846 return 1, $cardnumber, $userid;
1849 if ( $userid && $userid eq 'demo'
1850 && "$password" eq 'demo'
1851 && C4::Context->config('demo') )
1854 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1855 # some features won't be effective : modify systempref, modify MARC structure,
1862 my ( $password, $stored_hash ) = @_;
1864 return if $stored_hash eq '!';
1866 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1868 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1869 $hash = hash_password( $password, $stored_hash );
1871 $hash = md5_base64($password);
1873 return $hash eq $stored_hash;
1878 my $authflags = getuserflags($flags, $userid, [$dbh]);
1880 Translates integer flags into permissions strings hash.
1882 C<$flags> is the integer userflags value ( borrowers.userflags )
1883 C<$userid> is the members.userid, used for building subpermissions
1884 C<$authflags> is a hashref of permissions
1891 my $dbh = @_ ? shift : C4::Context->dbh;
1894 # I don't want to do this, but if someone logs in as the database
1895 # user, it would be preferable not to spam them to death with
1896 # numeric warnings. So, we make $flags numeric.
1897 no warnings 'numeric';
1900 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1903 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1904 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1905 $userflags->{$flag} = 1;
1908 $userflags->{$flag} = 0;
1912 # get subpermissions and merge with top-level permissions
1913 my $user_subperms = get_user_subpermissions($userid);
1914 foreach my $module ( keys %$user_subperms ) {
1915 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1916 $userflags->{$module} = $user_subperms->{$module};
1922 =head2 get_user_subpermissions
1924 $user_perm_hashref = get_user_subpermissions($userid);
1926 Given the userid (note, not the borrowernumber) of a staff user,
1927 return a hashref of hashrefs of the specific subpermissions
1928 accorded to the user. An example return is
1932 export_catalog => 1,
1933 import_patrons => 1,
1937 The top-level hash-key is a module or function code from
1938 userflags.flag, while the second-level key is a code
1941 The results of this function do not give a complete picture
1942 of the functions that a staff user can access; it is also
1943 necessary to check borrowers.flags.
1947 sub get_user_subpermissions {
1950 my $dbh = C4::Context->dbh;
1951 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1952 FROM user_permissions
1953 JOIN permissions USING (module_bit, code)
1954 JOIN userflags ON (module_bit = bit)
1955 JOIN borrowers USING (borrowernumber)
1956 WHERE userid = ?" );
1957 $sth->execute($userid);
1959 my $user_perms = {};
1960 while ( my $perm = $sth->fetchrow_hashref ) {
1961 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1966 =head2 get_all_subpermissions
1968 my $perm_hashref = get_all_subpermissions();
1970 Returns a hashref of hashrefs defining all specific
1971 permissions currently defined. The return value
1972 has the same structure as that of C<get_user_subpermissions>,
1973 except that the innermost hash value is the description
1974 of the subpermission.
1978 sub get_all_subpermissions {
1979 my $dbh = C4::Context->dbh;
1980 my $sth = $dbh->prepare( "SELECT flag, code
1982 JOIN userflags ON (module_bit = bit)" );
1986 while ( my $perm = $sth->fetchrow_hashref ) {
1987 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1992 =head2 haspermission
1994 $flags = ($userid, $flagsrequired);
1996 C<$userid> the userid of the member
1997 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1999 Returns member's flags or 0 if a permission is not met.
2004 my ( $userid, $flagsrequired ) = @_;
2005 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
2006 $sth->execute($userid);
2007 my $row = $sth->fetchrow();
2008 my $flags = getuserflags( $row, $userid );
2009 if ( $userid eq C4::Context->config('user') ) {
2011 # Super User Account from /etc/koha.conf
2012 $flags->{'superlibrarian'} = 1;
2014 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
2016 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
2017 $flags->{'superlibrarian'} = 1;
2020 return $flags if $flags->{superlibrarian};
2022 foreach my $module ( keys %$flagsrequired ) {
2023 my $subperm = $flagsrequired->{$module};
2024 if ( $subperm eq '*' ) {
2025 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
2028 ( defined $flags->{$module} and
2029 $flags->{$module} == 1 )
2031 ( ref( $flags->{$module} ) and
2032 exists $flags->{$module}->{$subperm} and
2033 $flags->{$module}->{$subperm} == 1 )
2039 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2042 sub getborrowernumber {
2044 my $userenv = C4::Context->userenv;
2045 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2046 return $userenv->{number};
2048 my $dbh = C4::Context->dbh;
2049 for my $field ( 'userid', 'cardnumber' ) {
2051 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2052 $sth->execute($userid);
2054 my ($bnumber) = $sth->fetchrow;
2061 END { } # module clean-up code here (global destructor)
2071 Crypt::Eksblowfish::Bcrypt(3)