2 # NOTE: This file uses 8-character tabs; do not change the tab size!
6 # Copyright 2000-2002 Katipo Communications
8 # This file is part of Koha.
10 # Koha is free software; you can redistribute it and/or modify it under the
11 # terms of the GNU General Public License as published by the Free Software
12 # Foundation; either version 2 of the License, or (at your option) any later
15 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
16 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
17 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
19 # You should have received a copy of the GNU General Public License along with
20 # Koha; if not, write to the Free Software Foundation, Inc., 59 Temple Place,
21 # Suite 330, Boston, MA 02111-1307 USA
24 use Digest::MD5 qw(md5_base64);
28 use C4::Output; # to get the template
29 use C4::Interface::CGI::Output;
30 use C4::Circulation::Circ2; # getpatroninformation
32 # use Net::LDAP qw(:all);
34 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
36 # set the version for version checking
41 C4::Auth - Authenticates Koha users
50 my ($template, $borrowernumber, $cookie)
51 = get_template_and_user({template_name => "opac-main.tmpl",
55 flagsrequired => {borrow => 1},
59 -type => guesstype($template->output),
66 The main function of this module is to provide
67 authentification. However the get_template_and_user function has
68 been provided so that a users login information is passed along
69 automatically. This gets loaded into the template.
82 &get_template_and_user
85 =item get_template_and_user
87 my ($template, $borrowernumber, $cookie)
88 = get_template_and_user({template_name => "opac-main.tmpl",
92 flagsrequired => {borrow => 1},
95 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
96 to C<&checkauth> (in this module) to perform authentification.
97 See C<&checkauth> for an explanation of these parameters.
99 The C<template_name> is then used to find the correct template for
100 the page. The authenticated users details are loaded onto the
101 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
102 C<sessionID> is passed to the template. This can be used in templates
103 if cookies are disabled. It needs to be put as and input to every
106 More information on the C<gettemplate> sub can be found in the
112 sub get_template_and_user {
114 my $template = gettemplate($in->{'template_name'}, $in->{'type'},$in->{'query'});
115 my ($user, $cookie, $sessionID, $flags)
116 = checkauth($in->{'query'}, $in->{'authnotrequired'}, $in->{'flagsrequired'}, $in->{'type'});
120 $template->param(loggedinusername => $user);
121 $template->param(sessionID => $sessionID);
123 $borrowernumber = getborrowernumber($user);
124 my ($borr, $alternativeflags) = getpatroninformation(undef, $borrowernumber);
127 $template->param(USER_INFO => \@bordat,
130 # We are going to use the $flags returned by checkauth
131 # to create the template's parameters that will indicate
132 # which menus the user can access.
133 if ($flags && $flags->{superlibrarian} == 1)
135 $template->param(CAN_user_circulate => 1);
136 $template->param(CAN_user_catalogue => 1);
137 $template->param(CAN_user_parameters => 1);
138 $template->param(CAN_user_borrowers => 1);
139 $template->param(CAN_user_permission => 1);
140 $template->param(CAN_user_reserveforothers => 1);
141 $template->param(CAN_user_borrow => 1);
142 $template->param(CAN_user_reserveforself => 1);
143 $template->param(CAN_user_editcatalogue => 1);
144 $template->param(CAN_user_updatecharge => 1);
145 $template->param(CAN_user_acquisition => 1);
146 $template->param(CAN_user_management => 1);
147 $template->param(CAN_user_tools => 1); }
149 if ($flags && $flags->{circulate} == 1) {
150 $template->param(CAN_user_circulate => 1); }
152 if ($flags && $flags->{catalogue} == 1) {
153 $template->param(CAN_user_catalogue => 1); }
156 if ($flags && $flags->{parameters} == 1) {
157 $template->param(CAN_user_parameters => 1);
158 $template->param(CAN_user_management => 1);
159 $template->param(CAN_user_tools => 1); }
162 if ($flags && $flags->{borrowers} == 1) {
163 $template->param(CAN_user_borrowers => 1); }
166 if ($flags && $flags->{permissions} == 1) {
167 $template->param(CAN_user_permission => 1); }
169 if ($flags && $flags->{reserveforothers} == 1) {
170 $template->param(CAN_user_reserveforothers => 1); }
173 if ($flags && $flags->{borrow} == 1) {
174 $template->param(CAN_user_borrow => 1); }
177 if ($flags && $flags->{reserveforself} == 1) {
178 $template->param(CAN_user_reserveforself => 1); }
181 if ($flags && $flags->{editcatalogue} == 1) {
182 $template->param(CAN_user_editcatalogue => 1); }
185 if ($flags && $flags->{updatecharges} == 1) {
186 $template->param(CAN_user_updatecharge => 1); }
188 if ($flags && $flags->{acquisition} == 1) {
189 $template->param(CAN_user_acquisition => 1); }
191 if ($flags && $flags->{management} == 1) {
192 $template->param(CAN_user_management => 1);
193 $template->param(CAN_user_tools => 1); }
195 if ($flags && $flags->{tools} == 1) {
196 $template->param(CAN_user_tools => 1); }
200 LibraryName => C4::Context->preference("LibraryName"),
202 return ($template, $borrowernumber, $cookie);
208 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
210 Verifies that the user is authorized to run this script. If
211 the user is authorized, a (userid, cookie, session-id, flags)
212 quadruple is returned. If the user is not authorized but does
213 not have the required privilege (see $flagsrequired below), it
214 displays an error page and exits. Otherwise, it displays the
215 login page and exits.
217 Note that C<&checkauth> will return if and only if the user
218 is authorized, so it should be called early on, before any
219 unfinished operations (e.g., if you've opened a file, then
220 C<&checkauth> won't close it for you).
222 C<$query> is the CGI object for the script calling C<&checkauth>.
224 The C<$noauth> argument is optional. If it is set, then no
225 authorization is required for the script.
227 C<&checkauth> fetches user and session information from C<$query> and
228 ensures that the user is authorized to run scripts that require
231 The C<$flagsrequired> argument specifies the required privileges
232 the user must have if the username and password are correct.
233 It should be specified as a reference-to-hash; keys in the hash
234 should be the "flags" for the user, as specified in the Members
235 intranet module. Any key specified must correspond to a "flag"
236 in the userflags table. E.g., { circulate => 1 } would specify
237 that the user must have the "circulate" privilege in order to
238 proceed. To make sure that access control is correct, the
239 C<$flagsrequired> parameter must be specified correctly.
241 The C<$type> argument specifies whether the template should be
242 retrieved from the opac or intranet directory tree. "opac" is
243 assumed if it is not specified; however, if C<$type> is specified,
244 "intranet" is assumed if it is not "opac".
246 If C<$query> does not have a valid session ID associated with it
247 (i.e., the user has not logged in) or if the session has expired,
248 C<&checkauth> presents the user with a login page (from the point of
249 view of the original script, C<&checkauth> does not return). Once the
250 user has authenticated, C<&checkauth> restarts the original script
251 (this time, C<&checkauth> returns).
253 The login page is provided using a HTML::Template, which is set in the
254 systempreferences table or at the top of this file. The variable C<$type>
255 selects which template to use, either the opac or the intranet
256 authentification template.
258 C<&checkauth> returns a user ID, a cookie, and a session ID. The
259 cookie should be sent back to the browser; it verifies that the user
268 # $authnotrequired will be set for scripts which will run without authentication
269 my $authnotrequired = shift;
270 my $flagsrequired = shift;
272 $type = 'opac' unless $type;
274 my $dbh = C4::Context->dbh;
275 my $timeout = C4::Context->preference('timeout');
276 $timeout = 600 unless $timeout;
279 if ($type eq 'opac') {
280 $template_name = "opac-auth.tmpl";
282 $template_name = "auth.tmpl";
288 my ($userid, $cookie, $sessionID, $flags, $envcookie);
289 my $logout = $query->param('logout.x');
290 if ($userid = $ENV{'REMOTE_USER'}) {
291 # Using Basic Authentication, no cookies required
292 $cookie=$query->cookie(-name => 'sessionID',
296 } elsif ($sessionID=$query->cookie('sessionID')) {
297 C4::Context->_new_userenv($sessionID);
298 if (my %hash=$query->cookie('userenv')){
299 C4::Context::set_userenv(
310 my ($ip , $lasttime);
311 ($userid, $ip, $lasttime) = $dbh->selectrow_array(
312 "SELECT userid,ip,lasttime FROM sessions WHERE sessionid=?",
315 # voluntary logout the user
316 $dbh->do("DELETE FROM sessions WHERE sessionID=?", undef, $sessionID);
317 C4::Context->_unset_userenv($sessionID);
320 open L, ">>/tmp/sessionlog";
321 my $time=localtime(time());
322 printf L "%20s from %16s logged out at %30s (manually).\n", $userid, $ip, $time;
326 if ($lasttime<time()-$timeout) {
328 $info{'timed_out'} = 1;
329 $dbh->do("DELETE FROM sessions WHERE sessionID=?", undef, $sessionID);
330 C4::Context->_unset_userenv($sessionID);
333 open L, ">>/tmp/sessionlog";
334 my $time=localtime(time());
335 printf L "%20s from %16s logged out at %30s (inactivity).\n", $userid, $ip, $time;
337 } elsif ($ip ne $ENV{'REMOTE_ADDR'}) {
338 # Different ip than originally logged in from
339 $info{'oldip'} = $ip;
340 $info{'newip'} = $ENV{'REMOTE_ADDR'};
341 $info{'different_ip'} = 1;
342 $dbh->do("DELETE FROM sessions WHERE sessionID=?", undef, $sessionID);
343 C4::Context->_unset_userenv($sessionID);
346 open L, ">>/tmp/sessionlog";
347 my $time=localtime(time());
348 printf L "%20s from logged out at %30s (ip changed from %16s to %16s).\n", $userid, $time, $ip, $info{'newip'};
351 $cookie=$query->cookie(-name => 'sessionID',
352 -value => $sessionID,
354 $dbh->do("UPDATE sessions SET lasttime=? WHERE sessionID=?",
355 undef, (time(), $sessionID));
356 $flags = haspermission($dbh, $userid, $flagsrequired);
360 $info{'nopermission'} = 1;
366 $sessionID=int(rand()*100000).'-'.time();
367 $userid=$query->param('userid');
368 C4::Context->_new_userenv($sessionID);
369 my $password=$query->param('password');
370 my ($return, $cardnumber) = checkpw($dbh,$userid,$password);
372 $dbh->do("DELETE FROM sessions WHERE sessionID=? AND userid=?",
373 undef, ($sessionID, $userid));
374 $dbh->do("INSERT INTO sessions (sessionID, userid, ip,lasttime) VALUES (?, ?, ?, ?)",
375 undef, ($sessionID, $userid, $ENV{'REMOTE_ADDR'}, time()));
376 open L, ">>/tmp/sessionlog";
377 my $time=localtime(time());
378 printf L "%20s from %16s logged in at %30s.\n", $userid, $ENV{'REMOTE_ADDR'}, $time;
380 $cookie=$query->cookie(-name => 'sessionID',
381 -value => $sessionID,
384 if ($flags = haspermission($dbh, $userid, $flagsrequired)) {
387 $info{'nopermission'} = 1;
388 C4::Context->_unset_userenv($sessionID);
391 my $sth=$dbh->prepare(
392 "select cardnumber,borrowernumber,userid,firstname,surname,flags,branchcode,emailaddress
393 from borrowers where userid=?"
395 $sth->execute($userid);
396 my ($cardnumber,$bornum,$userid,$firstname,$surname,$userflags,$branchcode,$emailaddress) = $sth->fetchrow;
397 my $hash = C4::Context::set_userenv(
407 $envcookie=$query->cookie(-name => 'userenv',
410 } elsif ($return == 2) {
411 #We suppose the user is the superlibrarian
412 my $hash = C4::Context::set_userenv(
414 C4::Context->config('user'),
415 C4::Context->config('user'),
416 C4::Context->config('user'),
417 "",1,'nobody@nowhere_koha.com'
419 $envcookie=$query->cookie(-name => 'userenv',
425 $info{'invalid_username_or_password'} = 1;
426 C4::Context->_unset_userenv($sessionID);
430 my $insecure = C4::Context->boolean_preference('insecure');
431 # finished authentification, now respond
432 if ($loggedin || $authnotrequired || (defined($insecure) && $insecure)) {
435 $cookie=$query->cookie(-name => 'sessionID',
440 return ($userid, [$cookie,$envcookie], $sessionID, $flags)
442 return ($userid, $cookie, $sessionID, $flags);
445 # else we have a problem...
446 # get the inputs from the incoming query
448 foreach my $name (param $query) {
449 (next) if ($name eq 'userid' || $name eq 'password');
450 my $value = $query->param($name);
451 push @inputs, {name => $name , value => $value};
454 my $template = gettemplate($template_name, $type,$query);
455 $template->param(INPUTS => \@inputs);
456 $template->param(loginprompt => 1) unless $info{'nopermission'};
458 my $self_url = $query->url(-absolute => 1);
459 $template->param(url => $self_url, LibraryName=> C4::Context->preference("LibraryName"),);
460 $template->param(\%info);
461 $cookie=$query->cookie(-name => 'sessionID',
462 -value => $sessionID,
464 print $query->header(
465 -type => guesstype($template->output),
467 ), $template->output;
476 my ($dbh, $userid, $password) = @_;
478 my $sth=$dbh->prepare("select password,cardnumber from borrowers where userid=?");
479 $sth->execute($userid);
481 my ($md5password,$cardnumber) = $sth->fetchrow;
482 if (md5_base64($password) eq $md5password) {
483 # C4::Context->set_userenv("$bornum",$userid,$cardnumber,$firstname,$surname,$branchcode,$userflags);
484 return 1,$cardnumber;
487 my $sth=$dbh->prepare("select password from borrowers where cardnumber=?");
488 $sth->execute($userid);
490 my ($md5password) = $sth->fetchrow;
491 if (md5_base64($password) eq $md5password) {
492 # C4::Context->set_userenv($bornum,$userid,$cardnumber,$firstname,$surname,$branchcode,$userflags);
496 if ($userid eq C4::Context->config('user') && $password eq C4::Context->config('pass')) {
497 # Koha superuser account
498 # C4::Context->set_userenv(0,0,C4::Context->config('user'),C4::Context->config('user'),C4::Context->config('user'),"",1);
501 if ($userid eq 'demo' && $password eq 'demo' && C4::Context->config('demo')) {
502 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
503 # some features won't be effective : modify systempref, modify MARC structure,
510 my $cardnumber=shift;
513 my $sth=$dbh->prepare("SELECT flags FROM borrowers WHERE cardnumber=?");
514 $sth->execute($cardnumber);
515 my ($flags) = $sth->fetchrow;
516 $sth=$dbh->prepare("SELECT bit, flag, defaulton FROM userflags");
518 while (my ($bit, $flag, $defaulton) = $sth->fetchrow) {
519 if (($flags & (2**$bit)) || $defaulton) {
520 $userflags->{$flag}=1;
527 my ($dbh, $userid, $flagsrequired) = @_;
528 my $sth=$dbh->prepare("SELECT cardnumber FROM borrowers WHERE userid=?");
529 $sth->execute($userid);
530 my ($cardnumber) = $sth->fetchrow;
531 ($cardnumber) || ($cardnumber=$userid);
532 my $flags=getuserflags($cardnumber,$dbh);
534 if ($userid eq C4::Context->config('user')) {
535 # Super User Account from /etc/koha.conf
536 $flags->{'superlibrarian'}=1;
538 if ($userid eq 'demo' && C4::Context->config('demo')) {
539 # Demo user that can do "anything" (demo=1 in /etc/koha.conf)
540 $flags->{'superlibrarian'}=1;
542 return $flags if $flags->{superlibrarian};
543 foreach (keys %$flagsrequired) {
544 return $flags if $flags->{$_};
549 sub getborrowernumber {
551 my $dbh = C4::Context->dbh;
552 for my $field ('userid', 'cardnumber') {
553 my $sth=$dbh->prepare
554 ("select borrowernumber from borrowers where $field=?");
555 $sth->execute($userid);
557 my ($bnumber) = $sth->fetchrow;
564 END { } # module clean-up code here (global destructor)