Skip to content
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

Jump to bottom

#356: Added username sanitation. #365

Merged
merged 3 commits into from
Apr 4, 2024
Merged

#356: Added username sanitation. #365

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
96be0c4
#356: Added username sanitation.
FranSlot Apr 4, 2024
3f5af57
#356: Forgot to add the prefix.
FranSlot Apr 4, 2024
e89ac4b
#356: Added explanation why we sanitise.
FranSlot Apr 4, 2024
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
35 changes: 28 additions & 7 deletions RAP4/customizations/bootstrap/files/ExecEngineFunctions.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -343,13 +343,7 @@
$zipContentForCommandline = base64_encode($zipContent);
$mainAldForCommandLine = base64_encode("main.adl");

//sanitize the username for usage later
$pattern = '/[\W+]/';

$userName=strtolower($userName);
$userName = preg_replace($pattern, '-', $userName);

$userName = 'st-' . $userName;
$userName = sanitize_username($userName);

$deployment = getenv('RAP_DEPLOYMENT');
if ($deployment == 'Kubernetes') {
Expand Down Expand Up @@ -477,6 +471,33 @@
$scriptVersionAtom->link($message, 'compileresponse[ScriptVersion*CompileResponse]')->add();
});

/**Sanitize the username
* As the user is allowed to choose any name, it is possible that the name they chose does not conform to restrictions places on the string in certain use cases.
* For example, a user could use special characters in their username. This might violate the restrictions placed on strings in a kubernetes metadata.name field.
* Therefore we remove all characters deemed unfit, and create a hash from these characters and append this hash at the end.
* To prevent casting errors between int and string, we append 'st' at the beginning.
*/
function sanitize_username($username) {
// Define the pattern of illegal characters
$pattern = '/[^a-zA-Z0-9]/';

// Find all illegal characters
preg_match_all($pattern, $username, $matches);

// Remove illegal characters
$sanitized_username = preg_replace($pattern, '', $username);

// Create a hash of the illegal characters
$hash = !empty($matches[0]) ? substr(md5(implode($matches[0])), 0, 5) : '';

// Append the hash to the sanitized username
$sanitized_username .= $hash;

$sanitized_username = 'st' . $sanitized_username;

return strtolower($sanitized_username);
}

/**
* @phan-closure-scope \Ampersand\Rule\ExecEngine
* Phan analyzes the inner body of this closure as if it were a closure declared in ExecEngine.
Expand Down
Loading