Enhance log sanitization with GitHub, GitLab, AWS, and generic URL passwords (#7670)
This commit is contained in:
commit
8c023b4e52
3 changed files with 102 additions and 21 deletions
|
|
@ -269,9 +269,41 @@ function remove_iip($text)
|
||||||
// Ensure the input is valid UTF-8 before processing
|
// Ensure the input is valid UTF-8 before processing
|
||||||
$text = sanitize_utf8_text($text);
|
$text = sanitize_utf8_text($text);
|
||||||
|
|
||||||
|
// Git access tokens
|
||||||
$text = preg_replace('/x-access-token:.*?(?=@)/', 'x-access-token:'.REDACTED, $text);
|
$text = preg_replace('/x-access-token:.*?(?=@)/', 'x-access-token:'.REDACTED, $text);
|
||||||
|
|
||||||
return preg_replace('/\x1b\[[0-9;]*m/', '', $text);
|
// ANSI color codes
|
||||||
|
$text = preg_replace('/\x1b\[[0-9;]*m/', '', $text);
|
||||||
|
|
||||||
|
// Generic URLs with passwords (covers database URLs, ftp, amqp, ssh, etc.)
|
||||||
|
// (protocol://user:password@host → protocol://user:<REDACTED>@host)
|
||||||
|
$text = preg_replace('/((?:postgres|mysql|mongodb|rediss?|mariadb|ftp|sftp|ssh|amqp|amqps|ldap|ldaps|s3):\/\/[^:]+:)[^@]+(@)/i', '$1'.REDACTED.'$2', $text);
|
||||||
|
|
||||||
|
// Email addresses
|
||||||
|
$text = preg_replace('/[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/', REDACTED, $text);
|
||||||
|
|
||||||
|
// Bearer/JWT tokens
|
||||||
|
$text = preg_replace('/Bearer\s+[A-Za-z0-9\-_]+\.[A-Za-z0-9\-_]+\.[A-Za-z0-9\-_]+/i', 'Bearer '.REDACTED, $text);
|
||||||
|
|
||||||
|
// GitHub tokens (ghp_ = personal, gho_ = OAuth, ghu_ = user-to-server, ghs_ = server-to-server, ghr_ = refresh)
|
||||||
|
$text = preg_replace('/\b(gh[pousr]_[A-Za-z0-9_]{36,})\b/', REDACTED, $text);
|
||||||
|
|
||||||
|
// GitLab tokens (glpat- = personal access token, glcbt- = CI build token, glrt- = runner token)
|
||||||
|
$text = preg_replace('/\b(gl(?:pat|cbt|rt)-[A-Za-z0-9\-_]{20,})\b/', REDACTED, $text);
|
||||||
|
|
||||||
|
// AWS credentials (Access Key ID starts with AKIA, ABIA, ACCA, ASIA)
|
||||||
|
$text = preg_replace('/\b(A(?:KIA|BIA|CCA|SIA)[A-Z0-9]{16})\b/', REDACTED, $text);
|
||||||
|
|
||||||
|
// AWS Secret Access Key (40 character base64-ish string, typically follows access key)
|
||||||
|
$text = preg_replace('/(aws_secret_access_key|AWS_SECRET_ACCESS_KEY)[=:]\s*[\'"]?([A-Za-z0-9\/+=]{40})[\'"]?/i', '$1='.REDACTED, $text);
|
||||||
|
|
||||||
|
// API keys (common patterns)
|
||||||
|
$text = preg_replace('/(api[_-]?key|apikey|api[_-]?secret|secret[_-]?key)[=:]\s*[\'"]?[A-Za-z0-9\-_]{16,}[\'"]?/i', '$1='.REDACTED, $text);
|
||||||
|
|
||||||
|
// Private key blocks
|
||||||
|
$text = preg_replace('/-----BEGIN [A-Z ]*PRIVATE KEY-----[\s\S]*?-----END [A-Z ]*PRIVATE KEY-----/', REDACTED, $text);
|
||||||
|
|
||||||
|
return $text;
|
||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
|
|
|
||||||
|
|
@ -674,26 +674,8 @@ function removeAnsiColors($text)
|
||||||
|
|
||||||
function sanitizeLogsForExport(string $text): string
|
function sanitizeLogsForExport(string $text): string
|
||||||
{
|
{
|
||||||
// Use existing helper for tokens and ANSI codes
|
// All sanitization is now handled by remove_iip()
|
||||||
$text = remove_iip($text);
|
return remove_iip($text);
|
||||||
|
|
||||||
// Database URLs with passwords - must run before email regex to prevent false matches
|
|
||||||
// (postgres://user:password@host → postgres://user:<REDACTED>@host)
|
|
||||||
$text = preg_replace('/((?:postgres|mysql|mongodb|rediss?|mariadb):\/\/[^:]+:)[^@]+(@)/i', '$1'.REDACTED.'$2', $text);
|
|
||||||
|
|
||||||
// Email addresses
|
|
||||||
$text = preg_replace('/[a-zA-Z0-9._%+-]+@[a-zA-Z0-9.-]+\.[a-zA-Z]{2,}/', REDACTED, $text);
|
|
||||||
|
|
||||||
// Bearer/JWT tokens
|
|
||||||
$text = preg_replace('/Bearer\s+[A-Za-z0-9\-_]+\.[A-Za-z0-9\-_]+\.[A-Za-z0-9\-_]+/i', 'Bearer '.REDACTED, $text);
|
|
||||||
|
|
||||||
// API keys (common patterns)
|
|
||||||
$text = preg_replace('/(api[_-]?key|apikey|api[_-]?secret|secret[_-]?key)[=:]\s*[\'"]?[A-Za-z0-9\-_]{16,}[\'"]?/i', '$1='.REDACTED, $text);
|
|
||||||
|
|
||||||
// Private key blocks
|
|
||||||
$text = preg_replace('/-----BEGIN [A-Z ]*PRIVATE KEY-----[\s\S]*?-----END [A-Z ]*PRIVATE KEY-----/', REDACTED, $text);
|
|
||||||
|
|
||||||
return $text;
|
|
||||||
}
|
}
|
||||||
|
|
||||||
function getTopLevelNetworks(Service|Application $resource)
|
function getTopLevelNetworks(Service|Application $resource)
|
||||||
|
|
|
||||||
|
|
@ -101,3 +101,70 @@
|
||||||
expect($result)->not->toContain('12345678901234567890');
|
expect($result)->not->toContain('12345678901234567890');
|
||||||
expect($result)->toContain(REDACTED);
|
expect($result)->toContain(REDACTED);
|
||||||
});
|
});
|
||||||
|
|
||||||
|
it('removes GitHub tokens', function () {
|
||||||
|
$testCases = [
|
||||||
|
'ghp_aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789' => 'ghp_ personal access token',
|
||||||
|
'gho_aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789' => 'gho_ OAuth token',
|
||||||
|
'ghu_aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789' => 'ghu_ user-to-server token',
|
||||||
|
'ghs_aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789' => 'ghs_ server-to-server token',
|
||||||
|
'ghr_aBcDeFgHiJkLmNoPqRsTuVwXyZ0123456789' => 'ghr_ refresh token',
|
||||||
|
];
|
||||||
|
|
||||||
|
foreach ($testCases as $token => $description) {
|
||||||
|
$input = "Token: {$token}";
|
||||||
|
$result = sanitizeLogsForExport($input);
|
||||||
|
expect($result)->not->toContain($token, "Failed to redact {$description}");
|
||||||
|
expect($result)->toContain(REDACTED);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('removes GitLab tokens', function () {
|
||||||
|
$testCases = [
|
||||||
|
'glpat-aBcDeFgHiJkLmNoPqRsTu' => 'glpat- personal access token',
|
||||||
|
'glcbt-aBcDeFgHiJkLmNoPqRsTu' => 'glcbt- CI build token',
|
||||||
|
'glrt-aBcDeFgHiJkLmNoPqRsTuV' => 'glrt- runner token',
|
||||||
|
];
|
||||||
|
|
||||||
|
foreach ($testCases as $token => $description) {
|
||||||
|
$input = "Token: {$token}";
|
||||||
|
$result = sanitizeLogsForExport($input);
|
||||||
|
expect($result)->not->toContain($token, "Failed to redact {$description}");
|
||||||
|
expect($result)->toContain(REDACTED);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
||||||
|
it('removes AWS credentials', function () {
|
||||||
|
// AWS Access Key ID (starts with AKIA, ABIA, ACCA, or ASIA)
|
||||||
|
$accessKeyId = 'AKIAIOSFODNN7EXAMPLE';
|
||||||
|
$input = "AWS_ACCESS_KEY_ID={$accessKeyId}";
|
||||||
|
$result = sanitizeLogsForExport($input);
|
||||||
|
|
||||||
|
expect($result)->not->toContain($accessKeyId);
|
||||||
|
expect($result)->toContain(REDACTED);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('removes AWS secret access key', function () {
|
||||||
|
$secretKey = 'wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY';
|
||||||
|
$input = "aws_secret_access_key={$secretKey}";
|
||||||
|
$result = sanitizeLogsForExport($input);
|
||||||
|
|
||||||
|
expect($result)->not->toContain($secretKey);
|
||||||
|
expect($result)->toContain('aws_secret_access_key='.REDACTED);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('removes generic URL passwords', function () {
|
||||||
|
$testCases = [
|
||||||
|
'ftp://user:ftppass@ftp.example.com/path' => 'ftp://user:'.REDACTED.'@ftp.example.com/path',
|
||||||
|
'sftp://deploy:secret123@sftp.example.com' => 'sftp://deploy:'.REDACTED.'@sftp.example.com',
|
||||||
|
'ssh://git:sshpass@git.example.com/repo' => 'ssh://git:'.REDACTED.'@git.example.com/repo',
|
||||||
|
'amqp://rabbit:bunny123@rabbitmq:5672' => 'amqp://rabbit:'.REDACTED.'@rabbitmq:5672',
|
||||||
|
'ldap://admin:ldappass@ldap.example.com' => 'ldap://admin:'.REDACTED.'@ldap.example.com',
|
||||||
|
's3://access:secretkey@bucket.s3.amazonaws.com' => 's3://access:'.REDACTED.'@bucket.s3.amazonaws.com',
|
||||||
|
];
|
||||||
|
|
||||||
|
foreach ($testCases as $input => $expected) {
|
||||||
|
$result = sanitizeLogsForExport($input);
|
||||||
|
expect($result)->toBe($expected);
|
||||||
|
}
|
||||||
|
});
|
||||||
|
|
|
||||||
Loading…
Reference in a new issue