SEBWIN-972: Fixed issue with base address of HttpClient and paths of …

…APIs for bundled setup of server and service.
SafeExamBrowser · Nov 12, 2024 · 7d10de0 · 7d10de0
1 parent 657cb7e
commit 7d10de0
Show file tree

Hide file tree

Showing 28 changed files with 170 additions and 78 deletions.
diff --git a/SafeExamBrowser.Proctoring/SafeExamBrowser.Proctoring.csproj b/SafeExamBrowser.Proctoring/SafeExamBrowser.Proctoring.csproj
@@ -107,6 +107,7 @@
     <Compile Include="ScreenProctoring\Service\Requests\OAuth2TokenRequest.cs" />
     <Compile Include="ScreenProctoring\Service\Requests\Request.cs" />
     <Compile Include="ScreenProctoring\Service\Requests\ScreenShotRequest.cs" />
+    <Compile Include="ScreenProctoring\Service\Sanitizer.cs" />
     <Compile Include="ScreenProctoring\Service\ServiceProxy.cs" />
     <Compile Include="ScreenProctoring\Service\ServiceResponse.cs" />
     <Compile Include="ScreenProctoring\TransmissionSpooler.cs" />

diff --git a/SafeExamBrowser.Proctoring/ScreenProctoring/Service/Api.cs b/SafeExamBrowser.Proctoring/ScreenProctoring/Service/Api.cs
@@ -19,10 +19,10 @@ internal class Api
 
 		internal Api()
 		{
-			AccessTokenEndpoint = "/oauth/token";
-			HealthEndpoint = "/health";
-			ScreenShotEndpoint = $"/seb-api/v1/session/{SESSION_ID}/screenshot";
-			SessionEndpoint = "/seb-api/v1/session";
+			AccessTokenEndpoint = "oauth/token";
+			HealthEndpoint = "health";
+			ScreenShotEndpoint = $"seb-api/v1/session/{SESSION_ID}/screenshot";
+			SessionEndpoint = "seb-api/v1/session";
 		}
 	}
 }
diff --git a/SafeExamBrowser.Proctoring/ScreenProctoring/Service/Sanitizer.cs b/SafeExamBrowser.Proctoring/ScreenProctoring/Service/Sanitizer.cs
@@ -0,0 +1,32 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ * 
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+using System;
+using System.Reflection;
+
+namespace SafeExamBrowser.Proctoring.ScreenProctoring.Service
+{
+	internal class Sanitizer
+	{
+		internal Uri Sanitize(string serviceUrl)
+		{
+			return new Uri(serviceUrl.EndsWith("/") ? serviceUrl : $"{serviceUrl}/");
+		}
+
+		internal void Sanitize(Api api)
+		{
+			foreach (var property in api.GetType().GetProperties(BindingFlags.Instance | BindingFlags.Public | BindingFlags.NonPublic))
+			{
+				var value = property.GetValue(api) as string;
+				var sanitized = value.TrimStart('/');
+
+				property.SetValue(api, sanitized);
+			}
+		}
+	}
+}
diff --git a/SafeExamBrowser.Proctoring/ScreenProctoring/Service/ServiceProxy.cs b/SafeExamBrowser.Proctoring/ScreenProctoring/Service/ServiceProxy.cs
@@ -20,6 +20,7 @@ internal class ServiceProxy
 		private readonly Api api;
 		private readonly ILogger logger;
 		private readonly Parser parser;
+		private readonly Sanitizer sanitizer;
 
 		private HttpClient httpClient;
 
@@ -31,16 +32,19 @@ internal ServiceProxy(ILogger logger)
 			this.api = new Api();
 			this.logger = logger;
 			this.parser = new Parser(logger);
