Warnung wenn kein cookie übergeben wurde
[kivitendo-erp.git] / SL / Auth.pm
index 5f3c65d..37586b8 100644 (file)
@@ -8,10 +8,12 @@ use Time::HiRes qw(gettimeofday);
 use List::MoreUtils qw(uniq);
 use YAML;
 
+use SL::Auth::ColumnInformation;
 use SL::Auth::Constants qw(:all);
 use SL::Auth::DB;
 use SL::Auth::LDAP;
 use SL::Auth::Password;
+use SL::Auth::SessionValue;
 
 use SL::SessionFile;
 use SL::User;
@@ -29,9 +31,8 @@ sub new {
 
   bless $self, $type;
 
-  $self->{SESSION} = { };
-
   $self->_read_auth_config();
+  $self->reset;
 
   $main::lxdebug->leave_sub();
 
@@ -41,10 +42,11 @@ sub new {
 sub reset {
   my ($self, %params) = @_;
 
-  $self->{SESSION}          = { };
-  $self->{FULL_RIGHTS}      = { };
-  $self->{RIGHTS}           = { };
-  $self->{unique_counter}   = 0;
+  $self->{SESSION}            = { };
+  $self->{FULL_RIGHTS}        = { };
+  $self->{RIGHTS}             = { };
+  $self->{unique_counter}     = 0;
+  $self->{column_information} = SL::Auth::ColumnInformation->new(auth => $self);
 }
 
 sub get_user_dbh {
@@ -165,8 +167,12 @@ sub authenticate {
 sub store_credentials_in_session {
   my ($self, %params) = @_;
 
-  $params{password} = SL::Auth::Password->hash_if_unhashed(login => $params{login}, password => $params{password})
-    unless $self->{authenticator}->requires_cleartext_password;
+  if (!$self->{authenticator}->requires_cleartext_password) {
+    $params{password} = SL::Auth::Password->hash_if_unhashed(login             => $params{login},
+                                                             password          => $params{password},
+                                                             look_up_algorithm => 1,
+                                                             auth              => $self);
+  }
 
   $self->set_session_value(login => $params{login}, password => $params{password});
 }
@@ -174,10 +180,20 @@ sub store_credentials_in_session {
 sub store_root_credentials_in_session {
   my ($self, $rpw) = @_;
 
-  $rpw = SL::Auth::Password->hash_if_unhashed(login => 'root', password => $rpw)
-    unless $self->{authenticator}->requires_cleartext_password;
+  $self->set_session_value(rpw => SL::Auth::Password->hash_if_unhashed(login => 'root', password => $rpw));
+}
+
+sub get_stored_password {
+  my ($self, $login) = @_;
+
+  my $dbh            = $self->dbconnect;
+
+  return undef unless $dbh;
+
+  my $query             = qq|SELECT password FROM auth."user" WHERE login = ?|;
+  my ($stored_password) = $dbh->selectrow_array($query, undef, $login);
 
-  $self->set_session_value(rpw => $rpw);
+  return $stored_password;
 }
 
 sub dbconnect {
@@ -379,8 +395,14 @@ sub can_change_password {
 sub change_password {
   $main::lxdebug->enter_sub();
 
-  my $self   = shift;
-  my $result = $self->{authenticator}->change_password(@_);
+  my ($self, $login, $new_password) = @_;
+
+  my $result = $self->{authenticator}->change_password($login, $new_password);
+
+  $self->store_credentials_in_session(login             => $login,
+                                      password          => $new_password,
+                                      look_up_algorithm => 1,
+                                      auth              => $self);
 
   $main::lxdebug->leave_sub();
 
@@ -489,11 +511,8 @@ sub restore_session {
 
   my $self = shift;
 
-  my $cgi            =  $main::cgi;
-  $cgi             ||=  CGI->new('');
-
-  $session_id        =  $cgi->cookie($self->get_session_cookie_name());
-  $session_id        =~ s|[^0-9a-f]||g;
+  $session_id        =  $::request->{cgi}->cookie($self->get_session_cookie_name());
+  $session_id        =~ s|[^0-9a-f]||g if $session_id;
 
   $self->{SESSION}   = { };
 
@@ -517,45 +536,85 @@ sub restore_session {
     return $cookie ? SESSION_EXPIRED : SESSION_NONE;
   }
 
-  $query = qq|SELECT sess_key, sess_value FROM auth.session_content WHERE session_id = ?|;
-  $sth   = prepare_execute_query($form, $dbh, $query, $session_id);
-
-  while (my $ref = $sth->fetchrow_hashref()) {
-    $self->{SESSION}->{$ref->{sess_key}} = $ref->{sess_value};
-    next if defined $form->{$ref->{sess_key}};
-
-    my $params                = $self->_load_value($ref->{sess_value});
-    $form->{$ref->{sess_key}} = $params->{data} if $params->{auto_restore} || $params->{simple};
+  if ($self->{column_information}->has('auto_restore')) {
+    $self->_load_with_auto_restore_column($dbh, $session_id);
+  } else {
+    $self->_load_without_auto_restore_column($dbh, $session_id);
   }
 
-  $sth->finish();
-
   $main::lxdebug->leave_sub();
 
   return SESSION_OK;
 }
 
-sub _load_value {
-  my ($self, $value) = @_;
+sub _load_without_auto_restore_column {
+  my ($self, $dbh, $session_id) = @_;
 
-  return { simple => 1, data => $value } if $value !~ m/^---/;
+  my $query = <<SQL;
+    SELECT sess_key, sess_value
+    FROM auth.session_content
+    WHERE (session_id = ?)
+SQL
+  my $sth = prepare_execute_query($::form, $dbh, $query, $session_id);
 
-  my %params = ( simple => 1 );
-  eval {
-    my $data = YAML::Load($value);
+  while (my $ref = $sth->fetchrow_hashref) {
+    my $value = SL::Auth::SessionValue->new(auth  => $self,
+                                            key   => $ref->{sess_key},
+                                            value => $ref->{sess_value},
+                                            raw   => 1);
+    $self->{SESSION}->{ $ref->{sess_key} } = $value;
 
-    if (ref $data eq 'HASH') {
-      map { $params{$_} = $data->{$_} } keys %{ $data };
-      $params{simple} = 0;
+    next if defined $::form->{$ref->{sess_key}};
 
-    } else {
-      $params{data}   = $data;
-    }
+    my $data                    = $value->get;
+    $::form->{$ref->{sess_key}} = $data if $value->{auto_restore} || !ref $data;
+  }
+}
+
+sub _load_with_auto_restore_column {
+  my ($self, $dbh, $session_id) = @_;
 
-    1;
-  } or $params{data} = $value;
+  my $auto_restore_keys = join ', ', map { "'${_}'" } qw(login password rpw);
 
-  return \%params;
+  my $query = <<SQL;
+    SELECT sess_key, sess_value, auto_restore
+    FROM auth.session_content
+    WHERE (session_id = ?)
+      AND (   auto_restore
+           OR sess_key IN (${auto_restore_keys}))
+SQL
+  my $sth = prepare_execute_query($::form, $dbh, $query, $session_id);
+
+  while (my $ref = $sth->fetchrow_hashref) {
+    my $value = SL::Auth::SessionValue->new(auth         => $self,
+                                            key          => $ref->{sess_key},
+                                            value        => $ref->{sess_value},
+                                            auto_restore => $ref->{auto_restore},
+                                            raw          => 1);
+    $self->{SESSION}->{ $ref->{sess_key} } = $value;
+
+    next if defined $::form->{$ref->{sess_key}};
+
+    my $data                    = $value->get;
+    $::form->{$ref->{sess_key}} = $data if $value->{auto_restore} || !ref $data;
+  }
+
+  $sth->finish;
+
+  $query = <<SQL;
+    SELECT sess_key
+    FROM auth.session_content
+    WHERE (session_id = ?)
+      AND NOT COALESCE(auto_restore, FALSE)
+      AND (sess_key NOT IN (${auto_restore_keys}))
+SQL
+  $sth = prepare_execute_query($::form, $dbh, $query, $session_id);
+
+  while (my $ref = $sth->fetchrow_hashref) {
+    my $value = SL::Auth::SessionValue->new(auth => $self,
+                                            key  => $ref->{sess_key});
+    $self->{SESSION}->{ $ref->{sess_key} } = $value;
+  }
 }
 
 sub destroy_session {
@@ -645,11 +704,18 @@ sub save_session {
   $dbh->begin_work unless $provided_dbh;
 
   do_query($::form, $dbh, qq|LOCK auth.session_content|);
-  do_query($::form, $dbh, qq|DELETE FROM auth.session_content WHERE session_id = ?|, $session_id);
 
-  my $query = qq|SELECT id FROM auth.session WHERE id = ?|;
+  my @unfetched_keys = map     { $_->{key}        }
+                       grep    { ! $_->{fetched}  }
+                       values %{ $self->{SESSION} };
+  # $::lxdebug->dump(0, "unfetched_keys", [ sort @unfetched_keys ]);
+  # $::lxdebug->dump(0, "all keys", [ sort map { $_->{key} } values %{ $self->{SESSION} } ]);
+  my $query          = qq|DELETE FROM auth.session_content WHERE (session_id = ?)|;
+  $query            .= qq| AND (sess_key NOT IN (| . join(', ', ('?') x scalar @unfetched_keys) . qq|))| if @unfetched_keys;
+
+  do_query($::form, $dbh, $query, $session_id, @unfetched_keys);
 
-  my ($id)  = selectrow_query($::form, $dbh, $query, $session_id);
+  my ($id) = selectrow_query($::form, $dbh, qq|SELECT id FROM auth.session WHERE id = ?|, $session_id);
 
   if ($id) {
     do_query($::form, $dbh, qq|UPDATE auth.session SET mtime = now() WHERE id = ?|, $session_id);
@@ -657,12 +723,25 @@ sub save_session {
     do_query($::form, $dbh, qq|INSERT INTO auth.session (id, ip_address, mtime) VALUES (?, ?, now())|, $session_id, $ENV{REMOTE_ADDR});
   }
 
-  if (%{ $self->{SESSION} }) {
-    my $query = qq|INSERT INTO auth.session_content (session_id, sess_key, sess_value) VALUES (?, ?, ?)|;
-    my $sth   = prepare_query($::form, $dbh, $query);
+  my @values_to_save = grep    { $_->{fetched} }
+                       values %{ $self->{SESSION} };
+  if (@values_to_save) {
+    my ($columns, $placeholders) = ('', '');
+    my $auto_restore             = $self->{column_information}->has('auto_restore');
 
-    foreach my $key (sort keys %{ $self->{SESSION} }) {
-      do_statement($::form, $sth, $query, $session_id, $key, $self->{SESSION}->{$key});
+    if ($auto_restore) {
+      $columns      .= ', auto_restore';
+      $placeholders .= ', ?';
+    }
+
+    $query  = qq|INSERT INTO auth.session_content (session_id, sess_key, sess_value ${columns}) VALUES (?, ?, ? ${placeholders})|;
+    my $sth = prepare_query($::form, $dbh, $query);
+
+    foreach my $value (@values_to_save) {
+      my @values = ($value->{key}, $value->get_dumped);
+      push @values, $value->{auto_restore} if $auto_restore;
+
+      do_statement($::form, $sth, $query, $session_id, @values);
     }
 
     $sth->finish();
@@ -676,12 +755,23 @@ sub set_session_value {
   $main::lxdebug->enter_sub();
 
   my $self   = shift;
-  my %params = @_;
+  my @params = @_;
 
   $self->{SESSION} ||= { };
 
-  while (my ($key, $value) = each %params) {
-    $self->{SESSION}->{ $key } = YAML::Dump(ref($value) eq 'HASH' ? { data => $value } : $value);
+  while (@params) {
+    my $key = shift @params;
+
+    if (ref $key eq 'HASH') {
+      $self->{SESSION}->{ $key->{key} } = SL::Auth::SessionValue->new(key          => $key->{key},
+                                                                      value        => $key->{value},
+                                                                      auto_restore => $key->{auto_restore});
+
+    } else {
+      my $value = shift @params;
+      $self->{SESSION}->{ $key } = SL::Auth::SessionValue->new(key   => $key,
+                                                               value => $value);
+    }
   }
 
   $main::lxdebug->leave_sub();
@@ -705,12 +795,12 @@ sub delete_session_value {
 sub get_session_value {
   $main::lxdebug->enter_sub();
 
-  my $self   = shift;
-  my $params = $self->{SESSION} ? $self->_load_value($self->{SESSION}->{ $_[0] }) : {};
+  my $self = shift;
+  my $data = $self->{SESSION} && $self->{SESSION}->{ $_[0] } ? $self->{SESSION}->{ $_[0] }->get : undef;
 
   $main::lxdebug->leave_sub();
 
-  return $params->{data};
+  return $data;
 }
 
 sub create_unique_sesion_value {
@@ -722,16 +812,15 @@ sub create_unique_sesion_value {
   my $key                   = "$$-" . ($now[0] * 1000000 + $now[1]) . "-";
   $self->{unique_counter} ||= 0;
 
-  $self->{unique_counter}++ while exists $self->{SESSION}->{$key . $self->{unique_counter}};
-  $self->{unique_counter}++;
-
-  $value  = { expiration => $params{expiration} ? ($now[0] + $params{expiration}) * 1000000 + $now[1] : undef,
-              data       => $value,
-            };
+  my $hashed_key;
+  do {
+    $self->{unique_counter}++;
+    $hashed_key = md5_hex($key . $self->{unique_counter});
+  } while (exists $self->{SESSION}->{$hashed_key});
 
-  $self->{SESSION}->{$key . $self->{unique_counter}} = YAML::Dump($value);
+  $self->set_session_value($hashed_key => $value);
 
-  return $key . $self->{unique_counter};
+  return $hashed_key;
 }
 
 sub save_form_in_session {
@@ -764,27 +853,6 @@ sub restore_form_from_session {
   return $self;
 }
 
-sub expire_session_keys {
-  my ($self) = @_;
-
-  $self->{SESSION} ||= { };
-
-  my @now = gettimeofday();
-  my $now = $now[0] * 1000000 + $now[1];
-
-  $self->delete_session_value(map  { $_->[0]                                                 }
-                              grep { $_->[1]->{expiration} && ($now > $_->[1]->{expiration}) }
-                              map  { [ $_, $self->_load_value($self->{SESSION}->{$_}) ]      }
-                              keys %{ $self->{SESSION} });
-
-  return $self;
-}
-
-sub _has_expiration {
-  my ($value) = @_;
-  return (ref $value eq 'HASH') && exists($value->{expiration}) && $value->{data};
-}
-
 sub set_cookie_environment_variable {
   my $self = shift;
   $ENV{HTTP_COOKIE} = $self->get_session_cookie_name() . "=${session_id}";
@@ -858,7 +926,6 @@ sub all_rights_full {
     ["customer_vendor_edit",           $locale->text("Create and edit customers and vendors")],
     ["part_service_assembly_edit",     $locale->text("Create and edit parts, services, assemblies")],
     ["project_edit",                   $locale->text("Create and edit projects")],
-    ["license_edit",                   $locale->text("Manage license keys")],
     ["--ar",                           $locale->text("AR")],
     ["sales_quotation_edit",           $locale->text("Create and edit sales quotations")],
     ["sales_order_edit",               $locale->text("Create and edit sales orders")],
@@ -1190,11 +1257,30 @@ SL::Auth - Authentication and session handling
 
 =over 4
 
+=item C<set_session_value @values>
 =item C<set_session_value %values>
 
-Store all key/value pairs in C<%values> in the session. All of these
-values are copied back into C<$::form> in the next request
-automatically.
+Store all values of C<@values> or C<%values> in the session. Each
+member of C<@values> is tested if it is a hash reference. If it is
+then it must contain the keys C<key> and C<value> and can optionally
+contain the key C<auto_restore>. In this case C<value> is associated
+with C<key> and restored to C<$::form> upon the next request
+automatically if C<auto_restore> is trueish or if C<value> is a scalar
+value.
+
+If the current member of C<@values> is not a hash reference then it
+will be used as the C<key> and the next entry of C<@values> is used as
+the C<value> to store. In this case setting C<auto_restore> is not
+possible.
+
+Therefore the following two invocations are identical:
+
+  $::auth-E<gt>set_session_value(name =E<gt> "Charlie");
+  $::auth-E<gt>set_session_value({ key =E<gt> "name", value =E<gt> "Charlie" });
+
+All of these values are copied back into C<$::form> for the next
+request automatically if they're scalar values or if they have
+C<auto_restore> set to trueish.
 
 The values can be any Perl structure. They are stored as YAML dumps.
 
@@ -1208,17 +1294,8 @@ doesn't exist.
 Create a unique key in the session and store C<$value>
 there.
 
-If C<$params{expiration}> is set then it is interpreted as a number of
-seconds after which the value is removed from the session. It will
-never expire if that parameter is falsish.
-
 Returns the key created in the session.
 
-=item C<expire_session_keys>
-
-Removes all keys from the session that have an expiration time set and
-whose expiration time is in the past.
-
 =item C<save_session>
 
 Stores the session values in the database. This is the only function