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);
23 use JSON qw/encode_json/;
29 use C4::Templates; # to get the template
31 use C4::Branch; # GetBranches
32 use C4::Search::History;
34 use Koha::AuthUtils qw(hash_password);
35 use POSIX qw/strftime/;
36 use List::MoreUtils qw/ any /;
37 use Encode qw( encode is_utf8);
40 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap $cas $caslogout $shib $shib_login);
43 sub psgi_env { any { /^psgi\./ } keys %ENV }
46 if (psgi_env) { die 'psgi:exit' }
49 $VERSION = 3.07.00.049; # set version for version checking
53 @EXPORT = qw(&checkauth &get_template_and_user &haspermission &get_user_subpermissions);
54 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw &checkpw_internal &checkpw_hash
55 &get_all_subpermissions &get_user_subpermissions
57 %EXPORT_TAGS = ( EditPermissions => [qw(get_all_subpermissions get_user_subpermissions)] );
58 $ldap = C4::Context->config('useldapserver') || 0;
59 $cas = C4::Context->preference('casAuthentication');
60 $shib = C4::Context->config('useshibboleth') || 0;
61 $caslogout = C4::Context->preference('casLogout');
62 require C4::Auth_with_cas; # no import
65 require C4::Auth_with_ldap;
66 import C4::Auth_with_ldap qw(checkpw_ldap);
69 require C4::Auth_with_shibboleth;
70 import C4::Auth_with_shibboleth
71 qw(shib_ok checkpw_shib logout_shib login_shib_url get_login_shib);
73 # Check for good config
76 # Get shibboleth login attribute
77 $shib_login = get_login_shib();
80 # Bad config, disable shibboleth
86 import C4::Auth_with_cas qw(check_api_auth_cas checkpw_cas login_cas logout_cas login_cas_url);
93 C4::Auth - Authenticates Koha users
103 my ($template, $borrowernumber, $cookie)
104 = get_template_and_user(
106 template_name => "opac-main.tt",
109 authnotrequired => 0,
110 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
114 output_html_with_http_headers $query, $cookie, $template->output;
118 The main function of this module is to provide
119 authentification. However the get_template_and_user function has
120 been provided so that a users login information is passed along
121 automatically. This gets loaded into the template.
125 =head2 get_template_and_user
127 my ($template, $borrowernumber, $cookie)
128 = get_template_and_user(
130 template_name => "opac-main.tt",
133 authnotrequired => 0,
134 flagsrequired => { catalogue => '*', tools => 'import_patrons' },
138 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
139 to C<&checkauth> (in this module) to perform authentification.
140 See C<&checkauth> for an explanation of these parameters.
142 The C<template_name> is then used to find the correct template for
143 the page. The authenticated users details are loaded onto the
144 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
145 C<sessionID> is passed to the template. This can be used in templates
146 if cookies are disabled. It needs to be put as and input to every
149 More information on the C<gettemplate> sub can be found in the
154 sub get_template_and_user {
157 my ( $user, $cookie, $sessionID, $flags );
159 C4::Context->interface( $in->{type} );
161 my $safe_chars = 'a-zA-Z0-9_\-\/';
162 die "bad template path" unless $in->{'template_name'} =~ m/^[$safe_chars]+\.tt$/ig; #sanitize input
164 $in->{'authnotrequired'} ||= 0;
165 my $template = C4::Templates::gettemplate(
166 $in->{'template_name'},
172 if ( $in->{'template_name'} !~ m/maintenance/ ) {
173 ( $user, $cookie, $sessionID, $flags ) = checkauth(
175 $in->{'authnotrequired'},
176 $in->{'flagsrequired'},
182 # 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
183 if ( $in->{type} eq 'opac' and $in->{template_name} !~ m|sco/| ) {
184 if ( C4::Context->preference('AutoSelfCheckID') && $user eq C4::Context->preference('AutoSelfCheckID') ) {
185 $template = C4::Templates::gettemplate( 'opac-auth.tt', 'opac', $in->{query} );
186 my $cookie = $in->{query}->cookie(
187 -name => 'CGISESSID',
193 $template->param( loginprompt => 1 );
194 print $in->{query}->header(
195 -type => 'text/html',
208 # It's possible for $user to be the borrowernumber if they don't have a
209 # userid defined (and are logging in through some other method, such
210 # as SSL certs against an email address)
212 $borrowernumber = getborrowernumber($user) if defined($user);
213 if ( !defined($borrowernumber) && defined($user) ) {
214 $borrower = C4::Members::GetMember( borrowernumber => $user );
216 $borrowernumber = $user;
218 # A bit of a hack, but I don't know there's a nicer way
220 $user = $borrower->{firstname} . ' ' . $borrower->{surname};
223 $borrower = C4::Members::GetMember( borrowernumber => $borrowernumber );
227 $template->param( loggedinusername => $user );
228 $template->param( loggedinusernumber => $borrowernumber );
229 $template->param( sessionID => $sessionID );
231 if ( $in->{'type'} eq 'opac' ) {
232 require Koha::Virtualshelves;
233 my $some_private_shelves = Koha::Virtualshelves->get_some_shelves(
235 borrowernumber => $borrowernumber,
239 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
245 some_private_shelves => $some_private_shelves,
246 some_public_shelves => $some_public_shelves,
250 $template->param( "USER_INFO" => $borrower );
252 my $all_perms = get_all_subpermissions();
254 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
255 editcatalogue updatecharges management tools editauthorities serials reports acquisition);
257 # We are going to use the $flags returned by checkauth
258 # to create the template's parameters that will indicate
259 # which menus the user can access.
260 if ( $flags && $flags->{superlibrarian} == 1 ) {
261 $template->param( CAN_user_circulate => 1 );
262 $template->param( CAN_user_catalogue => 1 );
263 $template->param( CAN_user_parameters => 1 );
264 $template->param( CAN_user_borrowers => 1 );
265 $template->param( CAN_user_permissions => 1 );
266 $template->param( CAN_user_reserveforothers => 1 );
267 $template->param( CAN_user_editcatalogue => 1 );
268 $template->param( CAN_user_updatecharges => 1 );
269 $template->param( CAN_user_acquisition => 1 );
270 $template->param( CAN_user_management => 1 );
271 $template->param( CAN_user_tools => 1 );
272 $template->param( CAN_user_editauthorities => 1 );
273 $template->param( CAN_user_serials => 1 );
274 $template->param( CAN_user_reports => 1 );
275 $template->param( CAN_user_staffaccess => 1 );
276 $template->param( CAN_user_plugins => 1 );
277 $template->param( CAN_user_coursereserves => 1 );
278 foreach my $module ( keys %$all_perms ) {
280 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
281 $template->param( "CAN_user_${module}_${subperm}" => 1 );
287 foreach my $module ( keys %$all_perms ) {
288 if ( defined($flags->{$module}) && $flags->{$module} == 1 ) {
289 foreach my $subperm ( keys %{ $all_perms->{$module} } ) {
290 $template->param( "CAN_user_${module}_${subperm}" => 1 );
292 } elsif ( ref( $flags->{$module} ) ) {
293 foreach my $subperm ( keys %{ $flags->{$module} } ) {
294 $template->param( "CAN_user_${module}_${subperm}" => 1 );
301 foreach my $module ( keys %$flags ) {
302 if ( $flags->{$module} == 1 or ref( $flags->{$module} ) ) {
303 $template->param( "CAN_user_$module" => 1 );
304 if ( $module eq "parameters" ) {
305 $template->param( CAN_user_management => 1 );
311 # Logged-in opac search history
312 # If the requested template is an opac one and opac search history is enabled
313 if ( $in->{type} eq 'opac' && C4::Context->preference('EnableOpacSearchHistory') ) {
314 my $dbh = C4::Context->dbh;
315 my $query = "SELECT COUNT(*) FROM search_history WHERE userid=?";
316 my $sth = $dbh->prepare($query);
317 $sth->execute($borrowernumber);
319 # If at least one search has already been performed
320 if ( $sth->fetchrow_array > 0 ) {
322 # We show the link in opac
323 $template->param( EnableOpacSearchHistory => 1 );
326 # And if there are searches performed when the user was not logged in,
327 # we add them to the logged-in search history
328 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
329 if (@recentSearches) {
330 my $dbh = C4::Context->dbh;
332 INSERT INTO search_history(userid, sessionid, query_desc, query_cgi, type, total, time )
333 VALUES (?, ?, ?, ?, ?, ?, ?)
336 my $sth = $dbh->prepare($query);
337 $sth->execute( $borrowernumber,
338 $in->{query}->cookie("CGISESSID"),
341 $_->{type} || 'biblio',
344 ) foreach @recentSearches;
346 # clear out the search history from the session now that
347 # we've saved it to the database
348 C4::Search::History::set_to_session( { cgi => $in->{'query'}, search_history => [] } );
350 } elsif ( $in->{type} eq 'intranet' and C4::Context->preference('EnableSearchHistory') ) {
351 $template->param( EnableSearchHistory => 1 );
354 else { # if this is an anonymous session, setup to display public lists...
356 # If shibboleth is enabled, and we're in an anonymous session, we should allow
357 # the user to attempt login via shibboleth.
359 $template->param( shibbolethAuthentication => $shib,
360 shibbolethLoginUrl => login_shib_url( $in->{'query'} ),
363 # If shibboleth is enabled and we have a shibboleth login attribute,
364 # but we are in an anonymous session, then we clearly have an invalid
365 # shibboleth koha account.
367 $template->param( invalidShibLogin => '1' );
371 $template->param( sessionID => $sessionID );
373 if ( $in->{'type'} eq 'opac' ){
374 require Koha::Virtualshelves;
375 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
381 some_public_shelves => $some_public_shelves,
386 # Anonymous opac search history
387 # If opac search history is enabled and at least one search has already been performed
388 if ( C4::Context->preference('EnableOpacSearchHistory') ) {
389 my @recentSearches = C4::Search::History::get_from_session( { cgi => $in->{'query'} } );
390 if (@recentSearches) {
391 $template->param( EnableOpacSearchHistory => 1 );
395 if ( C4::Context->preference('dateformat') ) {
396 $template->param( dateformat => C4::Context->preference('dateformat') );
399 $template->param(auth_forwarded_hash => $in->{'query'}->param('auth_forwarded_hash'));
401 # these template parameters are set the same regardless of $in->{'type'}
403 # Set the using_https variable for templates
404 # FIXME Under Plack the CGI->https method always returns 'OFF'
405 my $https = $in->{query}->https();
406 my $using_https = ( defined $https and $https ne 'OFF' ) ? 1 : 0;
409 "BiblioDefaultView" . C4::Context->preference("BiblioDefaultView") => 1,
410 EnhancedMessagingPreferences => C4::Context->preference('EnhancedMessagingPreferences'),
411 GoogleJackets => C4::Context->preference("GoogleJackets"),
412 OpenLibraryCovers => C4::Context->preference("OpenLibraryCovers"),
413 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
414 LoginBranchcode => ( C4::Context->userenv ? C4::Context->userenv->{"branch"} : undef ),
415 LoginFirstname => ( C4::Context->userenv ? C4::Context->userenv->{"firstname"} : "Bel" ),
416 LoginSurname => C4::Context->userenv ? C4::Context->userenv->{"surname"} : "Inconnu",
417 emailaddress => C4::Context->userenv ? C4::Context->userenv->{"emailaddress"} : undef,
418 loggedinpersona => C4::Context->userenv ? C4::Context->userenv->{"persona"} : undef,
419 TagsEnabled => C4::Context->preference("TagsEnabled"),
420 hide_marc => C4::Context->preference("hide_marc"),
421 item_level_itypes => C4::Context->preference('item-level_itypes'),
422 patronimages => C4::Context->preference("patronimages"),
423 singleBranchMode => C4::Context->preference("singleBranchMode"),
424 XSLTDetailsDisplay => C4::Context->preference("XSLTDetailsDisplay"),
425 XSLTResultsDisplay => C4::Context->preference("XSLTResultsDisplay"),
426 using_https => $using_https,
427 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
428 marcflavour => C4::Context->preference("marcflavour"),
429 persona => C4::Context->preference("persona"),
430 OPACBaseURL => C4::Context->preference('OPACBaseURL'),
432 if ( $in->{'type'} eq "intranet" ) {
434 AmazonCoverImages => C4::Context->preference("AmazonCoverImages"),
435 AutoLocation => C4::Context->preference("AutoLocation"),
436 "BiblioDefaultView" . C4::Context->preference("IntranetBiblioDefaultView") => 1,
437 CircAutocompl => C4::Context->preference("CircAutocompl"),
438 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
439 IndependentBranches => C4::Context->preference("IndependentBranches"),
440 IntranetNav => C4::Context->preference("IntranetNav"),
441 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
442 LibraryName => C4::Context->preference("LibraryName"),
443 LoginBranchname => ( C4::Context->userenv ? C4::Context->userenv->{"branchname"} : undef ),
444 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
445 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
446 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
447 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
448 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
449 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
450 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
451 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
452 intranetbookbag => C4::Context->preference("intranetbookbag"),
453 suggestion => C4::Context->preference("suggestion"),
454 virtualshelves => C4::Context->preference("virtualshelves"),
455 StaffSerialIssueDisplayCount => C4::Context->preference("StaffSerialIssueDisplayCount"),
456 EasyAnalyticalRecords => C4::Context->preference('EasyAnalyticalRecords'),
457 LocalCoverImages => C4::Context->preference('LocalCoverImages'),
458 OPACLocalCoverImages => C4::Context->preference('OPACLocalCoverImages'),
459 AllowMultipleCovers => C4::Context->preference('AllowMultipleCovers'),
460 EnableBorrowerFiles => C4::Context->preference('EnableBorrowerFiles'),
461 UseKohaPlugins => C4::Context->preference('UseKohaPlugins'),
462 UseCourseReserves => C4::Context->preference("UseCourseReserves"),
463 useDischarge => C4::Context->preference('useDischarge'),
467 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
469 #TODO : replace LibraryName syspref with 'system name', and remove this html processing
470 my $LibraryNameTitle = C4::Context->preference("LibraryName");
471 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
472 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
474 # clean up the busc param in the session
475 # if the page is not opac-detail and not the "add to list" page
476 # and not the "edit comments" page
477 if ( C4::Context->preference("OpacBrowseResults")
478 && $in->{'template_name'} =~ /opac-(.+)\.(?:tt|tmpl)$/ ) {
480 unless ( $pagename =~ /^(?:MARC|ISBD)?detail$/
481 or $pagename =~ /^addbybiblionumber$/
482 or $pagename =~ /^review$/ ) {
483 my $sessionSearch = get_session( $sessionID || $in->{'query'}->cookie("CGISESSID") );
484 $sessionSearch->clear( ["busc"] ) if ( $sessionSearch->param("busc") );
488 # variables passed from CGI: opac_css_override and opac_search_limits.
489 my $opac_search_limit = $ENV{'OPAC_SEARCH_LIMIT'};
490 my $opac_limit_override = $ENV{'OPAC_LIMIT_OVERRIDE'};
493 ( $opac_limit_override && $opac_search_limit && $opac_search_limit =~ /branch:(\w+)/ ) ||
494 ( $in->{'query'}->param('limit') && $in->{'query'}->param('limit') =~ /branch:(\w+)/ ) ||
495 ( $in->{'query'}->param('multibranchlimit') && $in->{'query'}->param('multibranchlimit') =~ /multibranchlimit-(\w+)/ )
497 $opac_name = $1; # opac_search_limit is a branch, so we use it.
498 } elsif ( $in->{'query'}->param('multibranchlimit') ) {
499 $opac_name = $in->{'query'}->param('multibranchlimit');
500 } elsif ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv && C4::Context->userenv->{'branch'} ) {
501 $opac_name = C4::Context->userenv->{'branch'};
505 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
506 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
507 AuthorisedValueImages => C4::Context->preference("AuthorisedValueImages"),
508 BranchesLoop => GetBranchesLoop($opac_name),
509 BranchCategoriesLoop => GetBranchCategories( 'searchdomain', 1, $opac_name ),
510 LibraryName => "" . C4::Context->preference("LibraryName"),
511 LibraryNameTitle => "" . $LibraryNameTitle,
512 LoginBranchname => C4::Context->userenv ? C4::Context->userenv->{"branchname"} : "",
513 OPACAmazonCoverImages => C4::Context->preference("OPACAmazonCoverImages"),
514 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
515 OpacHighlightedWords => C4::Context->preference("OpacHighlightedWords"),
516 OPACShelfBrowser => "" . C4::Context->preference("OPACShelfBrowser"),
517 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
518 OPACUserCSS => "" . C4::Context->preference("OPACUserCSS"),
519 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
520 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
521 opac_search_limit => $opac_search_limit,
522 opac_limit_override => $opac_limit_override,
523 OpacBrowser => C4::Context->preference("OpacBrowser"),
524 OpacCloud => C4::Context->preference("OpacCloud"),
525 OpacKohaUrl => C4::Context->preference("OpacKohaUrl"),
526 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
527 OpacNav => "" . C4::Context->preference("OpacNav"),
528 OpacNavRight => "" . C4::Context->preference("OpacNavRight"),
529 OpacNavBottom => "" . C4::Context->preference("OpacNavBottom"),
530 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
531 OPACPatronDetails => C4::Context->preference("OPACPatronDetails"),
532 OPACPrivacy => C4::Context->preference("OPACPrivacy"),
533 OPACFinesTab => C4::Context->preference("OPACFinesTab"),
534 OpacTopissue => C4::Context->preference("OpacTopissue"),
535 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
536 'Version' => C4::Context->preference('Version'),
537 hidelostitems => C4::Context->preference("hidelostitems"),
538 mylibraryfirst => ( C4::Context->preference("SearchMyLibraryFirst") && C4::Context->userenv ) ? C4::Context->userenv->{'branch'} : '',
539 opaclayoutstylesheet => "" . C4::Context->preference("opaclayoutstylesheet"),
540 opacbookbag => "" . C4::Context->preference("opacbookbag"),
541 opaccredits => "" . C4::Context->preference("opaccredits"),
542 OpacFavicon => C4::Context->preference("OpacFavicon"),
543 opacheader => "" . C4::Context->preference("opacheader"),
544 opaclanguagesdisplay => "" . C4::Context->preference("opaclanguagesdisplay"),
545 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
546 OPACUserJS => C4::Context->preference("OPACUserJS"),
547 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
548 ShowReviewer => C4::Context->preference("ShowReviewer"),
549 ShowReviewerPhoto => C4::Context->preference("ShowReviewerPhoto"),
550 suggestion => "" . C4::Context->preference("suggestion"),
551 virtualshelves => "" . C4::Context->preference("virtualshelves"),
552 OPACSerialIssueDisplayCount => C4::Context->preference("OPACSerialIssueDisplayCount"),
553 OPACXSLTDetailsDisplay => C4::Context->preference("OPACXSLTDetailsDisplay"),
554 OPACXSLTResultsDisplay => C4::Context->preference("OPACXSLTResultsDisplay"),
555 SyndeticsClientCode => C4::Context->preference("SyndeticsClientCode"),
556 SyndeticsEnabled => C4::Context->preference("SyndeticsEnabled"),
557 SyndeticsCoverImages => C4::Context->preference("SyndeticsCoverImages"),
558 SyndeticsTOC => C4::Context->preference("SyndeticsTOC"),
559 SyndeticsSummary => C4::Context->preference("SyndeticsSummary"),
560 SyndeticsEditions => C4::Context->preference("SyndeticsEditions"),
561 SyndeticsExcerpt => C4::Context->preference("SyndeticsExcerpt"),
562 SyndeticsReviews => C4::Context->preference("SyndeticsReviews"),
563 SyndeticsAuthorNotes => C4::Context->preference("SyndeticsAuthorNotes"),
564 SyndeticsAwards => C4::Context->preference("SyndeticsAwards"),
565 SyndeticsSeries => C4::Context->preference("SyndeticsSeries"),
566 SyndeticsCoverImageSize => C4::Context->preference("SyndeticsCoverImageSize"),
567 OPACLocalCoverImages => C4::Context->preference("OPACLocalCoverImages"),
568 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
569 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
570 useDischarge => C4::Context->preference('useDischarge'),
573 $template->param( OpacPublic => '1' ) if ( $user || C4::Context->preference("OpacPublic") );
576 # Check if we were asked using parameters to force a specific language
577 if ( defined $in->{'query'}->param('language') ) {
579 # Extract the language, let C4::Languages::getlanguage choose
581 my $language = C4::Languages::getlanguage( $in->{'query'} );
582 my $languagecookie = C4::Templates::getlanguagecookie( $in->{'query'}, $language );
583 if ( ref $cookie eq 'ARRAY' ) {
584 push @{$cookie}, $languagecookie;
586 $cookie = [ $cookie, $languagecookie ];
590 return ( $template, $borrowernumber, $cookie, $flags );
595 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
597 Verifies that the user is authorized to run this script. If
598 the user is authorized, a (userid, cookie, session-id, flags)
599 quadruple is returned. If the user is not authorized but does
600 not have the required privilege (see $flagsrequired below), it
601 displays an error page and exits. Otherwise, it displays the
602 login page and exits.
604 Note that C<&checkauth> will return if and only if the user
605 is authorized, so it should be called early on, before any
606 unfinished operations (e.g., if you've opened a file, then
607 C<&checkauth> won't close it for you).
609 C<$query> is the CGI object for the script calling C<&checkauth>.
611 The C<$noauth> argument is optional. If it is set, then no
612 authorization is required for the script.
614 C<&checkauth> fetches user and session information from C<$query> and
615 ensures that the user is authorized to run scripts that require
618 The C<$flagsrequired> argument specifies the required privileges
619 the user must have if the username and password are correct.
620 It should be specified as a reference-to-hash; keys in the hash
621 should be the "flags" for the user, as specified in the Members
622 intranet module. Any key specified must correspond to a "flag"
623 in the userflags table. E.g., { circulate => 1 } would specify
624 that the user must have the "circulate" privilege in order to
625 proceed. To make sure that access control is correct, the
626 C<$flagsrequired> parameter must be specified correctly.
628 Koha also has a concept of sub-permissions, also known as
629 granular permissions. This makes the value of each key
630 in the C<flagsrequired> hash take on an additional
635 The user must have access to all subfunctions of the module
636 specified by the hash key.
640 The user must have access to at least one subfunction of the module
641 specified by the hash key.
643 specific permission, e.g., 'export_catalog'
645 The user must have access to the specific subfunction list, which
646 must correspond to a row in the permissions table.
648 The C<$type> argument specifies whether the template should be
649 retrieved from the opac or intranet directory tree. "opac" is
650 assumed if it is not specified; however, if C<$type> is specified,
651 "intranet" is assumed if it is not "opac".
653 If C<$query> does not have a valid session ID associated with it
654 (i.e., the user has not logged in) or if the session has expired,
655 C<&checkauth> presents the user with a login page (from the point of
656 view of the original script, C<&checkauth> does not return). Once the
657 user has authenticated, C<&checkauth> restarts the original script
658 (this time, C<&checkauth> returns).
660 The login page is provided using a HTML::Template, which is set in the
661 systempreferences table or at the top of this file. The variable C<$type>
662 selects which template to use, either the opac or the intranet
663 authentification template.
665 C<&checkauth> returns a user ID, a cookie, and a session ID. The
666 cookie should be sent back to the browser; it verifies that the user
676 # If version syspref is unavailable, it means Koha is being installed,
677 # and so we must redirect to OPAC maintenance page or to the WebInstaller
678 # also, if OpacMaintenance is ON, OPAC should redirect to maintenance
679 if ( C4::Context->preference('OpacMaintenance') && $type eq 'opac' ) {
680 warn "OPAC Install required, redirecting to maintenance";
681 print $query->redirect("/cgi-bin/koha/maintenance.pl");
684 unless ( $version = C4::Context->preference('Version') ) { # assignment, not comparison
685 if ( $type ne 'opac' ) {
686 warn "Install required, redirecting to Installer";
687 print $query->redirect("/cgi-bin/koha/installer/install.pl");
689 warn "OPAC Install required, redirecting to maintenance";
690 print $query->redirect("/cgi-bin/koha/maintenance.pl");
695 # check that database and koha version are the same
696 # there is no DB version, it's a fresh install,
697 # go to web installer
698 # there is a DB version, compare it to the code version
699 my $kohaversion = Koha::version();
701 # remove the 3 last . to have a Perl number
702 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
703 $debug and print STDERR "kohaversion : $kohaversion\n";
704 if ( $version < $kohaversion ) {
705 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
706 if ( $type ne 'opac' ) {
707 warn sprintf( $warning, 'Installer' );
708 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=1&op=updatestructure");
710 warn sprintf( "OPAC: " . $warning, 'maintenance' );
711 print $query->redirect("/cgi-bin/koha/maintenance.pl");
719 open my $fh, '>>', "/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
720 printf $fh join( "\n", @_ );
724 sub _timeout_syspref {
725 my $timeout = C4::Context->preference('timeout') || 600;
727 # value in days, convert in seconds
728 if ( $timeout =~ /(\d+)[dD]/ ) {
729 $timeout = $1 * 86400;
736 $debug and warn "Checking Auth";
738 # $authnotrequired will be set for scripts which will run without authentication
739 my $authnotrequired = shift;
740 my $flagsrequired = shift;
743 $type = 'opac' unless $type;
745 my $dbh = C4::Context->dbh;
746 my $timeout = _timeout_syspref();
748 _version_check( $type, $query );
753 my ( $userid, $cookie, $sessionID, $flags );
754 my $logout = $query->param('logout.x');
756 my $anon_search_history;
758 # This parameter is the name of the CAS server we want to authenticate against,
759 # when using authentication against multiple CAS servers, as configured in Auth_cas_servers.yaml
760 my $casparam = $query->param('cas');
761 my $q_userid = $query->param('userid') // '';
763 # Basic authentication is incompatible with the use of Shibboleth,
764 # as Shibboleth may return REMOTE_USER as a Shibboleth attribute,
765 # and it may not be the attribute we want to use to match the koha login.
767 # Also, do not consider an empty REMOTE_USER.
769 # Finally, after those tests, we can assume (although if it would be better with
770 # a syspref) that if we get a REMOTE_USER, that's from basic authentication,
771 # and we can affect it to $userid.
772 if ( !$shib and defined( $ENV{'REMOTE_USER'} ) and $ENV{'REMOTE_USER'} ne '' and $userid = $ENV{'REMOTE_USER'} ) {
774 # Using Basic Authentication, no cookies required
775 $cookie = $query->cookie(
776 -name => 'CGISESSID',
785 # we don't want to set a session because we are being called by a persona callback
787 elsif ( $sessionID = $query->cookie("CGISESSID") )
788 { # assignment, not comparison
789 my $session = get_session($sessionID);
790 C4::Context->_new_userenv($sessionID);
791 my ( $ip, $lasttime, $sessiontype );
794 $s_userid = $session->param('id') // '';
795 C4::Context->set_userenv(
796 $session->param('number'), $s_userid,
797 $session->param('cardnumber'), $session->param('firstname'),
798 $session->param('surname'), $session->param('branch'),
799 $session->param('branchname'), $session->param('flags'),
800 $session->param('emailaddress'), $session->param('branchprinter'),
801 $session->param('persona'), $session->param('shibboleth')
803 C4::Context::set_shelves_userenv( 'bar', $session->param('barshelves') );
804 C4::Context::set_shelves_userenv( 'pub', $session->param('pubshelves') );
805 C4::Context::set_shelves_userenv( 'tot', $session->param('totshelves') );
806 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
807 $ip = $session->param('ip');
808 $lasttime = $session->param('lasttime');
810 $sessiontype = $session->param('sessiontype') || '';
812 if ( ( $query->param('koha_login_context') && ( $q_userid ne $s_userid ) )
813 || ( $cas && $query->param('ticket') && !C4::Context->userenv->{'id'} )
814 || ( $shib && $shib_login && !$logout && !C4::Context->userenv->{'id'} )
817 #if a user enters an id ne to the id in the current session, we need to log them in...
818 #first we need to clear the anonymous session...
819 $debug and warn "query id = $q_userid but session id = $s_userid";
820 $anon_search_history = $session->param('search_history');
823 C4::Context->_unset_userenv($sessionID);
829 # voluntary logout the user
830 # check wether the user was using their shibboleth session or a local one
831 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
834 C4::Context->_unset_userenv($sessionID);
836 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
840 if ($cas and $caslogout) {
841 logout_cas($query, $type);
844 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
845 if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
847 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
851 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
854 $info{'timed_out'} = 1;
859 C4::Context->_unset_userenv($sessionID);
861 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
865 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
867 # Different ip than originally logged in from
868 $info{'oldip'} = $ip;
869 $info{'newip'} = $ENV{'REMOTE_ADDR'};
870 $info{'different_ip'} = 1;
873 C4::Context->_unset_userenv($sessionID);
875 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
880 $cookie = $query->cookie(
881 -name => 'CGISESSID',
882 -value => $session->id,
885 $session->param( 'lasttime', time() );
886 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...
887 $flags = haspermission( $userid, $flagsrequired );
891 $info{'nopermission'} = 1;
896 unless ( $userid || $sessionID ) {
898 #we initiate a session prior to checking for a username to allow for anonymous sessions...
899 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
901 # Save anonymous search history in new session so it can be retrieved
902 # by get_template_and_user to store it in user's search history after
903 # a successful login.
904 if ($anon_search_history) {
905 $session->param( 'search_history', $anon_search_history );
908 my $sessionID = $session->id;
909 C4::Context->_new_userenv($sessionID);
910 $cookie = $query->cookie(
911 -name => 'CGISESSID',
912 -value => $session->id,
916 my $pki_field = C4::Context->preference('AllowPKIAuth');
917 if ( !defined($pki_field) ) {
918 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
921 if ( ( $cas && $query->param('ticket') )
923 || ( $shib && $shib_login )
924 || $pki_field ne 'None'
927 my $password = $query->param('password');
930 my ( $return, $cardnumber );
932 # If shib is enabled and we have a shib login, does the login match a valid koha user
933 if ( $shib && $shib_login && $type eq 'opac' ) {
936 # Do not pass password here, else shib will not be checked in checkpw.
937 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, undef, $query );
938 $userid = $retuserid;
939 $shibSuccess = $return;
940 $info{'invalidShibLogin'} = 1 unless ($return);
943 # If shib login and match were successful, skip further login methods
944 unless ($shibSuccess) {
945 if ( $cas && $query->param('ticket') ) {
947 ( $return, $cardnumber, $retuserid ) =
948 checkpw( $dbh, $userid, $password, $query, $type );
949 $userid = $retuserid;
950 $info{'invalidCasLogin'} = 1 unless ($return);
954 my $value = $persona;
956 # If we're looking up the email, there's a chance that the person
957 # doesn't have a userid. So if there is none, we pass along the
958 # borrower number, and the bits of code that need to know the user
959 # ID will have to be smart enough to handle that.
961 my @users_info = C4::Members::GetBorrowersWithEmail($value);
964 # First the userid, then the borrowernum
965 $value = $users_info[0][1] || $users_info[0][0];
970 $return = $value ? 1 : 0;
975 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
976 || ( $pki_field eq 'emailAddress'
977 && $ENV{'SSL_CLIENT_S_DN_Email'} )
981 if ( $pki_field eq 'Common Name' ) {
982 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
984 elsif ( $pki_field eq 'emailAddress' ) {
985 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
987 # If we're looking up the email, there's a chance that the person
988 # doesn't have a userid. So if there is none, we pass along the
989 # borrower number, and the bits of code that need to know the user
990 # ID will have to be smart enough to handle that.
992 my @users_info = C4::Members::GetBorrowersWithEmail($value);
995 # First the userid, then the borrowernum
996 $value = $users_info[0][1] || $users_info[0][0];
1002 $return = $value ? 1 : 0;
1008 ( $return, $cardnumber, $retuserid ) =
1009 checkpw( $dbh, $userid, $password, $query, $type );
1010 $userid = $retuserid if ($retuserid);
1011 $info{'invalid_username_or_password'} = 1 unless ($return);
1015 # $return: 1 = valid user, 2 = superlibrarian
1018 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1019 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1023 $info{'nopermission'} = 1;
1024 C4::Context->_unset_userenv($sessionID);
1026 my ( $borrowernumber, $firstname, $surname, $userflags,
1027 $branchcode, $branchname, $branchprinter, $emailaddress );
1029 if ( $return == 1 ) {
1031 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1032 branches.branchname as branchname,
1033 branches.branchprinter as branchprinter,
1036 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1038 my $sth = $dbh->prepare("$select where userid=?");
1039 $sth->execute($userid);
1040 unless ( $sth->rows ) {
1041 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1042 $sth = $dbh->prepare("$select where cardnumber=?");
1043 $sth->execute($cardnumber);
1045 unless ( $sth->rows ) {
1046 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1047 $sth->execute($userid);
1048 unless ( $sth->rows ) {
1049 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1054 ( $borrowernumber, $firstname, $surname, $userflags,
1055 $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1056 $debug and print STDERR "AUTH_3 results: " .
1057 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1059 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1062 # launch a sequence to check if we have a ip for the branch, i
1063 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1065 my $ip = $ENV{'REMOTE_ADDR'};
1067 # if they specify at login, use that
1068 if ( $query->param('branch') ) {
1069 $branchcode = $query->param('branch');
1070 $branchname = GetBranchName($branchcode);
1072 my $branches = GetBranches();
1073 if ( C4::Context->boolean_preference('IndependentBranches') && C4::Context->boolean_preference('Autolocation') ) {
1075 # we have to check they are coming from the right ip range
1076 my $domain = $branches->{$branchcode}->{'branchip'};
1077 if ( $ip !~ /^$domain/ ) {
1079 $info{'wrongip'} = 1;
1084 foreach my $br ( keys %$branches ) {
1086 # now we work with the treatment of ip
1087 my $domain = $branches->{$br}->{'branchip'};
1088 if ( $domain && $ip =~ /^$domain/ ) {
1089 $branchcode = $branches->{$br}->{'branchcode'};
1091 # new op dev : add the branchprinter and branchname in the cookie
1092 $branchprinter = $branches->{$br}->{'branchprinter'};
1093 $branchname = $branches->{$br}->{'branchname'};
1096 $session->param( 'number', $borrowernumber );
1097 $session->param( 'id', $userid );
1098 $session->param( 'cardnumber', $cardnumber );
1099 $session->param( 'firstname', $firstname );
1100 $session->param( 'surname', $surname );
1101 $session->param( 'branch', $branchcode );
1102 $session->param( 'branchname', $branchname );
1103 $session->param( 'flags', $userflags );
1104 $session->param( 'emailaddress', $emailaddress );
1105 $session->param( 'ip', $session->remote_addr() );
1106 $session->param( 'lasttime', time() );
1107 $session->param( 'shibboleth', $shibSuccess );
1108 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1110 elsif ( $return == 2 ) {
1112 #We suppose the user is the superlibrarian
1113 $borrowernumber = 0;
1114 $session->param( 'number', 0 );
1115 $session->param( 'id', C4::Context->config('user') );
1116 $session->param( 'cardnumber', C4::Context->config('user') );
1117 $session->param( 'firstname', C4::Context->config('user') );
1118 $session->param( 'surname', C4::Context->config('user') );
1119 $session->param( 'branch', 'NO_LIBRARY_SET' );
1120 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1121 $session->param( 'flags', 1 );
1122 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1123 $session->param( 'ip', $session->remote_addr() );
1124 $session->param( 'lasttime', time() );
1127 $session->param( 'persona', 1 );
1129 C4::Context->set_userenv(
1130 $session->param('number'), $session->param('id'),
1131 $session->param('cardnumber'), $session->param('firstname'),
1132 $session->param('surname'), $session->param('branch'),
1133 $session->param('branchname'), $session->param('flags'),
1134 $session->param('emailaddress'), $session->param('branchprinter'),
1135 $session->param('persona'), $session->param('shibboleth')
1139 # $return: 0 = invalid user
1140 # reset to anonymous session
1142 $debug and warn "Login failed, resetting anonymous session...";
1144 $info{'invalid_username_or_password'} = 1;
1145 C4::Context->_unset_userenv($sessionID);
1147 $session->param( 'lasttime', time() );
1148 $session->param( 'ip', $session->remote_addr() );
1149 $session->param( 'sessiontype', 'anon' );
1151 } # END if ( $userid = $query->param('userid') )
1152 elsif ( $type eq "opac" ) {
1154 # if we are here this is an anonymous session; add public lists to it and a few other items...
1155 # anonymous sessions are created only for the OPAC
1156 $debug and warn "Initiating an anonymous session...";
1158 # setting a couple of other session vars...
1159 $session->param( 'ip', $session->remote_addr() );
1160 $session->param( 'lasttime', time() );
1161 $session->param( 'sessiontype', 'anon' );
1163 } # END unless ($userid)
1165 # finished authentification, now respond
1166 if ( $loggedin || $authnotrequired )
1170 $cookie = $query->cookie(
1171 -name => 'CGISESSID',
1176 return ( $userid, $cookie, $sessionID, $flags );
1181 # AUTH rejected, show the login/password template, after checking the DB.
1185 # get the inputs from the incoming query
1187 foreach my $name ( param $query) {
1188 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1189 my $value = $query->param($name);
1190 push @inputs, { name => $name, value => $value };
1193 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1194 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1195 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1197 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1198 my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1200 branchloop => GetBranchesLoop(),
1201 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1202 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1205 casAuthentication => C4::Context->preference("casAuthentication"),
1206 shibbolethAuthentication => $shib,
1207 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1208 suggestion => C4::Context->preference("suggestion"),
1209 virtualshelves => C4::Context->preference("virtualshelves"),
1210 LibraryName => "" . C4::Context->preference("LibraryName"),
1211 LibraryNameTitle => "" . $LibraryNameTitle,
1212 opacuserlogin => C4::Context->preference("opacuserlogin"),
1213 OpacNav => C4::Context->preference("OpacNav"),
1214 OpacNavRight => C4::Context->preference("OpacNavRight"),
1215 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1216 opaccredits => C4::Context->preference("opaccredits"),
1217 OpacFavicon => C4::Context->preference("OpacFavicon"),
1218 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1219 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1220 OPACUserJS => C4::Context->preference("OPACUserJS"),
1221 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1222 OpacCloud => C4::Context->preference("OpacCloud"),
1223 OpacTopissue => C4::Context->preference("OpacTopissue"),
1224 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1225 OpacBrowser => C4::Context->preference("OpacBrowser"),
1226 opacheader => C4::Context->preference("opacheader"),
1227 TagsEnabled => C4::Context->preference("TagsEnabled"),
1228 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1229 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1230 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1231 intranetbookbag => C4::Context->preference("intranetbookbag"),
1232 IntranetNav => C4::Context->preference("IntranetNav"),
1233 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1234 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1235 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1236 IndependentBranches => C4::Context->preference("IndependentBranches"),
1237 AutoLocation => C4::Context->preference("AutoLocation"),
1238 wrongip => $info{'wrongip'},
1239 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1240 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1241 persona => C4::Context->preference("Persona"),
1242 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1245 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1246 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1248 if ( $type eq 'opac' ) {
1249 require Koha::Virtualshelves;
1250 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1256 some_public_shelves => $some_public_shelves,
1262 # Is authentication against multiple CAS servers enabled?
1263 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1264 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1266 foreach my $key ( keys %$casservers ) {
1267 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1270 casServersLoop => \@tmplservers
1274 casServerUrl => login_cas_url($query, undef, $type),
1279 invalidCasLogin => $info{'invalidCasLogin'}
1285 shibbolethAuthentication => $shib,
1286 shibbolethLoginUrl => login_shib_url($query),
1291 LibraryName => C4::Context->preference("LibraryName"),
1293 $template->param(%info);
1295 # $cookie = $query->cookie(CGISESSID => $session->id
1297 print $query->header(
1298 -type => 'text/html',
1299 -charset => 'utf-8',
1306 =head2 check_api_auth
1308 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1310 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1311 cookie, determine if the user has the privileges specified by C<$userflags>.
1313 C<check_api_auth> is is meant for authenticating users of web services, and
1314 consequently will always return and will not attempt to redirect the user
1317 If a valid session cookie is already present, check_api_auth will return a status
1318 of "ok", the cookie, and the Koha session ID.
1320 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1321 parameters and create a session cookie and Koha session if the supplied credentials
1324 Possible return values in C<$status> are:
1328 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1330 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1332 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1334 =item "expired -- session cookie has expired; API user should resubmit userid and password
1340 sub check_api_auth {
1342 my $flagsrequired = shift;
1344 my $dbh = C4::Context->dbh;
1345 my $timeout = _timeout_syspref();
1347 unless ( C4::Context->preference('Version') ) {
1349 # database has not been installed yet
1350 return ( "maintenance", undef, undef );
1352 my $kohaversion = Koha::version();
1353 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1354 if ( C4::Context->preference('Version') < $kohaversion ) {
1356 # database in need of version update; assume that
1357 # no API should be called while databsae is in
1359 return ( "maintenance", undef, undef );
1362 # FIXME -- most of what follows is a copy-and-paste
1363 # of code from checkauth. There is an obvious need
1364 # for refactoring to separate the various parts of
1365 # the authentication code, but as of 2007-11-19 this
1366 # is deferred so as to not introduce bugs into the
1367 # regular authentication code for Koha 3.0.
1369 # see if we have a valid session cookie already
1370 # however, if a userid parameter is present (i.e., from
1371 # a form submission, assume that any current cookie
1373 my $sessionID = undef;
1374 unless ( $query->param('userid') ) {
1375 $sessionID = $query->cookie("CGISESSID");
1377 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1378 my $session = get_session($sessionID);
1379 C4::Context->_new_userenv($sessionID);
1381 C4::Context->set_userenv(
1382 $session->param('number'), $session->param('id'),
1383 $session->param('cardnumber'), $session->param('firstname'),
1384 $session->param('surname'), $session->param('branch'),
1385 $session->param('branchname'), $session->param('flags'),
1386 $session->param('emailaddress'), $session->param('branchprinter')
1389 my $ip = $session->param('ip');
1390 my $lasttime = $session->param('lasttime');
1391 my $userid = $session->param('id');
1392 if ( $lasttime < time() - $timeout ) {
1397 C4::Context->_unset_userenv($sessionID);
1400 return ( "expired", undef, undef );
1401 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1403 # IP address changed
1406 C4::Context->_unset_userenv($sessionID);
1409 return ( "expired", undef, undef );
1411 my $cookie = $query->cookie(
1412 -name => 'CGISESSID',
1413 -value => $session->id,
1416 $session->param( 'lasttime', time() );
1417 my $flags = haspermission( $userid, $flagsrequired );
1419 return ( "ok", $cookie, $sessionID );
1423 C4::Context->_unset_userenv($sessionID);
1426 return ( "failed", undef, undef );
1430 return ( "expired", undef, undef );
1435 my $userid = $query->param('userid');
1436 my $password = $query->param('password');
1437 my ( $return, $cardnumber );
1440 if ( $cas && $query->param('PT') ) {
1442 $debug and print STDERR "## check_api_auth - checking CAS\n";
1444 # In case of a CAS authentication, we use the ticket instead of the password
1445 my $PT = $query->param('PT');
1446 ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1449 # User / password auth
1450 unless ( $userid and $password ) {
1452 # caller did something wrong, fail the authenticateion
1453 return ( "failed", undef, undef );
1455 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1458 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1459 my $session = get_session("");
1460 return ( "failed", undef, undef ) unless $session;
1462 my $sessionID = $session->id;
1463 C4::Context->_new_userenv($sessionID);
1464 my $cookie = $query->cookie(
1465 -name => 'CGISESSID',
1466 -value => $sessionID,
1469 if ( $return == 1 ) {
1471 $borrowernumber, $firstname, $surname,
1472 $userflags, $branchcode, $branchname,
1473 $branchprinter, $emailaddress
1477 "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=?"
1479 $sth->execute($userid);
1481 $borrowernumber, $firstname, $surname,
1482 $userflags, $branchcode, $branchname,
1483 $branchprinter, $emailaddress
1484 ) = $sth->fetchrow if ( $sth->rows );
1486 unless ( $sth->rows ) {
1487 my $sth = $dbh->prepare(
1488 "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=?"
1490 $sth->execute($cardnumber);
1492 $borrowernumber, $firstname, $surname,
1493 $userflags, $branchcode, $branchname,
1494 $branchprinter, $emailaddress
1495 ) = $sth->fetchrow if ( $sth->rows );
1497 unless ( $sth->rows ) {
1498 $sth->execute($userid);
1500 $borrowernumber, $firstname, $surname, $userflags,
1501 $branchcode, $branchname, $branchprinter, $emailaddress
1502 ) = $sth->fetchrow if ( $sth->rows );
1506 my $ip = $ENV{'REMOTE_ADDR'};
1508 # if they specify at login, use that
1509 if ( $query->param('branch') ) {
1510 $branchcode = $query->param('branch');
1511 $branchname = GetBranchName($branchcode);
1513 my $branches = GetBranches();
1515 foreach my $br ( keys %$branches ) {
1517 # now we work with the treatment of ip
1518 my $domain = $branches->{$br}->{'branchip'};
1519 if ( $domain && $ip =~ /^$domain/ ) {
1520 $branchcode = $branches->{$br}->{'branchcode'};
1522 # new op dev : add the branchprinter and branchname in the cookie
1523 $branchprinter = $branches->{$br}->{'branchprinter'};
1524 $branchname = $branches->{$br}->{'branchname'};
1527 $session->param( 'number', $borrowernumber );
1528 $session->param( 'id', $userid );
1529 $session->param( 'cardnumber', $cardnumber );
1530 $session->param( 'firstname', $firstname );
1531 $session->param( 'surname', $surname );
1532 $session->param( 'branch', $branchcode );
1533 $session->param( 'branchname', $branchname );
1534 $session->param( 'flags', $userflags );
1535 $session->param( 'emailaddress', $emailaddress );
1536 $session->param( 'ip', $session->remote_addr() );
1537 $session->param( 'lasttime', time() );
1538 } elsif ( $return == 2 ) {
1540 #We suppose the user is the superlibrarian
1541 $session->param( 'number', 0 );
1542 $session->param( 'id', C4::Context->config('user') );
1543 $session->param( 'cardnumber', C4::Context->config('user') );
1544 $session->param( 'firstname', C4::Context->config('user') );
1545 $session->param( 'surname', C4::Context->config('user') );
1546 $session->param( 'branch', 'NO_LIBRARY_SET' );
1547 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1548 $session->param( 'flags', 1 );
1549 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1550 $session->param( 'ip', $session->remote_addr() );
1551 $session->param( 'lasttime', time() );
1553 C4::Context->set_userenv(
1554 $session->param('number'), $session->param('id'),
1555 $session->param('cardnumber'), $session->param('firstname'),
1556 $session->param('surname'), $session->param('branch'),
1557 $session->param('branchname'), $session->param('flags'),
1558 $session->param('emailaddress'), $session->param('branchprinter')
1560 return ( "ok", $cookie, $sessionID );
1562 return ( "failed", undef, undef );
1567 =head2 check_cookie_auth
1569 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1571 Given a CGISESSID cookie set during a previous login to Koha, determine
1572 if the user has the privileges specified by C<$userflags>.
1574 C<check_cookie_auth> is meant for authenticating special services
1575 such as tools/upload-file.pl that are invoked by other pages that
1576 have been authenticated in the usual way.
1578 Possible return values in C<$status> are:
1582 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1584 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1586 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1588 =item "expired -- session cookie has expired; API user should resubmit userid and password
1594 sub check_cookie_auth {
1596 my $flagsrequired = shift;
1598 my $dbh = C4::Context->dbh;
1599 my $timeout = _timeout_syspref();
1601 unless ( C4::Context->preference('Version') ) {
1603 # database has not been installed yet
1604 return ( "maintenance", undef );
1606 my $kohaversion = Koha::version();
1607 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1608 if ( C4::Context->preference('Version') < $kohaversion ) {
1610 # database in need of version update; assume that
1611 # no API should be called while databsae is in
1613 return ( "maintenance", undef );
1616 # FIXME -- most of what follows is a copy-and-paste
1617 # of code from checkauth. There is an obvious need
1618 # for refactoring to separate the various parts of
1619 # the authentication code, but as of 2007-11-23 this
1620 # is deferred so as to not introduce bugs into the
1621 # regular authentication code for Koha 3.0.
1623 # see if we have a valid session cookie already
1624 # however, if a userid parameter is present (i.e., from
1625 # a form submission, assume that any current cookie
1627 unless ( defined $cookie and $cookie ) {
1628 return ( "failed", undef );
1630 my $sessionID = $cookie;
1631 my $session = get_session($sessionID);
1632 C4::Context->_new_userenv($sessionID);
1634 C4::Context->set_userenv(
1635 $session->param('number'), $session->param('id'),
1636 $session->param('cardnumber'), $session->param('firstname'),
1637 $session->param('surname'), $session->param('branch'),
1638 $session->param('branchname'), $session->param('flags'),
1639 $session->param('emailaddress'), $session->param('branchprinter')
1642 my $ip = $session->param('ip');
1643 my $lasttime = $session->param('lasttime');
1644 my $userid = $session->param('id');
1645 if ( $lasttime < time() - $timeout ) {
1650 C4::Context->_unset_userenv($sessionID);
1653 return ("expired", undef);
1654 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1656 # IP address changed
1659 C4::Context->_unset_userenv($sessionID);
1662 return ( "expired", undef );
1664 $session->param( 'lasttime', time() );
1665 my $flags = haspermission( $userid, $flagsrequired );
1667 return ( "ok", $sessionID );
1671 C4::Context->_unset_userenv($sessionID);
1674 return ( "failed", undef );
1678 return ( "expired", undef );
1685 my $session = get_session($sessionID);
1687 Given a session ID, retrieve the CGI::Session object used to store
1688 the session's state. The session object can be used to store
1689 data that needs to be accessed by different scripts during a
1692 If the C<$sessionID> parameter is an empty string, a new session
1698 my $sessionID = shift;
1699 my $storage_method = C4::Context->preference('SessionStorage');
1700 my $dbh = C4::Context->dbh;
1702 if ( $storage_method eq 'mysql' ) {
1703 $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1705 elsif ( $storage_method eq 'Pg' ) {
1706 $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1708 elsif ( $storage_method eq 'memcached' && C4::Context->ismemcached ) {
1709 $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1712 # catch all defaults to tmp should work on all systems
1713 $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => '/tmp' } );
1719 my ( $dbh, $userid, $password, $query, $type ) = @_;
1720 $type = 'opac' unless $type;
1722 $debug and print STDERR "## checkpw - checking LDAP\n";
1723 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1724 return 0 if $retval == -1; # Incorrect password for LDAP login attempt
1725 ($retval) and return ( $retval, $retcard, $retuserid );
1728 if ( $cas && $query && $query->param('ticket') ) {
1729 $debug and print STDERR "## checkpw - checking CAS\n";
1731 # In case of a CAS authentication, we use the ticket instead of the password
1732 my $ticket = $query->param('ticket');
1733 $query->delete('ticket'); # remove ticket to come back to original URL
1734 my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1735 ($retval) and return ( $retval, $retcard, $retuserid );
1739 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1740 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1742 if ( $shib && $shib_login && !$password ) {
1744 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1746 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1747 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1748 # shibboleth-authenticated user
1750 # Then, we check if it matches a valid koha user
1752 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1753 ($retval) and return ( $retval, $retcard, $retuserid );
1759 return checkpw_internal(@_)
1762 sub checkpw_internal {
1763 my ( $dbh, $userid, $password ) = @_;
1765 $password = Encode::encode( 'UTF-8', $password )
1766 if Encode::is_utf8($password);
1768 if ( $userid && $userid eq C4::Context->config('user') ) {
1769 if ( $password && $password eq C4::Context->config('pass') ) {
1771 # Koha superuser account
1772 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1782 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1784 $sth->execute($userid);
1786 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1787 $surname, $branchcode, $branchname, $flags )
1790 if ( checkpw_hash( $password, $stored_hash ) ) {
1792 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1793 $firstname, $surname, $branchcode, $branchname, $flags );
1794 return 1, $cardnumber, $userid;
1799 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1801 $sth->execute($userid);
1803 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1804 $surname, $branchcode, $branchname, $flags )
1807 if ( checkpw_hash( $password, $stored_hash ) ) {
1809 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1810 $firstname, $surname, $branchcode, $branchname, $flags );
1811 return 1, $cardnumber, $userid;
1814 if ( $userid && $userid eq 'demo'
1815 && "$password" eq 'demo'
1816 && C4::Context->config('demo') )
1819 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1820 # some features won't be effective : modify systempref, modify MARC structure,
1827 my ( $password, $stored_hash ) = @_;
1829 return if $stored_hash eq '!';
1831 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1833 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1834 $hash = hash_password( $password, $stored_hash );
1836 $hash = md5_base64($password);
1838 return $hash eq $stored_hash;
1843 my $authflags = getuserflags($flags, $userid, [$dbh]);
1845 Translates integer flags into permissions strings hash.
1847 C<$flags> is the integer userflags value ( borrowers.userflags )
1848 C<$userid> is the members.userid, used for building subpermissions
1849 C<$authflags> is a hashref of permissions
1856 my $dbh = @_ ? shift : C4::Context->dbh;
1859 # I don't want to do this, but if someone logs in as the database
1860 # user, it would be preferable not to spam them to death with
1861 # numeric warnings. So, we make $flags numeric.
1862 no warnings 'numeric';
1865 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1868 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1869 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1870 $userflags->{$flag} = 1;
1873 $userflags->{$flag} = 0;
1877 # get subpermissions and merge with top-level permissions
1878 my $user_subperms = get_user_subpermissions($userid);
1879 foreach my $module ( keys %$user_subperms ) {
1880 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1881 $userflags->{$module} = $user_subperms->{$module};
1887 =head2 get_user_subpermissions
1889 $user_perm_hashref = get_user_subpermissions($userid);
1891 Given the userid (note, not the borrowernumber) of a staff user,
1892 return a hashref of hashrefs of the specific subpermissions
1893 accorded to the user. An example return is
1897 export_catalog => 1,
1898 import_patrons => 1,
1902 The top-level hash-key is a module or function code from
1903 userflags.flag, while the second-level key is a code
1906 The results of this function do not give a complete picture
1907 of the functions that a staff user can access; it is also
1908 necessary to check borrowers.flags.
1912 sub get_user_subpermissions {
1915 my $dbh = C4::Context->dbh;
1916 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1917 FROM user_permissions
1918 JOIN permissions USING (module_bit, code)
1919 JOIN userflags ON (module_bit = bit)
1920 JOIN borrowers USING (borrowernumber)
1921 WHERE userid = ?" );
1922 $sth->execute($userid);
1924 my $user_perms = {};
1925 while ( my $perm = $sth->fetchrow_hashref ) {
1926 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1931 =head2 get_all_subpermissions
1933 my $perm_hashref = get_all_subpermissions();
1935 Returns a hashref of hashrefs defining all specific
1936 permissions currently defined. The return value
1937 has the same structure as that of C<get_user_subpermissions>,
1938 except that the innermost hash value is the description
1939 of the subpermission.
1943 sub get_all_subpermissions {
1944 my $dbh = C4::Context->dbh;
1945 my $sth = $dbh->prepare( "SELECT flag, code
1947 JOIN userflags ON (module_bit = bit)" );
1951 while ( my $perm = $sth->fetchrow_hashref ) {
1952 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1957 =head2 haspermission
1959 $flags = ($userid, $flagsrequired);
1961 C<$userid> the userid of the member
1962 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1964 Returns member's flags or 0 if a permission is not met.
1969 my ( $userid, $flagsrequired ) = @_;
1970 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1971 $sth->execute($userid);
1972 my $row = $sth->fetchrow();
1973 my $flags = getuserflags( $row, $userid );
1974 if ( $userid eq C4::Context->config('user') ) {
1976 # Super User Account from /etc/koha.conf
1977 $flags->{'superlibrarian'} = 1;
1979 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1981 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1982 $flags->{'superlibrarian'} = 1;
1985 return $flags if $flags->{superlibrarian};
1987 foreach my $module ( keys %$flagsrequired ) {
1988 my $subperm = $flagsrequired->{$module};
1989 if ( $subperm eq '*' ) {
1990 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
1993 ( defined $flags->{$module} and
1994 $flags->{$module} == 1 )
1996 ( ref( $flags->{$module} ) and
1997 exists $flags->{$module}->{$subperm} and
1998 $flags->{$module}->{$subperm} == 1 )
2004 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2007 sub getborrowernumber {
2009 my $userenv = C4::Context->userenv;
2010 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2011 return $userenv->{number};
2013 my $dbh = C4::Context->dbh;
2014 for my $field ( 'userid', 'cardnumber' ) {
2016 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2017 $sth->execute($userid);
2019 my ($bnumber) = $sth->fetchrow;
2026 END { } # module clean-up code here (global destructor)
2036 Crypt::Eksblowfish::Bcrypt(3)