feat: Add support for Relax SSL validation (#922)

* Add RelaxSslValidation property and IsModified method

Added a new property `RelaxSslValidation` to the `AppiumClientConfig` class to allow users to specify whether SSL validation should be relaxed. Introduced a new method `IsModified` that checks if the current configuration has been modified from the default configuration, specifically comparing the `DirectConnect` and `RelaxSslValidation` properties.

* Add AppiumHttpCommandExecutor class with custom HttpClientHandler

Introduce AppiumHttpCommandExecutor in OpenQA.Selenium.Appium.Service.
This class inherits from HttpCommandExecutor and includes two constructors
for initializing with a Uri and TimeSpan, with an optional AppiumClientConfig.
Override CreateHttpClientHandler to customize HttpClientHandler with a
callback for server certificate validation. Add ModifyHttpClientHandler
method to return the customized handler. Include necessary using directives.

* Switch to AppiumHttpCommandExecutor for better integration

Replaced instances of HttpCommandExecutor with AppiumHttpCommandExecutor
in AppiumCommandExecutor.cs. Updated CreateRealExecutor and
GetNewExecutorWithDirectConnect methods to return AppiumHttpCommandExecutor.
Modified ModifyNewSessionHttpRequestHeader to cast commandExecutor to
AppiumHttpCommandExecutor and added a call to ModifyHttpClientHandler with
ClientConfig. These changes enhance the command execution process by
leveraging Appium-specific functionalities.

* Refactor AppiumCommandExecutor and AppiumHttpCommandExecutor

Updated CreateRealExecutor to accept AppiumClientConfig and pass it to AppiumHttpCommandExecutor. Modified constructors of AppiumCommandExecutor to include clientConfig. Reformatted Execute and HandleCommandException methods for consistency. Cleaned up ModifyNewSessionHttpRequestHeader method to remove commented-out code and ensure IdempotencyHeader is added. Updated AppiumHttpCommandExecutor constructor to optionally accept clientConfig and initialize _clientConfig. Adjusted CreateHttpClientHandler to set ServerCertificateCustomValidationCallback based on RelaxSslValidation property. Removed obsolete ModifyHttpClientHandler method.

* Add test for RelaxSslValidation in AppiumClientConfig

A new test method `SetAndGetRelaxSSLValidation` was added to the
`AppiumClientConfigTest` class within the
`Appium.Net.Integration.Tests.ServerTests` namespace. This test
verifies the `RelaxSslValidation` property of the `AppiumClientConfig`
class. It asserts that the default value of `RelaxSslValidation` is
`False`, then sets it to `True` and asserts the updated value.

* Remove `IsModified` method from `AppiumClientConfig`

* Add Apache License header to AppiumHttpCommandExecutor.cs

* Passing clientConfig to ensure consistent behavior in GetNewExecutorWithDirectConnect

* Add RelaxSslValidationTest for Appium SSL validation

* Refactor AppiumHttpCommandExecutor initialization

Refactored the `AppiumHttpCommandExecutor` class to simplify initialization:
- Moved constructor parameters directly into the class definition.
- Initialized `_clientConfig` field at the point of declaration.
- Removed redundant constructor definition and initialization of `_clientConfig` within the constructor body.

* Make ClientConfig readonly in AppiumCommandExecutor

* Add conditional compilation for .NET version-specific tests

* Directly setting callback when enabling the relax SSL Validation.

* Consolidate cleanup logic in RelaxSslValidationTest

* Simplify exception handling in RelaxSslValidationTest

Author: Dor-bl

src/Appium.Net/Appium/Service/AppiumClientConfig.cs

@@ -37,5 +37,8 @@ public static AppiumClientConfig DefaultConfig()
         ///
         /// </summary>
         public bool DirectConnect { get; set; }
+
+        public bool RelaxSslValidation { get; set; }
+
     }
 }

src/Appium.Net/Appium/Service/AppiumCommandExecutor.cs

@@ -12,7 +12,6 @@
 //See the License for the specific language governing permissions and
 //limitations under the License.
 
-using OpenQA.Selenium.Remote;
 using System;
 using System.Threading.Tasks;
 
