Add default auth policy to generated openapi spec (#11181)

pull/11199/head
Cody Robibero 3 months ago committed by GitHub
parent c16135800c
commit d9e35a969f
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

@ -1,18 +1,34 @@
using System; using System;
using System.Collections.Generic; using System.Collections.Generic;
using System.Linq; using System.Linq;
using Jellyfin.Api.Auth.DefaultAuthorizationPolicy;
using Jellyfin.Api.Constants; using Jellyfin.Api.Constants;
using Jellyfin.Extensions;
using Microsoft.AspNetCore.Authorization; using Microsoft.AspNetCore.Authorization;
using Microsoft.OpenApi.Models; using Microsoft.OpenApi.Models;
using Swashbuckle.AspNetCore.SwaggerGen; using Swashbuckle.AspNetCore.SwaggerGen;
namespace Jellyfin.Server.Filters namespace Jellyfin.Server.Filters;
{
/// <summary> /// <summary>
/// Security requirement operation filter. /// Security requirement operation filter.
/// </summary> /// </summary>
public class SecurityRequirementsOperationFilter : IOperationFilter public class SecurityRequirementsOperationFilter : IOperationFilter
{ {
private const string DefaultAuthPolicy = "DefaultAuthorization";
private static readonly Type _attributeType = typeof(AuthorizeAttribute);
private readonly IAuthorizationPolicyProvider _authorizationPolicyProvider;
/// <summary>
/// Initializes a new instance of the <see cref="SecurityRequirementsOperationFilter"/> class.
/// </summary>
/// <param name="authorizationPolicyProvider">The authorization policy provider.</param>
public SecurityRequirementsOperationFilter(IAuthorizationPolicyProvider authorizationPolicyProvider)
{
_authorizationPolicyProvider = authorizationPolicyProvider;
}
/// <inheritdoc /> /// <inheritdoc />
public void Apply(OpenApiOperation operation, OperationFilterContext context) public void Apply(OpenApiOperation operation, OperationFilterContext context)
{ {
@ -20,37 +36,27 @@ namespace Jellyfin.Server.Filters
var requiresAuth = false; var requiresAuth = false;
// Add all method scopes. // Add all method scopes.
foreach (var attribute in context.MethodInfo.GetCustomAttributes(true)) foreach (var authorizeAttribute in context.MethodInfo.GetCustomAttributes(_attributeType, true).Cast<AuthorizeAttribute>())
{
if (attribute is not AuthorizeAttribute authorizeAttribute)
{ {
continue;
}
requiresAuth = true; requiresAuth = true;
if (authorizeAttribute.Policy is not null var policy = authorizeAttribute.Policy ?? DefaultAuthPolicy;
&& !requiredScopes.Contains(authorizeAttribute.Policy, StringComparer.Ordinal)) if (!requiredScopes.Contains(policy, StringComparer.Ordinal))
{ {
requiredScopes.Add(authorizeAttribute.Policy); requiredScopes.Add(policy);
} }
} }
// Add controller scopes if any. // Add controller scopes if any.
var controllerAttributes = context.MethodInfo.DeclaringType?.GetCustomAttributes(true); var controllerAttributes = context.MethodInfo.DeclaringType?.GetCustomAttributes(_attributeType, true).Cast<AuthorizeAttribute>();
if (controllerAttributes is not null) if (controllerAttributes is not null)
{ {
foreach (var attribute in controllerAttributes) foreach (var authorizeAttribute in controllerAttributes)
{
if (attribute is not AuthorizeAttribute authorizeAttribute)
{ {
continue;
}
requiresAuth = true; requiresAuth = true;
if (authorizeAttribute.Policy is not null var policy = authorizeAttribute.Policy ?? DefaultAuthPolicy;
&& !requiredScopes.Contains(authorizeAttribute.Policy, StringComparer.Ordinal)) if (!requiredScopes.Contains(policy, StringComparer.Ordinal))
{ {
requiredScopes.Add(authorizeAttribute.Policy); requiredScopes.Add(policy);
} }
} }
} }
@ -76,16 +82,24 @@ namespace Jellyfin.Server.Filters
{ {
Type = ReferenceType.SecurityScheme, Type = ReferenceType.SecurityScheme,
Id = AuthenticationSchemes.CustomAuthentication Id = AuthenticationSchemes.CustomAuthentication
} },
}; };
operation.Security = new List<OpenApiSecurityRequirement> // Add DefaultAuthorization scope to any endpoint that has a policy with a requirement that is a subset of DefaultAuthorization.
if (!requiredScopes.Contains(DefaultAuthPolicy.AsSpan(), StringComparison.Ordinal))
{
foreach (var scope in requiredScopes)
{ {
new OpenApiSecurityRequirement var authorizationPolicy = _authorizationPolicyProvider.GetPolicyAsync(scope).GetAwaiter().GetResult();
if (authorizationPolicy is not null
&& authorizationPolicy.Requirements.Any(r => r is DefaultAuthorizationRequirement))
{ {
[scheme] = requiredScopes requiredScopes.Add(DefaultAuthPolicy);
break;
} }
};
} }
} }
operation.Security = [new OpenApiSecurityRequirement { [scheme] = requiredScopes }];
}
} }

Loading…
Cancel
Save