+			this.sanitizer = new Sanitizer();
 		}
 
 		internal ServiceResponse Connect(string clientId, string clientSecret, string serviceUrl)
 		{
 			httpClient = new HttpClient
 			{
-				BaseAddress = new Uri(serviceUrl),
+				BaseAddress = sanitizer.Sanitize(serviceUrl),
 				Timeout = TimeSpan.FromSeconds(10)
 			};
 
+			sanitizer.Sanitize(api);
+
 			var request = new OAuth2TokenRequest(api, httpClient, logger, parser);
 			var success = request.TryExecute(clientId, clientSecret, out var message);
 

diff --git a/SafeExamBrowser.Server/Data/Api.cs b/SafeExamBrowser.Server/Data/Api.cs
@@ -0,0 +1,30 @@
+/*
+ * Copyright (c) 2024 ETH Zürich, IT Services
+ *
+ * This Source Code Form is subject to the terms of the Mozilla Public
+ * License, v. 2.0. If a copy of the MPL was not distributed with this
+ * file, You can obtain one at http://mozilla.org/MPL/2.0/.
+ */
+
+using Newtonsoft.Json;
+
+namespace SafeExamBrowser.Server.Data
+{
+	internal class Api
+	{
+		[JsonProperty]
+		internal string AccessTokenEndpoint { get; set; }
+
+		[JsonProperty]
+		internal string HandshakeEndpoint { get; set; }
+
+		[JsonProperty]
+		internal string ConfigurationEndpoint { get; set; }
+
+		[JsonProperty]
+		internal string PingEndpoint { get; set; }
+
+		[JsonProperty]
+		internal string LogEndpoint { get; set; }
+	}
+}
diff --git a/SafeExamBrowser.Server/Data/ApiVersion1.cs b/SafeExamBrowser.Server/Data/ApiVersion1.cs
diff --git a/SafeExamBrowser.Server/Parser.cs b/SafeExamBrowser.Server/Parser.cs
@@ -50,11 +50,11 @@ internal bool IsTokenExpired(HttpContent content)
 			return isExpired;
 		}
 
