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;
39 use POSIX qw/strftime/;
40 use List::MoreUtils qw/ any /;
41 use Encode qw( encode is_utf8);
44 use vars qw(@ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $shib $shib_login);
47 sub psgi_env { any { /^psgi\./ } keys %ENV }
50 if (psgi_env) { die 'psgi:exit' }
56 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
57 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
58 &get_all_subpermissions &get_user_subpermissions
60 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
61 $ldap = C4::Context->config('useldapserver') || 0;
62 $cas = C4::Context->preference('casAuthentication');
63 $shib = C4::Context->config('useshibboleth') || 0;
64 $caslogout = C4::Context->preference('casLogout');
65 require C4::Auth_with_cas; # no import
68 require C4::Auth_with_ldap;
69 import C4::Auth_with_ldap qw(checkpw_ldap);
72 require C4::Auth_with_shibboleth;
73 import C4::Auth_with_shibboleth
74 qw(shib_ok checkpw_shib logout_shib login_shib_url get_login_shib);
76 # Check for good config
79 # Get shibboleth login attribute
80 $shib_login = get_login_shib();
83 # Bad config, disable shibboleth
89 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
96 C4::Auth - Authenticates Koha users
100 use CGI qw ( -utf8 );
106 my ($template, $borrowernumber, $cookie)
107 = get_template_and_user(
109 template_name => "opac-main.tt",
112 authnotrequired => 0,
113 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
117 output_html_with_http_headers $query, $cookie, $template->output;
121 The main function of this module is to provide
122 authentification. However the get_template_and_user function has
123 been provided so that a users login information is passed along
124 automatically. This gets loaded into the template.
128 =head2 get_template_and_user
130 my ($template, $borrowernumber, $cookie)
131 = get_template_and_user(
133 template_name => "opac-main.tt",
136 authnotrequired => 0,
137 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
141 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
142 to C<&checkauth> (in this module) to perform authentification.
143 See C<&checkauth> for an explanation of these parameters.
145 The C<template_name> is then used to find the correct template for
146 the page. The authenticated users details are loaded onto the
147 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
148 C<sessionID> is passed to the template. This can be used in templates
149 if cookies are disabled. It needs to be put as and input to every
152 More information on the C<gettemplate> sub can be found in the
157 sub get_template_and_user {
160 my ( $user, $cookie, $sessionID, $flags );
162 C4::Context->interface( $in->{type} );
164 my $safe_chars = 'a-zA-Z0-9_\-\/';
165 die "bad template path" unless $in->{'template_name'} =~ m/^[$safe_chars]+\.tt$/ig; #sanitize input
167 $in->{'authnotrequired'} ||= 0;
168 my $template = C4::Templates::gettemplate(
169 $in->{'template_name'},
175 if ( $in->{'template_name'} !~ m/maintenance/ ) {
176 ( $user, $cookie, $sessionID, $flags ) = checkauth(
178 $in->{'authnotrequired'},
179 $in->{'flagsrequired'},
185 # 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
186 if ( $in->{type} eq 'opac' and $in->{template_name} !~ m|sco/| ) {
187 if ( C4::Context->preference('AutoSelfCheckID') && $user eq C4::Context->preference('AutoSelfCheckID') ) {
188 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac', $in->{query} );
189 my $cookie = $in->{query}->cookie(
190 -name => 'CGISESSID',
198 script_name => get_script_name(),
200 print $in->{query}->header(
201 { type => 'text/html',
204 'X-Frame-Options' => 'SAMEORIGIN'
216 # It's possible for $user to be the borrowernumber if they don't have a
217 # userid defined (and are logging in through some other method, such
218 # as SSL certs against an email address)
220 $borrowernumber = getborrowernumber($user) if defined($user);
221 if ( !defined($borrowernumber) && defined($user) ) {
222 $borrower = C4::Members::GetMember( borrowernumber => $user );
224 $borrowernumber = $user;
226 # A bit of a hack, but I don't know there's a nicer way
228 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
231 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
235 $template->param( loggedinusername => $user );
236 $template->param( loggedinusernumber => $borrowernumber );
237 $template->param( sessionID => $sessionID );
239 if ( $in->{'type'} eq 'opac' ) {
240 require Koha::Virtualshelves;
241 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
243 borrowernumber => $borrowernumber,
247 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
253 some_private_shelves => $some_private_shelves,
254 some_public_shelves => $some_public_shelves,
258 $template->param( "USER_INFO" => $borrower );
260 my $all_perms = get_all_subpermissions();
262 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
263 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
265 # We are going to use the $flags returned by checkauth
266 # to create the template's parameters that will indicate
267 # which menus the user can access.
268 if ( $flags && $flags->{superlibrarian} == 1 ) {
269 $template->param( CAN_user_circulate => 1 );
270 $template->param( CAN_user_catalogue => 1 );
271 $template->param( CAN_user_parameters => 1 );
272 $template->param( CAN_user_borrowers => 1 );
273 $template->param( CAN_user_permissions => 1 );
274 $template->param( CAN_user_reserveforothers => 1 );
275 $template->param( CAN_user_editcatalogue => 1 );
276 $template->param( CAN_user_updatecharges => 1 );
277 $template->param( CAN_user_acquisition => 1 );
278 $template->param( CAN_user_management => 1 );
279 $template->param( CAN_user_tools => 1 );
280 $template->param( CAN_user_editauthorities => 1 );
281 $template->param( CAN_user_serials => 1 );
282 $template->param( CAN_user_reports => 1 );
283 $template->param( CAN_user_staffaccess => 1 );
284 $template->param( CAN_user_plugins => 1 );
285 $template->param( CAN_user_coursereserves => 1 );
286 foreach my $module ( keys %$all_perms ) {
288 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
289 $template->param( "CAN_user_${module}_${subperm}" => 1 );
295 foreach my $module ( keys %$all_perms ) {
296 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
297 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
298 $template->param( "CAN_user_${module}_${subperm}" => 1 );
300 } elsif ( ref( $flags->{$module} ) ) {
301 foreach my $subperm ( keys %{ $flags->{$module} } ) {
302 $template->param( "CAN_user_${module}_${subperm}" => 1 );
309 foreach my $module ( keys %$flags ) {
310 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
311 $template->param( "CAN_user_$module" => 1 );
312 if ( $module eq "parameters" ) {
313 $template->param( CAN_user_management => 1 );
319 # Logged-in opac search history
320 # If the requested template is an opac one and opac search history is enabled
321 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
322 my $dbh = C4::Context->dbh;
323 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
324 my $sth = $dbh->prepare($query);
325 $sth->execute($borrowernumber);
327 # If at least one search has already been performed
328 if ( $sth->fetchrow_array > 0 ) {
330 # We show the link in opac
331 $template->param( EnableOpacSearchHistory => 1 );
334 # And if there are searches performed when the user was not logged in,
335 # we add them to the logged-in search history
336 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
337 if (@recentSearches) {
338 my $dbh = C4::Context->dbh;
340 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
341 VALUES (?, ?, ?, ?, ?, ?, ?)
344 my $sth = $dbh->prepare($query);
345 $sth->execute( $borrowernumber,
346 $in->{query}->cookie("CGISESSID"),
349 $_->{type} || 'biblio',
352 ) foreach @recentSearches;
354 # clear out the search history from the session now that
355 # we've saved it to the database
356 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
358 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
359 $template->param( EnableSearchHistory => 1 );
362 else { # if this is an anonymous session, setup to display public lists...
364 # If shibboleth is enabled, and we're in an anonymous session, we should allow
365 # the user to attempt login via shibboleth.
367 $template->param( shibbolethAuthentication => $shib,
368 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
371 # If shibboleth is enabled and we have a shibboleth login attribute,
372 # but we are in an anonymous session, then we clearly have an invalid
373 # shibboleth koha account.
375 $template->param( invalidShibLogin => '1' );
379 $template->param( sessionID => $sessionID );
381 if ( $in->{'type'} eq 'opac' ){
382 require Koha::Virtualshelves;
383 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
389 some_public_shelves => $some_public_shelves,
394 # Anonymous opac search history
395 # If opac search history is enabled and at least one search has already been performed
396 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
397 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
398 if (@recentSearches) {
399 $template->param( EnableOpacSearchHistory => 1 );
403 if ( C4::Context->preference('dateformat') ) {
404 $template->param( dateformat => C4::Context->preference('dateformat') );
407 $template->param(auth_forwarded_hash => scalar $in->{'query'}->param('auth_forwarded_hash'));
409 # these template parameters are set the same regardless of $in->{'type'}
411 # Set the using_https variable for templates
412 # FIXME Under Plack the CGI->https method always returns 'OFF'
413 my $https = $in->{query}->https();
414 my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
417 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
418 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
419 GoogleJackets => C4::Context->preference("GoogleJackets"),
420 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
421 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
422 LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"} : undef ),
423 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
424 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
425 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : 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 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
438 if ( $in->{'type'} eq "intranet" ) {
440 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
441 AutoLocation => C4::Context->preference("AutoLocation"),
442 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
443 CircAutocompl => C4::Context->preference("CircAutocompl"),
444 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
445 IndependentBranches => C4::Context->preference("IndependentBranches"),
446 IntranetNav => C4::Context->preference("IntranetNav"),
447 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
448 LibraryName => C4::Context->preference("LibraryName"),
449 LoginBranchname => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
450 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
451 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
452 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
453 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
454 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
455 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
456 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
457 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
458 intranetbookbag => C4::Context->preference("intranetbookbag"),
459 suggestion => C4::Context->preference("suggestion"),
460 virtualshelves => C4::Context->preference("virtualshelves"),
461 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
462 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
463 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
464 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
465 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
466 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
467 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
468 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
469 useDischarge => C4::Context->preference('useDischarge'),
473 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
475 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
476 my $LibraryNameTitle = C4::Context->preference("LibraryName");
477 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
478 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
480 # clean up the busc param in the session
481 # if the page is not opac-detail and not the "add to list" page
482 # and not the "edit comments" page
483 if ( C4::Context->preference("OpacBrowseResults")
484 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
486 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
487 or $pagename =~ /^addbybiblionumber$/
488 or $pagename =~ /^review$/ ) {
489 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
490 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
494 # variables passed from CGI: opac_css_override and opac_search_limits.
495 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
496 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
499 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
500 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
501 ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
503 $opac_name = $1; # opac_search_limit is a branch, so we use it.
504 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
505 $opac_name = $in->{'query'}->param('multibranchlimit');
506 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
507 $opac_name = C4::Context->userenv->{'branch'};
510 my $library_categories = Koha::LibraryCategories->search({categorytype => 'searchdomain', show_in_pulldown => 1}, { order_by => ['categorytype', 'categorycode']});
512 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
513 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
514 BranchCategoriesLoop => $library_categories,
515 opac_name => $opac_name,
516 LibraryName => "" . C4::Context->preference("LibraryName"),
517 LibraryNameTitle => "" . $LibraryNameTitle,
518 LoginBranchname => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
519 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
520 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
521 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
522 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
523 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
524 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
525 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
526 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
527 opac_search_limit => $opac_search_limit,
528 opac_limit_override => $opac_limit_override,
529 OpacBrowser => C4::Context->preference("OpacBrowser"),
530 OpacCloud => C4::Context->preference("OpacCloud"),
531 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
532 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
533 OpacNav => "" . C4::Context->preference("OpacNav"),
534 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
535 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
536 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
537 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
538 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
539 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
540 OpacTopissue => C4::Context->preference("OpacTopissue"),
541 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
542 'Version' => C4::Context->preference('Version'),
543 hidelostitems => C4::Context->preference("hidelostitems"),
544 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
545 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
546 opacbookbag => "" . C4::Context->preference("opacbookbag"),
547 opaccredits => "" . C4::Context->preference("opaccredits"),
548 OpacFavicon => C4::Context->preference("OpacFavicon"),
549 opacheader => "" . C4::Context->preference("opacheader"),
550 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
551 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
552 OPACUserJS => C4::Context->preference("OPACUserJS"),
553 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
554 OpenLibrarySearch => C4::Context->preference("OpenLibrarySearch"),
555 ShowReviewer => C4::Context->preference("ShowReviewer"),
556 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
557 suggestion => "" . C4::Context->preference("suggestion"),
558 virtualshelves => "" . C4::Context->preference("virtualshelves"),
559 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
560 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
561 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
562 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
563 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
564 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
565 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
566 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
567 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
568 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
569 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
570 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
571 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
572 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
573 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
574 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
575 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
576 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
577 useDischarge => C4::Context->preference('useDischarge'),
580 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
583 # Check if we were asked using parameters to force a specific language
584 if ( defined $in->{'query'}->param('language') ) {
586 # Extract the language, let C4::Languages::getlanguage choose
588 my $language = C4::Languages::getlanguage( $in->{'query'} );
589 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
590 if ( ref $cookie eq 'ARRAY' ) {
591 push @{$cookie}, $languagecookie;
593 $cookie = [ $cookie, $languagecookie ];
597 return ( $template, $borrowernumber, $cookie, $flags );
602 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
604 Verifies that the user is authorized to run this script. If
605 the user is authorized, a (userid, cookie, session-id, flags)
606 quadruple is returned. If the user is not authorized but does
607 not have the required privilege (see $flagsrequired below), it
608 displays an error page and exits. Otherwise, it displays the
609 login page and exits.
611 Note that C<&checkauth> will return if and only if the user
612 is authorized, so it should be called early on, before any
613 unfinished operations (e.g., if you've opened a file, then
614 C<&checkauth> won't close it for you).
616 C<$query> is the CGI object for the script calling C<&checkauth>.
618 The C<$noauth> argument is optional. If it is set, then no
619 authorization is required for the script.
621 C<&checkauth> fetches user and session information from C<$query> and
622 ensures that the user is authorized to run scripts that require
625 The C<$flagsrequired> argument specifies the required privileges
626 the user must have if the username and password are correct.
627 It should be specified as a reference-to-hash; keys in the hash
628 should be the "flags" for the user, as specified in the Members
629 intranet module. Any key specified must correspond to a "flag"
630 in the userflags table. E.g., { circulate => 1 } would specify
631 that the user must have the "circulate" privilege in order to
632 proceed. To make sure that access control is correct, the
633 C<$flagsrequired> parameter must be specified correctly.
635 Koha also has a concept of sub-permissions, also known as
636 granular permissions. This makes the value of each key
637 in the C<flagsrequired> hash take on an additional
642 The user must have access to all subfunctions of the module
643 specified by the hash key.
647 The user must have access to at least one subfunction of the module
648 specified by the hash key.
650 specific permission, e.g., 'export_catalog'
652 The user must have access to the specific subfunction list, which
653 must correspond to a row in the permissions table.
655 The C<$type> argument specifies whether the template should be
656 retrieved from the opac or intranet directory tree. "opac" is
657 assumed if it is not specified; however, if C<$type> is specified,
658 "intranet" is assumed if it is not "opac".
660 If C<$query> does not have a valid session ID associated with it
661 (i.e., the user has not logged in) or if the session has expired,
662 C<&checkauth> presents the user with a login page (from the point of
663 view of the original script, C<&checkauth> does not return). Once the
664 user has authenticated, C<&checkauth> restarts the original script
665 (this time, C<&checkauth> returns).
667 The login page is provided using a HTML::Template, which is set in the
668 systempreferences table or at the top of this file. The variable C<$type>
669 selects which template to use, either the opac or the intranet
670 authentification template.
672 C<&checkauth> returns a user ID, a cookie, and a session ID. The
673 cookie should be sent back to the browser; it verifies that the user
683 # If version syspref is unavailable, it means Koha is being installed,
684 # and so we must redirect to OPAC maintenance page or to the WebInstaller
685 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
686 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
687 warn "OPAC Install required, redirecting to maintenance";
688 print $query->redirect("/cgi-bin/koha/maintenance.pl");
691 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
692 if ( $type ne 'opac' ) {
693 warn "Install required, redirecting to Installer";
694 print $query->redirect("/cgi-bin/koha/installer/install.pl");
696 warn "OPAC Install required, redirecting to maintenance";
697 print $query->redirect("/cgi-bin/koha/maintenance.pl");
702 # check that database and koha version are the same
703 # there is no DB version, it's a fresh install,
704 # go to web installer
705 # there is a DB version, compare it to the code version
706 my $kohaversion = Koha::version();
708 # remove the 3 last . to have a Perl number
709 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
710 $debug and print STDERR "kohaversion : $kohaversion\n";
711 if ( $version < $kohaversion ) {
712 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
713 if ( $type ne 'opac' ) {
714 warn sprintf( $warning, 'Installer' );
715 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
717 warn sprintf( "OPAC: " . $warning, 'maintenance' );
718 print $query->redirect("/cgi-bin/koha/maintenance.pl");
726 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
727 printf $fh join( "\n", @_ );
731 sub _timeout_syspref {
732 my $timeout = C4::Context->preference('timeout') || 600;
734 # value in days, convert in seconds
735 if ( $timeout =~ /(\d+)[dD]/ ) {
736 $timeout = $1 * 86400;
743 $debug and warn "Checking Auth";
745 # $authnotrequired will be set for scripts which will run without authentication
746 my $authnotrequired = shift;
747 my $flagsrequired = shift;
749 $type = 'opac' unless $type;
751 my $dbh = C4::Context->dbh;
752 my $timeout = _timeout_syspref();
754 _version_check( $type, $query );
759 my ( $userid, $cookie, $sessionID, $flags );
760 my $logout = $query->param('logout.x');
762 my $anon_search_history;
764 # This parameter is the name of the CAS server we want to authenticate against,
765 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
766 my $casparam = $query->param('cas');
767 my $q_userid = $query->param('userid') // '';
769 # Basic authentication is incompatible with the use of Shibboleth,
770 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
771 # and it may not be the attribute we want to use to match the koha login.
773 # Also, do not consider an empty REMOTE_USER.
775 # Finally, after those tests, we can assume (although if it would be better with
776 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
777 # and we can affect it to $userid.
778 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
780 # Using Basic Authentication, no cookies required
781 $cookie = $query->cookie(
782 -name => 'CGISESSID',
789 elsif ( $sessionID = $query->cookie("CGISESSID") )
790 { # assignment, not comparison
791 my $session = get_session($sessionID);
792 C4::Context->_new_userenv($sessionID);
793 my ( $ip, $lasttime, $sessiontype );
796 $s_userid = $session->param('id') // '';
797 C4::Context->set_userenv(
798 $session->param('number'), $s_userid,
799 $session->param('cardnumber'), $session->param('firstname'),
800 $session->param('surname'), $session->param('branch'),
801 $session->param('branchname'), $session->param('flags'),
802 $session->param('emailaddress'), $session->param('branchprinter'),
803 $session->param('shibboleth')
805 C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
806 C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
807 C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
808 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
809 $ip = $session->param('ip');
810 $lasttime = $session->param('lasttime');
812 $sessiontype = $session->param('sessiontype') || '';
814 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
815 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
816 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
819 #if a user enters an id ne to the id in the current session, we need to log them in...
820 #first we need to clear the anonymous session...
821 $debug and warn "query id = $q_userid but session id = $s_userid";
822 $anon_search_history = $session->param('search_history');
825 C4::Context->_unset_userenv($sessionID);
831 # voluntary logout the user
832 # check wether the user was using their shibboleth session or a local one
833 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
836 C4::Context->_unset_userenv($sessionID);
838 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
842 if ($cas and $caslogout) {
843 logout_cas($query, $type);
846 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
847 if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
849 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
853 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
856 $info{'timed_out'} = 1;
861 C4::Context->_unset_userenv($sessionID);
863 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
867 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
869 # Different ip than originally logged in from
870 $info{'oldip'} = $ip;
871 $info{'newip'} = $ENV{'REMOTE_ADDR'};
872 $info{'different_ip'} = 1;
875 C4::Context->_unset_userenv($sessionID);
877 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
882 $cookie = $query->cookie(
883 -name => 'CGISESSID',
884 -value => $session->id,
887 $session->param( 'lasttime', time() );
888 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...
889 $flags = haspermission( $userid, $flagsrequired );
893 $info{'nopermission'} = 1;
898 unless ( $userid || $sessionID ) {
900 #we initiate a session prior to checking for a username to allow for anonymous sessions...
901 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
903 # Save anonymous search history in new session so it can be retrieved
904 # by get_template_and_user to store it in user's search history after
905 # a successful login.
906 if ($anon_search_history) {
907 $session->param( 'search_history', $anon_search_history );
910 my $sessionID = $session->id;
911 C4::Context->_new_userenv($sessionID);
912 $cookie = $query->cookie(
913 -name => 'CGISESSID',
914 -value => $session->id,
918 my $pki_field = C4::Context->preference('AllowPKIAuth');
919 if ( !defined($pki_field) ) {
920 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
923 if ( ( $cas && $query->param('ticket') )
925 || ( $shib && $shib_login )
926 || $pki_field ne 'None' )
928 my $password = $query->param('password');
931 my ( $return, $cardnumber );
933 # If shib is enabled and we have a shib login, does the login match a valid koha user
934 if ( $shib && $shib_login && $type eq 'opac' ) {
937 # Do not pass password here, else shib will not be checked in checkpw.
938 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, undef, $query );
939 $userid = $retuserid;
940 $shibSuccess = $return;
941 $info{'invalidShibLogin'} = 1 unless ($return);
944 # If shib login and match were successful, skip further login methods
945 unless ($shibSuccess) {
946 if ( $cas && $query->param('ticket') ) {
948 ( $return, $cardnumber, $retuserid ) =
949 checkpw( $dbh, $userid, $password, $query, $type );
950 $userid = $retuserid;
951 $info{'invalidCasLogin'} = 1 unless ($return);
955 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
956 || ( $pki_field eq 'emailAddress'
957 && $ENV{'SSL_CLIENT_S_DN_Email'} )
961 if ( $pki_field eq 'Common Name' ) {
962 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
964 elsif ( $pki_field eq 'emailAddress' ) {
965 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
967 # If we're looking up the email, there's a chance that the person
968 # doesn't have a userid. So if there is none, we pass along the
969 # borrower number, and the bits of code that need to know the user
970 # ID will have to be smart enough to handle that.
972 my @users_info = C4::Members::GetBorrowersWithEmail($value);
975 # First the userid, then the borrowernum
976 $value = $users_info[0][1] || $users_info[0][0];
982 $return = $value ? 1 : 0;
988 ( $return, $cardnumber, $retuserid ) =
989 checkpw( $dbh, $userid, $password, $query, $type );
990 $userid = $retuserid if ($retuserid);
991 $info{'invalid_username_or_password'} = 1 unless ($return);
995 # $return: 1 = valid user, 2 = superlibrarian
998 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
999 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1003 $info{'nopermission'} = 1;
1004 C4::Context->_unset_userenv($sessionID);
1006 my ( $borrowernumber, $firstname, $surname, $userflags,
1007 $branchcode, $branchname, $branchprinter, $emailaddress );
1009 if ( $return == 1 ) {
1011 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1012 branches.branchname as branchname,
1013 branches.branchprinter as branchprinter,
1016 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1018 my $sth = $dbh->prepare("$select where userid=?");
1019 $sth->execute($userid);
1020 unless ( $sth->rows ) {
1021 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1022 $sth = $dbh->prepare("$select where cardnumber=?");
1023 $sth->execute($cardnumber);
1025 unless ( $sth->rows ) {
1026 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1027 $sth->execute($userid);
1028 unless ( $sth->rows ) {
1029 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1034 ( $borrowernumber, $firstname, $surname, $userflags,
1035 $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1036 $debug and print STDERR "AUTH_3 results: " .
1037 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1039 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1042 # launch a sequence to check if we have a ip for the branch, i
1043 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1045 my $ip = $ENV{'REMOTE_ADDR'};
1047 # if they specify at login, use that
1048 if ( $query->param('branch') ) {
1049 $branchcode = $query->param('branch');
1050 my $library = Koha::Libraries->find($branchcode);
1051 $branchname = $library? $library->branchname: '';
1053 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1054 if ( $type ne 'opac' and C4::Context->boolean_preference('AutoLocation') ) {
1056 # we have to check they are coming from the right ip range
1057 my $domain = $branches->{$branchcode}->{'branchip'};
1058 $domain =~ s|\.\*||g;
1059 if ( $ip !~ /^$domain/ ) {
1061 $info{'wrongip'} = 1;
1065 foreach my $br ( keys %$branches ) {
1067 # now we work with the treatment of ip
1068 my $domain = $branches->{$br}->{'branchip'};
1069 if ( $domain && $ip =~ /^$domain/ ) {
1070 $branchcode = $branches->{$br}->{'branchcode'};
1072 # new op dev : add the branchprinter and branchname in the cookie
1073 $branchprinter = $branches->{$br}->{'branchprinter'};
1074 $branchname = $branches->{$br}->{'branchname'};
1077 $session->param( 'number', $borrowernumber );
1078 $session->param( 'id', $userid );
1079 $session->param( 'cardnumber', $cardnumber );
1080 $session->param( 'firstname', $firstname );
1081 $session->param( 'surname', $surname );
1082 $session->param( 'branch', $branchcode );
1083 $session->param( 'branchname', $branchname );
1084 $session->param( 'flags', $userflags );
1085 $session->param( 'emailaddress', $emailaddress );
1086 $session->param( 'ip', $session->remote_addr() );
1087 $session->param( 'lasttime', time() );
1088 $session->param( 'shibboleth', $shibSuccess );
1089 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1091 elsif ( $return == 2 ) {
1093 #We suppose the user is the superlibrarian
1094 $borrowernumber = 0;
1095 $session->param( 'number', 0 );
1096 $session->param( 'id', C4::Context->config('user') );
1097 $session->param( 'cardnumber', C4::Context->config('user') );
1098 $session->param( 'firstname', C4::Context->config('user') );
1099 $session->param( 'surname', C4::Context->config('user') );
1100 $session->param( 'branch', 'NO_LIBRARY_SET' );
1101 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1102 $session->param( 'flags', 1 );
1103 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1104 $session->param( 'ip', $session->remote_addr() );
1105 $session->param( 'lasttime', time() );
1107 C4::Context->set_userenv(
1108 $session->param('number'), $session->param('id'),
1109 $session->param('cardnumber'), $session->param('firstname'),
1110 $session->param('surname'), $session->param('branch'),
1111 $session->param('branchname'), $session->param('flags'),
1112 $session->param('emailaddress'), $session->param('branchprinter'),
1113 $session->param('shibboleth')
1117 # $return: 0 = invalid user
1118 # reset to anonymous session
1120 $debug and warn "Login failed, resetting anonymous session...";
1122 $info{'invalid_username_or_password'} = 1;
1123 C4::Context->_unset_userenv($sessionID);
1125 $session->param( 'lasttime', time() );
1126 $session->param( 'ip', $session->remote_addr() );
1127 $session->param( 'sessiontype', 'anon' );
1129 } # END if ( $userid = $query->param('userid') )
1130 elsif ( $type eq "opac" ) {
1132 # if we are here this is an anonymous session; add public lists to it and a few other items...
1133 # anonymous sessions are created only for the OPAC
1134 $debug and warn "Initiating an anonymous session...";
1136 # setting a couple of other session vars...
1137 $session->param( 'ip', $session->remote_addr() );
1138 $session->param( 'lasttime', time() );
1139 $session->param( 'sessiontype', 'anon' );
1141 } # END unless ($userid)
1143 # finished authentification, now respond
1144 if ( $loggedin || $authnotrequired )
1148 $cookie = $query->cookie(
1149 -name => 'CGISESSID',
1156 # track_login also depends on pref TrackLastPatronActivity
1157 my $patron = Koha::Patrons->find({ userid => $userid });
1158 $patron->track_login if $patron;
1161 return ( $userid, $cookie, $sessionID, $flags );
1166 # AUTH rejected, show the login/password template, after checking the DB.
1170 # get the inputs from the incoming query
1172 foreach my $name ( param $query) {
1173 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1174 my $value = $query->param($name);
1175 push @inputs, { name => $name, value => $value };
1178 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1179 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1180 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1182 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1183 my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1185 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1186 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1189 script_name => get_script_name(),
1190 casAuthentication => C4::Context->preference("casAuthentication"),
1191 shibbolethAuthentication => $shib,
1192 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1193 suggestion => C4::Context->preference("suggestion"),
1194 virtualshelves => C4::Context->preference("virtualshelves"),
1195 LibraryName => "" . C4::Context->preference("LibraryName"),
1196 LibraryNameTitle => "" . $LibraryNameTitle,
1197 opacuserlogin => C4::Context->preference("opacuserlogin"),
1198 OpacNav => C4::Context->preference("OpacNav"),
1199 OpacNavRight => C4::Context->preference("OpacNavRight"),
1200 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1201 opaccredits => C4::Context->preference("opaccredits"),
1202 OpacFavicon => C4::Context->preference("OpacFavicon"),
1203 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1204 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1205 OPACUserJS => C4::Context->preference("OPACUserJS"),
1206 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1207 OpacCloud => C4::Context->preference("OpacCloud"),
1208 OpacTopissue => C4::Context->preference("OpacTopissue"),
1209 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1210 OpacBrowser => C4::Context->preference("OpacBrowser"),
1211 opacheader => C4::Context->preference("opacheader"),
1212 TagsEnabled => C4::Context->preference("TagsEnabled"),
1213 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1214 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1215 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1216 intranetbookbag => C4::Context->preference("intranetbookbag"),
1217 IntranetNav => C4::Context->preference("IntranetNav"),
1218 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1219 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1220 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1221 IndependentBranches => C4::Context->preference("IndependentBranches"),
1222 AutoLocation => C4::Context->preference("AutoLocation"),
1223 wrongip => $info{'wrongip'},
1224 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1225 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1226 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1229 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1230 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1231 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1233 if ( $type eq 'opac' ) {
1234 require Koha::Virtualshelves;
1235 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1241 some_public_shelves => $some_public_shelves,
1247 # Is authentication against multiple CAS servers enabled?
1248 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1249 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1251 foreach my $key ( keys %$casservers ) {
1252 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1255 casServersLoop => \@tmplservers
1259 casServerUrl => login_cas_url($query, undef, $type),
1264 invalidCasLogin => $info{'invalidCasLogin'}
1270 shibbolethAuthentication => $shib,
1271 shibbolethLoginUrl => login_shib_url($query),
1275 if (C4::Context->preference('GoogleOpenIDConnect')) {
1276 if ($query->param("OpenIDConnectFailed")) {
1277 my $reason = $query->param('OpenIDConnectFailed');
1278 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1283 LibraryName => C4::Context->preference("LibraryName"),
1285 $template->param(%info);
1287 # $cookie = $query->cookie(CGISESSID => $session->id
1289 print $query->header(
1290 { type => 'text/html',
1293 'X-Frame-Options' => 'SAMEORIGIN'
1300 =head2 check_api_auth
1302 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1304 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1305 cookie, determine if the user has the privileges specified by C<$userflags>.
1307 C<check_api_auth> is is meant for authenticating users of web services, and
1308 consequently will always return and will not attempt to redirect the user
1311 If a valid session cookie is already present, check_api_auth will return a status
1312 of "ok", the cookie, and the Koha session ID.
1314 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1315 parameters and create a session cookie and Koha session if the supplied credentials
1318 Possible return values in C<$status> are:
1322 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1324 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1326 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1328 =item "expired -- session cookie has expired; API user should resubmit userid and password
1334 sub check_api_auth {
1336 my $flagsrequired = shift;
1338 my $dbh = C4::Context->dbh;
1339 my $timeout = _timeout_syspref();
1341 unless ( C4::Context->preference('Version') ) {
1343 # database has not been installed yet
1344 return ( "maintenance", undef, undef );
1346 my $kohaversion = Koha::version();
1347 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1348 if ( C4::Context->preference('Version') < $kohaversion ) {
1350 # database in need of version update; assume that
1351 # no API should be called while databsae is in
1353 return ( "maintenance", undef, undef );
1356 # FIXME -- most of what follows is a copy-and-paste
1357 # of code from checkauth. There is an obvious need
1358 # for refactoring to separate the various parts of
1359 # the authentication code, but as of 2007-11-19 this
1360 # is deferred so as to not introduce bugs into the
1361 # regular authentication code for Koha 3.0.
1363 # see if we have a valid session cookie already
1364 # however, if a userid parameter is present (i.e., from
1365 # a form submission, assume that any current cookie
1367 my $sessionID = undef;
1368 unless ( $query->param('userid') ) {
1369 $sessionID = $query->cookie("CGISESSID");
1371 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1372 my $session = get_session($sessionID);
1373 C4::Context->_new_userenv($sessionID);
1375 C4::Context->set_userenv(
1376 $session->param('number'), $session->param('id'),
1377 $session->param('cardnumber'), $session->param('firstname'),
1378 $session->param('surname'), $session->param('branch'),
1379 $session->param('branchname'), $session->param('flags'),
1380 $session->param('emailaddress'), $session->param('branchprinter')
1383 my $ip = $session->param('ip');
1384 my $lasttime = $session->param('lasttime');
1385 my $userid = $session->param('id');
1386 if ( $lasttime < time() - $timeout ) {
1391 C4::Context->_unset_userenv($sessionID);
1394 return ( "expired", undef, undef );
1395 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1397 # IP address changed
1400 C4::Context->_unset_userenv($sessionID);
1403 return ( "expired", undef, undef );
1405 my $cookie = $query->cookie(
1406 -name => 'CGISESSID',
1407 -value => $session->id,
1410 $session->param( 'lasttime', time() );
1411 my $flags = haspermission( $userid, $flagsrequired );
1413 return ( "ok", $cookie, $sessionID );
1417 C4::Context->_unset_userenv($sessionID);
1420 return ( "failed", undef, undef );
1424 return ( "expired", undef, undef );
1429 my $userid = $query->param('userid');
1430 my $password = $query->param('password');
1431 my ( $return, $cardnumber );
1434 if ( $cas && $query->param('PT') ) {
1436 $debug and print STDERR "## check_api_auth - checking CAS\n";
1438 # In case of a CAS authentication, we use the ticket instead of the password
1439 my $PT = $query->param('PT');
1440 ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1443 # User / password auth
1444 unless ( $userid and $password ) {
1446 # caller did something wrong, fail the authenticateion
1447 return ( "failed", undef, undef );
1449 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1452 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1453 my $session = get_session("");
1454 return ( "failed", undef, undef ) unless $session;
1456 my $sessionID = $session->id;
1457 C4::Context->_new_userenv($sessionID);
1458 my $cookie = $query->cookie(
1459 -name => 'CGISESSID',
1460 -value => $sessionID,
1463 if ( $return == 1 ) {
1465 $borrowernumber, $firstname, $surname,
1466 $userflags, $branchcode, $branchname,
1467 $branchprinter, $emailaddress
1471 "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=?"
1473 $sth->execute($userid);
1475 $borrowernumber, $firstname, $surname,
1476 $userflags, $branchcode, $branchname,
1477 $branchprinter, $emailaddress
1478 ) = $sth->fetchrow if ( $sth->rows );
1480 unless ( $sth->rows ) {
1481 my $sth = $dbh->prepare(
1482 "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=?"
1484 $sth->execute($cardnumber);
1486 $borrowernumber, $firstname, $surname,
1487 $userflags, $branchcode, $branchname,
1488 $branchprinter, $emailaddress
1489 ) = $sth->fetchrow if ( $sth->rows );
1491 unless ( $sth->rows ) {
1492 $sth->execute($userid);
1494 $borrowernumber, $firstname, $surname, $userflags,
1495 $branchcode, $branchname, $branchprinter, $emailaddress
1496 ) = $sth->fetchrow if ( $sth->rows );
1500 my $ip = $ENV{'REMOTE_ADDR'};
1502 # if they specify at login, use that
1503 if ( $query->param('branch') ) {
1504 $branchcode = $query->param('branch');
1505 my $library = Koha::Libraries->find($branchcode);
1506 $branchname = $library? $library->branchname: '';
1508 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1509 foreach my $br ( keys %$branches ) {
1511 # now we work with the treatment of ip
1512 my $domain = $branches->{$br}->{'branchip'};
1513 if ( $domain && $ip =~ /^$domain/ ) {
1514 $branchcode = $branches->{$br}->{'branchcode'};
1516 # new op dev : add the branchprinter and branchname in the cookie
1517 $branchprinter = $branches->{$br}->{'branchprinter'};
1518 $branchname = $branches->{$br}->{'branchname'};
1521 $session->param( 'number', $borrowernumber );
1522 $session->param( 'id', $userid );
1523 $session->param( 'cardnumber', $cardnumber );
1524 $session->param( 'firstname', $firstname );
1525 $session->param( 'surname', $surname );
1526 $session->param( 'branch', $branchcode );
1527 $session->param( 'branchname', $branchname );
1528 $session->param( 'flags', $userflags );
1529 $session->param( 'emailaddress', $emailaddress );
1530 $session->param( 'ip', $session->remote_addr() );
1531 $session->param( 'lasttime', time() );
1532 } elsif ( $return == 2 ) {
1534 #We suppose the user is the superlibrarian
1535 $session->param( 'number', 0 );
1536 $session->param( 'id', C4::Context->config('user') );
1537 $session->param( 'cardnumber', C4::Context->config('user') );
1538 $session->param( 'firstname', C4::Context->config('user') );
1539 $session->param( 'surname', C4::Context->config('user') );
1540 $session->param( 'branch', 'NO_LIBRARY_SET' );
1541 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1542 $session->param( 'flags', 1 );
1543 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1544 $session->param( 'ip', $session->remote_addr() );
1545 $session->param( 'lasttime', time() );
1547 C4::Context->set_userenv(
1548 $session->param('number'), $session->param('id'),
1549 $session->param('cardnumber'), $session->param('firstname'),
1550 $session->param('surname'), $session->param('branch'),
1551 $session->param('branchname'), $session->param('flags'),
1552 $session->param('emailaddress'), $session->param('branchprinter')
1554 return ( "ok", $cookie, $sessionID );
1556 return ( "failed", undef, undef );
1561 =head2 check_cookie_auth
1563 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1565 Given a CGISESSID cookie set during a previous login to Koha, determine
1566 if the user has the privileges specified by C<$userflags>.
1568 C<check_cookie_auth> is meant for authenticating special services
1569 such as tools/upload-file.pl that are invoked by other pages that
1570 have been authenticated in the usual way.
1572 Possible return values in C<$status> are:
1576 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1578 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1580 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1582 =item "expired -- session cookie has expired; API user should resubmit userid and password
1588 sub check_cookie_auth {
1590 my $flagsrequired = shift;
1593 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1594 my $dbh = C4::Context->dbh;
1595 my $timeout = _timeout_syspref();
1597 unless ( C4::Context->preference('Version') ) {
1599 # database has not been installed yet
1600 return ( "maintenance", undef );
1602 my $kohaversion = Koha::version();
1603 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1604 if ( C4::Context->preference('Version') < $kohaversion ) {
1606 # database in need of version update; assume that
1607 # no API should be called while databsae is in
1609 return ( "maintenance", undef );
1612 # FIXME -- most of what follows is a copy-and-paste
1613 # of code from checkauth. There is an obvious need
1614 # for refactoring to separate the various parts of
1615 # the authentication code, but as of 2007-11-23 this
1616 # is deferred so as to not introduce bugs into the
1617 # regular authentication code for Koha 3.0.
1619 # see if we have a valid session cookie already
1620 # however, if a userid parameter is present (i.e., from
1621 # a form submission, assume that any current cookie
1623 unless ( defined $cookie and $cookie ) {
1624 return ( "failed", undef );
1626 my $sessionID = $cookie;
1627 my $session = get_session($sessionID);
1628 C4::Context->_new_userenv($sessionID);
1630 C4::Context->set_userenv(
1631 $session->param('number'), $session->param('id'),
1632 $session->param('cardnumber'), $session->param('firstname'),
1633 $session->param('surname'), $session->param('branch'),
1634 $session->param('branchname'), $session->param('flags'),
1635 $session->param('emailaddress'), $session->param('branchprinter')
1638 my $ip = $session->param('ip');
1639 my $lasttime = $session->param('lasttime');
1640 my $userid = $session->param('id');
1641 if ( $lasttime < time() - $timeout ) {
1646 C4::Context->_unset_userenv($sessionID);
1649 return ("expired", undef);
1650 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1652 # IP address changed
1655 C4::Context->_unset_userenv($sessionID);
1658 return ( "expired", undef );
1660 $session->param( 'lasttime', time() );
1661 my $flags = haspermission( $userid, $flagsrequired );
1663 return ( "ok", $sessionID );
1667 C4::Context->_unset_userenv($sessionID);
1670 return ( "failed", undef );
1674 return ( "expired", undef );
1681 my $session = get_session($sessionID);
1683 Given a session ID, retrieve the CGI::Session object used to store
1684 the session's state. The session object can be used to store
1685 data that needs to be accessed by different scripts during a
1688 If the C<$sessionID> parameter is an empty string, a new session
1694 my $sessionID = shift;
1695 my $storage_method = C4::Context->preference('SessionStorage');
1696 my $dbh = C4::Context->dbh;
1698 if ( $storage_method eq 'mysql' ) {
1699 $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1701 elsif ( $storage_method eq 'Pg' ) {
1702 $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1704 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1705 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1706 $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => $memcached } );
1709 # catch all defaults to tmp should work on all systems
1710 my $dir = File::Spec->tmpdir;
1711 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1712 $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => "$dir/cgisess_$instance" } );
1718 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1719 # (or something similar)
1720 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1721 # not having a userenv defined could cause a crash.
1723 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1724 $type = 'opac' unless $type;
1726 $debug and print STDERR "## checkpw - checking LDAP\n";
1727 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1728 return 0 if $retval == -1; # Incorrect password for LDAP login attempt
1729 ($retval) and return ( $retval, $retcard, $retuserid );
1732 if ( $cas && $query && $query->param('ticket') ) {
1733 $debug and print STDERR "## checkpw - checking CAS\n";
1735 # In case of a CAS authentication, we use the ticket instead of the password
1736 my $ticket = $query->param('ticket');
1737 $query->delete('ticket'); # remove ticket to come back to original URL
1738 my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1739 ($retval) and return ( $retval, $retcard, $retuserid );
1743 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1744 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1746 if ( $shib && $shib_login && !$password ) {
1748 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1750 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1751 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1752 # shibboleth-authenticated user
1754 # Then, we check if it matches a valid koha user
1756 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1757 ($retval) and return ( $retval, $retcard, $retuserid );
1763 return checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1766 sub checkpw_internal {
1767 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1769 $password = Encode::encode( 'UTF-8', $password )
1770 if Encode::is_utf8($password);
1772 if ( $userid && $userid eq C4::Context->config('user') ) {
1773 if ( $password && $password eq C4::Context->config('pass') ) {
1775 # Koha superuser account
1776 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1786 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1788 $sth->execute($userid);
1790 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1791 $surname, $branchcode, $branchname, $flags )
1794 if ( checkpw_hash( $password, $stored_hash ) ) {
1796 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1797 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1798 return 1, $cardnumber, $userid;
1803 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1805 $sth->execute($userid);
1807 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1808 $surname, $branchcode, $branchname, $flags )
1811 if ( checkpw_hash( $password, $stored_hash ) ) {
1813 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1814 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1815 return 1, $cardnumber, $userid;
1818 if ( $userid && $userid eq 'demo'
1819 && "$password" eq 'demo'
1820 && C4::Context->config('demo') )
1823 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1824 # some features won't be effective : modify systempref, modify MARC structure,
1831 my ( $password, $stored_hash ) = @_;
1833 return if $stored_hash eq '!';
1835 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1837 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1838 $hash = hash_password( $password, $stored_hash );
1840 $hash = md5_base64($password);
1842 return $hash eq $stored_hash;
1847 my $authflags = getuserflags($flags, $userid, [$dbh]);
1849 Translates integer flags into permissions strings hash.
1851 C<$flags> is the integer userflags value ( borrowers.userflags )
1852 C<$userid> is the members.userid, used for building subpermissions
1853 C<$authflags> is a hashref of permissions
1860 my $dbh = @_ ? shift : C4::Context->dbh;
1863 # I don't want to do this, but if someone logs in as the database
1864 # user, it would be preferable not to spam them to death with
1865 # numeric warnings. So, we make $flags numeric.
1866 no warnings 'numeric';
1869 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1872 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1873 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1874 $userflags->{$flag} = 1;
1877 $userflags->{$flag} = 0;
1881 # get subpermissions and merge with top-level permissions
1882 my $user_subperms = get_user_subpermissions($userid);
1883 foreach my $module ( keys %$user_subperms ) {
1884 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1885 $userflags->{$module} = $user_subperms->{$module};
1891 =head2 get_user_subpermissions
1893 $user_perm_hashref = get_user_subpermissions($userid);
1895 Given the userid (note, not the borrowernumber) of a staff user,
1896 return a hashref of hashrefs of the specific subpermissions
1897 accorded to the user. An example return is
1901 export_catalog => 1,
1902 import_patrons => 1,
1906 The top-level hash-key is a module or function code from
1907 userflags.flag, while the second-level key is a code
1910 The results of this function do not give a complete picture
1911 of the functions that a staff user can access; it is also
1912 necessary to check borrowers.flags.
1916 sub get_user_subpermissions {
1919 my $dbh = C4::Context->dbh;
1920 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1921 FROM user_permissions
1922 JOIN permissions USING (module_bit, code)
1923 JOIN userflags ON (module_bit = bit)
1924 JOIN borrowers USING (borrowernumber)
1925 WHERE userid = ?" );
1926 $sth->execute($userid);
1928 my $user_perms = {};
1929 while ( my $perm = $sth->fetchrow_hashref ) {
1930 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1935 =head2 get_all_subpermissions
1937 my $perm_hashref = get_all_subpermissions();
1939 Returns a hashref of hashrefs defining all specific
1940 permissions currently defined. The return value
1941 has the same structure as that of C<get_user_subpermissions>,
1942 except that the innermost hash value is the description
1943 of the subpermission.
1947 sub get_all_subpermissions {
1948 my $dbh = C4::Context->dbh;
1949 my $sth = $dbh->prepare( "SELECT flag, code
1951 JOIN userflags ON (module_bit = bit)" );
1955 while ( my $perm = $sth->fetchrow_hashref ) {
1956 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1961 =head2 haspermission
1963 $flags = ($userid, $flagsrequired);
1965 C<$userid> the userid of the member
1966 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1968 Returns member's flags or 0 if a permission is not met.
1973 my ( $userid, $flagsrequired ) = @_;
1974 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1975 $sth->execute($userid);
1976 my $row = $sth->fetchrow();
1977 my $flags = getuserflags( $row, $userid );
1978 if ( $userid eq C4::Context->config('user') ) {
1980 # Super User Account from /etc/koha.conf
1981 $flags->{'superlibrarian'} = 1;
1983 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1985 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1986 $flags->{'superlibrarian'} = 1;
1989 return $flags if $flags->{superlibrarian};
1991 foreach my $module ( keys %$flagsrequired ) {
1992 my $subperm = $flagsrequired->{$module};
1993 if ( $subperm eq '*' ) {
1994 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
1997 ( defined $flags->{$module} and
1998 $flags->{$module} == 1 )
2000 ( ref( $flags->{$module} ) and
2001 exists $flags->{$module}->{$subperm} and
2002 $flags->{$module}->{$subperm} == 1 )
2008 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2011 sub getborrowernumber {
2013 my $userenv = C4::Context->userenv;
2014 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2015 return $userenv->{number};
2017 my $dbh = C4::Context->dbh;
2018 for my $field ( 'userid', 'cardnumber' ) {
2020 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2021 $sth->execute($userid);
2023 my ($bnumber) = $sth->fetchrow;
2030 END { } # module clean-up code here (global destructor)
2040 Crypt::Eksblowfish::Bcrypt(3)