Skip to content

Commit c80354a

Browse files
committed
feat(models): support mutualTLS security scheme
1 parent 4ee34a8 commit c80354a

File tree

5 files changed

+40
-1
lines changed

5 files changed

+40
-1
lines changed

src/Microsoft.OpenApi/Models/OpenApiSecurityScheme.cs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -126,6 +126,9 @@ private void SerializeInternal(IOpenApiWriter writer, OpenApiSpecVersion version
126126
// openIdConnectUrl
127127
writer.WriteProperty(OpenApiConstants.OpenIdConnectUrl, OpenIdConnectUrl?.ToString());
128128
break;
129+
case SecuritySchemeType.MutualTLS:
130+
// No additional properties for mutualTLS
131+
break;
129132
}
130133

131134
// deprecated - serialize as native field for v3.2+ or as extension for earlier versions
@@ -170,6 +173,14 @@ public virtual void SerializeAsV2(IOpenApiWriter writer)
170173
return;
171174
}
172175

176+
if (Type == SecuritySchemeType.MutualTLS)
177+
{
178+
// Bail because V2 does not support mutualTLS
179+
writer.WriteStartObject();
180+
writer.WriteEndObject();
181+
return;
182+
}
183+
173184
writer.WriteStartObject();
174185

175186
// type

src/Microsoft.OpenApi/Models/SecuritySchemeType.cs

Lines changed: 6 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,11 @@ public enum SecuritySchemeType
2626
/// <summary>
2727
/// Use OAuth2 with OpenId Connect URL to discover OAuth2 configuration value.
2828
/// </summary>
29-
[Display("openIdConnect")] OpenIdConnect
29+
[Display("openIdConnect")] OpenIdConnect,
30+
31+
/// <summary>
32+
/// Use mutual TLS authentication.
33+
/// </summary>
34+
[Display("mutualTLS")] MutualTLS
3035
}
3136
}

test/Microsoft.OpenApi.Readers.Tests/V32Tests/OpenApiSecuritySchemeTests.cs

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -102,6 +102,25 @@ public async Task ParseOpenIdConnectSecuritySchemeShouldSucceed()
102102
}, securityScheme);
103103
}
104104

105+
[Fact]
106+
public async Task ParseMutualTlsSecuritySchemeShouldSucceed()
107+
{
108+
// Act
109+
var securityScheme = await OpenApiModelFactory.LoadAsync<OpenApiSecurityScheme>(
110+
Path.Combine(SampleFolderPath, "mutualTlsSecurityScheme.yaml"),
111+
OpenApiSpecVersion.OpenApi3_2,
112+
new(),
113+
SettingsFixture.ReaderSettings);
114+
115+
// Assert
116+
Assert.Equivalent(
117+
new OpenApiSecurityScheme
118+
{
119+
Type = SecuritySchemeType.MutualTLS,
120+
Description = "Sample Description"
121+
}, securityScheme);
122+
}
123+
105124
[Fact]
106125
public async Task ParseOAuth2SecuritySchemeWithDeviceAuthorizationUrlShouldSucceed()
107126
{
Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
type: mutualTLS
2+
description: Sample Description

test/Microsoft.OpenApi.Tests/PublicApi/PublicApi.approved.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1933,6 +1933,8 @@ namespace Microsoft.OpenApi
19331933
OAuth2 = 2,
19341934
[Microsoft.OpenApi.Display("openIdConnect")]
19351935
OpenIdConnect = 3,
1936+
[Microsoft.OpenApi.Display("mutualTLS")]
1937+
MutualTLS = 4,
19361938
}
19371939
public abstract class SourceExpression : Microsoft.OpenApi.RuntimeExpression
19381940
{

0 commit comments

Comments
 (0)