Skip to content

Add config-driven body field redaction #65

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

Closed
firecow wants to merge 1 commit into from
Closed

Add config-driven body field redaction #65

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
4 changes: 3 additions & 1 deletion publishable/config/request-log.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,9 @@
'cegosso',
'refresh_token',
'access_token',
]
],
'request_body' => array_filter(explode(',', env('REQUEST_LOG_REDACT_REQUEST_BODY', ''))),
'response_body' => array_filter(explode(',', env('REQUEST_LOG_REDACT_RESPONSE_BODY', ''))),
],

/*
Expand Down
2 changes: 1 addition & 1 deletion src/RequestLog/Middleware/LogRequest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -127,7 +127,7 @@ private function logRequest(Request $request, Response $response): void
status: $response->getStatusCode(),
responseHeaders: $responseHeaders,
responseCookies: SecurityUtility::getResponseCookiesWithMaskingApplied($response->headers->getCookies(), $request),
responseBody: $this->truncate($response->getContent() ?: '{}', $truncateBodyLength),
responseBody: $this->truncate(SecurityUtility::getResponseBodyWithMaskingApplied($response->getContent() ?: '{}', $request->isJson()), $truncateBodyLength),
responseException: $response->exception ?? null,
executionTimeNs: $executionTimeNs
))->log();
Expand Down
32 changes: 27 additions & 5 deletions src/RequestLog/Utilities/SecurityUtility.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -75,16 +75,38 @@ public static function getHeadersWithMaskingApplied(Request $request): array
*/
public static function getBodyWithMaskingApplied(Request $request): ?string
{
if ( ! $request->hasHeader('X-SENSITIVE-REQUEST-BODY-JSON') || ! $request->isJson()) {
// If the request is not JSON, getContent(), which is what we log as request body, is always empty
$sensitiveBodyHeaderIn = $request->header('X-SENSITIVE-REQUEST-BODY-JSON');
$sensitiveBodyFields = $sensitiveBodyHeaderIn ? json_decode($sensitiveBodyHeaderIn) : [];
$redactedBodyFields = Config::get('request-log.redact.request_body', []);

$fieldsToMask = collect($sensitiveBodyFields)->concat($redactedBodyFields);

if ($fieldsToMask->isEmpty() || ! $request->isJson()) {
return $request->getContent();
}

$sensitiveBodyFields = json_decode($request->header('X-SENSITIVE-REQUEST-BODY-JSON'));

$data = json_decode($request->getContent(), true);

foreach ($sensitiveBodyFields as $field) {
foreach ($fieldsToMask as $field) {
if (Arr::has($data, $field)) {
Arr::set($data, $field, '[ MASKED ]');
}
}

return json_encode($data);
}

public static function getResponseBodyWithMaskingApplied(string $responseContent, bool $isJson): string
{
$redactedBodyFields = collect(Config::get('request-log.redact.response_body', []));

if ($redactedBodyFields->isEmpty() || ! $isJson) {
return $responseContent;
}

$data = json_decode($responseContent, true);

foreach ($redactedBodyFields as $field) {
if (Arr::has($data, $field)) {
Arr::set($data, $field, '[ MASKED ]');
}
Expand Down
89 changes: 89 additions & 0 deletions tests/Unit/LogRequestTest.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -151,6 +151,95 @@ public function test_it_masks_request_body()
$this->postJson('/test', $data, $headers);
}

public function test_it_masks_request_body_from_config()
{
// Arrange
Config::set('request-log.redact.request_body', ['password', 'person.sensitive_data']);

$loggerMock = Log::partialMock();
Log::setApplication($this->app);

$loggerMock->shouldReceive('debug')->once()->andReturnUsing(function ($message, $context) {
$loggedBody = json_decode($context['http']['request']['body']['content'], true);
$this->assertEquals('[ MASKED ]', $loggedBody['password']);
$this->assertEquals('[ MASKED ]', $loggedBody['person']['sensitive_data']);
$this->assertEquals('not secret', $loggedBody['person']['insensitive_data']);
});

$data = [
'password' => '12345678',
'person' => [
'sensitive_data' => 'secret',
'insensitive_data' => 'not secret',
],
];

// Act
$this->postJson('/test', $data);
}

public function test_it_merges_config_and_header_body_masking()
{
// Arrange
Config::set('request-log.redact.request_body', ['password']);

$loggerMock = Log::partialMock();
Log::setApplication($this->app);

$loggerMock->shouldReceive('debug')->once()->andReturnUsing(function ($message, $context) {
$loggedBody = json_decode($context['http']['request']['body']['content'], true);
$this->assertEquals('[ MASKED ]', $loggedBody['password']);
$this->assertEquals('[ MASKED ]', $loggedBody['person']['sensitive_data']);
$this->assertEquals('not secret', $loggedBody['person']['insensitive_data']);
});

$data = [
'password' => '12345678',
'person' => [
'sensitive_data' => 'secret',
'insensitive_data' => 'not secret',
],
];

$headers = [
'X-SENSITIVE-REQUEST-BODY-JSON' => json_encode(['person.sensitive_data']),
];

// Act
$this->postJson('/test', $data, $headers);
}

public function test_it_masks_response_body_from_config()
{
// Arrange
Config::set('request-log.redact.response_body', ['token', 'user.ssn']);

$loggerMock = Log::partialMock();
Log::setApplication($this->app);

$loggerMock->shouldReceive('debug')->once()->andReturnUsing(function ($message, $context) {
$loggedBody = json_decode($context['http']['response']['body']['content'], true);
$this->assertEquals('[ MASKED ]', $loggedBody['token']);
$this->assertEquals('[ MASKED ]', $loggedBody['user']['ssn']);
$this->assertEquals('John', $loggedBody['user']['name']);
});

$middleware = new LogRequest();

$request = new Request(server: ['HTTP_CONTENT_TYPE' => 'application/json']);

$response = new Response();
$response->setContent(json_encode([
'token' => 'secret-token',
'user' => [
'name' => 'John',
'ssn' => '123-45-6789',
],
]));

$middleware->terminate($request, $response);
}

public function test_it_tests()
{
// Arrange
Expand Down
Loading