Skip to content

fix/security requirement ref #2802

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

Merged
baywet merged 4 commits into from
Mar 31, 2026
+81 −62
Merged

fix/security requirement ref #2802

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b3807c8
tests: refactors to theory to reduce duplication
baywet Mar 30, 2026
32bef0f
tests: further theory refactoring
baywet Mar 30, 2026
a6291d1
tests: adds a unit test to validate security reference resolution
baywet Mar 30, 2026
a5acb89
fix: security scheme references serialization
baywet Mar 30, 2026
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
25 changes: 20 additions & 5 deletions src/Microsoft.OpenApi/Models/OpenApiSecurityRequirement.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,11 +79,7 @@ private void SerializeInternal(IOpenApiWriter writer, Action<IOpenApiWriter, Ope

writer.WriteStartObject();

// Reaching this point means the reference to a specific OpenApiSecurityScheme fails.
// We are not able to serialize this SecurityScheme/Scopes key value pair since we do not know what
// string to output.

foreach (var securitySchemeAndScopesValuePair in this.Where(static p => p.Key?.Target is not null))
foreach (var securitySchemeAndScopesValuePair in this.Where(static p => CanSerializeSecurityScheme(p.Key)))
{
var securityScheme = securitySchemeAndScopesValuePair.Key;
var scopes = securitySchemeAndScopesValuePair.Value;
Expand All @@ -103,6 +99,25 @@ private void SerializeInternal(IOpenApiWriter writer, Action<IOpenApiWriter, Ope
writer.WriteEndObject();
}

private static bool CanSerializeSecurityScheme(OpenApiSecuritySchemeReference? securityScheme)
{
if (securityScheme is null)
{
return false;
}

if (securityScheme.Target is not null)
{
return true;
}

var schemeId = securityScheme.Reference?.Id;
var securitySchemes = securityScheme.Reference?.HostDocument?.Components?.SecuritySchemes;
return !string.IsNullOrEmpty(schemeId)
&& securitySchemes is not null
&& securitySchemes.ContainsKey(schemeId!);
}

/// <summary>
/// Serialize <see cref="OpenApiSecurityRequirement"/> to Open Api v2.0
/// </summary>
Expand Down
51 changes: 51 additions & 0 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@
using System.IO;
using System.Linq;
using System.Net.Http;
using System.Text.Json.Nodes;
using System.Threading.Tasks;
using VerifyXunit;
using Xunit;
Expand Down Expand Up @@ -1841,7 +1842,7 @@
}

[Fact]
public void SerializeExamplesDoesNotThrowNullReferenceException()

Check warning on line 1845 in test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs

View workflow job for this annotation

GitHub Actions / Build 

Add at least one assertion to this test case.

Check warning on line 1845 in test/Microsoft.OpenApi.Tests/Models/OpenApiDocumentTests.cs

View workflow job for this annotation

GitHub Actions / Build 

Add at least one assertion to this test case.
{
OpenApiDocument doc = new OpenApiDocument
{
Expand Down Expand Up @@ -2387,6 +2388,56 @@
Assert.Equal(expected.MakeLineBreaksEnvironmentNeutral(), actual.MakeLineBreaksEnvironmentNeutral());
}

[Theory]
[InlineData(OpenApiSpecVersion.OpenApi3_0)]
[InlineData(OpenApiSpecVersion.OpenApi3_1)]
[InlineData(OpenApiSpecVersion.OpenApi3_2)]
public async Task SerializeDocumentWithSecurityRequirementAsJsonWorks(OpenApiSpecVersion openApiSpecVersion)
{
// Arrange
var doc = new OpenApiDocument
{
Info = new OpenApiInfo { Title = "Test", Version = "1.0" },
Components = new OpenApiComponents
{
SecuritySchemes = new Dictionary<string, IOpenApiSecurityScheme>(StringComparer.Ordinal)
{
["Bearer"] = new OpenApiSecurityScheme
{
Type = SecuritySchemeType.Http,
Scheme = "Bearer",
BearerFormat = "JWT",
},
},
},
};

doc.Security =
[
new OpenApiSecurityRequirement
{
{ new OpenApiSecuritySchemeReference("Bearer", doc), [] },
},
];

var expected =
"""
[
{
"Bearer": []
}
]
""";

// Act
var actual = await doc.SerializeAsJsonAsync(openApiSpecVersion);

// Assert
var actualSecurity = JsonNode.Parse(actual)?["security"];
Assert.NotNull(actualSecurity);
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expected), actualSecurity));
}

