SecurityRequirementsOperationFilter.cs 3.6 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798
  1. using System;
  2. using System.Collections.Generic;
  3. using System.Linq;
  4. using Jellyfin.Api.Auth.DefaultAuthorizationPolicy;
  5. using Jellyfin.Api.Constants;
  6. using Jellyfin.Extensions;
  7. using Microsoft.AspNetCore.Authorization;
  8. using Microsoft.OpenApi.Models;
  9. using Swashbuckle.AspNetCore.SwaggerGen;
  10. namespace Jellyfin.Server.Filters;
  11. /// <summary>
  12. /// Security requirement operation filter.
  13. /// </summary>
  14. public class SecurityRequirementsOperationFilter : IOperationFilter
  15. {
  16. private const string DefaultAuthPolicy = "DefaultAuthorization";
  17. private static readonly Type _attributeType = typeof(AuthorizeAttribute);
  18. private readonly IAuthorizationPolicyProvider _authorizationPolicyProvider;
  19. /// <summary>
  20. /// Initializes a new instance of the <see cref="SecurityRequirementsOperationFilter"/> class.
  21. /// </summary>
  22. /// <param name="authorizationPolicyProvider">The authorization policy provider.</param>
  23. public SecurityRequirementsOperationFilter(IAuthorizationPolicyProvider authorizationPolicyProvider)
  24. {
  25. _authorizationPolicyProvider = authorizationPolicyProvider;
  26. }
  27. /// <inheritdoc />
  28. public void Apply(OpenApiOperation operation, OperationFilterContext context)
  29. {
  30. var requiredScopes = new List<string>();
  31. var requiresAuth = false;
  32. // Add all method scopes.
  33. foreach (var authorizeAttribute in context.MethodInfo.GetCustomAttributes(_attributeType, true).Cast<AuthorizeAttribute>())
  34. {
  35. requiresAuth = true;
  36. var policy = authorizeAttribute.Policy ?? DefaultAuthPolicy;
  37. if (!requiredScopes.Contains(policy, StringComparer.Ordinal))
  38. {
  39. requiredScopes.Add(policy);
  40. }
  41. }
  42. // Add controller scopes if any.
  43. var controllerAttributes = context.MethodInfo.DeclaringType?.GetCustomAttributes(_attributeType, true).Cast<AuthorizeAttribute>();
  44. if (controllerAttributes is not null)
  45. {
  46. foreach (var authorizeAttribute in controllerAttributes)
  47. {
  48. requiresAuth = true;
  49. var policy = authorizeAttribute.Policy ?? DefaultAuthPolicy;
  50. if (!requiredScopes.Contains(policy, StringComparer.Ordinal))
  51. {
  52. requiredScopes.Add(policy);
  53. }
  54. }
  55. }
  56. if (!requiresAuth)
  57. {
  58. return;
  59. }
  60. operation.Responses.TryAdd("401", new OpenApiResponse { Description = "Unauthorized" });
  61. operation.Responses.TryAdd("403", new OpenApiResponse { Description = "Forbidden" });
  62. var scheme = new OpenApiSecurityScheme
  63. {
  64. Reference = new OpenApiReference
  65. {
  66. Type = ReferenceType.SecurityScheme,
  67. Id = AuthenticationSchemes.CustomAuthentication
  68. },
  69. };
  70. // Add DefaultAuthorization scope to any endpoint that has a policy with a requirement that is a subset of DefaultAuthorization.
  71. if (!requiredScopes.Contains(DefaultAuthPolicy.AsSpan(), StringComparison.Ordinal))
  72. {
  73. foreach (var scope in requiredScopes)
  74. {
  75. var authorizationPolicy = _authorizationPolicyProvider.GetPolicyAsync(scope).GetAwaiter().GetResult();
  76. if (authorizationPolicy is not null
  77. && authorizationPolicy.Requirements.Any(r => r is DefaultAuthorizationRequirement))
  78. {
  79. requiredScopes.Add(DefaultAuthPolicy);
  80. break;
  81. }
  82. }
  83. }
  84. operation.Security = [new OpenApiSecurityRequirement { [scheme] = requiredScopes }];
  85. }
  86. }