Merge pull request #678 from immense/feature/server-side-recording

Server-side remote control session recording.
immense · Jul 18, 2023 · 567c6af · 567c6af
2 parents e897ab5 + 4a7bf7c
commit 567c6af
Show file tree

Hide file tree

Showing 15 changed files with 238 additions and 85 deletions.
diff --git a/Server/API/LoginController.cs b/Server/API/LoginController.cs
@@ -23,7 +23,7 @@ public class LoginController : ControllerBase
         private readonly IApplicationConfig _appConfig;
         private readonly IDataService _dataService;
         private readonly IHubContext<DesktopHub> _desktopHub;
-        private readonly IDesktopHubSessionCache _desktopSessionCache;
+        private readonly IRemoteControlSessionCache _remoteControlSessionCache;
         private readonly SignInManager<RemotelyUser> _signInManager;
         private readonly IHubContext<ViewerHub> _viewerHub;
         private readonly ILogger<LoginController> _logger;
@@ -33,15 +33,15 @@ public LoginController(
             IDataService dataService,
             IApplicationConfig appConfig,
             IHubContext<DesktopHub> casterHubContext,
-            IDesktopHubSessionCache desktopSessionCache,
+            IRemoteControlSessionCache remoteControlSessionCache,
             IHubContext<ViewerHub> viewerHubContext,
             ILogger<LoginController> logger)
         {
             _signInManager = signInManager;
             _dataService = dataService;
             _appConfig = appConfig;
             _desktopHub = casterHubContext;
-            _desktopSessionCache = desktopSessionCache;
+            _remoteControlSessionCache = remoteControlSessionCache;
             _viewerHub = viewerHubContext;
             _logger = logger;
         }