@@ -24,13 +23,13 @@ internal class AppiumCommandExecutor : ICommandExecutor
         private ICommandExecutor RealExecutor;
         private bool isDisposed;
         private const string IdempotencyHeader = "X-Idempotency-Key";
-        private AppiumClientConfig ClientConfig;
+        private readonly AppiumClientConfig ClientConfig;
 
         private TimeSpan CommandTimeout;
 
-        private static ICommandExecutor CreateRealExecutor(Uri remoteAddress, TimeSpan commandTimeout)
+        private static ICommandExecutor CreateRealExecutor(Uri remoteAddress, TimeSpan commandTimeout, AppiumClientConfig clientConfig)
         {
-            return new HttpCommandExecutor(remoteAddress, commandTimeout);
+            return new AppiumHttpCommandExecutor(remoteAddress, commandTimeout, clientConfig);
         }
 
         private AppiumCommandExecutor(ICommandExecutor realExecutor)
@@ -39,25 +38,25 @@ private AppiumCommandExecutor(ICommandExecutor realExecutor)
         }
 
         internal AppiumCommandExecutor(Uri url, TimeSpan timeForTheServerResponding, AppiumClientConfig clientConfig)
-            : this(CreateRealExecutor(url, timeForTheServerResponding))
+            : this(CreateRealExecutor(url, timeForTheServerResponding, clientConfig))
         {
             CommandTimeout = timeForTheServerResponding;
             Service = null;
             ClientConfig = clientConfig;
         }
 
         internal AppiumCommandExecutor(AppiumLocalService service, TimeSpan timeForTheServerResponding, AppiumClientConfig clientConfig)
-            : this(CreateRealExecutor(service.ServiceUrl, timeForTheServerResponding))
+            : this(CreateRealExecutor(service.ServiceUrl, timeForTheServerResponding, clientConfig))
         {
             CommandTimeout = timeForTheServerResponding;
             Service = service;
             ClientConfig = clientConfig;
         }
 
         public Response Execute(Command commandToExecute)
-       {
-           return Task.Run(() => ExecuteAsync(commandToExecute)).GetAwaiter().GetResult();
-       }
+        {
+            return Task.Run(() => ExecuteAsync(commandToExecute)).GetAwaiter().GetResult();
+        }
 
         public async Task<Response> ExecuteAsync(Command commandToExecute)
         {
@@ -131,7 +130,7 @@ private void HandleCommandException(Command command)
             if (command.Name == DriverCommand.NewSession)
             {
                 Service?.Dispose();
-            }  
+            }
         }
 
         /// <summary>
@@ -142,7 +141,8 @@ private void HandleCommandException(Command command)
         private ICommandExecutor ModifyNewSessionHttpRequestHeader(ICommandExecutor commandExecutor)
         {
             if (commandExecutor == null) throw new ArgumentNullException(nameof(commandExecutor));
-            var modifiedCommandExecutor = commandExecutor as HttpCommandExecutor;
+
+            var modifiedCommandExecutor = commandExecutor as AppiumHttpCommandExecutor;
 
             modifiedCommandExecutor.SendingRemoteHttpRequest += (sender, args) =>
                     args.AddHeader(IdempotencyHeader, Guid.NewGuid().ToString());
@@ -183,7 +183,7 @@ private ICommandExecutor GetNewExecutorWithDirectConnect(Response response)
             var newUri = new DirectConnect(response).GetUri();
             if (newUri != null)
             {
-                return new HttpCommandExecutor(newUri, CommandTimeout);
+                return new AppiumHttpCommandExecutor(newUri, CommandTimeout, ClientConfig);
             }
 
             return null;

src/Appium.Net/Appium/Service/AppiumHttpCommandExecutor.cs

@@ -0,0 +1,37 @@
+//Licensed under the Apache License, Version 2.0 (the "License");
+//you may not use this file except in compliance with the License.
+//See the NOTICE file distributed with this work for additional
+//information regarding copyright ownership.
+//You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+//Unless required by applicable law or agreed to in writing, software
+//distributed under the License is distributed on an "AS IS" BASIS,
+//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//See the License for the specific language governing permissions and
+//limitations under the License.
+
+using OpenQA.Selenium.Remote;
+using System;
+using System.Net.Http;
+
+namespace OpenQA.Selenium.Appium.Service
+{
+    public class AppiumHttpCommandExecutor(Uri addressOfRemoteServer, TimeSpan timeout, AppiumClientConfig clientConfig) : HttpCommandExecutor(addressOfRemoteServer, timeout, enableKeepAlive: true)
+    {
+        private readonly AppiumClientConfig _clientConfig = clientConfig;
+
+        protected override HttpClientHandler CreateHttpClientHandler()
+        {
+            var handler = base.CreateHttpClientHandler();
+
+            if (_clientConfig != null && _clientConfig.RelaxSslValidation)
+            {
+                handler.ServerCertificateCustomValidationCallback = (sender, cert, chain, sslPolicyErrors) => true;
+            }
+            return handler;
+        }
+
+    }
+}

test/integration/ServerTests/AppiumClientConfigTest.cs

@@ -30,5 +30,16 @@ public void SetAndGetDirectConnect()
             clientConfig.DirectConnect = true;
             Assert.That(clientConfig.DirectConnect);
         }
