diff --git a/Emby.Server.Implementations/QuickConnect/ConfigurationExtension.cs b/Emby.Server.Implementations/QuickConnect/ConfigurationExtension.cs
deleted file mode 100644
index 2a19fc36c..000000000
--- a/Emby.Server.Implementations/QuickConnect/ConfigurationExtension.cs
+++ /dev/null
@@ -1,20 +0,0 @@
-using MediaBrowser.Common.Configuration;
-
-namespace Emby.Server.Implementations.QuickConnect
-{
- ///
- /// Configuration extension to support persistent quick connect configuration.
- ///
- public static class ConfigurationExtension
- {
- ///
- /// Return the current quick connect configuration.
- ///
- /// Configuration manager.
- /// Current quick connect configuration.
- public static QuickConnectConfiguration GetQuickConnectConfiguration(this IConfigurationManager manager)
- {
- return manager.GetConfiguration("quickconnect");
- }
- }
-}
diff --git a/Emby.Server.Implementations/QuickConnect/QuickConnectConfiguration.cs b/Emby.Server.Implementations/QuickConnect/QuickConnectConfiguration.cs
deleted file mode 100644
index 2302ddbc3..000000000
--- a/Emby.Server.Implementations/QuickConnect/QuickConnectConfiguration.cs
+++ /dev/null
@@ -1,15 +0,0 @@
-using MediaBrowser.Model.QuickConnect;
-
-namespace Emby.Server.Implementations.QuickConnect
-{
- ///
- /// Persistent quick connect configuration.
- ///
- public class QuickConnectConfiguration
- {
- ///
- /// Gets or sets persistent quick connect availability state.
- ///
- public QuickConnectState State { get; set; }
- }
-}
diff --git a/Emby.Server.Implementations/QuickConnect/QuickConnectConfigurationFactory.cs b/Emby.Server.Implementations/QuickConnect/QuickConnectConfigurationFactory.cs
deleted file mode 100644
index d7bc84c5e..000000000
--- a/Emby.Server.Implementations/QuickConnect/QuickConnectConfigurationFactory.cs
+++ /dev/null
@@ -1,27 +0,0 @@
-using System.Collections.Generic;
-using MediaBrowser.Common.Configuration;
-
-namespace Emby.Server.Implementations.QuickConnect
-{
- ///
- /// Configuration factory for quick connect.
- ///
- public class QuickConnectConfigurationFactory : IConfigurationFactory
- {
- ///
- /// Returns the current quick connect configuration.
- ///
- /// Current quick connect configuration.
- public IEnumerable GetConfigurations()
- {
- return new[]
- {
- new ConfigurationStore
- {
- Key = "quickconnect",
- ConfigurationType = typeof(QuickConnectConfiguration)
- }
- };
- }
- }
-}
diff --git a/Emby.Server.Implementations/QuickConnect/QuickConnectManager.cs b/Emby.Server.Implementations/QuickConnect/QuickConnectManager.cs
index 7a584c7cd..8d704f32b 100644
--- a/Emby.Server.Implementations/QuickConnect/QuickConnectManager.cs
+++ b/Emby.Server.Implementations/QuickConnect/QuickConnectManager.cs
@@ -11,7 +11,9 @@ using MediaBrowser.Controller.QuickConnect;
using MediaBrowser.Controller.Security;
using MediaBrowser.Model.QuickConnect;
using MediaBrowser.Model.Services;
+using MediaBrowser.Common;
using Microsoft.Extensions.Logging;
+using MediaBrowser.Common.Extensions;
namespace Emby.Server.Implementations.QuickConnect
{
@@ -64,9 +66,7 @@ namespace Emby.Server.Implementations.QuickConnect
public QuickConnectState State { get; private set; } = QuickConnectState.Unavailable;
///
- public int RequestExpiry { get; set; } = 30;
-
- private bool TemporaryActivation { get; set; } = false;
+ public int Timeout { get; set; } = 5;
private DateTime DateActivated { get; set; }
@@ -82,10 +82,9 @@ namespace Emby.Server.Implementations.QuickConnect
///
public QuickConnectResult Activate()
{
- // This should not call SetEnabled since that would persist the "temporary" activation to the configuration file
- State = QuickConnectState.Active;
+ SetEnabled(QuickConnectState.Active);
+
DateActivated = DateTime.Now;
- TemporaryActivation = true;
return new QuickConnectResult();
}
@@ -96,12 +95,10 @@ namespace Emby.Server.Implementations.QuickConnect
_logger.LogDebug("Changed quick connect state from {0} to {1}", State, newState);
ExpireRequests(true);
- State = newState;
- _config.SaveConfiguration("quickconnect", new QuickConnectConfiguration()
- {
- State = State
- });
+ State = newState;
+ _config.Configuration.QuickConnectAvailable = newState == QuickConnectState.Available || newState == QuickConnectState.Active;
+ _config.SaveConfiguration();
_logger.LogDebug("Configuration saved");
}
@@ -123,17 +120,16 @@ namespace Emby.Server.Implementations.QuickConnect
_logger.LogDebug("Got new quick connect request from {friendlyName}", friendlyName);
- var lookup = GenerateSecureRandom();
+ var code = GenerateCode();
var result = new QuickConnectResult()
{
- Lookup = lookup,
Secret = GenerateSecureRandom(),
FriendlyName = friendlyName,
DateAdded = DateTime.Now,
- Code = GenerateCode()
+ Code = code
};
- _currentRequests[lookup] = result;
+ _currentRequests[code] = result;
return result;
}
@@ -143,17 +139,16 @@ namespace Emby.Server.Implementations.QuickConnect
ExpireRequests();
AssertActive();
- string lookup = _currentRequests.Where(x => x.Value.Secret == secret).Select(x => x.Value.Lookup).DefaultIfEmpty(string.Empty).First();
+ string code = _currentRequests.Where(x => x.Value.Secret == secret).Select(x => x.Value.Code).DefaultIfEmpty(string.Empty).First();
- if (!_currentRequests.TryGetValue(lookup, out QuickConnectResult result))
+ if (!_currentRequests.TryGetValue(code, out QuickConnectResult result))
{
- throw new KeyNotFoundException("Unable to find request with provided identifier");
+ throw new ResourceNotFoundException("Unable to find request with provided secret");
}
return result;
}
- ///
public List GetCurrentRequests()
{
return GetCurrentRequestsInternal().Select(x => (QuickConnectResultDto)x).ToList();
@@ -186,16 +181,16 @@ namespace Emby.Server.Implementations.QuickConnect
}
///
- public bool AuthorizeRequest(IRequest request, string lookup)
+ public bool AuthorizeRequest(IRequest request, string code)
{
ExpireRequests();
AssertActive();
var auth = _authContext.GetAuthorizationInfo(request);
- if (!_currentRequests.TryGetValue(lookup, out QuickConnectResult result))
+ if (!_currentRequests.TryGetValue(code, out QuickConnectResult result))
{
- throw new KeyNotFoundException("Unable to find request");
+ throw new ResourceNotFoundException("Unable to find request");
}
if (result.Authenticated)
@@ -205,9 +200,9 @@ namespace Emby.Server.Implementations.QuickConnect
result.Authentication = Guid.NewGuid().ToString("N", CultureInfo.InvariantCulture);
- // Advance the time on the request so it expires sooner as the client will pick up the changes in a few seconds
- var added = result.DateAdded ?? DateTime.Now.Subtract(new TimeSpan(0, RequestExpiry, 0));
- result.DateAdded = added.Subtract(new TimeSpan(0, RequestExpiry - 1, 0));
+ // 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));
_authenticationRepository.Create(new AuthenticationInfo
{
@@ -271,7 +266,7 @@ namespace Emby.Server.Implementations.QuickConnect
var bytes = new byte[length];
_rng.GetBytes(bytes);
- return string.Join(string.Empty, bytes.Select(x => x.ToString("x2", CultureInfo.InvariantCulture)));
+ return Hex.Encode(bytes);
}
///
@@ -281,12 +276,11 @@ namespace Emby.Server.Implementations.QuickConnect
private void ExpireRequests(bool expireAll = false)
{
// Check if quick connect should be deactivated
- if (TemporaryActivation && DateTime.Now > DateActivated.AddMinutes(10) && State == QuickConnectState.Active && !expireAll)
+ if (State == QuickConnectState.Active && DateTime.Now > DateActivated.AddMinutes(Timeout) && !expireAll)
{
_logger.LogDebug("Quick connect time expired, deactivating");
SetEnabled(QuickConnectState.Available);
expireAll = true;
- TemporaryActivation = false;
}
// Expire stale connection requests
@@ -296,28 +290,28 @@ namespace Emby.Server.Implementations.QuickConnect
for (int i = 0; i < values.Count; i++)
{
var added = values[i].DateAdded ?? DateTime.UnixEpoch;
- if (DateTime.Now > added.AddMinutes(RequestExpiry) || expireAll)
+ if (DateTime.Now > added.AddMinutes(Timeout) || expireAll)
{
- delete.Add(values[i].Lookup);
+ delete.Add(values[i].Code);
}
}
- foreach (var lookup in delete)
+ foreach (var code in delete)
{
- _logger.LogDebug("Removing expired request {lookup}", lookup);
+ _logger.LogDebug("Removing expired request {code}", code);
- if (!_currentRequests.TryRemove(lookup, out _))
+ if (!_currentRequests.TryRemove(code, out _))
{
- _logger.LogWarning("Request {lookup} already expired", lookup);
+ _logger.LogWarning("Request {code} already expired", code);
}
}
}
private void ReloadConfiguration()
{
- var config = _config.GetQuickConnectConfiguration();
+ var available = _config.Configuration.QuickConnectAvailable;
- State = config.State;
+ State = available ? QuickConnectState.Available : QuickConnectState.Unavailable;
}
}
}
diff --git a/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs b/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs
index d44765e11..d31d0e509 100644
--- a/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs
+++ b/MediaBrowser.Controller/QuickConnect/IQuickConnect.cs
@@ -26,9 +26,9 @@ namespace MediaBrowser.Controller.QuickConnect
public QuickConnectState State { get; }
///
- /// Gets or sets the time (in minutes) before a pending request will expire.
+ /// Gets or sets the time (in minutes) before quick connect will automatically deactivate.
///
- public int RequestExpiry { get; set; }
+ public int Timeout { get; set; }
///
/// Assert that quick connect is currently active and throws an exception if it is not.
@@ -77,9 +77,9 @@ namespace MediaBrowser.Controller.QuickConnect
/// Authorizes a quick connect request to connect as the calling user.
///
/// HTTP request object.
- /// Public request lookup value.
+ /// Identifying code for the request..
/// A boolean indicating if the authorization completed successfully.
- bool AuthorizeRequest(IRequest request, string lookup);
+ bool AuthorizeRequest(IRequest request, string code);
///
/// Deletes all quick connect access tokens for the provided user.
diff --git a/MediaBrowser.Model/Configuration/ServerConfiguration.cs b/MediaBrowser.Model/Configuration/ServerConfiguration.cs
index afbe02dd3..76b290606 100644
--- a/MediaBrowser.Model/Configuration/ServerConfiguration.cs
+++ b/MediaBrowser.Model/Configuration/ServerConfiguration.cs
@@ -76,6 +76,11 @@ namespace MediaBrowser.Model.Configuration
/// true if this instance is port authorized; otherwise, false.
public bool IsPortAuthorized { get; set; }
+ ///
+ /// Gets or sets if quick connect is available for use on this server.
+ ///
+ public bool QuickConnectAvailable { get; set; }
+
public bool AutoRunWebApp { get; set; }
public bool EnableRemoteAccess { get; set; }
@@ -281,6 +286,7 @@ namespace MediaBrowser.Model.Configuration
AutoRunWebApp = true;
EnableRemoteAccess = true;
+ QuickConnectAvailable = false;
EnableUPnP = false;
MinResumePct = 5;
diff --git a/MediaBrowser.Model/QuickConnect/QuickConnectResult.cs b/MediaBrowser.Model/QuickConnect/QuickConnectResult.cs
index 32d7f6aba..a10d60d57 100644
--- a/MediaBrowser.Model/QuickConnect/QuickConnectResult.cs
+++ b/MediaBrowser.Model/QuickConnect/QuickConnectResult.cs
@@ -17,11 +17,6 @@ namespace MediaBrowser.Model.QuickConnect
///
public string? Secret { get; set; }
- ///
- /// Gets or sets the public value used to uniquely identify this request. Can only be used to authorize the request.
- ///
- public string? Lookup { get; set; }
-
///
/// Gets or sets the user facing code used so the user can quickly differentiate this request from others.
///
diff --git a/MediaBrowser.Model/QuickConnect/QuickConnectResultDto.cs b/MediaBrowser.Model/QuickConnect/QuickConnectResultDto.cs
index 19acc7cd8..26084caf1 100644
--- a/MediaBrowser.Model/QuickConnect/QuickConnectResultDto.cs
+++ b/MediaBrowser.Model/QuickConnect/QuickConnectResultDto.cs
@@ -17,25 +17,15 @@ namespace MediaBrowser.Model.QuickConnect
///
public string? Code { get; private set; }
- ///
- /// Gets the public value used to uniquely identify this request. Can only be used to authorize the request.
- ///
- public string? Lookup { get; private set; }
-
///
/// Gets the device friendly name.
///
public string? FriendlyName { get; private set; }
- ///
- /// Gets the DateTime that this request was created.
- ///
- public DateTime? DateAdded { get; private set; }
-
///
/// Cast an internal quick connect result to a DTO by removing all sensitive properties.
///
- /// QuickConnectResult object to cast
+ /// QuickConnectResult object to cast.
public static implicit operator QuickConnectResultDto(QuickConnectResult result)
{
QuickConnectResultDto resultDto = new QuickConnectResultDto
@@ -43,8 +33,6 @@ namespace MediaBrowser.Model.QuickConnect
Authenticated = result.Authenticated,
Code = result.Code,
FriendlyName = result.FriendlyName,
- DateAdded = result.DateAdded,
- Lookup = result.Lookup
};
return resultDto;