sub new {
- $main::lxdebug->enter_sub();
+ my ($type, %params) = @_;
+ my $self = bless {}, $type;
- my $type = shift;
- my $self = {};
-
- bless $self, $type;
-
- $self->_read_auth_config();
+ $self->_read_auth_config(%params);
$self->reset;
- $main::lxdebug->leave_sub();
-
return $self;
}
}
sub _read_auth_config {
- $main::lxdebug->enter_sub();
-
- my $self = shift;
+ my ($self, %params) = @_;
map { $self->{$_} = $::lx_office_conf{authentication}->{$_} } keys %{ $::lx_office_conf{authentication} };
# Prevent password leakage to log files when dumping Auth instances.
$self->{admin_password} = sub { $::lx_office_conf{authentication}->{admin_password} };
- $self->{DB_config} = $::lx_office_conf{'authentication/database'};
- $self->{LDAP_config} = $::lx_office_conf{'authentication/ldap'};
+ if ($params{unit_tests_database}) {
+ $self->{DB_config} = $::lx_office_conf{'testing/database'};
+ $self->{module} = 'DB';
+
+ } else {
+ $self->{DB_config} = $::lx_office_conf{'authentication/database'};
+ $self->{LDAP_config} = $::lx_office_conf{'authentication/ldap'};
+ }
if ($self->{module} eq 'DB') {
$self->{authenticator} = SL::Auth::DB->new($self);
$self->{session_timeout} *= 1;
$self->{session_timeout} = 8 * 60 if (!$self->{session_timeout});
-
- $main::lxdebug->leave_sub();
}
sub has_access_to_client {
}
sub authenticate_root {
- $main::lxdebug->enter_sub();
-
my ($self, $password) = @_;
my $session_root_auth = $self->get_session_value(SESSION_KEY_ROOT_AUTH());
if (defined $session_root_auth && $session_root_auth == OK) {
- $::lxdebug->leave_sub;
return OK;
}
if (!defined $password) {
- $::lxdebug->leave_sub;
return ERR_PASSWORD;
}
my $result = $password eq $admin_password ? OK : ERR_PASSWORD;
$self->set_session_value(SESSION_KEY_ROOT_AUTH() => $result);
- $::lxdebug->leave_sub;
return $result;
}
sub authenticate {
- $main::lxdebug->enter_sub();
-
my ($self, $login, $password) = @_;
if (!$self->client || !$self->has_access_to_client($login)) {
- $::lxdebug->leave_sub;
return ERR_PASSWORD;
}
my $session_auth = $self->get_session_value(SESSION_KEY_USER_AUTH());
if (defined $session_auth && $session_auth == OK) {
- $::lxdebug->leave_sub;
return OK;
}
if (!defined $password) {
- $::lxdebug->leave_sub;
return ERR_PASSWORD;
}
my $result = $login ? $self->{authenticator}->authenticate($login, $password) : ERR_USER;
$self->set_session_value(SESSION_KEY_USER_AUTH() => $result, login => $login, client_id => $self->client->{id});
-
- $::lxdebug->leave_sub;
return $result;
}
}
sub dbconnect {
- $main::lxdebug->enter_sub(2);
-
my $self = shift;
my $may_fail = shift;
if ($self->{dbh}) {
- $main::lxdebug->leave_sub(2);
return $self->{dbh};
}
$main::form->error($main::locale->text('The connection to the authentication database failed:') . "\n" . $DBI::errstr);
}
- $main::lxdebug->leave_sub(2);
-
return $self->{dbh};
}
sub dbdisconnect {
- $main::lxdebug->enter_sub();
-
my $self = shift;
if ($self->{dbh}) {
$self->{dbh}->disconnect();
delete $self->{dbh};
}
-
- $main::lxdebug->leave_sub();
}
sub check_tables {
- $main::lxdebug->enter_sub();
-
my ($self, $dbh) = @_;
$dbh ||= $self->dbconnect();
my ($count) = $dbh->selectrow_array($query);
- $main::lxdebug->leave_sub();
-
return $count > 0;
}
sub check_database {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $dbh = $self->dbconnect(1);
- $main::lxdebug->leave_sub();
-
return $dbh ? 1 : 0;
}
sub create_database {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my %params = @_;
}
$dbh->disconnect();
-
- $main::lxdebug->leave_sub();
}
sub create_tables {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $dbh = $self->dbconnect();
$dbh->rollback();
SL::DBUpgrade2->new(form => $::form)->process_query($dbh, 'sql/auth_db.sql');
-
- $main::lxdebug->leave_sub();
}
sub save_user {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $login = shift;
my %params = @_;
}
$dbh->commit();
-
- $main::lxdebug->leave_sub();
}
sub can_change_password {
}
sub change_password {
- $main::lxdebug->enter_sub();
-
my ($self, $login, $new_password) = @_;
my $result = $self->{authenticator}->change_password($login, $new_password);
- $main::lxdebug->leave_sub();
-
return $result;
}
sub read_all_users {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $dbh = $self->dbconnect();
$sth->finish();
- $main::lxdebug->leave_sub();
-
return %users;
}
sub read_user {
- $main::lxdebug->enter_sub();
-
my ($self, %params) = @_;
my $dbh = $self->dbconnect();
$sth->finish();
- $main::lxdebug->leave_sub();
-
return %user_data;
}
sub get_user_id {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $login = shift;
my $dbh = $self->dbconnect();
my ($id) = selectrow_query($main::form, $dbh, qq|SELECT id FROM auth."user" WHERE login = ?|, $login);
- $main::lxdebug->leave_sub();
-
return $id;
}
sub delete_user {
- $::lxdebug->enter_sub;
-
my $self = shift;
my $login = shift;
my $dbh = $self->dbconnect;
my $id = $self->get_user_id($login);
- $dbh->rollback and return $::lxdebug->leave_sub if (!$id);
+ if (!$id) {
+ $dbh->rollback;
+ return;
+ }
$dbh->begin_work;
# do_query($::form, $u_dbh, qq|UPDATE employee SET deleted = 't' WHERE login = ?|, $login) if $u_dbh && $user_db_exists;
$dbh->commit;
-
- $::lxdebug->leave_sub;
}
# --------------------------------------
my $session_id;
sub restore_session {
- $main::lxdebug->enter_sub();
-
my $self = shift;
$session_id = $::request->{cgi}->cookie($self->get_session_cookie_name());
$self->{SESSION} = { };
if (!$session_id) {
- $main::lxdebug->leave_sub();
return $self->session_restore_result(SESSION_NONE());
}
# Don't fail if the auth DB doesn't yet.
if (!( $dbh = $self->dbconnect(1) )) {
- $::lxdebug->leave_sub;
return $self->session_restore_result(SESSION_NONE());
}
if (!($sth = $dbh->prepare($query)) || !$sth->execute($session_id)) {
$sth->finish if $sth;
- $::lxdebug->leave_sub;
return $self->session_restore_result(SESSION_NONE());
}
# The session ID provided is valid in the following cases:
# 1. session ID exists in the database
# 2. hasn't expired yet
- # 3. if form field '{AUTH}api_token' is given: form field must equal database column 'auth.session.api_token' for the session ID
- # 4. if form field '{AUTH}api_token' is NOT given then: the requestee's IP address must match the stored IP address
+ # 3. if cookie for the API token is given: the cookie's value equal database column 'auth.session.api_token' for the session ID
+ # 4. if cookie for the API token is NOT given then: the requestee's IP address must match the stored IP address
$self->{api_token} = $cookie->{api_token} if $cookie;
my $api_token_cookie = $self->get_api_token_cookie;
my $cookie_is_bad = !$cookie || $cookie->{is_expired};
$cookie_is_bad ||= $cookie->{ip_address} ne $ENV{REMOTE_ADDR} if !$api_token_cookie;
if ($cookie_is_bad) {
$self->destroy_session();
- $main::lxdebug->leave_sub();
return $self->session_restore_result($cookie ? SESSION_EXPIRED() : SESSION_NONE());
}
$self->_load_without_auto_restore_column($dbh, $session_id);
}
- $main::lxdebug->leave_sub();
-
return $self->session_restore_result(SESSION_OK());
}
}
sub destroy_session {
- $main::lxdebug->enter_sub();
-
my $self = shift;
if ($session_id) {
$session_id = undef;
$self->{SESSION} = { };
}
-
- $main::lxdebug->leave_sub();
}
sub active_session_ids {
}
sub expire_sessions {
- $main::lxdebug->enter_sub();
-
my $self = shift;
- $main::lxdebug->leave_sub and return if !$self->session_tables_present;
+ return if !$self->session_tables_present;
my $dbh = $self->dbconnect();
$dbh->commit();
}
-
- $main::lxdebug->leave_sub();
}
sub _create_session_id {
- $main::lxdebug->enter_sub();
-
my @data;
map { push @data, int(rand() * 255); } (1..32);
my $id = md5_hex(pack 'C*', @data);
- $main::lxdebug->leave_sub();
-
return $id;
}
}
sub save_session {
- $::lxdebug->enter_sub;
my $self = shift;
my $provided_dbh = shift;
my $dbh = $provided_dbh || $self->dbconnect(1);
- $::lxdebug->leave_sub && return unless $dbh && $session_id;
+ return unless $dbh && $session_id;
$dbh->begin_work unless $provided_dbh;
# the admin is just trying to create the auth database.
if (!$dbh->do(qq|LOCK auth.session_content|)) {
$dbh->rollback unless $provided_dbh;
- $::lxdebug->leave_sub;
return;
}
}
$dbh->commit() unless $provided_dbh;
- $::lxdebug->leave_sub;
}
sub set_session_value {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my @params = @_;
}
}
- $main::lxdebug->leave_sub();
-
return $self;
}
sub delete_session_value {
- $main::lxdebug->enter_sub();
-
my $self = shift;
$self->{SESSION} ||= { };
delete @{ $self->{SESSION} }{ @_ };
- $main::lxdebug->leave_sub();
-
return $self;
}
sub get_session_value {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $data = $self->{SESSION} && $self->{SESSION}->{ $_[0] } ? $self->{SESSION}->{ $_[0] }->get : undef;
- $main::lxdebug->leave_sub();
-
return $data;
}
$::request->{cgi}->cookie($self->get_session_cookie_name(type => 'api_token'));
}
-sub session_tables_present {
- $main::lxdebug->enter_sub();
+sub is_api_token_cookie_valid {
+ my ($self) = @_;
+ my $provided_api_token = $self->get_api_token_cookie;
+ return $self->{api_token} && $provided_api_token && ($self->{api_token} eq $provided_api_token);
+}
+sub session_tables_present {
my $self = shift;
# Only re-check for the presence of auth tables if either the check
# hasn't been done before of if they weren't present.
if ($self->{session_tables_present}) {
- $main::lxdebug->leave_sub();
return $self->{session_tables_present};
}
my $dbh = $self->dbconnect(1);
if (!$dbh) {
- $main::lxdebug->leave_sub();
return 0;
}
$self->{session_tables_present} = 2 == $count;
- $main::lxdebug->leave_sub();
-
return $self->{session_tables_present};
}
["customer_vendor_edit", $locale->text("Create customers and vendors. Edit all vendors. Edit only customers where salesman equals employee (login)")],
["customer_vendor_all_edit", $locale->text("Create customers and vendors. Edit all vendors. Edit all customers")],
["part_service_assembly_edit", $locale->text("Create and edit parts, services, assemblies")],
+ ["part_service_assembly_details", $locale->text("Show details and reports of parts, services, assemblies")],
["project_edit", $locale->text("Create and edit projects")],
["--ar", $locale->text("AR")],
+ ["requirement_spec_edit", $locale->text("Create and edit requirement specs")],
["sales_quotation_edit", $locale->text("Create and edit sales quotations")],
["sales_order_edit", $locale->text("Create and edit sales orders")],
["sales_delivery_order_edit", $locale->text("Create and edit sales delivery orders")],
["invoice_edit", $locale->text("Create and edit invoices and credit notes")],
["dunning_edit", $locale->text("Create and edit dunnings")],
+ ["sales_letter_edit", $locale->text("Edit sales letters")],
["sales_all_edit", $locale->text("View/edit all employees sales documents")],
["edit_prices", $locale->text("Edit prices and discount (if not used, textfield is ONLY set readonly)")],
+ ["show_ar_transactions", $locale->text("Show AR transactions as part of AR invoice report")],
+ ["delivery_plan", $locale->text("Show delivery plan")],
+ ["delivery_value_report", $locale->text("Show delivery value report")],
+ ["sales_letter_report", $locale->text("Show sales letters report")],
["--ap", $locale->text("AP")],
["request_quotation_edit", $locale->text("Create and edit RFQs")],
["purchase_order_edit", $locale->text("Create and edit purchase orders")],
["purchase_delivery_order_edit", $locale->text("Create and edit purchase delivery orders")],
["vendor_invoice_edit", $locale->text("Create and edit vendor invoices")],
+ ["show_ap_transactions", $locale->text("Show AP transactions as part of AP invoice report")],
["--warehouse_management", $locale->text("Warehouse management")],
["warehouse_contents", $locale->text("View warehouse content")],
["warehouse_management", $locale->text("Warehouse management")],
["general_ledger", $locale->text("Transactions, AR transactions, AP transactions")],
["datev_export", $locale->text("DATEV Export")],
["cash", $locale->text("Receipt, payment, reconciliation")],
+ ["bank_transaction", $locale->text("Bank transactions")],
["--reports", $locale->text('Reports')],
["report", $locale->text('All reports')],
["advance_turnover_tax_return", $locale->text('Advance turnover tax return')],
["--batch_printing", $locale->text("Batch Printing")],
["batch_printing", $locale->text("Batch Printing")],
+ ["--configuration", $locale->text("Configuration")],
+ ["config", $locale->text("Change kivitendo installation settings (most entries in the 'System' menu)")],
+ ["admin", $locale->text("Client administration: configuration, editing templates, task server control, background jobs (remaining entries in the 'System' menu)")],
["--others", $locale->text("Others")],
["email_bcc", $locale->text("May set the BCC field when sending emails")],
- ["config", $locale->text("Change kivitendo installation settings (all menu entries beneath 'System')")],
- ["admin", $locale->text("Administration (Used to access instance administration from user logins)")],
["productivity", $locale->text("Productivity")],
["display_admin_link", $locale->text("Show administration link")],
);
}
sub read_groups {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $form = $main::form;
}
$sth->finish();
- $main::lxdebug->leave_sub();
-
return $groups;
}
sub save_group {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $group = shift;
$sth->finish();
$dbh->commit();
-
- $main::lxdebug->leave_sub();
}
sub delete_group {
- $main::lxdebug->enter_sub();
-
my $self = shift;
my $id = shift;
do_query($form, $dbh, qq|DELETE FROM auth."group" WHERE id = ?|, $id);
$dbh->commit();
-
- $main::lxdebug->leave_sub();
}
sub evaluate_rights_ary {
- $main::lxdebug->enter_sub(2);
-
my $ary = shift;
my $value = 0;
}
}
- $main::lxdebug->leave_sub(2);
-
return $value;
}
sub _parse_rights_string {
- $main::lxdebug->enter_sub(2);
-
my $self = shift;
my $login = shift;
pop @stack;
if (!@stack) {
- $main::lxdebug->leave_sub(2);
return 0;
}
my $result = ($access || (1 < scalar @stack)) ? 0 : evaluate_rights_ary($stack[0]);
- $main::lxdebug->leave_sub(2);
-
return $result;
}
sub check_right {
- $main::lxdebug->enter_sub(2);
-
my $self = shift;
my $login = shift;
my $right = shift;
my $granted = $self->{FULL_RIGHTS}->{$login}->{$right};
$granted = $default if (!defined $granted);
- $main::lxdebug->leave_sub(2);
-
return $granted;
}
sub assert {
- $::lxdebug->enter_sub(2);
my ($self, $right, $dont_abort) = @_;
if ($self->check_right($::myconfig{login}, $right)) {
- $::lxdebug->leave_sub(2);
return 1;
}
$::form->show_generic_error($::locale->text("You do not have the permissions to access this function."));
}
- $::lxdebug->leave_sub(2);
-
return 0;
}
sub load_rights_for_user {
- $::lxdebug->enter_sub;
-
my ($self, $login) = @_;
my $dbh = $self->dbconnect;
my ($query, $sth, $row, $rights);
$rights = { map { $_ => 0 } all_rights() };
+ return $rights if !$self->client || !$login;
+
$query =
qq|SELECT gr."right", gr.granted
FROM auth.group_rights gr
}
$sth->finish();
- $::lxdebug->leave_sub;
-
return $rights;
}
SL::Auth - Authentication and session handling
-=head1 FUNCTIONS
+=head1 METHODS
=over 4
that actually stores stuff in the database. Neither the various
setters nor the deleter access the database.
-=item <save_form_in_session %params>
+=item C<save_form_in_session %params>
Stores the content of C<$params{form}> (default: C<$::form>) in the
session using L</create_unique_sesion_value>.
Returns the unique key under which the form is stored.
-=item <restore_form_from_session $key, %params>
+=item C<restore_form_from_session $key, %params>
Restores the form from the session into C<$params{form}> (default:
C<$::form>).
Returns C<$self>.
+=item C<reset>
+
+C<reset> deletes every state information from previous requests, but does not
+close the database connection.
+
+Creating a new database handle on each request can take up to 30% of the
+pre-request startup time, so we want to avoid that for fast ajax calls.
+
=back
=head1 BUGS