C4/InstallAuth.pm

   1 package C4::InstallAuth;
   2
   3 # Copyright 2000-2002 Katipo Communications
   4 #
   5 # This file is part of Koha.
   6 #
   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.
  11 #
  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.
  16 #
  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>.
  19
  20 use strict;
  21 #use warnings; FIXME - Bug 2505
  22 use Digest::MD5 qw(md5_base64);
  23
  24 require Exporter;
  25 use C4::Context;
  26 use C4::Output;
  27 use C4::Templates;
  28 use C4::Koha;
  29 use CGI::Session;
  30
  31 use vars qw($VERSION @ISA @EXPORT @EXPORT_OK %EXPORT_TAGS);
  32
  33 # set the version for version checking
  34 $VERSION = 3.00;
  35
  36 =head1 NAME
  37
  38 InstallAuth - Authenticates Koha users for Install process
  39
  40 =head1 SYNOPSIS
  41
  42   use CGI qw ( -utf8 );
  43   use InstallAuth;
  44   use C4::Output;
  45
  46   my $query = new CGI;
  47
  48     my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  49         {   template_name   => "opac-main.tt",
  50             query           => $query,
  51             type            => "opac",
  52             authnotrequired => 1,
  53             flagsrequired   => { acquisition => '*' },
  54         }
  55     );
  56
  57   output_html_with_http_headers $query, $cookie, $template->output;
  58
  59 =head1 DESCRIPTION
  60
  61     The main function of this module is to provide
  62     authentification. However the get_template_and_user function has
  63     been provided so that a users login information is passed along
  64     automatically. This gets loaded into the template.
  65     This package is different from C4::Auth in so far as
  66     C4::Auth uses many preferences which are supposed NOT to be obtainable when installing the database.
  67
  68     As in C4::Auth, Authentication is based on cookies.
  69
  70 =head1 FUNCTIONS
  71
  72 =over 2
  73
  74 =cut
  75
  76 @ISA    = qw(Exporter);
  77 @EXPORT = qw(
  78   &checkauth
  79   &get_template_and_user
  80 );
  81
  82 =item get_template_and_user
  83
  84     my ( $template, $borrowernumber, $cookie ) = get_template_and_user(
  85         {   template_name   => "opac-main.tt",
  86             query           => $query,
  87             type            => "opac",
  88             authnotrequired => 1,
  89             flagsrequired   => { acquisition => '*' },
  90         }
  91     );
  92
  93     This call passes the C<query>, C<flagsrequired> and C<authnotrequired>
  94     to C<&checkauth> (in this module) to perform authentification.
  95     See C<&checkauth> for an explanation of these parameters.
  96
  97     The C<template_name> is then used to find the correct template for
  98     the page. The authenticated users details are loaded onto the
  99     template in the HTML::Template LOOP variable C<USER_INFO>. Also the
 100     C<sessionID> is passed to the template. This can be used in templates
 101     if cookies are disabled. It needs to be put as and input to every
 102     authenticated page.
 103
 104     More information on the C<gettemplate> sub can be found in the
 105     Templates.pm module.
 106
 107 =cut
 108
 109 sub get_template_and_user {
 110     my $in       = shift;
 111     my $query    = $in->{'query'};
 112     my $language =_get_template_language($query->cookie('KohaOpacLanguage'));
 113     my $path     = C4::Context->config('intrahtdocs'). "/prog/". $language;
 114
 115     my $tmplbase = $in->{template_name};
 116     my $filename = "$path/modules/" . $tmplbase;
 117     my $interface = 'intranet';
 118     my $template = C4::Templates->new( $interface, $filename, $tmplbase, $query);
 119
 120     my ( $user, $cookie, $sessionID, $flags ) = checkauth(
 121         $in->{'query'},
 122         $in->{'authnotrequired'},
 123         $in->{'flagsrequired'},
 124         $in->{'type'}
 125     );
 126
 127     #     use Data::Dumper;warn "utilisateur $user cookie : ".Dumper($cookie);
 128
 129     my $borrowernumber;
 130     if ($user) {
 131         $template->param( loggedinusername => $user );
 132         $template->param( sessionID        => $sessionID );
 133
 134         # We are going to use the $flags returned by checkauth
 135         # to create the template's parameters that will indicate
 136         # which menus the user can access.
 137         if ( ( $flags && $flags->{superlibrarian} == 1 ) ) {
 138             $template->param( CAN_user_circulate        => 1 );
 139             $template->param( CAN_user_catalogue        => 1 );
 140             $template->param( CAN_user_parameters       => 1 );
 141             $template->param( CAN_user_borrowers        => 1 );
 142             $template->param( CAN_user_permission       => 1 );
 143             $template->param( CAN_user_reserveforothers => 1 );
 144             $template->param( CAN_user_editcatalogue    => 1 );
 145             $template->param( CAN_user_updatecharges    => 1 );
 146             $template->param( CAN_user_acquisition      => 1 );
 147             $template->param( CAN_user_management       => 1 );
 148             $template->param( CAN_user_tools            => 1 );
 149             $template->param( CAN_user_editauthorities  => 1 );
 150             $template->param( CAN_user_serials          => 1 );
 151             $template->param( CAN_user_reports          => 1 );
 152         }
 153     }
 154     return ( $template, $borrowernumber, $cookie );
 155 }
 156
 157 sub _get_template_language {
 158
 159     #verify if opac language exists in staff (bug 5660)
 160     #conditions are 1) dir exists and 2) enabled in prefs
 161     my ($opaclang) = @_;
 162     return 'en' unless $opaclang;
 163     $opaclang =~ s/[^a-zA-Z_-]*//g;
 164     my $path = C4::Context->config('intrahtdocs') . "/prog/$opaclang";
 165     -d $path ? $opaclang : 'en';
 166 }
 167
 168 =item checkauth
 169
 170   ($userid, $cookie, $sessionID) = &checkauth($query, $noauth, $flagsrequired, $type);
 171
 172 Verifies that the user is authorized to run this script.  If
 173 the user is authorized, a (userid, cookie, session-id, flags)
 174 quadruple is returned.  If the user is not authorized but does
 175 not have the required privilege (see $flagsrequired below), it
 176 displays an error page and exits.  Otherwise, it displays the
 177 login page and exits.
 178
 179 Note that C<&checkauth> will return if and only if the user
 180 is authorized, so it should be called early on, before any
 181 unfinished operations (e.g., if you've opened a file, then
 182 C<&checkauth> won't close it for you).
 183
 184 C<$query> is the CGI object for the script calling C<&checkauth>.
 185
 186 The C<$noauth> argument is optional. If it is set, then no
 187 authorization is required for the script.
 188
 189 C<&checkauth> fetches user and session information from C<$query> and
 190 ensures that the user is authorized to run scripts that require
 191 authorization.
 192
 193 The C<$flagsrequired> argument specifies the required privileges
 194 the user must have if the username and password are correct.
 195 It should be specified as a reference-to-hash; keys in the hash
 196 should be the "flags" for the user, as specified in the Members
 197 intranet module. Any key specified must correspond to a "flag"
 198 in the userflags table. E.g., { circulate => 1 } would specify
 199 that the user must have the "circulate" privilege in order to
 200 proceed. To make sure that access control is correct, the
 201 C<$flagsrequired> parameter must be specified correctly.
 202
 203 The C<$type> argument specifies whether the template should be
 204 retrieved from the opac or intranet directory tree.  "opac" is
 205 assumed if it is not specified; however, if C<$type> is specified,
 206 "intranet" is assumed if it is not "opac".
 207
 208 If C<$query> does not have a valid session ID associated with it
 209 (i.e., the user has not logged in) or if the session has expired,
 210 C<&checkauth> presents the user with a login page (from the point of
 211 view of the original script, C<&checkauth> does not return). Once the
 212 user has authenticated, C<&checkauth> restarts the original script
 213 (this time, C<&checkauth> returns).
 214
 215 The login page is provided using a HTML::Template, which is set in the
 216 systempreferences table or at the top of this file. The variable C<$type>
 217 selects which template to use, either the opac or the intranet
 218 authentification template.
 219
 220 C<&checkauth> returns a user ID, a cookie, and a session ID. The
 221 cookie should be sent back to the browser; it verifies that the user
 222 has authenticated.
 223
 224 =cut
 225
 226 sub checkauth {
 227     my $query = shift;
 228
 229 # $authnotrequired will be set for scripts which will run without authentication
 230     my $authnotrequired = shift;
 231     my $flagsrequired   = shift;
 232     my $type            = shift;
 233     $type = 'intranet' unless $type;
 234
 235     my $dbh = C4::Context->dbh();
 236     my $template_name;
 237     $template_name = "installer/auth.tt";
 238
 239     # state variables
 240     my $loggedin = 0;
 241     my %info;
 242     my ( $userid, $cookie, $sessionID, $flags, $envcookie );
 243     my $logout = $query->param('logout.x');
 244     if ( $sessionID = $query->cookie("CGISESSID") ) {
 245         C4::Context->_new_userenv($sessionID);
 246         my $session =
 247           new CGI::Session( "driver:File;serializer:yaml", $sessionID,
 248             { Directory => '/tmp' } );
 249         if ( $session->param('cardnumber') ) {
 250             C4::Context->set_userenv(
 251                 $session->param('number'),
 252                 $session->param('id'),
 253                 $session->param('cardnumber'),
 254                 $session->param('firstname'),
 255                 $session->param('surname'),
 256                 $session->param('branch'),
 257                 $session->param('branchname'),
 258                 $session->param('flags'),
 259                 $session->param('emailaddress'),
 260                 $session->param('branchprinter')
 261             );
 262             $cookie = $query->cookie(
 263                 -name     => 'CGISESSID',
 264                 -value    => $session->id,
 265                 -HttpOnly => 1,
 266             );
 267             $loggedin = 1;
 268             $userid   = $session->param('cardnumber');
 269         }
 270         my ( $ip, $lasttime );
 271
 272         if ($logout) {
 273
 274             # voluntary logout the user
 275             C4::Context->_unset_userenv($sessionID);
 276             $sessionID = undef;
 277             $userid    = undef;
 278            # Commented out due to its lack of usefulness
 279            # open L, ">>/tmp/sessionlog";
 280            # my $time = localtime( time() );
 281            # printf L "%20s from %16s logged out at %30s (manually).\n", $userid,
 282            #   $ip, $time;
 283            # close L;
 284         }
 285     }
 286     unless ($userid) {
 287         my $session =
 288           new CGI::Session( "driver:File;serializer:yaml", undef, { Directory => '/tmp' } );
 289         $sessionID = $session->id;
 290         $userid    = $query->param('userid');
 291         C4::Context->_new_userenv($sessionID);
 292         my $password = $query->param('password');
 293         C4::Context->_new_userenv($sessionID);
 294         my ( $return, $cardnumber ) = checkpw( $userid, $password );
 295         if ($return) {
 296             $loggedin = 1;
 297             # open L, ">>/tmp/sessionlog";
 298             # my $time = localtime( time() );
 299             # printf L "%20s from %16s logged in  at %30s.\n", $userid,
 300             #  $ENV{'REMOTE_ADDR'}, $time;
 301             # close L;
 302             $cookie = $query->cookie(
 303                 -name     => 'CGISESSID',
 304                 -value    => $sessionID,
 305                 -HttpOnly => 1,
 306             );
 307             if ( $return == 2 ) {
 308
 309            #Only superlibrarian should have access to this page.
 310            #Since if it is a user, it is supposed that there is a borrower table
 311            #And thus that data structure is loaded.
 312                 my $hash = C4::Context->set_userenv(
 313                     0,                           0,
 314                     C4::Context->config('user'), C4::Context->config('user'),
 315                     C4::Context->config('user'), "",
 316                     "NO_LIBRARY_SET",            1,
 317                     ""
 318                 );
 319                 $session->param( 'number',     0 );
 320                 $session->param( 'id',         C4::Context->config('user') );
 321                 $session->param( 'cardnumber', C4::Context->config('user') );
 322                 $session->param( 'firstname',  C4::Context->config('user') );
 323                 $session->param( 'surname',    C4::Context->config('user'), );
 324                 $session->param( 'branch',     'NO_LIBRARY_SET' );
 325                 $session->param( 'branchname', 'NO_LIBRARY_SET' );
 326                 $session->param( 'flags',      1 );
 327                 $session->param( 'emailaddress',
 328                     C4::Context->preference('KohaAdminEmailAddress') );
 329                 $session->param( 'ip',       $session->remote_addr() );
 330                 $session->param( 'lasttime', time() );
 331                 $userid = C4::Context->config('user');
 332             }
 333         }
 334         else {
 335             if ($userid) {
 336                 $info{'invalid_username_or_password'} = 1;
 337                 C4::Context->_unset_userenv($sessionID);
 338             }
 339         }
 340     }
 341
 342     # finished authentification, now respond
 343     if ($loggedin) {
 344
 345         # successful login
 346         unless ($cookie) {
 347             $cookie = $query->cookie(
 348                 -name    => 'CGISESSID',
 349                 -value   => '',
 350                 -HttpOnly => 1,
 351                 -expires => ''
 352             );
 353         }
 354         if ($envcookie) {
 355             return ( $userid, [ $cookie, $envcookie ], $sessionID, $flags );
 356         }
 357         else {
 358             return ( $userid, $cookie, $sessionID, $flags );
 359         }
 360     }
 361
 362     # else we have a problem...
 363     # get the inputs from the incoming query
 364     my @inputs = ();
 365     foreach my $name ( param $query) {
 366         (next) if ( $name eq 'userid' || $name eq 'password' );
 367         my $value = $query->param($name);
 368         push @inputs, { name => $name, value => $value };
 369     }
 370
 371     my $path =
 372       C4::Context->config('intrahtdocs') . "/prog/"
 373       . ( $query->param('language') ? $query->param('language') : "en" );
 374     my $filename = "$path/modules/$template_name";
 375     my $interface = 'intranet';
 376     my $template = C4::Templates->new( $interface, $filename, '', $query);
 377     $template->param(
 378         INPUTS => \@inputs,
 379
 380     );
 381     $template->param( login => 1 );
 382     $template->param( loginprompt => 1 ) unless $info{'nopermission'};
 383
 384     my $self_url = $query->url( -absolute => 1 );
 385     $template->param( url => $self_url, );
 386     $template->param( \%info );
 387     $cookie = $query->cookie(
 388         -name    => 'CGISESSID',
 389         -value   => $sessionID,
 390         -HttpOnly => 1,
 391         -expires => ''
 392     );
 393     print $query->header(
 394         -type    => 'text/html; charset=utf-8',
 395         -cookie  => $cookie
 396       ),
 397       $template->output;
 398     exit;
 399 }
 400
 401 sub checkpw {
 402
 403     my ( $userid, $password ) = @_;
 404
 405     if (   $userid
 406         && $userid     eq C4::Context->config('user')
 407         && "$password" eq C4::Context->config('pass') )
 408     {
 409
 410         # Koha superuser account
 411         C4::Context->set_userenv(
 412             0, 0,
 413             C4::Context->config('user'),
 414             C4::Context->config('user'),
 415             C4::Context->config('user'),
 416             "", "NO_LIBRARY_SET", 1
 417         );
 418         return 2;
 419     }
 420     if (   $userid
 421         && $userid     eq 'demo'
 422         && "$password" eq 'demo'
 423         && C4::Context->config('demo') )
 424     {
 425
 426 # DEMO => the demo user is allowed to do everything (if demo set to 1 in koha.conf
 427 # some features won't be effective : modify systempref, modify MARC structure,
 428         return 2;
 429     }
 430     return 0;
 431 }
 432
 433 END { }    # module clean-up code here (global destructor)
 434 1;
 435 __END__
 436
 437 =back
 438
 439 =head1 SEE ALSO
 440
 441 CGI(3)
 442
 443 C4::Output(3)
 444
 445 Digest::MD5(3)
 446
 447 =cut