Skip to content

Fix code scanning alert no. 2: Log entries created from user input #10

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

Draft
Kenny-Rogers wants to merge 1 commit into
base: master
Choose a base branch
from
Draft

Fix code scanning alert no. 2: Log entries created from user input #10

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
3 changes: 2 additions & 1 deletion examples/WebApplication1/Controllers/RequestController.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,7 +41,8 @@ [FromBody]ProgrammableServiceRequest request
{

//this action will be called anytime a user wants to interact with your application
_logger.LogDebug("received request for {msisdn} {session_id} {gs_request}", request.Mobile, request.SessionId,
var sanitizedSessionId = request.SessionId?.Replace(Environment.NewLine, "").Replace("\n", "").Replace("\r", "");
_logger.LogDebug("received request for {msisdn} {session_id} {gs_request}", request.Mobile, sanitizedSessionId,

Check failure

Code scanning / CodeQL

Log entries created from user input

This log entry depends on a [user-provided value](1).

Copilot Autofix

AI over 1 year ago

To fix the problem, we need to sanitize the request.Mobile value before logging it. Since the log entries are likely plain text, we should remove any new line characters from the user input. This can be done using the String.Replace method to ensure that no line endings are present in the user input.

Suggested changeset 1
examples/WebApplication1/Controllers/RequestController.cs

Autofix patch

Autofix patch
Run the following command in your local git repository to apply this patch
cat << 'EOF' | git apply
diff --git a/examples/WebApplication1/Controllers/RequestController.cs b/examples/WebApplication1/Controllers/RequestController.cs
--- a/examples/WebApplication1/Controllers/RequestController.cs
+++ b/examples/WebApplication1/Controllers/RequestController.cs
@@ -44,3 +44,4 @@
             var sanitizedSessionId = request.SessionId?.Replace(Environment.NewLine, "").Replace("\n", "").Replace("\r", "");
-            _logger.LogDebug("received request for {msisdn} {session_id} {gs_request}", request.Mobile, sanitizedSessionId,
+            var sanitizedMobile = request.Mobile?.Replace(Environment.NewLine, "").Replace("\n", "").Replace("\r", "");
+            _logger.LogDebug("received request for {msisdn} {session_id} {gs_request}", sanitizedMobile, sanitizedSessionId,
                 JsonConvert.SerializeObject(request));
EOF
@@ -44,3 +44,4 @@
var sanitizedSessionId = request.SessionId?.Replace(Environment.NewLine, "").Replace("\n", "").Replace("\r", "");
_logger.LogDebug("received request for {msisdn} {session_id} {gs_request}", request.Mobile, sanitizedSessionId,
var sanitizedMobile = request.Mobile?.Replace(Environment.NewLine, "").Replace("\n", "").Replace("\r", "");
_logger.LogDebug("received request for {msisdn} {session_id} {gs_request}", sanitizedMobile, sanitizedSessionId,
JsonConvert.SerializeObject(request));
Copilot is powered by AI and may make mistakes. Always verify output.
JsonConvert.SerializeObject(request));

var response = await _programmableService.ExecuteInteraction(request, nameof(EvdController));
Expand Down