Added support for fragment component in TimedUrlSigner.

ridercz · Aug 4, 2019 · 70cd2e8 · 70cd2e8
1 parent f16e0fa
commit 70cd2e8
Show file tree

Hide file tree

Showing 4 changed files with 27 additions and 3 deletions.
diff --git a/Altairis.Services.UrlSigner.Tests/TimedUrlSignerTest.cs b/Altairis.Services.UrlSigner.Tests/TimedUrlSignerTest.cs
@@ -26,6 +26,20 @@ public class TimedUrlSignerTest {
             Assert.True(signer.Verify(signedString));
         }
 
+        [Fact]
+        public static async Task ImmediateRoundtripStringWithFragment() {
+            const string origUrl = "https://www.example.com#myFragment";
+
+            var signer = new TimedUrlSigner(new HmacUrlSigner<HMACSHA512>(Key));
+            var signedString = signer.Sign(origUrl, TestTtl);
+            await Task.Delay((int)TestTtl.TotalMilliseconds / 2);
+            Assert.True(signer.Verify(signedString));
+            Assert.EndsWith("#myFragment", signedString); // we want preserve fragment component
+
+            var signedStringWithoutFragment = signedString.Replace("#myFragment", "");
+            Assert.True(signer.Verify(signedStringWithoutFragment));
+        }
+
         [Fact]
         public static async Task ExpiredRoundtripUri() {
             var signer = new TimedUrlSigner(new HmacUrlSigner<HMACSHA512>(Key));

diff --git a/Altairis.Services.UrlSigner/Extensions.cs b/Altairis.Services.UrlSigner/Extensions.cs
@@ -32,6 +32,17 @@ public static class Extensions {
             }
         }
 
+        internal static string AppendParameter(this string url, string paramName, string paramValue) {
+            if (url == null) throw new ArgumentNullException(nameof(url));
+            if (string.IsNullOrWhiteSpace(url)) throw new ArgumentException("Value cannot be empty or whitespace only string.", nameof(url));
+            if (paramName == null) throw new ArgumentNullException(nameof(paramName));
+            if (string.IsNullOrWhiteSpace(paramName)) throw new ArgumentException("Value cannot be empty or whitespace only string.", nameof(paramName));
+
+            var baseUrl = RemoveFragment(url, out var fragment);
+            var separator = baseUrl.Contains("?") ? "&" : "?";
+            return $"{baseUrl}{separator}{paramName}={paramValue}{fragment}";
+        }
+
         internal static string RemoveFragment(this string url) => RemoveFragment(url, out _);
 
         internal static string RemoveFragment(this string url, out string fragment) {

diff --git a/Altairis.Services.UrlSigner/TimedUrlSigner.cs b/Altairis.Services.UrlSigner/TimedUrlSigner.cs
@@ -23,7 +23,7 @@ public class TimedUrlSigner {
 
             // Append expiration timestamp
             var expTimeStamp = DateTime.UtcNow.Add(ttl).Subtract(ZeroTime).TotalSeconds;
-            url += (url.Contains("?") ? "&" : "?") + "exp=" + expTimeStamp.ToString();
+            url = url.AppendParameter("exp", expTimeStamp.ToString());
 
             // Sign value with configured signer
             return this.Signer.Sign(url);

diff --git a/Altairis.Services.UrlSigner/UrlSigner.cs b/Altairis.Services.UrlSigner/UrlSigner.cs
@@ -35,8 +35,7 @@ public abstract class UrlSigner : IUrlSigner {
             var sigString = Convert.ToBase64String(sigData).Replace('+', '-').Replace('/', '_');
 
             // Append signature
-            var separator = baseUrl.Contains("?") ? "&": "?";
-            return $"{baseUrl}{separator}sig={sigString}{fragment}";
+            return baseUrl.AppendParameter("sig", sigString) + fragment;
         }
 
         public virtual bool Verify(string url) {