jellyfin-server/Emby.Server.Implementations/QuickConnect/QuickConnectManager.cs

297 lines
10 KiB
C#
Raw Normal View History

2020-04-15 19:28:42 +00:00
using System;
2020-06-09 20:18:26 +00:00
using System.Collections.Concurrent;
2020-04-15 19:28:42 +00:00
using System.Collections.Generic;
using System.Globalization;
using System.Linq;
using System.Security.Cryptography;
using MediaBrowser.Controller;
using MediaBrowser.Controller.Configuration;
2020-04-15 19:28:42 +00:00
using MediaBrowser.Controller.Net;
using MediaBrowser.Controller.QuickConnect;
using MediaBrowser.Controller.Security;
using MediaBrowser.Model.QuickConnect;
using MediaBrowser.Model.Services;
using MediaBrowser.Common;
2020-04-15 19:28:42 +00:00
using Microsoft.Extensions.Logging;
using MediaBrowser.Common.Extensions;
2020-04-15 19:28:42 +00:00
namespace Emby.Server.Implementations.QuickConnect
{
/// <summary>
/// Quick connect implementation.
/// </summary>
2020-06-09 23:40:35 +00:00
public class QuickConnectManager : IQuickConnect, IDisposable
2020-04-15 19:28:42 +00:00
{
private readonly RNGCryptoServiceProvider _rng = new RNGCryptoServiceProvider();
2020-06-09 20:18:26 +00:00
private readonly ConcurrentDictionary<string, QuickConnectResult> _currentRequests = new ConcurrentDictionary<string, QuickConnectResult>();
2020-04-15 19:28:42 +00:00
private readonly IServerConfigurationManager _config;
private readonly ILogger<QuickConnectManager> _logger;
private readonly IAuthenticationRepository _authenticationRepository;
private readonly IAuthorizationContext _authContext;
private readonly IServerApplicationHost _appHost;
2020-04-15 19:28:42 +00:00
/// <summary>
/// Initializes a new instance of the <see cref="QuickConnectManager"/> class.
/// Should only be called at server startup when a singleton is created.
/// </summary>
/// <param name="config">Configuration.</param>
2020-04-24 23:51:19 +00:00
/// <param name="logger">Logger.</param>
2020-04-15 19:28:42 +00:00
/// <param name="appHost">Application host.</param>
/// <param name="authContext">Authentication context.</param>
/// <param name="authenticationRepository">Authentication repository.</param>
public QuickConnectManager(
IServerConfigurationManager config,
2020-04-24 23:51:19 +00:00
ILogger<QuickConnectManager> logger,
2020-04-15 19:28:42 +00:00
IServerApplicationHost appHost,
IAuthorizationContext authContext,
2020-06-09 20:18:26 +00:00
IAuthenticationRepository authenticationRepository)
2020-04-15 19:28:42 +00:00
{
_config = config;
2020-04-24 23:51:19 +00:00
_logger = logger;
2020-04-15 19:28:42 +00:00
_appHost = appHost;
_authContext = authContext;
_authenticationRepository = authenticationRepository;
ReloadConfiguration();
}
2020-04-15 19:28:42 +00:00
/// <inheritdoc/>
public int CodeLength { get; set; } = 6;
/// <inheritdoc/>
public string TokenNamePrefix { get; set; } = "QuickConnect-";
/// <inheritdoc/>
public QuickConnectState State { get; private set; } = QuickConnectState.Unavailable;
/// <inheritdoc/>
public int Timeout { get; set; } = 5;
private DateTime DateActivated { get; set; }
2020-04-15 19:28:42 +00:00
/// <inheritdoc/>
public void AssertActive()
{
if (State != QuickConnectState.Active)
{
2020-06-18 06:58:58 +00:00
throw new ArgumentException("Quick connect is not active on this server");
2020-04-15 19:28:42 +00:00
}
}
/// <inheritdoc/>
2020-06-18 06:58:58 +00:00
public void Activate()
{
DateActivated = DateTime.Now;
2020-06-18 06:58:58 +00:00
SetEnabled(QuickConnectState.Active);
}
2020-04-15 19:28:42 +00:00
/// <inheritdoc/>
public void SetEnabled(QuickConnectState newState)
{
_logger.LogDebug("Changed quick connect state from {0} to {1}", State, newState);
2020-06-09 20:18:26 +00:00
ExpireRequests(true);
State = newState;
_config.Configuration.QuickConnectAvailable = newState == QuickConnectState.Available || newState == QuickConnectState.Active;
_config.SaveConfiguration();
_logger.LogDebug("Configuration saved");
2020-04-15 19:28:42 +00:00
}
/// <inheritdoc/>
public QuickConnectResult TryConnect(string friendlyName)
{
2020-04-24 04:44:15 +00:00
ExpireRequests();
2020-04-15 19:28:42 +00:00
if (State != QuickConnectState.Active)
{
_logger.LogDebug("Refusing quick connect initiation request, current state is {0}", State);
return new QuickConnectResult()
{
Error = "Quick connect is not active on this server"
};
}
_logger.LogDebug("Got new quick connect request from {friendlyName}", friendlyName);
var code = GenerateCode();
2020-04-15 19:28:42 +00:00
var result = new QuickConnectResult()
{
Secret = GenerateSecureRandom(),
FriendlyName = friendlyName,
DateAdded = DateTime.Now,
Code = code
2020-04-15 19:28:42 +00:00
};
_currentRequests[code] = result;
2020-04-15 19:28:42 +00:00
return result;
}
/// <inheritdoc/>
public QuickConnectResult CheckRequestStatus(string secret)
{
ExpireRequests();
AssertActive();
2020-04-15 19:28:42 +00:00
string code = _currentRequests.Where(x => x.Value.Secret == secret).Select(x => x.Value.Code).DefaultIfEmpty(string.Empty).First();
2020-04-15 19:28:42 +00:00
if (!_currentRequests.TryGetValue(code, out QuickConnectResult result))
2020-04-15 19:28:42 +00:00
{
throw new ResourceNotFoundException("Unable to find request with provided secret");
2020-04-15 19:28:42 +00:00
}
2020-06-09 20:18:26 +00:00
return result;
2020-04-15 19:28:42 +00:00
}
/// <inheritdoc/>
public string GenerateCode()
{
int min = (int)Math.Pow(10, CodeLength - 1);
int max = (int)Math.Pow(10, CodeLength);
uint scale = uint.MaxValue;
while (scale == uint.MaxValue)
{
byte[] raw = new byte[4];
_rng.GetBytes(raw);
scale = BitConverter.ToUInt32(raw, 0);
}
int code = (int)(min + ((max - min) * (scale / (double)uint.MaxValue)));
2020-04-15 19:28:42 +00:00
return code.ToString(CultureInfo.InvariantCulture);
}
/// <inheritdoc/>
public bool AuthorizeRequest(IRequest request, string code)
2020-04-15 19:28:42 +00:00
{
ExpireRequests();
2020-04-15 19:28:42 +00:00
AssertActive();
var auth = _authContext.GetAuthorizationInfo(request);
if (!_currentRequests.TryGetValue(code, out QuickConnectResult result))
2020-04-15 19:28:42 +00:00
{
throw new ResourceNotFoundException("Unable to find request");
2020-04-15 19:28:42 +00:00
}
if (result.Authenticated)
{
throw new InvalidOperationException("Request is already authorized");
}
result.Authentication = Guid.NewGuid().ToString("N", CultureInfo.InvariantCulture);
// Change the time on the request so it expires one minute into the future. It can't expire immediately as otherwise some clients wouldn't ever see that they have been authenticated.
var added = result.DateAdded ?? DateTime.Now.Subtract(new TimeSpan(0, Timeout, 0));
result.DateAdded = added.Subtract(new TimeSpan(0, Timeout - 1, 0));
2020-04-15 19:28:42 +00:00
_authenticationRepository.Create(new AuthenticationInfo
{
AppName = TokenNamePrefix + result.FriendlyName,
AccessToken = result.Authentication,
DateCreated = DateTime.UtcNow,
DeviceId = _appHost.SystemId,
DeviceName = _appHost.FriendlyName,
AppVersion = _appHost.ApplicationVersionString,
UserId = auth.UserId
});
2020-06-18 06:58:58 +00:00
_logger.LogInformation("Allowing device {0} to login as user {1} with quick connect code {2}", result.FriendlyName, auth.User.Username, result.Code);
2020-04-15 19:28:42 +00:00
return true;
}
/// <inheritdoc/>
public int DeleteAllDevices(Guid user)
{
var raw = _authenticationRepository.Get(new AuthenticationInfoQuery()
{
DeviceId = _appHost.SystemId,
UserId = user
});
var tokens = raw.Items.Where(x => x.AppName.StartsWith(TokenNamePrefix, StringComparison.CurrentCulture));
foreach (var token in tokens)
{
_authenticationRepository.Delete(token);
_logger.LogDebug("Deleted token {0}", token.AccessToken);
}
return tokens.Count();
}
2020-06-09 20:18:26 +00:00
/// <summary>
/// Dispose.
/// </summary>
public void Dispose()
{
Dispose(true);
GC.SuppressFinalize(this);
}
2020-04-15 19:28:42 +00:00
/// <summary>
/// Dispose.
/// </summary>
/// <param name="disposing">Dispose unmanaged resources.</param>
protected virtual void Dispose(bool disposing)
{
if (disposing)
{
_rng?.Dispose();
}
}
2020-06-09 20:18:26 +00:00
2020-04-15 19:28:42 +00:00
private string GenerateSecureRandom(int length = 32)
{
var bytes = new byte[length];
_rng.GetBytes(bytes);
return Hex.Encode(bytes);
2020-04-15 19:28:42 +00:00
}
2020-06-18 06:58:58 +00:00
/// <inheritdoc/>
public void ExpireRequests(bool expireAll = false)
2020-04-15 19:28:42 +00:00
{
2020-06-08 20:48:18 +00:00
// Check if quick connect should be deactivated
if (State == QuickConnectState.Active && DateTime.Now > DateActivated.AddMinutes(Timeout) && !expireAll)
{
_logger.LogDebug("Quick connect time expired, deactivating");
SetEnabled(QuickConnectState.Available);
2020-04-24 04:44:15 +00:00
expireAll = true;
}
2020-06-08 20:48:18 +00:00
// Expire stale connection requests
2020-04-15 19:28:42 +00:00
var delete = new List<string>();
var values = _currentRequests.Values.ToList();
2020-06-09 20:18:26 +00:00
for (int i = 0; i < values.Count; i++)
2020-04-15 19:28:42 +00:00
{
2020-06-08 20:48:18 +00:00
var added = values[i].DateAdded ?? DateTime.UnixEpoch;
if (DateTime.Now > added.AddMinutes(Timeout) || expireAll)
2020-04-15 19:28:42 +00:00
{
delete.Add(values[i].Code);
2020-04-15 19:28:42 +00:00
}
}
foreach (var code in delete)
2020-04-15 19:28:42 +00:00
{
_logger.LogDebug("Removing expired request {code}", code);
2020-06-09 20:18:26 +00:00
if (!_currentRequests.TryRemove(code, out _))
2020-06-09 20:18:26 +00:00
{
_logger.LogWarning("Request {code} already expired", code);
2020-06-09 20:18:26 +00:00
}
2020-04-15 19:28:42 +00:00
}
}
2020-06-09 20:18:26 +00:00
private void ReloadConfiguration()
{
2020-06-18 06:58:58 +00:00
State = _config.Configuration.QuickConnectAvailable ? QuickConnectState.Available : QuickConnectState.Unavailable;
2020-06-09 20:18:26 +00:00
}
2020-04-15 19:28:42 +00:00
}
}