5 use Digest::MD5 qw(md5_hex);
7 use Time::HiRes qw(gettimeofday);
8 use List::MoreUtils qw(uniq);
11 use SL::Auth::ColumnInformation;
12 use SL::Auth::Constants qw(:all);
15 use SL::Auth::Password;
16 use SL::Auth::SessionValue;
26 use constant SESSION_KEY_ROOT_AUTH => 'session_auth_status_root';
27 use constant SESSION_KEY_USER_AUTH => 'session_auth_status_user';
30 $main::lxdebug->enter_sub();
37 $self->_read_auth_config();
40 $main::lxdebug->leave_sub();
46 my ($self, %params) = @_;
48 $self->{SESSION} = { };
49 $self->{FULL_RIGHTS} = { };
50 $self->{RIGHTS} = { };
51 $self->{unique_counter} = 0;
52 $self->{column_information} = SL::Auth::ColumnInformation->new(auth => $self);
53 $self->{authenticator}->reset;
57 my ($self, $login, %params) = @_;
58 my $may_fail = delete $params{may_fail};
60 my %user = $self->read_user(login => $login);
61 my $dbh = SL::DBConnect->connect(
66 pg_enable_utf8 => $::locale->is_utf8,
71 if (!$may_fail && !$dbh) {
72 $::form->error($::locale->text('The connection to the authentication database failed:') . "\n" . $DBI::errstr);
75 if ($user{dboptions} && $dbh) {
76 $dbh->do($user{dboptions}) or $::form->dberror($user{dboptions});
85 $self->{dbh}->disconnect() if ($self->{dbh});
88 # form isn't loaded yet, so auth needs it's own error.
90 $::lxdebug->show_backtrace();
92 my ($self, @msg) = @_;
93 if ($ENV{HTTP_USER_AGENT}) {
94 print Form->create_http_response(content_type => 'text/html');
95 print "<pre>", join ('<br>', @msg), "</pre>";
97 print STDERR "Error: @msg\n";
102 sub _read_auth_config {
103 $main::lxdebug->enter_sub();
107 map { $self->{$_} = $::lx_office_conf{authentication}->{$_} } keys %{ $::lx_office_conf{authentication} };
109 # Prevent password leakage to log files when dumping Auth instances.
110 $self->{admin_password} = sub { $::lx_office_conf{authentication}->{admin_password} };
112 $self->{DB_config} = $::lx_office_conf{'authentication/database'};
113 $self->{LDAP_config} = $::lx_office_conf{'authentication/ldap'};
115 if ($self->{module} eq 'DB') {
116 $self->{authenticator} = SL::Auth::DB->new($self);
118 } elsif ($self->{module} eq 'LDAP') {
119 $self->{authenticator} = SL::Auth::LDAP->new($self);
122 if (!$self->{authenticator}) {
123 my $locale = Locale->new('en');
124 $self->mini_error($locale->text('No or an unknown authenticantion module specified in "config/kivitendo.conf".'));
127 my $cfg = $self->{DB_config};
130 my $locale = Locale->new('en');
131 $self->mini_error($locale->text('config/kivitendo.conf: Key "DB_config" is missing.'));
134 if (!$cfg->{host} || !$cfg->{db} || !$cfg->{user}) {
135 my $locale = Locale->new('en');
136 $self->mini_error($locale->text('config/kivitendo.conf: Missing parameters in "authentication/database". Required parameters are "host", "db" and "user".'));
139 $self->{authenticator}->verify_config();
141 $self->{session_timeout} *= 1;
142 $self->{session_timeout} = 8 * 60 if (!$self->{session_timeout});
144 $main::lxdebug->leave_sub();
147 sub authenticate_root {
148 $main::lxdebug->enter_sub();
150 my ($self, $password) = @_;
152 my $session_root_auth = $self->get_session_value(SESSION_KEY_ROOT_AUTH());
153 if (defined $session_root_auth && $session_root_auth == OK) {
154 $::lxdebug->leave_sub;
158 if (!defined $password) {
159 $::lxdebug->leave_sub;
163 $password = SL::Auth::Password->hash(login => 'root', password => $password);
164 my $admin_password = SL::Auth::Password->hash_if_unhashed(login => 'root', password => $self->{admin_password}->());
166 my $result = $password eq $admin_password ? OK : ERR_PASSWORD;
167 $self->set_session_value(SESSION_KEY_ROOT_AUTH() => $result);
169 $::lxdebug->leave_sub;
174 $main::lxdebug->enter_sub();
176 my ($self, $login, $password) = @_;
178 my $session_auth = $self->get_session_value(SESSION_KEY_USER_AUTH());
179 if (defined $session_auth && $session_auth == OK) {
180 $::lxdebug->leave_sub;
184 if (!defined $password) {
185 $::lxdebug->leave_sub;
189 my $result = $login ? $self->{authenticator}->authenticate($login, $password) : ERR_USER;
190 $self->set_session_value(SESSION_KEY_USER_AUTH() => $result, login => $login);
192 $::lxdebug->leave_sub;
196 sub punish_wrong_login {
197 my $failed_login_penalty = ($::lx_office_conf{authentication} || {})->{failed_login_penalty};
198 sleep $failed_login_penalty if $failed_login_penalty;
201 sub get_stored_password {
202 my ($self, $login) = @_;
204 my $dbh = $self->dbconnect;
206 return undef unless $dbh;
208 my $query = qq|SELECT password FROM auth."user" WHERE login = ?|;
209 my ($stored_password) = $dbh->selectrow_array($query, undef, $login);
211 return $stored_password;
215 $main::lxdebug->enter_sub(2);
218 my $may_fail = shift;
221 $main::lxdebug->leave_sub(2);
225 my $cfg = $self->{DB_config};
226 my $dsn = 'dbi:Pg:dbname=' . $cfg->{db} . ';host=' . $cfg->{host};
229 $dsn .= ';port=' . $cfg->{port};
232 $main::lxdebug->message(LXDebug->DEBUG1, "Auth::dbconnect DSN: $dsn");
234 $self->{dbh} = SL::DBConnect->connect($dsn, $cfg->{user}, $cfg->{password}, { pg_enable_utf8 => $::locale->is_utf8, AutoCommit => 1 });
236 if (!$may_fail && !$self->{dbh}) {
237 $main::form->error($main::locale->text('The connection to the authentication database failed:') . "\n" . $DBI::errstr);
240 $main::lxdebug->leave_sub(2);
246 $main::lxdebug->enter_sub();
251 $self->{dbh}->disconnect();
255 $main::lxdebug->leave_sub();
259 $main::lxdebug->enter_sub();
261 my ($self, $dbh) = @_;
263 $dbh ||= $self->dbconnect();
264 my $query = qq|SELECT COUNT(*) FROM pg_tables WHERE (schemaname = 'auth') AND (tablename = 'user')|;
266 my ($count) = $dbh->selectrow_array($query);
268 $main::lxdebug->leave_sub();
274 $main::lxdebug->enter_sub();
278 my $dbh = $self->dbconnect(1);
280 $main::lxdebug->leave_sub();
285 sub create_database {
286 $main::lxdebug->enter_sub();
291 my $cfg = $self->{DB_config};
293 if (!$params{superuser}) {
294 $params{superuser} = $cfg->{user};
295 $params{superuser_password} = $cfg->{password};
298 $params{template} ||= 'template0';
299 $params{template} =~ s|[^a-zA-Z0-9_\-]||g;
301 my $dsn = 'dbi:Pg:dbname=template1;host=' . $cfg->{host};
304 $dsn .= ';port=' . $cfg->{port};
307 $main::lxdebug->message(LXDebug->DEBUG1(), "Auth::create_database DSN: $dsn");
309 my $charset = $::lx_office_conf{system}->{dbcharset};
310 $charset ||= Common::DEFAULT_CHARSET;
311 my $encoding = $Common::charset_to_db_encoding{$charset};
312 $encoding ||= 'UNICODE';
314 my $dbh = SL::DBConnect->connect($dsn, $params{superuser}, $params{superuser_password}, { pg_enable_utf8 => scalar($charset =~ m/^utf-?8$/i) });
317 $main::form->error($main::locale->text('The connection to the template database failed:') . "\n" . $DBI::errstr);
320 my $query = qq|CREATE DATABASE "$cfg->{db}" OWNER "$cfg->{user}" TEMPLATE "$params{template}" ENCODING '$encoding'|;
322 $main::lxdebug->message(LXDebug->DEBUG1(), "Auth::create_database query: $query");
327 my $error = $dbh->errstr();
329 $query = qq|SELECT pg_encoding_to_char(encoding) FROM pg_database WHERE datname = 'template0'|;
330 my ($cluster_encoding) = $dbh->selectrow_array($query);
332 if ($cluster_encoding && ($cluster_encoding =~ m/^(?:UTF-?8|UNICODE)$/i) && ($encoding !~ m/^(?:UTF-?8|UNICODE)$/i)) {
333 $error = $main::locale->text('Your PostgreSQL installationen uses UTF-8 as its encoding. Therefore you have to configure kivitendo to use UTF-8 as well.');
338 $main::form->error($main::locale->text('The creation of the authentication database failed:') . "\n" . $error);
343 $main::lxdebug->leave_sub();
347 $main::lxdebug->enter_sub();
350 my $dbh = $self->dbconnect();
352 my $charset = $::lx_office_conf{system}->{dbcharset};
353 $charset ||= Common::DEFAULT_CHARSET;
356 SL::DBUpgrade2->new(form => $::form)->process_query($dbh, 'sql/auth_db.sql', undef, $charset);
358 $main::lxdebug->leave_sub();
362 $main::lxdebug->enter_sub();
368 my $form = $main::form;
370 my $dbh = $self->dbconnect();
372 my ($sth, $query, $user_id);
376 $query = qq|SELECT id FROM auth."user" WHERE login = ?|;
377 ($user_id) = selectrow_query($form, $dbh, $query, $login);
380 $query = qq|SELECT nextval('auth.user_id_seq')|;
381 ($user_id) = selectrow_query($form, $dbh, $query);
383 $query = qq|INSERT INTO auth."user" (id, login) VALUES (?, ?)|;
384 do_query($form, $dbh, $query, $user_id, $login);
387 $query = qq|DELETE FROM auth.user_config WHERE (user_id = ?)|;
388 do_query($form, $dbh, $query, $user_id);
390 $query = qq|INSERT INTO auth.user_config (user_id, cfg_key, cfg_value) VALUES (?, ?, ?)|;
391 $sth = prepare_query($form, $dbh, $query);
393 while (my ($cfg_key, $cfg_value) = each %params) {
394 next if ($cfg_key eq 'password');
396 do_statement($form, $sth, $query, $user_id, $cfg_key, $cfg_value);
401 $main::lxdebug->leave_sub();
404 sub can_change_password {
407 return $self->{authenticator}->can_change_password();
410 sub change_password {
411 $main::lxdebug->enter_sub();
413 my ($self, $login, $new_password) = @_;
415 my $result = $self->{authenticator}->change_password($login, $new_password);
417 $main::lxdebug->leave_sub();
423 $main::lxdebug->enter_sub();
427 my $dbh = $self->dbconnect();
428 my $query = qq|SELECT u.id, u.login, cfg.cfg_key, cfg.cfg_value, s.mtime AS last_action
430 FROM auth."user" AS u
432 LEFT JOIN auth.user_config AS cfg
433 ON (cfg.user_id = u.id)
435 LEFT JOIN auth.session_content AS sc_login
436 ON (sc_login.sess_key = 'login' AND sc_login.sess_value = ('--- ' \|\| u.login \|\| '\n'))
438 LEFT JOIN auth.session AS s
439 ON (s.id = sc_login.session_id)
441 my $sth = prepare_execute_query($main::form, $dbh, $query);
445 while (my $ref = $sth->fetchrow_hashref()) {
447 $users{$ref->{login}} ||= {
448 'login' => $ref->{login},
450 'last_action' => $ref->{last_action},
452 $users{$ref->{login}}->{$ref->{cfg_key}} = $ref->{cfg_value} if (($ref->{cfg_key} ne 'login') && ($ref->{cfg_key} ne 'id'));
457 $main::lxdebug->leave_sub();
463 $main::lxdebug->enter_sub();
465 my ($self, %params) = @_;
467 my $dbh = $self->dbconnect();
469 my (@where, @values);
470 if ($params{login}) {
471 push @where, 'u.login = ?';
472 push @values, $params{login};
475 push @where, 'u.id = ?';
476 push @values, $params{id};
478 my $where = join ' AND ', '1 = 1', @where;
479 my $query = qq|SELECT u.id, u.login, cfg.cfg_key, cfg.cfg_value
480 FROM auth.user_config cfg
481 LEFT JOIN auth."user" u ON (cfg.user_id = u.id)
483 my $sth = prepare_execute_query($main::form, $dbh, $query, @values);
487 while (my $ref = $sth->fetchrow_hashref()) {
488 $user_data{$ref->{cfg_key}} = $ref->{cfg_value};
489 @user_data{qw(id login)} = @{$ref}{qw(id login)};
492 # The XUL/XML & 'CSS new' backed menus have been removed.
493 my %menustyle_map = ( xml => 'new', v4 => 'v3' );
494 $user_data{menustyle} = $menustyle_map{lc($user_data{menustyle} || '')} || $user_data{menustyle};
496 # The 'Win2000.css' stylesheet has been removed.
497 $user_data{stylesheet} = 'kivitendo.css' if ($user_data{stylesheet} || '') =~ m/win2000/i;
499 # Set default language if selected language does not exist (anymore).
500 $user_data{countrycode} = $::lx_office_conf{system}->{language} unless $user_data{countrycode} && -d "locale/$user_data{countrycode}";
504 $main::lxdebug->leave_sub();
510 $main::lxdebug->enter_sub();
515 my $dbh = $self->dbconnect();
516 my ($id) = selectrow_query($main::form, $dbh, qq|SELECT id FROM auth."user" WHERE login = ?|, $login);
518 $main::lxdebug->leave_sub();
524 $::lxdebug->enter_sub;
529 my $dbh = $self->dbconnect;
530 my $id = $self->get_user_id($login);
533 $dbh->rollback and return $::lxdebug->leave_sub if (!$id);
535 my $u_dbh = $self->get_user_dbh($login, may_fail => 1);
536 $user_db_exists = $self->check_tables($u_dbh) if $u_dbh;
538 $u_dbh->begin_work if $u_dbh && $user_db_exists;
542 do_query($::form, $dbh, qq|DELETE FROM auth.user_group WHERE user_id = ?|, $id);
543 do_query($::form, $dbh, qq|DELETE FROM auth.user_config WHERE user_id = ?|, $id);
544 do_query($::form, $dbh, qq|DELETE FROM auth.user WHERE id = ?|, $id);
545 do_query($::form, $u_dbh, qq|UPDATE employee SET deleted = 't' WHERE login = ?|, $login) if $u_dbh && $user_db_exists;
548 $u_dbh->commit if $u_dbh && $user_db_exists;
550 $::lxdebug->leave_sub;
553 # --------------------------------------
557 sub restore_session {
558 $main::lxdebug->enter_sub();
562 $session_id = $::request->{cgi}->cookie($self->get_session_cookie_name());
563 $session_id =~ s|[^0-9a-f]||g if $session_id;
565 $self->{SESSION} = { };
568 $main::lxdebug->leave_sub();
572 my ($dbh, $query, $sth, $cookie, $ref, $form);
576 # Don't fail if the auth DB doesn't yet.
577 if (!( $dbh = $self->dbconnect(1) )) {
578 $::lxdebug->leave_sub;
582 # Don't fail if the "auth" schema doesn't exist yet, e.g. if the
583 # admin is creating the session tables at the moment.
584 $query = qq|SELECT *, (mtime < (now() - '$self->{session_timeout}m'::interval)) AS is_expired FROM auth.session WHERE id = ?|;
586 if (!($sth = $dbh->prepare($query)) || !$sth->execute($session_id)) {
587 $sth->finish if $sth;
588 $::lxdebug->leave_sub;
592 $cookie = $sth->fetchrow_hashref;
595 # The session ID provided is valid in the following cases:
596 # 1. session ID exists in the database
597 # 2. hasn't expired yet
598 # 3. if form field '{AUTH}api_token' is given: form field must equal database column 'auth.session.api_token' for the session ID
599 # 4. if form field '{AUTH}api_token' is NOT given then: the requestee's IP address must match the stored IP address
600 $self->{api_token} = $cookie->{api_token} if $cookie;
601 my $api_token_cookie = $self->get_api_token_cookie;
602 my $cookie_is_bad = !$cookie || $cookie->{is_expired};
603 $cookie_is_bad ||= $api_token_cookie && ($api_token_cookie ne $cookie->{api_token}) if $api_token_cookie;
604 $cookie_is_bad ||= $cookie->{ip_address} ne $ENV{REMOTE_ADDR} if !$api_token_cookie;
605 if ($cookie_is_bad) {
606 $self->destroy_session();
607 $main::lxdebug->leave_sub();
608 return $cookie ? SESSION_EXPIRED : SESSION_NONE;
611 if ($self->{column_information}->has('auto_restore')) {
612 $self->_load_with_auto_restore_column($dbh, $session_id);
614 $self->_load_without_auto_restore_column($dbh, $session_id);
617 $main::lxdebug->leave_sub();
622 sub _load_without_auto_restore_column {
623 my ($self, $dbh, $session_id) = @_;
626 SELECT sess_key, sess_value
627 FROM auth.session_content
628 WHERE (session_id = ?)
630 my $sth = prepare_execute_query($::form, $dbh, $query, $session_id);
632 while (my $ref = $sth->fetchrow_hashref) {
633 my $value = SL::Auth::SessionValue->new(auth => $self,
634 key => $ref->{sess_key},
635 value => $ref->{sess_value},
637 $self->{SESSION}->{ $ref->{sess_key} } = $value;
639 next if defined $::form->{$ref->{sess_key}};
641 my $data = $value->get;
642 $::form->{$ref->{sess_key}} = $data if $value->{auto_restore} || !ref $data;
646 sub _load_with_auto_restore_column {
647 my ($self, $dbh, $session_id) = @_;
649 my $auto_restore_keys = join ', ', map { "'${_}'" } qw(login password rpw);
652 SELECT sess_key, sess_value, auto_restore
653 FROM auth.session_content
654 WHERE (session_id = ?)
656 OR sess_key IN (${auto_restore_keys}))
658 my $sth = prepare_execute_query($::form, $dbh, $query, $session_id);
660 while (my $ref = $sth->fetchrow_hashref) {
661 my $value = SL::Auth::SessionValue->new(auth => $self,
662 key => $ref->{sess_key},
663 value => $ref->{sess_value},
664 auto_restore => $ref->{auto_restore},
666 $self->{SESSION}->{ $ref->{sess_key} } = $value;
668 next if defined $::form->{$ref->{sess_key}};
670 my $data = $value->get;
671 $::form->{$ref->{sess_key}} = $data if $value->{auto_restore} || !ref $data;
678 FROM auth.session_content
679 WHERE (session_id = ?)
680 AND NOT COALESCE(auto_restore, FALSE)
681 AND (sess_key NOT IN (${auto_restore_keys}))
683 $sth = prepare_execute_query($::form, $dbh, $query, $session_id);
685 while (my $ref = $sth->fetchrow_hashref) {
686 my $value = SL::Auth::SessionValue->new(auth => $self,
687 key => $ref->{sess_key});
688 $self->{SESSION}->{ $ref->{sess_key} } = $value;
692 sub destroy_session {
693 $main::lxdebug->enter_sub();
698 my $dbh = $self->dbconnect();
702 do_query($main::form, $dbh, qq|DELETE FROM auth.session_content WHERE session_id = ?|, $session_id);
703 do_query($main::form, $dbh, qq|DELETE FROM auth.session WHERE id = ?|, $session_id);
707 SL::SessionFile->destroy_session($session_id);
710 $self->{SESSION} = { };
713 $main::lxdebug->leave_sub();
716 sub active_session_ids {
718 my $dbh = $self->dbconnect;
720 my $query = qq|SELECT id FROM auth.session|;
722 my @ids = selectall_array_query($::form, $dbh, $query);
727 sub expire_sessions {
728 $main::lxdebug->enter_sub();
732 $main::lxdebug->leave_sub and return if !$self->session_tables_present;
734 my $dbh = $self->dbconnect();
736 my $query = qq|SELECT id
738 WHERE (mtime < (now() - '$self->{session_timeout}m'::interval))|;
740 my @ids = selectall_array_query($::form, $dbh, $query);
745 SL::SessionFile->destroy_session($_) for @ids;
747 $query = qq|DELETE FROM auth.session_content
748 WHERE session_id IN (| . join(', ', ('?') x scalar(@ids)) . qq|)|;
749 do_query($main::form, $dbh, $query, @ids);
751 $query = qq|DELETE FROM auth.session
752 WHERE id IN (| . join(', ', ('?') x scalar(@ids)) . qq|)|;
753 do_query($main::form, $dbh, $query, @ids);
758 $main::lxdebug->leave_sub();
761 sub _create_session_id {
762 $main::lxdebug->enter_sub();
765 map { push @data, int(rand() * 255); } (1..32);
767 my $id = md5_hex(pack 'C*', @data);
769 $main::lxdebug->leave_sub();
774 sub create_or_refresh_session {
775 $session_id ||= shift->_create_session_id;
779 $::lxdebug->enter_sub;
781 my $provided_dbh = shift;
783 my $dbh = $provided_dbh || $self->dbconnect(1);
785 $::lxdebug->leave_sub && return unless $dbh && $session_id;
787 $dbh->begin_work unless $provided_dbh;
789 # If this fails then the "auth" schema might not exist yet, e.g. if
790 # the admin is just trying to create the auth database.
791 if (!$dbh->do(qq|LOCK auth.session_content|)) {
792 $dbh->rollback unless $provided_dbh;
793 $::lxdebug->leave_sub;
797 my @unfetched_keys = map { $_->{key} }
798 grep { ! $_->{fetched} }
799 values %{ $self->{SESSION} };
800 # $::lxdebug->dump(0, "unfetched_keys", [ sort @unfetched_keys ]);
801 # $::lxdebug->dump(0, "all keys", [ sort map { $_->{key} } values %{ $self->{SESSION} } ]);
802 my $query = qq|DELETE FROM auth.session_content WHERE (session_id = ?)|;
803 $query .= qq| AND (sess_key NOT IN (| . join(', ', ('?') x scalar @unfetched_keys) . qq|))| if @unfetched_keys;
805 do_query($::form, $dbh, $query, $session_id, @unfetched_keys);
807 my ($id) = selectrow_query($::form, $dbh, qq|SELECT id FROM auth.session WHERE id = ?|, $session_id);
810 do_query($::form, $dbh, qq|UPDATE auth.session SET mtime = now() WHERE id = ?|, $session_id);
812 do_query($::form, $dbh, qq|INSERT INTO auth.session (id, ip_address, mtime) VALUES (?, ?, now())|, $session_id, $ENV{REMOTE_ADDR});
815 if ($self->{column_information}->has('api_token', 'session')) {
816 my ($stored_api_token) = $dbh->selectrow_array(qq|SELECT api_token FROM auth.session WHERE id = ?|, undef, $session_id);
817 do_query($::form, $dbh, qq|UPDATE auth.session SET api_token = ? WHERE id = ?|, $self->_create_session_id, $session_id) unless $stored_api_token;
820 my @values_to_save = grep { $_->{fetched} }
821 values %{ $self->{SESSION} };
822 if (@values_to_save) {
823 my ($columns, $placeholders) = ('', '');
824 my $auto_restore = $self->{column_information}->has('auto_restore');
827 $columns .= ', auto_restore';
828 $placeholders .= ', ?';
831 $query = qq|INSERT INTO auth.session_content (session_id, sess_key, sess_value ${columns}) VALUES (?, ?, ? ${placeholders})|;
832 my $sth = prepare_query($::form, $dbh, $query);
834 foreach my $value (@values_to_save) {
835 my @values = ($value->{key}, $value->get_dumped);
836 push @values, $value->{auto_restore} if $auto_restore;
838 do_statement($::form, $sth, $query, $session_id, @values);
844 $dbh->commit() unless $provided_dbh;
845 $::lxdebug->leave_sub;
848 sub set_session_value {
849 $main::lxdebug->enter_sub();
854 $self->{SESSION} ||= { };
857 my $key = shift @params;
859 if (ref $key eq 'HASH') {
860 $self->{SESSION}->{ $key->{key} } = SL::Auth::SessionValue->new(key => $key->{key},
861 value => $key->{value},
862 auto_restore => $key->{auto_restore});
865 my $value = shift @params;
866 $self->{SESSION}->{ $key } = SL::Auth::SessionValue->new(key => $key,
871 $main::lxdebug->leave_sub();
876 sub delete_session_value {
877 $main::lxdebug->enter_sub();
881 $self->{SESSION} ||= { };
882 delete @{ $self->{SESSION} }{ @_ };
884 $main::lxdebug->leave_sub();
889 sub get_session_value {
890 $main::lxdebug->enter_sub();
893 my $data = $self->{SESSION} && $self->{SESSION}->{ $_[0] } ? $self->{SESSION}->{ $_[0] }->get : undef;
895 $main::lxdebug->leave_sub();
900 sub create_unique_sesion_value {
901 my ($self, $value, %params) = @_;
903 $self->{SESSION} ||= { };
905 my @now = gettimeofday();
906 my $key = "$$-" . ($now[0] * 1000000 + $now[1]) . "-";
907 $self->{unique_counter} ||= 0;
911 $self->{unique_counter}++;
912 $hashed_key = md5_hex($key . $self->{unique_counter});
913 } while (exists $self->{SESSION}->{$hashed_key});
915 $self->set_session_value($hashed_key => $value);
920 sub save_form_in_session {
921 my ($self, %params) = @_;
923 my $form = delete($params{form}) || $::form;
924 my $non_scalars = delete $params{non_scalars};
927 my %skip_keys = map { ( $_ => 1 ) } (qw(login password stylesheet version titlebar), @{ $params{skip_keys} || [] });
929 foreach my $key (grep { !$skip_keys{$_} } keys %{ $form }) {
930 $data->{$key} = $form->{$key} if !ref($form->{$key}) || $non_scalars;
933 return $self->create_unique_sesion_value($data, %params);
936 sub restore_form_from_session {
937 my ($self, $key, %params) = @_;
939 my $data = $self->get_session_value($key);
940 return $self unless $data;
942 my $form = delete($params{form}) || $::form;
943 my $clobber = exists $params{clobber} ? $params{clobber} : 1;
945 map { $form->{$_} = $data->{$_} if $clobber || !exists $form->{$_} } keys %{ $data };
950 sub set_cookie_environment_variable {
952 $ENV{HTTP_COOKIE} = $self->get_session_cookie_name() . "=${session_id}";
955 sub get_session_cookie_name {
956 my ($self, %params) = @_;
958 $params{type} ||= 'id';
959 my $name = $self->{cookie_name} || 'lx_office_erp_session_id';
960 $name .= '_api_token' if $params{type} eq 'api_token';
969 sub get_api_token_cookie {
972 $::request->{cgi}->cookie($self->get_session_cookie_name(type => 'api_token'));
975 sub session_tables_present {
976 $main::lxdebug->enter_sub();
980 # Only re-check for the presence of auth tables if either the check
981 # hasn't been done before of if they weren't present.
982 if ($self->{session_tables_present}) {
983 $main::lxdebug->leave_sub();
984 return $self->{session_tables_present};
987 my $dbh = $self->dbconnect(1);
990 $main::lxdebug->leave_sub();
997 WHERE (schemaname = 'auth')
998 AND (tablename IN ('session', 'session_content'))|;
1000 my ($count) = selectrow_query($main::form, $dbh, $query);
1002 $self->{session_tables_present} = 2 == $count;
1004 $main::lxdebug->leave_sub();
1006 return $self->{session_tables_present};
1009 # --------------------------------------
1011 sub all_rights_full {
1012 my $locale = $main::locale;
1015 ["--crm", $locale->text("CRM optional software")],
1016 ["crm_search", $locale->text("CRM search")],
1017 ["crm_new", $locale->text("CRM create customers, vendors and contacts")],
1018 ["crm_service", $locale->text("CRM services")],
1019 ["crm_admin", $locale->text("CRM admin")],
1020 ["crm_adminuser", $locale->text("CRM user")],
1021 ["crm_adminstatus", $locale->text("CRM status")],
1022 ["crm_email", $locale->text("CRM send email")],
1023 ["crm_termin", $locale->text("CRM termin")],
1024 ["crm_opportunity", $locale->text("CRM opportunity")],
1025 ["crm_knowhow", $locale->text("CRM know how")],
1026 ["crm_follow", $locale->text("CRM follow up")],
1027 ["crm_notices", $locale->text("CRM notices")],
1028 ["crm_other", $locale->text("CRM other")],
1029 ["--master_data", $locale->text("Master Data")],
1030 ["customer_vendor_edit", $locale->text("Create customers and vendors. Edit all vendors. Edit only customers where salesman equals employee (login)")],
1031 ["customer_vendor_all_edit", $locale->text("Create customers and vendors. Edit all vendors. Edit all customers")],
1032 ["part_service_assembly_edit", $locale->text("Create and edit parts, services, assemblies")],
1033 ["project_edit", $locale->text("Create and edit projects")],
1034 ["--ar", $locale->text("AR")],
1035 ["sales_quotation_edit", $locale->text("Create and edit sales quotations")],
1036 ["sales_order_edit", $locale->text("Create and edit sales orders")],
1037 ["sales_delivery_order_edit", $locale->text("Create and edit sales delivery orders")],
1038 ["invoice_edit", $locale->text("Create and edit invoices and credit notes")],
1039 ["dunning_edit", $locale->text("Create and edit dunnings")],
1040 ["sales_all_edit", $locale->text("View/edit all employees sales documents")],
1041 ["edit_prices", $locale->text("Edit prices and discount (if not used, textfield is ONLY set readonly)")],
1042 ["--ap", $locale->text("AP")],
1043 ["request_quotation_edit", $locale->text("Create and edit RFQs")],
1044 ["purchase_order_edit", $locale->text("Create and edit purchase orders")],
1045 ["purchase_delivery_order_edit", $locale->text("Create and edit purchase delivery orders")],
1046 ["vendor_invoice_edit", $locale->text("Create and edit vendor invoices")],
1047 ["--warehouse_management", $locale->text("Warehouse management")],
1048 ["warehouse_contents", $locale->text("View warehouse content")],
1049 ["warehouse_management", $locale->text("Warehouse management")],
1050 ["--general_ledger_cash", $locale->text("General ledger and cash")],
1051 ["general_ledger", $locale->text("Transactions, AR transactions, AP transactions")],
1052 ["datev_export", $locale->text("DATEV Export")],
1053 ["cash", $locale->text("Receipt, payment, reconciliation")],
1054 ["--reports", $locale->text('Reports')],
1055 ["report", $locale->text('All reports')],
1056 ["advance_turnover_tax_return", $locale->text('Advance turnover tax return')],
1057 ["--batch_printing", $locale->text("Batch Printing")],
1058 ["batch_printing", $locale->text("Batch Printing")],
1059 ["--others", $locale->text("Others")],
1060 ["email_bcc", $locale->text("May set the BCC field when sending emails")],
1061 ["config", $locale->text("Change kivitendo installation settings (all menu entries beneath 'System')")],
1062 ["admin", $locale->text("Administration (Used to access instance administration from user logins)")],
1063 ["productivity", $locale->text("Productivity")],
1064 ["display_admin_link", $locale->text("Show administration link")],
1071 return grep !/^--/, map { $_->[0] } all_rights_full();
1075 $main::lxdebug->enter_sub();
1079 my $form = $main::form;
1081 my $dbh = $self->dbconnect();
1083 my $query = 'SELECT * FROM auth."group"';
1084 my $sth = prepare_execute_query($form, $dbh, $query);
1088 while ($row = $sth->fetchrow_hashref()) {
1089 $groups->{$row->{id}} = $row;
1093 $query = 'SELECT * FROM auth.user_group WHERE group_id = ?';
1094 $sth = prepare_query($form, $dbh, $query);
1096 foreach $group (values %{$groups}) {
1099 do_statement($form, $sth, $query, $group->{id});
1101 while ($row = $sth->fetchrow_hashref()) {
1102 push @members, $row->{user_id};
1104 $group->{members} = [ uniq @members ];
1108 $query = 'SELECT * FROM auth.group_rights WHERE group_id = ?';
1109 $sth = prepare_query($form, $dbh, $query);
1111 foreach $group (values %{$groups}) {
1112 $group->{rights} = {};
1114 do_statement($form, $sth, $query, $group->{id});
1116 while ($row = $sth->fetchrow_hashref()) {
1117 $group->{rights}->{$row->{right}} |= $row->{granted};
1120 map { $group->{rights}->{$_} = 0 if (!defined $group->{rights}->{$_}); } all_rights();
1124 $main::lxdebug->leave_sub();
1130 $main::lxdebug->enter_sub();
1135 my $form = $main::form;
1136 my $dbh = $self->dbconnect();
1140 my ($query, $sth, $row, $rights);
1142 if (!$group->{id}) {
1143 ($group->{id}) = selectrow_query($form, $dbh, qq|SELECT nextval('auth.group_id_seq')|);
1145 $query = qq|INSERT INTO auth."group" (id, name, description) VALUES (?, '', '')|;
1146 do_query($form, $dbh, $query, $group->{id});
1149 do_query($form, $dbh, qq|UPDATE auth."group" SET name = ?, description = ? WHERE id = ?|, map { $group->{$_} } qw(name description id));
1151 do_query($form, $dbh, qq|DELETE FROM auth.user_group WHERE group_id = ?|, $group->{id});
1153 $query = qq|INSERT INTO auth.user_group (user_id, group_id) VALUES (?, ?)|;
1154 $sth = prepare_query($form, $dbh, $query);
1156 foreach my $user_id (uniq @{ $group->{members} }) {
1157 do_statement($form, $sth, $query, $user_id, $group->{id});
1161 do_query($form, $dbh, qq|DELETE FROM auth.group_rights WHERE group_id = ?|, $group->{id});
1163 $query = qq|INSERT INTO auth.group_rights (group_id, "right", granted) VALUES (?, ?, ?)|;
1164 $sth = prepare_query($form, $dbh, $query);
1166 foreach my $right (keys %{ $group->{rights} }) {
1167 do_statement($form, $sth, $query, $group->{id}, $right, $group->{rights}->{$right} ? 't' : 'f');
1173 $main::lxdebug->leave_sub();
1177 $main::lxdebug->enter_sub();
1182 my $form = $main::form;
1184 my $dbh = $self->dbconnect();
1187 do_query($form, $dbh, qq|DELETE FROM auth.user_group WHERE group_id = ?|, $id);
1188 do_query($form, $dbh, qq|DELETE FROM auth.group_rights WHERE group_id = ?|, $id);
1189 do_query($form, $dbh, qq|DELETE FROM auth."group" WHERE id = ?|, $id);
1193 $main::lxdebug->leave_sub();
1196 sub evaluate_rights_ary {
1197 $main::lxdebug->enter_sub(2);
1204 foreach my $el (@{$ary}) {
1205 if (ref $el eq "ARRAY") {
1206 if ($action eq '|') {
1207 $value |= evaluate_rights_ary($el);
1209 $value &= evaluate_rights_ary($el);
1212 } elsif (($el eq '&') || ($el eq '|')) {
1215 } elsif ($action eq '|') {
1224 $main::lxdebug->leave_sub(2);
1229 sub _parse_rights_string {
1230 $main::lxdebug->enter_sub(2);
1240 push @stack, $cur_ary;
1242 while ($access =~ m/^([a-z_0-9]+|\||\&|\(|\)|\s+)/) {
1244 substr($access, 0, length $1) = "";
1246 next if ($token =~ /\s/);
1248 if ($token eq "(") {
1249 my $new_cur_ary = [];
1250 push @stack, $new_cur_ary;
1251 push @{$cur_ary}, $new_cur_ary;
1252 $cur_ary = $new_cur_ary;
1254 } elsif ($token eq ")") {
1258 $main::lxdebug->leave_sub(2);
1262 $cur_ary = $stack[-1];
1264 } elsif (($token eq "|") || ($token eq "&")) {
1265 push @{$cur_ary}, $token;
1268 push @{$cur_ary}, $self->{RIGHTS}->{$login}->{$token} * 1;
1272 my $result = ($access || (1 < scalar @stack)) ? 0 : evaluate_rights_ary($stack[0]);
1274 $main::lxdebug->leave_sub(2);
1280 $main::lxdebug->enter_sub(2);
1285 my $default = shift;
1287 $self->{FULL_RIGHTS} ||= { };
1288 $self->{FULL_RIGHTS}->{$login} ||= { };
1290 if (!defined $self->{FULL_RIGHTS}->{$login}->{$right}) {
1291 $self->{RIGHTS} ||= { };
1292 $self->{RIGHTS}->{$login} ||= $self->load_rights_for_user($login);
1294 $self->{FULL_RIGHTS}->{$login}->{$right} = $self->_parse_rights_string($login, $right);
1297 my $granted = $self->{FULL_RIGHTS}->{$login}->{$right};
1298 $granted = $default if (!defined $granted);
1300 $main::lxdebug->leave_sub(2);
1306 $::lxdebug->enter_sub(2);
1307 my ($self, $right, $dont_abort) = @_;
1309 if ($self->check_right($::myconfig{login}, $right)) {
1310 $::lxdebug->leave_sub(2);
1315 delete $::form->{title};
1316 $::form->show_generic_error($::locale->text("You do not have the permissions to access this function."));
1319 $::lxdebug->leave_sub(2);
1324 sub load_rights_for_user {
1325 $::lxdebug->enter_sub;
1327 my ($self, $login) = @_;
1328 my $dbh = $self->dbconnect;
1329 my ($query, $sth, $row, $rights);
1331 $rights = { map { $_ => 0 } all_rights() };
1334 qq|SELECT gr."right", gr.granted
1335 FROM auth.group_rights gr
1338 FROM auth.user_group ug
1339 LEFT JOIN auth."user" u ON (ug.user_id = u.id)
1340 WHERE u.login = ?)|;
1342 $sth = prepare_execute_query($::form, $dbh, $query, $login);
1344 while ($row = $sth->fetchrow_hashref()) {
1345 $rights->{$row->{right}} |= $row->{granted};
1349 $::lxdebug->leave_sub;
1363 SL::Auth - Authentication and session handling
1369 =item C<set_session_value @values>
1371 =item C<set_session_value %values>
1373 Store all values of C<@values> or C<%values> in the session. Each
1374 member of C<@values> is tested if it is a hash reference. If it is
1375 then it must contain the keys C<key> and C<value> and can optionally
1376 contain the key C<auto_restore>. In this case C<value> is associated
1377 with C<key> and restored to C<$::form> upon the next request
1378 automatically if C<auto_restore> is trueish or if C<value> is a scalar
1381 If the current member of C<@values> is not a hash reference then it
1382 will be used as the C<key> and the next entry of C<@values> is used as
1383 the C<value> to store. In this case setting C<auto_restore> is not
1386 Therefore the following two invocations are identical:
1388 $::auth-E<gt>set_session_value(name =E<gt> "Charlie");
1389 $::auth-E<gt>set_session_value({ key =E<gt> "name", value =E<gt> "Charlie" });
1391 All of these values are copied back into C<$::form> for the next
1392 request automatically if they're scalar values or if they have
1393 C<auto_restore> set to trueish.
1395 The values can be any Perl structure. They are stored as YAML dumps.
1397 =item C<get_session_value $key>
1399 Retrieve a value from the session. Returns C<undef> if the value
1402 =item C<create_unique_sesion_value $value, %params>
1404 Create a unique key in the session and store C<$value>
1407 Returns the key created in the session.
1409 =item C<save_session>
1411 Stores the session values in the database. This is the only function
1412 that actually stores stuff in the database. Neither the various
1413 setters nor the deleter access the database.
1415 =item <save_form_in_session %params>
1417 Stores the content of C<$params{form}> (default: C<$::form>) in the
1418 session using L</create_unique_sesion_value>.
1420 If C<$params{non_scalars}> is trueish then non-scalar values will be
1421 stored as well. Default is to only store scalar values.
1423 The following keys will never be saved: C<login>, C<password>,
1424 C<stylesheet>, C<titlebar>, C<version>. Additional keys not to save
1425 can be given as an array ref in C<$params{skip_keys}>.
1427 Returns the unique key under which the form is stored.
1429 =item <restore_form_from_session $key, %params>
1431 Restores the form from the session into C<$params{form}> (default:
1434 If C<$params{clobber}> is falsish then existing values with the same
1435 key in C<$params{form}> will not be overwritten. C<$params{clobber}>
1448 Moritz Bunkus E<lt>m.bunkus@linet-services.deE<gt>