3 # NOTE: This file uses 8-character tabs; do not change the tab size!
7 # Copyright 2000-2002 Katipo Communications
9 # This file is part of Koha.
11 # Koha is free software; you can redistribute it and/or modify it under the
12 # terms of the GNU General Public License as published by the Free Software
13 # Foundation; either version 2 of the License, or (at your option) any later
16 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
17 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
18 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
20 # You should have received a copy of the GNU General Public License along with
21 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
22 # Suite 330, Boston, MA 02111-1307 USA
25 use Digest::MD5 qw(md5_base64);
30 use C4::Output; # to get the template
33 use C4::Branch; # GetBranches
34 use C4::VirtualShelves 3.02 qw(GetShelvesSummary);
37 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS $debug $ldap);
40 $VERSION = 3.02; # set version for version checking
41 $debug = $ENV{DEBUG} || 0 ;
43 @EXPORT = qw(&checkauth &get_template_and_user);
44 @EXPORT_OK = qw(&check_api_auth &get_session &check_cookie_auth &checkpw);
45 $ldap = C4::Context->config('useldapserver') || 0;
47 require C4::Auth_with_ldap; # no import
48 import C4::Auth_with_ldap qw(checkpw_ldap);
54 C4::Auth - Authenticates Koha users
63 my ($template, $borrowernumber, $cookie)
64 = get_template_and_user(
66 template_name => "opac-main.tmpl",
70 flagsrequired => {borrow => 1},
82 The main function of this module is to provide
83 authentification. However the get_template_and_user function has
84 been provided so that a users login information is passed along
85 automatically. This gets loaded into the template.
91 =item get_template_and_user
93 my ($template, $borrowernumber, $cookie)
94 = get_template_and_user(
96 template_name => "opac-main.tmpl",
100 flagsrequired => {borrow => 1},
104 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
105 to C<&checkauth> (in this module) to perform authentification.
106 See C<&checkauth> for an explanation of these parameters.
108 The C<template_name> is then used to find the correct template for
109 the page. The authenticated users details are loaded onto the
110 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
111 C<sessionID> is passed to the template. This can be used in templates
112 if cookies are disabled. It needs to be put as and input to every
115 More information on the C<gettemplate> sub can be found in the
120 sub get_template_and_user {
123 gettemplate( $in->{'template_name'}, $in->{'type'}, $in->{'query'} );
124 my ( $user, $cookie, $sessionID, $flags ) = checkauth(
126 $in->{'authnotrequired'},
127 $in->{'flagsrequired'},
129 ) unless ($in->{'template_name'}=~/maintenance/);
132 my $insecure = C4::Context->preference('insecure');
133 if ($user or $insecure) {
135 # load the template variables for stylesheets and JavaScript
136 $template->param( css_libs => $in->{'css_libs'} );
137 $template->param( css_module => $in->{'css_module'} );
138 $template->param( css_page => $in->{'css_page'} );
139 $template->param( css_widgets => $in->{'css_widgets'} );
141 $template->param( js_libs => $in->{'js_libs'} );
142 $template->param( js_module => $in->{'js_module'} );
143 $template->param( js_page => $in->{'js_page'} );
144 $template->param( js_widgets => $in->{'js_widgets'} );
147 $template->param( loggedinusername => $user );
148 $template->param( sessionID => $sessionID );
150 if ($shelves = C4::Context->get_shelves_userenv()) {
151 $template->param( barshelves => scalar (@$shelves));
152 $template->param( barshelvesloop => $shelves);
155 $borrowernumber = getborrowernumber($user);
156 my ( $borr, $alternativeflags ) =
157 GetMemberDetails( $borrowernumber );
160 $template->param( "USER_INFO" => \@bordat );
162 my @flagroots = qw(circulate catalogue parameters borrowers permissions reserveforothers borrow
163 editcatalogue updatecharges management tools editauthorities serials reports);
164 # We are going to use the $flags returned by checkauth
165 # to create the template's parameters that will indicate
166 # which menus the user can access.
167 if (( $flags && $flags->{superlibrarian}==1) or $insecure==1) {
168 $template->param( CAN_user_circulate => 1 );
169 $template->param( CAN_user_catalogue => 1 );
170 $template->param( CAN_user_parameters => 1 );
171 $template->param( CAN_user_borrowers => 1 );
172 $template->param( CAN_user_permission => 1 );
173 $template->param( CAN_user_reserveforothers => 1 );
174 $template->param( CAN_user_borrow => 1 );
175 $template->param( CAN_user_editcatalogue => 1 );
176 $template->param( CAN_user_updatecharges => 1 );
177 $template->param( CAN_user_acquisition => 1 );
178 $template->param( CAN_user_management => 1 );
179 $template->param( CAN_user_tools => 1 );
180 $template->param( CAN_user_editauthorities => 1 );
181 $template->param( CAN_user_serials => 1 );
182 $template->param( CAN_user_reports => 1 );
183 $template->param( CAN_user_staffaccess => 1 );
186 if ( $flags && $flags->{circulate} == 1 ) {
187 $template->param( CAN_user_circulate => 1 );
190 if ( $flags && $flags->{catalogue} == 1 ) {
191 $template->param( CAN_user_catalogue => 1 );
194 if ( $flags && $flags->{parameters} == 1 ) {
195 $template->param( CAN_user_parameters => 1 );
196 $template->param( CAN_user_management => 1 );
199 if ( $flags && $flags->{borrowers} == 1 ) {
200 $template->param( CAN_user_borrowers => 1 );
203 if ( $flags && $flags->{permissions} == 1 ) {
204 $template->param( CAN_user_permission => 1 );
207 if ( $flags && $flags->{reserveforothers} == 1 ) {
208 $template->param( CAN_user_reserveforothers => 1 );
211 if ( $flags && $flags->{borrow} == 1 ) {
212 $template->param( CAN_user_borrow => 1 );
215 if ( $flags && $flags->{editcatalogue} == 1 ) {
216 $template->param( CAN_user_editcatalogue => 1 );
219 if ( $flags && $flags->{updatecharges} == 1 ) {
220 $template->param( CAN_user_updatecharges => 1 );
223 if ( $flags && $flags->{acquisition} == 1 ) {
224 $template->param( CAN_user_acquisition => 1 );
227 if ( $flags && $flags->{tools} == 1 ) {
228 $template->param( CAN_user_tools => 1 );
231 if ( $flags && $flags->{editauthorities} == 1 ) {
232 $template->param( CAN_user_editauthorities => 1 );
235 if ( $flags && $flags->{serials} == 1 ) {
236 $template->param( CAN_user_serials => 1 );
239 if ( $flags && $flags->{reports} == 1 ) {
240 $template->param( CAN_user_reports => 1 );
242 if ( $flags && $flags->{staffaccess} == 1 ) {
243 $template->param( CAN_user_staffaccess => 1 );
246 if ( $in->{'type'} eq "intranet" ) {
248 intranetcolorstylesheet => C4::Context->preference("intranetcolorstylesheet"),
249 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
250 IntranetNav => C4::Context->preference("IntranetNav"),
251 intranetuserjs => C4::Context->preference("intranetuserjs"),
252 TemplateEncoding => C4::Context->preference("TemplateEncoding"),
253 AmazonContent => C4::Context->preference("AmazonContent"),
254 LibraryName => C4::Context->preference("LibraryName"),
255 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
256 LoginBranchname => (C4::Context->userenv?C4::Context->userenv->{"branchname"}:"insecure"),
257 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
258 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
259 AutoLocation => C4::Context->preference("AutoLocation"),
260 hide_marc => C4::Context->preference("hide_marc"),
261 patronimages => C4::Context->preference("patronimages"),
262 "BiblioDefaultView".C4::Context->preference("IntranetBiblioDefaultView") => 1,
263 advancedMARCEditor => C4::Context->preference("advancedMARCEditor"),
264 suggestion => C4::Context->preference("suggestion"),
265 virtualshelves => C4::Context->preference("virtualshelves"),
266 LibraryName => C4::Context->preference("LibraryName"),
267 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
268 IntranetmainUserblock => C4::Context->preference("IntranetmainUserblock"),
269 IndependantBranches => C4::Context->preference("IndependantBranches"),
270 CircAutocompl => C4::Context->preference("CircAutocompl"),
271 yuipath => C4::Context->preference("yuipath"),
272 FRBRizeEditions => C4::Context->preference("FRBRizeEditions"),
273 AmazonSimilarItems => C4::Context->preference("AmazonSimilarItems"),
274 'item-level_itypes' => C4::Context->preference('item-level_itypes'),
275 canreservefromotherbranches => C4::Context->preference('canreservefromotherbranches'),
276 intranetreadinghistory => C4::Context->preference("intranetreadinghistory"),
277 noItemTypeImages => C4::Context->preference("noItemTypeImages"),
281 warn "template type should be OPAC, here it is=[" . $in->{'type'} . "]" unless ( $in->{'type'} eq 'opac' );
282 my $LibraryNameTitle = C4::Context->preference("LibraryName");
283 $LibraryNameTitle =~ s/<(?:\/?)(?:br|p)\s*(?:\/?)>/ /sgi;
284 $LibraryNameTitle =~ s/<(?:[^<>'"]|'(?:[^']*)'|"(?:[^"]*)")*>//sg;
286 KohaAdminEmailAddress => "" . C4::Context->preference("KohaAdminEmailAddress"),
287 AnonSuggestions => "" . C4::Context->preference("AnonSuggestions"),
288 suggestion => "" . C4::Context->preference("suggestion"),
289 OPACViewOthersSuggestions => "" . C4::Context->preference("OPACViewOthersSuggestions"),
290 virtualshelves => "" . C4::Context->preference("virtualshelves"),
291 OpacNav => "" . C4::Context->preference("OpacNav"),
292 opacheader => "" . C4::Context->preference("opacheader"),
293 opaccredits => "" . C4::Context->preference("opaccredits"),
294 opacsmallimage => "" . C4::Context->preference("opacsmallimage"),
295 opaclargeimage => "" . C4::Context->preference("opaclargeimage"),
296 opaclayoutstylesheet => "". C4::Context->preference("opaclayoutstylesheet"),
297 opaccolorstylesheet => "". C4::Context->preference("opaccolorstylesheet"),
298 OPACUserCSS => "". C4::Context->preference("OPACUserCSS"),
299 opaclanguagesdisplay => "". C4::Context->preference("opaclanguagesdisplay"),
300 opacuserlogin => "" . C4::Context->preference("opacuserlogin"),
301 OpacMainUserBlock => "" . C4::Context->preference("OpacMainUserBlock"),
302 OPACURLOpenInNewWindow => "" . C4::Context->preference("OPACURLOpenInNewWindow"),
303 opacbookbag => "" . C4::Context->preference("opacbookbag"),
304 TemplateEncoding => "". C4::Context->preference("TemplateEncoding"),
305 AmazonContent => "" . C4::Context->preference("AmazonContent"),
306 OPACShelfBrowser => "". C4::Context->preference("OPACShelfBrowser"),
307 OPACAmazonSimilarItems => "" . C4::Context->preference("OPACAmazonSimilarItems"),
308 LibraryName => "" . C4::Context->preference("LibraryName"),
309 LibraryNameTitle => "" . $LibraryNameTitle,
310 LoginBranchcode => (C4::Context->userenv?C4::Context->userenv->{"branch"}:"insecure"),
311 LoginBranchname => C4::Context->userenv?C4::Context->userenv->{"branchname"}:"",
312 LoginFirstname => (C4::Context->userenv?C4::Context->userenv->{"firstname"}:"Bel"),
313 LoginSurname => C4::Context->userenv?C4::Context->userenv->{"surname"}:"Inconnu",
314 OpacPasswordChange => C4::Context->preference("OpacPasswordChange"),
315 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
316 opacuserjs => C4::Context->preference("opacuserjs"),
317 OpacCloud => C4::Context->preference("OpacCloud"),
318 OpacTopissue => C4::Context->preference("OpacTopissue"),
319 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
320 OpacBrowser => C4::Context->preference("OpacBrowser"),
321 RequestOnOpac => C4::Context->preference("RequestOnOpac"),
322 reviewson => C4::Context->preference("reviewson"),
323 hide_marc => C4::Context->preference("hide_marc"),
324 patronimages => C4::Context->preference("patronimages"),
325 hidelostitems => C4::Context->preference("hidelostitems"),
326 mylibraryfirst => C4::Context->preference("SearchMyLibraryFirst"),
327 "BiblioDefaultView".C4::Context->preference("BiblioDefaultView") => 1,
328 OPACFRBRizeEditions => C4::Context->preference("OPACFRBRizeEditions"),
329 'item-level_itypes' => C4::Context->preference('item-level_itypes'),
330 'Version' => C4::Context->preference('Version'),
331 yuipath => C4::Context->preference("yuipath"),
334 $template->param(listloop=>[{shelfname=>"Freelist", shelfnumber=>110}]);
335 return ( $template, $borrowernumber, $cookie, $flags);
340 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
342 Verifies that the user is authorized to run this script. If
343 the user is authorized, a (userid, cookie, session-id, flags)
344 quadruple is returned. If the user is not authorized but does
345 not have the required privilege (see $flagsrequired below), it
346 displays an error page and exits. Otherwise, it displays the
347 login page and exits.
349 Note that C<&checkauth> will return if and only if the user
350 is authorized, so it should be called early on, before any
351 unfinished operations (e.g., if you've opened a file, then
352 C<&checkauth> won't close it for you).
354 C<$query> is the CGI object for the script calling C<&checkauth>.
356 The C<$noauth> argument is optional. If it is set, then no
357 authorization is required for the script.
359 C<&checkauth> fetches user and session information from C<$query> and
360 ensures that the user is authorized to run scripts that require
363 The C<$flagsrequired> argument specifies the required privileges
364 the user must have if the username and password are correct.
365 It should be specified as a reference-to-hash; keys in the hash
366 should be the "flags" for the user, as specified in the Members
367 intranet module. Any key specified must correspond to a "flag"
368 in the userflags table. E.g., { circulate => 1 } would specify
369 that the user must have the "circulate" privilege in order to
370 proceed. To make sure that access control is correct, the
371 C<$flagsrequired> parameter must be specified correctly.
373 The C<$type> argument specifies whether the template should be
374 retrieved from the opac or intranet directory tree. "opac" is
375 assumed if it is not specified; however, if C<$type> is specified,
376 "intranet" is assumed if it is not "opac".
378 If C<$query> does not have a valid session ID associated with it
379 (i.e., the user has not logged in) or if the session has expired,
380 C<&checkauth> presents the user with a login page (from the point of
381 view of the original script, C<&checkauth> does not return). Once the
382 user has authenticated, C<&checkauth> restarts the original script
383 (this time, C<&checkauth> returns).
385 The login page is provided using a HTML::Template, which is set in the
386 systempreferences table or at the top of this file. The variable C<$type>
387 selects which template to use, either the opac or the intranet
388 authentification template.
390 C<&checkauth> returns a user ID, a cookie, and a session ID. The
391 cookie should be sent back to the browser; it verifies that the user
396 sub _version_check ($$) {
400 # If Version syspref is unavailable, it means Koha is beeing installed,
401 # and so we must redirect to OPAC maintenance page or to the WebInstaller
402 #warn "about to check version";
403 unless ($version = C4::Context->preference('Version')) { # assignment, not comparison
404 if ($type ne 'opac') {
405 warn "Install required, redirecting to Installer";
406 print $query->redirect("/cgi-bin/koha/installer/install.pl");
409 warn "OPAC Install required, redirecting to maintenance";
410 print $query->redirect("/cgi-bin/koha/maintenance.pl");
415 # check that database and koha version are the same
416 # there is no DB version, it's a fresh install,
417 # go to web installer
418 # there is a DB version, compare it to the code version
419 my $kohaversion=C4::Context::KOHAVERSION;
420 # remove the 3 last . to have a Perl number
421 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
422 $debug and print STDERR "kohaversion : $kohaversion\n";
423 if ($version < $kohaversion){
424 my $warning = "Database update needed, redirecting to %s. Database is $version and Koha is $kohaversion";
425 if ($type ne 'opac'){
426 warn sprintf($warning, 'Installer');
427 print $query->redirect("/cgi-bin/koha/installer/install.pl?step=3");
429 warn sprintf("OPAC: " . $warning, 'maintenance');
430 print $query->redirect("/cgi-bin/koha/maintenance.pl");
438 open L, ">>/tmp/sessionlog" or warn "ERROR: Cannot append to /tmp/sessionlog";
439 printf L join("\n",@_);
445 $debug and warn "Checking Auth";
446 # $authnotrequired will be set for scripts which will run without authentication
447 my $authnotrequired = shift;
448 my $flagsrequired = shift;
450 $type = 'opac' unless $type;
452 my $dbh = C4::Context->dbh;
453 my $timeout = C4::Context->preference('timeout');
455 if ($timeout =~ /(\d+)[dD]/) {
456 $timeout = $1 * 86400;
458 $timeout = 600 unless $timeout;
460 _version_check($type,$query);
464 my ( $userid, $cookie, $sessionID, $flags, $shelves );
465 my $logout = $query->param('logout.x');
466 if ( $userid = $ENV{'REMOTE_USER'} ) {
467 # Using Basic Authentication, no cookies required
468 $cookie = $query->cookie(
469 -name => 'CGISESSID',
475 elsif ( $sessionID = $query->cookie("CGISESSID")) { # assignment, not comparison
476 my $session = get_session($sessionID);
477 C4::Context->_new_userenv($sessionID);
480 C4::Context::set_userenv(
481 $session->param('number'), $session->param('id'),
482 $session->param('cardnumber'), $session->param('firstname'),
483 $session->param('surname'), $session->param('branch'),
484 $session->param('branchname'), $session->param('flags'),
485 $session->param('emailaddress'), $session->param('branchprinter')
487 C4::Context::set_shelves_userenv($session->param('shelves'));
488 $debug and printf STDERR "AUTH_SESSION: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
489 $ip = $session->param('ip');
490 $lasttime = $session->param('lasttime');
491 $userid = $session->param('id');
495 # voluntary logout the user
498 C4::Context->_unset_userenv($sessionID);
499 _session_log(sprintf "%20s from %16s logged out at %30s (manually).\n", $userid,$ip,localtime);
503 elsif ( $lasttime < time() - $timeout ) {
505 $info{'timed_out'} = 1;
507 C4::Context->_unset_userenv($sessionID);
508 _session_log(sprintf "%20s from %16s logged out at %30s (inactivity).\n", $userid,$ip,localtime);
512 elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
513 # Different ip than originally logged in from
514 $info{'oldip'} = $ip;
515 $info{'newip'} = $ENV{'REMOTE_ADDR'};
516 $info{'different_ip'} = 1;
518 C4::Context->_unset_userenv($sessionID);
519 _session_log(sprintf "%20s from %16s logged out at %30s (ip changed to %16s).\n", $userid,$ip,localtime, $info{'newip'});
524 $cookie = $query->cookie( CGISESSID => $session->id );
525 $session->param('lasttime',time());
526 $flags = haspermission( $dbh, $userid, $flagsrequired );
530 $info{'nopermission'} = 1;
535 my $session = get_session("") or die "Auth ERROR: Cannot get_session()";
536 my $sessionID = $session->id;
537 $userid = $query->param('userid');
538 my $password = $query->param('password');
539 C4::Context->_new_userenv($sessionID);
540 my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
542 _session_log(sprintf "%20s from %16s logged in at %30s.\n", $userid,$ENV{'REMOTE_ADDR'},localtime);
543 $cookie = $query->cookie(CGISESSID => $sessionID);
544 if ( $flags = haspermission( $dbh, $userid, $flagsrequired ) ) {
548 $info{'nopermission'} = 1;
549 C4::Context->_unset_userenv($sessionID);
552 my ($borrowernumber, $firstname, $surname, $userflags,
553 $branchcode, $branchname, $branchprinter, $emailaddress);
555 if ( $return == 1 ) {
557 SELECT borrowernumber, firstname, surname, flags, borrowers.branchcode,
558 branches.branchname as branchname,
559 branches.branchprinter as branchprinter,
562 LEFT JOIN branches on borrowers.branchcode=branches.branchcode
564 my $sth = $dbh->prepare("$select where userid=?");
565 $sth->execute($userid);
566 unless ($sth->rows) {
567 $debug and print STDERR "AUTH_1: no rows for userid='$userid'\n";
568 $sth = $dbh->prepare("$select where cardnumber=?");
569 $sth->execute($cardnumber);
570 unless ($sth->rows) {
571 $debug and print STDERR "AUTH_2a: no rows for cardnumber='$cardnumber'\n";
572 $sth->execute($userid);
573 unless ($sth->rows) {
574 $debug and print STDERR "AUTH_2b: no rows for userid='$userid' AS cardnumber\n";
579 ($borrowernumber, $firstname, $surname, $userflags,
580 $branchcode, $branchname, $branchprinter, $emailaddress) = $sth->fetchrow;
581 $debug and print STDERR "AUTH_3 results: " .
582 "$cardnumber,$borrowernumber,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress\n";
584 print STDERR "AUTH_3: no results for userid='$userid', cardnumber='$cardnumber'.\n";
587 # launch a sequence to check if we have a ip for the branch, i
588 # if we have one we replace the branchcode of the userenv by the branch bound in the ip.
590 my $ip = $ENV{'REMOTE_ADDR'};
591 # if they specify at login, use that
592 if ($query->param('branch')) {
593 $branchcode = $query->param('branch');
594 $branchname = GetBranchName($branchcode);
596 my $branches = GetBranches();
597 if (C4::Context->boolean_preference('IndependantBranches') && C4::Context->boolean_preference('Autolocation')){
598 # we have to check they are coming from the right ip range
599 my $domain = $branches->{$branchcode}->{'branchip'};
600 if ($ip !~ /^$domain/){
602 $info{'wrongip'} = 1;
607 foreach my $br ( keys %$branches ) {
608 # now we work with the treatment of ip
609 my $domain = $branches->{$br}->{'branchip'};
610 if ( $domain && $ip =~ /^$domain/ ) {
611 $branchcode = $branches->{$br}->{'branchcode'};
613 # new op dev : add the branchprinter and branchname in the cookie
614 $branchprinter = $branches->{$br}->{'branchprinter'};
615 $branchname = $branches->{$br}->{'branchname'};
618 $session->param('number',$borrowernumber);
619 $session->param('id',$userid);
620 $session->param('cardnumber',$cardnumber);
621 $session->param('firstname',$firstname);
622 $session->param('surname',$surname);
623 $session->param('branch',$branchcode);
624 $session->param('branchname',$branchname);
625 $session->param('flags',$userflags);
626 $session->param('emailaddress',$emailaddress);
627 $session->param('ip',$session->remote_addr());
628 $session->param('lasttime',time());
629 $debug and printf STDERR "AUTH_4: (%s)\t%s %s - %s\n", map {$session->param($_)} qw(cardnumber firstname surname branch) ;
631 elsif ( $return == 2 ) {
632 #We suppose the user is the superlibrarian
634 $session->param('number',0);
635 $session->param('id',C4::Context->config('user'));
636 $session->param('cardnumber',C4::Context->config('user'));
637 $session->param('firstname',C4::Context->config('user'));
638 $session->param('surname',C4::Context->config('user'));
639 $session->param('branch','NO_LIBRARY_SET');
640 $session->param('branchname','NO_LIBRARY_SET');
641 $session->param('flags',1);
642 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
643 $session->param('ip',$session->remote_addr());
644 $session->param('lasttime',time());
646 C4::Context::set_userenv(
647 $session->param('number'), $session->param('id'),
648 $session->param('cardnumber'), $session->param('firstname'),
649 $session->param('surname'), $session->param('branch'),
650 $session->param('branchname'), $session->param('flags'),
651 $session->param('emailaddress'), $session->param('branchprinter')
653 $shelves = GetShelvesSummary($borrowernumber,2,10);
654 $session->param('shelves', $shelves);
655 C4::Context::set_shelves_userenv($shelves);
659 $info{'invalid_username_or_password'} = 1;
660 C4::Context->_unset_userenv($sessionID);
664 } # END unless ($userid)
665 my $insecure = C4::Context->boolean_preference('insecure');
667 # finished authentification, now respond
668 if ( $loggedin || $authnotrequired || ( defined($insecure) && $insecure ) )
672 $cookie = $query->cookie( CGISESSID => '' );
674 return ( $userid, $cookie, $sessionID, $flags );
679 # AUTH rejected, show the login/password template, after checking the DB.
683 # get the inputs from the incoming query
685 foreach my $name ( param $query) {
686 (next) if ( $name eq 'userid' || $name eq 'password' );
687 my $value = $query->param($name);
688 push @inputs, { name => $name, value => $value };
690 # get the branchloop, which we need for authentication
691 my $branches = GetBranches();
693 for my $branch_hash (sort keys %$branches) {
694 push @branch_loop, {branchcode => "$branch_hash", branchname => $branches->{$branch_hash}->{'branchname'}, };
697 my $template_name = ( $type eq 'opac' ) ? 'opac-auth.tmpl' : 'auth.tmpl';
698 my $template = gettemplate( $template_name, $type, $query );
699 $template->param(branchloop => \@branch_loop,);
703 suggestion => C4::Context->preference("suggestion"),
704 virtualshelves => C4::Context->preference("virtualshelves"),
705 opaclargeimage => C4::Context->preference("opaclargeimage"),
706 LibraryName => C4::Context->preference("LibraryName"),
707 opacuserlogin => C4::Context->preference("opacuserlogin"),
708 OpacNav => C4::Context->preference("OpacNav"),
709 opaccredits => C4::Context->preference("opaccredits"),
710 opacreadinghistory => C4::Context->preference("opacreadinghistory"),
711 opacsmallimage => C4::Context->preference("opacsmallimage"),
712 opaclayoutstylesheet => C4::Context->preference("opaclayoutstylesheet"),
713 opaccolorstylesheet => C4::Context->preference("opaccolorstylesheet"),
714 opaclanguagesdisplay => C4::Context->preference("opaclanguagesdisplay"),
715 opacuserjs => C4::Context->preference("opacuserjs"),
716 opacbookbag => "" . C4::Context->preference("opacbookbag"),
717 OpacCloud => C4::Context->preference("OpacCloud"),
718 OpacTopissue => C4::Context->preference("OpacTopissue"),
719 OpacAuthorities => C4::Context->preference("OpacAuthorities"),
720 OpacBrowser => C4::Context->preference("OpacBrowser"),
721 intranetcolorstylesheet =>
722 C4::Context->preference("intranetcolorstylesheet"),
723 intranetstylesheet => C4::Context->preference("intranetstylesheet"),
724 IntranetNav => C4::Context->preference("IntranetNav"),
725 intranetuserjs => C4::Context->preference("intranetuserjs"),
726 TemplateEncoding => C4::Context->preference("TemplateEncoding"),
727 IndependantBranches=> C4::Context->preference("IndependantBranches"),
728 AutoLocation => C4::Context->preference("AutoLocation"),
729 yuipath => C4::Context->preference("yuipath"),
730 wrongip => $info{'wrongip'}
733 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
735 my $self_url = $query->url( -absolute => 1 );
738 LibraryName => C4::Context->preference("LibraryName"),
740 $template->param( \%info );
741 # $cookie = $query->cookie(CGISESSID => $session->id
743 print $query->header(
744 -type => 'text/html',
754 ($status, $cookie, $sessionId) = check_api_auth($query, $userflags);
756 Given a CGI query containing the parameters 'userid' and 'password' and/or a session
757 cookie, determine if the user has the privileges specified by C<$userflags>.
759 C<check_api_auth> is is meant for authenticating users of web services, and
760 consequently will always return and will not attempt to redirect the user
763 If a valid session cookie is already present, check_api_auth will return a status
764 of "ok", the cookie, and the Koha session ID.
766 If no session cookie is present, check_api_auth will check the 'userid' and 'password
767 parameters and create a session cookie and Koha session if the supplied credentials
770 Possible return values in C<$status> are:
774 =item "ok" -- user authenticated; C<$cookie> and C<$sessionid> have valid values.
776 =item "failed" -- credentials are not correct; C<$cookie> and C<$sessionid> are undef
778 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
780 =item "expired -- session cookie has expired; API user should resubmit userid and password
788 my $flagsrequired = shift;
790 my $dbh = C4::Context->dbh;
791 my $timeout = C4::Context->preference('timeout');
792 $timeout = 600 unless $timeout;
794 unless (C4::Context->preference('Version')) {
795 # database has not been installed yet
796 return ("maintenance", undef, undef);
798 my $kohaversion=C4::Context::KOHAVERSION;
799 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
800 if (C4::Context->preference('Version') < $kohaversion) {
801 # database in need of version update; assume that
802 # no API should be called while databsae is in
804 return ("maintenance", undef, undef);
807 # FIXME -- most of what follows is a copy-and-paste
808 # of code from checkauth. There is an obvious need
809 # for refactoring to separate the various parts of
810 # the authentication code, but as of 2007-11-19 this
811 # is deferred so as to not introduce bugs into the
812 # regular authentication code for Koha 3.0.
814 # see if we have a valid session cookie already
815 # however, if a userid parameter is present (i.e., from
816 # a form submission, assume that any current cookie
818 my $sessionID = undef;
819 unless ($query->param('userid')) {
820 $sessionID = $query->cookie("CGISESSID");
823 my $session = get_session($sessionID);
824 C4::Context->_new_userenv($sessionID);
826 C4::Context::set_userenv(
827 $session->param('number'), $session->param('id'),
828 $session->param('cardnumber'), $session->param('firstname'),
829 $session->param('surname'), $session->param('branch'),
830 $session->param('branchname'), $session->param('flags'),
831 $session->param('emailaddress'), $session->param('branchprinter')
834 my $ip = $session->param('ip');
835 my $lasttime = $session->param('lasttime');
836 my $userid = $session->param('id');
837 if ( $lasttime < time() - $timeout ) {
840 C4::Context->_unset_userenv($sessionID);
843 return ("expired", undef, undef);
844 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
847 C4::Context->_unset_userenv($sessionID);
850 return ("expired", undef, undef);
852 my $cookie = $query->cookie( CGISESSID => $session->id );
853 $session->param('lasttime',time());
854 my $flags = haspermission( $dbh, $userid, $flagsrequired );
856 return ("ok", $cookie, $sessionID);
859 C4::Context->_unset_userenv($sessionID);
862 return ("failed", undef, undef);
866 return ("expired", undef, undef);
870 my $userid = $query->param('userid');
871 my $password = $query->param('password');
872 unless ($userid and $password) {
873 # caller did something wrong, fail the authenticateion
874 return ("failed", undef, undef);
876 my ( $return, $cardnumber ) = checkpw( $dbh, $userid, $password );
877 if ($return and haspermission( $dbh, $userid, $flagsrequired)) {
878 my $session = get_session("");
879 return ("failed", undef, undef) unless $session;
881 my $sessionID = $session->id;
882 C4::Context->_new_userenv($sessionID);
883 my $cookie = $query->cookie(CGISESSID => $sessionID);
884 if ( $return == 1 ) {
886 $borrowernumber, $firstname, $surname,
887 $userflags, $branchcode, $branchname,
888 $branchprinter, $emailaddress
892 "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=?"
894 $sth->execute($userid);
896 $borrowernumber, $firstname, $surname,
897 $userflags, $branchcode, $branchname,
898 $branchprinter, $emailaddress
899 ) = $sth->fetchrow if ( $sth->rows );
901 unless ($sth->rows ) {
902 my $sth = $dbh->prepare(
903 "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=?"
905 $sth->execute($cardnumber);
907 $borrowernumber, $firstname, $surname,
908 $userflags, $branchcode, $branchname,
909 $branchprinter, $emailaddress
910 ) = $sth->fetchrow if ( $sth->rows );
912 unless ( $sth->rows ) {
913 $sth->execute($userid);
915 $borrowernumber, $firstname, $surname, $userflags,
916 $branchcode, $branchname, $branchprinter, $emailaddress
917 ) = $sth->fetchrow if ( $sth->rows );
921 my $ip = $ENV{'REMOTE_ADDR'};
922 # if they specify at login, use that
923 if ($query->param('branch')) {
924 $branchcode = $query->param('branch');
925 $branchname = GetBranchName($branchcode);
927 my $branches = GetBranches();
929 foreach my $br ( keys %$branches ) {
930 # now we work with the treatment of ip
931 my $domain = $branches->{$br}->{'branchip'};
932 if ( $domain && $ip =~ /^$domain/ ) {
933 $branchcode = $branches->{$br}->{'branchcode'};
935 # new op dev : add the branchprinter and branchname in the cookie
936 $branchprinter = $branches->{$br}->{'branchprinter'};
937 $branchname = $branches->{$br}->{'branchname'};
940 $session->param('number',$borrowernumber);
941 $session->param('id',$userid);
942 $session->param('cardnumber',$cardnumber);
943 $session->param('firstname',$firstname);
944 $session->param('surname',$surname);
945 $session->param('branch',$branchcode);
946 $session->param('branchname',$branchname);
947 $session->param('flags',$userflags);
948 $session->param('emailaddress',$emailaddress);
949 $session->param('ip',$session->remote_addr());
950 $session->param('lasttime',time());
951 } elsif ( $return == 2 ) {
952 #We suppose the user is the superlibrarian
953 $session->param('number',0);
954 $session->param('id',C4::Context->config('user'));
955 $session->param('cardnumber',C4::Context->config('user'));
956 $session->param('firstname',C4::Context->config('user'));
957 $session->param('surname',C4::Context->config('user'));
958 $session->param('branch','NO_LIBRARY_SET');
959 $session->param('branchname','NO_LIBRARY_SET');
960 $session->param('flags',1);
961 $session->param('emailaddress', C4::Context->preference('KohaAdminEmailAddress'));
962 $session->param('ip',$session->remote_addr());
963 $session->param('lasttime',time());
965 C4::Context::set_userenv(
966 $session->param('number'), $session->param('id'),
967 $session->param('cardnumber'), $session->param('firstname'),
968 $session->param('surname'), $session->param('branch'),
969 $session->param('branchname'), $session->param('flags'),
970 $session->param('emailaddress'), $session->param('branchprinter')
972 return ("ok", $cookie, $sessionID);
974 return ("failed", undef, undef);
979 =item check_cookie_auth
981 ($status, $sessionId) = check_api_auth($cookie, $userflags);
983 Given a CGISESSID cookie set during a previous login to Koha, determine
984 if the user has the privileges specified by C<$userflags>.
986 C<check_cookie_auth> is meant for authenticating special services
987 such as tools/upload-file.pl that are invoked by other pages that
988 have been authenticated in the usual way.
990 Possible return values in C<$status> are:
994 =item "ok" -- user authenticated; C<$sessionID> have valid values.
996 =item "failed" -- credentials are not correct; C<$sessionid> are undef
998 =item "maintenance" -- DB is in maintenance mode; no login possible at the moment
1000 =item "expired -- session cookie has expired; API user should resubmit userid and password
1006 sub check_cookie_auth {
1008 my $flagsrequired = shift;
1010 my $dbh = C4::Context->dbh;
1011 my $timeout = C4::Context->preference('timeout');
1012 $timeout = 600 unless $timeout;
1014 unless (C4::Context->preference('Version')) {
1015 # database has not been installed yet
1016 return ("maintenance", undef);
1018 my $kohaversion=C4::Context::KOHAVERSION;
1019 $kohaversion =~ s/(.*\..*)\.(.*)\.(.*)/$1$2$3/;
1020 if (C4::Context->preference('Version') < $kohaversion) {
1021 # database in need of version update; assume that
1022 # no API should be called while databsae is in
1024 return ("maintenance", undef);
1027 # FIXME -- most of what follows is a copy-and-paste
1028 # of code from checkauth. There is an obvious need
1029 # for refactoring to separate the various parts of
1030 # the authentication code, but as of 2007-11-23 this
1031 # is deferred so as to not introduce bugs into the
1032 # regular authentication code for Koha 3.0.
1034 # see if we have a valid session cookie already
1035 # however, if a userid parameter is present (i.e., from
1036 # a form submission, assume that any current cookie
1038 unless (defined $cookie and $cookie) {
1039 return ("failed", undef);
1041 my $sessionID = $cookie;
1042 my $session = get_session($sessionID);
1043 C4::Context->_new_userenv($sessionID);
1045 C4::Context::set_userenv(
1046 $session->param('number'), $session->param('id'),
1047 $session->param('cardnumber'), $session->param('firstname'),
1048 $session->param('surname'), $session->param('branch'),
1049 $session->param('branchname'), $session->param('flags'),
1050 $session->param('emailaddress'), $session->param('branchprinter')
1053 my $ip = $session->param('ip');
1054 my $lasttime = $session->param('lasttime');
1055 my $userid = $session->param('id');
1056 if ( $lasttime < time() - $timeout ) {
1059 C4::Context->_unset_userenv($sessionID);
1062 return ("expired", undef);
1063 } elsif ( $ip ne $ENV{'REMOTE_ADDR'} ) {
1064 # IP address changed
1066 C4::Context->_unset_userenv($sessionID);
1069 return ("expired", undef);
1071 $session->param('lasttime',time());
1072 my $flags = haspermission( $dbh, $userid, $flagsrequired );
1074 return ("ok", $sessionID);
1077 C4::Context->_unset_userenv($sessionID);
1080 return ("failed", undef);
1084 return ("expired", undef);
1091 my $session = get_session($sessionID);
1093 Given a session ID, retrieve the CGI::Session object used to store
1094 the session's state. The session object can be used to store
1095 data that needs to be accessed by different scripts during a
1098 If the C<$sessionID> parameter is an empty string, a new session
1104 my $sessionID = shift;
1105 my $storage_method = C4::Context->preference('SessionStorage');
1106 my $dbh = C4::Context->dbh;
1108 if ($storage_method eq 'mysql'){
1109 $session = new CGI::Session("driver:MySQL;serializer:yaml", $sessionID, {Handle=>$dbh});
1111 elsif ($storage_method eq 'Pg') {
1112 $session = new CGI::Session("driver:PostgreSQL;serializer:yaml", $sessionID, {Handle=>$dbh});
1115 # catch all defaults to tmp should work on all systems
1116 $session = new CGI::Session("driver:File;serializer:yaml", $sessionID, {Directory=>'/tmp'});
1123 my ( $dbh, $userid, $password ) = @_;
1125 $debug and print "## checkpw - checking LDAP\n";
1126 my ($retval,$retcard) = checkpw_ldap(@_); # EXTERNAL AUTH
1127 ($retval) and return ($retval,$retcard);
1133 "select password,cardnumber,borrowernumber,userid,firstname,surname,branchcode,flags from borrowers where userid=?"
1135 $sth->execute($userid);
1137 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1138 $surname, $branchcode, $flags )
1140 if ( md5_base64($password) eq $md5password ) {
1142 C4::Context->set_userenv( "$borrowernumber", $userid, $cardnumber,
1143 $firstname, $surname, $branchcode, $flags );
1144 return 1, $cardnumber;
1149 "select password,cardnumber,borrowernumber,userid, firstname,surname,branchcode,flags from borrowers where cardnumber=?"
1151 $sth->execute($userid);
1153 my ( $md5password, $cardnumber, $borrowernumber, $userid, $firstname,
1154 $surname, $branchcode, $flags )
1156 if ( md5_base64($password) eq $md5password ) {
1158 C4::Context->set_userenv( $borrowernumber, $userid, $cardnumber,
1159 $firstname, $surname, $branchcode, $flags );
1163 if ( $userid && $userid eq C4::Context->config('user')
1164 && "$password" eq C4::Context->config('pass') )
1167 # Koha superuser account
1168 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
1171 if ( $userid && $userid eq 'demo'
1172 && "$password" eq 'demo'
1173 && C4::Context->config('demo') )
1176 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
1177 # some features won't be effective : modify systempref, modify MARC structure,
1185 $authflags = getuserflags($flags,$dbh);
1186 Translates integer flags into permissions strings hash.
1188 C<$flags> is the integer userflags value ( borrowers.userflags )
1189 C<$authflags> is a hashref of permissions
1197 $flags = 0 unless $flags;
1198 my $sth = $dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
1201 while ( my ( $bit, $flag, $defaulton ) = $sth->fetchrow ) {
1202 if ( ( $flags & ( 2**$bit ) ) || $defaulton ) {
1203 $userflags->{$flag} = 1;
1206 $userflags->{$flag} = 0;
1214 $flags = ($dbh,$member,$flagsrequired);
1216 C<$member> may be either userid or overloaded with $borrower hashref from GetMemberDetails.
1217 C<$flags> is a hashref of required flags lik C<$borrower-<{authflags}>
1219 Returns member's flags or 0 if a permission is not met.
1224 my ( $dbh, $userid, $flagsrequired ) = @_;
1225 my ($flags,$intflags);
1226 $dbh=C4::Context->dbh unless($dbh);
1228 $intflags = $userid->{'flags'};
1230 my $sth = $dbh->prepare("SELECT flags FROM borrowers WHERE userid=?");
1231 $sth->execute($userid);
1232 my ($intflags) = $sth->fetchrow;
1233 $flags = getuserflags( $intflags, $dbh );
1235 if ( $userid eq C4::Context->config('user') ) {
1236 # Super User Account from /etc/koha.conf
1237 $flags->{'superlibrarian'} = 1;
1239 if ( $userid eq 'demo' && C4::Context->config('demo') ) {
1240 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
1241 $flags->{'superlibrarian'} = 1;
1243 return $flags if $flags->{superlibrarian};
1244 foreach ( keys %$flagsrequired ) {
1245 return 0 unless( $flags->{$_} );
1248 #FIXME - This fcn should return the failed permission so a suitable error msg can be delivered.
1252 sub getborrowernumber {
1254 my $dbh = C4::Context->dbh;
1255 for my $field ( 'userid', 'cardnumber' ) {
1257 $dbh->prepare("select borrowernumber from borrowers where $field=?");
1258 $sth->execute($userid);
1260 my ($bnumber) = $sth->fetchrow;
1267 END { } # module clean-up code here (global destructor)