Skip to content

FOUR-9018: Define a variable in ENV to turn off the security Logs #4937

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
pmPaulis merged 1 commit into from
Jun 30, 2023
Merged

FOUR-9018: Define a variable in ENV to turn off the security Logs #4937

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
241 changes: 99 additions & 142 deletions ProcessMaker/Providers/EventServiceProvider.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,54 @@
namespace ProcessMaker\Providers;

use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
use ProcessMaker\Events\ActivityReassignment;
use ProcessMaker\Events\AuthClientCreated;
use ProcessMaker\Events\AuthClientDeleted;
use ProcessMaker\Events\AuthClientUpdated;
use ProcessMaker\Events\CategoryCreated;
use ProcessMaker\Events\CategoryDeleted;
use ProcessMaker\Events\CategoryUpdated;
use ProcessMaker\Events\CustomizeUiUpdated;
use ProcessMaker\Events\EnvironmentVariablesUpdated;
use ProcessMaker\Events\EnvironmentVariablesCreated;
use ProcessMaker\Events\EnvironmentVariablesDeleted;
use ProcessMaker\Events\FilesCreated;
use ProcessMaker\Events\FilesDeleted;
use ProcessMaker\Events\FilesUpdated;
use ProcessMaker\Events\GroupCreated;
use ProcessMaker\Events\GroupDeleted;
use ProcessMaker\Events\GroupUpdated;
use ProcessMaker\Events\GroupUsersUpdated;
use ProcessMaker\Events\PermissionUpdated;
use ProcessMaker\Events\ProcessArchived;
use ProcessMaker\Events\ProcessCreated;
use ProcessMaker\Events\ProcessPublished;
use ProcessMaker\Events\ProcessRestored;
use ProcessMaker\Events\ProcessUpdated;
use ProcessMaker\Events\RequestAction;
use ProcessMaker\Events\RequestError;
use ProcessMaker\Events\ScreenCreated;
use ProcessMaker\Events\ScreenDeleted;
use ProcessMaker\Events\ScreenUpdated;
use ProcessMaker\Events\ScriptCreated;
use ProcessMaker\Events\ScriptDeleted;
use ProcessMaker\Events\ScriptDuplicated;
use ProcessMaker\Events\ScriptExecutorCreated;
use ProcessMaker\Events\ScriptExecutorDeleted;
use ProcessMaker\Events\ScriptExecutorUpdated;
use ProcessMaker\Events\ScriptUpdated;
use ProcessMaker\Events\SettingsUpdated;
use ProcessMaker\Events\TemplateCreated;
use ProcessMaker\Events\TemplateDeleted;
use ProcessMaker\Events\TemplateUpdated;
use ProcessMaker\Events\TokenCreated;
use ProcessMaker\Events\TokenDeleted;
use ProcessMaker\Events\UnauthorizedAccessAttempt;
use ProcessMaker\Events\UserCreated;
use ProcessMaker\Events\UserDeleted;
use ProcessMaker\Events\UserGroupMembershipUpdated;
use ProcessMaker\Events\UserUpdated;
use ProcessMaker\Listeners\SecurityLogger;

