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 ( C4::Context->boolean_preference('IndependentBranches') && 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 if ( $ip !~ /^$domain/ ) {
1060 $info{'wrongip'} = 1;
1064 foreach my $br ( keys %$branches ) {
1066 # now we work with the treatment of ip
1067 my $domain = $branches->{$br}->{'branchip'};
1068 if ( $domain && $ip =~ /^$domain/ ) {
1069 $branchcode = $branches->{$br}->{'branchcode'};
1071 # new op dev : add the branchprinter and branchname in the cookie
1072 $branchprinter = $branches->{$br}->{'branchprinter'};
1073 $branchname = $branches->{$br}->{'branchname'};
1076 $session->param( 'number', $borrowernumber );
1077 $session->param( 'id', $userid );
1078 $session->param( 'cardnumber', $cardnumber );
1079 $session->param( 'firstname', $firstname );
1080 $session->param( 'surname', $surname );
1081 $session->param( 'branch', $branchcode );
1082 $session->param( 'branchname', $branchname );
1083 $session->param( 'flags', $userflags );
1084 $session->param( 'emailaddress', $emailaddress );
1085 $session->param( 'ip', $session->remote_addr() );
1086 $session->param( 'lasttime', time() );
1087 $session->param( 'shibboleth', $shibSuccess );
1088 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1090 elsif ( $return == 2 ) {
1092 #We suppose the user is the superlibrarian
1093 $borrowernumber = 0;
1094 $session->param( 'number', 0 );
1095 $session->param( 'id', C4::Context->config('user') );
1096 $session->param( 'cardnumber', C4::Context->config('user') );
1097 $session->param( 'firstname', C4::Context->config('user') );
1098 $session->param( 'surname', C4::Context->config('user') );
1099 $session->param( 'branch', 'NO_LIBRARY_SET' );
1100 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1101 $session->param( 'flags', 1 );
1102 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1103 $session->param( 'ip', $session->remote_addr() );
1104 $session->param( 'lasttime', time() );
1106 C4::Context->set_userenv(
1107 $session->param('number'), $session->param('id'),
1108 $session->param('cardnumber'), $session->param('firstname'),
1109 $session->param('surname'), $session->param('branch'),
1110 $session->param('branchname'), $session->param('flags'),
1111 $session->param('emailaddress'), $session->param('branchprinter'),
1112 $session->param('shibboleth')
1116 # $return: 0 = invalid user
1117 # reset to anonymous session
1119 $debug and warn "Login failed, resetting anonymous session...";
1121 $info{'invalid_username_or_password'} = 1;
1122 C4::Context->_unset_userenv($sessionID);
1124 $session->param( 'lasttime', time() );
1125 $session->param( 'ip', $session->remote_addr() );
1126 $session->param( 'sessiontype', 'anon' );
1128 } # END if ( $userid = $query->param('userid') )
1129 elsif ( $type eq "opac" ) {
1131 # if we are here this is an anonymous session; add public lists to it and a few other items...
1132 # anonymous sessions are created only for the OPAC
1133 $debug and warn "Initiating an anonymous session...";
1135 # setting a couple of other session vars...
1136 $session->param( 'ip', $session->remote_addr() );
1137 $session->param( 'lasttime', time() );
1138 $session->param( 'sessiontype', 'anon' );
1140 } # END unless ($userid)
1142 # finished authentification, now respond
1143 if ( $loggedin || $authnotrequired )
1147 $cookie = $query->cookie(
1148 -name => 'CGISESSID',
1155 # track_login also depends on pref TrackLastPatronActivity
1156 my $patron = Koha::Patrons->find({ userid => $userid });
1157 $patron->track_login if $patron;
1160 return ( $userid, $cookie, $sessionID, $flags );
1165 # AUTH rejected, show the login/password template, after checking the DB.
1169 # get the inputs from the incoming query
1171 foreach my $name ( param $query) {
1172 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1173 my $value = $query->param($name);
1174 push @inputs, { name => $name, value => $value };
1177 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1178 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1179 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1181 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1182 my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1184 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1185 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1188 script_name => get_script_name(),
1189 casAuthentication => C4::Context->preference("casAuthentication"),
1190 shibbolethAuthentication => $shib,
1191 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1192 suggestion => C4::Context->preference("suggestion"),
1193 virtualshelves => C4::Context->preference("virtualshelves"),
1194 LibraryName => "" . C4::Context->preference("LibraryName"),
1195 LibraryNameTitle => "" . $LibraryNameTitle,
1196 opacuserlogin => C4::Context->preference("opacuserlogin"),
1197 OpacNav => C4::Context->preference("OpacNav"),
1198 OpacNavRight => C4::Context->preference("OpacNavRight"),
1199 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1200 opaccredits => C4::Context->preference("opaccredits"),
1201 OpacFavicon => C4::Context->preference("OpacFavicon"),
1202 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1203 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1204 OPACUserJS => C4::Context->preference("OPACUserJS"),
1205 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1206 OpacCloud => C4::Context->preference("OpacCloud"),
1207 OpacTopissue => C4::Context->preference("OpacTopissue"),
1208 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1209 OpacBrowser => C4::Context->preference("OpacBrowser"),
1210 opacheader => C4::Context->preference("opacheader"),
1211 TagsEnabled => C4::Context->preference("TagsEnabled"),
1212 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1213 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1214 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1215 intranetbookbag => C4::Context->preference("intranetbookbag"),
1216 IntranetNav => C4::Context->preference("IntranetNav"),
1217 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1218 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1219 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1220 IndependentBranches => C4::Context->preference("IndependentBranches"),
1221 AutoLocation => C4::Context->preference("AutoLocation"),
1222 wrongip => $info{'wrongip'},
1223 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1224 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1225 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1228 $template->param( SCO_login => 1 ) if ( $query->param('sco_user_login') );
1229 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1230 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1232 if ( $type eq 'opac' ) {
1233 require Koha::Virtualshelves;
1234 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1240 some_public_shelves => $some_public_shelves,
1246 # Is authentication against multiple CAS servers enabled?
1247 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1248 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1250 foreach my $key ( keys %$casservers ) {
1251 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1254 casServersLoop => \@tmplservers
1258 casServerUrl => login_cas_url($query, undef, $type),
1263 invalidCasLogin => $info{'invalidCasLogin'}
1269 shibbolethAuthentication => $shib,
1270 shibbolethLoginUrl => login_shib_url($query),
1274 if (C4::Context->preference('GoogleOpenIDConnect')) {
1275 if ($query->param("OpenIDConnectFailed")) {
1276 my $reason = $query->param('OpenIDConnectFailed');
1277 $template->param(invalidGoogleOpenIDConnectLogin => $reason);
1282 LibraryName => C4::Context->preference("LibraryName"),
1284 $template->param(%info);
1286 # $cookie = $query->cookie(CGISESSID => $session->id
1288 print $query->header(
1289 { type => 'text/html',
1292 'X-Frame-Options' => 'SAMEORIGIN'
1299 =head2 check_api_auth
1301 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1303 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1304 cookie, determine if the user has the privileges specified by C<$userflags>.
1306 C<check_api_auth> is is meant for authenticating users of web services, and
1307 consequently will always return and will not attempt to redirect the user
1310 If a valid session cookie is already present, check_api_auth will return a status
1311 of "ok", the cookie, and the Koha session ID.
1313 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1314 parameters and create a session cookie and Koha session if the supplied credentials
1317 Possible return values in C<$status> are:
1321 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1323 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1325 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1327 =item "expired -- session cookie has expired; API user should resubmit userid and password
1333 sub check_api_auth {
1335 my $flagsrequired = shift;
1337 my $dbh = C4::Context->dbh;
1338 my $timeout = _timeout_syspref();
1340 unless ( C4::Context->preference('Version') ) {
1342 # database has not been installed yet
1343 return ( "maintenance", undef, undef );
1345 my $kohaversion = Koha::version();
1346 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1347 if ( C4::Context->preference('Version') < $kohaversion ) {
1349 # database in need of version update; assume that
1350 # no API should be called while databsae is in
1352 return ( "maintenance", undef, undef );
1355 # FIXME -- most of what follows is a copy-and-paste
1356 # of code from checkauth. There is an obvious need
1357 # for refactoring to separate the various parts of
1358 # the authentication code, but as of 2007-11-19 this
1359 # is deferred so as to not introduce bugs into the
1360 # regular authentication code for Koha 3.0.
1362 # see if we have a valid session cookie already
1363 # however, if a userid parameter is present (i.e., from
1364 # a form submission, assume that any current cookie
1366 my $sessionID = undef;
1367 unless ( $query->param('userid') ) {
1368 $sessionID = $query->cookie("CGISESSID");
1370 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1371 my $session = get_session($sessionID);
1372 C4::Context->_new_userenv($sessionID);
1374 C4::Context->set_userenv(
1375 $session->param('number'), $session->param('id'),
1376 $session->param('cardnumber'), $session->param('firstname'),
1377 $session->param('surname'), $session->param('branch'),
1378 $session->param('branchname'), $session->param('flags'),
1379 $session->param('emailaddress'), $session->param('branchprinter')
1382 my $ip = $session->param('ip');
1383 my $lasttime = $session->param('lasttime');
1384 my $userid = $session->param('id');
1385 if ( $lasttime < time() - $timeout ) {
1390 C4::Context->_unset_userenv($sessionID);
1393 return ( "expired", undef, undef );
1394 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1396 # IP address changed
1399 C4::Context->_unset_userenv($sessionID);
1402 return ( "expired", undef, undef );
1404 my $cookie = $query->cookie(
1405 -name => 'CGISESSID',
1406 -value => $session->id,
1409 $session->param( 'lasttime', time() );
1410 my $flags = haspermission( $userid, $flagsrequired );
1412 return ( "ok", $cookie, $sessionID );
1416 C4::Context->_unset_userenv($sessionID);
1419 return ( "failed", undef, undef );
1423 return ( "expired", undef, undef );
1428 my $userid = $query->param('userid');
1429 my $password = $query->param('password');
1430 my ( $return, $cardnumber );
1433 if ( $cas && $query->param('PT') ) {
1435 $debug and print STDERR "## check_api_auth - checking CAS\n";
1437 # In case of a CAS authentication, we use the ticket instead of the password
1438 my $PT = $query->param('PT');
1439 ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1442 # User / password auth
1443 unless ( $userid and $password ) {
1445 # caller did something wrong, fail the authenticateion
1446 return ( "failed", undef, undef );
1448 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1451 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1452 my $session = get_session("");
1453 return ( "failed", undef, undef ) unless $session;
1455 my $sessionID = $session->id;
1456 C4::Context->_new_userenv($sessionID);
1457 my $cookie = $query->cookie(
1458 -name => 'CGISESSID',
1459 -value => $sessionID,
1462 if ( $return == 1 ) {
1464 $borrowernumber, $firstname, $surname,
1465 $userflags, $branchcode, $branchname,
1466 $branchprinter, $emailaddress
1470 "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=?"
1472 $sth->execute($userid);
1474 $borrowernumber, $firstname, $surname,
1475 $userflags, $branchcode, $branchname,
1476 $branchprinter, $emailaddress
1477 ) = $sth->fetchrow if ( $sth->rows );
1479 unless ( $sth->rows ) {
1480 my $sth = $dbh->prepare(
1481 "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=?"
1483 $sth->execute($cardnumber);
1485 $borrowernumber, $firstname, $surname,
1486 $userflags, $branchcode, $branchname,
1487 $branchprinter, $emailaddress
1488 ) = $sth->fetchrow if ( $sth->rows );
1490 unless ( $sth->rows ) {
1491 $sth->execute($userid);
1493 $borrowernumber, $firstname, $surname, $userflags,
1494 $branchcode, $branchname, $branchprinter, $emailaddress
1495 ) = $sth->fetchrow if ( $sth->rows );
1499 my $ip = $ENV{'REMOTE_ADDR'};
1501 # if they specify at login, use that
1502 if ( $query->param('branch') ) {
1503 $branchcode = $query->param('branch');
1504 my $library = Koha::Libraries->find($branchcode);
1505 $branchname = $library? $library->branchname: '';
1507 my $branches = { map { $_->branchcode => $_->unblessed } Koha::Libraries->search };
1508 foreach my $br ( keys %$branches ) {
1510 # now we work with the treatment of ip
1511 my $domain = $branches->{$br}->{'branchip'};
1512 if ( $domain && $ip =~ /^$domain/ ) {
1513 $branchcode = $branches->{$br}->{'branchcode'};
1515 # new op dev : add the branchprinter and branchname in the cookie
1516 $branchprinter = $branches->{$br}->{'branchprinter'};
1517 $branchname = $branches->{$br}->{'branchname'};
1520 $session->param( 'number', $borrowernumber );
1521 $session->param( 'id', $userid );
1522 $session->param( 'cardnumber', $cardnumber );
1523 $session->param( 'firstname', $firstname );
1524 $session->param( 'surname', $surname );
1525 $session->param( 'branch', $branchcode );
1526 $session->param( 'branchname', $branchname );
1527 $session->param( 'flags', $userflags );
1528 $session->param( 'emailaddress', $emailaddress );
1529 $session->param( 'ip', $session->remote_addr() );
1530 $session->param( 'lasttime', time() );
1531 } elsif ( $return == 2 ) {
1533 #We suppose the user is the superlibrarian
1534 $session->param( 'number', 0 );
1535 $session->param( 'id', C4::Context->config('user') );
1536 $session->param( 'cardnumber', C4::Context->config('user') );
1537 $session->param( 'firstname', C4::Context->config('user') );
1538 $session->param( 'surname', C4::Context->config('user') );
1539 $session->param( 'branch', 'NO_LIBRARY_SET' );
1540 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1541 $session->param( 'flags', 1 );
1542 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1543 $session->param( 'ip', $session->remote_addr() );
1544 $session->param( 'lasttime', time() );
1546 C4::Context->set_userenv(
1547 $session->param('number'), $session->param('id'),
1548 $session->param('cardnumber'), $session->param('firstname'),
1549 $session->param('surname'), $session->param('branch'),
1550 $session->param('branchname'), $session->param('flags'),
1551 $session->param('emailaddress'), $session->param('branchprinter')
1553 return ( "ok", $cookie, $sessionID );
1555 return ( "failed", undef, undef );
1560 =head2 check_cookie_auth
1562 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1564 Given a CGISESSID cookie set during a previous login to Koha, determine
1565 if the user has the privileges specified by C<$userflags>.
1567 C<check_cookie_auth> is meant for authenticating special services
1568 such as tools/upload-file.pl that are invoked by other pages that
1569 have been authenticated in the usual way.
1571 Possible return values in C<$status> are:
1575 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1577 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1579 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1581 =item "expired -- session cookie has expired; API user should resubmit userid and password
1587 sub check_cookie_auth {
1589 my $flagsrequired = shift;
1592 my $remote_addr = $params->{remote_addr} || $ENV{REMOTE_ADDR};
1593 my $dbh = C4::Context->dbh;
1594 my $timeout = _timeout_syspref();
1596 unless ( C4::Context->preference('Version') ) {
1598 # database has not been installed yet
1599 return ( "maintenance", undef );
1601 my $kohaversion = Koha::version();
1602 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1603 if ( C4::Context->preference('Version') < $kohaversion ) {
1605 # database in need of version update; assume that
1606 # no API should be called while databsae is in
1608 return ( "maintenance", undef );
1611 # FIXME -- most of what follows is a copy-and-paste
1612 # of code from checkauth. There is an obvious need
1613 # for refactoring to separate the various parts of
1614 # the authentication code, but as of 2007-11-23 this
1615 # is deferred so as to not introduce bugs into the
1616 # regular authentication code for Koha 3.0.
1618 # see if we have a valid session cookie already
1619 # however, if a userid parameter is present (i.e., from
1620 # a form submission, assume that any current cookie
1622 unless ( defined $cookie and $cookie ) {
1623 return ( "failed", undef );
1625 my $sessionID = $cookie;
1626 my $session = get_session($sessionID);
1627 C4::Context->_new_userenv($sessionID);
1629 C4::Context->set_userenv(
1630 $session->param('number'), $session->param('id'),
1631 $session->param('cardnumber'), $session->param('firstname'),
1632 $session->param('surname'), $session->param('branch'),
1633 $session->param('branchname'), $session->param('flags'),
1634 $session->param('emailaddress'), $session->param('branchprinter')
1637 my $ip = $session->param('ip');
1638 my $lasttime = $session->param('lasttime');
1639 my $userid = $session->param('id');
1640 if ( $lasttime < time() - $timeout ) {
1645 C4::Context->_unset_userenv($sessionID);
1648 return ("expired", undef);
1649 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $remote_addr ) {
1651 # IP address changed
1654 C4::Context->_unset_userenv($sessionID);
1657 return ( "expired", undef );
1659 $session->param( 'lasttime', time() );
1660 my $flags = haspermission( $userid, $flagsrequired );
1662 return ( "ok", $sessionID );
1666 C4::Context->_unset_userenv($sessionID);
1669 return ( "failed", undef );
1673 return ( "expired", undef );
1680 my $session = get_session($sessionID);
1682 Given a session ID, retrieve the CGI::Session object used to store
1683 the session's state. The session object can be used to store
1684 data that needs to be accessed by different scripts during a
1687 If the C<$sessionID> parameter is an empty string, a new session
1693 my $sessionID = shift;
1694 my $storage_method = C4::Context->preference('SessionStorage');
1695 my $dbh = C4::Context->dbh;
1697 if ( $storage_method eq 'mysql' ) {
1698 $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1700 elsif ( $storage_method eq 'Pg' ) {
1701 $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1703 elsif ( $storage_method eq 'memcached' && Koha::Caches->get_instance->memcached_cache ) {
1704 my $memcached = Koha::Caches->get_instance()->memcached_cache;
1705 $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => $memcached } );
1708 # catch all defaults to tmp should work on all systems
1709 my $dir = File::Spec->tmpdir;
1710 my $instance = C4::Context->config( 'database' ); #actually for packages not exactly the instance name, but generally safer to leave it as it is
1711 $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => "$dir/cgisess_$instance" } );
1717 # FIXME no_set_userenv may be replaced with force_branchcode_for_userenv
1718 # (or something similar)
1719 # Currently it's only passed from C4::SIP::ILS::Patron::check_password, but
1720 # not having a userenv defined could cause a crash.
1722 my ( $dbh, $userid, $password, $query, $type, $no_set_userenv ) = @_;
1723 $type = 'opac' unless $type;
1725 $debug and print STDERR "## checkpw - checking LDAP\n";
1726 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1727 return 0 if $retval == -1; # Incorrect password for LDAP login attempt
1728 ($retval) and return ( $retval, $retcard, $retuserid );
1731 if ( $cas && $query && $query->param('ticket') ) {
1732 $debug and print STDERR "## checkpw - checking CAS\n";
1734 # In case of a CAS authentication, we use the ticket instead of the password
1735 my $ticket = $query->param('ticket');
1736 $query->delete('ticket'); # remove ticket to come back to original URL
1737 my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1738 ($retval) and return ( $retval, $retcard, $retuserid );
1742 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1743 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1745 if ( $shib && $shib_login && !$password ) {
1747 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1749 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1750 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1751 # shibboleth-authenticated user
1753 # Then, we check if it matches a valid koha user
1755 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1756 ($retval) and return ( $retval, $retcard, $retuserid );
1762 return checkpw_internal( $dbh, $userid, $password, $no_set_userenv);
1765 sub checkpw_internal {
1766 my ( $dbh, $userid, $password, $no_set_userenv ) = @_;
1768 $password = Encode::encode( 'UTF-8', $password )
1769 if Encode::is_utf8($password);
1771 if ( $userid && $userid eq C4::Context->config('user') ) {
1772 if ( $password && $password eq C4::Context->config('pass') ) {
1774 # Koha superuser account
1775 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1785 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1787 $sth->execute($userid);
1789 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1790 $surname, $branchcode, $branchname, $flags )
1793 if ( checkpw_hash( $password, $stored_hash ) ) {
1795 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1796 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1797 return 1, $cardnumber, $userid;
1802 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1804 $sth->execute($userid);
1806 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1807 $surname, $branchcode, $branchname, $flags )
1810 if ( checkpw_hash( $password, $stored_hash ) ) {
1812 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1813 $firstname, $surname, $branchcode, $branchname, $flags ) unless $no_set_userenv;
1814 return 1, $cardnumber, $userid;
1817 if ( $userid && $userid eq 'demo'
1818 && "$password" eq 'demo'
1819 && C4::Context->config('demo') )
1822 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1823 # some features won't be effective : modify systempref, modify MARC structure,
1830 my ( $password, $stored_hash ) = @_;
1832 return if $stored_hash eq '!';
1834 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1836 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1837 $hash = hash_password( $password, $stored_hash );
1839 $hash = md5_base64($password);
1841 return $hash eq $stored_hash;
1846 my $authflags = getuserflags($flags, $userid, [$dbh]);
1848 Translates integer flags into permissions strings hash.
1850 C<$flags> is the integer userflags value ( borrowers.userflags )
1851 C<$userid> is the members.userid, used for building subpermissions
1852 C<$authflags> is a hashref of permissions
1859 my $dbh = @_ ? shift : C4::Context->dbh;
1862 # I don't want to do this, but if someone logs in as the database
1863 # user, it would be preferable not to spam them to death with
1864 # numeric warnings. So, we make $flags numeric.
1865 no warnings 'numeric';
1868 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1871 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1872 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1873 $userflags->{$flag} = 1;
1876 $userflags->{$flag} = 0;
1880 # get subpermissions and merge with top-level permissions
1881 my $user_subperms = get_user_subpermissions($userid);
1882 foreach my $module ( keys %$user_subperms ) {
1883 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1884 $userflags->{$module} = $user_subperms->{$module};
1890 =head2 get_user_subpermissions
1892 $user_perm_hashref = get_user_subpermissions($userid);
1894 Given the userid (note, not the borrowernumber) of a staff user,
1895 return a hashref of hashrefs of the specific subpermissions
1896 accorded to the user. An example return is
1900 export_catalog => 1,
1901 import_patrons => 1,
1905 The top-level hash-key is a module or function code from
1906 userflags.flag, while the second-level key is a code
1909 The results of this function do not give a complete picture
1910 of the functions that a staff user can access; it is also
1911 necessary to check borrowers.flags.
1915 sub get_user_subpermissions {
1918 my $dbh = C4::Context->dbh;
1919 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1920 FROM user_permissions
1921 JOIN permissions USING (module_bit, code)
1922 JOIN userflags ON (module_bit = bit)
1923 JOIN borrowers USING (borrowernumber)
1924 WHERE userid = ?" );
1925 $sth->execute($userid);
1927 my $user_perms = {};
1928 while ( my $perm = $sth->fetchrow_hashref ) {
1929 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1934 =head2 get_all_subpermissions
1936 my $perm_hashref = get_all_subpermissions();
1938 Returns a hashref of hashrefs defining all specific
1939 permissions currently defined. The return value
1940 has the same structure as that of C<get_user_subpermissions>,
1941 except that the innermost hash value is the description
1942 of the subpermission.
1946 sub get_all_subpermissions {
1947 my $dbh = C4::Context->dbh;
1948 my $sth = $dbh->prepare( "SELECT flag, code
1950 JOIN userflags ON (module_bit = bit)" );
1954 while ( my $perm = $sth->fetchrow_hashref ) {
1955 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1960 =head2 haspermission
1962 $flags = ($userid, $flagsrequired);
1964 C<$userid> the userid of the member
1965 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1967 Returns member's flags or 0 if a permission is not met.
1972 my ( $userid, $flagsrequired ) = @_;
1973 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1974 $sth->execute($userid);
1975 my $row = $sth->fetchrow();
1976 my $flags = getuserflags( $row, $userid );
1977 if ( $userid eq C4::Context->config('user') ) {
1979 # Super User Account from /etc/koha.conf
1980 $flags->{'superlibrarian'} = 1;
1982 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1984 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1985 $flags->{'superlibrarian'} = 1;
1988 return $flags if $flags->{superlibrarian};
1990 foreach my $module ( keys %$flagsrequired ) {
1991 my $subperm = $flagsrequired->{$module};
1992 if ( $subperm eq '*' ) {
1993 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
1996 ( defined $flags->{$module} and
1997 $flags->{$module} == 1 )
1999 ( ref( $flags->{$module} ) and
2000 exists $flags->{$module}->{$subperm} and
2001 $flags->{$module}->{$subperm} == 1 )
2007 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2010 sub getborrowernumber {
2012 my $userenv = C4::Context->userenv;
2013 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2014 return $userenv->{number};
2016 my $dbh = C4::Context->dbh;
2017 for my $field ( 'userid', 'cardnumber' ) {
2019 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2020 $sth->execute($userid);
2022 my ($bnumber) = $sth->fetchrow;
2029 END { } # module clean-up code here (global destructor)
2039 Crypt::Eksblowfish::Bcrypt(3)