add headers order (android only)

Author: tranb3r

CHANGELOG.md

@@ -1,6 +1,7 @@
 ## 2.1.2
 - vs : 17.5.4 (maui 7.0.81 ; android 33.0.46 ; ios 16.2.2035)
 - dotnet sdk 7.0.203
+- add headers order (android only)
 
 ## 2.1.1
 - vs : 17.5.0 (maui 7.0.59 ; android 33.0.26 ; ios 16.2.1024)

SecureHttpClient.OkHttp/java/HeadersOrderInterceptor.java

@@ -0,0 +1,42 @@
+package securehttpclient.okhttp;
+
+import java.io.IOException;
+
+import okhttp3.Headers;
+import okhttp3.Interceptor;
+import okhttp3.Request;
+import okhttp3.Response;
+
+public class HeadersOrderInterceptor implements Interceptor {
+    
+    private static final String HEADERS_ORDER_HEADER = "securehttpclient-headers-order";
+
+    @Override
+    public Response intercept(Chain chain) throws IOException {
+        Request original = chain.request();
+
+        if (original.header(HEADERS_ORDER_HEADER) == null) {
+            return chain.proceed(original);
+        }
+
+        Request.Builder requestBuilder = original.newBuilder();
+
+        String headersOrderHeader = original.header(HEADERS_ORDER_HEADER);
+        String[] headersOrderArray = headersOrderHeader.split(";");
+
+        for (String name : headersOrderArray) {
+            if (original.header(name) != null) {
+                String header = original.header(name);
+                requestBuilder
+                    .removeHeader(name)
+                    .addHeader(name, header);
+            }
+        }
+
+        Request request = requestBuilder
+            .removeHeader(HEADERS_ORDER_HEADER)
+            .build();
+
+        return chain.proceed(request);
+    }
+}

SecureHttpClient.Test/HttpTest.cs

@@ -6,6 +6,7 @@
 using System.Text.Json;
 using System.Threading.Tasks;
 using Microsoft.Maui.Devices;
+using SecureHttpClient.Extensions;
 using SecureHttpClient.Test.Helpers;
 using Xunit;
 
@@ -49,6 +50,45 @@ public async Task HttpTest_Gzip_WithRequestHeader()
             Assert.True(url);
         }
 
+        [Fact]
+        public async Task HttpTest_Headers()
+        {
+            const string page = @"https://postman-echo.com/get";
+            var req = new HttpRequestMessage(HttpMethod.Get, page);
+            req.Headers.Add("header1", "value1");
+            req.Headers.Add("header2", "value2");
+            req.Headers.Add("header3", "value3");
+            var result = await SendAsync(req).ReceiveString();
+            var json = JsonDocument.Parse(result);
+            var headers = json.RootElement.GetProperty("headers").Deserialize<Dictionary<string, string>>().Select(kv => kv.Key).ToList();
+            var index1 = headers.IndexOf("header1");
+            var index2 = headers.IndexOf("header2");
+            var index3 = headers.IndexOf("header3");
+            Assert.Equal(1, index2 - index1);
+            Assert.Equal(1, index3 - index2);
+        }
+
+        [SkippableFact]
+        public async Task HttpTest_HeadersOrder()
+        {
+            Skip.If(DeviceInfo.Platform != DevicePlatform.Android, "Only on Android");
+
+            const string page = @"https://postman-echo.com/get";
+            var req = new HttpRequestMessage(HttpMethod.Get, page);
+            req.Headers.Add("header1", "value1");
+            req.Headers.Add("header2", "value2");
+            req.Headers.Add("header3", "value3");
+            req.SetHeadersOrder("header3", "header2", "header1");
+            var result = await SendAsync(req).ReceiveString();
+            var json = JsonDocument.Parse(result);
+            var headers = json.RootElement.GetProperty("headers").Deserialize<Dictionary<string, string>>().Select(kv => kv.Key).ToList();
+            var index1 = headers.IndexOf("header1");
+            var index2 = headers.IndexOf("header2");
+            var index3 = headers.IndexOf("header3");
+            Assert.Equal(1, index2 - index3);
+            Assert.Equal(1, index1 - index2);
+        }
+
         [SkippableFact]
         public async Task HttpTest_Deflate()
         {

SecureHttpClient/Extensions/RequestPropertiesExtensions.cs

@@ -0,0 +1,31 @@
+using System.Net.Http;
+
+namespace SecureHttpClient.Extensions
+{
+    /// <summary>
+    /// Request properties extensions
+    /// </summary>
+    public static class RequestPropertiesExtensions
+    {
+        private const string HeadersOrderPropertyKey = "headersOrder";
+
+        /// <summary>
+        /// Set the headers order
+        /// </summary>
+        /// <param name="request">The request</param>
+        /// <param name="headers">The ordered headers names</param>
+        public static void SetHeadersOrder(this HttpRequestMessage request, params string[] headers)
+        {
+            request.Options.Set(new HttpRequestOptionsKey<object>(HeadersOrderPropertyKey), headers);
+        }
+
+        internal static string[] GetHeadersOrder(this HttpRequestMessage request)
+        {
+            if (request.Options.TryGetValue(new HttpRequestOptionsKey<object>(HeadersOrderPropertyKey), out var value))
+            {
+                return (string[])value;
+            }
+            return null;
+        }
+    }
+}

SecureHttpClient/Platforms/Android/SecureHttpClientHandler.cs

@@ -17,6 +17,7 @@
 using Microsoft.Extensions.Logging;
 using System.Security.Authentication;
 using Java.Net;
+using SecureHttpClient.Extensions;
 
 namespace SecureHttpClient
 {
@@ -113,7 +114,8 @@ private OkHttpClient CreateOkHttpClientInstance()
                 .WriteTimeout(100, TimeUnit.Seconds)
                 .ReadTimeout(100, TimeUnit.Seconds)
                 .FollowRedirects(AllowAutoRedirect)
-                .AddInterceptor(new DecompressInterceptor());
+                .AddInterceptor(new DecompressInterceptor())
+                .AddNetworkInterceptor(new HeadersOrderInterceptor());
 
             if (UseCookies)
             {
@@ -181,6 +183,12 @@ protected override async Task<HttpResponseMessage> SendAsync(HttpRequestMessage
                 builder.AddHeader(name, string.Join(headerSeparator, values));
             }
 
+            var headersOrder = request.GetHeadersOrder();
+            if (headersOrder != null)
+            {
+                builder.AddHeader("securehttpclient-headers-order", string.Join(';', headersOrder));
+            }
+
             cancellationToken.ThrowIfCancellationRequested();
 
             var rq = builder.Build();

SecureHttpClient/SecureHttpClient.csproj

@@ -13,6 +13,7 @@
 
 	<ItemGroup>
 		<None Include="**\*.cs;**\*.xml;**\*.axml;**\*.png" Exclude="obj\**\*.*;bin\**\*.*;bin;obj" />
+		<Compile Include="Extensions\**\*.cs" />
 		<Compile Include="Abstractions\**\*.cs" />
 		<Compile Include="CertificatePinning\**\*.cs" />
 	</ItemGroup>