Merge pull request #254 from ObsidianPhoenix/features/253_Expose_otpAuth_Url

Add SetupUrl to the SetupCode class

Author: ahwm

Google.Authenticator.Tests/QRCodeTest.cs …nticator.Tests/QRCodeAndSetupUrlTests.csGoogle.Authenticator.Tests/QRCodeTest.cs renamed to Google.Authenticator.Tests/QRCodeAndSetupUrlTests.cs Google.Authenticator.Tests/QRCodeTest.cs renamed to Google.Authenticator.Tests/QRCodeAndSetupUrlTests.cs

@@ -8,7 +8,7 @@
 
 namespace Google.Authenticator.Tests
 {
-    public class QRCodeTest
+    public class QRCodeAndSetupUrlTests
     {
         [Theory]
         [InlineData("issuer", "otpauth://totp/issuer:a%40b.com?secret=ONSWG4TFOQ&issuer=issuer")]
@@ -25,8 +25,13 @@ public void CanGenerateQRCode(string issuer, string expectedUrl)
                 2);
 
             var actualUrl = ExtractUrlFromQRImage(setupCodeInfo.QrCodeSetupImageUrl);
+            var rawUrl = setupCodeInfo.SetupUrl;
 
-            actualUrl.ShouldBe(expectedUrl);
+            Assert.Multiple(() =>
+            {
+                actualUrl.ShouldBe(expectedUrl, "QR Code Url is not as expected");
+                rawUrl.ShouldBe(expectedUrl, "SetupUrl is not as expected");
+            });
         }
 
         [Theory]
@@ -44,8 +49,13 @@ public void CanGenerateSHA256QRCode(string issuer, string expectedUrl)
                 2);
 
             var actualUrl = ExtractUrlFromQRImage(setupCodeInfo.QrCodeSetupImageUrl);
+            var rawUrl = setupCodeInfo.SetupUrl;
 
-            actualUrl.ShouldBe(expectedUrl);
+            Assert.Multiple(() =>
+            {
+                actualUrl.ShouldBe(expectedUrl, "QR Code Url is not as expected");
+                rawUrl.ShouldBe(expectedUrl, "SetupUrl is not as expected");
+            });
         }
 
         [Theory]
@@ -63,8 +73,13 @@ public void CanGenerateSHA512QRCode(string issuer, string expectedUrl)
                 2);
 
             var actualUrl = ExtractUrlFromQRImage(setupCodeInfo.QrCodeSetupImageUrl);
+            var rawUrl = setupCodeInfo.SetupUrl;
 
-            actualUrl.ShouldBe(expectedUrl);
+            Assert.Multiple(() =>
+            {
+                actualUrl.ShouldBe(expectedUrl, "QR Code Url is not as expected");
+                rawUrl.ShouldBe(expectedUrl, "SetupUrl is not as expected");
+            });
         }
 
         private static string ExtractUrlFromQRImage(string qrCodeSetupImageUrl)

Google.Authenticator/SetupCode.cs

@@ -9,13 +9,19 @@ public class SetupCode
         /// </summary>
         public string QrCodeSetupImageUrl { get; internal set; }
 
+        /// <summary>
+        /// The Raw otp:// url
+        /// </summary>
+        public string SetupUrl { get; internal set; }
+
         public SetupCode() { }
 
-        public SetupCode(string account, string manualEntryKey, string qrCodeSetupImageUrl)
+        public SetupCode(string account, string manualEntryKey, string qrCodeSetupImageUrl, string setupUrl)
         {
             Account = account;
             ManualEntryKey = manualEntryKey;
             QrCodeSetupImageUrl = qrCodeSetupImageUrl;
+            SetupUrl = setupUrl;
         }
     }
 }

Google.Authenticator/TwoFactorAuthenticator.cs

@@ -98,7 +98,8 @@ public SetupCode GenerateSetupCode(string issuer,
             return new SetupCode(
                 accountTitleNoSpaces,
                 encodedSecretKey.Trim('='),
-                generateQrCode ? GenerateQrCodeUrl(qrPixelsPerModule, provisionUrl) : "");
+                generateQrCode ? GenerateQrCodeUrl(qrPixelsPerModule, provisionUrl) : "",
+                provisionUrl);
         }
 
         private static string GenerateQrCodeUrl(int qrPixelsPerModule, string provisionUrl)

build/azure-pipeline.yaml

@@ -35,6 +35,18 @@ jobs:
   - script: dotnet build ./Google.Authenticator.Tests/Google.Authenticator.Tests.csproj --configuration $(buildConfiguration) --no-restore --no-dependencies
     displayName: build tests
 
+  - task: UseDotNet@2
+    displayName: Install dotnet 6
+    inputs:
+      packageType: sdk
+      version: 6.x
+
+  - task: UseDotNet@2
+    displayName: Install dotnet 7
+    inputs:
+      packageType: sdk
+      version: 7.x
+
   - task: DotNetCoreCLI@2
     displayName: test
     inputs: