Skip to content

[csharp] Fix HTTP signature auth failure on .NET 8 when query params contain special characters #23714

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

Open
sagadira wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[csharp] Fix HTTP signature auth failure on .NET 8 when query params contain special characters #23714

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
14 changes: 12 additions & 2 deletions modules/openapi-generator/src/main/resources/csharp/HttpSigningConfiguration.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,9 @@ namespace {{packageName}}.Client
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -67,6 +70,14 @@ namespace {{packageName}}.Client
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -133,8 +144,7 @@ namespace {{packageName}}.Client
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : {{#net90OrLater}}HttpUtility.UrlEncode({{/net90OrLater}}parameter.Key{{#net90OrLater}}){{/net90OrLater}};
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions .../csharp/httpclient/net10/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...e/csharp/httpclient/net9/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...p/httpclient/standard2.0/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : parameter.Key;
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...e/csharp/restsharp/net10/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions .../csharp/restsharp/net4.7/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : parameter.Key;
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions .../csharp/restsharp/net4.8/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : parameter.Key;
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...sharp/restsharp/net8/EnumMappings/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : parameter.Key;
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...re/csharp/restsharp/net8/Petstore/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : parameter.Key;
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...sharp/restsharp/net9/EnumMappings/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
14 changes: 12 additions & 2 deletions ...ndard2.0/ConditionalSerialization/src/Org.OpenAPITools/Client/HttpSigningConfiguration.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,9 @@ public HttpSigningConfiguration()
{
HashAlgorithm = HashAlgorithmName.SHA256;
SigningAlgorithm = "PKCS1-v15";
string framework = RuntimeInformation.FrameworkDescription;
_skipUrlEncode = framework.StartsWith(".NET ") &&
int.TryParse(framework.Substring(5).Split('.')[0], out int fwMajor) && fwMajor >= 9;
}

/// <summary>
Expand Down Expand Up @@ -75,6 +78,14 @@ public HttpSigningConfiguration()
/// </summary>
public int SignatureValidityPeriod { get; set; }

// On .NET 9+, HttpUtility.ParseQueryString already URL-encodes keys internally,
// so calling UrlEncode again would cause double-encoding and produce a signature
// that does not match the actual request sent by RestSharp 112+.
// On .NET 8 and earlier, keys must be explicitly URL-encoded so that special
// characters (e.g. '$' in OData params like $filter) are encoded the same way
// in the signature as they are in the outgoing HTTP request.
private readonly bool _skipUrlEncode;

private enum PrivateKeyType
{
None = 0,
Expand Down Expand Up @@ -141,8 +152,7 @@ public Dictionary<string, string> GetHttpSignedHeader(string basePath,string met
foreach (var parameter in requestOptions.QueryParameters)
{
#if (NETCOREAPP)
string framework = RuntimeInformation.FrameworkDescription;
string key = framework.StartsWith(".NET 9") ? parameter.Key : parameter.Key;
string key = _skipUrlEncode ? parameter.Key : HttpUtility.UrlEncode(parameter.Key);
if (parameter.Value.Count > 1)
{ // array
foreach (var value in parameter.Value)
Expand Down
Loading
Loading