1 package C4::InstallAuth;
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 under the
8 # terms of the GNU General Public License as published by the Free Software
9 # Foundation; either version 2 of the License, or (at your option) any later
12 # Koha is distributed in the hope that it will be useful, but WITHOUT ANY
13 # WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR
14 # A PARTICULAR PURPOSE. See the GNU General Public License for more details.
16 # You should have received a copy of the GNU General Public License along
17 # with Koha; if not, write to the Free Software Foundation, Inc.,
18 # 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
21 #use warnings; FIXME - Bug 2505
22 use Digest::MD5 qw(md5_base64);
31 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
33 # set the version for version checking
38 InstallAuth - Authenticates Koha users for Install process
48 my ($template, $borrowernumber, $cookie)
49 = get_template_and_user({template_name => "opac-main.tt",
53 flagsrequired => {borrow => 1},
56 output_html_with_http_headers $query, $cookie, $template->output;
60 The main function of this module is to provide
61 authentification. However the get_template_and_user function has
62 been provided so that a users login information is passed along
63 automatically. This gets loaded into the template.
64 This package is different from C4::Auth in so far as
65 C4::Auth uses many preferences which are supposed NOT to be obtainable when installing the database.
67 As in C4::Auth, Authentication is based on cookies.
78 &get_template_and_user
81 =item get_template_and_user
83 my ($template, $borrowernumber, $cookie)
84 = get_template_and_user({template_name => "opac-main.tt",
88 flagsrequired => {borrow => 1},
91 This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
92 to C<&checkauth> (in this module) to perform authentification.
93 See C<&checkauth> for an explanation of these parameters.
95 The C<template_name> is then used to find the correct template for
96 the page. The authenticated users details are loaded onto the
97 template in the HTML::Template LOOP variable C<USER_INFO>. Also the
98 C<sessionID> is passed to the template. This can be used in templates
99 if cookies are disabled. It needs to be put as and input to every
102 More information on the C<gettemplate> sub can be found in the
107 sub get_template_and_user {
109 my $query = $in->{'query'};
110 my $language =_get_template_language($query->cookie('KohaOpacLanguage'));
111 my $path = C4::Context->config('intrahtdocs'). "/prog/". $language;
113 my $tmplbase = $in->{template_name};
114 my $filename = "$path/modules/" . $tmplbase;
115 my $interface = 'intranet';
116 my $template = C4::Templates->new( $interface, $filename, $tmplbase, $query);
118 my ( $user, $cookie, $sessionID, $flags ) = checkauth(
120 $in->{'authnotrequired'},
121 $in->{'flagsrequired'},
125 # use Data::Dumper;warn "utilisateur $user cookie : ".Dumper($cookie);
129 $template->param( loggedinusername => $user );
130 $template->param( sessionID => $sessionID );
132 # We are going to use the $flags returned by checkauth
133 # to create the template's parameters that will indicate
134 # which menus the user can access.
135 if ( ( $flags && $flags->{superlibrarian} == 1 ) ) {
136 $template->param( CAN_user_circulate => 1 );
137 $template->param( CAN_user_catalogue => 1 );
138 $template->param( CAN_user_parameters => 1 );
139 $template->param( CAN_user_borrowers => 1 );
140 $template->param( CAN_user_permission => 1 );
141 $template->param( CAN_user_reserveforothers => 1 );
142 $template->param( CAN_user_borrow => 1 );
143 $template->param( CAN_user_editcatalogue => 1 );
144 $template->param( CAN_user_updatecharges => 1 );
145 $template->param( CAN_user_acquisition => 1 );
146 $template->param( CAN_user_management => 1 );
147 $template->param( CAN_user_tools => 1 );
148 $template->param( CAN_user_editauthorities => 1 );
149 $template->param( CAN_user_serials => 1 );
150 $template->param( CAN_user_reports => 1 );
153 return ( $template, $borrowernumber, $cookie );
156 sub _get_template_language {
158 #verify if opac language exists in staff (bug 5660)
159 #conditions are 1) dir exists and 2) enabled in prefs
161 return 'en' unless $opaclang;
162 $opaclang =~ s/[^a-zA-Z_-]*//g;
163 my $path = C4::Context->config('intrahtdocs') . "/prog/$opaclang";
164 -d $path ? $opaclang : 'en';
169 ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
171 Verifies that the user is authorized to run this script. If
172 the user is authorized, a (userid, cookie, session-id, flags)
173 quadruple is returned. If the user is not authorized but does
174 not have the required privilege (see $flagsrequired below), it
175 displays an error page and exits. Otherwise, it displays the
176 login page and exits.
178 Note that C<&checkauth> will return if and only if the user
179 is authorized, so it should be called early on, before any
180 unfinished operations (e.g., if you've opened a file, then
181 C<&checkauth> won't close it for you).
183 C<$query> is the CGI object for the script calling C<&checkauth>.
185 The C<$noauth> argument is optional. If it is set, then no
186 authorization is required for the script.
188 C<&checkauth> fetches user and session information from C<$query> and
189 ensures that the user is authorized to run scripts that require
192 The C<$flagsrequired> argument specifies the required privileges
193 the user must have if the username and password are correct.
194 It should be specified as a reference-to-hash; keys in the hash
195 should be the "flags" for the user, as specified in the Members
196 intranet module. Any key specified must correspond to a "flag"
197 in the userflags table. E.g., { circulate => 1 } would specify
198 that the user must have the "circulate" privilege in order to
199 proceed. To make sure that access control is correct, the
200 C<$flagsrequired> parameter must be specified correctly.
202 The C<$type> argument specifies whether the template should be
203 retrieved from the opac or intranet directory tree. "opac" is
204 assumed if it is not specified; however, if C<$type> is specified,
205 "intranet" is assumed if it is not "opac".
207 If C<$query> does not have a valid session ID associated with it
208 (i.e., the user has not logged in) or if the session has expired,
209 C<&checkauth> presents the user with a login page (from the point of
210 view of the original script, C<&checkauth> does not return). Once the
211 user has authenticated, C<&checkauth> restarts the original script
212 (this time, C<&checkauth> returns).
214 The login page is provided using a HTML::Template, which is set in the
215 systempreferences table or at the top of this file. The variable C<$type>
216 selects which template to use, either the opac or the intranet
217 authentification template.
219 C<&checkauth> returns a user ID, a cookie, and a session ID. The
220 cookie should be sent back to the browser; it verifies that the user
228 # $authnotrequired will be set for scripts which will run without authentication
229 my $authnotrequired = shift;
230 my $flagsrequired = shift;
232 $type = 'intranet' unless $type;
234 my $dbh = C4::Context->dbh();
236 $template_name = "installer/auth.tt";
241 my ( $userid, $cookie, $sessionID, $flags, $envcookie );
242 my $logout = $query->param('logout.x');
243 if ( $sessionID = $query->cookie("CGISESSID") ) {
244 C4::Context->_new_userenv($sessionID);
246 new CGI::Session( "driver:File;serializer:yaml", $sessionID,
247 { Directory => '/tmp' } );
248 if ( $session->param('cardnumber') ) {
249 C4::Context::set_userenv(
250 $session->param('number'),
251 $session->param('id'),
252 $session->param('cardnumber'),
253 $session->param('firstname'),
254 $session->param('surname'),
255 $session->param('branch'),
256 $session->param('branchname'),
257 $session->param('flags'),
258 $session->param('emailaddress'),
259 $session->param('branchprinter')
261 $cookie = $query->cookie(
262 -name => 'CGISESSID',
263 -value => $session->id,
267 $userid = $session->param('cardnumber');
269 my ( $ip, $lasttime );
273 # voluntary logout the user
274 C4::Context->_unset_userenv($sessionID);
277 # Commented out due to its lack of usefulness
278 # open L, ">>/tmp/sessionlog";
279 # my $time = localtime( time() );
280 # printf L "%20s from %16s logged out at %30s (manually).\n", $userid,
287 new CGI::Session( "driver:File;serializer:yaml", undef, { Directory => '/tmp' } );
288 $sessionID = $session->id;
289 $userid = $query->param('userid');
290 C4::Context->_new_userenv($sessionID);
291 my $password = $query->param('password');
292 C4::Context->_new_userenv($sessionID);
293 my ( $return, $cardnumber ) = checkpw( $userid, $password );
296 # open L, ">>/tmp/sessionlog";
297 # my $time = localtime( time() );
298 # printf L "%20s from %16s logged in at %30s.\n", $userid,
299 # $ENV{'REMOTE_ADDR'}, $time;
301 $cookie = $query->cookie(
302 -name => 'CGISESSID',
303 -value => $sessionID,
306 if ( $return == 2 ) {
308 #Only superlibrarian should have access to this page.
309 #Since if it is a user, it is supposed that there is a borrower table
310 #And thus that data structure is loaded.
311 my $hash = C4::Context::set_userenv(
313 C4::Context->config('user'), C4::Context->config('user'),
314 C4::Context->config('user'), "",
318 $session->param( 'number', 0 );
319 $session->param( 'id', C4::Context->config('user') );
320 $session->param( 'cardnumber', C4::Context->config('user') );
321 $session->param( 'firstname', C4::Context->config('user') );
322 $session->param( 'surname', C4::Context->config('user'), );
323 $session->param( 'branch', 'NO_LIBRARY_SET' );
324 $session->param( 'branchname', 'NO_LIBRARY_SET' );
325 $session->param( 'flags', 1 );
326 $session->param( 'emailaddress',
327 C4::Context->preference('KohaAdminEmailAddress') );
328 $session->param( 'ip', $session->remote_addr() );
329 $session->param( 'lasttime', time() );
330 $userid = C4::Context->config('user');
335 $info{'invalid_username_or_password'} = 1;
336 C4::Context->_unset_userenv($sessionID);
341 # finished authentification, now respond
346 $cookie = $query->cookie(
347 -name => 'CGISESSID',
354 return ( $userid, [ $cookie, $envcookie ], $sessionID, $flags );
357 return ( $userid, $cookie, $sessionID, $flags );
361 # else we have a problem...
362 # get the inputs from the incoming query
364 foreach my $name ( param $query) {
365 (next) if ( $name eq 'userid' || $name eq 'password' );
366 my $value = $query->param($name);
367 push @inputs, { name => $name, value => $value };
371 C4::Context->config('intrahtdocs') . "/prog/"
372 . ( $query->param('language') ? $query->param('language') : "en" );
373 my $filename = "$path/modules/$template_name";
374 my $interface = 'intranet';
375 my $template = C4::Templates->new( $interface, $filename, '', $query);
380 $template->param( login => 1 );
381 $template->param( loginprompt => 1 ) unless $info{'nopermission'};
383 my $self_url = $query->url( -absolute => 1 );
384 $template->param( url => $self_url, );
385 $template->param( \%info );
386 $cookie = $query->cookie(
387 -name => 'CGISESSID',
388 -value => $sessionID,
392 print $query->header(
393 -type => 'text/html; charset=utf-8',
402 my ( $userid, $password ) = @_;
405 && $userid eq C4::Context->config('user')
406 && "$password" eq C4::Context->config('pass') )
409 # Koha superuser account
410 C4::Context->set_userenv(
412 C4::Context->config('user'),
413 C4::Context->config('user'),
414 C4::Context->config('user'),
421 && "$password" eq 'demo'
422 && C4::Context->config('demo') )
425 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
426 # some features won't be effective : modify systempref, modify MARC structure,
432 END { } # module clean-up code here (global destructor)