+
+        [Test]
+        public void SetAndGetRelaxSSLValidation()
+        {
+            var clientConfig = AppiumClientConfig.DefaultConfig();
+            Assert.That(clientConfig.RelaxSslValidation, Is.False);
+
+            clientConfig.RelaxSslValidation = true;
+            Assert.That(clientConfig.RelaxSslValidation);
+        }
+
     }
 }

test/integration/ServerTests/RelaxSslValidationTest.cs

@@ -0,0 +1,78 @@
+//Licensed under the Apache License, Version 2.0 (the "License");
+//you may not use this file except in compliance with the License.
+//See the NOTICE file distributed with this work for additional
+//information regarding copyright ownership.
+//You may obtain a copy of the License at
+//
+//   http://www.apache.org/licenses/LICENSE-2.0
+//
+//Unless required by applicable law or agreed to in writing, software
+//distributed under the License is distributed on an "AS IS" BASIS,
+//WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+//See the License for the specific language governing permissions and
+//limitations under the License.
+
+
+using System;
+using Appium.Net.Integration.Tests.helpers;
+using NUnit.Framework;
+using OpenQA.Selenium.Appium;
+using OpenQA.Selenium.Appium.Android;
+using OpenQA.Selenium.Appium.Service;
+
+namespace Appium.Net.Integration.Tests.ServerTests
+{
+    [TestFixture]
+    public class RelaxSslValidationTest
+    {
+        private AppiumDriver _driver;
+        AppiumClientConfig appiumClient;
+        Uri serverUri;
+        AppiumOptions capabilities;
+
+        [OneTimeSetUp]
+        public void BeforeAll()
+        {
+            capabilities = Caps.GetAndroidUIAutomatorCaps(Apps.Get("androidApiDemos"));
+            // TODO: Create serverUri that will redirect to https://
+            serverUri = Env.ServerIsRemote() ? AppiumServers.RemoteServerUri : AppiumServers.LocalServiceUri;
+            appiumClient = AppiumClientConfig.DefaultConfig();
+        }
+
+        [Test]
+        public void TestRelaxSslValidationTrue()
+        {
+            appiumClient.RelaxSslValidation = true;
+            _driver = new AndroidDriver(serverUri, capabilities, Env.InitTimeoutSec, appiumClient);
+            _driver.Manage().Timeouts().ImplicitWait = Env.ImplicitTimeoutSec;
+            Assert.That(_driver, Is.Not.Null, "Driver initialization failed.");
+            Assert.That(_driver.SessionId, Is.Not.Null, "Driver session ID is null.");
+        }
+
+        [Test]
+        public void TestRelaxSslValidationFalse()
+        {
+            appiumClient.RelaxSslValidation = false;
+            try
+            {
+                _driver = new AndroidDriver(serverUri, capabilities, Env.InitTimeoutSec, appiumClient);
+            }
+            catch (Exception e)
+            {
+                using (Assert.EnterMultipleScope())
+                {
+                    Assert.That(e, Is.InstanceOf<OpenQA.Selenium.WebDriverException>());
+                    Assert.That(_driver, Is.Null, "Driver initialization failed as it should.");
+                }
+            }
+        }
+
+        [TearDown]
+        public void TearDown()
+        {
+            _driver?.Dispose();
+            _driver = null;
+        }
+
+    }
+}