Merge pull request #58 from BrandonPotter/AddCheckForDependencyOnLinux

Add check for dependency on linux
BrandonPotter · Oct 14, 2020 · 9c2980d · 9c2980d
2 parents 589f980 + 48726b7
commit 9c2980d
Show file tree

Hide file tree

Showing 5 changed files with 56 additions and 8 deletions.
diff --git a/Google.Authenticator.Tests/QRCodeTest.cs b/Google.Authenticator.Tests/QRCodeTest.cs
@@ -0,0 +1,17 @@
+using System;
+using Xunit;
+using Shouldly;
+
+namespace Google.Authenticator.Tests
+{
+    public class QRCodeTest
+    {
+        [Fact]
+        public void CanGenerateQRCode()
+        {
+            var subject = new TwoFactorAuthenticator();
+            var setupCodeInfo = subject.GenerateSetupCode("issuer","[email protected]","secret", false, 2);
+            setupCodeInfo.QrCodeSetupImageUrl.ShouldNotBeNull();
+        }
+    }
+}
diff --git a/Google.Authenticator/Google.Authenticator.csproj b/Google.Authenticator/Google.Authenticator.csproj
@@ -7,7 +7,7 @@
     <Description>Google Authenticator Two-Factor Authentication Library (Not officially affiliated with Google.)</Description>
     <Authors>Brandon Potter</Authors>
     <Company>Brandon Potter</Company>
-    <Version>2.0.2</Version>
+    <Version>2.1.0</Version>
     <PackageLicenseExpression>Apache-2.0</PackageLicenseExpression>
     <PackageProjectUrl>https://github.com/BrandonPotter/GoogleAuthenticator</PackageProjectUrl>
     <PackageId>GoogleAuthenticator</PackageId>

diff --git a/Google.Authenticator/MissingDependencyException.cs b/Google.Authenticator/MissingDependencyException.cs
@@ -0,0 +1,15 @@
+using System;
+
+namespace Google.Authenticator
+{
+    public class MissingDependencyException : Exception
+    {
+        public MissingDependencyException(string message) : base(message)
+        {
+        }
+
+        public MissingDependencyException(string message, Exception innerException) : base(message, innerException)
+        {
+        }
+    }
+}
diff --git a/Google.Authenticator/TwoFactorAuthenticator.cs b/Google.Authenticator/TwoFactorAuthenticator.cs
@@ -68,15 +68,28 @@ public SetupCode GenerateSetupCode(string issuer, string accountTitleNoSpaces, b
             string qrCodeUrl = string.Empty;
             if (generateQrCode)
             {
-                using (QRCodeGenerator qrGenerator = new QRCodeGenerator())
-                using (QRCodeData qrCodeData = qrGenerator.CreateQrCode(provisionUrl, QRCodeGenerator.ECCLevel.Q))
-                using (QRCode qrCode = new QRCode(qrCodeData))
-                using (Bitmap qrCodeImage = qrCode.GetGraphic(QRPixelsPerModule))
-                using (MemoryStream ms = new MemoryStream())
+                try
                 {
-                    qrCodeImage.Save(ms, System.Drawing.Imaging.ImageFormat.Png);
+                    using (QRCodeGenerator qrGenerator = new QRCodeGenerator())
+                    using (QRCodeData qrCodeData = qrGenerator.CreateQrCode(provisionUrl, QRCodeGenerator.ECCLevel.Q))
+                    using (QRCode qrCode = new QRCode(qrCodeData))
+                    using (Bitmap qrCodeImage = qrCode.GetGraphic(QRPixelsPerModule))
+                    using (MemoryStream ms = new MemoryStream())
+                    {
+                        qrCodeImage.Save(ms, System.Drawing.Imaging.ImageFormat.Png);
+
+                        qrCodeUrl = String.Format("data:image/png;base64,{0}", Convert.ToBase64String(ms.ToArray()));
+                    }
+                }
+                catch (System.TypeInitializationException e)  
+                {
+                    if (e.InnerException != null 
+                        && e.InnerException.GetType() == typeof(System.DllNotFoundException)
+                        && e.InnerException.Message.Contains("libgdiplus"))
+                    {
+                        throw new MissingDependencyException("It looks like libgdiplus has not been installed - see https://github.com/codebude/QRCoder/issues/227", e);
+                    }
 
-                    qrCodeUrl = String.Format("data:image/png;base64,{0}", Convert.ToBase64String(ms.ToArray()));
                 }
             }
 

diff --git a/README.md b/README.md
@@ -8,3 +8,6 @@ Simple, easy to use server-side two-factor authentication library for .NET that
 See blog post for usage instructions:
 
 https://csharprookie.wordpress.com/2015/03/17/implementing-free-two-factor-authentication-in-net-using-google-authenticator/
+
+# Notes
+On linux, you need to ensure `libgdiplus` is installed if you want to generate QR Codes. See [https://github.com/codebude/QRCoder/issues/227](https://github.com/codebude/QRCoder/issues/227).