/**
* Register our Events and their Listeners
Expand All @@ -27,151 +75,9 @@ class EventServiceProvider extends ServiceProvider
'Illuminate\Database\Events\MigrationsEnded' => [
'ProcessMaker\Listeners\UpdateDataLakeViews',
],
'ProcessMaker\Events\ActivityReassignment' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\AuthClientUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\AuthClientCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\AuthClientDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\CategoryCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\CategoryDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\CategoryUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\CustomizeUiUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\EnvironmentVariablesCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\EnvironmentVariablesDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\EnvironmentVariablesUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\FilesCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\FilesDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\FilesUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\GroupCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\GroupDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\GroupUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\GroupUsersUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\PermissionUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ProcessCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ProcessArchived' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ProcessPublished' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ProcessRestored' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ProcessUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\RequestError' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\RequestAction' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScreenCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScreenDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScreenUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptDuplicated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptExecutorCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptExecutorDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\ScriptExecutorUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\SessionStarted' => [
'ProcessMaker\Listeners\ActiveUserListener',
],
'ProcessMaker\Events\SettingsUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\TemplateCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\TemplateDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\TemplateUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\TokenCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\TokenDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\UnauthorizedAccessAttempt' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\UserCreated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\UserDeleted' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\UserGroupMembershipUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],
'ProcessMaker\Events\UserUpdated' => [
'ProcessMaker\Listeners\SecurityLogger',
],

];

/**
Expand All @@ -181,5 +87,56 @@ class EventServiceProvider extends ServiceProvider
public function boot()
{
parent::boot();

// Check if the variable security_log is enable
if (config('app.security_log')) {
$this->app['events']->listen(ActivityReassignment::class, SecurityLogger::class);
$this->app['events']->listen(AuthClientUpdated::class, SecurityLogger::class);
$this->app['events']->listen(AuthClientCreated::class, SecurityLogger::class);
$this->app['events']->listen(AuthClientDeleted::class, SecurityLogger::class);
$this->app['events']->listen(CategoryCreated::class, SecurityLogger::class);
$this->app['events']->listen(CategoryDeleted::class, SecurityLogger::class);
$this->app['events']->listen(CategoryUpdated::class, SecurityLogger::class);
$this->app['events']->listen(CustomizeUiUpdated::class, SecurityLogger::class);
$this->app['events']->listen(EnvironmentVariablesCreated::class, SecurityLogger::class);
$this->app['events']->listen(EnvironmentVariablesDeleted::class, SecurityLogger::class);
$this->app['events']->listen(EnvironmentVariablesUpdated::class, SecurityLogger::class);
$this->app['events']->listen(FilesCreated::class, SecurityLogger::class);
$this->app['events']->listen(FilesDeleted::class, SecurityLogger::class);
$this->app['events']->listen(FilesUpdated::class, SecurityLogger::class);
$this->app['events']->listen(GroupCreated::class, SecurityLogger::class);
$this->app['events']->listen(GroupDeleted::class, SecurityLogger::class);
$this->app['events']->listen(GroupUpdated::class, SecurityLogger::class);
$this->app['events']->listen(GroupUsersUpdated::class, SecurityLogger::class);
$this->app['events']->listen(PermissionUpdated::class, SecurityLogger::class);
$this->app['events']->listen(ProcessCreated::class, SecurityLogger::class);
$this->app['events']->listen(ProcessArchived::class, SecurityLogger::class);
$this->app['events']->listen(ProcessPublished::class, SecurityLogger::class);
$this->app['events']->listen(ProcessRestored::class, SecurityLogger::class);
$this->app['events']->listen(ProcessUpdated::class, SecurityLogger::class);
$this->app['events']->listen(RequestError::class, SecurityLogger::class);
$this->app['events']->listen(RequestAction::class, SecurityLogger::class);
$this->app['events']->listen(ScreenCreated::class, SecurityLogger::class);
$this->app['events']->listen(ScreenDeleted::class, SecurityLogger::class);
$this->app['events']->listen(ScreenUpdated::class, SecurityLogger::class);
$this->app['events']->listen(ScriptCreated::class, SecurityLogger::class);
$this->app['events']->listen(ScriptDeleted::class, SecurityLogger::class);
$this->app['events']->listen(ScriptDuplicated::class, SecurityLogger::class);
$this->app['events']->listen(ScriptExecutorCreated::class, SecurityLogger::class);
$this->app['events']->listen(ScriptExecutorDeleted::class, SecurityLogger::class);
$this->app['events']->listen(ScriptExecutorUpdated::class, SecurityLogger::class);
$this->app['events']->listen(ScriptUpdated::class, SecurityLogger::class);
$this->app['events']->listen(SettingsUpdated::class, SecurityLogger::class);
$this->app['events']->listen(TemplateCreated::class, SecurityLogger::class);
$this->app['events']->listen(TemplateDeleted::class, SecurityLogger::class);
$this->app['events']->listen(TemplateUpdated::class, SecurityLogger::class);
$this->app['events']->listen(TokenCreated::class, SecurityLogger::class);
$this->app['events']->listen(TokenDeleted::class, SecurityLogger::class);
$this->app['events']->listen(UnauthorizedAccessAttempt::class, SecurityLogger::class);
$this->app['events']->listen(UserCreated::class, SecurityLogger::class);
$this->app['events']->listen(UserDeleted::class, SecurityLogger::class);
$this->app['events']->listen(UserGroupMembershipUpdated::class, SecurityLogger::class);
$this->app['events']->listen(UserUpdated::class, SecurityLogger::class);
}
}
}
14 changes: 11 additions & 3 deletions config/app.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,9 +85,14 @@
'bpmn_actions_lock_check_interval' => (int) env('BPMN_ACTIONS_LOCK_CHECK_INTERVAL', 1000),

// The url of our host from inside the docker
'docker_host_url' => env('DOCKER_HOST_URL',
preg_replace('/(\w+):\/\/([^:\/]+)(\:\d+)?/', '$1://172.17.0.1$3',
env('APP_URL', 'http://localhost'))),
'docker_host_url' => env(
'DOCKER_HOST_URL',
preg_replace(
'/(\w+):\/\/([^:\/]+)(\:\d+)?/',
'$1://172.17.0.1$3',
env('APP_URL', 'http://localhost')
)
),

// Allows our script executors to ignore invalid SSL. This should only be set to false for development.
'api_ssl_verify' => env('API_SSL_VERIFY', 'true'),
Expand All @@ -101,6 +106,9 @@
// Microservice AI Host
'ai_microservice_host' => env('AI_MICROSERVICE_HOST'),

// Security log
'security_log' => env('SECURITY_LOG', 'true'),

// Message broker driver to use in Workflow Manager
'message_broker_driver' => env('MESSAGE_BROKER_DRIVER', 'default'),

Expand Down
16 changes: 10 additions & 6 deletions tests/Feature/Api/SecurityLogsTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,8 +150,8 @@ public function testStore()
]);
$response->assertStatus(201);
$collection = SecurityLog::where('user_id', $this->user->id)->get();
$this->assertCount(2, $collection);
$securityLog = $collection->skip(1)->first();
$this->assertCount(1, $collection);
$securityLog = $collection->first();
$this->assertEquals([
'fullname' => $this->user->getAttribute('fullname'),
], (array) $securityLog->data);
Expand Down Expand Up @@ -180,10 +180,14 @@ public function testSettingUpdated()
$original = array_intersect_key($setting->getOriginal(), $setting->getDirty());
$setting->save();
SettingsUpdated::dispatch($setting, $setting->getChanges(), $original);

$collection = SecurityLog::get();
$this->assertCount(1, $collection);
$securityLog = $collection->first();
$this->assertEquals('SettingsUpdated', $securityLog->getAttribute('event'));
// Check if the variable security_log is enable
if (config('app.security_log')) {
$this->assertCount(1, $collection);
$securityLog = $collection->first();
$this->assertEquals('SettingsUpdated', $securityLog->getAttribute('event'));
} else {
$this->assertCount(0, $collection);
}
}
}