-		internal bool TryParseApi(HttpContent content, out ApiVersion1 api)
+		internal bool TryParseApi(HttpContent content, out Api api)
 		{
 			var success = false;
 
-			api = new ApiVersion1();
+			api = new Api();
 
 			try
 			{

diff --git a/SafeExamBrowser.Server/Requests/ApiRequest.cs b/SafeExamBrowser.Server/Requests/ApiRequest.cs
@@ -13,27 +13,32 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class ApiRequest : BaseRequest
+	internal class ApiRequest : Request
 	{
+		private readonly Sanitizer sanitizer;
+
 		internal ApiRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,
+			Sanitizer sanitizer,
 			ServerSettings settings) : base(api, httpClient, logger, parser, settings)
 		{
+			this.sanitizer = sanitizer;
 		}
 
-		internal bool TryExecute(out ApiVersion1 api, out string message)
+		internal bool TryExecute(out Api api, out string message)
 		{
 			var success = TryExecute(HttpMethod.Get, settings.ApiUrl, out var response);
 
-			api = new ApiVersion1();
+			api = new Api();
 			message = response.ToLogString();
 
 			if (success)
 			{
 				parser.TryParseApi(response.Content, out api);
+				sanitizer.Sanitize(api);
 			}
 
 			return success;

diff --git a/SafeExamBrowser.Server/Requests/AppSignatureKeyRequest.cs b/SafeExamBrowser.Server/Requests/AppSignatureKeyRequest.cs
@@ -13,10 +13,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class AppSignatureKeyRequest : BaseRequest
+	internal class AppSignatureKeyRequest : Request
 	{
 		internal AppSignatureKeyRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/AvailableExamsRequest.cs b/SafeExamBrowser.Server/Requests/AvailableExamsRequest.cs
@@ -17,14 +17,14 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class AvailableExamsRequest : BaseRequest
+	internal class AvailableExamsRequest : Request
 	{
 		private readonly AppConfig appConfig;
 		private readonly ISystemInfo systemInfo;
 		private readonly IUserInfo userInfo;
 
 		internal AvailableExamsRequest(
-			ApiVersion1 api,
+			Api api,
 			AppConfig appConfig,
 			HttpClient httpClient,
 			ILogger logger,

diff --git a/SafeExamBrowser.Server/Requests/ConfirmLockScreenRequest.cs b/SafeExamBrowser.Server/Requests/ConfirmLockScreenRequest.cs
@@ -15,10 +15,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class ConfirmLockScreenRequest : BaseRequest
+	internal class ConfirmLockScreenRequest : Request
 	{
 		internal ConfirmLockScreenRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/DisconnectionRequest.cs b/SafeExamBrowser.Server/Requests/DisconnectionRequest.cs
@@ -13,10 +13,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class DisconnectionRequest : BaseRequest
+	internal class DisconnectionRequest : Request
 	{
 		internal DisconnectionRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/ExamConfigurationRequest.cs b/SafeExamBrowser.Server/Requests/ExamConfigurationRequest.cs
@@ -14,10 +14,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class ExamConfigurationRequest : BaseRequest
+	internal class ExamConfigurationRequest : Request
 	{
 		internal ExamConfigurationRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Extensions.cs → ...ExamBrowser.Server/Requests/Extensions.cs b/SafeExamBrowser.Server/Extensions.cs → ...ExamBrowser.Server/Requests/Extensions.cs
@@ -11,7 +11,7 @@
 using System.Text;
 using SafeExamBrowser.Settings.Logging;
 
-namespace SafeExamBrowser.Server
+namespace SafeExamBrowser.Server.Requests
 {
 	internal static class Extensions
 	{

diff --git a/SafeExamBrowser.Server/Requests/LockScreenRequest.cs b/SafeExamBrowser.Server/Requests/LockScreenRequest.cs
@@ -15,10 +15,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class LockScreenRequest : BaseRequest
+	internal class LockScreenRequest : Request
 	{
 		internal LockScreenRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/LogRequest.cs b/SafeExamBrowser.Server/Requests/LogRequest.cs
@@ -14,10 +14,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class LogRequest : BaseRequest
+	internal class LogRequest : Request
 	{
 		internal LogRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/LowerHandRequest.cs b/SafeExamBrowser.Server/Requests/LowerHandRequest.cs
@@ -15,10 +15,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class LowerHandRequest : BaseRequest
+	internal class LowerHandRequest : Request
 	{
 		internal LowerHandRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/NetworkAdapterRequest.cs b/SafeExamBrowser.Server/Requests/NetworkAdapterRequest.cs
@@ -17,10 +17,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class NetworkAdapterRequest : BaseRequest
+	internal class NetworkAdapterRequest : Request
 	{
 		internal NetworkAdapterRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/OAuth2TokenRequest.cs b/SafeExamBrowser.Server/Requests/OAuth2TokenRequest.cs
@@ -13,10 +13,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class OAuth2TokenRequest : BaseRequest
+	internal class OAuth2TokenRequest : Request
 	{
 		internal OAuth2TokenRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/PingRequest.cs b/SafeExamBrowser.Server/Requests/PingRequest.cs
@@ -14,10 +14,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class PingRequest : BaseRequest
+	internal class PingRequest : Request
 	{
 		internal PingRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/PowerSupplyRequest.cs b/SafeExamBrowser.Server/Requests/PowerSupplyRequest.cs
@@ -17,10 +17,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class PowerSupplyRequest : BaseRequest
+	internal class PowerSupplyRequest : Request
 	{
 		internal PowerSupplyRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,

diff --git a/SafeExamBrowser.Server/Requests/RaiseHandRequest.cs b/SafeExamBrowser.Server/Requests/RaiseHandRequest.cs
@@ -15,10 +15,10 @@
 
 namespace SafeExamBrowser.Server.Requests
 {
-	internal class RaiseHandRequest : BaseRequest
+	internal class RaiseHandRequest : Request
 	{
 		internal RaiseHandRequest(
-			ApiVersion1 api,
+			Api api,
 			HttpClient httpClient,
 			ILogger logger,
 			Parser parser,