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

sanitize string headers when writing request generator #4218

Merged
merged 11 commits into from
Feb 22, 2024
Merged

sanitize string headers when writing request generator #4218

Changes from 1 commit
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
d9717b1
sanitize string headers when writing request generator
crobibero Feb 22, 2024
cff4cef
update other generators
crobibero Feb 22, 2024
f5905a4
add tests
crobibero Feb 22, 2024
ac13233
sanitize string headers when writing request generator
crobibero Feb 22, 2024
d9bb58b
update other generators
crobibero Feb 22, 2024
5710263
add tests
crobibero Feb 22, 2024
c063e04
Merge remote-tracking branch 'origin/escape-string' into escape-string
crobibero Feb 22, 2024
2bb8492
update CHANGELOG.md
crobibero Feb 22, 2024
dc3c443
Apply suggestions from code review
baywet Feb 22, 2024
6e67350
- fixes formatting
baywet Feb 22, 2024
a0e3d6c
- fixes failing unit test after quotes normalziation
baywet Feb 22, 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
19 changes: 14 additions & 5 deletions src/Kiota.Builder/Writers/CSharp/CodeMethodWriter.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,22 +418,23 @@ private void WriteRequestGeneratorBody(CodeMethod codeElement, RequestParams req
writer.WriteLine($"{RequestInfoVarName}.Configure({requestParams.requestConfiguration.Name});");

if (codeElement.ShouldAddAcceptHeader)
writer.WriteLine($"{RequestInfoVarName}.Headers.TryAdd(\"Accept\", \"{codeElement.AcceptHeaderValue}\");");
writer.WriteLine($"{RequestInfoVarName}.Headers.TryAdd(\"Accept\", \"{SanitizeString(codeElement.AcceptHeaderValue)}\");");
if (requestParams.requestBody != null)
{
var suffix = requestParams.requestBody.Type.IsCollection ? "Collection" : string.Empty;
var sanitizedRequestBodyContentType = SanitizeString(codeElement.RequestBodyContentType);
if (requestParams.requestBody.Type.Name.Equals(conventions.StreamTypeName, StringComparison.OrdinalIgnoreCase))
{
if (requestParams.requestContentType is not null)
writer.WriteLine($"{RequestInfoVarName}.SetStreamContent({requestParams.requestBody.Name}, {requestParams.requestContentType.Name});");
else if (!string.IsNullOrEmpty(codeElement.RequestBodyContentType))
writer.WriteLine($"{RequestInfoVarName}.SetStreamContent({requestParams.requestBody.Name}, \"{codeElement.RequestBodyContentType}\");");
else if (!string.IsNullOrEmpty(sanitizedRequestBodyContentType))
writer.WriteLine($"{RequestInfoVarName}.SetStreamContent({requestParams.requestBody.Name}, \"{sanitizedRequestBodyContentType}\");");
}
else if (currentClass.GetPropertyOfKind(CodePropertyKind.RequestAdapter) is CodeProperty requestAdapterProperty)
if (requestParams.requestBody.Type is CodeType bodyType && (bodyType.TypeDefinition is CodeClass || bodyType.Name.Equals("MultipartBody", StringComparison.OrdinalIgnoreCase)))
writer.WriteLine($"{RequestInfoVarName}.SetContentFromParsable({requestAdapterProperty.Name.ToFirstCharacterUpperCase()}, \"{codeElement.RequestBodyContentType}\", {requestParams.requestBody.Name});");
writer.WriteLine($"{RequestInfoVarName}.SetContentFromParsable({requestAdapterProperty.Name.ToFirstCharacterUpperCase()}, \"{sanitizedRequestBodyContentType}\", {requestParams.requestBody.Name});");
else
writer.WriteLine($"{RequestInfoVarName}.SetContentFromScalar{suffix}({requestAdapterProperty.Name.ToFirstCharacterUpperCase()}, \"{codeElement.RequestBodyContentType}\", {requestParams.requestBody.Name});");
writer.WriteLine($"{RequestInfoVarName}.SetContentFromScalar{suffix}({requestAdapterProperty.Name.ToFirstCharacterUpperCase()}, \"{sanitizedRequestBodyContentType}\", {requestParams.requestBody.Name});");
}

writer.WriteLine($"return {RequestInfoVarName};");
Expand Down Expand Up @@ -669,4 +670,12 @@ _ when conventions.IsPrimitiveType(propertyType) => $"Write{propertyType.TrimEnd
_ => $"WriteObjectValue<{propertyType.ToFirstCharacterUpperCase()}{(includeNullableRef ? "?" : string.Empty)}>",
};
}

/// <summary>
/// Sanitize a string for direct writing.
/// </summary>
/// <param name="input">The string to sanitize.</param>
/// <returns>The sanitized string.</returns>
private static string SanitizeString(string input)
=> input.Replace("\"", "\\\"", StringComparison.Ordinal);
}