@@ -54,7 +54,7 @@ public async Task<IActionResult> Logout()
             if (HttpContext?.User?.Identity?.IsAuthenticated == true)
             {
                 orgId = _dataService.GetUserByNameWithOrg(HttpContext.User.Identity.Name)?.OrganizationID;
-                var activeSessions = _desktopSessionCache
+                var activeSessions = _remoteControlSessionCache
                     .Sessions
                     .Where(x => x.RequesterUserName == HttpContext.User.Identity.Name);
 

diff --git a/Server/API/RemoteControlController.cs b/Server/API/RemoteControlController.cs
@@ -27,7 +27,7 @@ namespace Remotely.Server.API
     public class RemoteControlController : ControllerBase
     {
         private readonly IHubContext<AgentHub> _serviceHub;
-        private readonly IDesktopHubSessionCache _desktopSessionCache;
+        private readonly IRemoteControlSessionCache _remoteControlSessionCache;
         private readonly IAgentHubSessionCache _serviceSessionCache;
         private readonly IApplicationConfig _appConfig;
         private readonly IOtpProvider _otpProvider;
@@ -39,7 +39,7 @@ public class RemoteControlController : ControllerBase
         public RemoteControlController(
             SignInManager<RemotelyUser> signInManager,
             IDataService dataService,
-            IDesktopHubSessionCache desktopSessionCache,
+            IRemoteControlSessionCache remoteControlSessionCache,
             IHubContext<AgentHub> serviceHub,
             IAgentHubSessionCache serviceSessionCache,
             IOtpProvider otpProvider,
@@ -49,7 +49,7 @@ public RemoteControlController(
         {
             _dataService = dataService;
             _serviceHub = serviceHub;
-            _desktopSessionCache = desktopSessionCache;
+            _remoteControlSessionCache = remoteControlSessionCache;
             _serviceSessionCache = serviceSessionCache;
             _appConfig = appConfig;
             _otpProvider = otpProvider;
@@ -117,7 +117,7 @@ private async Task<IActionResult> InitiateRemoteControl(string deviceID, string
             }
 
 
-            var sessionCount = _desktopSessionCache.Sessions
+            var sessionCount = _remoteControlSessionCache.Sessions
                    .OfType<RemoteControlSessionEx>()
                    .Count(x => x.OrganizationId == orgID);
 
@@ -138,7 +138,7 @@ private async Task<IActionResult> InitiateRemoteControl(string deviceID, string
                 OrganizationId = orgID
             };
 
-            _desktopSessionCache.AddOrUpdate($"{sessionId}", session, (k, v) =>
+            _remoteControlSessionCache.AddOrUpdate($"{sessionId}", session, (k, v) =>
             {
                 if (v is RemoteControlSessionEx ex)
                 {

diff --git a/Server/Areas/Identity/Pages/Account/Logout.cshtml b/Server/Areas/Identity/Pages/Account/Logout.cshtml
@@ -9,14 +9,14 @@
 @inject SignInManager<RemotelyUser> SignInManager
 @inject IHubContext<DesktopHub> DesktopHubContext
 @inject IHubContext<ViewerHub> ViewerHubContext
-@inject IDesktopHubSessionCache DesktopSessionCache
+@inject IRemoteControlSessionCache RemoteControlSessionCache
 
 @functions {
     public async Task<IActionResult> OnPost()
     {
         if (SignInManager.IsSignedIn(User))
         {
-            var activeSessions = DesktopSessionCache.Sessions.Where(x => x.RequesterUserName == HttpContext.User.Identity.Name);
+            var activeSessions = RemoteControlSessionCache.Sessions.Where(x => x.RequesterUserName == HttpContext.User.Identity.Name);
             foreach (var session in activeSessions)
             {
                 await DesktopHubContext.Clients.Client(session.DesktopConnectionId).SendAsync("Disconnect", "User logged out.");

diff --git a/Server/Hubs/CircuitConnection.cs b/Server/Hubs/CircuitConnection.cs
@@ -79,7 +79,7 @@ public class CircuitConnection : CircuitHandler, ICircuitConnection
         private readonly IAuthService _authService;
         private readonly ICircuitManager _circuitManager;
         private readonly IDataService _dataService;
-        private readonly IDesktopHubSessionCache _desktopSessionCache;
+        private readonly IRemoteControlSessionCache _remoteControlSessionCache;
         private readonly ConcurrentQueue<CircuitEvent> _eventQueue = new();
         private readonly IExpiringTokenService _expiringTokenService;
         private readonly ILogger<CircuitConnection> _logger;
@@ -94,7 +94,7 @@ public CircuitConnection(
             ICircuitManager circuitManager,
             IToastService toastService,
             IExpiringTokenService expiringTokenService,
-            IDesktopHubSessionCache desktopSessionCache,
+            IRemoteControlSessionCache remoteControlSessionCache,
             IAgentHubSessionCache agentSessionCache,
             ILogger<CircuitConnection> logger)
         {
@@ -106,7 +106,7 @@ public CircuitConnection(
             _circuitManager = circuitManager;
             _toastService = toastService;
             _expiringTokenService = expiringTokenService;
-            _desktopSessionCache = desktopSessionCache;
+            _remoteControlSessionCache = remoteControlSessionCache;
             _agentSessionCache = agentSessionCache;
             _logger = logger;
         }
@@ -244,7 +244,7 @@ public async Task<Result<RemoteControlSessionEx>> RemoteControl(string deviceId,
 
             }
 
-            var sessionCount = _desktopSessionCache.Sessions
+            var sessionCount = _remoteControlSessionCache.Sessions
                    .OfType<RemoteControlSessionEx>()
                    .Count(x => x.OrganizationId == User.OrganizationID);
 
@@ -281,7 +281,7 @@ public async Task<Result<RemoteControlSessionEx>> RemoteControl(string deviceId,
                 NotifyUserOnStart = _appConfig.RemoteControlNotifyUser
             };
 
-            _desktopSessionCache.AddOrUpdate($"{sessionId}", session);
+            _remoteControlSessionCache.AddOrUpdate($"{sessionId}", session);
 
             var organization = _dataService.GetOrganizationNameByUserName(User.UserName);
             await _agentHubContext.Clients.Client(serviceConnectionId).SendAsync("RemoteControl",

diff --git a/Server/Pages/ServerConfig.razor b/Server/Pages/ServerConfig.razor
@@ -134,6 +134,13 @@
                 <br />
                 <ValidationMessage For="() => Input.DBProvider" />
             </div>
+            <div class="form-group">
+                <label>Enable Remote Control Recording</label>
+                <br />
+                <InputCheckbox @bind-Value="Input.EnableRemoteControlRecording" autocomplete="off" />
+                <br />
+                <ValidationMessage For="() => Input.EnableRemoteControlRecording" />
+            </div>
             <div class="form-group">
                 <label>Enable Windows Event Log</label>
                 <br />

diff --git a/Server/Pages/ServerConfig.razor.cs b/Server/Pages/ServerConfig.razor.cs
@@ -37,6 +37,8 @@ public class AppSettingsModel
         [JsonConverter(typeof(JsonStringEnumConverter))]
         public DbProvider DBProvider { get; set; }
 
+        [Display(Name = "Enable Remote Control Recording")]
+        public bool EnableRemoteControlRecording { get; set; }
 
         [Display(Name = "Enable Windows Event Log")]
         public bool EnableWindowsEventLog { get; set; }

diff --git a/Server/Program.cs b/Server/Program.cs
@@ -226,6 +226,8 @@
     config.AddHubEventHandler<HubEventHandler>();
     config.AddViewerAuthorizer<ViewerAuthorizer>();
     config.AddViewerPageDataProvider<ViewerPageDataProvider>();
+    config.AddViewerOptionsProvider<ViewerOptionsProvider>();
+    config.AddSessionRecordingSink<SessionRecordingSink>();
 });
 
 services.AddSingleton<IAgentHubSessionCache, AgentHubSessionCache>();
@@ -292,7 +294,7 @@
     }
 
     await dataService.SetAllDevicesNotOnline();
-    dataService.CleanupOldRecords();
+    await dataService.CleanupOldRecords();
 }
 
 await app.RunAsync();

diff --git a/Server/Services/ApplicationConfig.cs b/Server/Services/ApplicationConfig.cs
@@ -11,6 +11,7 @@ public interface IApplicationConfig
         string[] BannedDevices { get; }
         double DataRetentionInDays { get; }
         string DBProvider { get; }
+        bool EnableRemoteControlRecording { get; }
         bool EnableWindowsEventLog { get; }
         bool EnforceAttendedAccess { get; }
         bool ForceClientHttps { get; }
@@ -40,40 +41,42 @@ public interface IApplicationConfig
 
     public class ApplicationConfig : IApplicationConfig
     {
+        private readonly IConfiguration _config;
+
         public ApplicationConfig(IConfiguration config)
         {
-            Config = config;
+            _config = config;
         }
 
-        public bool AllowApiLogin => bool.Parse(Config["ApplicationOptions:AllowApiLogin"] ?? "false");
-        public string[] BannedDevices => Config.GetSection("ApplicationOptions:BannedDevices").Get<string[]>() ?? System.Array.Empty<string>();
-        public double DataRetentionInDays => double.Parse(Config["ApplicationOptions:DataRetentionInDays"] ?? "30");
-        public string DBProvider => Config["ApplicationOptions:DBProvider"] ?? "SQLite";
-        public bool EnableWindowsEventLog => bool.Parse(Config["ApplicationOptions:EnableWindowsEventLog"]);
-        public bool EnforceAttendedAccess => bool.Parse(Config["ApplicationOptions:EnforceAttendedAccess"] ?? "false");
-        public bool ForceClientHttps => bool.Parse(Config["ApplicationOptions:ForceClientHttps"] ?? "false");
-        public string[] KnownProxies => Config.GetSection("ApplicationOptions:KnownProxies").Get<string[]>() ?? System.Array.Empty<string>();
-        public int MaxConcurrentUpdates => int.Parse(Config["ApplicationOptions:MaxConcurrentUpdates"] ?? "10");
-        public int MaxOrganizationCount => int.Parse(Config["ApplicationOptions:MaxOrganizationCount"] ?? "1");
-        public string MessageOfTheDay => Config["ApplicationOptions:MessageOfTheDay"];
-        public bool RedirectToHttps => bool.Parse(Config["ApplicationOptions:RedirectToHttps"] ?? "true");
-        public bool RemoteControlNotifyUser => bool.Parse(Config["ApplicationOptions:RemoteControlNotifyUser"] ?? "true");
-        public bool RemoteControlRequiresAuthentication => bool.Parse(Config["ApplicationOptions:RemoteControlRequiresAuthentication"] ?? "true");
-        public int RemoteControlSessionLimit => int.Parse(Config["ApplicationOptions:RemoteControlSessionLimit"] ?? "3");
-        public bool Require2FA => bool.Parse(Config["ApplicationOptions:Require2FA"] ?? "false");
-        public string ServerUrl => Config["ApplicationOptions:ServerUrl"];
-        public bool SmtpCheckCertificateRevocation => bool.Parse(Config["ApplicationOptions:SmtpCheckCertificateRevocation"] ?? "true");
-        public string SmtpDisplayName => Config["ApplicationOptions:SmtpDisplayName"];
-        public string SmtpEmail => Config["ApplicationOptions:SmtpEmail"];
-        public string SmtpHost => Config["ApplicationOptions:SmtpHost"];
-        public string SmtpLocalDomain => Config["ApplicationOptions:SmtpLocalDomain"];
-        public string SmtpPassword => Config["ApplicationOptions:SmtpPassword"];
-        public int SmtpPort => int.Parse(Config["ApplicationOptions:SmtpPort"] ?? "25");
-        public string SmtpUserName => Config["ApplicationOptions:SmtpUserName"];
-        public Theme Theme => Enum.Parse<Theme>(Config["ApplicationOptions:Theme"] ?? "Dark", true);
-        public string[] TrustedCorsOrigins => Config.GetSection("ApplicationOptions:TrustedCorsOrigins").Get<string[]>() ?? System.Array.Empty<string>();
-        public bool UseHsts => bool.Parse(Config["ApplicationOptions:UseHsts"] ?? "false");
-        public bool UseHttpLogging => bool.Parse(Config["ApplicationOptions:UseHttpLogging"] ?? "false");
-        private IConfiguration Config { get; set; }
+        public bool AllowApiLogin => bool.TryParse(_config["ApplicationOptions:AllowApiLogin"], out var result) && result;
+        public string[] BannedDevices => _config.GetSection("ApplicationOptions:BannedDevices").Get<string[]>() ?? System.Array.Empty<string>();
+        public double DataRetentionInDays => double.TryParse(_config["ApplicationOptions:DataRetentionInDays"], out var result) ? result : 30;
+        public string DBProvider => _config["ApplicationOptions:DBProvider"] ?? "SQLite";
+        public bool EnableRemoteControlRecording => bool.TryParse(_config["ApplicationOptions:EnableRemoteControlRecording"], out var result) && result;
+        public bool EnableWindowsEventLog => bool.TryParse(_config["ApplicationOptions:EnableWindowsEventLog"], out var result) && result;
+        public bool EnforceAttendedAccess => bool.TryParse(_config["ApplicationOptions:EnforceAttendedAccess"], out var result) && result;
+        public bool ForceClientHttps => bool.TryParse(_config["ApplicationOptions:ForceClientHttps"], out var result) && result;
+        public string[] KnownProxies => _config.GetSection("ApplicationOptions:KnownProxies").Get<string[]>() ?? System.Array.Empty<string>();
+        public int MaxConcurrentUpdates => int.TryParse(_config["ApplicationOptions:MaxConcurrentUpdates"], out var result) ? result : 10;
+        public int MaxOrganizationCount => int.TryParse(_config["ApplicationOptions:MaxOrganizationCount"], out var result) ? result : 1;
+        public string MessageOfTheDay => _config["ApplicationOptions:MessageOfTheDay"];
+        public bool RedirectToHttps => bool.TryParse(_config["ApplicationOptions:RedirectToHttps"], out var result) && result;
+        public bool RemoteControlNotifyUser => bool.TryParse(_config["ApplicationOptions:RemoteControlNotifyUser"], out var result) && result;
+        public bool RemoteControlRequiresAuthentication => bool.TryParse(_config["ApplicationOptions:RemoteControlRequiresAuthentication"], out var result) && result;
+        public int RemoteControlSessionLimit => int.TryParse(_config["ApplicationOptions:RemoteControlSessionLimit"], out var result) ? result : 3;
+        public bool Require2FA => bool.TryParse(_config["ApplicationOptions:Require2FA"], out var result) && result;
+        public string ServerUrl => _config["ApplicationOptions:ServerUrl"];
+        public bool SmtpCheckCertificateRevocation => !bool.TryParse(_config["ApplicationOptions:SmtpCheckCertificateRevocation"], out var result) || result;
+        public string SmtpDisplayName => _config["ApplicationOptions:SmtpDisplayName"];
+        public string SmtpEmail => _config["ApplicationOptions:SmtpEmail"];
+        public string SmtpHost => _config["ApplicationOptions:SmtpHost"];
+        public string SmtpLocalDomain => _config["ApplicationOptions:SmtpLocalDomain"];
+        public string SmtpPassword => _config["ApplicationOptions:SmtpPassword"];
+        public int SmtpPort => int.TryParse(_config["ApplicationOptions:SmtpPort"], out var result) ? result : 25;
+        public string SmtpUserName => _config["ApplicationOptions:SmtpUserName"];
+        public Theme Theme => Enum.TryParse<Theme>(_config["ApplicationOptions:Theme"], out var result) ? result : Theme.Dark;
+        public string[] TrustedCorsOrigins => _config.GetSection("ApplicationOptions:TrustedCorsOrigins").Get<string[]>() ?? System.Array.Empty<string>();
+        public bool UseHsts => bool.TryParse(_config["ApplicationOptions:UseHsts"], out var result) && result;
+        public bool UseHttpLogging => bool.TryParse(_config["ApplicationOptions:UseHttpLogging"], out var result) && result;
     }
 }