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'} ) || ( $shib && $shib_login && !$logout ) ) {
815 #if a user enters an id ne to the id in the current session, we need to log them in...
816 #first we need to clear the anonymous session...
817 $debug and warn "query id = $q_userid but session id = $s_userid";
818 $anon_search_history = $session->param('search_history');
821 C4::Context->_unset_userenv($sessionID);
827 # voluntary logout the user
828 # check wether the user was using their shibboleth session or a local one
829 my $shibSuccess = C4::Context->userenv->{'shibboleth'};
832 C4::Context->_unset_userenv($sessionID);
834 #_session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,(strftime "%c",localtime));
838 if ($cas and $caslogout) {
839 logout_cas($query, $type);
842 # If we are in a shibboleth session (shibboleth is enabled, a shibboleth match attribute is set and matches koha matchpoint)
843 if ( $shib and $shib_login and $shibSuccess and $type eq 'opac' ) {
845 # (Note: $type eq 'opac' condition should be removed when shibboleth authentication for intranet will be implemented)
849 elsif ( !$lasttime || ( $lasttime < time() - $timeout ) ) {
852 $info{'timed_out'} = 1;
857 C4::Context->_unset_userenv($sessionID);
859 #_session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,(strftime "%c",localtime));
863 elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
865 # Different ip than originally logged in from
866 $info{'oldip'} = $ip;
867 $info{'newip'} = $ENV{'REMOTE_ADDR'};
868 $info{'different_ip'} = 1;
871 C4::Context->_unset_userenv($sessionID);
873 #_session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,(strftime "%c",localtime), $info{'newip'});
878 $cookie = $query->cookie(
879 -name => 'CGISESSID',
880 -value => $session->id,
883 $session->param( 'lasttime', time() );
884 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...
885 $flags = haspermission( $userid, $flagsrequired );
889 $info{'nopermission'} = 1;
894 unless ( $userid || $sessionID ) {
896 #we initiate a session prior to checking for a username to allow for anonymous sessions...
897 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
899 # Save anonymous search history in new session so it can be retrieved
900 # by get_template_and_user to store it in user's search history after
901 # a successful login.
902 if ($anon_search_history) {
903 $session->param( 'search_history', $anon_search_history );
906 my $sessionID = $session->id;
907 C4::Context->_new_userenv($sessionID);
908 $cookie = $query->cookie(
909 -name => 'CGISESSID',
910 -value => $session->id,
914 my $pki_field = C4::Context->preference('AllowPKIAuth');
915 if ( !defined($pki_field) ) {
916 print STDERR "ERROR: Missing system preference AllowPKIAuth.\n";
919 if ( ( $cas && $query->param('ticket') )
921 || ( $shib && $shib_login )
922 || $pki_field ne 'None'
925 my $password = $query->param('password');
928 my ( $return, $cardnumber );
930 # If shib is enabled and we have a shib login, does the login match a valid koha user
931 if ( $shib && $shib_login && $type eq 'opac' ) {
934 # Do not pass password here, else shib will not be checked in checkpw.
935 ( $return, $cardnumber, $retuserid ) = checkpw( $dbh, $userid, undef, $query );
936 $userid = $retuserid;
937 $shibSuccess = $return;
938 $info{'invalidShibLogin'} = 1 unless ($return);
941 # If shib login and match were successful, skip further login methods
942 unless ($shibSuccess) {
943 if ( $cas && $query->param('ticket') ) {
945 ( $return, $cardnumber, $retuserid ) =
946 checkpw( $dbh, $userid, $password, $query, $type );
947 $userid = $retuserid;
948 $info{'invalidCasLogin'} = 1 unless ($return);
952 my $value = $persona;
954 # If we're looking up the email, there's a chance that the person
955 # doesn't have a userid. So if there is none, we pass along the
956 # borrower number, and the bits of code that need to know the user
957 # ID will have to be smart enough to handle that.
959 my @users_info = C4::Members::GetBorrowersWithEmail($value);
962 # First the userid, then the borrowernum
963 $value = $users_info[0][1] || $users_info[0][0];
968 $return = $value ? 1 : 0;
973 ( $pki_field eq 'Common Name' && $ENV{'SSL_CLIENT_S_DN_CN'} )
974 || ( $pki_field eq 'emailAddress'
975 && $ENV{'SSL_CLIENT_S_DN_Email'} )
979 if ( $pki_field eq 'Common Name' ) {
980 $value = $ENV{'SSL_CLIENT_S_DN_CN'};
982 elsif ( $pki_field eq 'emailAddress' ) {
983 $value = $ENV{'SSL_CLIENT_S_DN_Email'};
985 # If we're looking up the email, there's a chance that the person
986 # doesn't have a userid. So if there is none, we pass along the
987 # borrower number, and the bits of code that need to know the user
988 # ID will have to be smart enough to handle that.
990 my @users_info = C4::Members::GetBorrowersWithEmail($value);
993 # First the userid, then the borrowernum
994 $value = $users_info[0][1] || $users_info[0][0];
1000 $return = $value ? 1 : 0;
1006 ( $return, $cardnumber, $retuserid ) =
1007 checkpw( $dbh, $userid, $password, $query, $type );
1008 $userid = $retuserid if ($retuserid);
1009 $info{'invalid_username_or_password'} = 1 unless ($return);
1013 # $return: 1 = valid user, 2 = superlibrarian
1016 #_session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},(strftime '%c', localtime));
1017 if ( $flags = haspermission( $userid, $flagsrequired ) ) {
1021 $info{'nopermission'} = 1;
1022 C4::Context->_unset_userenv($sessionID);
1024 my ( $borrowernumber, $firstname, $surname, $userflags,
1025 $branchcode, $branchname, $branchprinter, $emailaddress );
1027 if ( $return == 1 ) {
1029 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
1030 branches.branchname as branchname,
1031 branches.branchprinter as branchprinter,
1034 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
1036 my $sth = $dbh->prepare("$select where userid=?");
1037 $sth->execute($userid);
1038 unless ( $sth->rows ) {
1039 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
1040 $sth = $dbh->prepare("$select where cardnumber=?");
1041 $sth->execute($cardnumber);
1043 unless ( $sth->rows ) {
1044 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
1045 $sth->execute($userid);
1046 unless ( $sth->rows ) {
1047 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
1052 ( $borrowernumber, $firstname, $surname, $userflags,
1053 $branchcode, $branchname, $branchprinter, $emailaddress ) = $sth->fetchrow;
1054 $debug and print STDERR "AUTH_3 results: " .
1055 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
1057 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
1060 # launch a sequence to check if we have a ip for the branch, i
1061 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
1063 my $ip = $ENV{'REMOTE_ADDR'};
1065 # if they specify at login, use that
1066 if ( $query->param('branch') ) {
1067 $branchcode = $query->param('branch');
1068 $branchname = GetBranchName($branchcode);
1070 my $branches = GetBranches();
1071 if ( C4::Context->boolean_preference('IndependentBranches') && C4::Context->boolean_preference('Autolocation') ) {
1073 # we have to check they are coming from the right ip range
1074 my $domain = $branches->{$branchcode}->{'branchip'};
1075 if ( $ip !~ /^$domain/ ) {
1077 $info{'wrongip'} = 1;
1082 foreach my $br ( keys %$branches ) {
1084 # now we work with the treatment of ip
1085 my $domain = $branches->{$br}->{'branchip'};
1086 if ( $domain && $ip =~ /^$domain/ ) {
1087 $branchcode = $branches->{$br}->{'branchcode'};
1089 # new op dev : add the branchprinter and branchname in the cookie
1090 $branchprinter = $branches->{$br}->{'branchprinter'};
1091 $branchname = $branches->{$br}->{'branchname'};
1094 $session->param( 'number', $borrowernumber );
1095 $session->param( 'id', $userid );
1096 $session->param( 'cardnumber', $cardnumber );
1097 $session->param( 'firstname', $firstname );
1098 $session->param( 'surname', $surname );
1099 $session->param( 'branch', $branchcode );
1100 $session->param( 'branchname', $branchname );
1101 $session->param( 'flags', $userflags );
1102 $session->param( 'emailaddress', $emailaddress );
1103 $session->param( 'ip', $session->remote_addr() );
1104 $session->param( 'lasttime', time() );
1105 $session->param( 'shibboleth', $shibSuccess );
1106 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map { $session->param($_) } qw(cardnumber firstname surname branch);
1108 elsif ( $return == 2 ) {
1110 #We suppose the user is the superlibrarian
1111 $borrowernumber = 0;
1112 $session->param( 'number', 0 );
1113 $session->param( 'id', C4::Context->config('user') );
1114 $session->param( 'cardnumber', C4::Context->config('user') );
1115 $session->param( 'firstname', C4::Context->config('user') );
1116 $session->param( 'surname', C4::Context->config('user') );
1117 $session->param( 'branch', 'NO_LIBRARY_SET' );
1118 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1119 $session->param( 'flags', 1 );
1120 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1121 $session->param( 'ip', $session->remote_addr() );
1122 $session->param( 'lasttime', time() );
1125 $session->param( 'persona', 1 );
1127 C4::Context->set_userenv(
1128 $session->param('number'), $session->param('id'),
1129 $session->param('cardnumber'), $session->param('firstname'),
1130 $session->param('surname'), $session->param('branch'),
1131 $session->param('branchname'), $session->param('flags'),
1132 $session->param('emailaddress'), $session->param('branchprinter'),
1133 $session->param('persona'), $session->param('shibboleth')
1137 # $return: 0 = invalid user
1138 # reset to anonymous session
1140 $debug and warn "Login failed, resetting anonymous session...";
1142 $info{'invalid_username_or_password'} = 1;
1143 C4::Context->_unset_userenv($sessionID);
1145 $session->param( 'lasttime', time() );
1146 $session->param( 'ip', $session->remote_addr() );
1147 $session->param( 'sessiontype', 'anon' );
1149 } # END if ( $userid = $query->param('userid') )
1150 elsif ( $type eq "opac" ) {
1152 # if we are here this is an anonymous session; add public lists to it and a few other items...
1153 # anonymous sessions are created only for the OPAC
1154 $debug and warn "Initiating an anonymous session...";
1156 # setting a couple of other session vars...
1157 $session->param( 'ip', $session->remote_addr() );
1158 $session->param( 'lasttime', time() );
1159 $session->param( 'sessiontype', 'anon' );
1161 } # END unless ($userid)
1163 # finished authentification, now respond
1164 if ( $loggedin || $authnotrequired )
1168 $cookie = $query->cookie(
1169 -name => 'CGISESSID',
1174 return ( $userid, $cookie, $sessionID, $flags );
1179 # AUTH rejected, show the login/password template, after checking the DB.
1183 # get the inputs from the incoming query
1185 foreach my $name ( param $query) {
1186 (next) if ( $name eq 'userid' || $name eq 'password' || $name eq 'ticket' );
1187 my $value = $query->param($name);
1188 push @inputs, { name => $name, value => $value };
1191 my $LibraryNameTitle = C4::Context->preference("LibraryName");
1192 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
1193 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
1195 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tt' : 'auth.tt';
1196 my $template = C4::Templates::gettemplate( $template_name, $type, $query );
1198 branchloop => GetBranchesLoop(),
1199 OpacAdditionalStylesheet => C4::Context->preference("OpacAdditionalStylesheet"),
1200 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
1203 casAuthentication => C4::Context->preference("casAuthentication"),
1204 shibbolethAuthentication => $shib,
1205 SessionRestrictionByIP => C4::Context->preference("SessionRestrictionByIP"),
1206 suggestion => C4::Context->preference("suggestion"),
1207 virtualshelves => C4::Context->preference("virtualshelves"),
1208 LibraryName => "" . C4::Context->preference("LibraryName"),
1209 LibraryNameTitle => "" . $LibraryNameTitle,
1210 opacuserlogin => C4::Context->preference("opacuserlogin"),
1211 OpacNav => C4::Context->preference("OpacNav"),
1212 OpacNavRight => C4::Context->preference("OpacNavRight"),
1213 OpacNavBottom => C4::Context->preference("OpacNavBottom"),
1214 opaccredits => C4::Context->preference("opaccredits"),
1215 OpacFavicon => C4::Context->preference("OpacFavicon"),
1216 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
1217 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
1218 OPACUserJS => C4::Context->preference("OPACUserJS"),
1219 opacbookbag => "" . C4::Context->preference("opacbookbag"),
1220 OpacCloud => C4::Context->preference("OpacCloud"),
1221 OpacTopissue => C4::Context->preference("OpacTopissue"),
1222 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
1223 OpacBrowser => C4::Context->preference("OpacBrowser"),
1224 opacheader => C4::Context->preference("opacheader"),
1225 TagsEnabled => C4::Context->preference("TagsEnabled"),
1226 OPACUserCSS => C4::Context->preference("OPACUserCSS"),
1227 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
1228 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
1229 intranetbookbag => C4::Context->preference("intranetbookbag"),
1230 IntranetNav => C4::Context->preference("IntranetNav"),
1231 IntranetFavicon => C4::Context->preference("IntranetFavicon"),
1232 IntranetUserCSS => C4::Context->preference("IntranetUserCSS"),
1233 IntranetUserJS => C4::Context->preference("IntranetUserJS"),
1234 IndependentBranches => C4::Context->preference("IndependentBranches"),
1235 AutoLocation => C4::Context->preference("AutoLocation"),
1236 wrongip => $info{'wrongip'},
1237 PatronSelfRegistration => C4::Context->preference("PatronSelfRegistration"),
1238 PatronSelfRegistrationDefaultCategory => C4::Context->preference("PatronSelfRegistrationDefaultCategory"),
1239 persona => C4::Context->preference("Persona"),
1240 opac_css_override => $ENV{'OPAC_CSS_OVERRIDE'},
1243 $template->param( OpacPublic => C4::Context->preference("OpacPublic") );
1244 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
1246 if ( $type eq 'opac' ) {
1247 require Koha::Virtualshelves;
1248 my $some_public_shelves = Koha::Virtualshelves->get_some_shelves(
1254 some_public_shelves => $some_public_shelves,
1260 # Is authentication against multiple CAS servers enabled?
1261 if ( C4::Auth_with_cas::multipleAuth && !$casparam ) {
1262 my $casservers = C4::Auth_with_cas::getMultipleAuth();
1264 foreach my $key ( keys %$casservers ) {
1265 push @tmplservers, { name => $key, value => login_cas_url( $query, $key, $type ) . "?cas=$key" };
1268 casServersLoop => \@tmplservers
1272 casServerUrl => login_cas_url($query, undef, $type),
1277 invalidCasLogin => $info{'invalidCasLogin'}
1283 shibbolethAuthentication => $shib,
1284 shibbolethLoginUrl => login_shib_url($query),
1289 LibraryName => C4::Context->preference("LibraryName"),
1291 $template->param(%info);
1293 # $cookie = $query->cookie(CGISESSID => $session->id
1295 print $query->header(
1296 -type => 'text/html',
1297 -charset => 'utf-8',
1304 =head2 check_api_auth
1306 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
1308 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
1309 cookie, determine if the user has the privileges specified by C<$userflags>.
1311 C<check_api_auth> is is meant for authenticating users of web services, and
1312 consequently will always return and will not attempt to redirect the user
1315 If a valid session cookie is already present, check_api_auth will return a status
1316 of "ok", the cookie, and the Koha session ID.
1318 If no session cookie is present, check_api_auth will check the 'userid' and 'password
1319 parameters and create a session cookie and Koha session if the supplied credentials
1322 Possible return values in C<$status> are:
1326 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
1328 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
1330 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1332 =item "expired -- session cookie has expired; API user should resubmit userid and password
1338 sub check_api_auth {
1340 my $flagsrequired = shift;
1342 my $dbh = C4::Context->dbh;
1343 my $timeout = _timeout_syspref();
1345 unless ( C4::Context->preference('Version') ) {
1347 # database has not been installed yet
1348 return ( "maintenance", undef, undef );
1350 my $kohaversion = Koha::version();
1351 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1352 if ( C4::Context->preference('Version') < $kohaversion ) {
1354 # database in need of version update; assume that
1355 # no API should be called while databsae is in
1357 return ( "maintenance", undef, undef );
1360 # FIXME -- most of what follows is a copy-and-paste
1361 # of code from checkauth. There is an obvious need
1362 # for refactoring to separate the various parts of
1363 # the authentication code, but as of 2007-11-19 this
1364 # is deferred so as to not introduce bugs into the
1365 # regular authentication code for Koha 3.0.
1367 # see if we have a valid session cookie already
1368 # however, if a userid parameter is present (i.e., from
1369 # a form submission, assume that any current cookie
1371 my $sessionID = undef;
1372 unless ( $query->param('userid') ) {
1373 $sessionID = $query->cookie("CGISESSID");
1375 if ( $sessionID && not( $cas && $query->param('PT') ) ) {
1376 my $session = get_session($sessionID);
1377 C4::Context->_new_userenv($sessionID);
1379 C4::Context->set_userenv(
1380 $session->param('number'), $session->param('id'),
1381 $session->param('cardnumber'), $session->param('firstname'),
1382 $session->param('surname'), $session->param('branch'),
1383 $session->param('branchname'), $session->param('flags'),
1384 $session->param('emailaddress'), $session->param('branchprinter')
1387 my $ip = $session->param('ip');
1388 my $lasttime = $session->param('lasttime');
1389 my $userid = $session->param('id');
1390 if ( $lasttime < time() - $timeout ) {
1395 C4::Context->_unset_userenv($sessionID);
1398 return ( "expired", undef, undef );
1399 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1401 # IP address changed
1404 C4::Context->_unset_userenv($sessionID);
1407 return ( "expired", undef, undef );
1409 my $cookie = $query->cookie(
1410 -name => 'CGISESSID',
1411 -value => $session->id,
1414 $session->param( 'lasttime', time() );
1415 my $flags = haspermission( $userid, $flagsrequired );
1417 return ( "ok", $cookie, $sessionID );
1421 C4::Context->_unset_userenv($sessionID);
1424 return ( "failed", undef, undef );
1428 return ( "expired", undef, undef );
1433 my $userid = $query->param('userid');
1434 my $password = $query->param('password');
1435 my ( $return, $cardnumber );
1438 if ( $cas && $query->param('PT') ) {
1440 $debug and print STDERR "## check_api_auth - checking CAS\n";
1442 # In case of a CAS authentication, we use the ticket instead of the password
1443 my $PT = $query->param('PT');
1444 ( $return, $cardnumber, $userid ) = check_api_auth_cas( $dbh, $PT, $query ); # EXTERNAL AUTH
1447 # User / password auth
1448 unless ( $userid and $password ) {
1450 # caller did something wrong, fail the authenticateion
1451 return ( "failed", undef, undef );
1453 ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password, $query );
1456 if ( $return and haspermission( $userid, $flagsrequired ) ) {
1457 my $session = get_session("");
1458 return ( "failed", undef, undef ) unless $session;
1460 my $sessionID = $session->id;
1461 C4::Context->_new_userenv($sessionID);
1462 my $cookie = $query->cookie(
1463 -name => 'CGISESSID',
1464 -value => $sessionID,
1467 if ( $return == 1 ) {
1469 $borrowernumber, $firstname, $surname,
1470 $userflags, $branchcode, $branchname,
1471 $branchprinter, $emailaddress
1475 "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=?"
1477 $sth->execute($userid);
1479 $borrowernumber, $firstname, $surname,
1480 $userflags, $branchcode, $branchname,
1481 $branchprinter, $emailaddress
1482 ) = $sth->fetchrow if ( $sth->rows );
1484 unless ( $sth->rows ) {
1485 my $sth = $dbh->prepare(
1486 "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=?"
1488 $sth->execute($cardnumber);
1490 $borrowernumber, $firstname, $surname,
1491 $userflags, $branchcode, $branchname,
1492 $branchprinter, $emailaddress
1493 ) = $sth->fetchrow if ( $sth->rows );
1495 unless ( $sth->rows ) {
1496 $sth->execute($userid);
1498 $borrowernumber, $firstname, $surname, $userflags,
1499 $branchcode, $branchname, $branchprinter, $emailaddress
1500 ) = $sth->fetchrow if ( $sth->rows );
1504 my $ip = $ENV{'REMOTE_ADDR'};
1506 # if they specify at login, use that
1507 if ( $query->param('branch') ) {
1508 $branchcode = $query->param('branch');
1509 $branchname = GetBranchName($branchcode);
1511 my $branches = GetBranches();
1513 foreach my $br ( keys %$branches ) {
1515 # now we work with the treatment of ip
1516 my $domain = $branches->{$br}->{'branchip'};
1517 if ( $domain && $ip =~ /^$domain/ ) {
1518 $branchcode = $branches->{$br}->{'branchcode'};
1520 # new op dev : add the branchprinter and branchname in the cookie
1521 $branchprinter = $branches->{$br}->{'branchprinter'};
1522 $branchname = $branches->{$br}->{'branchname'};
1525 $session->param( 'number', $borrowernumber );
1526 $session->param( 'id', $userid );
1527 $session->param( 'cardnumber', $cardnumber );
1528 $session->param( 'firstname', $firstname );
1529 $session->param( 'surname', $surname );
1530 $session->param( 'branch', $branchcode );
1531 $session->param( 'branchname', $branchname );
1532 $session->param( 'flags', $userflags );
1533 $session->param( 'emailaddress', $emailaddress );
1534 $session->param( 'ip', $session->remote_addr() );
1535 $session->param( 'lasttime', time() );
1536 } elsif ( $return == 2 ) {
1538 #We suppose the user is the superlibrarian
1539 $session->param( 'number', 0 );
1540 $session->param( 'id', C4::Context->config('user') );
1541 $session->param( 'cardnumber', C4::Context->config('user') );
1542 $session->param( 'firstname', C4::Context->config('user') );
1543 $session->param( 'surname', C4::Context->config('user') );
1544 $session->param( 'branch', 'NO_LIBRARY_SET' );
1545 $session->param( 'branchname', 'NO_LIBRARY_SET' );
1546 $session->param( 'flags', 1 );
1547 $session->param( 'emailaddress', C4::Context->preference('KohaAdminEmailAddress') );
1548 $session->param( 'ip', $session->remote_addr() );
1549 $session->param( 'lasttime', time() );
1551 C4::Context->set_userenv(
1552 $session->param('number'), $session->param('id'),
1553 $session->param('cardnumber'), $session->param('firstname'),
1554 $session->param('surname'), $session->param('branch'),
1555 $session->param('branchname'), $session->param('flags'),
1556 $session->param('emailaddress'), $session->param('branchprinter')
1558 return ( "ok", $cookie, $sessionID );
1560 return ( "failed", undef, undef );
1565 =head2 check_cookie_auth
1567 ($status, $sessionId) = check_api_auth($cookie, $userflags);
1569 Given a CGISESSID cookie set during a previous login to Koha, determine
1570 if the user has the privileges specified by C<$userflags>.
1572 C<check_cookie_auth> is meant for authenticating special services
1573 such as tools/upload-file.pl that are invoked by other pages that
1574 have been authenticated in the usual way.
1576 Possible return values in C<$status> are:
1580 =item "ok" -- user authenticated; C<$sessionID> have valid values.
1582 =item "failed" -- credentials are not correct; C<$sessionid> are undef
1584 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1586 =item "expired -- session cookie has expired; API user should resubmit userid and password
1592 sub check_cookie_auth {
1594 my $flagsrequired = shift;
1596 my $dbh = C4::Context->dbh;
1597 my $timeout = _timeout_syspref();
1599 unless ( C4::Context->preference('Version') ) {
1601 # database has not been installed yet
1602 return ( "maintenance", undef );
1604 my $kohaversion = Koha::version();
1605 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1606 if ( C4::Context->preference('Version') < $kohaversion ) {
1608 # database in need of version update; assume that
1609 # no API should be called while databsae is in
1611 return ( "maintenance", undef );
1614 # FIXME -- most of what follows is a copy-and-paste
1615 # of code from checkauth. There is an obvious need
1616 # for refactoring to separate the various parts of
1617 # the authentication code, but as of 2007-11-23 this
1618 # is deferred so as to not introduce bugs into the
1619 # regular authentication code for Koha 3.0.
1621 # see if we have a valid session cookie already
1622 # however, if a userid parameter is present (i.e., from
1623 # a form submission, assume that any current cookie
1625 unless ( defined $cookie and $cookie ) {
1626 return ( "failed", undef );
1628 my $sessionID = $cookie;
1629 my $session = get_session($sessionID);
1630 C4::Context->_new_userenv($sessionID);
1632 C4::Context->set_userenv(
1633 $session->param('number'), $session->param('id'),
1634 $session->param('cardnumber'), $session->param('firstname'),
1635 $session->param('surname'), $session->param('branch'),
1636 $session->param('branchname'), $session->param('flags'),
1637 $session->param('emailaddress'), $session->param('branchprinter')
1640 my $ip = $session->param('ip');
1641 my $lasttime = $session->param('lasttime');
1642 my $userid = $session->param('id');
1643 if ( $lasttime < time() - $timeout ) {
1648 C4::Context->_unset_userenv($sessionID);
1651 return ("expired", undef);
1652 } elsif ( C4::Context->preference('SessionRestrictionByIP') && $ip ne $ENV{'REMOTE_ADDR'} ) {
1654 # IP address changed
1657 C4::Context->_unset_userenv($sessionID);
1660 return ( "expired", undef );
1662 $session->param( 'lasttime', time() );
1663 my $flags = haspermission( $userid, $flagsrequired );
1665 return ( "ok", $sessionID );
1669 C4::Context->_unset_userenv($sessionID);
1672 return ( "failed", undef );
1676 return ( "expired", undef );
1683 my $session = get_session($sessionID);
1685 Given a session ID, retrieve the CGI::Session object used to store
1686 the session's state. The session object can be used to store
1687 data that needs to be accessed by different scripts during a
1690 If the C<$sessionID> parameter is an empty string, a new session
1696 my $sessionID = shift;
1697 my $storage_method = C4::Context->preference('SessionStorage');
1698 my $dbh = C4::Context->dbh;
1700 if ( $storage_method eq 'mysql' ) {
1701 $session = new CGI::Session( "driver:MySQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1703 elsif ( $storage_method eq 'Pg' ) {
1704 $session = new CGI::Session( "driver:PostgreSQL;serializer:yaml;id:md5", $sessionID, { Handle => $dbh } );
1706 elsif ( $storage_method eq 'memcached' && C4::Context->ismemcached ) {
1707 $session = new CGI::Session( "driver:memcached;serializer:yaml;id:md5", $sessionID, { Memcached => C4::Context->memcached } );
1710 # catch all defaults to tmp should work on all systems
1711 $session = new CGI::Session( "driver:File;serializer:yaml;id:md5", $sessionID, { Directory => '/tmp' } );
1717 my ( $dbh, $userid, $password, $query, $type ) = @_;
1718 $type = 'opac' unless $type;
1720 $debug and print STDERR "## checkpw - checking LDAP\n";
1721 my ( $retval, $retcard, $retuserid ) = checkpw_ldap(@_); # EXTERNAL AUTH
1722 return 0 if $retval == -1; # Incorrect password for LDAP login attempt
1723 ($retval) and return ( $retval, $retcard, $retuserid );
1726 if ( $cas && $query && $query->param('ticket') ) {
1727 $debug and print STDERR "## checkpw - checking CAS\n";
1729 # In case of a CAS authentication, we use the ticket instead of the password
1730 my $ticket = $query->param('ticket');
1731 $query->delete('ticket'); # remove ticket to come back to original URL
1732 my ( $retval, $retcard, $retuserid ) = checkpw_cas( $dbh, $ticket, $query, $type ); # EXTERNAL AUTH
1733 ($retval) and return ( $retval, $retcard, $retuserid );
1737 # If we are in a shibboleth session (shibboleth is enabled, and a shibboleth match attribute is present)
1738 # Check for password to asertain whether we want to be testing against shibboleth or another method this
1740 if ( $shib && $shib_login && !$password ) {
1742 $debug and print STDERR "## checkpw - checking Shibboleth\n";
1744 # In case of a Shibboleth authentication, we expect a shibboleth user attribute
1745 # (defined under shibboleth mapping in koha-conf.xml) to contain the login of the
1746 # shibboleth-authenticated user
1748 # Then, we check if it matches a valid koha user
1750 my ( $retval, $retcard, $retuserid ) = C4::Auth_with_shibboleth::checkpw_shib($shib_login); # EXTERNAL AUTH
1751 ($retval) and return ( $retval, $retcard, $retuserid );
1757 return checkpw_internal(@_)
1760 sub checkpw_internal {
1761 my ( $dbh, $userid, $password ) = @_;
1763 $password = Encode::encode( 'UTF-8', $password )
1764 if Encode::is_utf8($password);
1766 if ( $userid && $userid eq C4::Context->config('user') ) {
1767 if ( $password && $password eq C4::Context->config('pass') ) {
1769 # Koha superuser account
1770 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1780 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where userid=?"
1782 $sth->execute($userid);
1784 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1785 $surname, $branchcode, $branchname, $flags )
1788 if ( checkpw_hash( $password, $stored_hash ) ) {
1790 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1791 $firstname, $surname, $branchcode, $branchname, $flags );
1792 return 1, $cardnumber, $userid;
1797 "select password,cardnumber,borrowernumber,userid,firstname,surname,borrowers.branchcode,branches.branchname,flags from borrowers join branches on borrowers.branchcode=branches.branchcode where cardnumber=?"
1799 $sth->execute($userid);
1801 my ( $stored_hash, $cardnumber, $borrowernumber, $userid, $firstname,
1802 $surname, $branchcode, $branchname, $flags )
1805 if ( checkpw_hash( $password, $stored_hash ) ) {
1807 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1808 $firstname, $surname, $branchcode, $branchname, $flags );
1809 return 1, $cardnumber, $userid;
1812 if ( $userid && $userid eq 'demo'
1813 && "$password" eq 'demo'
1814 && C4::Context->config('demo') )
1817 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1818 # some features won't be effective : modify systempref, modify MARC structure,
1825 my ( $password, $stored_hash ) = @_;
1827 return if $stored_hash eq '!';
1829 # check what encryption algorithm was implemented: Bcrypt - if the hash starts with '$2' it is Bcrypt else md5
1831 if ( substr( $stored_hash, 0, 2 ) eq '$2' ) {
1832 $hash = hash_password( $password, $stored_hash );
1834 $hash = md5_base64($password);
1836 return $hash eq $stored_hash;
1841 my $authflags = getuserflags($flags, $userid, [$dbh]);
1843 Translates integer flags into permissions strings hash.
1845 C<$flags> is the integer userflags value ( borrowers.userflags )
1846 C<$userid> is the members.userid, used for building subpermissions
1847 C<$authflags> is a hashref of permissions
1854 my $dbh = @_ ? shift : C4::Context->dbh;
1857 # I don't want to do this, but if someone logs in as the database
1858 # user, it would be preferable not to spam them to death with
1859 # numeric warnings. So, we make $flags numeric.
1860 no warnings 'numeric';
1863 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1866 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1867 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1868 $userflags->{$flag} = 1;
1871 $userflags->{$flag} = 0;
1875 # get subpermissions and merge with top-level permissions
1876 my $user_subperms = get_user_subpermissions($userid);
1877 foreach my $module ( keys %$user_subperms ) {
1878 next if $userflags->{$module} == 1; # user already has permission for everything in this module
1879 $userflags->{$module} = $user_subperms->{$module};
1885 =head2 get_user_subpermissions
1887 $user_perm_hashref = get_user_subpermissions($userid);
1889 Given the userid (note, not the borrowernumber) of a staff user,
1890 return a hashref of hashrefs of the specific subpermissions
1891 accorded to the user. An example return is
1895 export_catalog => 1,
1896 import_patrons => 1,
1900 The top-level hash-key is a module or function code from
1901 userflags.flag, while the second-level key is a code
1904 The results of this function do not give a complete picture
1905 of the functions that a staff user can access; it is also
1906 necessary to check borrowers.flags.
1910 sub get_user_subpermissions {
1913 my $dbh = C4::Context->dbh;
1914 my $sth = $dbh->prepare( "SELECT flag, user_permissions.code
1915 FROM user_permissions
1916 JOIN permissions USING (module_bit, code)
1917 JOIN userflags ON (module_bit = bit)
1918 JOIN borrowers USING (borrowernumber)
1919 WHERE userid = ?" );
1920 $sth->execute($userid);
1922 my $user_perms = {};
1923 while ( my $perm = $sth->fetchrow_hashref ) {
1924 $user_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1929 =head2 get_all_subpermissions
1931 my $perm_hashref = get_all_subpermissions();
1933 Returns a hashref of hashrefs defining all specific
1934 permissions currently defined. The return value
1935 has the same structure as that of C<get_user_subpermissions>,
1936 except that the innermost hash value is the description
1937 of the subpermission.
1941 sub get_all_subpermissions {
1942 my $dbh = C4::Context->dbh;
1943 my $sth = $dbh->prepare( "SELECT flag, code
1945 JOIN userflags ON (module_bit = bit)" );
1949 while ( my $perm = $sth->fetchrow_hashref ) {
1950 $all_perms->{ $perm->{'flag'} }->{ $perm->{'code'} } = 1;
1955 =head2 haspermission
1957 $flags = ($userid, $flagsrequired);
1959 C<$userid> the userid of the member
1960 C<$flags> is a hashref of required flags like C<$borrower-<{authflags}>
1962 Returns member's flags or 0 if a permission is not met.
1967 my ( $userid, $flagsrequired ) = @_;
1968 my $sth = C4::Context->dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1969 $sth->execute($userid);
1970 my $row = $sth->fetchrow();
1971 my $flags = getuserflags( $row, $userid );
1972 if ( $userid eq C4::Context->config('user') ) {
1974 # Super User Account from /etc/koha.conf
1975 $flags->{'superlibrarian'} = 1;
1977 elsif ( $userid eq 'demo' && C4::Context->config('demo') ) {
1979 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1980 $flags->{'superlibrarian'} = 1;
1983 return $flags if $flags->{superlibrarian};
1985 foreach my $module ( keys %$flagsrequired ) {
1986 my $subperm = $flagsrequired->{$module};
1987 if ( $subperm eq '*' ) {
1988 return 0 unless ( $flags->{$module} == 1 or ref( $flags->{$module} ) );
1991 ( defined $flags->{$module} and
1992 $flags->{$module} == 1 )
1994 ( ref( $flags->{$module} ) and
1995 exists $flags->{$module}->{$subperm} and
1996 $flags->{$module}->{$subperm} == 1 )
2002 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
2005 sub getborrowernumber {
2007 my $userenv = C4::Context->userenv;
2008 if ( defined($userenv) && ref($userenv) eq 'HASH' && $userenv->{number} ) {
2009 return $userenv->{number};
2011 my $dbh = C4::Context->dbh;
2012 for my $field ( 'userid', 'cardnumber' ) {
2014 $dbh->prepare("select borrowernumber from borrowers where $field=?");
2015 $sth->execute($userid);
2017 my ($bnumber) = $sth->fetchrow;
2024 END { } # module clean-up code here (global destructor)
2034 Crypt::Eksblowfish::Bcrypt(3)