Merge pull request #104 from mdsol/authenticator

Expose MAuthenticator class

Author: dcassidy-mdsol

.github/workflows/test-net60.yaml

@@ -8,6 +8,11 @@ jobs:
         uses: actions/checkout@v2
         with:
           submodules: 'recursive'
+      - name: Setup dotnet
+        uses: actions/setup-dotnet@v4
+        with:
+          dotnet-version: |
+            6.0.x
       - name: Run the Core tests
         run: dotnet test $GITHUB_WORKSPACE/tests/Medidata.MAuth.CoreTests --framework net6.0
       - name: Run the ASP.NET Core tests

CHANGELOG.md

@@ -1,4 +1,6 @@
 # Changes in Medidata.MAuth
+## v5.1.8
+- **[Core]** Updated MAuthenticator to be public
 ## v5.1.7
 - **[Core]** Fix preprocessor for sync methods
 

src/Medidata.MAuth.AspNetCore/MAuthAspNetCoreExtensions.cs

@@ -5,11 +5,13 @@
 using Medidata.MAuth.Core;
 using Microsoft.AspNetCore.Http;
 using Microsoft.AspNetCore.Http.Extensions;
-using Microsoft.Extensions.Logging;
 
 namespace Medidata.MAuth.AspNetCore
 {
-    internal static class MAuthAspNetCoreExtensions
+    /// <summary>
+    /// MAuth extension methods.
+    /// </summary>
+    public static class MAuthAspNetCoreExtensions
     {
         /// <summary>
         /// Converts an <see cref="HttpRequest"/> object to an equivalent <see cref="HttpRequestMessage"/> object. 
@@ -46,7 +48,7 @@ public static HttpRequestMessage ToHttpRequestMessage(this HttpRequest request)
         /// will throw an exception if any errors occurred during the authentication.
         /// </returns>
         public static async Task<bool> TryAuthenticate(
-            this HttpContext context, MAuthAuthenticator authenticator, bool shouldIgnoreExceptions)
+            this HttpContext context, IMAuthAuthenticator authenticator, bool shouldIgnoreExceptions)
         {
             try
             {

src/Medidata.MAuth.Core/IMAuthAuthenticator.cs

@@ -0,0 +1,19 @@
+using System.Net.Http;
+using System.Threading.Tasks;
+
+namespace Medidata.MAuth.Core;
+
+/// <summary>
+/// MAuth authenticator.
+/// </summary>
+public interface IMAuthAuthenticator
+{
+    /// <summary>
+    /// Authenticate http request.
+    /// </summary>
+    /// <param name="request">Http context converted to a http request.</param>
+    /// <returns>
+    /// This method returns <see langword="true"/> if it successfully authenticated the request  otherwise it will return <see langword="false"/>.
+    /// </returns>
+    Task<bool> AuthenticateRequest(HttpRequestMessage request);
+}

src/Medidata.MAuth.Core/MAuthAuthenticator.cs

@@ -11,7 +11,10 @@
 
 namespace Medidata.MAuth.Core
 {
-    internal class MAuthAuthenticator
+    /// <summary>
+    /// MAuth service class to process authentication.
+    /// </summary>
+    public class MAuthAuthenticator : IMAuthAuthenticator
     {
         private const int AllowedDriftSeconds = 300;
         private static readonly TimeSpan AllowedDriftTimeSpan = TimeSpan.FromSeconds(AllowedDriftSeconds);
@@ -22,8 +25,17 @@ internal class MAuthAuthenticator
         private readonly IDateTimeOffsetWrapper _dateTimeOffsetWrapper;
         private readonly Lazy<HttpClient> _lazyHttpClient;
 
+        /// <summary>
+        /// MAuth application uuid.
+        /// </summary>
         public Guid ApplicationUuid => _options.ApplicationUuid;
 
+        /// <summary>
+        /// Create a new instance <see cref="MAuthAuthenticator"/>
+        /// </summary>
+        /// <param name="options">MAuth options</param>
+        /// <param name="logger">Logger</param>
+        /// <param name="cacheService">Cache service. (Optional)</param>
         public MAuthAuthenticator(MAuthOptionsBase options, ILogger logger, ICacheService cacheService = null)
         {
             if (options.ApplicationUuid == default)
@@ -41,6 +53,36 @@ public MAuthAuthenticator(MAuthOptionsBase options, ILogger logger, ICacheServic
             _lazyHttpClient = new Lazy<HttpClient>(() => CreateHttpClient(options));
             _dateTimeOffsetWrapper = options.DateTimeOffsetWrapper;
         }
+        
+        /// <summary>
+        /// Create a new instance <see cref="MAuthAuthenticator"/>
+        /// </summary>
+        /// <param name="options">MAuth options</param>
+        /// <param name="logger">Logger</param>
+        /// <param name="httpClient">Http Client</param>
+        /// <param name="cacheService">Cache service. (Optional)</param>
+        public MAuthAuthenticator(MAuthOptionsBase options, ILogger logger, HttpClient httpClient, ICacheService cacheService = null)
+        {
+            if (options.ApplicationUuid == default)
+                throw new ArgumentException(nameof(options.ApplicationUuid));
+
+            if (options.MAuthServiceUrl == null)
+                throw new ArgumentNullException(nameof(options.MAuthServiceUrl));
+
+            if (string.IsNullOrWhiteSpace(options.PrivateKey))
+                throw new ArgumentNullException(nameof(options.PrivateKey));
+
+            _cache = cacheService ?? new MemoryCacheService(new MemoryCache(new MemoryCacheOptions()));
+            _options = options;
+            _logger = logger;
+#if NET6_0_OR_GREATER
+            _lazyHttpClient = new Lazy<HttpClient>(httpClient);
+#else
+            _lazyHttpClient = new Lazy<HttpClient>(() => httpClient);
+#endif
+            
+            _dateTimeOffsetWrapper = options.DateTimeOffsetWrapper;
+        }
 
         /// <summary>
         /// Verifies if the <see cref="HttpRequestMessage"/> request is authenticated or not.

version.props

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="utf-8"?>
 <Project>
   <PropertyGroup>
-    <Version>5.1.7</Version>
+    <Version>5.1.8</Version>
   </PropertyGroup>
 </Project>