jellyfin/Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs

221 lines
9.8 KiB
C#
Raw Normal View History

2020-04-19 17:24:32 +00:00
using System;
using System.Collections.Generic;
using System.IO;
using System.Linq;
2020-05-08 14:40:37 +00:00
using System.Reflection;
using Jellyfin.Api;
2019-11-23 18:43:30 +00:00
using Jellyfin.Api.Auth;
using Jellyfin.Api.Auth.DefaultAuthorizationPolicy;
2019-11-23 18:43:30 +00:00
using Jellyfin.Api.Auth.FirstTimeSetupOrElevatedPolicy;
using Jellyfin.Api.Auth.IgnoreSchedulePolicy;
using Jellyfin.Api.Auth.LocalAccessPolicy;
2019-11-23 18:43:30 +00:00
using Jellyfin.Api.Auth.RequiresElevationPolicy;
2019-11-24 18:25:46 +00:00
using Jellyfin.Api.Constants;
2019-11-23 18:43:30 +00:00
using Jellyfin.Api.Controllers;
2020-04-20 00:10:59 +00:00
using Jellyfin.Server.Formatters;
2020-06-01 17:03:08 +00:00
using Jellyfin.Server.Models;
using MediaBrowser.Common.Json;
using MediaBrowser.Model.Entities;
2019-11-23 18:43:30 +00:00
using Microsoft.AspNetCore.Authentication;
using Microsoft.AspNetCore.Authorization;
2020-06-17 14:05:30 +00:00
using Microsoft.AspNetCore.Builder;
using Microsoft.AspNetCore.HttpOverrides;
2019-11-23 18:43:30 +00:00
using Microsoft.Extensions.DependencyInjection;
using Microsoft.OpenApi.Models;
2020-05-08 14:40:37 +00:00
using Swashbuckle.AspNetCore.SwaggerGen;
2019-11-23 18:43:30 +00:00
namespace Jellyfin.Server.Extensions
2019-11-23 18:43:30 +00:00
{
2019-11-23 19:31:17 +00:00
/// <summary>
/// API specific extensions for the service collection.
/// </summary>
2019-11-23 18:43:30 +00:00
public static class ApiServiceCollectionExtensions
{
2019-11-23 19:31:17 +00:00
/// <summary>
/// Adds jellyfin API authorization policies to the DI container.
/// </summary>
/// <param name="serviceCollection">The service collection.</param>
/// <returns>The updated service collection.</returns>
2019-11-23 18:43:30 +00:00
public static IServiceCollection AddJellyfinApiAuthorization(this IServiceCollection serviceCollection)
{
serviceCollection.AddSingleton<IAuthorizationHandler, DefaultAuthorizationHandler>();
2019-11-23 18:43:30 +00:00
serviceCollection.AddSingleton<IAuthorizationHandler, FirstTimeSetupOrElevatedHandler>();
serviceCollection.AddSingleton<IAuthorizationHandler, IgnoreScheduleHandler>();
serviceCollection.AddSingleton<IAuthorizationHandler, LocalAccessHandler>();
2019-11-23 18:43:30 +00:00
serviceCollection.AddSingleton<IAuthorizationHandler, RequiresElevationHandler>();
return serviceCollection.AddAuthorizationCore(options =>
{
options.AddPolicy(
Policies.DefaultAuthorization,
2019-11-23 18:43:30 +00:00
policy =>
{
2019-11-24 18:25:46 +00:00
policy.AddAuthenticationSchemes(AuthenticationSchemes.CustomAuthentication);
policy.AddRequirements(new DefaultAuthorizationRequirement());
2019-11-23 18:43:30 +00:00
});
options.AddPolicy(
2019-11-24 18:25:46 +00:00
Policies.FirstTimeSetupOrElevated,
2019-11-23 18:43:30 +00:00
policy =>
{
2019-11-24 18:25:46 +00:00
policy.AddAuthenticationSchemes(AuthenticationSchemes.CustomAuthentication);
2019-11-23 18:43:30 +00:00
policy.AddRequirements(new FirstTimeSetupOrElevatedRequirement());
});
options.AddPolicy(
Policies.IgnoreSchedule,
policy =>
{
policy.AddAuthenticationSchemes(AuthenticationSchemes.CustomAuthentication);
policy.AddRequirements(new IgnoreScheduleRequirement());
});
options.AddPolicy(
Policies.LocalAccessOnly,
policy =>
{
policy.AddAuthenticationSchemes(AuthenticationSchemes.CustomAuthentication);
policy.AddRequirements(new LocalAccessRequirement());
});
options.AddPolicy(
Policies.RequiresElevation,
policy =>
{
policy.AddAuthenticationSchemes(AuthenticationSchemes.CustomAuthentication);
policy.AddRequirements(new RequiresElevationRequirement());
});
2019-11-23 18:43:30 +00:00
});
}
2019-11-23 19:31:17 +00:00
/// <summary>
/// Adds custom legacy authentication to the service collection.
/// </summary>
/// <param name="serviceCollection">The service collection.</param>
/// <returns>The updated service collection.</returns>
2019-11-23 18:43:30 +00:00
public static AuthenticationBuilder AddCustomAuthentication(this IServiceCollection serviceCollection)
{
2019-11-24 18:25:46 +00:00
return serviceCollection.AddAuthentication(AuthenticationSchemes.CustomAuthentication)
.AddScheme<AuthenticationSchemeOptions, CustomAuthenticationHandler>(AuthenticationSchemes.CustomAuthentication, null);
2019-11-23 18:43:30 +00:00
}
2019-11-23 19:31:17 +00:00
/// <summary>
/// Extension method for adding the jellyfin API to the service collection.
/// </summary>
/// <param name="serviceCollection">The service collection.</param>
/// <param name="baseUrl">The base url for the API.</param>
/// <returns>The MVC builder.</returns>
2019-11-23 18:43:30 +00:00
public static IMvcBuilder AddJellyfinApi(this IServiceCollection serviceCollection, string baseUrl)
{
2020-06-01 17:03:08 +00:00
return serviceCollection
.AddCors(options =>
{
options.AddPolicy(ServerCorsPolicy.DefaultPolicyName, ServerCorsPolicy.DefaultPolicy);
})
2020-06-17 14:05:30 +00:00
.Configure<ForwardedHeadersOptions>(options =>
{
options.ForwardedHeaders = ForwardedHeaders.XForwardedFor | ForwardedHeaders.XForwardedProto;
})
2020-06-01 17:03:08 +00:00
.AddMvc(opts =>
2019-11-23 18:43:30 +00:00
{
opts.UseGeneralRoutePrefix(baseUrl);
2020-04-20 00:10:59 +00:00
opts.OutputFormatters.Insert(0, new CamelCaseJsonProfileFormatter());
opts.OutputFormatters.Insert(0, new PascalCaseJsonProfileFormatter());
2020-06-06 22:51:21 +00:00
opts.OutputFormatters.Add(new CssOutputFormatter());
2019-11-23 18:43:30 +00:00
})
2019-11-23 19:31:17 +00:00
2019-11-23 18:43:30 +00:00
// Clear app parts to avoid other assemblies being picked up
.ConfigureApplicationPartManager(a => a.ApplicationParts.Clear())
.AddApplicationPart(typeof(StartupController).Assembly)
.AddJsonOptions(options =>
{
// Update all properties that are set in JsonDefaults
2020-06-13 19:11:41 +00:00
var jsonOptions = JsonDefaults.GetPascalCaseOptions();
// From JsonDefaults
options.JsonSerializerOptions.ReadCommentHandling = jsonOptions.ReadCommentHandling;
options.JsonSerializerOptions.WriteIndented = jsonOptions.WriteIndented;
options.JsonSerializerOptions.Converters.Clear();
foreach (var converter in jsonOptions.Converters)
{
options.JsonSerializerOptions.Converters.Add(converter);
}
// From JsonDefaults.PascalCase
options.JsonSerializerOptions.PropertyNamingPolicy = jsonOptions.PropertyNamingPolicy;
})
2019-11-23 18:43:30 +00:00
.AddControllersAsServices();
}
2019-11-23 19:31:17 +00:00
/// <summary>
/// Adds Swagger to the service collection.
/// </summary>
/// <param name="serviceCollection">The service collection.</param>
/// <returns>The updated service collection.</returns>
2019-11-23 18:43:30 +00:00
public static IServiceCollection AddJellyfinApiSwagger(this IServiceCollection serviceCollection)
{
return serviceCollection.AddSwaggerGen(c =>
{
2020-06-12 20:37:55 +00:00
c.SwaggerDoc("api-docs", new OpenApiInfo { Title = "Jellyfin API", Version = "v1" });
c.AddSecurityDefinition(AuthenticationSchemes.CustomAuthentication, new OpenApiSecurityScheme
{
Type = SecuritySchemeType.ApiKey,
In = ParameterLocation.Header,
Name = "X-Emby-Token",
Description = "API key header parameter"
});
var securitySchemeRef = new OpenApiSecurityScheme
{
Reference = new OpenApiReference { Type = ReferenceType.SecurityScheme, Id = AuthenticationSchemes.CustomAuthentication },
};
// TODO: Apply this with an operation filter instead of globally
// https://github.com/domaindrivendev/Swashbuckle.AspNetCore#add-security-definitions-and-requirements
c.AddSecurityRequirement(new OpenApiSecurityRequirement
{
{ securitySchemeRef, Array.Empty<string>() }
});
2020-04-19 17:24:32 +00:00
// Add all xml doc files to swagger generator.
var xmlFiles = Directory.GetFiles(
AppContext.BaseDirectory,
"*.xml",
SearchOption.TopDirectoryOnly);
foreach (var xmlFile in xmlFiles)
{
c.IncludeXmlComments(xmlFile);
}
// Order actions by route path, then by http method.
c.OrderActionsBy(description =>
$"{description.ActionDescriptor.RouteValues["controller"]}_{description.HttpMethod}");
2020-05-08 14:40:37 +00:00
// Use method name as operationId
c.CustomOperationIds(description =>
description.TryGetMethodInfo(out MethodInfo methodInfo) ? methodInfo.Name : null);
// TODO - remove when all types are supported in System.Text.Json
c.AddSwaggerTypeMappings();
2019-11-23 18:43:30 +00:00
});
}
private static void AddSwaggerTypeMappings(this SwaggerGenOptions options)
{
/*
* TODO remove when System.Text.Json supports non-string keys.
* Used in Jellyfin.Api.Controller.GetChannels.
*/
options.MapType<Dictionary<ImageType, string>>(() =>
new OpenApiSchema
{
Type = "object",
Properties = typeof(ImageType).GetEnumNames().ToDictionary(
name => name,
name => new OpenApiSchema
{
Type = "string",
Format = "string"
})
});
}
2019-11-23 18:43:30 +00:00
}
}