[Fact]
public async Task SerializeDocumentWithSelfPropertyAsV31WritesAsExtension()
{
Expand Down
67 changes: 10 additions & 57 deletions test/Microsoft.OpenApi.Tests/Models/OpenApiSecurityRequirementTests.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -130,35 +130,10 @@ public async Task SerializeSecurityRequirementAsV3JsonWorksAsync(bool produceTer
await Verifier.Verify(outputStringWriter).UseParameters(produceTerseOutput);
}

[Fact]
public async Task SerializeSecurityRequirementWithReferencedSecuritySchemeAsV3JsonWorks()
{
// Arrange
var expected =
"""
{
"scheme1": [
"scope1",
"scope2",
"scope3"
],
"scheme2": [
"scope4",
"scope5"
],
"scheme3": [ ]
}
""";

// Act
var actual = await SecurityRequirementWithReferencedSecurityScheme.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi3_0);

// Assert
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expected), JsonNode.Parse(actual)));
}

[Fact]
public async Task SerializeSecurityRequirementWithReferencedSecuritySchemeAsV2JsonWorks()
[Theory]
[InlineData(OpenApiSpecVersion.OpenApi3_0)]
[InlineData(OpenApiSpecVersion.OpenApi2_0)]
public async Task SerializeSecurityRequirementWithReferencedSecuritySchemeAsJsonWorks(OpenApiSpecVersion openApiSpecVersion)
{
// Arrange
var expected =
Expand All @@ -178,37 +153,16 @@ public async Task SerializeSecurityRequirementWithReferencedSecuritySchemeAsV2Js
""";

// Act
var actual = await SecurityRequirementWithReferencedSecurityScheme.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi2_0);
var actual = await SecurityRequirementWithReferencedSecurityScheme.SerializeAsJsonAsync(openApiSpecVersion);

// Assert
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expected), JsonNode.Parse(actual)));
}

[Fact]
public async Task SerializeSecurityRequirementWithUnreferencedSecuritySchemeAsV3JsonShouldSkipUnserializableKeyValuePair()
{
// Arrange
var expected =
"""
{
"scheme1": [
"scope1",
"scope2",
"scope3"
],
"scheme3": [ ]
}
""";

// Act
var actual = await SecurityRequirementWithUnreferencedSecurityScheme.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi3_0);

// Assert
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expected), JsonNode.Parse(actual)));
}

[Fact]
public async Task SerializeSecurityRequirementWithUnreferencedSecuritySchemeAsV2JsonShouldSkipUnserializableKeyValuePair()
[Theory]
[InlineData(OpenApiSpecVersion.OpenApi3_0)]
[InlineData(OpenApiSpecVersion.OpenApi2_0)]
public async Task SerializeSecurityRequirementWithUnreferencedSecuritySchemeAsJsonShouldSkipUnserializableKeyValuePair(OpenApiSpecVersion openApiSpecVersion)
{
// Arrange
var expected =
Expand All @@ -224,8 +178,7 @@ public async Task SerializeSecurityRequirementWithUnreferencedSecuritySchemeAsV2
""";

// Act
var actual =
await SecurityRequirementWithUnreferencedSecurityScheme.SerializeAsJsonAsync(OpenApiSpecVersion.OpenApi2_0);
var actual = await SecurityRequirementWithUnreferencedSecurityScheme.SerializeAsJsonAsync(openApiSpecVersion);

// Assert
Assert.True(JsonNode.DeepEquals(JsonNode.Parse(expected), JsonNode.Parse(actual)));
Expand Down
Loading