-
Notifications
You must be signed in to change notification settings - Fork 12
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Feature - add operation filters for Shared Access Key and Certificate…
… authentications in OpenAPI docs (#172) * Feature - add operation filters for Shared Access Key and Certificate authentications in OpenAPI docs * pr-style: remove blank line in operation filters * Update src/Arcus.WebApi.OpenApi.Extensions/CertificateAuthenticationOperationFilter.cs Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com> * Update docs/preview/features/openapi/security-definitions.md Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com> * pr-sug: remove scopes in operation filters * pr-sug: update with tests * pr-fix: remove tests with ctor creation * pr-sug: update w/ correct doc title * pr-sug: make security schema name configuratble * pr-sug: make security scheme type configurable * pr-test: make sure we test for valid out of bound enumeration values * pr-style: add paranthesis for AND and OR operation combinations Co-authored-by: Tom Kerkhove <kerkhove.tom@gmail.com>
- Loading branch information
1 parent
b449326
commit 207f7ac
Showing
13 changed files
with
598 additions
and
144 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
src/Arcus.WebApi.OpenApi.Extensions/CertificateAuthenticationOperationFilter.cs
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| using System; | ||
| using System.Collections.Generic; | ||
| using System.Linq; | ||
| using Arcus.WebApi.Security.Authentication.Certificates; | ||
| using GuardNet; | ||
| #if NETCOREAPP3_1 | ||
| using Microsoft.OpenApi.Models; | ||
| #endif | ||
| using Swashbuckle.AspNetCore.Swagger; | ||
| using Swashbuckle.AspNetCore.SwaggerGen; | ||
|
|
||
| namespace Arcus.WebApi.OpenApi.Extensions | ||
| { | ||
| /// <summary> | ||
| /// A Swashbuckle operation filter that adds certificate security definitions to authorized API operations. | ||
| /// </summary> | ||
| public class CertificateAuthenticationOperationFilter : IOperationFilter | ||
| { | ||
| private const string DefaultSecuritySchemeName = "certificate"; | ||
|
|
||
| private readonly string _securitySchemeName; | ||
| #if NETCOREAPP3_1 | ||
| private readonly SecuritySchemeType _securitySchemeType; | ||
| #endif | ||
|
|
||
| /// <summary> | ||
| /// Initializes a new instance of the <see cref="CertificateAuthenticationOperationFilter"/> class. | ||
| /// </summary> | ||
| /// <param name="securitySchemeName">The name of the security scheme. Default value is <c>"certificate"</c>.</param> | ||
| #if NETCOREAPP3_1 | ||
| /// <param name="securitySchemeType">The type of the security scheme. Default value is <c>ApiKey</c>.</param> | ||
| #endif | ||
| public CertificateAuthenticationOperationFilter( | ||
| #if NETCOREAPP3_1 | ||
| string securitySchemeName = DefaultSecuritySchemeName, | ||
| SecuritySchemeType securitySchemeType = SecuritySchemeType.ApiKey | ||
| #else | ||
| string securitySchemeName = DefaultSecuritySchemeName | ||
| #endif | ||
| ) | ||
| { | ||
| Guard.NotNullOrWhitespace(securitySchemeName, | ||
| nameof(securitySchemeName), | ||
| "Requires a name for the Certificate security scheme"); | ||
|
|
||
| _securitySchemeName = securitySchemeName; | ||
|
|
||
| #if NETCOREAPP3_1 | ||
| Guard.For<ArgumentException>( | ||
| () => !Enum.IsDefined(typeof(SecuritySchemeType), securitySchemeType), | ||
| "Requires a security scheme type for the Certificate authentication that is within the bounds of the enumeration"); | ||
|
|
||
| _securitySchemeType = securitySchemeType; | ||
| #endif | ||
| } | ||
|
|
||
| /// <summary> | ||
| /// Applies the OperationFilter to the API <paramref name="operation"/>. | ||
| /// </summary> | ||
| /// <param name="operation">The operation instance on which the OperationFilter must be applied.</param> | ||
| /// <param name="context">Provides meta-information on the <paramref name="operation"/> instance.</param> | ||
| #if NETCOREAPP3_1 | ||
| public void Apply(OpenApiOperation operation, OperationFilterContext context) | ||
| #else | ||
| public void Apply(Operation operation, OperationFilterContext context) | ||
| #endif | ||
| { | ||
| bool hasOperationAuthentication = | ||
| context.MethodInfo | ||
| .GetCustomAttributes(true) | ||
| .OfType<CertificateAuthenticationAttribute>() | ||
| .Any(); | ||
|
|
||
| bool hasControllerAuthentication = | ||
| context.MethodInfo.DeclaringType != null | ||
| && context.MethodInfo.DeclaringType | ||
| .GetCustomAttributes(true) | ||
| .OfType<CertificateAuthenticationAttribute>() | ||
| .Any(); | ||
|
|
||
| if (hasOperationAuthentication || hasControllerAuthentication) | ||
| { | ||
| if (operation.Responses.ContainsKey("401") == false) | ||
| { | ||
| #if NETCOREAPP3_1 | ||
| operation.Responses.Add("401", new OpenApiResponse { Description = "Unauthorized" }); | ||
| #else | ||
| operation.Responses.Add("401", new Response { Description = "Unauthorized" }); | ||
| #endif | ||
| } | ||
|
|
||
| if (operation.Responses.ContainsKey("403") == false) | ||
| { | ||
| #if NETCOREAPP3_1 | ||
| operation.Responses.Add("403", new OpenApiResponse { Description = "Forbidden" }); | ||
| #else | ||
| operation.Responses.Add("403", new Response { Description = "Forbidden" }); | ||
| #endif | ||
| } | ||
|
|
||
| #if NETCOREAPP3_1 | ||
| var scheme = new OpenApiSecurityScheme | ||
| { | ||
| Scheme = _securitySchemeName, | ||
| Type = _securitySchemeType, | ||
| In = ParameterLocation.Header | ||
| }; | ||
|
|
||
| operation.Security = new List<OpenApiSecurityRequirement> | ||
| { | ||
| new OpenApiSecurityRequirement | ||
| { | ||
| [scheme] = new List<string>() | ||
| } | ||
| }; | ||
| #else | ||
| operation.Security = new List<IDictionary<string, IEnumerable<string>>> | ||
| { | ||
| new Dictionary<string, IEnumerable<string>> { [_securitySchemeName] = Enumerable.Empty<string>() } | ||
| }; | ||
| #endif | ||
| } | ||
| } | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.