mirror of
https://github.com/jellyfin/jellyfin.git
synced 2024-09-09 12:58:37 +02:00
616 lines
21 KiB
C#
616 lines
21 KiB
C#
using System;
|
|
using System.Linq;
|
|
using System.Threading.Tasks;
|
|
using MediaBrowser.Common.Extensions;
|
|
using MediaBrowser.Common.Net;
|
|
using MediaBrowser.Controller.Authentication;
|
|
using MediaBrowser.Controller.Configuration;
|
|
using MediaBrowser.Controller.Devices;
|
|
using MediaBrowser.Controller.Library;
|
|
using MediaBrowser.Controller.Net;
|
|
using MediaBrowser.Controller.Session;
|
|
using MediaBrowser.Model.Configuration;
|
|
using MediaBrowser.Model.Dto;
|
|
using MediaBrowser.Model.Services;
|
|
using MediaBrowser.Model.Users;
|
|
using Microsoft.Extensions.Logging;
|
|
|
|
namespace MediaBrowser.Api
|
|
{
|
|
/// <summary>
|
|
/// Class GetUsers
|
|
/// </summary>
|
|
[Route("/Users", "GET", Summary = "Gets a list of users")]
|
|
[Authenticated]
|
|
public class GetUsers : IReturn<UserDto[]>
|
|
{
|
|
[ApiMember(Name = "IsHidden", Description = "Optional filter by IsHidden=true or false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
public bool? IsHidden { get; set; }
|
|
|
|
[ApiMember(Name = "IsDisabled", Description = "Optional filter by IsDisabled=true or false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
public bool? IsDisabled { get; set; }
|
|
|
|
[ApiMember(Name = "IsGuest", Description = "Optional filter by IsGuest=true or false", IsRequired = false, DataType = "bool", ParameterType = "query", Verb = "GET")]
|
|
public bool? IsGuest { get; set; }
|
|
}
|
|
|
|
[Route("/Users/Public", "GET", Summary = "Gets a list of publicly visible users for display on a login screen.")]
|
|
public class GetPublicUsers : IReturn<PublicUserDto[]>
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class GetUser
|
|
/// </summary>
|
|
[Route("/Users/{Id}", "GET", Summary = "Gets a user by Id")]
|
|
[Authenticated(EscapeParentalControl = true)]
|
|
public class GetUser : IReturn<UserDto>
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "GET")]
|
|
public Guid Id { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class DeleteUser
|
|
/// </summary>
|
|
[Route("/Users/{Id}", "DELETE", Summary = "Deletes a user")]
|
|
[Authenticated(Roles = "Admin")]
|
|
public class DeleteUser : IReturnVoid
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "DELETE")]
|
|
public Guid Id { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class AuthenticateUser
|
|
/// </summary>
|
|
[Route("/Users/{Id}/Authenticate", "POST", Summary = "Authenticates a user")]
|
|
public class AuthenticateUser : IReturn<AuthenticationResult>
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
|
|
public Guid Id { get; set; }
|
|
|
|
[ApiMember(Name = "Pw", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Pw { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the password.
|
|
/// </summary>
|
|
/// <value>The password.</value>
|
|
[ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Password { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class AuthenticateUser
|
|
/// </summary>
|
|
[Route("/Users/AuthenticateByName", "POST", Summary = "Authenticates a user")]
|
|
public class AuthenticateUserByName : IReturn<AuthenticationResult>
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
[ApiMember(Name = "Username", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Username { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the password.
|
|
/// </summary>
|
|
/// <value>The password.</value>
|
|
[ApiMember(Name = "Password", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Password { get; set; }
|
|
|
|
[ApiMember(Name = "Pw", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Pw { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class UpdateUserPassword
|
|
/// </summary>
|
|
[Route("/Users/{Id}/Password", "POST", Summary = "Updates a user's password")]
|
|
[Authenticated]
|
|
public class UpdateUserPassword : IReturnVoid
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
public Guid Id { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the password.
|
|
/// </summary>
|
|
/// <value>The password.</value>
|
|
public string CurrentPassword { get; set; }
|
|
|
|
public string CurrentPw { get; set; }
|
|
|
|
public string NewPw { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets a value indicating whether [reset password].
|
|
/// </summary>
|
|
/// <value><c>true</c> if [reset password]; otherwise, <c>false</c>.</value>
|
|
public bool ResetPassword { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class UpdateUserEasyPassword
|
|
/// </summary>
|
|
[Route("/Users/{Id}/EasyPassword", "POST", Summary = "Updates a user's easy password")]
|
|
[Authenticated]
|
|
public class UpdateUserEasyPassword : IReturnVoid
|
|
{
|
|
/// <summary>
|
|
/// Gets or sets the id.
|
|
/// </summary>
|
|
/// <value>The id.</value>
|
|
public Guid Id { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets the new password.
|
|
/// </summary>
|
|
/// <value>The new password.</value>
|
|
public string NewPassword { get; set; }
|
|
|
|
public string NewPw { get; set; }
|
|
|
|
/// <summary>
|
|
/// Gets or sets a value indicating whether [reset password].
|
|
/// </summary>
|
|
/// <value><c>true</c> if [reset password]; otherwise, <c>false</c>.</value>
|
|
public bool ResetPassword { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class UpdateUser
|
|
/// </summary>
|
|
[Route("/Users/{Id}", "POST", Summary = "Updates a user")]
|
|
[Authenticated]
|
|
public class UpdateUser : UserDto, IReturnVoid
|
|
{
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class UpdateUser
|
|
/// </summary>
|
|
[Route("/Users/{Id}/Policy", "POST", Summary = "Updates a user policy")]
|
|
[Authenticated(Roles = "admin")]
|
|
public class UpdateUserPolicy : UserPolicy, IReturnVoid
|
|
{
|
|
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
|
|
public Guid Id { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class UpdateUser
|
|
/// </summary>
|
|
[Route("/Users/{Id}/Configuration", "POST", Summary = "Updates a user configuration")]
|
|
[Authenticated]
|
|
public class UpdateUserConfiguration : UserConfiguration, IReturnVoid
|
|
{
|
|
[ApiMember(Name = "User Id", IsRequired = true, DataType = "string", ParameterType = "path", Verb = "POST")]
|
|
public Guid Id { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class CreateUser
|
|
/// </summary>
|
|
[Route("/Users/New", "POST", Summary = "Creates a user")]
|
|
[Authenticated(Roles = "Admin")]
|
|
public class CreateUserByName : IReturn<UserDto>
|
|
{
|
|
[ApiMember(Name = "Name", IsRequired = true, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Name { get; set; }
|
|
|
|
[ApiMember(Name = "Password", IsRequired = false, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Password { get; set; }
|
|
}
|
|
|
|
[Route("/Users/ForgotPassword", "POST", Summary = "Initiates the forgot password process for a local user")]
|
|
public class ForgotPassword : IReturn<ForgotPasswordResult>
|
|
{
|
|
[ApiMember(Name = "EnteredUsername", IsRequired = false, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string EnteredUsername { get; set; }
|
|
}
|
|
|
|
[Route("/Users/ForgotPassword/Pin", "POST", Summary = "Redeems a forgot password pin")]
|
|
public class ForgotPasswordPin : IReturn<PinRedeemResult>
|
|
{
|
|
[ApiMember(Name = "Pin", IsRequired = false, DataType = "string", ParameterType = "body", Verb = "POST")]
|
|
public string Pin { get; set; }
|
|
}
|
|
|
|
/// <summary>
|
|
/// Class UsersService
|
|
/// </summary>
|
|
public class UserService : BaseApiService
|
|
{
|
|
/// <summary>
|
|
/// The user manager.
|
|
/// </summary>
|
|
private readonly IUserManager _userManager;
|
|
private readonly ISessionManager _sessionMananger;
|
|
private readonly INetworkManager _networkManager;
|
|
private readonly IDeviceManager _deviceManager;
|
|
private readonly IAuthorizationContext _authContext;
|
|
|
|
public UserService(
|
|
ILogger<UserService> logger,
|
|
IServerConfigurationManager serverConfigurationManager,
|
|
IHttpResultFactory httpResultFactory,
|
|
IUserManager userManager,
|
|
ISessionManager sessionMananger,
|
|
INetworkManager networkManager,
|
|
IDeviceManager deviceManager,
|
|
IAuthorizationContext authContext)
|
|
: base(logger, serverConfigurationManager, httpResultFactory)
|
|
{
|
|
_userManager = userManager;
|
|
_sessionMananger = sessionMananger;
|
|
_networkManager = networkManager;
|
|
_deviceManager = deviceManager;
|
|
_authContext = authContext;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the public available Users information
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <returns>System.Object.</returns>
|
|
public object Get(GetPublicUsers request)
|
|
{
|
|
var result = _userManager
|
|
.Users
|
|
.Where(item => !item.Policy.IsDisabled);
|
|
|
|
if (ServerConfigurationManager.Configuration.IsStartupWizardCompleted)
|
|
{
|
|
var deviceId = _authContext.GetAuthorizationInfo(Request).DeviceId;
|
|
result = result.Where(item => !item.Policy.IsHidden);
|
|
|
|
if (!string.IsNullOrWhiteSpace(deviceId))
|
|
{
|
|
result = result.Where(i => _deviceManager.CanAccessDevice(i, deviceId));
|
|
}
|
|
|
|
if (!_networkManager.IsInLocalNetwork(Request.RemoteIp))
|
|
{
|
|
result = result.Where(i => i.Policy.EnableRemoteAccess);
|
|
}
|
|
}
|
|
|
|
return ToOptimizedResult(result
|
|
.OrderBy(u => u.Name)
|
|
.Select(i => _userManager.GetPublicUserDto(i, Request.RemoteIp))
|
|
.ToArray()
|
|
);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <returns>System.Object.</returns>
|
|
public object Get(GetUsers request)
|
|
{
|
|
return Get(request, false, false);
|
|
}
|
|
|
|
private object Get(GetUsers request, bool filterByDevice, bool filterByNetwork)
|
|
{
|
|
var users = _userManager.Users;
|
|
|
|
if (request.IsDisabled.HasValue)
|
|
{
|
|
users = users.Where(i => i.Policy.IsDisabled == request.IsDisabled.Value);
|
|
}
|
|
|
|
if (request.IsHidden.HasValue)
|
|
{
|
|
users = users.Where(i => i.Policy.IsHidden == request.IsHidden.Value);
|
|
}
|
|
|
|
if (filterByDevice)
|
|
{
|
|
var deviceId = _authContext.GetAuthorizationInfo(Request).DeviceId;
|
|
|
|
if (!string.IsNullOrWhiteSpace(deviceId))
|
|
{
|
|
users = users.Where(i => _deviceManager.CanAccessDevice(i, deviceId));
|
|
}
|
|
}
|
|
|
|
if (filterByNetwork)
|
|
{
|
|
if (!_networkManager.IsInLocalNetwork(Request.RemoteIp))
|
|
{
|
|
users = users.Where(i => i.Policy.EnableRemoteAccess);
|
|
}
|
|
}
|
|
|
|
var result = users
|
|
.OrderBy(u => u.Name)
|
|
.Select(i => _userManager.GetUserDto(i, Request.RemoteIp))
|
|
.ToArray();
|
|
|
|
return ToOptimizedResult(result);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Gets the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <returns>System.Object.</returns>
|
|
public object Get(GetUser request)
|
|
{
|
|
var user = _userManager.GetUserById(request.Id);
|
|
|
|
if (user == null)
|
|
{
|
|
throw new ResourceNotFoundException("User not found");
|
|
}
|
|
|
|
var result = _userManager.GetUserDto(user, Request.RemoteIp);
|
|
|
|
return ToOptimizedResult(result);
|
|
}
|
|
|
|
/// <summary>
|
|
/// Deletes the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
public Task Delete(DeleteUser request)
|
|
{
|
|
return DeleteAsync(request);
|
|
}
|
|
|
|
public Task DeleteAsync(DeleteUser request)
|
|
{
|
|
var user = _userManager.GetUserById(request.Id);
|
|
|
|
if (user == null)
|
|
{
|
|
throw new ResourceNotFoundException("User not found");
|
|
}
|
|
|
|
_sessionMananger.RevokeUserTokens(user.Id, null);
|
|
_userManager.DeleteUser(user);
|
|
return Task.CompletedTask;
|
|
}
|
|
|
|
/// <summary>
|
|
/// Posts the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
public object Post(AuthenticateUser request)
|
|
{
|
|
var user = _userManager.GetUserById(request.Id);
|
|
|
|
if (user == null)
|
|
{
|
|
throw new ResourceNotFoundException("User not found");
|
|
}
|
|
|
|
if (!string.IsNullOrEmpty(request.Password) && string.IsNullOrEmpty(request.Pw))
|
|
{
|
|
throw new MethodNotAllowedException("Hashed-only passwords are not valid for this API.");
|
|
}
|
|
|
|
// Password should always be null
|
|
return Post(new AuthenticateUserByName
|
|
{
|
|
Username = user.Name,
|
|
Password = null,
|
|
Pw = request.Pw
|
|
});
|
|
}
|
|
|
|
public async Task<object> Post(AuthenticateUserByName request)
|
|
{
|
|
var auth = _authContext.GetAuthorizationInfo(Request);
|
|
|
|
try
|
|
{
|
|
var result = await _sessionMananger.AuthenticateNewSession(new AuthenticationRequest
|
|
{
|
|
App = auth.Client,
|
|
AppVersion = auth.Version,
|
|
DeviceId = auth.DeviceId,
|
|
DeviceName = auth.Device,
|
|
Password = request.Pw,
|
|
PasswordSha1 = request.Password,
|
|
RemoteEndPoint = Request.RemoteIp,
|
|
Username = request.Username
|
|
}).ConfigureAwait(false);
|
|
|
|
return ToOptimizedResult(result);
|
|
}
|
|
catch (SecurityException e)
|
|
{
|
|
// rethrow adding IP address to message
|
|
throw new SecurityException($"[{Request.RemoteIp}] {e.Message}", e);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Posts the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
public Task Post(UpdateUserPassword request)
|
|
{
|
|
return PostAsync(request);
|
|
}
|
|
|
|
public async Task PostAsync(UpdateUserPassword request)
|
|
{
|
|
AssertCanUpdateUser(_authContext, _userManager, request.Id, true);
|
|
|
|
var user = _userManager.GetUserById(request.Id);
|
|
|
|
if (user == null)
|
|
{
|
|
throw new ResourceNotFoundException("User not found");
|
|
}
|
|
|
|
if (request.ResetPassword)
|
|
{
|
|
await _userManager.ResetPassword(user).ConfigureAwait(false);
|
|
}
|
|
else
|
|
{
|
|
var success = await _userManager.AuthenticateUser(user.Name, request.CurrentPw, request.CurrentPassword, Request.RemoteIp, false).ConfigureAwait(false);
|
|
|
|
if (success == null)
|
|
{
|
|
throw new ArgumentException("Invalid user or password entered.");
|
|
}
|
|
|
|
await _userManager.ChangePassword(user, request.NewPw).ConfigureAwait(false);
|
|
|
|
var currentToken = _authContext.GetAuthorizationInfo(Request).Token;
|
|
|
|
_sessionMananger.RevokeUserTokens(user.Id, currentToken);
|
|
}
|
|
}
|
|
|
|
public void Post(UpdateUserEasyPassword request)
|
|
{
|
|
AssertCanUpdateUser(_authContext, _userManager, request.Id, true);
|
|
|
|
var user = _userManager.GetUserById(request.Id);
|
|
|
|
if (user == null)
|
|
{
|
|
throw new ResourceNotFoundException("User not found");
|
|
}
|
|
|
|
if (request.ResetPassword)
|
|
{
|
|
_userManager.ResetEasyPassword(user);
|
|
}
|
|
else
|
|
{
|
|
_userManager.ChangeEasyPassword(user, request.NewPw, request.NewPassword);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Posts the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
public async Task Post(UpdateUser request)
|
|
{
|
|
var id = Guid.Parse(GetPathValue(1));
|
|
|
|
AssertCanUpdateUser(_authContext, _userManager, id, false);
|
|
|
|
var dtoUser = request;
|
|
|
|
var user = _userManager.GetUserById(id);
|
|
|
|
if (string.Equals(user.Name, dtoUser.Name, StringComparison.Ordinal))
|
|
{
|
|
_userManager.UpdateUser(user);
|
|
_userManager.UpdateConfiguration(user, dtoUser.Configuration);
|
|
}
|
|
else
|
|
{
|
|
await _userManager.RenameUser(user, dtoUser.Name).ConfigureAwait(false);
|
|
|
|
_userManager.UpdateConfiguration(dtoUser.Id, dtoUser.Configuration);
|
|
}
|
|
}
|
|
|
|
/// <summary>
|
|
/// Posts the specified request.
|
|
/// </summary>
|
|
/// <param name="request">The request.</param>
|
|
/// <returns>System.Object.</returns>
|
|
public async Task<object> Post(CreateUserByName request)
|
|
{
|
|
var newUser = _userManager.CreateUser(request.Name);
|
|
|
|
// no need to authenticate password for new user
|
|
if (request.Password != null)
|
|
{
|
|
await _userManager.ChangePassword(newUser, request.Password).ConfigureAwait(false);
|
|
}
|
|
|
|
var result = _userManager.GetUserDto(newUser, Request.RemoteIp);
|
|
|
|
return ToOptimizedResult(result);
|
|
}
|
|
|
|
public async Task<object> Post(ForgotPassword request)
|
|
{
|
|
var isLocal = Request.IsLocal || _networkManager.IsInLocalNetwork(Request.RemoteIp);
|
|
|
|
var result = await _userManager.StartForgotPasswordProcess(request.EnteredUsername, isLocal).ConfigureAwait(false);
|
|
|
|
return result;
|
|
}
|
|
|
|
public async Task<object> Post(ForgotPasswordPin request)
|
|
{
|
|
var result = await _userManager.RedeemPasswordResetPin(request.Pin).ConfigureAwait(false);
|
|
|
|
return result;
|
|
}
|
|
|
|
public void Post(UpdateUserConfiguration request)
|
|
{
|
|
AssertCanUpdateUser(_authContext, _userManager, request.Id, false);
|
|
|
|
_userManager.UpdateConfiguration(request.Id, request);
|
|
|
|
}
|
|
|
|
public void Post(UpdateUserPolicy request)
|
|
{
|
|
var user = _userManager.GetUserById(request.Id);
|
|
|
|
// If removing admin access
|
|
if (!request.IsAdministrator && user.Policy.IsAdministrator)
|
|
{
|
|
if (_userManager.Users.Count(i => i.Policy.IsAdministrator) == 1)
|
|
{
|
|
throw new ArgumentException("There must be at least one user in the system with administrative access.");
|
|
}
|
|
}
|
|
|
|
// If disabling
|
|
if (request.IsDisabled && user.Policy.IsAdministrator)
|
|
{
|
|
throw new ArgumentException("Administrators cannot be disabled.");
|
|
}
|
|
|
|
// If disabling
|
|
if (request.IsDisabled && !user.Policy.IsDisabled)
|
|
{
|
|
if (_userManager.Users.Count(i => !i.Policy.IsDisabled) == 1)
|
|
{
|
|
throw new ArgumentException("There must be at least one enabled user in the system.");
|
|
}
|
|
|
|
var currentToken = _authContext.GetAuthorizationInfo(Request).Token;
|
|
_sessionMananger.RevokeUserTokens(user.Id, currentToken);
|
|
}
|
|
|
|
_userManager.UpdateUserPolicy(request.Id, request);
|
|
}
|
|
}
|
|
}
|